relay

Documentation

Index

• func NewRelayerAdapter(r types.Relayer, e RelayerExt) loop.Relayer
• type ChainID
  • func (c ChainID) Int64() (int64, error)
  • func (c ChainID) String() string
• type ID
  • func NewID(n Network, c ChainID) (ID, error)
  • func (i *ID) Name() string
  • func (i *ID) String() string
  • func (i *ID) UnmarshalString(s string) error
• type Network
• type RelayerExt

Functions

func NewRelayerAdapter

func NewRelayerAdapter(r types.Relayer, e RelayerExt) loop.Relayer

NewRelayerAdapter returns a loop.Relayer adapted from a types.Relayer and RelayerExt.

Types

type ChainID

type ChainID string

func (ChainID) Int64

func (c ChainID) Int64() (int64, error)

func (ChainID) String

func (c ChainID) String() string

type ID

type ID struct {
	Network Network
	ChainID ChainID
}

ID uniquely identifies a relayer by network and chain id

func NewID

func NewID(n Network, c ChainID) (ID, error)

func (*ID) Name

func (i *ID) Name() string

func (*ID) String

func (i *ID) String() string

func (*ID) UnmarshalString

func (i *ID) UnmarshalString(s string) error

type Network

type Network string

var (
	EVM             Network = "evm"
	Cosmos          Network = "cosmos"
	Solana          Network = "solana"
	StarkNet        Network = "starknet"
	SupportedRelays         = map[Network]struct{}{
		EVM:      {},
		Cosmos:   {},
		Solana:   {},
		StarkNet: {},
	}
)

type RelayerExt

type RelayerExt interface {
	types.ChainService
	// TODO remove after BFC-2441
	ID() string
	GetChainStatus(ctx context.Context) (types.ChainStatus, error)
	ListNodeStatuses(ctx context.Context, pageSize int32, pageToken string) (stats []types.NodeStatus, nextPageToken string, total int, err error)
	// choose different name than SendTx to avoid collison during refactor.
	Transact(ctx context.Context, from, to string, amount *big.Int, balanceCheck bool) error
}

RelayerExt is a subset of loop.Relayer for adapting types.Relayer, typically with a Chain. See [relayerAdapter].