netman

Documentation

Index

• type DeployInfo
• type Manager
  • func NewManager(testnet types.Testnet, backends ethbackend.Backends, relayerKeyFile string) (Manager, error)
• type Portal

Types

type DeployInfo

type DeployInfo struct {
	PortalAddress common.Address
	DeployHeight  uint64
}

DeployInfo contains the deployed portal address and height.

type Manager

type Manager interface {
	// DeployPublicPortals deploys portals to public chains, like arb-goerli.
	DeployPublicPortals(ctx context.Context, valSetID uint64, validators []bindings.Validator) error

	// DeployInfo returns the deployed network information.
	// Note that the private chains has to be deterministic, since this is called before deploying private portals.
	DeployInfo() map[types.EVMChain]DeployInfo

	// DeployPrivatePortals deploys portals to private (docker) chains.
	DeployPrivatePortals(ctx context.Context, valSetID uint64, validators []bindings.Validator) error

	// Portals returns the deployed portals from both public and private chains.
	Portals() map[uint64]Portal

	// RelayerKey returns the relayer private key hex.
	RelayerKey() *ecdsa.PrivateKey

	// Operator returns the address of the account that operates the network.
	Operator() common.Address
}

Manager abstract logic to deploy and bootstrap a network.

func NewManager

func NewManager(testnet types.Testnet, backends ethbackend.Backends, relayerKeyFile string) (Manager, error)

type Portal

type Portal struct {
	Chain      types.EVMChain
	DeployInfo DeployInfo
	Contract   *bindings.OmniPortal
}

Portal contains all deployed portal information and state.