Documentation ¶
Index ¶
- type Keeper
- func (k Keeper) CheckMisbehaviourAndUpdateState(ctx sdk.Context, misbehaviour exported.Misbehaviour) error
- func (q Keeper) ClientParams(c context.Context, _ *types.QueryClientParamsRequest) (*types.QueryClientParamsResponse, error)
- func (q Keeper) ClientState(c context.Context, req *types.QueryClientStateRequest) (*types.QueryClientStateResponse, error)
- func (q Keeper) ClientStates(c context.Context, req *types.QueryClientStatesRequest) (*types.QueryClientStatesResponse, error)
- func (k Keeper) ClientStore(ctx sdk.Context, clientID string) sdk.KVStore
- func (k Keeper) ClientUpdateProposal(ctx sdk.Context, p *types.ClientUpdateProposal) error
- func (q Keeper) ConsensusState(c context.Context, req *types.QueryConsensusStateRequest) (*types.QueryConsensusStateResponse, error)
- func (q Keeper) ConsensusStates(c context.Context, req *types.QueryConsensusStatesRequest) (*types.QueryConsensusStatesResponse, error)
- func (k Keeper) CreateClient(ctx sdk.Context, clientState exported.ClientState, ...) (string, error)
- func (k Keeper) GenerateClientIdentifier(ctx sdk.Context, clientType string) string
- func (k Keeper) GetAllClientMetadata(ctx sdk.Context, genClients []types.IdentifiedClientState) ([]types.IdentifiedGenesisMetadata, error)
- func (k Keeper) GetAllClients(ctx sdk.Context) (states []exported.ClientState)
- func (k Keeper) GetAllConsensusStates(ctx sdk.Context) types.ClientsConsensusStates
- func (k Keeper) GetAllGenesisClients(ctx sdk.Context) types.IdentifiedClientStates
- func (k Keeper) GetAllowedClients(ctx sdk.Context) []string
- func (k Keeper) GetClientConsensusState(ctx sdk.Context, clientID string, height exported.Height) (exported.ConsensusState, bool)
- func (k Keeper) GetClientState(ctx sdk.Context, clientID string) (exported.ClientState, bool)
- func (k Keeper) GetLatestClientConsensusState(ctx sdk.Context, clientID string) (exported.ConsensusState, bool)
- func (k Keeper) GetNextClientSequence(ctx sdk.Context) uint64
- func (k Keeper) GetParams(ctx sdk.Context) types.Params
- func (k Keeper) GetSelfConsensusState(ctx sdk.Context, height exported.Height) (exported.ConsensusState, bool)
- func (k Keeper) HasClientConsensusState(ctx sdk.Context, clientID string, height exported.Height) bool
- func (k Keeper) IterateClients(ctx sdk.Context, cb func(clientID string, cs exported.ClientState) bool)
- func (k Keeper) IterateConsensusStates(ctx sdk.Context, ...)
- func (k Keeper) Logger(ctx sdk.Context) log.Logger
- func (k Keeper) MustMarshalClientState(clientState exported.ClientState) []byte
- func (k Keeper) MustMarshalConsensusState(consensusState exported.ConsensusState) []byte
- func (k Keeper) MustUnmarshalClientState(bz []byte) exported.ClientState
- func (k Keeper) MustUnmarshalConsensusState(bz []byte) exported.ConsensusState
- func (k Keeper) SetAllClientMetadata(ctx sdk.Context, genMetadata []types.IdentifiedGenesisMetadata)
- func (k Keeper) SetClientConsensusState(ctx sdk.Context, clientID string, height exported.Height, ...)
- func (k Keeper) SetClientState(ctx sdk.Context, clientID string, clientState exported.ClientState)
- func (k Keeper) SetNextClientSequence(ctx sdk.Context, sequence uint64)
- func (k Keeper) SetParams(ctx sdk.Context, params types.Params)
- func (k Keeper) UnmarshalClientState(bz []byte) (exported.ClientState, error)
- func (k Keeper) UnmarshalConsensusState(bz []byte) (exported.ConsensusState, error)
- func (k Keeper) UpdateClient(ctx sdk.Context, clientID string, header exported.Header) error
- func (k Keeper) UpgradeClient(ctx sdk.Context, clientID string, upgradedClient exported.ClientState, ...) error
- func (k Keeper) ValidateSelfClient(ctx sdk.Context, clientState exported.ClientState) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Keeper ¶
type Keeper struct {
// contains filtered or unexported fields
}
Keeper represents a type that grants read and write permissions to any client state information
func NewKeeper ¶
func NewKeeper(cdc codec.BinaryMarshaler, key sdk.StoreKey, paramSpace paramtypes.Subspace, sk types.StakingKeeper) Keeper
NewKeeper creates a new NewKeeper instance
func (Keeper) CheckMisbehaviourAndUpdateState ¶
func (k Keeper) CheckMisbehaviourAndUpdateState(ctx sdk.Context, misbehaviour exported.Misbehaviour) error
CheckMisbehaviourAndUpdateState checks for client misbehaviour and freezes the client if so.
func (Keeper) ClientParams ¶
func (q Keeper) ClientParams(c context.Context, _ *types.QueryClientParamsRequest) (*types.QueryClientParamsResponse, error)
ClientParams implements the Query/ClientParams gRPC method
func (Keeper) ClientState ¶
func (q Keeper) ClientState(c context.Context, req *types.QueryClientStateRequest) (*types.QueryClientStateResponse, error)
ClientState implements the Query/ClientState gRPC method
func (Keeper) ClientStates ¶
func (q Keeper) ClientStates(c context.Context, req *types.QueryClientStatesRequest) (*types.QueryClientStatesResponse, error)
ClientStates implements the Query/ClientStates gRPC method
func (Keeper) ClientStore ¶
ClientStore returns isolated prefix store for each client so they can read/write in separate namespace without being able to read/write other client's data
func (Keeper) ClientUpdateProposal ¶
ClientUpdateProposal will retrieve the subject and substitute client. The initial height must be greater than the latest height of the subject client. A callback will occur to the subject client state with the client prefixed store being provided for both the subject and the substitute client. The localhost client is not allowed to be modified with a proposal. The IBC client implementations are responsible for validating the parameters of the subtitute (enusring they match the subject's parameters) as well as copying the necessary consensus states from the subtitute to the subject client store.
func (Keeper) ConsensusState ¶
func (q Keeper) ConsensusState(c context.Context, req *types.QueryConsensusStateRequest) (*types.QueryConsensusStateResponse, error)
ConsensusState implements the Query/ConsensusState gRPC method
func (Keeper) ConsensusStates ¶
func (q Keeper) ConsensusStates(c context.Context, req *types.QueryConsensusStatesRequest) (*types.QueryConsensusStatesResponse, error)
ConsensusStates implements the Query/ConsensusStates gRPC method
func (Keeper) CreateClient ¶
func (k Keeper) CreateClient( ctx sdk.Context, clientState exported.ClientState, consensusState exported.ConsensusState, ) (string, error)
CreateClient creates a new client state and populates it with a given consensus state as defined in https://github.com/cosmos/ics/tree/master/spec/ics-002-client-semantics#create
func (Keeper) GenerateClientIdentifier ¶
GenerateClientIdentifier returns the next client identifier.
func (Keeper) GetAllClientMetadata ¶
func (k Keeper) GetAllClientMetadata(ctx sdk.Context, genClients []types.IdentifiedClientState) ([]types.IdentifiedGenesisMetadata, error)
GetAllClientMetadata will take a list of IdentifiedClientState and return a list of IdentifiedGenesisMetadata necessary for exporting and importing client metadata into the client store.
func (Keeper) GetAllClients ¶
func (k Keeper) GetAllClients(ctx sdk.Context) (states []exported.ClientState)
GetAllClients returns all stored light client State objects.
func (Keeper) GetAllConsensusStates ¶
func (k Keeper) GetAllConsensusStates(ctx sdk.Context) types.ClientsConsensusStates
GetAllConsensusStates returns all stored client consensus states.
func (Keeper) GetAllGenesisClients ¶
func (k Keeper) GetAllGenesisClients(ctx sdk.Context) types.IdentifiedClientStates
GetAllGenesisClients returns all the clients in state with their client ids returned as IdentifiedClientState
func (Keeper) GetAllowedClients ¶
GetAllowedClients retrieves the receive enabled boolean from the paramstore
func (Keeper) GetClientConsensusState ¶
func (k Keeper) GetClientConsensusState(ctx sdk.Context, clientID string, height exported.Height) (exported.ConsensusState, bool)
GetClientConsensusState gets the stored consensus state from a client at a given height.
func (Keeper) GetClientState ¶
GetClientState gets a particular client from the store
func (Keeper) GetLatestClientConsensusState ¶
func (k Keeper) GetLatestClientConsensusState(ctx sdk.Context, clientID string) (exported.ConsensusState, bool)
GetLatestClientConsensusState gets the latest ConsensusState stored for a given client
func (Keeper) GetNextClientSequence ¶
GetNextClientSequence gets the next client sequence from the store.
func (Keeper) GetSelfConsensusState ¶
func (k Keeper) GetSelfConsensusState(ctx sdk.Context, height exported.Height) (exported.ConsensusState, bool)
GetSelfConsensusState introspects the (self) past historical info at a given height and returns the expected consensus state at that height. For now, can only retrieve self consensus states for the current revision
func (Keeper) HasClientConsensusState ¶
func (k Keeper) HasClientConsensusState(ctx sdk.Context, clientID string, height exported.Height) bool
HasClientConsensusState returns if keeper has a ConsensusState for a particular client at the given height
func (Keeper) IterateClients ¶
func (k Keeper) IterateClients(ctx sdk.Context, cb func(clientID string, cs exported.ClientState) bool)
IterateClients provides an iterator over all stored light client State objects. For each State object, cb will be called. If the cb returns true, the iterator will close and stop.
func (Keeper) IterateConsensusStates ¶
func (k Keeper) IterateConsensusStates(ctx sdk.Context, cb func(clientID string, cs types.ConsensusStateWithHeight) bool)
IterateConsensusStates provides an iterator over all stored consensus states. objects. For each State object, cb will be called. If the cb returns true, the iterator will close and stop.
func (Keeper) MustMarshalClientState ¶
func (k Keeper) MustMarshalClientState(clientState exported.ClientState) []byte
MustMarshalClientState attempts to encode an ClientState object and returns the raw encoded bytes. It panics on error.
func (Keeper) MustMarshalConsensusState ¶
func (k Keeper) MustMarshalConsensusState(consensusState exported.ConsensusState) []byte
MustMarshalConsensusState attempts to encode an ConsensusState object and returns the raw encoded bytes. It panics on error.
func (Keeper) MustUnmarshalClientState ¶
func (k Keeper) MustUnmarshalClientState(bz []byte) exported.ClientState
MustUnmarshalClientState attempts to decode and return an ClientState object from raw encoded bytes. It panics on error.
func (Keeper) MustUnmarshalConsensusState ¶
func (k Keeper) MustUnmarshalConsensusState(bz []byte) exported.ConsensusState
MustUnmarshalConsensusState attempts to decode and return an ConsensusState object from raw encoded bytes. It panics on error.
func (Keeper) SetAllClientMetadata ¶
func (k Keeper) SetAllClientMetadata(ctx sdk.Context, genMetadata []types.IdentifiedGenesisMetadata)
SetAllClientMetadata takes a list of IdentifiedGenesisMetadata and stores all of the metadata in the client store at the appropriate paths.
func (Keeper) SetClientConsensusState ¶
func (k Keeper) SetClientConsensusState(ctx sdk.Context, clientID string, height exported.Height, consensusState exported.ConsensusState)
SetClientConsensusState sets a ConsensusState to a particular client at the given height
func (Keeper) SetClientState ¶
SetClientState sets a particular Client to the store
func (Keeper) SetNextClientSequence ¶
SetNextClientSequence sets the next client sequence to the store.
func (Keeper) UnmarshalClientState ¶
func (k Keeper) UnmarshalClientState(bz []byte) (exported.ClientState, error)
UnmarshalClientState attempts to decode and return an ClientState object from raw encoded bytes.
func (Keeper) UnmarshalConsensusState ¶
func (k Keeper) UnmarshalConsensusState(bz []byte) (exported.ConsensusState, error)
UnmarshalConsensusState attempts to decode and return an ConsensusState object from raw encoded bytes.
func (Keeper) UpdateClient ¶
UpdateClient updates the consensus state and the state root from a provided header.
func (Keeper) UpgradeClient ¶
func (k Keeper) UpgradeClient(ctx sdk.Context, clientID string, upgradedClient exported.ClientState, upgradedConsState exported.ConsensusState, proofUpgradeClient, proofUpgradeConsState []byte) error
UpgradeClient upgrades the client to a new client state if this new client was committed to by the old client at the specified upgrade height
func (Keeper) ValidateSelfClient ¶
ValidateSelfClient validates the client parameters for a client of the running chain This function is only used to validate the client state the counterparty stores for this chain Client must be in same revision as the executing chain