dsl

package
v1.13.5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 11, 2025 License: MIT Imports: 53 Imported by: 1

Documentation

Overview

Package dsl provides DSL (domain specific language) to interact with a devstack system.

Each component in the devstack has a DSL wrapper. The wrapper itself does not have any state, and may be recreated or shallow-copied.

Each DSL wrapper provides an Escape method, in case the DSL is not sufficient for a given use-case. The Escape method is a temporary compromise to allow more incremental development of and migration to the DSL. It should be avoided whenever possible and will be removed in the future.

Index

Constants

View Source 
const DefaultTimeout = 30 * time.Second
View Source 
const (
	SaltEnvVar = "DEVSTACK_KEYS_SALT"
)

Variables

This section is empty.

Functions

func CheckAll 

func CheckAll(t devtest.T, checks ...CheckFunc)

func WithAllLocalUnsafeHeadsAdvancedBy 

func WithAllLocalUnsafeHeadsAdvancedBy(blocks uint64) func(cfg *VerifySyncStatusConfig)

WithAllLocalUnsafeHeadsAdvancedBy verifies that the local unsafe head of every chain advances by at least the specified number of blocks compared to the value when VerifySyncStatus is called.

func WithMinRequiredL2Block 

func WithMinRequiredL2Block(blockNum uint64) func(opts *safeHeadDbMatchOpts)

Types

type CheckFunc 

type CheckFunc func() error

func LaggedFn 

func LaggedFn(baseNode, refNode SyncStatusProvider, log log.Logger, ctx context.Context, lvl types.SafetyLevel, chainID eth.ChainID, attempts int, allowMatch bool) CheckFunc

LaggedFn returns a lambda that checks the baseNode head with given safety level is lagged with the refNode chain sync status provider Composable with other lambdas to wait in parallel

func MatchedFn 

func MatchedFn(baseNode, refNode SyncStatusProvider, log log.Logger, ctx context.Context, lvl types.SafetyLevel, chainID eth.ChainID, attempts int) CheckFunc

MatchedFn returns a lambda that checks the baseNode head with given safety level is matched with the refNode chain sync status provider Composable with other lambdas to wait in parallel

type Cluster added in v1.13.3 

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

Cluster wraps a stack.Cluster interface for DSL operations

func NewCluster added in v1.13.3 

func NewCluster(inner stack.Cluster) *Cluster

NewCluster creates a new Cluster DSL wrapper

func (*Cluster) Escape added in v1.13.3 

func (c *Cluster) Escape() stack.Cluster

Escape returns the underlying stack.Cluster

func (*Cluster) String added in v1.13.3 

func (c *Cluster) String() string

type Conductor 

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

func NewConductor 

func NewConductor(inner stack.Conductor) *Conductor

func (*Conductor) Escape 

func (c *Conductor) Escape() stack.Conductor

func (*Conductor) FetchClusterMembership 

func (c *Conductor) FetchClusterMembership() *consensus.ClusterMembership

func (*Conductor) FetchLeader 

func (c *Conductor) FetchLeader() *consensus.ServerInfo

func (*Conductor) FetchPaused 

func (c *Conductor) FetchPaused() bool

func (*Conductor) FetchSequencerHealthy 

func (c *Conductor) FetchSequencerHealthy() bool

func (*Conductor) IsLeader 

func (c *Conductor) IsLeader() bool

func (*Conductor) String 

func (c *Conductor) String() string

func (*Conductor) TransferLeadershipTo 

func (c *Conductor) TransferLeadershipTo(targetLeaderInfo consensus.ServerInfo)

type ConductorSet 

type ConductorSet []*Conductor

func NewConductorSet 

func NewConductorSet(inner []stack.Conductor) ConductorSet

type Deposit 

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

func (Deposit) GasCost 

func (d Deposit) GasCost() eth.ETH

type ELNode 

type ELNode interface {
	ChainID() eth.ChainID
	// contains filtered or unexported methods
}

type EOA 

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

EOA is an Externally-Owned-Account: an account on a specific chain that is operated by a single private key.

func NewEOA 

func NewEOA(key *Key, el ELNode) *EOA

func (*EOA) Address 

func (u *EOA) Address() common.Address

func (*EOA) AsEL 

func (u *EOA) AsEL(el ELNode) *EOA

func (*EOA) ChainID 

func (u *EOA) ChainID() eth.ChainID

func (*EOA) DeployEventLogger 

func (u *EOA) DeployEventLogger() common.Address

func (*EOA) GetBalance 

