keeper

package
v0.5.0 Latest Latest
Warning

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

 Go to latest Published: Dec 1, 2023 License: Apache-2.0 Imports: 20 Imported by: 11

Documentation

Index

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.BinaryCodec,
	key storetypes.StoreKey,
	sk types.StakingKeeper,
) Keeper

NewKeeper creates a new NewKeeper instance

func (Keeper) AuthRelayer 

func (k Keeper) AuthRelayer(ctx sdk.Context, chainName string, relayer string) bool

AuthRelayer asserts whether a relayer is already registered

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 

func (k Keeper) ClientStore(ctx sdk.Context, chainName string) sdk.KVStore

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) 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, chainName string, clientState exported.ClientState, consensusState exported.ConsensusState,
) error

CreateClient creates a new client state and populates it with a given client state and consensus state

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) GetAllRelayers 

func (k Keeper) GetAllRelayers(ctx sdk.Context) (relayers []types.IdentifiedRelayers)

GetAllRelayers returns all registered relayer addresses

func (Keeper) GetChainName 

func (k Keeper) GetChainName(ctx sdk.Context) string

GetChainName return the chain name of the current chain

func (Keeper) GetClientConsensusState 

func (k Keeper) GetClientConsensusState(
	ctx sdk.Context,
	chainName string,
	height exported.Height,
) (exported.ConsensusState, bool)

GetClientConsensusState gets the stored consensus state from a client at a given height.

func (Keeper) GetClientState 

func (k Keeper) GetClientState(ctx sdk.Context, chainName string) (exported.ClientState, bool)

GetClientState gets a particular client from the store

func (Keeper) GetLatestClientConsensusState 

func (k Keeper) GetLatestClientConsensusState(
	ctx sdk.Context,
	chainName string,
) (exported.ConsensusState, bool)

GetLatestClientConsensusState gets the latest ConsensusState stored for a given client

func (Keeper) GetRelayers 

func (k Keeper) GetRelayers(ctx sdk.Context, chainName string) (relayers []string)

GetRelayers returns all registered relayer addresses under the specified chain name

func (Keeper) HandleCreateClientProposal 

func (k Keeper) HandleCreateClientProposal(ctx sdk.Context, p *types.CreateClientProposal) error

HandleCreateClientProposal will try to create the client with the new ClientState and ConsensusState if and only if the proposal passes.

func (Keeper) HandleRegisterRelayerProposal 

func (k Keeper) HandleRegisterRelayerProposal(ctx sdk.Context, p *types.RegisterRelayerProposal) error

HandleRegisterRelayerProposal will try to save the registered relayer address under the specified client

func (Keeper) HandleUpgradeClientProposal 

func (k Keeper) HandleUpgradeClientProposal(ctx sdk.Context, p *types.UpgradeClientProposal) error

HandleUpgradeClientProposal will try to update the client with the new ClientState and ConsensusState if and only if the proposal passes.

func (Keeper) HasClientConsensusState 

func (k Keeper) HasClientConsensusState(
	ctx sdk.Context,
	chainName 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(chainName 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(chainName 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) Logger 

func (k Keeper) Logger(ctx sdk.Context) log.Logger

Logger returns a module-specific logger.

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) RegisterRelayers 

func (k Keeper) RegisterRelayers(ctx sdk.Context, chainName string, relayers []string)

RegisterRelayers saves the relayers under the specified chainname

func (Keeper) RelayerStore 

func (k Keeper) RelayerStore(ctx sdk.Context) sdk.KVStore

RelayerStore returns isolated prefix store for each client so they can read/write in separate namespace without being able to read/write other relayer's data

func (Keeper) Relayers 

func (q Keeper) Relayers(c context.Context, req *types.QueryRelayersRequest) (*types.QueryRelayersResponse, error)

Relayers implements the Query/Relayers gRPC method

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) SetChainName 

func (k Keeper) SetChainName(ctx sdk.Context, chainName string)

SetChainName sets a chain name to the tibc module

func (Keeper) SetClientConsensusState 

func (k Keeper) SetClientConsensusState(
	ctx sdk.Context,
	chainName string,
	height exported.Height,
	consensusState exported.ConsensusState,
)

SetClientConsensusState sets a ConsensusState to a particular client at the given height

func (Keeper) SetClientState 

func (k Keeper) SetClientState(
	ctx sdk.Context,
	chainName string,
	clientState exported.ClientState,
)

SetClientState sets a particular Client 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 

func (k Keeper) UpdateClient(ctx sdk.Context, chainName string, header exported.Header) error

UpdateClient updates the consensus state and the state root from a provided header.

func (Keeper) UpgradeClient 

func (k Keeper) UpgradeClient(ctx sdk.Context, chainName string, upgradedClientState exported.ClientState, upgradedConsState exported.ConsensusState) error

UpgradeClient upgrades the client to a new client state.

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.