shim

package
v1.13.2 Latest Latest
Warning

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

Go to latest
Published: Apr 15, 2025 License: MIT Imports: 16 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewCluster

func NewCluster(cfg ClusterConfig) stack.Cluster

func NewFaucet

func NewFaucet(cfg FaucetConfig) stack.Faucet

func NewKeyring added in v1.13.1

func NewKeyring(keys devkeys.Keys, req *require.Assertions) stack.Keys

func NewL1CLNode

func NewL1CLNode(cfg L1CLNodeConfig) stack.L1CLNode

func NewL1ELNode

func NewL1ELNode(cfg L1ELNodeConfig) stack.L1ELNode

func NewL2Batcher

func NewL2Batcher(cfg L2BatcherConfig) stack.L2Batcher

func NewL2CLNode

func NewL2CLNode(cfg L2CLNodeConfig) stack.L2CLNode

func NewL2Challenger

func NewL2Challenger(cfg L2ChallengerConfig) stack.L2Challenger

func NewL2ELNode

func NewL2ELNode(cfg L2ELNodeConfig) stack.L2ELNode

func NewL2Proposer

func NewL2Proposer(cfg L2ProposerConfig) stack.L2Proposer

func NewSuperchain

func NewSuperchain(cfg SuperchainConfig) stack.Superchain

func NewSupervisor

func NewSupervisor(cfg SupervisorConfig) stack.Supervisor

func NewSystem

func NewSystem(t devtest.T) stack.ExtensibleSystem

NewSystem creates a new empty System

func NewUser

func NewUser(cfg UserConfig) stack.User

Types

type ClusterConfig

type ClusterConfig struct {
	CommonConfig
	DependencySet depset.DependencySet
	ID            stack.ClusterID
}

ClusterConfig is the config to create a default cluster object

type CommonConfig

type CommonConfig struct {
	// Log is the logger to use, annotated with metadata.
	// Shim constructors generally add default annotations like the component "id" and "chain"
	Log log.Logger
	T   devtest.T
}

CommonConfig provides common inputs for creating a new component

func NewCommonConfig added in v1.13.1

func NewCommonConfig(t devtest.T) CommonConfig

NewCommonConfig is a convenience method to build the config common between all components. Note that component constructors will decorate the logger with metadata for internal use, the caller of the component constructor can generally leave the logger as-is.

type ELNodeConfig

type ELNodeConfig struct {
	CommonConfig
	Client  client.RPC
	ChainID eth.ChainID
}

type FaucetConfig

type FaucetConfig struct {
	CommonConfig
	ID stack.FaucetID
}

type L1CLNodeConfig

type L1CLNodeConfig struct {
	CommonConfig
	ID     stack.L1CLNodeID
	Client client.HTTP
}

type L1ELNodeConfig

type L1ELNodeConfig struct {
	ELNodeConfig
	ID stack.L1ELNodeID
}

type L1NetworkConfig

type L1NetworkConfig struct {
	NetworkConfig
	ID stack.L1NetworkID
}

type L2BatcherConfig

type L2BatcherConfig struct {
	CommonConfig
	ID     stack.L2BatcherID
	Client client.RPC
}

type L2CLNodeConfig

type L2CLNodeConfig struct {
	CommonConfig
	ID     stack.L2CLNodeID
	Client client.RPC
}

type L2ChallengerConfig

type L2ChallengerConfig struct {
	CommonConfig
	ID stack.L2ChallengerID
}

type L2ELNodeConfig

type L2ELNodeConfig struct {
	ELNodeConfig
	ID stack.L2ELNodeID
}

type L2NetworkConfig

type L2NetworkConfig struct {
	NetworkConfig
	ID           stack.L2NetworkID
	RollupConfig *rollup.Config
	Deployment   stack.L2Deployment
	Keys         stack.Keys

	Superchain stack.Superchain
	L1         stack.L1Network
	Cluster    stack.Cluster
}

type L2ProposerConfig

type L2ProposerConfig struct {
	CommonConfig
	ID     stack.L2ProposerID
	Client client.RPC
}

type NetworkConfig

type NetworkConfig struct {
	CommonConfig
	ChainConfig *params.ChainConfig
}

type SuperchainConfig

type SuperchainConfig struct {
	CommonConfig
	ID         stack.SuperchainID
	Deployment stack.SuperchainDeployment
}

type SupervisorConfig

type SupervisorConfig struct {
	CommonConfig
	ID     stack.SupervisorID
	Client client.RPC
}

type SystemConfig

type SystemConfig struct {
	CommonConfig
}

SystemConfig sets up a System. It is intentially very minimal, the system is expected to be extended after creation, using Option functions

type UserConfig

type UserConfig struct {
	CommonConfig
	ID   stack.UserID
	Priv *ecdsa.PrivateKey
	EL   stack.ELNode
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL