manifest

Documentation

Index

• type ChainAcceptor
• type ChainVisitor
• type Component
  • func (c *Component) Accept(visitor ComponentVisitor)
• type ComponentAcceptor
• type ComponentVisitor
• type Contracts
  • func (c *Contracts) Accept(visitor ContractsVisitor)
• type ContractsAcceptor
• type ContractsVisitor
• type DeploymentAcceptor
• type DeploymentVisitor
• type L1Config
  • func (c *L1Config) Accept(visitor ChainVisitor)
• type L2Acceptor
• type L2Chain
  • func (c *L2Chain) Accept(visitor ChainVisitor)
• type L2Config
  • func (c *L2Config) Accept(visitor L2Visitor)
• type L2Deployment
  • func (d *L2Deployment) Accept(visitor DeploymentVisitor)
• type L2Visitor
• type Manifest
  • func (m *Manifest) Accept(visitor ManifestVisitor)
• type ManifestAcceptor
• type ManifestVisitor

Types

type ChainAcceptor

type ChainAcceptor interface {
	Accept(visitor ChainVisitor)
}

type ChainVisitor

type ChainVisitor interface {
	VisitName(name string)
	VisitID(id uint64)
}

type Component

type Component struct {
	Version string `yaml:"version"`
}

func (*Component) Accept

func (c *Component) Accept(visitor ComponentVisitor)

type ComponentAcceptor

type ComponentAcceptor interface {
	Accept(visitor ComponentVisitor)
}

type ComponentVisitor

type ComponentVisitor interface {
	VisitVersion(version string)
}

type Contracts

type Contracts struct {
	Version string `yaml:"version"`
	Locator string `yaml:"locator"`
}

func (*Contracts) Accept

func (c *Contracts) Accept(visitor ContractsVisitor)

type ContractsAcceptor

type ContractsAcceptor interface {
	Accept(visitor ContractsVisitor)
}

type ContractsVisitor

type ContractsVisitor interface {
	VisitVersion(version string)
	VisitLocator(locator string)
}

type DeploymentAcceptor

type DeploymentAcceptor interface {
	Accept(visitor DeploymentVisitor)
}

type DeploymentVisitor

type DeploymentVisitor interface {
	VisitDeployer() ComponentVisitor
	VisitL1Contracts() ContractsVisitor
	VisitL2Contracts() ContractsVisitor
	VisitOverride(string, interface{})
}

type L1Config

type L1Config struct {
	Name    string `yaml:"name"`
	ChainID uint64 `yaml:"chain_id"`
}

L1Config represents L1 configuration

func (*L1Config) Accept

func (c *L1Config) Accept(visitor ChainVisitor)

type L2Acceptor

type L2Acceptor interface {
	Accept(visitor L2Visitor)
}

type L2Chain

type L2Chain struct {
	Name    string `yaml:"name"`
	ChainID uint64 `yaml:"chain_id"`
}

L2Chain represents an L2 chain configuration

func (*L2Chain) Accept

func (c *L2Chain) Accept(visitor ChainVisitor)

type L2Config

type L2Config struct {
	Deployment *L2Deployment         `yaml:"deployment"`
	Components map[string]*Component `yaml:"components"`
	Chains     []*L2Chain            `yaml:"chains"`
}

L2Config represents L2 configuration

func (*L2Config) Accept

func (c *L2Config) Accept(visitor L2Visitor)

type L2Deployment

type L2Deployment struct {
	OpDeployer  *Component             `yaml:"op-deployer"`
	L1Contracts *Contracts             `yaml:"l1-contracts"`
	L2Contracts *Contracts             `yaml:"l2-contracts"`
	Overrides   map[string]interface{} `yaml:"overrides"`
}

L2Deployment represents deployment configuration

func (*L2Deployment) Accept

func (d *L2Deployment) Accept(visitor DeploymentVisitor)

type L2Visitor

type L2Visitor interface {
	VisitL2Component(name string) ComponentVisitor
	VisitL2Deployment() DeploymentVisitor
	VisitL2Chain(int) ChainVisitor
}

type Manifest

type Manifest struct {
	Name string    `yaml:"name"`
	Type string    `yaml:"type"`
	L1   *L1Config `yaml:"l1"`
	L2   *L2Config `yaml:"l2"`
}

Manifest represents the top-level manifest configuration

func (*Manifest) Accept

func (m *Manifest) Accept(visitor ManifestVisitor)

type ManifestAcceptor

type ManifestAcceptor interface {
	Accept(visitor ManifestVisitor)
}

type ManifestVisitor

type ManifestVisitor interface {
	VisitName(name string)
	VisitType(manifestType string)
	VisitL1() ChainVisitor
	VisitL2() L2Visitor
}