stack

package
v1.14.0 Latest Latest
Warning

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

 Go to latest Published: Oct 7, 2025 License: MIT Imports: 24 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ApplyOptionLifecycle added in v1.13.3 

func ApplyOptionLifecycle[O Orchestrator](opt Option[O], orch O)

ApplyOptionLifecycle applies all option lifecycle stages to the given orchestrator

func ChainIDFromContext 

func ChainIDFromContext(ctx context.Context) eth.ChainID

ChainIDFromContext extracts the chain ID from the context.

func ChainIDSelector 

func ChainIDSelector(chainID eth.ChainID) logfilter.Selector

ChainIDSelector creates a log-filter that applies the given inner log-filter only if it matches the given chainID. This can be composed with logfilter package utils like logfilter.MuteAll or logfilter.Level to adjust logging for a specific chain ID.

func ContextWithChainID 

func ContextWithChainID(ctx context.Context, chainID eth.ChainID) context.Context

ContextWithChainID annotates the context with the given chainID of service

func ContextWithID added in v1.13.4 

func ContextWithID(ctx context.Context, id slog.LogValuer) context.Context

ContextWithID attaches a component ID to the context. This also automatically attaches the chain ID and component kind to the context, if available from the ID.

func ContextWithKind added in v1.13.4 

func ContextWithKind(ctx context.Context, kind Kind) context.Context

ContextWithKind annotates the context with the given kind of service

func IDFromContext added in v1.13.4 

func IDFromContext[T slog.LogValuer](ctx context.Context) T

func IDSelector added in v1.13.4 

func IDSelector(id slog.LogValuer) logfilter.Selector

IDSelector creates a log-filter that applies the given inner log-filter only if it matches the given ID. This can be composed with logfilter package utils like logfilter.MuteAll or logfilter.Level to adjust logging for a specific chain ID.

func KindSelector added in v1.13.4 

func KindSelector(kind Kind) logfilter.Selector

KindSelector creates a log-filter that applies the given inner log-filter only if it matches the given kind. For logs of the specified kind, it applies the inner filter. For logs of other kinds, it returns false (filters them out).

Types

type ChainIDProvider added in v1.13.4 

type ChainIDProvider interface {
	ChainID() eth.ChainID
}

ChainIDProvider presents a type that provides a relevant ChainID.

type Cluster added in v1.13.3 

type Cluster interface {
	Common
	ID() ClusterID

	DependencySet() depset.DependencySet
}

Cluster represents a set of chains that interop with each other. This may include L1 chains (although potentially not two-way interop due to consensus-layer limitations).

func SortClusters added in v1.13.3 

func SortClusters(elems []Cluster) []Cluster

type ClusterID added in v1.13.3 

type ClusterID genericID

ClusterID identifies a Cluster by name, is type-safe, and can be value-copied and used as map key.

func SortClusterIDs added in v1.13.3 

func SortClusterIDs(ids []ClusterID) []ClusterID

func (ClusterID) Kind added in v1.13.4 

func (id ClusterID) Kind() Kind

func (ClusterID) LogValue added in v1.13.4 

func (id ClusterID) LogValue() slog.Value

func (ClusterID) MarshalText added in v1.13.3 

func (id ClusterID) MarshalText() ([]byte, error)

func (ClusterID) Match added in v1.13.3 

func (id ClusterID) Match(elems []Cluster) []Cluster

func (ClusterID) String added in v1.13.3 

func (id ClusterID) String() string

func (*ClusterID) UnmarshalText added in v1.13.3 

func (id *ClusterID) UnmarshalText(data []byte) error

type ClusterMatcher added in v1.13.3 

type ClusterMatcher = Matcher[ClusterID, Cluster]

type CombinedOption added in v1.13.3 

type CombinedOption[O Orchestrator] []Option[O]

CombinedOption is a list of options. For each option lifecycle stage, all options are applied, left to right.

func Combine added in v1.13.3 

func Combine[O Orchestrator](opts ...Option[O]) CombinedOption[O]

Combine is a method to define a CombinedOption, more readable than a slice definition.

func (*CombinedOption[O]) Add added in v1.13.3 

func (c *CombinedOption[O]) Add(other ...Option[O])

Add changes the option into a new Option that that first applies the receiver, and then the other options. This is a convenience for bundling options together.

func (CombinedOption[O]) AfterDeploy added in v1.13.3 

func (c CombinedOption[O]) AfterDeploy(orch O)

func (CombinedOption[O]) BeforeDeploy added in v1.13.3 

func (c CombinedOption[O]) BeforeDeploy(orch O)

func (CombinedOption[O]) Deploy added in v1.13.3 

func (c CombinedOption[O]) Deploy(orch O)

func (CombinedOption[O]) Finally added in v1.13.3 

func (c CombinedOption[O]) Finally(orch O)

func (CombinedOption[O]) PostHydrate added in v1.13.3 

func (c CombinedOption[O]) PostHydrate(sys System)

func (CombinedOption[O]) PreHydrate added in v1.13.4 

func (c CombinedOption[O]) PreHydrate(sys System)

type Common 

type Common interface {
	T() devtest.T
	Logger() log.Logger

	// Label retrieves a label by key.
	// If the label does not exist, it returns an empty string.
	Label(key string) string

	// SetLabel sets a label by key.
	// Note that labels added by tests are not visible to other tests against the same backend.
	SetLabel(key, value string)
}

type CommonOption added in v1.13.3 

type CommonOption = Option[Orchestrator]

func MakeCommon added in v1.13.3 

func MakeCommon[O Orchestrator](opt Option[O]) CommonOption

MakeCommon makes the type-specific option a common option. If the result runs with a different orchestrator type than expected the actual typed option will not run. This can be used to mix in customizations. Later common options should verify the orchestrator has the properties it needs to have.

type Conductor 

type Conductor interface {
	Common
	ID() ConductorID

	RpcAPI() conductorRpc.API
}

func SortConductors added in v1.13.4 

func SortConductors(elems []Conductor) []Conductor

type ConductorID added in v1.13.4 

type ConductorID genericID

func SortConductorIDs added in v1.13.4 

func SortConductorIDs(ids []ConductorID) []ConductorID

func (ConductorID) MarshalText added in v1.13.4 

func (id ConductorID) MarshalText() ([]byte, error)

