evm

Documentation

Index

• type AppConfig
• type Chain
  • func NewTOMLChain(ctx context.Context, chain *toml.EVMConfig, opts ChainRelayExtenderConfig) (Chain, error)
• type ChainRelayExtenderConfig
  • func (opts *ChainRelayExtenderConfig) Check() error
• type LegacyChainContainer
• type LegacyChains
  • func NewLegacyChains(m map[string]Chain, evmCfgs toml.EVMConfigs) *LegacyChains
  • func (c *LegacyChains) ChainNodeConfigs() evmtypes.Configs
  • func (c *LegacyChains) Get(id string) (Chain, error)
• type RelayerConfig

Types

type AppConfig

type AppConfig interface {
	config.AppConfig
	toml.HasEVMConfigs
}

TODO BCF-2509 what is this and does it need the entire app config?

type Chain

type Chain interface {
	types.ChainService

	ID() *big.Int
	Client() evmclient.Client
	Config() evmconfig.ChainScopedConfig
	LogBroadcaster() log.Broadcaster
	HeadBroadcaster() httypes.HeadBroadcaster
	TxManager() txmgr.TxManager
	HeadTracker() httypes.HeadTracker
	Logger() logger.Logger
	BalanceMonitor() monitor.BalanceMonitor
	LogPoller() logpoller.LogPoller
	GasEstimator() gas.EvmFeeEstimator
}

func NewTOMLChain

func NewTOMLChain(ctx context.Context, chain *toml.EVMConfig, opts ChainRelayExtenderConfig) (Chain, error)

type ChainRelayExtenderConfig

type ChainRelayExtenderConfig struct {
	Logger   logger.Logger
	DB       *sqlx.DB
	KeyStore keystore.Eth
	*RelayerConfig
}

func (*ChainRelayExtenderConfig) Check

func (opts *ChainRelayExtenderConfig) Check() error

type LegacyChainContainer

type LegacyChainContainer interface {
	Get(id string) (Chain, error)
	Len() int
	List(ids ...string) ([]Chain, error)
	Slice() []Chain

	// BCF-2516: this is only used for EVMORM. When we delete that
	// we can promote/move the needed funcs from it to LegacyChainContainer
	// so instead of EVMORM().XYZ() we'd have something like legacyChains.XYZ()
	ChainNodeConfigs() evmtypes.Configs
}

LegacyChainContainer is container for EVM chains.

type LegacyChains

type LegacyChains struct {
	*chains.ChainsKV[Chain]
	// contains filtered or unexported fields
}

LegacyChains implements LegacyChainContainer

func NewLegacyChains

func NewLegacyChains(m map[string]Chain, evmCfgs toml.EVMConfigs) *LegacyChains

func (*LegacyChains) ChainNodeConfigs

func (c *LegacyChains) ChainNodeConfigs() evmtypes.Configs

func (*LegacyChains) Get

func (c *LegacyChains) Get(id string) (Chain, error)

backward compatibility. eth keys are represented as multiple types in the code base; *big.Int, string, and int64.

TODO BCF-2507 unify the type system

type RelayerConfig

type RelayerConfig struct {
	AppConfig AppConfig

	EventBroadcaster pg.EventBroadcaster
	MailMon          *utils.MailboxMonitor
	GasEstimator     gas.EvmFeeEstimator

	// TODO BCF-2513 remove test code from the API
	// Gen-functions are useful for dependency injection by tests
	GenEthClient      func(*big.Int) client.Client
	GenLogBroadcaster func(*big.Int) log.Broadcaster
	GenLogPoller      func(*big.Int) logpoller.LogPoller
	GenHeadTracker    func(*big.Int, httypes.HeadBroadcaster) httypes.HeadTracker
	GenTxManager      func(*big.Int) txmgr.TxManager
	GenGasEstimator   func(*big.Int) gas.EvmFeeEstimator
}

options for the relayer factory. TODO BCF-2508 clean up configuration of chain and relayer after BCF-2440 the factory wants to own the logger and db the factory creates extenders, which need the same and more opts