provider

package
v2.5.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 28, 2024 License: Apache-2.0 Imports: 19 Imported by: 34

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CheckForMisbehaviour added in v2.3.0 

func CheckForMisbehaviour(
	ctx context.Context,
	counterparty ChainProvider,
	clientID string,
	proposedHeader []byte,
	cachedHeader IBCHeader,
) (ibcexported.ClientMessage, error)

CheckForMisbehaviour checks that a proposed header, for updating a light client, contains a consensus state that matches the trusted consensus state from the counterparty for the same block height. If the consensus states for the proposed header and the trusted header match then both returned values will be nil.

func ClientsMatch added in v2.1.0 

func ClientsMatch(ctx context.Context, src, dst ChainProvider, existingClient clienttypes.IdentifiedClientState, newClient ibcexported.ClientState) (string, error)

ClientsMatch will check the type of an existing light client on the src chain, tracking the dst chain, and run an appropriate matcher function to determine if the existing client's state matches a proposed new client state constructed from the dst chain.

Types

type BroadcastMode added in v2.3.0 

type BroadcastMode string
const (
	BroadcastModeSingle BroadcastMode = "single"
	BroadcastModeBatch  BroadcastMode = "batch"
)

type ChainProvider 

type ChainProvider interface {
	QueryProvider
	KeyProvider

	Init(ctx context.Context) error

	// [Begin] Client IBC message assembly functions
	NewClientState(dstChainID string, dstIBCHeader IBCHeader, dstTrustingPeriod, dstUbdPeriod, maxClockDrift time.Duration, allowUpdateAfterExpiry, allowUpdateAfterMisbehaviour bool) (ibcexported.ClientState, error)

	MsgCreateClient(clientState ibcexported.ClientState, consensusState ibcexported.ConsensusState) (RelayerMessage, error)

	MsgUpgradeClient(srcClientId string, consRes *clienttypes.QueryConsensusStateResponse, clientRes *clienttypes.QueryClientStateResponse) (RelayerMessage, error)

	MsgSubmitMisbehaviour(clientID string, misbehaviour ibcexported.ClientMessage) (RelayerMessage, error)

	// ValidatePacket makes sure packet is valid to be relayed.
	// It should return TimeoutHeightError, TimeoutTimestampError, or TimeoutOnCloseError
	// for packet timeout scenarios so that timeout message can be written to other chain.
	ValidatePacket(msgTransfer PacketInfo, latestBlock LatestBlock) error

	// PacketCommitment queries for proof that a MsgTransfer has been committed on the chain.
	PacketCommitment(ctx context.Context, msgTransfer PacketInfo, height uint64) (PacketProof, error)

	// PacketAcknowledgement queries for proof that a MsgRecvPacket has been committed on the chain.
	PacketAcknowledgement(ctx context.Context, msgRecvPacket PacketInfo, height uint64) (PacketProof, error)

	// PacketReceipt queries for proof that a MsgRecvPacket has not been committed to the chain.
	PacketReceipt(ctx context.Context, msgTransfer PacketInfo, height uint64) (PacketProof, error)

	// NextSeqRecv queries for the appropriate proof required to prove the next expected packet sequence number
	// for a given counterparty channel. This is used in ORDERED channels to ensure packets are being delivered in the
	// exact same order as they were sent over the wire.
	NextSeqRecv(ctx context.Context, msgTransfer PacketInfo, height uint64) (PacketProof, error)

	// MsgTransfer constructs a MsgTransfer message ready to write to the chain.
	MsgTransfer(dstAddr string, amount sdk.Coin, info PacketInfo) (RelayerMessage, error)

	// MsgRecvPacket takes the packet information from a MsgTransfer along with the packet commitment,
	// and assembles a full MsgRecvPacket ready to write to the chain.
	MsgRecvPacket(msgTransfer PacketInfo, proof PacketProof) (RelayerMessage, error)

	// MsgAcknowledgement takes the packet information from a MsgRecvPacket along with the packet acknowledgement,
	// and assembles a full MsgAcknowledgement ready to write to the chain.
	MsgAcknowledgement(msgRecvPacket PacketInfo, proofAcked PacketProof) (RelayerMessage, error)

	// MsgTimeout takes the packet information from a MsgTransfer along
	// with the packet receipt to prove that the packet was never relayed,
	// i.e. that the MsgRecvPacket was never written to the counterparty chain,
	// and assembles a full MsgTimeout ready to write to the chain,
	// i.e. the chain where the MsgTransfer was committed.
	MsgTimeout(msgTransfer PacketInfo, proofUnreceived PacketProof) (RelayerMessage, error)

	// MsgTimeoutOnClose takes the packet information from a MsgTransfer along
	// with the packet receipt to prove that the packet was never relayed,
	// i.e. that the MsgRecvPacket was never written to the counterparty chain,
	// and assembles a full MsgTimeoutOnClose ready to write to the chain,
	// i.e. the chain where the MsgTransfer was committed.
	MsgTimeoutOnClose(msgTransfer PacketInfo, proofUnreceived PacketProof) (RelayerMessage, error)

	// Get the commitment prefix of the chain.
	CommitmentPrefix() commitmenttypes.MerklePrefix

	// ConnectionHandshakeProof queries for proof of an initialized connection handshake.
	ConnectionHandshakeProof(ctx context.Context, msgOpenInit ConnectionInfo, height uint64) (ConnectionProof, error)

	// ConnectionProof queries for proof of an acked handshake.
	ConnectionProof(ctx context.Context, msgOpenAck ConnectionInfo, height uint64) (ConnectionProof, error)

	// MsgConnectionOpenInit takes connection info and assembles a MsgConnectionOpenInit message
	// ready to write to the chain. The connection proof is not needed here, but it needs
	// the same signature as the other connection message assembly methods.
	MsgConnectionOpenInit(info ConnectionInfo, proof ConnectionProof) (RelayerMessage, error)

	// MsgConnectionOpenTry takes connection info along with the proof that the connection has been initialized
	// on the counterparty chain, and assembles a MsgConnectionOpenTry message ready to write to the chain.
	MsgConnectionOpenTry(msgOpenInit ConnectionInfo, proof ConnectionProof) (RelayerMessage, error)

	// MsgConnectionOpenAck takes connection info along with the proof that the connection try has occurred
	// on the counterparty chain, and assembles a MsgConnectionOpenAck message ready to write to the chain.
	MsgConnectionOpenAck(msgOpenTry ConnectionInfo, proof ConnectionProof) (RelayerMessage, error)

	// MsgConnectionOpenConfirm takes connection info along with the proof that the connection ack has occurred
	// on the counterparty chain, and assembles a MsgConnectionOpenConfirm message ready to write to the chain.
	MsgConnectionOpenConfirm(msgOpenAck ConnectionInfo, proof ConnectionProof) (RelayerMessage, error)

	// ChannelProof queries for proof of a channel state.
	ChannelProof(ctx context.Context, msg ChannelInfo, height uint64) (ChannelProof, error)

	// MsgChannelOpenInit takes channel info and assembles a MsgChannelOpenInit message
	// ready to write to the chain. The channel proof is not needed here, but it needs
	// the same signature as the other channel message assembly methods.
	MsgChannelOpenInit(info ChannelInfo, proof ChannelProof) (RelayerMessage, error)

	// MsgChannelOpenTry takes channel info along with the proof that the channel has been initialized
	// on the counterparty chain, and assembles a MsgChannelOpenTry message ready to write to the chain.
	MsgChannelOpenTry(msgOpenInit ChannelInfo, proof ChannelProof) (RelayerMessage, error)

	// MsgChannelOpenAck takes channel info along with the proof that the channel try has occurred
	// on the counterparty chain, and assembles a MsgChannelOpenAck message ready to write to the chain.
	MsgChannelOpenAck(msgOpenTry ChannelInfo, proof ChannelProof) (RelayerMessage, error)

	// MsgChannelOpenConfirm takes connection info along with the proof that the channel ack has occurred
	// on the counterparty chain, and assembles a MsgChannelOpenConfirm message ready to write to the chain.
	MsgChannelOpenConfirm(msgOpenAck ChannelInfo, proof ChannelProof) (RelayerMessage, error)

	// MsgChannelCloseInit takes channel info and assembles a MsgChannelCloseInit message
	// ready to write to the chain. The channel proof is not needed here, but it needs
	// the same signature as the other channel message assembly methods.
	MsgChannelCloseInit(info ChannelInfo, proof ChannelProof) (RelayerMessage, error)

	// MsgChannelCloseConfirm takes connection info along with the proof that the channel close has occurred
	// on the counterparty chain, and assembles a MsgChannelCloseConfirm message ready to write to the chain.
	MsgChannelCloseConfirm(msgCloseInit ChannelInfo, proof ChannelProof) (RelayerMessage, error)

	// MsgUpdateClientHeader takes the latest chain header, in addition to the latest client trusted header
	// and assembles a new header for updating the light client on the counterparty chain.
	MsgUpdateClientHeader(latestHeader IBCHeader, trustedHeight clienttypes.Height, trustedHeader IBCHeader) (ibcexported.ClientMessage, error)

	// MsgUpdateClient takes an update client header to prove trust for the previous
	// consensus height and the new height, and assembles a MsgUpdateClient message
	// formatted for this chain.
	MsgUpdateClient(clientID string, counterpartyHeader ibcexported.ClientMessage) (RelayerMessage, error)

	// QueryICQWithProof performs an ABCI query and includes the required proofOps.
	QueryICQWithProof(ctx context.Context, msgType string, request []byte, height uint64) (ICQProof, error)

	// MsgSubmitQueryResponse takes the counterparty chain ID, the ICQ query ID, and the query result proof,
	// then assembles a MsgSubmitQueryResponse message formatted for sending to this chain.
	MsgSubmitQueryResponse(chainID string, queryID ClientICQQueryID, proof ICQProof) (RelayerMessage, error)

	RelayPacketFromSequence(ctx context.Context, src ChainProvider, srch, dsth, seq uint64, srcChanID, srcPortID string, order chantypes.Order) (RelayerMessage, RelayerMessage, error)
	AcknowledgementFromSequence(ctx context.Context, dst ChainProvider, dsth, seq uint64, dstChanID, dstPortID, srcChanID, srcPortID string) (RelayerMessage, error)

	SendMessage(ctx context.Context, msg RelayerMessage, memo string) (*RelayerTxResponse, bool, error)
	SendMessages(ctx context.Context, msgs []RelayerMessage, memo string) (*RelayerTxResponse, bool, error)
	SendMessagesToMempool(
		ctx context.Context,
		msgs []RelayerMessage,
		memo string,

		asyncCtx context.Context,
		asyncCallbacks []func(*RelayerTxResponse, error),
	) error

	MsgRegisterCounterpartyPayee(portID, channelID, relayerAddr, counterpartyPayeeAddr string) (RelayerMessage, error)

	ChainName() string
	ChainId() string
	Type() string
	ProviderConfig() ProviderConfig
	Key() string
	Address() (string, error)
	Timeout() string
	TrustingPeriod(ctx context.Context, overrideUnbondingPeriod time.Duration, percentage int64) (time.Duration, error)
	WaitForNBlocks(ctx context.Context, n int64) error
	Sprint(toPrint proto.Message) (string, error)

	SetRpcAddr(rpcAddr string) error
}