func (ConductorID) Match added in v1.13.4 

func (id ConductorID) Match(elems []Conductor) []Conductor

func (ConductorID) String added in v1.13.4 

func (id ConductorID) String() string

func (*ConductorID) UnmarshalText added in v1.13.4 

func (id *ConductorID) UnmarshalText(data []byte) error

type ConductorMatcher added in v1.13.4 

type ConductorMatcher = Matcher[ConductorID, Conductor]

type ControlAction added in v1.13.3 

type ControlAction int
const (
	Start ControlAction = iota
	Stop
)

type ControlPlane added in v1.13.3 

type ControlPlane interface {
	SupervisorState(id SupervisorID, action ControlAction)
	L2CLNodeState(id L2CLNodeID, action ControlAction)
	L2ELNodeState(id L2ELNodeID, action ControlAction)
	FakePoSState(id L1CLNodeID, action ControlAction)
}

ControlPlane is the interface for the orchestrators to control components of the system.

type ELNode 

type ELNode interface {
	Common
	ChainID() eth.ChainID
	EthClient() apis.EthClient
	TransactionTimeout() time.Duration
}

type ExtNetworkConfig added in v1.13.7 

type ExtNetworkConfig struct {
	L2NetworkName      string
	L1ChainID          eth.ChainID
	L2ELEndpoint       string
	L1CLBeaconEndpoint string
	L1ELEndpoint       string
}

type ExtensibleL1Network added in v1.13.3 

type ExtensibleL1Network interface {
	ExtensibleNetwork
	L1Network
	AddL1ELNode(v L1ELNode)
	AddL1CLNode(v L1CLNode)
}

type ExtensibleL2Network added in v1.13.3 

type ExtensibleL2Network interface {
	ExtensibleNetwork
	L2Network
	AddL2Batcher(v L2Batcher)
	AddL2Proposer(v L2Proposer)
	AddL2Challenger(v L2Challenger)
	AddL2CLNode(v L2CLNode)
	AddL2ELNode(v L2ELNode)
	AddConductor(v Conductor)
}

ExtensibleL2Network is an optional extension interface for L2Network, for adding new components to the chain. Used during test-setup, not generally during test execution.

type ExtensibleNetwork added in v1.13.3 

type ExtensibleNetwork interface {
	Network

	AddFaucet(f Faucet)
	AddSyncTester(st SyncTester)
}

type ExtensibleSystem added in v1.13.3 

type ExtensibleSystem interface {
	System
	AddSuperchain(v Superchain)
	AddCluster(v Cluster)
	AddL1Network(v L1Network)
	AddL2Network(v L2Network)
	AddSupervisor(v Supervisor)
	AddTestSequencer(v TestSequencer)
	AddSyncTester(v SyncTester)
}

ExtensibleSystem is an extension-interface to add new components to the system. Regular tests should not be modifying the system. Test gates may use this to remediate any shortcomings of an existing system.

type Faucet 

type Faucet interface {
	Common
	ID() FaucetID
	API() apis.Faucet
}

func SortFaucets added in v1.13.3 

func SortFaucets(elems []Faucet) []Faucet

type FaucetID added in v1.13.3 

type FaucetID idWithChain

FaucetID identifies a Faucet by name and chainID, is type-safe, and can be value-copied and used as map key.

func NewFaucetID added in v1.13.4 

func NewFaucetID(key string, chainID eth.ChainID) FaucetID

func SortFaucetIDs added in v1.13.3 

func SortFaucetIDs(ids []FaucetID) []FaucetID

func (FaucetID) ChainID added in v1.13.4 

func (id FaucetID) ChainID() eth.ChainID

func (FaucetID) Key added in v1.13.4 

func (id FaucetID) Key() string

func (FaucetID) Kind added in v1.13.4 

func (id FaucetID) Kind() Kind

func (FaucetID) LogValue added in v1.13.4 

func (id FaucetID) LogValue() slog.Value

func (FaucetID) MarshalText added in v1.13.3 

func (id FaucetID) MarshalText() ([]byte, error)

func (FaucetID) Match added in v1.13.3 

func (id FaucetID) Match(elems []Faucet) []Faucet

func (FaucetID) String added in v1.13.3 

func (id FaucetID) String() string

func (*FaucetID) UnmarshalText added in v1.13.3 

func (id *FaucetID) UnmarshalText(data []byte) error

type FaucetMatcher added in v1.13.3 

type FaucetMatcher = Matcher[FaucetID, Faucet]

type FlashblocksBuilderID added in v1.13.4 

type FlashblocksBuilderID idWithChain

func NewFlashblocksBuilderID added in v1.13.4 

func NewFlashblocksBuilderID(key string, chainID eth.ChainID) FlashblocksBuilderID

func SortFlashblocksBuilderIDs added in v1.13.4 

func SortFlashblocksBuilderIDs(ids []FlashblocksBuilderID) []FlashblocksBuilderID

func (FlashblocksBuilderID) ChainID added in v1.13.4 

func (id FlashblocksBuilderID) ChainID() eth.ChainID

func (FlashblocksBuilderID) LogValue added in v1.13.4 

func (id FlashblocksBuilderID) LogValue() slog.Value

func (FlashblocksBuilderID) MarshalText added in v1.13.4 

func (id FlashblocksBuilderID) MarshalText() ([]byte, error)

func (FlashblocksBuilderID) Match added in v1.13.4 

func (id FlashblocksBuilderID) Match(elems []FlashblocksBuilderNode) []FlashblocksBuilderNode

func (FlashblocksBuilderID) String added in v1.13.4 

func (id FlashblocksBuilderID) String() string

func (*FlashblocksBuilderID) UnmarshalText added in v1.13.4 

func (id *FlashblocksBuilderID) UnmarshalText(data []byte) error

type FlashblocksBuilderMatcher added in v1.13.4 

type FlashblocksBuilderMatcher = Matcher[FlashblocksBuilderID, FlashblocksBuilderNode]

type FlashblocksBuilderNode added in v1.13.4 

type FlashblocksBuilderNode interface {
	ELNode
	ID() FlashblocksBuilderID
	Conductor() Conductor
	L2EthClient() apis.L2EthClient
	FlashblocksWsUrl() string
	FlashblocksWsHeaders() http.Header
}

func SortFlashblocksBuilders added in v1.13.4 

func SortFlashblocksBuilders(elems []FlashblocksBuilderNode) []FlashblocksBuilderNode

type FlashblocksWebsocketProxy added in v1.13.5 

type FlashblocksWebsocketProxy interface {
	Common
	ChainID() eth.ChainID
	ID() FlashblocksWebsocketProxyID
	WsUrl() string
	WsHeaders() http.Header
}

func SortFlashblocksWebsocketProxies added in v1.13.5 

func SortFlashblocksWebsocketProxies(elems []FlashblocksWebsocketProxy) []FlashblocksWebsocketProxy

type FlashblocksWebsocketProxyID added in v1.13.5 

type FlashblocksWebsocketProxyID idWithChain

func NewFlashblocksWebsocketProxyID added in v1.13.5 

func NewFlashblocksWebsocketProxyID(key string, chainID eth.ChainID) FlashblocksWebsocketProxyID

func SortFlashblocksWebsocketProxyIDs added in v1.13.5 

func SortFlashblocksWebsocketProxyIDs(ids []FlashblocksWebsocketProxyID) []FlashblocksWebsocketProxyID

func (FlashblocksWebsocketProxyID) ChainID added in v1.13.5 

func (id FlashblocksWebsocketProxyID) ChainID() eth.ChainID

func (FlashblocksWebsocketProxyID) LogValue added in v1.13.5 

func (id FlashblocksWebsocketProxyID) LogValue() slog.Value

func (FlashblocksWebsocketProxyID) MarshalText added in v1.13.5 

func (id FlashblocksWebsocketProxyID) MarshalText() ([]byte, error)

func (FlashblocksWebsocketProxyID) Match added in v1.13.5 

func (id FlashblocksWebsocketProxyID) Match(elems []FlashblocksWebsocketProxy) []FlashblocksWebsocketProxy

func (FlashblocksWebsocketProxyID) String added in v1.13.5 

func (id FlashblocksWebsocketProxyID) String() string

func (*FlashblocksWebsocketProxyID) UnmarshalText added in v1.13.5 

func (id *FlashblocksWebsocketProxyID) UnmarshalText(data []byte) error

type FnOption added in v1.13.3 

type FnOption[O Orchestrator] struct {
	BeforeDeployFn func(orch O)
	DeployFn       func(orch O)
	AfterDeployFn  func(orch O)
	FinallyFn      func(orch O)
	PreHydrateFn   func(sys System)
	PostHydrateFn  func(sys System)
}

FnOption defines an option with more flexible function instances per option lifecycle stage. Each nil attribute is simply a no-op when not set.

func (FnOption[O]) AfterDeploy added in v1.13.3 

func (f FnOption[O]) AfterDeploy(orch O)

func (FnOption[O]) BeforeDeploy added in v1.13.3 

func (f FnOption[O]) BeforeDeploy(orch O)

func (FnOption[O]) Deploy added in v1.13.3 

func (f FnOption[O]) Deploy(orch O)

func (FnOption[O]) Finally added in v1.13.3 

func (f FnOption[O]) Finally(orch O)

func (FnOption[O]) PostHydrate added in v1.13.3 

func (f FnOption[O]) PostHydrate(sys System)

func (FnOption[O]) PreHydrate added in v1.13.4 

func (f FnOption[O]) PreHydrate(sys System)

type GenericID added in v1.13.4 

type GenericID interface {
	slog.LogValuer
	KindProvider
}

Defined types based on genericID should implement this interface so they may be used as logging attributes.

type IDOnlyChainID added in v1.13.4 

type IDOnlyChainID interface {
	slog.LogValuer
	ChainIDProvider
	KindProvider
}

Defined types based on idOnlyChainID should implement this interface so they may be used as logging attributes.

type IDWithChain added in v1.13.4 

type IDWithChain interface {
	slog.LogValuer
	ChainIDProvider
	KindProvider
	Keyed
}

Defined types based on idWithChain should implement this interface so they may be used as logging attributes.

type Identifiable added in v1.13.3 

type Identifiable[I comparable] interface {
	ID() I
}

type Keyed added in v1.13.4 

type Keyed interface {
	Key() string
}

Keyed presents a type that provides a relevant string key. E.g. a named superchain.

type Keys 

type Keys interface {
	Secret(key devkeys.Key) *ecdsa.PrivateKey
	Address(key devkeys.Key) common.Address
}

type Kind added in v1.13.3 

type Kind string

Kind represents a kind of component, this is used to make each ID unique, even when encoded as text. 

const ClusterKind Kind = "Cluster"
const ConductorKind Kind = "Conductor"
const FaucetKind Kind = "Faucet"
const FlashblocksBuilderKind Kind = "FlashblocksBuilder"
const FlashblocksWebsocketProxyKind Kind = "FlashblocksWebsocketProxy"
const L1CLNodeKind Kind = "L1CLNode"
const L1ELNodeKind Kind = "L1ELNode"
const L1NetworkKind Kind = "L1Network"
const L2BatcherKind Kind = "L2Batcher"
const L2CLNodeKind Kind = "L2CLNode"
const L2ChallengerKind Kind = "L2Challenger"
const L2ELNodeKind Kind = "L2ELNode"
const L2NetworkKind Kind = "L2Network"
const L2ProposerKind Kind = "L2Proposer"
const SuperchainKind Kind = "Superchain"
const SupervisorKind Kind = "Supervisor"
const SyncTesterKind Kind = "SyncTester"
const TestSequencerKind Kind = "TestSequencer"

func KindFromContext added in v1.13.4 

func KindFromContext(ctx context.Context) Kind

KindFromContext extracts the kind from the context.

func (Kind) LogValue added in v1.13.4 

func (k Kind) LogValue() slog.Value

func (Kind) MarshalText added in v1.13.3 

func (k Kind) MarshalText() ([]byte, error)

func (Kind) String added in v1.13.3 

func (k Kind) String() string

func (*Kind) UnmarshalText added in v1.13.3 

func (k *Kind) UnmarshalText(data []byte) error

type KindProvider added in v1.13.4 

type KindProvider interface {
	Kind() Kind
}

KindProvider presents a type that provides a relevant Kind. E.g. an L2BatcherKind.

