externalchains

Documentation

Index

• type Chains
  • func NewChains(pushCore *pushcore.Client, pushSigner *pushsigner.Signer, cfg *config.Config, ...) *Chains
  • func (c *Chains) GetClient(chainID string) (common.ChainClient, error)
  • func (c *Chains) GetStandardConfirmations(chainID string) uint64
  • func (c *Chains) IsChainInboundEnabled(chainID string) bool
  • func (c *Chains) IsChainOutboundEnabled(chainID string) bool
  • func (c *Chains) IsEVMChain(chainID string) bool
  • func (c *Chains) Start(ctx context.Context) error
  • func (c *Chains) Stop()
  • func (c *Chains) StopAll()

Types

type Chains

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

Chains manages chain clients by fetching chain configs periodically and adding/removing clients accordingly

func NewChains

func NewChains(
	pushCore *pushcore.Client,
	pushSigner *pushsigner.Signer,
	cfg *config.Config,
	logger zerolog.Logger,
) *Chains

NewChains creates a new chains manager

func (*Chains) GetClient

func (c *Chains) GetClient(chainID string) (common.ChainClient, error)

GetClient returns the chain client for the specified chain ID

func (*Chains) GetStandardConfirmations

func (c *Chains) GetStandardConfirmations(chainID string) uint64

GetStandardConfirmations returns the chain's standard block confirmations from registry config (BlockConfirmation.StandardInbound). Used for outbound tx completion. Returns 12 if not set.

func (*Chains) IsChainInboundEnabled

func (c *Chains) IsChainInboundEnabled(chainID string) bool

IsChainInboundEnabled returns whether inbound is enabled for the given chain

func (*Chains) IsChainOutboundEnabled

func (c *Chains) IsChainOutboundEnabled(chainID string) bool

IsChainOutboundEnabled returns whether outbound is enabled for the given chain

func (*Chains) IsEVMChain

func (c *Chains) IsEVMChain(chainID string) bool

IsEVMChain returns true if the chain uses EVM (e.g. Ethereum, BSC). Used by coordinator for nonce behaviour.

func (*Chains) Start

func (c *Chains) Start(ctx context.Context) error

Start begins fetching chains and managing chain clients

func (*Chains) Stop

func (c *Chains) Stop()

Stop stops the chains manager

func (*Chains) StopAll

func (c *Chains) StopAll()

StopAll stops all chain clients