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 ¶
- func WithAllLocalUnsafeHeadsAdvancedBy(blocks uint64) func(cfg *VerifySyncStatusConfig)
- type Cluster
- type Faucet
- type L1CLNode
- type L1ELNode
- type L1Network
- type L2Batcher
- type L2CLNode
- type L2Challenger
- type L2ELNode
- type L2Network
- type L2Proposer
- type Superchain
- type Supervisor
- type VerifySyncStatusConfig
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func WithAllLocalUnsafeHeadsAdvancedBy ¶ added in v1.13.1
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.
Types ¶
type Cluster ¶ added in v1.13.2
type Cluster struct {
// contains filtered or unexported fields
}
Cluster wraps a stack.Cluster interface for DSL operations
func NewCluster ¶ added in v1.13.2
NewCluster creates a new Cluster DSL wrapper
type Faucet ¶ added in v1.13.2
type Faucet struct {
// contains filtered or unexported fields
}
Faucet wraps a stack.Faucet interface for DSL operations. 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.
type L1CLNode ¶ added in v1.13.2
type L1CLNode struct {
// contains filtered or unexported fields
}
L1CLNode wraps a stack.L1CLNode interface for DSL operations
func NewL1CLNode ¶ added in v1.13.2
NewL1CLNode creates a new L1CLNode DSL wrapper
type L1ELNode ¶ added in v1.13.2
type L1ELNode struct {
// contains filtered or unexported fields
}
L1ELNode wraps a stack.L1ELNode interface for DSL operations
func NewL1ELNode ¶ added in v1.13.2
NewL1ELNode creates a new L1ELNode DSL wrapper
type L1Network ¶ added in v1.13.2
type L1Network struct {
// contains filtered or unexported fields
}
L1Network wraps a stack.L1Network interface for DSL operations
func NewL1Network ¶ added in v1.13.2
NewL1Network creates a new L1Network DSL wrapper
type L2Batcher ¶ added in v1.13.2
type L2Batcher struct {
// contains filtered or unexported fields
}
L2Batcher wraps a stack.L2Batcher interface for DSL operations
func NewL2Batcher ¶ added in v1.13.2
NewL2Batcher creates a new L2Batcher DSL wrapper
type L2CLNode ¶ added in v1.13.2
type L2CLNode struct {
// contains filtered or unexported fields
}
L2CLNode wraps a stack.L2CLNode interface for DSL operations
func NewL2CLNode ¶ added in v1.13.2
NewL2CLNode creates a new L2CLNode DSL wrapper
type L2Challenger ¶ added in v1.13.2
type L2Challenger struct {
// contains filtered or unexported fields
}
L2Challenger wraps a stack.L2Challenger interface for DSL operations
func NewL2Challenger ¶ added in v1.13.2
func NewL2Challenger(inner stack.L2Challenger) *L2Challenger
NewL2Challenger creates a new L2Challenger DSL wrapper
func (*L2Challenger) Escape ¶ added in v1.13.2
func (c *L2Challenger) Escape() stack.L2Challenger
Escape returns the underlying stack.L2Challenger
func (*L2Challenger) String ¶ added in v1.13.2
func (c *L2Challenger) String() string
type L2ELNode ¶ added in v1.13.2
type L2ELNode struct {
// contains filtered or unexported fields
}
L2ELNode wraps a stack.L2ELNode interface for DSL operations
func NewL2ELNode ¶ added in v1.13.2
NewL2ELNode creates a new L2ELNode DSL wrapper
type L2Network ¶ added in v1.13.2
type L2Network struct {
// contains filtered or unexported fields
}
L2Network wraps a stack.L2Network interface for DSL operations
func NewL2Network ¶ added in v1.13.2
NewL2Network creates a new L2Network DSL wrapper
type L2Proposer ¶ added in v1.13.2
type L2Proposer struct {
// contains filtered or unexported fields
}
L2Proposer wraps a stack.L2Proposer interface for DSL operations
func NewL2Proposer ¶ added in v1.13.2
func NewL2Proposer(inner stack.L2Proposer) *L2Proposer
NewL2Proposer creates a new L2Proposer DSL wrapper
func (*L2Proposer) Escape ¶ added in v1.13.2
func (p *L2Proposer) Escape() stack.L2Proposer
Escape returns the underlying stack.L2Proposer
func (*L2Proposer) String ¶ added in v1.13.2
func (p *L2Proposer) String() string
type Superchain ¶ added in v1.13.2
type Superchain struct {
// contains filtered or unexported fields
}
Superchain wraps a stack.Superchain interface for DSL operations
func NewSuperchain ¶ added in v1.13.2
func NewSuperchain(inner stack.Superchain) *Superchain
NewSuperchain creates a new Superchain DSL wrapper
func (*Superchain) Escape ¶ added in v1.13.2
func (s *Superchain) Escape() stack.Superchain
Escape returns the underlying stack.Superchain
func (*Superchain) String ¶ added in v1.13.2
func (s *Superchain) String() string
type Supervisor ¶ added in v1.13.1
type Supervisor struct {
// contains filtered or unexported fields
}
func NewSupervisor ¶ added in v1.13.2
func NewSupervisor(inner stack.Supervisor) *Supervisor
func (*Supervisor) Escape ¶ added in v1.13.2
func (s *Supervisor) Escape() stack.Supervisor
func (*Supervisor) String ¶ added in v1.13.2
func (s *Supervisor) String() string
func (*Supervisor) VerifySyncStatus ¶ added in v1.13.1
func (s *Supervisor) VerifySyncStatus(opts ...func(config *VerifySyncStatusConfig))
VerifySyncStatus performs assertions based on the supervisor's SyncStatus endpoint.
type VerifySyncStatusConfig ¶ added in v1.13.1
type VerifySyncStatusConfig struct {
AllUnsafeHeadsAdvance uint64
}