type L1CLMatcher added in v1.13.3 

type L1CLMatcher = Matcher[L1CLNodeID, L1CLNode]

type L1CLNode 

type L1CLNode interface {
	Common
	ID() L1CLNodeID

	BeaconClient() apis.BeaconClient
}

L1CLNode is a L1 ethereum consensus-layer node, aka Beacon node. This node may not be a full beacon node, and instead run a mock L1 consensus node.

func SortL1CLNodes added in v1.13.3 

func SortL1CLNodes(elems []L1CLNode) []L1CLNode

type L1CLNodeID added in v1.13.3 

type L1CLNodeID idWithChain

L1CLNodeID identifies a L1CLNode by name and chainID, is type-safe, and can be value-copied and used as map key.

func NewL1CLNodeID added in v1.13.4 

func NewL1CLNodeID(key string, chainID eth.ChainID) L1CLNodeID

func SortL1CLNodeIDs added in v1.13.3 

func SortL1CLNodeIDs(ids []L1CLNodeID) []L1CLNodeID

func (L1CLNodeID) ChainID added in v1.13.4 

func (id L1CLNodeID) ChainID() eth.ChainID

func (L1CLNodeID) Key added in v1.13.4 

func (id L1CLNodeID) Key() string

func (L1CLNodeID) Kind added in v1.13.4 

func (id L1CLNodeID) Kind() Kind

func (L1CLNodeID) LogValue added in v1.13.4 

func (id L1CLNodeID) LogValue() slog.Value

func (L1CLNodeID) MarshalText added in v1.13.3 

func (id L1CLNodeID) MarshalText() ([]byte, error)

func (L1CLNodeID) Match added in v1.13.3 

func (id L1CLNodeID) Match(elems []L1CLNode) []L1CLNode

func (L1CLNodeID) String added in v1.13.3 

func (id L1CLNodeID) String() string

func (*L1CLNodeID) UnmarshalText added in v1.13.3 

func (id *L1CLNodeID) UnmarshalText(data []byte) error

type L1ELMatcher added in v1.13.3 

type L1ELMatcher = Matcher[L1ELNodeID, L1ELNode]

type L1ELNode 

type L1ELNode interface {
	ID() L1ELNodeID

	ELNode
}

L1ELNode is a L1 ethereum execution-layer node

func SortL1ELNodes added in v1.13.3 

func SortL1ELNodes(elems []L1ELNode) []L1ELNode

type L1ELNodeID added in v1.13.3 

type L1ELNodeID idWithChain

L1ELNodeID identifies a L1ELNode by name and chainID, is type-safe, and can be value-copied and used as map key.

func NewL1ELNodeID added in v1.13.4 

func NewL1ELNodeID(key string, chainID eth.ChainID) L1ELNodeID

func SortL1ELNodeIDs added in v1.13.3 

func SortL1ELNodeIDs(ids []L1ELNodeID) []L1ELNodeID

func (L1ELNodeID) ChainID added in v1.13.4 

func (id L1ELNodeID) ChainID() eth.ChainID

func (L1ELNodeID) Key added in v1.13.4 

func (id L1ELNodeID) Key() string

func (L1ELNodeID) Kind added in v1.13.4 

func (id L1ELNodeID) Kind() Kind

func (L1ELNodeID) LogValue added in v1.13.4 

func (id L1ELNodeID) LogValue() slog.Value

func (L1ELNodeID) MarshalText added in v1.13.3 

func (id L1ELNodeID) MarshalText() ([]byte, error)

func (L1ELNodeID) Match added in v1.13.3 

func (id L1ELNodeID) Match(elems []L1ELNode) []L1ELNode

func (L1ELNodeID) String added in v1.13.3 

func (id L1ELNodeID) String() string

func (*L1ELNodeID) UnmarshalText added in v1.13.3 

func (id *L1ELNodeID) UnmarshalText(data []byte) error

type L1Network 

type L1Network interface {
	Network
	ID() L1NetworkID

	L1ELNode(m L1ELMatcher) L1ELNode
	L1CLNode(m L1CLMatcher) L1CLNode

	L1ELNodeIDs() []L1ELNodeID
	L1CLNodeIDs() []L1CLNodeID

	L1ELNodes() []L1ELNode
	L1CLNodes() []L1CLNode
}

L1Network represents a L1 chain, a collection of configuration and node resources.

func SortL1Networks added in v1.13.3 

func SortL1Networks(elems []L1Network) []L1Network

type L1NetworkID added in v1.13.3 

type L1NetworkID idOnlyChainID

L1NetworkID identifies a L1Network by name and chainID, is type-safe, and can be value-copied and used as map key.

func SortL1NetworkIDs added in v1.13.3 

func SortL1NetworkIDs(ids []L1NetworkID) []L1NetworkID

func (L1NetworkID) ChainID added in v1.13.3 

func (id L1NetworkID) ChainID() eth.ChainID

func (L1NetworkID) Kind added in v1.13.4 

func (id L1NetworkID) Kind() Kind

func (L1NetworkID) LogValue added in v1.13.4 

func (id L1NetworkID) LogValue() slog.Value

func (L1NetworkID) MarshalText added in v1.13.3 

func (id L1NetworkID) MarshalText() ([]byte, error)

func (L1NetworkID) Match added in v1.13.3 

func (id L1NetworkID) Match(elems []L1Network) []L1Network

func (L1NetworkID) String added in v1.13.3 

func (id L1NetworkID) String() string

func (*L1NetworkID) UnmarshalText added in v1.13.3 

func (id *L1NetworkID) UnmarshalText(data []byte) error

type L1NetworkMatcher added in v1.13.3 

type L1NetworkMatcher = Matcher[L1NetworkID, L1Network]

type L2Batcher 

type L2Batcher interface {
	Common
	ID() L2BatcherID
	ActivityAPI() apis.BatcherActivity
}

L2Batcher represents an L2 batch-submission service, posting L2 data of an L2 to L1.

func SortL2Batchers added in v1.13.3 

func SortL2Batchers(elems []L2Batcher) []L2Batcher

type L2BatcherID added in v1.13.3 

type L2BatcherID idWithChain

L2BatcherID identifies a L2Batcher by name and chainID, is type-safe, and can be value-copied and used as map key.