type ChannelInfo added in v2.1.0 

type ChannelInfo struct {
	Height                uint64
	PortID                string
	ChannelID             string
	CounterpartyPortID    string
	CounterpartyChannelID string
	ConnID                string

	// CounterpartyConnID doesn't come from any events, but is needed for
	// MsgChannelOpenTry, so should be added manually for MsgChannelOpenInit.
	CounterpartyConnID string

	Order   chantypes.Order
	Version string
}

ChannelInfo contains relevant properties from channel handshake messages which may be necessary to construct the next message for the counterparty chain.

type ChannelProof added in v2.1.0 

type ChannelProof struct {
	Proof       []byte
	ProofHeight clienttypes.Height
	Ordering    chantypes.Order
	Version     string
}

type ClientICQInfo added in v2.3.0 

type ClientICQInfo struct {
	Source     string
	Connection string
	Chain      string
	QueryID    ClientICQQueryID
	Type       string
	Request    []byte
	Height     uint64
}

ClientICQInfo contains relevant properties from client ICQ messages. Client ICQ implementation does not use IBC connections and channels.

type ClientICQQueryID added in v2.3.0 

type ClientICQQueryID string

ClientICQQueryID string wrapper for query ID.

type ClientState added in v2.1.0 

type ClientState struct {
	ClientID        string
	ConsensusHeight clienttypes.Height
	TrustingPeriod  time.Duration
	ConsensusTime   time.Time
	Header          []byte
}

