portal

Documentation

Index

• Constants
• func AddrForNetwork(network netconf.ID) (common.Address, bool)
• func Deploy(ctx context.Context, network netconf.ID, backend *ethbackend.Backend, ...) (common.Address, *ethtypes.Receipt, error)
• func IsDeployed(ctx context.Context, network netconf.ID, backend *ethbackend.Backend) (bool, common.Address, error)
• type DeploymentConfig
  • func (cfg DeploymentConfig) Validate() error

Constants

const (
	XMsgMinGasLimit       = 21_000
	XMsgMaxGasLimit       = 5_000_000
	XMsgMaxDataSize       = 20_000
	XReceiptMaxErrorBytes = 256

	GenesisCChainXMsgOffset   = 1
	GenesisCChainXBlockOffset = 1
)

Functions

func AddrForNetwork

func AddrForNetwork(network netconf.ID) (common.Address, bool)

func Deploy

func Deploy(ctx context.Context, network netconf.ID, backend *ethbackend.Backend, feeOracle common.Address, valSetID uint64, validators []bindings.Validator,
) (common.Address, *ethtypes.Receipt, error)

Deploy deploys a new Portal contract and returns the address and receipt. It only allows deployments to explicitly supported chains.

func IsDeployed

func IsDeployed(ctx context.Context, network netconf.ID, backend *ethbackend.Backend) (bool, common.Address, error)

IsDeployed checks if the Portal contract is deployed to the provided backend to its expected network address.

Types

type DeploymentConfig

type DeploymentConfig struct {
	Create3Factory        common.Address
	Create3Salt           string
	ProxyAdmin            common.Address
	Deployer              common.Address
	Owner                 common.Address
	OmniChainID           uint64
	OmniCChainID          uint64
	XMsgMinGasLimit       uint64
	XMsgMaxGasLimit       uint64
	XMsgMaxDataSize       uint16
	XReceiptMaxErrorBytes uint16
	CChainXMsgOffset      uint64
	CChainXBlockOffset    uint64
	ExpectedAddr          common.Address
}

func (DeploymentConfig) Validate

func (cfg DeploymentConfig) Validate() error