func NewL2BatcherID added in v1.13.4 

func NewL2BatcherID(key string, chainID eth.ChainID) L2BatcherID

func SortL2BatcherIDs added in v1.13.3 

func SortL2BatcherIDs(ids []L2BatcherID) []L2BatcherID

func (L2BatcherID) ChainID added in v1.13.4 

func (id L2BatcherID) ChainID() eth.ChainID

func (L2BatcherID) Key added in v1.13.4 

func (id L2BatcherID) Key() string

func (L2BatcherID) Kind added in v1.13.4 

func (id L2BatcherID) Kind() Kind

func (L2BatcherID) LogValue added in v1.13.4 

func (id L2BatcherID) LogValue() slog.Value

func (L2BatcherID) MarshalText added in v1.13.3 

func (id L2BatcherID) MarshalText() ([]byte, error)

func (L2BatcherID) Match added in v1.13.3 

func (id L2BatcherID) Match(elems []L2Batcher) []L2Batcher

func (L2BatcherID) String added in v1.13.3 

func (id L2BatcherID) String() string

func (*L2BatcherID) UnmarshalText added in v1.13.3 

func (id *L2BatcherID) UnmarshalText(data []byte) error

type L2BatcherMatcher added in v1.13.3 

type L2BatcherMatcher = Matcher[L2BatcherID, L2Batcher]

type L2CLMatcher added in v1.13.3 

type L2CLMatcher = Matcher[L2CLNodeID, L2CLNode]

type L2CLNode 

type L2CLNode interface {
	Common
	ID() L2CLNodeID

	ClientRPC() client.RPC
	RollupAPI() apis.RollupClient
	P2PAPI() apis.P2PClient
	InteropRPC() (endpoint string, jwtSecret eth.Bytes32)
	UserRPC() string

	// ELs returns the engine(s) that this L2CLNode is connected to.
	// This may be empty, if the L2CL is not connected to any.
	ELs() []L2ELNode
}

L2CLNode is a L2 ethereum consensus-layer node

func SortL2CLNodes added in v1.13.3 

func SortL2CLNodes(elems []L2CLNode) []L2CLNode

type L2CLNodeID added in v1.13.3 

type L2CLNodeID idWithChain

L2CLNodeID identifies a L2CLNode by name and chainID, is type-safe, and can be value-copied and used as map key.

func NewL2CLNodeID added in v1.13.4 

func NewL2CLNodeID(key string, chainID eth.ChainID) L2CLNodeID

func SortL2CLNodeIDs added in v1.13.3 

func SortL2CLNodeIDs(ids []L2CLNodeID) []L2CLNodeID

func (L2CLNodeID) ChainID added in v1.13.4 

func (id L2CLNodeID) ChainID() eth.ChainID

func (L2CLNodeID) Key added in v1.13.4 

func (id L2CLNodeID) Key() string

func (L2CLNodeID) Kind added in v1.13.4 

func (id L2CLNodeID) Kind() Kind

func (L2CLNodeID) LogValue added in v1.13.4 

func (id L2CLNodeID) LogValue() slog.Value

func (L2CLNodeID) MarshalText added in v1.13.3 

func (id L2CLNodeID) MarshalText() ([]byte, error)

func (L2CLNodeID) Match added in v1.13.3 

func (id L2CLNodeID) Match(elems []L2CLNode) []L2CLNode

func (L2CLNodeID) String added in v1.13.3 

func (id L2CLNodeID) String() string

func (*L2CLNodeID) UnmarshalText added in v1.13.3 

func (id *L2CLNodeID) UnmarshalText(data []byte) error

type L2Challenger 

type L2Challenger interface {
	Common
	ID() L2ChallengerID
}

func SortL2Challengers added in v1.13.3 

func SortL2Challengers(elems []L2Challenger) []L2Challenger

type L2ChallengerID added in v1.13.3 

type L2ChallengerID idWithChain

L2ChallengerID identifies a L2Challenger by name and chainID, is type-safe, and can be value-copied and used as map key.

func NewL2ChallengerID added in v1.13.4 

func NewL2ChallengerID(key string, chainID eth.ChainID) L2ChallengerID

func SortL2ChallengerIDs added in v1.13.3 

func SortL2ChallengerIDs(ids []L2ChallengerID) []L2ChallengerID

func (L2ChallengerID) ChainID added in v1.13.4 

func (id L2ChallengerID) ChainID() eth.ChainID

func (L2ChallengerID) Key added in v1.13.4 

func (id L2ChallengerID) Key() string

func (L2ChallengerID) Kind added in v1.13.4 

func (id L2ChallengerID) Kind() Kind

func (L2ChallengerID) LogValue added in v1.13.4 

func (id L2ChallengerID) LogValue() slog.Value

func (L2ChallengerID) MarshalText added in v1.13.3 

func (id L2ChallengerID) MarshalText() ([]byte, error)

func (L2ChallengerID) Match added in v1.13.3 

func (id L2ChallengerID) Match(elems []L2Challenger) []L2Challenger

func (L2ChallengerID) String added in v1.13.3 

func (id L2ChallengerID) String() string

func (*L2ChallengerID) UnmarshalText added in v1.13.3 

func (id *L2ChallengerID) UnmarshalText(data []byte) error

type L2ChallengerMatcher added in v1.13.3 

type L2ChallengerMatcher = Matcher[L2ChallengerID, L2Challenger]

type L2Deployment 

type L2Deployment interface {
	SystemConfigProxyAddr() common.Address
	DisputeGameFactoryProxyAddr() common.Address
	L1StandardBridgeProxyAddr() common.Address
}

type L2ELMatcher added in v1.13.3 

type L2ELMatcher = Matcher[L2ELNodeID, L2ELNode]

type L2ELNode 

type L2ELNode interface {
	ID() L2ELNodeID
	L2EthClient() apis.L2EthClient
	L2EthExtendedClient() apis.L2EthExtendedClient
	L2EngineClient() apis.EngineClient

	ELNode
}

L2ELNode is a L2 ethereum execution-layer node

func SortL2ELNodes added in v1.13.3 

func SortL2ELNodes(elems []L2ELNode) []L2ELNode

type L2ELNodeID added in v1.13.3 

type L2ELNodeID idWithChain

L2ELNodeID identifies a L2ELNode by name and chainID, is type-safe, and can be value-copied and used as map key.

func NewL2ELNodeID added in v1.13.4 

func NewL2ELNodeID(key string, chainID eth.ChainID) L2ELNodeID

func SortL2ELNodeIDs added in v1.13.3 

func SortL2ELNodeIDs(ids []L2ELNodeID) []L2ELNodeID

func (L2ELNodeID) ChainID added in v1.13.4 

func (id L2ELNodeID) ChainID() eth.ChainID

func (L2ELNodeID) Key added in v1.13.4 

func (id L2ELNodeID) Key() string

func (L2ELNodeID) Kind added in v1.13.4 

func (id L2ELNodeID) Kind() Kind

func (L2ELNodeID) LogValue added in v1.13.4 

func (id L2ELNodeID) LogValue() slog.Value

func (L2ELNodeID) MarshalText added in v1.13.3 

func (id L2ELNodeID) MarshalText() ([]byte, error)

func (L2ELNodeID) Match added in v1.13.3 

func (id L2ELNodeID) Match(elems []L2ELNode) []L2ELNode

func (L2ELNodeID) String added in v1.13.3 

func (id L2ELNodeID) String() string

func (*L2ELNodeID) UnmarshalText added in v1.13.3 

func (id *L2ELNodeID) UnmarshalText(data []byte) error

type L2Network 

type L2Network interface {
	Network
	ID() L2NetworkID
	RollupConfig() *rollup.Config
	Deployment() L2Deployment
	Keys() Keys

	Superchain() Superchain
	L1() L1Network
	Cluster() Cluster

	L2Batcher(m L2BatcherMatcher) L2Batcher
	L2Proposer(m L2ProposerMatcher) L2Proposer
	L2Challenger(m L2ChallengerMatcher) L2Challenger
	L2CLNode(m L2CLMatcher) L2CLNode
	L2ELNode(m L2ELMatcher) L2ELNode
	Conductor(m ConductorMatcher) Conductor

	L2BatcherIDs() []L2BatcherID
	L2ProposerIDs() []L2ProposerID
	L2ChallengerIDs() []L2ChallengerID
	L2CLNodeIDs() []L2CLNodeID
	L2ELNodeIDs() []L2ELNodeID

	L2Batchers() []L2Batcher
	L2Proposers() []L2Proposer
	L2Challengers() []L2Challenger
	L2CLNodes() []L2CLNode
	L2ELNodes() []L2ELNode
	Conductors() []Conductor
	FlashblocksBuilders() []FlashblocksBuilderNode
	AddFlashblocksBuilder(v FlashblocksBuilderNode)
	FlashblocksWebsocketProxies() []FlashblocksWebsocketProxy
	AddFlashblocksWebsocketProxy(v FlashblocksWebsocketProxy)
}

L2Network represents a L2 chain, a collection of configuration and node resources. There is an extension-interface ExtensibleL2Network for adding new components to the chain.

func SortL2Networks added in v1.13.3 

func SortL2Networks(elems []L2Network) []L2Network

type L2NetworkID added in v1.13.3 

type L2NetworkID idOnlyChainID

L2NetworkID identifies a L2Network by name and chainID, is type-safe, and can be value-copied and used as map key.

func SortL2NetworkIDs added in v1.13.3 

func SortL2NetworkIDs(ids []L2NetworkID) []L2NetworkID

func (L2NetworkID) ChainID added in v1.13.3 

func (id L2NetworkID) ChainID() eth.ChainID

func (L2NetworkID) Kind added in v1.13.4 

func (id L2NetworkID) Kind() Kind

func (L2NetworkID) LogValue added in v1.13.4 

func (id L2NetworkID) LogValue() slog.Value

func (L2NetworkID) MarshalText added in v1.13.3 

func (id L2NetworkID) MarshalText() ([]byte, error)

func (L2NetworkID) Match added in v1.13.3 

func (id L2NetworkID) Match(elems []L2Network) []L2Network

func (L2NetworkID) String added in v1.13.3 

func (id L2NetworkID) String() string

func (*L2NetworkID) UnmarshalText added in v1.13.3 

func (id *L2NetworkID) UnmarshalText(data []byte) error

type L2NetworkMatcher added in v1.13.3 

type L2NetworkMatcher = Matcher[L2NetworkID, L2Network]

type L2Proposer 

type L2Proposer interface {
	Common
	ID() L2ProposerID
}

L2Proposer is a L2 output proposer, posting claims of L2 state to L1.

func SortL2Proposers added in v1.13.3 

func SortL2Proposers(elems []L2Proposer) []L2Proposer

type L2ProposerID added in v1.13.3 

type L2ProposerID idWithChain

L2ProposerID identifies a L2Proposer by name and chainID, is type-safe, and can be value-copied and used as map key.

func NewL2ProposerID added in v1.13.4 

func NewL2ProposerID(key string, chainID eth.ChainID) L2ProposerID

func SortL2ProposerIDs added in v1.13.3 

func SortL2ProposerIDs(ids []L2ProposerID) []L2ProposerID

func (L2ProposerID) ChainID added in v1.13.4 

func (id L2ProposerID) ChainID() eth.ChainID

func (L2ProposerID) Key added in v1.13.4 

func (id L2ProposerID) Key() string

func (L2ProposerID) Kind added in v1.13.4 

func (id L2ProposerID) Kind() Kind

func (L2ProposerID) LogValue added in v1.13.4 

func (id L2ProposerID) LogValue() slog.Value

func (L2ProposerID) MarshalText added in v1.13.3 

func (id L2ProposerID) MarshalText() ([]byte, error)

func (L2ProposerID) Match added in v1.13.3 

func (id L2ProposerID) Match(elems []L2Proposer) []L2Proposer

func (L2ProposerID) String added in v1.13.3 

func (id L2ProposerID) String() string

func (*L2ProposerID) UnmarshalText added in v1.13.3 

func (id *L2ProposerID) UnmarshalText(data []byte) error

type L2ProposerMatcher added in v1.13.3 

type L2ProposerMatcher = Matcher[L2ProposerID, L2Proposer]

type Lifecycle 

type Lifecycle interface {
	Start()
	Stop()
}

Lifecycle represents a controllable component by ControlPlane

type LinkableL2CLNode added in v1.13.3 