ClientState holds the current state of a client from a single chain's perspective

type ClientTrustedState added in v2.1.0 

type ClientTrustedState struct {
	ClientState ClientState
	IBCHeader   IBCHeader
}

ClientTrustedState holds the current state of a client from the perspective of both involved chains, i.e. ClientState enriched with the trusted IBC header of the counterparty chain.

type ConnectionInfo added in v2.1.0 

type ConnectionInfo struct {
	Height                       uint64
	ConnID                       string
	ClientID                     string
	CounterpartyClientID         string
	CounterpartyConnID           string
	CounterpartyCommitmentPrefix commitmenttypes.MerklePrefix
}

ConnectionInfo contains relevant properties from connection handshake messages which may be necessary to construct the next message for the counterparty chain.

type ConnectionProof added in v2.1.0 

type ConnectionProof struct {
	ConsensusStateProof  []byte
	ConnectionStateProof []byte
	ClientStateProof     []byte
	ProofHeight          clienttypes.Height
	ClientState          ibcexported.ClientState
}

ConnectionProof includes all of the proof parameters needed for the connection handshake.

type ExtensionOption added in v2.4.0 

type ExtensionOption struct {
	Type  string `json:"type"`
	Value string `json:"value"`
}

type IBCHeader added in v2.1.0 

type IBCHeader interface {
	Height() uint64
	ConsensusState() ibcexported.ConsensusState
	NextValidatorsHash() []byte
}

type ICQProof added in v2.3.0 

type ICQProof struct {
	Result   []byte
	ProofOps *crypto.ProofOps // TODO swap out tendermint type for third party chains.
	Height   int64
}

type KeyOutput 

type KeyOutput struct {
	Mnemonic string `json:"mnemonic" yaml:"mnemonic"`
	Address  string `json:"address" yaml:"address"`
}

KeyOutput contains mnemonic and address of key

type KeyProvider 

type KeyProvider interface {
	CreateKeystore(path string) error
	KeystoreCreated(path string) bool
	AddKey(name string, coinType uint32, signingAlgorithm string) (output *KeyOutput, err error)
	UseKey(key string) error
	RestoreKey(name, mnemonic string, coinType uint32, signingAlgorithm string) (address string, err error)
	ShowAddress(name string) (address string, err error)
	ListAddresses() (map[string]string, error)
	DeleteKey(name string) error
	KeyExists(name string) bool
	ExportPrivKeyArmor(keyName string) (armor string, err error)
}

type LatestBlock added in v2.1.0 

type LatestBlock struct {
	Height uint64
	Time   time.Time
}

type PacketInfo added in v2.1.0 

type PacketInfo struct {
	Height           uint64
	Sequence         uint64
	SourcePort       string
	SourceChannel    string
	DestPort         string
	DestChannel      string
	ChannelOrder     string
	Data             []byte
	TimeoutHeight    clienttypes.Height
	TimeoutTimestamp uint64
	Ack              []byte
}

PacketInfo contains any relevant properties from packet flow messages which may be necessary to construct the next message in the packet flow.

func (PacketInfo) Packet added in v2.1.0 

func (pi PacketInfo) Packet() chantypes.Packet

type PacketProof added in v2.1.0 

type PacketProof struct {
	Proof       []byte
	ProofHeight clienttypes.Height
}

PacketProof includes all of the proof parameters needed for packet flows.

type ProviderConfig 

type ProviderConfig interface {
	NewProvider(log *zap.Logger, homepath string, debug bool, chainName string) (ChainProvider, error)
	Validate() error
	BroadcastMode() BroadcastMode
}

type QueryProvider 