func (u *EOA) GetBalance() eth.ETH

Try to avoid using this method where possible, use the VerifyBalance* methods instead.

func (*EOA) Key 

func (u *EOA) Key() *Key

Key returns the cross-chain user identity/key, i.e. the user but detached it from the EL node.

func (*EOA) PendingNonce 

func (u *EOA) PendingNonce() uint64

PendingNonce looks up the user nonce in the pending state.

func (*EOA) Plan 

func (u *EOA) Plan() txplan.Option

Plan creates the default tx-planning options, to perform a transaction with this Key, against the connected EL node and its chain.

func (*EOA) PlanTransfer 

func (u *EOA) PlanTransfer(to common.Address, amount eth.ETH) txplan.Option

PlanTransfer creates the tx-plan options to perform a transfer of the given amount of ETH to the given account.

func (*EOA) SendExecMessage 

func (u *EOA) SendExecMessage(initIntent *txintent.IntentTx[*txintent.InitTrigger, *txintent.InteropOutput], eventIdx int) (*txintent.IntentTx[*txintent.ExecTrigger, *txintent.InteropOutput], *types.Receipt)

func (*EOA) SendInitMessage 

func (u *EOA) SendInitMessage(trigger *txintent.InitTrigger) (*txintent.IntentTx[*txintent.InitTrigger, *txintent.InteropOutput], *types.Receipt)

func (*EOA) SendPackedExecMessages 

func (u *EOA) SendPackedExecMessages(dependOn *txintent.IntentTx[*txintent.MultiTrigger, *txintent.InteropOutput]) (*txintent.IntentTx[*txintent.MultiTrigger, *txintent.InteropOutput], *types.Receipt, error)

SendPackedExecMessages batches every message and validates them via a single multicall

func (*EOA) SendPackedRandomInitMessages 

func (u *EOA) SendPackedRandomInitMessages(rng *rand.Rand, eventLoggerAddress common.Address) (*txintent.IntentTx[*txintent.MultiTrigger, *txintent.InteropOutput], *types.Receipt, error)

SendPackedRandomInitMessages batches random messages and initiates them via a single multicall

func (*EOA) String 

func (u *EOA) String() string

func (*EOA) Transact 

func (u *EOA) Transact(opts ...txplan.Option) *txplan.PlannedTx

Transact plans and executes a tx. The success-state, as defined by the tx-plan options, is required. The resulting evaluated tx is returned.

func (*EOA) Transfer 

func (u *EOA) Transfer(to common.Address, amount eth.ETH) *txplan.PlannedTx

Transfer transfers the given amount of ETH to the given account, immediately.

func (*EOA) VerifyBalanceAtLeast 

func (u *EOA) VerifyBalanceAtLeast(v eth.ETH)

VerifyBalanceAtLeast verifies balance >= v

func (*EOA) VerifyBalanceExact 

func (u *EOA) VerifyBalanceExact(v eth.ETH)

VerifyBalanceExact verifies balance == v

func (*EOA) VerifyBalanceLessThan 

func (u *EOA) VerifyBalanceLessThan(v eth.ETH)

VerifyBalanceLessThan verifies balance < v

func (*EOA) WaitForBalance 

func (u *EOA) WaitForBalance(v eth.ETH)

type Faucet 

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

Faucet wraps a stack.Faucet interface for DSL operations. A Faucet is chain-specific. Note: Faucet wraps a stack component, to share faucet operations in kurtosis by hosting it as service, and prevent race-conditions with the account that sends out the faucet funds.

func NewFaucet 

func NewFaucet(inner stack.Faucet) *Faucet

NewFaucet creates a new Faucet DSL wrapper

func (*Faucet) Escape 

func (f *Faucet) Escape() stack.Faucet

Escape returns the underlying stack.Faucet

func (*Faucet) Fund 

func (f *Faucet) Fund(addr common.Address, amount eth.ETH)

Fund funds the given address with the given amount of ETH

func (*Faucet) String 

func (f *Faucet) String() string

type FlashblocksBuilderNode added in v1.13.4 

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

func NewFlashblocksBuilderNode added in v1.13.4 

func NewFlashblocksBuilderNode(inner stack.FlashblocksBuilderNode) *FlashblocksBuilderNode

func (*FlashblocksBuilderNode) Conductor added in v1.13.5 

func (c *FlashblocksBuilderNode) Conductor() *Conductor

func (*FlashblocksBuilderNode) Escape added in v1.13.4 

func (c *FlashblocksBuilderNode) Escape() stack.FlashblocksBuilderNode

