relay

Documentation

Index

• func NewRelayerAdapter(r types.Relayer, e RelayerExt) loop.Relayer
• func NewRelayerServerAdapter(r types.Relayer, e RelayerExt) loop.Relayer
• type ChainID
• type ID
  • func NewID(n Network, c ChainID) ID
  • 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. Unlike NewRelayerServerAdapter which is used to adapt non-LOOPP relayers, this is used to adapt LOOPP-based relayer which are then server over GRPC (by the relayerServer).

func NewRelayerServerAdapter

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

NewRelayerServerAdapter returns a loop.Relayer adapted from a types.Relayer and RelayerExt. Unlike NewRelayerAdapter, this behaves like the loop `RelayerServer` and dispatches calls to `NewPluginProvider` according to the passed in `RelayArgs.ProviderType`. This should only be used to adapt relayers not running via GRPC in a LOOPP.

nolint:staticcheck // SA1019

Types

type ChainID

type ChainID = 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

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
	ID() string
}

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