type QueryProvider interface {
	// chain
	BlockTime(ctx context.Context, height int64) (time.Time, error)
	QueryTx(ctx context.Context, hashHex string) (*RelayerTxResponse, error)
	QueryTxs(ctx context.Context, page, limit int, events []string) ([]*RelayerTxResponse, error)
	QueryLatestHeight(ctx context.Context) (int64, error)

	// QueryIBCHeader returns the IBC compatible block header at a specific height.
	QueryIBCHeader(ctx context.Context, h int64) (IBCHeader, error)

	// query packet info for sequence
	QuerySendPacket(ctx context.Context, srcChanID, srcPortID string, sequence uint64) (PacketInfo, error)
	QueryRecvPacket(ctx context.Context, dstChanID, dstPortID string, sequence uint64) (PacketInfo, error)

	// bank
	QueryBalance(ctx context.Context, keyName string) (sdk.Coins, error)
	QueryBalanceWithAddress(ctx context.Context, addr string) (sdk.Coins, error)

	// staking
	QueryUnbondingPeriod(context.Context) (time.Duration, error)

	// ics 02 - client
	QueryClientState(ctx context.Context, height int64, clientid string) (ibcexported.ClientState, error)
	QueryClientStateResponse(ctx context.Context, height int64, srcClientId string) (*clienttypes.QueryClientStateResponse, error)
	QueryClientConsensusState(ctx context.Context, chainHeight int64, clientid string, clientHeight ibcexported.Height) (*clienttypes.QueryConsensusStateResponse, error)
	QueryUpgradedClient(ctx context.Context, height int64) (*clienttypes.QueryClientStateResponse, error)
	QueryUpgradedConsState(ctx context.Context, height int64) (*clienttypes.QueryConsensusStateResponse, error)
	QueryConsensusState(ctx context.Context, height int64) (ibcexported.ConsensusState, int64, error)
	QueryClients(ctx context.Context) (clienttypes.IdentifiedClientStates, error)

	// ics 03 - connection
	QueryConnection(ctx context.Context, height int64, connectionid string) (*conntypes.QueryConnectionResponse, error)
	QueryConnections(ctx context.Context) (conns []*conntypes.IdentifiedConnection, err error)
	QueryConnectionsUsingClient(ctx context.Context, height int64, clientid string) (*conntypes.QueryConnectionsResponse, error)
	GenerateConnHandshakeProof(ctx context.Context, height int64, clientId, connId string) (clientState ibcexported.ClientState,
		clientStateProof []byte, consensusProof []byte, connectionProof []byte,
		connectionProofHeight ibcexported.Height, err error)

	// ics 04 - channel
	QueryChannel(ctx context.Context, height int64, channelid, portid string) (chanRes *chantypes.QueryChannelResponse, err error)
	QueryChannelClient(ctx context.Context, height int64, channelid, portid string) (*clienttypes.IdentifiedClientState, error)
	QueryConnectionChannels(ctx context.Context, height int64, connectionid string) ([]*chantypes.IdentifiedChannel, error)
	QueryChannels(ctx context.Context) ([]*chantypes.IdentifiedChannel, error)
	QueryPacketCommitments(ctx context.Context, height uint64, channelid, portid string) (commitments *chantypes.QueryPacketCommitmentsResponse, err error)
	QueryPacketAcknowledgements(ctx context.Context, height uint64, channelid, portid string) (acknowledgements []*chantypes.PacketState, err error)
	QueryUnreceivedPackets(ctx context.Context, height uint64, channelid, portid string, seqs []uint64) ([]uint64, error)
	QueryUnreceivedAcknowledgements(ctx context.Context, height uint64, channelid, portid string, seqs []uint64) ([]uint64, error)
	QueryNextSeqRecv(ctx context.Context, height int64, channelid, portid string) (recvRes *chantypes.QueryNextSequenceReceiveResponse, err error)
	QueryNextSeqAck(ctx context.Context, height int64, channelid, portid string) (recvRes *chantypes.QueryNextSequenceReceiveResponse, err error)
	QueryPacketCommitment(ctx context.Context, height int64, channelid, portid string, seq uint64) (comRes *chantypes.QueryPacketCommitmentResponse, err error)
	QueryPacketAcknowledgement(ctx context.Context, height int64, channelid, portid string, seq uint64) (ackRes *chantypes.QueryPacketAcknowledgementResponse, err error)
	QueryPacketReceipt(ctx context.Context, height int64, channelid, portid string, seq uint64) (recRes *chantypes.QueryPacketReceiptResponse, err error)

	// ics 20 - transfer
	QueryDenomTrace(ctx context.Context, denom string) (*transfertypes.DenomTrace, error)
	QueryDenomTraces(ctx context.Context, offset, limit uint64, height int64) ([]transfertypes.DenomTrace, error)
}