func (*FlashblocksBuilderNode) ListenFor added in v1.13.5 

func (c *FlashblocksBuilderNode) ListenFor(logger log.Logger, duration time.Duration, output chan<- []byte, done chan<- struct{}) error

func (*FlashblocksBuilderNode) String added in v1.13.4 

func (c *FlashblocksBuilderNode) String() string

type FlashblocksBuilderSet added in v1.13.4 

type FlashblocksBuilderSet []*FlashblocksBuilderNode

func NewFlashblocksBuilderSet added in v1.13.4 

func NewFlashblocksBuilderSet(inner []stack.FlashblocksBuilderNode) FlashblocksBuilderSet

func (FlashblocksBuilderSet) Leader added in v1.13.5 

func (f FlashblocksBuilderSet) Leader() *FlashblocksBuilderNode

type FlashblocksWebsocketProxy added in v1.13.5 

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

func NewFlashblocksWebsocketProxy added in v1.13.5 

func NewFlashblocksWebsocketProxy(inner stack.FlashblocksWebsocketProxy) *FlashblocksWebsocketProxy

func (*FlashblocksWebsocketProxy) Escape added in v1.13.5 

func (c *FlashblocksWebsocketProxy) Escape() stack.FlashblocksWebsocketProxy

func (*FlashblocksWebsocketProxy) ListenFor added in v1.13.5 

func (c *FlashblocksWebsocketProxy) ListenFor(logger log.Logger, duration time.Duration, output chan<- []byte, done chan<- struct{}) error

func (*FlashblocksWebsocketProxy) String added in v1.13.5 

func (c *FlashblocksWebsocketProxy) String() string

type FlashblocksWebsocketProxySet added in v1.13.5 

type FlashblocksWebsocketProxySet []*FlashblocksWebsocketProxy

func NewFlashblocksWebsocketProxySet added in v1.13.5 

func NewFlashblocksWebsocketProxySet(inner []stack.FlashblocksWebsocketProxy) FlashblocksWebsocketProxySet

type Funder 

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

func NewFunder 

func NewFunder(w *HDWallet, f *Faucet, el ELNode) *Funder

func (*Funder) Fund 

func (f *Funder) Fund(wallet *EOA, amount eth.ETH) eth.ETH

func (*Funder) FundAtLeast 

func (f *Funder) FundAtLeast(wallet *EOA, amount eth.ETH) eth.ETH

func (*Funder) FundNoWait 

func (f *Funder) FundNoWait(wallet *EOA, amount eth.ETH)

func (*Funder) NewFundedEOA 

func (f *Funder) NewFundedEOA(amount eth.ETH) *EOA

func (*Funder) NewFundedEOAs 

func (f *Funder) NewFundedEOAs(count int, amount eth.ETH) []*EOA

type HDWallet 

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

HDWallet is a collection of deterministic accounts, generated from an underlying devkeys keyring, using the standard cross-chain user identities.

func NewHDWallet 

func NewHDWallet(t devtest.T, mnemonic string, startIndex uint64) *HDWallet

func (*HDWallet) NewEOA 

func (w *HDWallet) NewEOA(el ELNode) *EOA

NewEOA creates a new Key and wraps it with an EL node into a new EOA

func (*HDWallet) NewKey 

func (w *HDWallet) NewKey() *Key

NewKey creates a new chain-agnostic account identity

func (*HDWallet) String 

func (w *HDWallet) String() string

type Key 

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

Key is an ethereum private key. This is a key with an address identity. The Key may be used on different chains: it is chain-agnostic.

func NewKey 

func NewKey(t devtest.T, priv *ecdsa.PrivateKey) *Key

func (*Key) Address 

func (a *Key) Address() common.Address

func (*Key) Plan 

func (a *Key) Plan() txplan.Option

Plan returns the tx-plan option to use this Key for signing of a transaction.

func (*Key) Priv 

func (a *Key) Priv() *ecdsa.PrivateKey

func (*Key) String 

func (a *Key) String() string

func (*Key) User 

func (a *Key) User(el ELNode) *EOA

EOA combines this Key with an EL node into a single-chain EOA.

type L1CLNode 

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

L1CLNode wraps a stack.L1CLNode interface for DSL operations

func NewL1CLNode 

func NewL1CLNode(inner stack.L1CLNode) *L1CLNode

NewL1CLNode creates a new L1CLNode DSL wrapper

func (*L1CLNode) Escape 

func (cl *L1CLNode) Escape() stack.L1CLNode

