Documentation
¶
Index ¶
Constants ¶
View Source
const ( ClientTypeTendermint string = "tendermint" ClientTypeLocalHost string = "localhost" )
string representation of the client types
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ClientState ¶
type ClientState interface {
GetID() string
GetChainID() string
ClientType() ClientType
GetLatestHeight() uint64
IsFrozen() bool
Validate() error
VerifyClientConsensusState(
store sdk.KVStore,
cdc *codec.Codec,
root commitmentexported.Root,
height uint64,
counterpartyClientIdentifier string,
consensusHeight uint64,
prefix commitmentexported.Prefix,
proof commitmentexported.Proof,
consensusState ConsensusState,
) error
VerifyConnectionState(
store sdk.KVStore,
cdc codec.Marshaler,
height uint64,
prefix commitmentexported.Prefix,
proof commitmentexported.Proof,
connectionID string,
connectionEnd connectionexported.ConnectionI,
consensusState ConsensusState,
) error
VerifyChannelState(
store sdk.KVStore,
cdc codec.Marshaler,
height uint64,
prefix commitmentexported.Prefix,
proof commitmentexported.Proof,
portID,
channelID string,
channel channelexported.ChannelI,
consensusState ConsensusState,
) error
VerifyPacketCommitment(
store sdk.KVStore,
height uint64,
prefix commitmentexported.Prefix,
proof commitmentexported.Proof,
portID,
channelID string,
sequence uint64,
commitmentBytes []byte,
consensusState ConsensusState,
) error
VerifyPacketAcknowledgement(
store sdk.KVStore,
height uint64,
prefix commitmentexported.Prefix,
proof commitmentexported.Proof,
portID,
channelID string,
sequence uint64,
acknowledgement []byte,
consensusState ConsensusState,
) error
VerifyPacketAcknowledgementAbsence(
store sdk.KVStore,
height uint64,
prefix commitmentexported.Prefix,
proof commitmentexported.Proof,
portID,
channelID string,
sequence uint64,
consensusState ConsensusState,
) error
VerifyNextSequenceRecv(
store sdk.KVStore,
height uint64,
prefix commitmentexported.Prefix,
proof commitmentexported.Proof,
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
Click to show internal directories.
Click to hide internal directories.