worldgen

Documentation

Index

• Constants
• func CLIFlags() []cli.Flag
• func GenerateWorld(ctx context.Context, logger log.Logger, monorepoArtifacts *foundry.ArtifactsFS, ...) (*interopgen.WorldDeployment, *interopgen.WorldOutput, error)
• func SupersimDevOperatorKeys(chainID *big.Int) func(SupersimDevOperatorRole) SupersimDevOperatorKey
• type CLIConfig
  • func ParseCLIConfig(ctx *cli.Context) (*CLIConfig, error)
• type DeployL2PeripheryContractsScript
• type SupersimDevOperatorKey
  • func (k SupersimDevOperatorKey) HDPath() string
  • func (k SupersimDevOperatorKey) String() string
• type SupersimDevOperatorRole
  • func (role SupersimDevOperatorRole) Key(chainID *big.Int) devkeys.Key
  • func (role SupersimDevOperatorRole) String() string

Constants

const (
	MonorepoArtifactsUrlFlag  = "monorepo-artifacts"
	PeripheryArtifactsUrlFlag = "periphery-artifacts"
	OutDirFlag                = "outdir"
)

const (
	// PeripheryContractsDeployerRole is the role of the account that deploys the periphery contracts to the L2
	PeripheryContractsDeployerRole = 0

	// AutoRelayerSenderRole is the sender of the interop.autorelayer transactions
	AutoRelayerSenderRole = 1
)

Functions

func CLIFlags

func CLIFlags() []cli.Flag

func GenerateWorld

func GenerateWorld(ctx context.Context, logger log.Logger, monorepoArtifacts *foundry.ArtifactsFS, peripheryArtifacts *foundry.ArtifactsFS) (*interopgen.WorldDeployment, *interopgen.WorldOutput, error)

func SupersimDevOperatorKeys

func SupersimDevOperatorKeys(chainID *big.Int) func(SupersimDevOperatorRole) SupersimDevOperatorKey

SupersimDevOperatorKeys is a helper method to not repeat chainID on every operator role

Types

type CLIConfig

type CLIConfig struct {
	MonorepoArtifactsURL  *url.URL
	PeripheryArtifactsURL *url.URL
	Outdir                string
}

func ParseCLIConfig

func ParseCLIConfig(ctx *cli.Context) (*CLIConfig, error)

type DeployL2PeripheryContractsScript

type DeployL2PeripheryContractsScript struct {
	Run func() error
}

type SupersimDevOperatorKey

type SupersimDevOperatorKey struct {
	ChainID *big.Int
	Role    SupersimDevOperatorRole
}

SupersimDevOperatorKey is an account specific to an OperationRole of a given OP-Stack chain.

func (SupersimDevOperatorKey) HDPath

func (k SupersimDevOperatorKey) HDPath() string

func (SupersimDevOperatorKey) String

func (k SupersimDevOperatorKey) String() string

type SupersimDevOperatorRole

type SupersimDevOperatorRole uint64

SupersimDevOperatorRole identifies an account for setup and admin tasks run by Supersim These roles don't exist in production OP-Stack chains

func (SupersimDevOperatorRole) Key

func (role SupersimDevOperatorRole) Key(chainID *big.Int) devkeys.Key

func (SupersimDevOperatorRole) String

func (role SupersimDevOperatorRole) String() string