Escape returns the underlying stack.L1CLNode

func (*L1CLNode) String 

func (cl *L1CLNode) String() string

type L1ELNode 

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

L1ELNode wraps a stack.L1ELNode interface for DSL operations

func NewL1ELNode 

func NewL1ELNode(inner stack.L1ELNode) *L1ELNode

NewL1ELNode creates a new L1ELNode DSL wrapper

func (*L1ELNode) BlockRefByLabel 

func (el *L1ELNode) BlockRefByLabel(label eth.BlockLabel) eth.L1BlockRef

func (*L1ELNode) BlockRefByNumber 

func (el *L1ELNode) BlockRefByNumber(number uint64) eth.L1BlockRef

func (L1ELNode) ChainID 

func (el L1ELNode) ChainID() eth.ChainID

func (*L1ELNode) Escape 

func (el *L1ELNode) Escape() stack.L1ELNode

Escape returns the underlying stack.L1ELNode

func (*L1ELNode) EstimateBlockTime 

func (el *L1ELNode) EstimateBlockTime() time.Duration

EstimateBlockTime estimates the L1 block based on the last 1000 blocks (or since genesis, if insufficient blocks).

func (*L1ELNode) EthClient 

func (el *L1ELNode) EthClient() apis.EthClient

func (L1ELNode) IsCanonical 

func (el L1ELNode) IsCanonical(ref eth.BlockID) bool

func (*L1ELNode) ReorgTriggered 

func (el *L1ELNode) ReorgTriggered(target eth.L1BlockRef, attempts int)

func (*L1ELNode) ReorgTriggeredFn 

func (el *L1ELNode) ReorgTriggeredFn(target eth.L1BlockRef, attempts int) CheckFunc

ReorgTriggeredFn returns a lambda that checks that a L1 reorg occurred on the expected block Composable with other lambdas to wait in parallel

func (*L1ELNode) String 

func (el *L1ELNode) String() string

func (*L1ELNode) TransactionTimeout 

func (el *L1ELNode) TransactionTimeout() time.Duration

func (L1ELNode) WaitForBlock 

func (el L1ELNode) WaitForBlock() eth.BlockRef

func (L1ELNode) WaitForBlockNumber 

func (el L1ELNode) WaitForBlockNumber(targetBlock uint64) eth.BlockRef

func (L1ELNode) WaitForOnline 

func (el L1ELNode) WaitForOnline()

type L1Network 

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

L1Network wraps a stack.L1Network interface for DSL operations

func NewL1Network 

func NewL1Network(inner stack.L1Network) *L1Network

NewL1Network creates a new L1Network DSL wrapper

func (*L1Network) ChainID 

func (n *L1Network) ChainID() eth.ChainID

func (*L1Network) Escape 

func (n *L1Network) Escape() stack.L1Network

Escape returns the underlying stack.L1Network

func (*L1Network) PrintChain 

func (n *L1Network) PrintChain()

PrintChain is used for testing/debugging, it prints the blockchain hashes and parent hashes to logs, which is useful when developing reorg tests

func (*L1Network) String 

func (n *L1Network) String() string

func (*L1Network) WaitForBlock 

func (n *L1Network) WaitForBlock() eth.BlockRef

func (*L1Network) WaitForOnline 

func (n *L1Network) WaitForOnline()

type L2Batcher 

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

L2Batcher wraps a stack.L2Batcher interface for DSL operations

func NewL2Batcher 

func NewL2Batcher(inner stack.L2Batcher) *L2Batcher

NewL2Batcher creates a new L2Batcher DSL wrapper

func (*L2Batcher) ActivityAPI 

func (b *L2Batcher) ActivityAPI() apis.BatcherActivity

func (*L2Batcher) Escape 

func (b *L2Batcher) Escape() stack.L2Batcher

Escape returns the underlying stack.L2Batcher

func (*L2Batcher) Start 

func (b *L2Batcher) Start()

func (*L2Batcher) Stop 

func (b *L2Batcher) Stop()

func (*L2Batcher) String 

func (b *L2Batcher) String() string

type L2CLNode 

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

L2CLNode wraps a stack.L2CLNode interface for DSL operations

func NewL2CLNode 

func NewL2CLNode(inner stack.L2CLNode, control stack.ControlPlane) *L2CLNode

NewL2CLNode creates a new L2CLNode DSL wrapper

func (*L2CLNode) Advanced 

func (cl *L2CLNode) Advanced(lvl types.SafetyLevel, delta uint64, attempts int)

func (*L2CLNode) AdvancedFn 