type LinkableL2CLNode interface {
	// Links the nodes. Does not make any backend changes, just registers the EL as connected to this CL.
	LinkEL(el L2ELNode)
}

type Matcher added in v1.13.3 

type Matcher[I comparable, E Identifiable[I]] interface {
	// Match finds the elements that pass the matcher.
	// If no element passes, it returns an empty slice.
	// Callers should guarantee a stable order of ids, to ensure a deterministic match.
	Match(elems []E) []E

	// String must describe the matcher for debugging purposes.
	// This does not get used for matching.
	String() string
}

Matcher abstracts what can be used as getter-method argument. All ID types implement this interface, and lookup functions check if the argument is an ID before searching for a match. This enables lookups such as getting a component by labels, by its state, by its relation to other components, etc.

type Network 

type Network interface {
	Common

	ChainID() eth.ChainID

	ChainConfig() *params.ChainConfig

	Faucet(m FaucetMatcher) Faucet
	Faucets() []Faucet
	FaucetIDs() []FaucetID

	SyncTester(m SyncTesterMatcher) SyncTester
	SyncTesters() []SyncTester
	SyncTesterIDs() []SyncTesterID
}

Network is an interface to an ethereum chain and its resources, with common properties between L1 and L2. For L1 or L2 specifics, see L1Network and L2Network extensions. A network hosts configuration resources and tracks participating nodes.

type Option added in v1.13.3 

type Option[O Orchestrator] interface {
	// BeforeDeploy runs before any chain is created/deployed
	BeforeDeploy(orch O)
	// Deploy runs the deployment
	Deploy(orch O)
	// AfterDeploy runs after chains are created/deployed
	AfterDeploy(orch O)
	// Finally runs at the very end of orchestrator setup,
	// but before any test-scope is created.
	Finally(orch O)
	// SystemHook is embedded: Options may expose system hooks, to run in test-scope.
	SystemHook
}

Option is used to define a change that inspects and/or changes a System during the lifecycle.

func AfterDeploy added in v1.13.3 

func AfterDeploy[O Orchestrator](fn func(orch O)) Option[O]

AfterDeploy registers a function to run after the deployment stage of the orchestrator. This may be used to customize the orchestrator, after having deployment configuration in place.

func BeforeDeploy added in v1.13.3 

func BeforeDeploy[O Orchestrator](fn func(orch O)) Option[O]

BeforeDeploy registers a function to run before the deployment stage of the orchestrator. This may be used to customize deployment settings.

func Deploy added in v1.13.3 

func Deploy[O Orchestrator](fn func(orch O)) Option[O]

Deploy registers a function to run during the deployment stage of the orchestrator. This may be used to perform deployments.

func Finally added in v1.13.3 

func Finally[O Orchestrator](fn func(orch O)) Option[O]

Finally registers a function to run at the end of orchestrator setup. This may be used for any orchestrator post-validation, or to export any of the now ready orchestrator resources.

func PostHydrate added in v1.13.3 

func PostHydrate[O Orchestrator](fn func(sys System)) Option[O]

PostHydrate hooks up an option callback to run when a new System has been hydrated by the Orchestrator. This is essentially a test-case preamble, to globally configure checks or gates that should run on the test-scope level. Test post-checks can be configured with sys.T().Cleanup(...).

func PreHydrate added in v1.13.4 

func PreHydrate[O Orchestrator](fn func(sys System)) Option[O]

PreHydrate hooks up an option callback to run before a new System has been hydrated by the Orchestrator.

type Orchestrator added in v1.13.3 

type Orchestrator interface {
	// P is the test-handle of the orchestrator.
	// This may not be a Go-test handle.
	// Orchestrators may be instantiated by dev-tools or test-package TestMain functions.
	P() devtest.P

	// Hydrate adds all services that the orchestrator is aware of to the given system.
	// An orchestrator may be asked to hydrate different systems, one for each test.
	Hydrate(sys ExtensibleSystem)

	ControlPlane() ControlPlane

	Type() compat.Type
}

Orchestrator is the base interface for all system orchestrators. It imposes some common things across all orchestrators, but may also have optional extensions, that not every type of backend might support.

type Superchain added in v1.13.3 

type Superchain interface {
	Common
	ID() SuperchainID

	Deployment() SuperchainDeployment
}

Superchain is a collection of L2 chains with common rules and shared configuration on L1

func SortSuperchains added in v1.13.3 

func SortSuperchains(elems []Superchain) []Superchain

type SuperchainDeployment 

type SuperchainDeployment interface {
	ProtocolVersionsAddr() common.Address
	SuperchainConfigAddr() common.Address
}

type SuperchainID added in v1.13.3 

type SuperchainID genericID

SuperchainID identifies a Superchain by name, is type-safe, and can be value-copied and used as map key.

func SortSuperchainIDs added in v1.13.3 

func SortSuperchainIDs(ids []SuperchainID) []SuperchainID

func (SuperchainID) Kind added in v1.13.4 

func (id SuperchainID) Kind() Kind

func (SuperchainID) LogValue added in v1.13.4 

func (id SuperchainID) LogValue() slog.Value

func (SuperchainID) MarshalText added in v1.13.3 

func (id SuperchainID) MarshalText() ([]byte, error)

func (SuperchainID) Match added in v1.13.3 

func (id SuperchainID) Match(elems []Superchain) []Superchain

func (SuperchainID) String added in v1.13.3 

func (id SuperchainID) String() string

func (*SuperchainID) UnmarshalText added in v1.13.3 

func (id *SuperchainID) UnmarshalText(data []byte) error

type SuperchainMatcher added in v1.13.3 

type SuperchainMatcher = Matcher[SuperchainID, Superchain]

type Supervisor 

type Supervisor interface {
	Common
	ID() SupervisorID

	AdminAPI() apis.SupervisorAdminAPI
	QueryAPI() apis.SupervisorQueryAPI
}

Supervisor is an interop service, used to cross-verify messages between chains.

func SortSupervisors added in v1.13.3 

func SortSupervisors(elems []Supervisor) []Supervisor

type SupervisorID added in v1.13.3 

type SupervisorID genericID

SupervisorID identifies a Supervisor by name and chainID, is type-safe, and can be value-copied and used as map key.

