contract

Documentation

Index

• type CallOpts
• type Contract
  • func NewContract(addr web3tool.Address, abi *abi.ABI, opts ...ContractOption) *Contract
  • func (a *Contract) Call(method string, block web3tool.BlockNumber, args ...interface{}) (map[string]interface{}, error)
  • func (a *Contract) GetABI() *abi.ABI
  • func (a *Contract) Txn(method string, args ...interface{}) (Txn, error)
• type ContractOption
  • func WithEIP1559() ContractOption
  • func WithJsonRPC(client *jsonrpc.Eth) ContractOption
  • func WithJsonRPCEndpoint(endpoint string) ContractOption
  • func WithProvider(provider Provider) ContractOption
  • func WithSender(sender web3tool.Key) ContractOption
• type Opts
• type Provider
• type Txn
  • func DeployContract(abi *abi.ABI, bin []byte, args []interface{}, opts ...ContractOption) (Txn, error)
• type TxnOpts

Types

type CallOpts

type CallOpts struct {
	Block web3tool.BlockNumber
	From  web3tool.Address
}

type Contract

type Contract struct {
	// contains filtered or unexported fields
}

Contract is a wrapper to make abi calls to contract with a state provider

func NewContract

func NewContract(addr web3tool.Address, abi *abi.ABI, opts ...ContractOption) *Contract

func (*Contract) Call

func (a *Contract) Call(method string, block web3tool.BlockNumber, args ...interface{}) (map[string]interface{}, error)

func (*Contract) GetABI

func (a *Contract) GetABI() *abi.ABI

func (*Contract) Txn

func (a *Contract) Txn(method string, args ...interface{}) (Txn, error)

type ContractOption

type ContractOption func(*Opts)

func WithEIP1559

func WithEIP1559() ContractOption

func WithJsonRPC

func WithJsonRPC(client *jsonrpc.Eth) ContractOption

func WithJsonRPCEndpoint

func WithJsonRPCEndpoint(endpoint string) ContractOption

func WithProvider

func WithProvider(provider Provider) ContractOption

func WithSender

func WithSender(sender web3tool.Key) ContractOption

type Opts

type Opts struct {
	JsonRPCEndpoint string
	JsonRPCClient   *jsonrpc.Eth
	Provider        Provider
	Sender          web3tool.Key
	EIP1559         bool
}

type Provider

type Provider interface {
	Call(web3tool.Address, []byte, *CallOpts) ([]byte, error)
	Txn(web3tool.Address, web3tool.Key, []byte) (Txn, error)
}

Provider handles the interactions with the Ethereum 1x node

type Txn

type Txn interface {
	Hash() web3tool.Hash
	WithOpts(opts *TxnOpts)
	Do() error
	Wait() (*web3tool.Receipt, error)
}

Txn is the transaction object returned

func DeployContract

func DeployContract(abi *abi.ABI, bin []byte, args []interface{}, opts ...ContractOption) (Txn, error)

type TxnOpts

type TxnOpts struct {
	Value    *big.Int
	GasPrice uint64
	GasLimit uint64
	Nonce    uint64
}