func (cl *L2CLNode) AdvancedFn(lvl types.SafetyLevel, delta uint64, attempts int) CheckFunc

AdvancedFn returns a lambda that checks the L2CL chain head with given safety level advanced more than delta block number Composable with other lambdas to wait in parallel

func (*L2CLNode) AwaitMinL1Processed 

func (cl *L2CLNode) AwaitMinL1Processed(minL1 uint64)

func (*L2CLNode) ChainID 

func (cl *L2CLNode) ChainID() eth.ChainID

func (*L2CLNode) ChainSyncStatus 

func (cl *L2CLNode) ChainSyncStatus(chainID eth.ChainID, lvl types.SafetyLevel) eth.BlockID

ChainSyncStatus satisfies that the L2CLNode can provide sync status per chain

func (*L2CLNode) ConnectPeer 

func (cl *L2CLNode) ConnectPeer(peer *L2CLNode)

func (*L2CLNode) DisconnectPeer 

func (cl *L2CLNode) DisconnectPeer(peer *L2CLNode)

func (*L2CLNode) Escape 

func (cl *L2CLNode) Escape() stack.L2CLNode

Escape returns the underlying stack.L2CLNode

func (*L2CLNode) HeadBlockRef 

func (cl *L2CLNode) HeadBlockRef(lvl types.SafetyLevel) eth.L2BlockRef

HeadBlockRef fetches L2CL sync status and returns block ref with given safety level

func (*L2CLNode) ID added in v1.13.5 

func (cl *L2CLNode) ID() stack.L2CLNodeID

func (*L2CLNode) Lagged 

func (cl *L2CLNode) Lagged(refNode SyncStatusProvider, lvl types.SafetyLevel, attempts int, allowMatch bool)

func (*L2CLNode) LaggedFn 

func (cl *L2CLNode) LaggedFn(refNode SyncStatusProvider, lvl types.SafetyLevel, attempts int, allowMatch bool) CheckFunc

LaggedFn returns a lambda that checks the L2CL chain head with given safety level is lagged with the reference chain sync status provider Composable with other lambdas to wait in parallel

func (*L2CLNode) Matched 

func (cl *L2CLNode) Matched(refNode SyncStatusProvider, lvl types.SafetyLevel, attempts int)

func (*L2CLNode) MatchedFn 

func (cl *L2CLNode) MatchedFn(refNode SyncStatusProvider, lvl types.SafetyLevel, attempts int) CheckFunc

MatchedFn returns a lambda that checks the L2CLNode head with given safety level is matched with the refNode chain sync status provider Composable with other lambdas to wait in parallel

func (*L2CLNode) NotAdvanced 

func (cl *L2CLNode) NotAdvanced(lvl types.SafetyLevel, attempts int)

func (*L2CLNode) NotAdvancedFn 

func (cl *L2CLNode) NotAdvancedFn(lvl types.SafetyLevel, attempts int) CheckFunc

func (*L2CLNode) PeerInfo 

func (cl *L2CLNode) PeerInfo() *apis.PeerInfo

func (*L2CLNode) Peers 

func (cl *L2CLNode) Peers() *apis.PeerDump

func (*L2CLNode) Reached 

func (cl *L2CLNode) Reached(lvl types.SafetyLevel, target uint64, attempts int)

func (*L2CLNode) ReachedFn 

func (cl *L2CLNode) ReachedFn(lvl types.SafetyLevel, target uint64, attempts int) CheckFunc

ReachedFn returns a lambda that checks the L2CL chain head with given safety level reaches the target block number Composable with other lambdas to wait in parallel

func (*L2CLNode) ReachedRef 

func (cl *L2CLNode) ReachedRef(lvl types.SafetyLevel, target eth.BlockID, attempts int)

func (*L2CLNode) ReachedRefFn 

func (cl *L2CLNode) ReachedRefFn(lvl types.SafetyLevel, target eth.BlockID, attempts int) CheckFunc

ReachedRefFn is same as Reached, but has an additional check to ensure that the block referenced is not reorged Composable with other lambdas to wait in parallel

func (*L2CLNode) Rewinded 

func (cl *L2CLNode) Rewinded(lvl types.SafetyLevel, delta uint64, attempts int)

func (*L2CLNode) RewindedFn 

func (cl *L2CLNode) RewindedFn(lvl types.SafetyLevel, delta uint64, attempts int) CheckFunc

RewindedFn returns a lambda that checks the L2CL chain head with given safety level rewinded more than the delta block number Composable with other lambdas to wait in parallel