Do we need intermediate types? i.e. can we use the SDK types for both substrate and cosmos?

type RelayPacket 

type RelayPacket interface {
	Msg(src ChainProvider, srcPortId, srcChanId, dstPortId, dstChanId string) (RelayerMessage, error)
	Data() []byte
	Seq() uint64
	Timeout() clienttypes.Height
	TimeoutStamp() uint64
}

type RelayerEvent added in v2.1.0 

type RelayerEvent struct {
	EventType  string
	Attributes map[string]string
}

func (RelayerEvent) MarshalLogObject added in v2.1.0 

func (e RelayerEvent) MarshalLogObject(enc zapcore.ObjectEncoder) error

MarshalLogObject satisfies the zapcore.ObjectMarshaler interface.

type RelayerMessage 

type RelayerMessage interface {
	Type() string
	MsgBytes() ([]byte, error)
}

type RelayerTxResponse 

type RelayerTxResponse struct {
	Height    int64
	TxHash    string
	Codespace string
	Code      uint32
	Data      string
	Events    []RelayerEvent
}

func (RelayerTxResponse) MarshalLogObject added in v2.1.0 

func (r RelayerTxResponse) MarshalLogObject(enc zapcore.ObjectEncoder) error

MarshalLogObject satisfies the zapcore.ObjectMarshaler interface.

type TendermintIBCHeader added in v2.3.0 

type TendermintIBCHeader struct {
	SignedHeader      *types.SignedHeader
	ValidatorSet      *types.ValidatorSet
	TrustedValidators *types.ValidatorSet
	TrustedHeight     clienttypes.Height
}

func (TendermintIBCHeader) ConsensusState added in v2.3.0 

func (h TendermintIBCHeader) ConsensusState() ibcexported.ConsensusState

func (TendermintIBCHeader) Height added in v2.3.0 

func (h TendermintIBCHeader) Height() uint64

func (TendermintIBCHeader) NextValidatorsHash added in v2.3.0 

func (h TendermintIBCHeader) NextValidatorsHash() []byte

func (TendermintIBCHeader) TMHeader added in v2.3.0 

func (h TendermintIBCHeader) TMHeader() (*tendermint.Header, error)

type TimeoutHeightError added in v2.1.0 

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

TimeoutHeightError is used during packet validation to inform the PathProcessor that the current chain height has exceeded the packet height timeout so that a MsgTimeout can be assembled for the counterparty chain.

func NewTimeoutHeightError added in v2.1.0 

func NewTimeoutHeightError(latestHeight, timeoutHeight uint64) *TimeoutHeightError

func (*TimeoutHeightError) Error added in v2.1.0 

func (t *TimeoutHeightError) Error() string

type TimeoutOnCloseError added in v2.1.0 

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

func NewTimeoutOnCloseError added in v2.1.0 

func NewTimeoutOnCloseError(msg string) *TimeoutOnCloseError

func (*TimeoutOnCloseError) Error added in v2.1.0 

func (t *TimeoutOnCloseError) Error() string

type TimeoutTimestampError added in v2.1.0 

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

TimeoutTimestampError is used during packet validation to inform the PathProcessor that current block timestamp has exceeded the packet timestamp timeout so that a MsgTimeout can be assembled for the counterparty chain.

func NewTimeoutTimestampError added in v2.1.0 

func NewTimeoutTimestampError(latestTimestamp, timeoutTimestamp uint64) *TimeoutTimestampError

func (*TimeoutTimestampError) Error added in v2.1.0 

func (t *TimeoutTimestampError) Error() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.