exported

Documentation

Index

• Constants
• type ClientState
• type ClientType
  • func ClientTypeFromString(clientType string) ClientType
  • func (ct ClientType) MarshalJSON() ([]byte, error)
  • func (ct ClientType) String() string
  • func (ct *ClientType) UnmarshalJSON(data []byte) error
• type ConsensusState
• type Header
• type Misbehaviour
• type MsgCreateClient
• type MsgUpdateClient

Constants

const (
	ClientTypeTendermint string = "tendermint"
	ClientTypeLocalHost  string = "localhost"
)

string representation of the client types

Types

type ClientState

type ClientState interface {
	GetID() string
	GetChainID() string
	ClientType() ClientType
	GetLatestHeight() uint64
	IsFrozen() bool
	Validate() error
	GetProofSpecs() []*ics23.ProofSpec

	VerifyClientConsensusState(
		store sdk.KVStore,
		cdc codec.Marshaler,
		aminoCdc *codec.Codec,
		root commitmentexported.Root,
		height uint64,
		counterpartyClientIdentifier string,
		consensusHeight uint64,
		prefix commitmentexported.Prefix,
		proof []byte,
		consensusState ConsensusState,
	) error
	VerifyConnectionState(
		store sdk.KVStore,
		cdc codec.Marshaler,
		height uint64,
		prefix commitmentexported.Prefix,
		proof []byte,
		connectionID string,
		connectionEnd connectionexported.ConnectionI,
		consensusState ConsensusState,
	) error
	VerifyChannelState(
		store sdk.KVStore,
		cdc codec.Marshaler,
		height uint64,
		prefix commitmentexported.Prefix,
		proof []byte,
		portID,
		channelID string,
		channel channelexported.ChannelI,
		consensusState ConsensusState,
	) error
	VerifyPacketCommitment(
		store sdk.KVStore,
		cdc codec.Marshaler,
		height uint64,
		prefix commitmentexported.Prefix,
		proof []byte,
		portID,
		channelID string,
		sequence uint64,
		commitmentBytes []byte,
		consensusState ConsensusState,
	) error
	VerifyPacketAcknowledgement(
		store sdk.KVStore,
		cdc codec.Marshaler,
		height uint64,
		prefix commitmentexported.Prefix,
		proof []byte,
		portID,
		channelID string,
		sequence uint64,
		acknowledgement []byte,
		consensusState ConsensusState,
	) error
	VerifyPacketAcknowledgementAbsence(
		store sdk.KVStore,
		cdc codec.Marshaler,
		height uint64,
		prefix commitmentexported.Prefix,
		proof []byte,
		portID,
		channelID string,
		sequence uint64,
		consensusState ConsensusState,
	) error
	VerifyNextSequenceRecv(
		store sdk.KVStore,
		cdc codec.Marshaler,
		height uint64,
		prefix commitmentexported.Prefix,
		proof []byte,
		portID,
		channelID string,
		nextSequenceRecv uint64,
		consensusState ConsensusState,
	) error
}

ClientState defines the required common functions for light clients.

type ClientType

type ClientType byte

ClientType defines the type of the consensus algorithm

const (
	Tendermint ClientType = iota + 1 // 1
	Localhost
)

available client types

func ClientTypeFromString

func ClientTypeFromString(clientType string) ClientType

ClientTypeFromString returns a byte that corresponds to the registered client type. It returns 0 if the type is not found/registered.

func (ClientType) MarshalJSON

func (ct ClientType) MarshalJSON() ([]byte, error)

MarshalJSON marshal to JSON using string.

func (ClientType) String

func (ct ClientType) String() string

func (*ClientType) UnmarshalJSON

func (ct *ClientType) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes from JSON.

type ConsensusState

type ConsensusState interface {
	ClientType() ClientType // Consensus kind

	// GetHeight returns the height of the consensus state
	GetHeight() uint64

	// GetRoot returns the commitment root of the consensus state,
	// which is used for key-value pair verification.
	GetRoot() commitmentexported.Root

	// GetTimestamp returns the timestamp (in nanoseconds) of the consensus state
	GetTimestamp() uint64

	ValidateBasic() error
}

ConsensusState is the state of the consensus process

type Header

type Header interface {
	ClientType() ClientType
	GetHeight() uint64
}

Header is the consensus state update information

type Misbehaviour

type Misbehaviour interface {
	evidenceexported.Evidence
	ClientType() ClientType
	GetClientID() string
}

Misbehaviour defines a specific consensus kind and an evidence

type MsgCreateClient

type MsgCreateClient interface {
	sdk.Msg
	GetClientID() string
	GetClientType() string
	GetConsensusState() ConsensusState
}

MsgCreateClient defines the msg interface that the CreateClient Handler expects

type MsgUpdateClient

type MsgUpdateClient interface {
	sdk.Msg
	GetClientID() string
	GetHeader() Header
}

MsgUpdateClient defines the msg interface that the UpdateClient Handler expects