func (*L2CLNode) SafeL2BlockRef 

func (cl *L2CLNode) SafeL2BlockRef() eth.L2BlockRef

func (*L2CLNode) Start 

func (cl *L2CLNode) Start()

func (*L2CLNode) StartSequencer 

func (cl *L2CLNode) StartSequencer()

func (*L2CLNode) Stop 

func (cl *L2CLNode) Stop()

func (*L2CLNode) StopSequencer 

func (cl *L2CLNode) StopSequencer() common.Hash

func (*L2CLNode) String 

func (cl *L2CLNode) String() string

func (*L2CLNode) SyncStatus 

func (cl *L2CLNode) SyncStatus() *eth.SyncStatus

func (*L2CLNode) VerifySafeHeadDatabaseMatches 

func (cl *L2CLNode) VerifySafeHeadDatabaseMatches(sourceOfTruth *L2CLNode, args ...func(opts *safeHeadDbMatchOpts))

type L2Challenger 

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

L2Challenger wraps a stack.L2Challenger interface for DSL operations

func NewL2Challenger 

func NewL2Challenger(inner stack.L2Challenger) *L2Challenger

NewL2Challenger creates a new L2Challenger DSL wrapper

func (*L2Challenger) Escape 

func (c *L2Challenger) Escape() stack.L2Challenger

Escape returns the underlying stack.L2Challenger

func (*L2Challenger) String 

func (c *L2Challenger) String() string

type L2ELNode 

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

L2ELNode wraps a stack.L2ELNode interface for DSL operations

func NewL2ELNode 

func NewL2ELNode(inner stack.L2ELNode, control stack.ControlPlane) *L2ELNode

NewL2ELNode creates a new L2ELNode DSL wrapper

func (*L2ELNode) Advanced 

func (el *L2ELNode) Advanced(label eth.BlockLabel, block uint64)

func (*L2ELNode) AdvancedFn 

func (el *L2ELNode) AdvancedFn(label eth.BlockLabel, block uint64) CheckFunc

func (*L2ELNode) BlockRefByLabel 

func (el *L2ELNode) BlockRefByLabel(label eth.BlockLabel) eth.L2BlockRef

func (*L2ELNode) BlockRefByNumber 

func (el *L2ELNode) BlockRefByNumber(num uint64) eth.L2BlockRef

func (L2ELNode) ChainID 

func (el L2ELNode) ChainID() eth.ChainID

func (*L2ELNode) Escape 

func (el *L2ELNode) Escape() stack.L2ELNode

Escape returns the underlying stack.L2ELNode

func (*L2ELNode) ID added in v1.13.5 

func (el *L2ELNode) ID() stack.L2ELNodeID

func (L2ELNode) IsCanonical 

func (el L2ELNode) IsCanonical(ref eth.BlockID) bool

func (*L2ELNode) NotAdvanced 

func (el *L2ELNode) NotAdvanced(label eth.BlockLabel)

func (*L2ELNode) NotAdvancedFn 

func (el *L2ELNode) NotAdvancedFn(label eth.BlockLabel) CheckFunc

func (*L2ELNode) PeerWith 

func (el *L2ELNode) PeerWith(peer *L2ELNode)

func (*L2ELNode) ReorgTriggered 

func (el *L2ELNode) ReorgTriggered(target eth.L2BlockRef, attempts int)

func (*L2ELNode) ReorgTriggeredFn 

func (el *L2ELNode) ReorgTriggeredFn(target eth.L2BlockRef, attempts int) CheckFunc

ReorgTriggeredFn returns a lambda that checks that a L2 reorg occurred on the expected block Composable with other lambdas to wait in parallel

func (*L2ELNode) Start 

func (el *L2ELNode) Start()

func (*L2ELNode) Stop 

func (el *L2ELNode) Stop()

func (*L2ELNode) String 

func (el *L2ELNode) String() string

func (*L2ELNode) TransactionTimeout 

func (el *L2ELNode) TransactionTimeout() time.Duration

func (L2ELNode) WaitForBlock 

func (el L2ELNode) WaitForBlock() eth.BlockRef

func (L2ELNode) WaitForBlockNumber 

func (el L2ELNode) WaitForBlockNumber(targetBlock uint64) eth.BlockRef

func (L2ELNode) WaitForOnline 

func (el L2ELNode) WaitForOnline()

type L2Network 

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

L2Network wraps a stack.L2Network interface for DSL operations

func NewL2Network 

func NewL2Network(inner stack.L2Network, control stack.ControlPlane) *L2Network

