Documentation ¶
Index ¶
- Variables
- func RegisterInterfaces(registry codectypes.InterfaceRegistry)
- type ClientState
- func (cs ClientState) CheckHeaderAndUpdateState(ctx sdk.Context, cdc codec.BinaryCodec, clientStore sdk.KVStore, ...) (exported.ClientState, exported.ConsensusState, error)
- func (cs *ClientState) CheckMisbehaviourAndUpdateState(ctx sdk.Context, cdc codec.BinaryCodec, store sdk.KVStore, ...) (exported.ClientState, error)
- func (cs *ClientState) CheckSubstituteAndUpdateState(ctx sdk.Context, cdc codec.BinaryCodec, subjectClientStore sdk.KVStore, ...) (exported.ClientState, error)
- func (cs *ClientState) ClientType() string
- func (*ClientState) Descriptor() ([]byte, []int)
- func (cs *ClientState) ExportMetadata(store sdk.KVStore) []exported.GenesisMetadata
- func (cs *ClientState) GetLatestHeight() exported.Height
- func (cs *ClientState) GetProofSpecs() []*ics23.ProofSpec
- func (cs *ClientState) GetUnderlyingClientState() exported.ClientState
- func (cs *ClientState) Initialize(ctx sdk.Context, cdc codec.BinaryCodec, clientStore sdk.KVStore, ...) error
- func (m *ClientState) Marshal() (dAtA []byte, err error)
- func (m *ClientState) MarshalTo(dAtA []byte) (int, error)
- func (m *ClientState) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*ClientState) ProtoMessage()
- func (m *ClientState) Reset()
- func (m *ClientState) Size() (n int)
- func (cs *ClientState) Status(ctx sdk.Context, clientStore sdk.KVStore, cdc codec.BinaryCodec) exported.Status
- func (m *ClientState) String() string
- func (m *ClientState) Unmarshal(dAtA []byte) error
- func (cs *ClientState) UnpackInterfaces(unpacker codectypes.AnyUnpacker) error
- func (cs *ClientState) Validate() error
- func (cs *ClientState) VerifyChannelState(store sdk.KVStore, cdc codec.BinaryCodec, height exported.Height, ...) error
- func (cs *ClientState) VerifyClientConsensusState(store sdk.KVStore, cdc codec.BinaryCodec, height exported.Height, ...) error
- func (cs *ClientState) VerifyClientState(store sdk.KVStore, cdc codec.BinaryCodec, height exported.Height, ...) error
- func (cs *ClientState) VerifyConnectionState(store sdk.KVStore, cdc codec.BinaryCodec, height exported.Height, ...) error
- func (cs *ClientState) VerifyNextSequenceRecv(ctx sdk.Context, store sdk.KVStore, cdc codec.BinaryCodec, ...) error
- func (cs *ClientState) VerifyPacketAcknowledgement(ctx sdk.Context, store sdk.KVStore, cdc codec.BinaryCodec, ...) error
- func (cs *ClientState) VerifyPacketCommitment(ctx sdk.Context, store sdk.KVStore, cdc codec.BinaryCodec, ...) error
- func (cs *ClientState) VerifyPacketReceiptAbsence(ctx sdk.Context, store sdk.KVStore, cdc codec.BinaryCodec, ...) error
- func (cs *ClientState) VerifyUpgradeAndUpdateState(ctx sdk.Context, cdc codec.BinaryCodec, store sdk.KVStore, ...) (exported.ClientState, exported.ConsensusState, error)
- func (m *ClientState) XXX_DiscardUnknown()
- func (m *ClientState) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *ClientState) XXX_Merge(src proto.Message)
- func (m *ClientState) XXX_Size() int
- func (m *ClientState) XXX_Unmarshal(b []byte) error
- func (cs ClientState) ZeroCustomFields() exported.ClientState
- type LeafProof
- func (*LeafProof) Descriptor() ([]byte, []int)
- func (m *LeafProof) Marshal() (dAtA []byte, err error)
- func (m *LeafProof) MarshalTo(dAtA []byte) (int, error)
- func (m *LeafProof) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*LeafProof) ProtoMessage()
- func (m *LeafProof) Reset()
- func (m *LeafProof) Size() (n int)
- func (m *LeafProof) String() string
- func (m *LeafProof) Unmarshal(dAtA []byte) error
- func (m *LeafProof) XXX_DiscardUnknown()
- func (m *LeafProof) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *LeafProof) XXX_Merge(src proto.Message)
- func (m *LeafProof) XXX_Size() int
- func (m *LeafProof) XXX_Unmarshal(b []byte) error
- type MultiProof
- func (*MultiProof) Descriptor() ([]byte, []int)
- func (p *MultiProof) Empty() bool
- func (m *MultiProof) Marshal() (dAtA []byte, err error)
- func (m *MultiProof) MarshalTo(dAtA []byte) (int, error)
- func (m *MultiProof) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*MultiProof) ProtoMessage()
- func (m *MultiProof) Reset()
- func (m *MultiProof) Size() (n int)
- func (m *MultiProof) String() string
- func (m *MultiProof) Unmarshal(dAtA []byte) error
- func (p *MultiProof) ValidateBasic() error
- func (p *MultiProof) VerifyMembership(_ []*ics23.ProofSpec, _ exported.Root, _ exported.Path, _ []byte) error
- func (p *MultiProof) VerifyNonMembership(_ []*ics23.ProofSpec, _ exported.Root, _ exported.Path) error
- func (m *MultiProof) XXX_DiscardUnknown()
- func (m *MultiProof) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *MultiProof) XXX_Merge(src proto.Message)
- func (m *MultiProof) XXX_Size() int
- func (m *MultiProof) XXX_Unmarshal(b []byte) error
- type Proof
- func (*Proof) Descriptor() ([]byte, []int)
- func (m *Proof) Marshal() (dAtA []byte, err error)
- func (m *Proof) MarshalTo(dAtA []byte) (int, error)
- func (m *Proof) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*Proof) ProtoMessage()
- func (m *Proof) Reset()
- func (m *Proof) Size() (n int)
- func (m *Proof) String() string
- func (m *Proof) Unmarshal(dAtA []byte) error
- func (m *Proof) XXX_DiscardUnknown()
- func (m *Proof) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *Proof) XXX_Merge(src proto.Message)
- func (m *Proof) XXX_Size() int
- func (m *Proof) XXX_Unmarshal(b []byte) error
Constants ¶
This section is empty.
Variables ¶
Functions ¶
func RegisterInterfaces ¶
func RegisterInterfaces(registry codectypes.InterfaceRegistry)
RegisterInterfaces registers the commitment interfaces to protobuf Any.
Types ¶
type ClientState ¶
type ClientState struct { UnderlyingClientState *types.Any `` /* 126-byte string literal not displayed */ Depth uint32 `protobuf:"varint,2,opt,name=depth,proto3" json:"depth,omitempty"` }
func NewClientState ¶
func NewClientState(clientState exported.ClientState, depth uint32) *ClientState
func (ClientState) CheckHeaderAndUpdateState ¶
func (cs ClientState) CheckHeaderAndUpdateState(ctx sdk.Context, cdc codec.BinaryCodec, clientStore sdk.KVStore, header exported.Header) (exported.ClientState, exported.ConsensusState, error)
Update and Misbehaviour functions
func (*ClientState) CheckMisbehaviourAndUpdateState ¶
func (cs *ClientState) CheckMisbehaviourAndUpdateState(ctx sdk.Context, cdc codec.BinaryCodec, store sdk.KVStore, misbehaviour exported.Misbehaviour) (exported.ClientState, error)
func (*ClientState) CheckSubstituteAndUpdateState ¶
func (cs *ClientState) CheckSubstituteAndUpdateState(ctx sdk.Context, cdc codec.BinaryCodec, subjectClientStore sdk.KVStore, substituteClientStore sdk.KVStore, substituteClient exported.ClientState) (exported.ClientState, error)
func (*ClientState) ClientType ¶
func (cs *ClientState) ClientType() string
func (*ClientState) Descriptor ¶
func (*ClientState) Descriptor() ([]byte, []int)
func (*ClientState) ExportMetadata ¶
func (cs *ClientState) ExportMetadata(store sdk.KVStore) []exported.GenesisMetadata
Genesis function
func (*ClientState) GetLatestHeight ¶
func (cs *ClientState) GetLatestHeight() exported.Height
func (*ClientState) GetProofSpecs ¶
func (cs *ClientState) GetProofSpecs() []*ics23.ProofSpec
func (*ClientState) GetUnderlyingClientState ¶
func (cs *ClientState) GetUnderlyingClientState() exported.ClientState
func (*ClientState) Initialize ¶
func (cs *ClientState) Initialize(ctx sdk.Context, cdc codec.BinaryCodec, clientStore sdk.KVStore, consState exported.ConsensusState) error
Initialization function Clients must validate the initial consensus state, and may store any client-specific metadata necessary for correct light client operation
func (*ClientState) Marshal ¶
func (m *ClientState) Marshal() (dAtA []byte, err error)
func (*ClientState) MarshalToSizedBuffer ¶
func (m *ClientState) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*ClientState) ProtoMessage ¶
func (*ClientState) ProtoMessage()
func (*ClientState) Reset ¶
func (m *ClientState) Reset()
func (*ClientState) Size ¶
func (m *ClientState) Size() (n int)
func (*ClientState) Status ¶
func (cs *ClientState) Status( ctx sdk.Context, clientStore sdk.KVStore, cdc codec.BinaryCodec, ) exported.Status
func (*ClientState) String ¶
func (m *ClientState) String() string
func (*ClientState) Unmarshal ¶
func (m *ClientState) Unmarshal(dAtA []byte) error
func (*ClientState) UnpackInterfaces ¶
func (cs *ClientState) UnpackInterfaces(unpacker codectypes.AnyUnpacker) error
UnpackInterfaces implements UnpackInterfacesMessage.UnpackInterfaces
func (*ClientState) Validate ¶
func (cs *ClientState) Validate() error
func (*ClientState) VerifyChannelState ¶
func (*ClientState) VerifyClientConsensusState ¶
func (*ClientState) VerifyClientState ¶
func (cs *ClientState) VerifyClientState(store sdk.KVStore, cdc codec.BinaryCodec, height exported.Height, prefix exported.Prefix, counterpartyClientIdentifier string, proofBytes []byte, clientState exported.ClientState) error
func (*ClientState) VerifyConnectionState ¶
func (cs *ClientState) VerifyConnectionState(store sdk.KVStore, cdc codec.BinaryCodec, height exported.Height, prefix exported.Prefix, proof []byte, connectionID string, connectionEnd exported.ConnectionI) error
func (*ClientState) VerifyNextSequenceRecv ¶
func (*ClientState) VerifyPacketAcknowledgement ¶
func (*ClientState) VerifyPacketCommitment ¶
func (*ClientState) VerifyPacketReceiptAbsence ¶
func (*ClientState) VerifyUpgradeAndUpdateState ¶
func (cs *ClientState) VerifyUpgradeAndUpdateState(ctx sdk.Context, cdc codec.BinaryCodec, store sdk.KVStore, newClient exported.ClientState, newConsState exported.ConsensusState, proofUpgradeClient []byte, proofUpgradeConsState []byte) (exported.ClientState, exported.ConsensusState, error)
Upgrade functions NOTE: proof heights are not included as upgrade to a new revision is expected to pass only on the last height committed by the current revision. Clients are responsible for ensuring that the planned last height of the current revision is somehow encoded in the proof verification process. This is to ensure that no premature upgrades occur, since upgrade plans committed to by the counterparty may be cancelled or modified before the last planned height.
func (*ClientState) XXX_DiscardUnknown ¶
func (m *ClientState) XXX_DiscardUnknown()
func (*ClientState) XXX_Marshal ¶
func (m *ClientState) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*ClientState) XXX_Merge ¶
func (m *ClientState) XXX_Merge(src proto.Message)
func (*ClientState) XXX_Size ¶
func (m *ClientState) XXX_Size() int
func (*ClientState) XXX_Unmarshal ¶
func (m *ClientState) XXX_Unmarshal(b []byte) error
func (ClientState) ZeroCustomFields ¶
func (cs ClientState) ZeroCustomFields() exported.ClientState
Utility function that zeroes out any client customizable fields in client state Ledger enforced fields are maintained while all custom fields are zero values Used to verify upgrades
type LeafProof ¶
type LeafProof struct { Proof []byte `protobuf:"bytes,1,opt,name=proof,proto3" json:"proof,omitempty"` ProofHeight types1.Height `protobuf:"bytes,2,opt,name=proof_height,json=proofHeight,proto3" json:"proof_height"` }
func (*LeafProof) Descriptor ¶
func (*LeafProof) MarshalToSizedBuffer ¶
func (*LeafProof) ProtoMessage ¶
func (*LeafProof) ProtoMessage()
func (*LeafProof) XXX_DiscardUnknown ¶
func (m *LeafProof) XXX_DiscardUnknown()
func (*LeafProof) XXX_Marshal ¶
func (*LeafProof) XXX_Unmarshal ¶
type MultiProof ¶
type MultiProof struct { Head Proof `protobuf:"bytes,1,opt,name=head,proto3" json:"head"` Branches []Proof `protobuf:"bytes,2,rep,name=branches,proto3" json:"branches"` Leaf LeafProof `protobuf:"bytes,3,opt,name=leaf,proto3" json:"leaf"` }
func (*MultiProof) Descriptor ¶
func (*MultiProof) Descriptor() ([]byte, []int)
func (*MultiProof) Empty ¶
func (p *MultiProof) Empty() bool
func (*MultiProof) Marshal ¶
func (m *MultiProof) Marshal() (dAtA []byte, err error)
func (*MultiProof) MarshalToSizedBuffer ¶
func (m *MultiProof) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*MultiProof) ProtoMessage ¶
func (*MultiProof) ProtoMessage()
func (*MultiProof) Reset ¶
func (m *MultiProof) Reset()
func (*MultiProof) Size ¶
func (m *MultiProof) Size() (n int)
func (*MultiProof) String ¶
func (m *MultiProof) String() string
func (*MultiProof) Unmarshal ¶
func (m *MultiProof) Unmarshal(dAtA []byte) error
func (*MultiProof) ValidateBasic ¶
func (p *MultiProof) ValidateBasic() error
func (*MultiProof) VerifyMembership ¶
func (*MultiProof) VerifyNonMembership ¶
func (*MultiProof) XXX_DiscardUnknown ¶
func (m *MultiProof) XXX_DiscardUnknown()
func (*MultiProof) XXX_Marshal ¶
func (m *MultiProof) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*MultiProof) XXX_Merge ¶
func (m *MultiProof) XXX_Merge(src proto.Message)
func (*MultiProof) XXX_Size ¶
func (m *MultiProof) XXX_Size() int
func (*MultiProof) XXX_Unmarshal ¶
func (m *MultiProof) XXX_Unmarshal(b []byte) error
type Proof ¶
type Proof struct { ClientProof []byte `protobuf:"bytes,1,opt,name=client_proof,json=clientProof,proto3" json:"client_proof,omitempty"` ClientState *types.Any `protobuf:"bytes,2,opt,name=client_state,json=clientState,proto3" json:"client_state,omitempty"` ConsensusProof []byte `protobuf:"bytes,3,opt,name=consensus_proof,json=consensusProof,proto3" json:"consensus_proof,omitempty"` ConsensusState *types.Any `protobuf:"bytes,4,opt,name=consensus_state,json=consensusState,proto3" json:"consensus_state,omitempty"` ProofHeight types1.Height `protobuf:"bytes,5,opt,name=proof_height,json=proofHeight,proto3" json:"proof_height"` ConsensusHeight types1.Height `protobuf:"bytes,6,opt,name=consensus_height,json=consensusHeight,proto3" json:"consensus_height"` }
func (*Proof) Descriptor ¶
func (*Proof) ProtoMessage ¶
func (*Proof) ProtoMessage()
func (*Proof) XXX_DiscardUnknown ¶
func (m *Proof) XXX_DiscardUnknown()