system

type Chain ¶

type Chain interface {
	ID() types.ChainID
	Wallets(ctx context.Context) ([]Wallet, error)
	ContractsRegistry() interfaces.ContractsRegistry
	SupportsEIP(ctx context.Context, eip uint64) bool

	GasPrice(ctx context.Context) (*big.Int, error)
	GasLimit(ctx context.Context, tx TransactionData) (uint64, error)
	PendingNonceAt(ctx context.Context, address common.Address) (uint64, error)
}

Chain represents an Ethereum chain (L1 or L2)

type EthClient ¶ added in v1.11.2

type EthClient interface {
	SendTransaction(ctx context.Context, tx *types.Transaction) error
}

EthClient defines the interface for interacting with Ethereum node

type EthTx ¶ added in v1.11.2

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

EthTx is the default implementation of Transaction that wraps types.Transaction

func (t *EthTx) Data() []byte

func (t *EthTx) From() common.Address

func (t *EthTx) Hash() common.Hash

func (t *EthTx) Raw() *types.Transaction

func (t *EthTx) To() *common.Address

func (t *EthTx) Type() uint8

func (t *EthTx) Value() *big.Int

type InteropSet ¶

type InteropSet interface {
	L2s() []Chain
}

InteropSet provides access to L2 chains in an interop environment

type InteropSystem ¶

type InteropSystem interface {
	System
	InteropSet() InteropSet
}

InteropSystem extends System with interoperability features

type LowLevelChain ¶ added in v1.11.2

type LowLevelChain interface {
	Chain
	RPCURL() string
	Client() (*ethclient.Client, error)
}

LowLevelChain is a Chain that gives direct access to the low level RPC client.

type LowLevelSystem ¶ added in v1.11.2

type LowLevelSystem = genSystem[LowLevelChain]

type RawTransaction ¶ added in v1.11.2

type RawTransaction interface {
	Raw() *coreTypes.Transaction
}

RawTransaction is an optional interface that can be implemented by a Transaction to provide access to the raw transaction data. It is currently necessary to perform processing operations (signing, sending) on the transaction. We would need to do better here.

type System ¶

type System = genSystem[Chain]

System represents a complete Optimism system with L1 and L2 chains

func NewSystemFromURL(url string) (System, error)

type Transaction ¶ added in v1.11.2

type Transaction interface {
	Type() uint8
	Hash() common.Hash
	TransactionData
}

Transaction is the instantiated transaction object.

type TransactionData ¶ added in v1.11.2

type TransactionData interface {
	From() common.Address
	To() *common.Address
	Value() *big.Int
	Data() []byte
}

TransactionData is the input for a transaction creation.

type TransactionProcessor ¶ added in v1.11.2

type TransactionProcessor interface {
	Sign(tx Transaction) (Transaction, error)
	Send(ctx context.Context, tx Transaction) error
}

TransactionProcessor is a helper interface for signing and sending transactions.

func NewEthTransactionProcessor(client *ethclient.Client, chainID *big.Int) TransactionProcessor

func NewTransactionProcessor(client EthClient, chainID *big.Int) TransactionProcessor

type TxBuilder ¶ added in v1.11.2

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

TxBuilder helps construct Ethereum transactions

func NewTxBuilder(ctx context.Context, chain Chain, opts ...TxBuilderOption) *TxBuilder

func (b *TxBuilder) BuildTx(options ...TxOption) (Transaction, error)

type TxBuilderOption ¶ added in v1.11.2

type TxBuilderOption func(*TxBuilder)

TxBuilderOption is a function that configures a TxBuilder

func WithFeeCapMultiplier(multiplier uint64) TxBuilderOption

func WithGasLimitMargin(marginPercent uint64) TxBuilderOption

func WithTxType(txType uint8) TxBuilderOption

type TxOption ¶ added in v1.11.2

type TxOption func(*TxOpts)

TxOption is a function that configures TxOpts

func WithAccessList(accessList types.AccessList) TxOption

func WithBlobCommitments(commitments []kzg4844.Commitment) TxOption

func WithBlobHashes(hashes []common.Hash) TxOption

func WithBlobProofs(proofs []kzg4844.Proof) TxOption

func WithBlobs(blobs []kzg4844.Blob) TxOption

func WithData(data []byte) TxOption

func WithFrom(from common.Address) TxOption

func WithGasLimit(gasLimit uint64) TxOption

func WithTo(to common.Address) TxOption

func WithValue(value *big.Int) TxOption

type TxOpts ¶ added in v1.11.2

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

TxOpts is a struct that holds all transaction options

func (opts *TxOpts) Data() []byte

func (opts *TxOpts) From() common.Address

func (opts *TxOpts) To() *common.Address

func (opts *TxOpts) Validate() error

func (opts *TxOpts) Value() *big.Int

type Wallet ¶ added in v1.11.2

type Wallet interface {
	PrivateKey() types.Key
	Address() types.Address
	SendETH(to types.Address, amount types.Balance) types.WriteInvocation[any]
	Balance() types.Balance
	Nonce() uint64

	TransactionProcessor
}

Wallet represents a chain wallet. In particular it can process transactions.