contract

Documentation

Index

• Variables
• type Config
• type Contract
  • func New(c Config) *Contract
  • func (c *Contract) Claims(add string) claimscontract.Interface
  • func (c *Contract) Client() *ethclient.Client
  • func (c *Contract) UVX(add string) uvxcontract.Interface
  • func (c *Contract) Wait(txn *types.Transaction, max time.Duration) error
• type Interface

Variables

var MaxWaitError = &tracer.Error{
	Kind: "MaxWaitError",
	Desc: "The maximum amount of time to wait passed, returning this error.",
}

var TransactionFailedError = &tracer.Error{
	Kind: "TransactionFailedError",
	Desc: "The transaction was mined, but failed with a status code other than 1, which implies that the transaction reverted.",
}

Types

type Config

type Config struct {
	// Key is the private key signing transactions for contract writes.
	Key string
	// Log is a simple logger interface to print system relevant information.
	Log logger.Interface
	// RPC is the RPC endpoint for network connection.
	RPC string
}

type Contract

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

func New

func New(c Config) *Contract

func (*Contract) Claims

func (c *Contract) Claims(add string) claimscontract.Interface

func (*Contract) Client

func (c *Contract) Client() *ethclient.Client

func (*Contract) UVX

func (c *Contract) UVX(add string) uvxcontract.Interface

func (*Contract) Wait

func (c *Contract) Wait(txn *types.Transaction, max time.Duration) error

type Interface

type Interface interface {
	// UVX returns a Claims contract interface for the given address and the
	// underlying RPC configured.
	Claims(string) claimscontract.Interface

	// Client is the underlying go-ethereum client interacting with the configured
	// RPC.
	Client() *ethclient.Client

	// UVX returns a UVX contract interface for the given address and the
	// underlying RPC configured.
	UVX(string) uvxcontract.Interface

	// Wait allows the caller to wait for the given transaction to be mined
	// onchain, but only for the maximum amount of time provided. Should the
	// provided transaction not be mined successfully within "max", then Wait will
	// return MaxWaitError. Should the provided transaction fail in time, then
	// TransactionFailedError is returned.
	Wait(txn *types.Transaction, max time.Duration) error
}