func SortSupervisorIDs added in v1.13.3 

func SortSupervisorIDs(ids []SupervisorID) []SupervisorID

func (SupervisorID) Kind added in v1.13.4 

func (id SupervisorID) Kind() Kind

func (SupervisorID) LogValue added in v1.13.4 

func (id SupervisorID) LogValue() slog.Value

func (SupervisorID) MarshalText added in v1.13.3 

func (id SupervisorID) MarshalText() ([]byte, error)

func (SupervisorID) Match added in v1.13.3 

func (id SupervisorID) Match(elems []Supervisor) []Supervisor

func (SupervisorID) String added in v1.13.3 

func (id SupervisorID) String() string

func (*SupervisorID) UnmarshalText added in v1.13.3 

func (id *SupervisorID) UnmarshalText(data []byte) error

type SupervisorMatcher added in v1.13.3 

type SupervisorMatcher = Matcher[SupervisorID, Supervisor]

type SyncTester 

type SyncTester interface {
	Common
	ID() SyncTesterID
	API() apis.SyncTester

	APIWithSession(sessionID string) apis.SyncTester
}

func SortSyncTesters added in v1.13.6 

func SortSyncTesters(elems []SyncTester) []SyncTester

type SyncTesterID added in v1.13.6 

type SyncTesterID idWithChain

SyncTesterID identifies a syncTester by name and chainID, is type-safe, and can be value-copied and used as map key.

func NewSyncTesterID added in v1.13.6 

func NewSyncTesterID(key string, chainID eth.ChainID) SyncTesterID

func SortSyncTesterIDs added in v1.13.6 

func SortSyncTesterIDs(ids []SyncTesterID) []SyncTesterID

func (SyncTesterID) ChainID added in v1.13.6 

func (id SyncTesterID) ChainID() eth.ChainID

func (SyncTesterID) Key added in v1.13.6 

func (id SyncTesterID) Key() string

func (SyncTesterID) Kind added in v1.13.6 

func (id SyncTesterID) Kind() Kind

func (SyncTesterID) LogValue added in v1.13.6 

func (id SyncTesterID) LogValue() slog.Value

func (SyncTesterID) MarshalText added in v1.13.6 

func (id SyncTesterID) MarshalText() ([]byte, error)

func (SyncTesterID) Match added in v1.13.6 

func (id SyncTesterID) Match(elems []SyncTester) []SyncTester

func (SyncTesterID) String added in v1.13.6 

func (id SyncTesterID) String() string

func (*SyncTesterID) UnmarshalText added in v1.13.6 

func (id *SyncTesterID) UnmarshalText(data []byte) error

type SyncTesterMatcher added in v1.13.6 

type SyncTesterMatcher = Matcher[SyncTesterID, SyncTester]

type System added in v1.13.3 

type System interface {
	Common

	Superchain(m SuperchainMatcher) Superchain
	Cluster(m ClusterMatcher) Cluster
	L1Network(m L1NetworkMatcher) L1Network
	L2Network(m L2NetworkMatcher) L2Network

	Network(id eth.ChainID) Network

	Supervisor(m SupervisorMatcher) Supervisor
	TestSequencer(id TestSequencerMatcher) TestSequencer

	SuperchainIDs() []SuperchainID
	ClusterIDs() []ClusterID
	L1NetworkIDs() []L1NetworkID
	L2NetworkIDs() []L2NetworkID
	SupervisorIDs() []SupervisorID

	Superchains() []Superchain
	Clusters() []Cluster
	L1Networks() []L1Network
	L2Networks() []L2Network
	Supervisors() []Supervisor
	TestSequencers() []TestSequencer
}

System represents a collection of L1 and L2 chains, any superchains or clusters, and any peripherals.

type SystemHook added in v1.13.3 

type SystemHook interface {
	// PreHydrate runs before a system is hydrated,
	// to prepare settings on the system like logging, or inspect test-scope
	PreHydrate(sys System)

	// PostHydrate runs after a system is hydrated, to run any checks.
	// This may register validation that runs at the end of the test, using the sys.T().Cleanup function.
	PostHydrate(sys System)
}

type TestSequencer 

type TestSequencer interface {
	Common
	ID() TestSequencerID

	AdminAPI() apis.TestSequencerAdminAPI
	BuildAPI() apis.TestSequencerBuildAPI
	ControlAPI(chainID eth.ChainID) apis.TestSequencerControlAPI
}

TestSequencer

func SortTestSequencers added in v1.13.4 

func SortTestSequencers(elems []TestSequencer) []TestSequencer

type TestSequencerID added in v1.13.4 

type TestSequencerID genericID

TestSequencerID identifies a TestSequencer by name and chainID, is type-safe, and can be value-copied and used as map key.

func SortTestSequencerIDs added in v1.13.4 

func SortTestSequencerIDs(ids []TestSequencerID) []TestSequencerID

func (TestSequencerID) Kind added in v1.13.4 

func (id TestSequencerID) Kind() Kind

func (TestSequencerID) LogValue added in v1.13.4 

func (id TestSequencerID) LogValue() slog.Value

func (TestSequencerID) MarshalText added in v1.13.4 

func (id TestSequencerID) MarshalText() ([]byte, error)

func (TestSequencerID) String added in v1.13.4 

func (id TestSequencerID) String() string

func (*TestSequencerID) UnmarshalText added in v1.13.4 

func (id *TestSequencerID) UnmarshalText(data []byte) error

type TestSequencerMatcher added in v1.13.4 

type TestSequencerMatcher = Matcher[TestSequencerID, TestSequencer]

type TimeTravelClock added in v1.13.4 

type TimeTravelClock interface {
	AdvanceTime(d time.Duration)
}

type TimeTravelOrchestrator added in v1.13.4 

type TimeTravelOrchestrator interface {
	EnableTimeTravel()
}

type TimeTravelSystem added in v1.13.4 

type TimeTravelSystem interface {
	System
	SetTimeTravelClock(cl TimeTravelClock)
	TimeTravelEnabled() bool
	AdvanceTime(amount time.Duration)
}

TimeTravelSystem is an extension-interface to support time travel.

Source Files

View all Source files

Directories

Path Synopsis
Package match provides matching presets and utils for selecting devstack components.
 Package match provides matching presets and utils for selecting devstack components.

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.