NewL2Network creates a new L2Network DSL wrapper

func (*L2Network) AwaitActivation 

func (n *L2Network) AwaitActivation(t devtest.T, forkName rollup.ForkName) eth.BlockID

AwaitActivation awaits the fork activation time, and returns the activation block

func (*L2Network) CatchUpTo 

func (n *L2Network) CatchUpTo(o *L2Network)

func (*L2Network) ChainID 

func (n *L2Network) ChainID() eth.ChainID

func (*L2Network) DepositContractAddr 

func (n *L2Network) DepositContractAddr() common.Address

func (*L2Network) DisputeGameFactoryProxyAddr 

func (n *L2Network) DisputeGameFactoryProxyAddr() common.Address

func (*L2Network) Escape 

func (n *L2Network) Escape() stack.L2Network

Escape returns the underlying stack.L2Network

func (*L2Network) IsActivated 

func (n *L2Network) IsActivated(timestamp uint64) bool

IsActivated checks if a given fork has been activated

func (*L2Network) L2ELNodes 

func (n *L2Network) L2ELNodes() []*L2ELNode

func (*L2Network) LatestBlockBeforeTimestamp 

func (n *L2Network) LatestBlockBeforeTimestamp(t devtest.T, timestamp uint64) eth.BlockRef

LatestBlockBeforeTimestamp finds the latest block before fork activation

func (*L2Network) PrintChain 

func (n *L2Network) PrintChain()

PrintChain is used for testing/debugging, it prints the blockchain hashes and parent hashes to logs, which is useful when developing reorg tests

func (*L2Network) PublicRPC 

func (n *L2Network) PublicRPC() *L2ELNode

func (*L2Network) String 

func (n *L2Network) String() string

func (*L2Network) WaitForBlock 

func (n *L2Network) WaitForBlock() eth.BlockRef

type L2Proposer 

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

L2Proposer wraps a stack.L2Proposer interface for DSL operations

func NewL2Proposer 

func NewL2Proposer(inner stack.L2Proposer) *L2Proposer

NewL2Proposer creates a new L2Proposer DSL wrapper

func (*L2Proposer) Escape 

func (p *L2Proposer) Escape() stack.L2Proposer

Escape returns the underlying stack.L2Proposer

func (*L2Proposer) String 

func (p *L2Proposer) String() string

type ProvenWithdrawalParameters 

type ProvenWithdrawalParameters struct {
	Nonce              *big.Int
	Sender             common.Address
	Target             common.Address
	Value              *big.Int
	GasLimit           *big.Int
	DisputeGameAddress common.Address
	DisputeGameIndex   *big.Int
	Data               []byte
	SuperRootProof     *bindings.SuperRootProof // Only set for games using super roots
	OutputRootIndex    *big.Int                 // Only set for games using super roots
	OutputRootProof    bindings.OutputRootProof
	WithdrawalProof    [][]byte // List of trie nodes to prove L2 storage
}

ProvenWithdrawalParameters is the set of parameters to pass to the ProveWithdrawalTransaction and FinalizeWithdrawalTransaction functions

type StandardBridge 

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

func NewStandardBridge 

func NewStandardBridge(t devtest.T, l2Network *L2Network, supervisor *Supervisor, l1EL *L1ELNode) *StandardBridge

func (*StandardBridge) Deposit 

func (b *StandardBridge) Deposit(amount eth.ETH, from *EOA) Deposit

func (*StandardBridge) DisputeGameFinalityDelay 

func (b *StandardBridge) DisputeGameFinalityDelay() time.Duration

func (*StandardBridge) GameResolutionDelay 

func (b *StandardBridge) GameResolutionDelay() time.Duration

func (*StandardBridge) InitiateWithdrawal 

func (b *StandardBridge) InitiateWithdrawal(amount eth.ETH, from *EOA) *Withdrawal

func (*StandardBridge) RespectedGameType 

func (b *StandardBridge) RespectedGameType() uint32

func (*StandardBridge) UsesSuperRoots 

func (b *StandardBridge) UsesSuperRoots() bool

func (*StandardBridge) WithdrawalDelay 

func (b *StandardBridge) WithdrawalDelay() time.Duration

type Superchain added in v1.13.3 

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

Superchain wraps a stack.Superchain interface for DSL operations

func NewSuperchain added in v1.13.3 

func NewSuperchain(inner stack.Superchain) *Superchain

NewSuperchain creates a new Superchain DSL wrapper

func (*Superchain) Escape added in v1.13.3 

