config

Documentation

Index

• Variables
• type ChainType
  • func ChainTypeFromSlug(slug string) ChainType
  • func (c ChainType) IsL2() bool
  • func (c ChainType) IsValid() bool
• type ChainTypeConfig
  • func NewChainTypeConfig(slug string) *ChainTypeConfig
  • func (c *ChainTypeConfig) ChainType() ChainType
  • func (c *ChainTypeConfig) MarshalText() ([]byte, error)
  • func (c *ChainTypeConfig) Slug() string
  • func (c *ChainTypeConfig) String() string
  • func (c *ChainTypeConfig) UnmarshalText(b []byte) error

Variables

var ErrInvalidChainType = fmt.Errorf("must be one of %s or omitted", strings.Join([]string{
	string(ChainArbitrum),
	string(ChainCelo),
	string(ChainGnosis),
	string(ChainKroma),
	string(ChainMetis),
	string(ChainOptimismBedrock),
	string(ChainScroll),
	string(ChainWeMix),
	string(ChainXLayer),
	string(ChainZkSync),
}, ", "))

Types

type ChainType

type ChainType string

const (
	ChainArbitrum        ChainType = "arbitrum"
	ChainCelo            ChainType = "celo"
	ChainGnosis          ChainType = "gnosis"
	ChainKroma           ChainType = "kroma"
	ChainMetis           ChainType = "metis"
	ChainOptimismBedrock ChainType = "optimismBedrock"
	ChainScroll          ChainType = "scroll"
	ChainWeMix           ChainType = "wemix"
	ChainXLayer          ChainType = "xlayer"
	ChainZkSync          ChainType = "zksync"
)

func ChainTypeFromSlug

func ChainTypeFromSlug(slug string) ChainType

func (ChainType) IsL2

func (c ChainType) IsL2() bool

IsL2 returns true if this chain is a Layer 2 chain. Notably:

• the block numbers used for log searching are different from calling block.number
• gas bumping is not supported, since there is no tx mempool

func (ChainType) IsValid

func (c ChainType) IsValid() bool

type ChainTypeConfig

type ChainTypeConfig struct {
	// contains filtered or unexported fields
}

func NewChainTypeConfig

func NewChainTypeConfig(slug string) *ChainTypeConfig

func (*ChainTypeConfig) ChainType

func (c *ChainTypeConfig) ChainType() ChainType

func (*ChainTypeConfig) MarshalText

func (c *ChainTypeConfig) MarshalText() ([]byte, error)

func (*ChainTypeConfig) Slug

func (c *ChainTypeConfig) Slug() string

func (*ChainTypeConfig) String

func (c *ChainTypeConfig) String() string

func (*ChainTypeConfig) UnmarshalText

func (c *ChainTypeConfig) UnmarshalText(b []byte) error