func (s *Superchain) Escape() stack.Superchain

Escape returns the underlying stack.Superchain

func (*Superchain) String added in v1.13.3 

func (s *Superchain) String() string

type Supervisor 

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

func NewSupervisor 

func NewSupervisor(inner stack.Supervisor, control stack.ControlPlane) *Supervisor

func (*Supervisor) AddManagedL2CL 

func (s *Supervisor) AddManagedL2CL(cl *L2CLNode)

func (*Supervisor) AdvancedSafeHead 

func (s *Supervisor) AdvancedSafeHead(chainID eth.ChainID, delta uint64, attempts int)

func (*Supervisor) AwaitMinCrossSafeTimestamp 

func (s *Supervisor) AwaitMinCrossSafeTimestamp(timestamp uint64)

func (*Supervisor) AwaitMinL1 

func (s *Supervisor) AwaitMinL1(minL1 uint64)

func (*Supervisor) ChainSyncStatus 

func (s *Supervisor) ChainSyncStatus(chainID eth.ChainID, lvl types.SafetyLevel) eth.BlockID

ChainSyncStatus satisfies that the supervisor can provide sync status per chain

func (*Supervisor) Escape 

func (s *Supervisor) Escape() stack.Supervisor

func (*Supervisor) FetchSuperRootAtTimestamp 

func (s *Supervisor) FetchSuperRootAtTimestamp(timestamp uint64) eth.SuperRootResponse

func (*Supervisor) FetchSyncStatus 

func (s *Supervisor) FetchSyncStatus() eth.SupervisorSyncStatus

func (*Supervisor) L2HeadBlockID 

func (s *Supervisor) L2HeadBlockID(chainID eth.ChainID, lvl types.SafetyLevel) eth.BlockID

L2HeadBlockID fetches supervisor sync status and returns block id with given safety level

func (*Supervisor) SafeBlockID 

func (s *Supervisor) SafeBlockID(chainID eth.ChainID) eth.BlockID

func (*Supervisor) Start 

func (s *Supervisor) Start()

func (*Supervisor) Stop 

func (s *Supervisor) Stop()

func (*Supervisor) String 

func (s *Supervisor) String() string

func (*Supervisor) VerifySyncStatus 

func (s *Supervisor) VerifySyncStatus(opts ...func(config *VerifySyncStatusConfig))

VerifySyncStatus performs assertions based on the supervisor's SyncStatus endpoint.

func (*Supervisor) WaitForL2HeadToAdvance 

func (s *Supervisor) WaitForL2HeadToAdvance(chainID eth.ChainID, delta uint64, lvl types.SafetyLevel, attempts int)

WaitForL2HeadToAdvance checks the supervisor view of L2CL chain head with given safety level advanced more than delta block number

func (*Supervisor) WaitForL2HeadToAdvanceTo 

func (s *Supervisor) WaitForL2HeadToAdvanceTo(chainID eth.ChainID, lvl types.SafetyLevel, blockID eth.BlockID)

func (*Supervisor) WaitForUnsafeHeadToAdvance 

func (s *Supervisor) WaitForUnsafeHeadToAdvance(chainID eth.ChainID, delta uint64)

type SyncStatusProvider 

type SyncStatusProvider interface {
	ChainSyncStatus(chainID eth.ChainID, lvl types.SafetyLevel) eth.BlockID
	String() string
}

type TestSequencer 

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

func NewTestSequencer 

func NewTestSequencer(inner stack.TestSequencer) *TestSequencer

func (*TestSequencer) Escape 

func (s *TestSequencer) Escape() stack.TestSequencer

func (*TestSequencer) String 

func (s *TestSequencer) String() string

type VerifySyncStatusConfig 

type VerifySyncStatusConfig struct {
	AllUnsafeHeadsAdvance uint64
}

type Withdrawal 

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

func (*Withdrawal) Finalize 

func (w *Withdrawal) Finalize(user *EOA)

func (*Withdrawal) FinalizeGasCost 

func (w *Withdrawal) FinalizeGasCost() eth.ETH

func (*Withdrawal) InitiateGasCost 

func (w *Withdrawal) InitiateGasCost() eth.ETH

func (*Withdrawal) Prove 

func (w *Withdrawal) Prove(user *EOA)

func (*Withdrawal) ProveGasCost 

func (w *Withdrawal) ProveGasCost() eth.ETH

func (*Withdrawal) WaitForDisputeGameResolved 

func (w *Withdrawal) WaitForDisputeGameResolved()

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.