keeper

package
v1.0.0-rc4 Latest Latest
Warning

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Hooks 

type Hooks struct {
	// contains filtered or unexported fields
}

Hooks wrapper struct for ConsumerKeeper

type Keeper 

type Keeper struct {
	// contains filtered or unexported fields
}

Keeper defines the Cross-Chain Validation Consumer Keeper

func NewKeeper 

func NewKeeper(
	cdc codec.BinaryCodec, key sdk.StoreKey, paramSpace paramtypes.Subspace,
	scopedKeeper ccv.ScopedKeeper,
	channelKeeper ccv.ChannelKeeper, portKeeper ccv.PortKeeper,
	connectionKeeper ccv.ConnectionKeeper, clientKeeper ccv.ClientKeeper,
	slashingKeeper ccv.SlashingKeeper, bankKeeper ccv.BankKeeper, accountKeeper ccv.AccountKeeper,
	ibcTransferKeeper ccv.IBCTransferKeeper, ibcCoreKeeper ccv.IBCCoreKeeper,
	feeCollectorName string,
) Keeper

NewKeeper creates a new Consumer Keeper instance NOTE: the feeCollectorName is in reference to the consumer-chain fee collector (and not the provider chain)

func (Keeper) AfterValidatorBonded 

func (k Keeper) AfterValidatorBonded(ctx sdk.Context, consAddr sdk.ConsAddress, _ sdk.ValAddress)

func (Keeper) AppendPendingPacket added in v1.0.0 

func (k Keeper) AppendPendingPacket(ctx sdk.Context, packet ...ccv.ConsumerPacketData)

AppendPendingDataPacket appends the given data packet to the pending data packets in store

func (Keeper) ApplyCCValidatorChanges 

func (k Keeper) ApplyCCValidatorChanges(ctx sdk.Context, changes []abci.ValidatorUpdate) []abci.ValidatorUpdate

ApplyCCValidatorChanges applies the given changes to the cross-chain validators states and returns updates to forward to tendermint.

func (Keeper) AuthenticateCapability 

func (k Keeper) AuthenticateCapability(ctx sdk.Context, cap *capabilitytypes.Capability, name string) bool

AuthenticateCapability wraps the scopedKeeper's AuthenticateCapability function

func (Keeper) BindPort 

func (k Keeper) BindPort(ctx sdk.Context, portID string) error

BindPort defines a wrapper function for the ort Keeper's function in order to expose it to module's InitGenesis function

func (Keeper) ChanCloseInit 

func (k Keeper) ChanCloseInit(ctx sdk.Context, portID, channelID string) error

ChanCloseInit defines a wrapper function for the channel Keeper's function Following ICS 004: https://github.com/cosmos/ibc/tree/main/spec/core/ics-004-channel-and-packet-semantics#closing-handshake

func (Keeper) ChannelOpenInit 

func (k Keeper) ChannelOpenInit(ctx sdk.Context, msg *channeltypes.MsgChannelOpenInit) (
	*channeltypes.MsgChannelOpenInitResponse, error)

func (Keeper) ClaimCapability 

func (k Keeper) ClaimCapability(ctx sdk.Context, cap *capabilitytypes.Capability, name string) error

ClaimCapability claims a capability that the IBC module passes to it

func (Keeper) Delegation 

func (k Keeper) Delegation(sdk.Context, sdk.AccAddress, sdk.ValAddress) stakingtypes.DelegationI

Delegation - unimplemented on CCV keeper

func (Keeper) DeleteCCValidator 

func (k Keeper) DeleteCCValidator(ctx sdk.Context, addr []byte)

DeleteCCValidator deletes a cross-chain validator for a given address

func (Keeper) DeleteHeightValsetUpdateID 

func (k Keeper) DeleteHeightValsetUpdateID(ctx sdk.Context, height uint64)

DeleteHeightValsetUpdateID deletes the valset update id for a given block height

func (Keeper) DeleteHistoricalInfo 

func (k Keeper) DeleteHistoricalInfo(ctx sdk.Context, height int64)

DeleteHistoricalInfo deletes the historical info at a given height

func (Keeper) DeleteOutstandingDowntime added in v0.2.0 

func (k Keeper) DeleteOutstandingDowntime(ctx sdk.Context, consAddress string)

DeleteOutstandingDowntime deletes the outstanding downtime flag for the given validator consensus address

func (Keeper) DeletePacketMaturityTimes added in v1.0.0 

func (k Keeper) DeletePacketMaturityTimes(ctx sdk.Context, vscId uint64, maturityTime time.Time)

DeletePacketMaturityTimes deletes the packet maturity time for a given vscId and maturityTime

func (Keeper) DeletePendingChanges 

func (k Keeper) DeletePendingChanges(ctx sdk.Context)

DeletePendingChanges deletes the pending changes after they've been flushed to ABCI

func (Keeper) DeletePendingDataPackets added in v1.0.0 

func (k Keeper) DeletePendingDataPackets(ctx sdk.Context)

DeletePendingDataPackets clears the pending data packets in store

func (Keeper) DeleteProviderChannel 

func (k Keeper) DeleteProviderChannel(ctx sdk.Context)

DeleteProviderChannel deletes the channelID for the channel to the provider.

func (Keeper) DistributeRewardsInternally added in v1.0.0 

func (k Keeper) DistributeRewardsInternally(ctx sdk.Context)

DistributeRewardsInternally splits the block rewards according to the ConsumerRedistributionFrac param. Returns true if it's time to send rewards to provider

func (Keeper) EndBlockRD added in v1.0.0 

func (k Keeper) EndBlockRD(ctx sdk.Context)

EndBlockRD executes EndBlock logic for the Reward Distribution sub-protocol. Reward Distribution follows a simple model: send tokens to the fee pool of the provider validator set

func (Keeper) ExportGenesis 

func (k Keeper) ExportGenesis(ctx sdk.Context) (genesis *consumertypes.GenesisState)

ExportGenesis returns the CCV consumer module's exported genesis

func (Keeper) GetAllCCValidator 

func (k Keeper) GetAllCCValidator(ctx sdk.Context) (validators []types.CrossChainValidator)

GetAllCCValidator returns all cross-chain validators

Note that the cross-chain validators are stored under keys with the following format: CrossChainValidatorBytePrefix | address Thus, the returned array is in ascending order of addresses.

func (Keeper) GetAllHeightToValsetUpdateIDs added in v1.0.0 

func (k Keeper) GetAllHeightToValsetUpdateIDs(ctx sdk.Context) (heightToValsetUpdateIDs []types.HeightToValsetUpdateID)

GetAllHeightToValsetUpdateIDs returns a list of all the block heights to valset update IDs in the store

Note that the block height to vscID mapping is stored under keys with the following format: HeightValsetUpdateIDBytePrefix | height Thus, the returned array is in ascending order of heights.

func (Keeper) GetAllOutstandingDowntimes added in v1.0.0 

func (k Keeper) GetAllOutstandingDowntimes(ctx sdk.Context) (downtimes []consumertypes.OutstandingDowntime)

GetAllOutstandingDowntimes gets an array of the validator addresses of outstanding downtime flags

Note that the outstanding downtime flags are stored under keys with the following format: OutstandingDowntimeBytePrefix | consAddress Thus, the returned array is in ascending order of consAddresses.

func (Keeper) GetAllPacketMaturityTimes added in v1.0.0 

func (k Keeper) GetAllPacketMaturityTimes(ctx sdk.Context) (maturingVSCPackets []consumertypes.MaturingVSCPacket)

GetAllPacketMaturityTimes returns a slice of all PacketMaturityTimes, sorted by maturity times.

Note that PacketMaturityTimes are stored under keys with the following format: PacketMaturityTimeBytePrefix | maturityTime.UnixNano() | vscID Thus, the returned array is in ascending order of maturityTimes. If two entries have the same maturityTime, then they are ordered by vscID.

func (Keeper) GetBlocksPerDistributionTransmission 

func (k Keeper) GetBlocksPerDistributionTransmission(ctx sdk.Context) int64

func (Keeper) GetCCVTimeoutPeriod added in v0.2.0 

func (k Keeper) GetCCVTimeoutPeriod(ctx sdk.Context) time.Duration

GetCCVTimeoutPeriod returns the timeout period for sent ccv related ibc packets

func (Keeper) GetCCValidator 

func (k Keeper) GetCCValidator(ctx sdk.Context, addr []byte) (validator types.CrossChainValidator, found bool)

GetCCValidator returns a cross-chain validator for a given address

func (Keeper) GetConnectionHops 

func (k Keeper) GetConnectionHops(ctx sdk.Context, srcPort, srcChan string) ([]string, error)

func (Keeper) GetConsumerRedistributionFrac added in v0.2.0 

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

GetConsumerRedistributionFrac returns the fraction of tokens allocated to the consumer redistribution address during distribution events. The fraction is a string representing a decimal number. For example "0.75" would represent 75%.

func (Keeper) GetDistributionTransmissionChannel 

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

func (Keeper) GetElapsedPacketMaturityTimes added in v1.0.0 

func (k Keeper) GetElapsedPacketMaturityTimes(ctx sdk.Context) (maturingVSCPackets []consumertypes.MaturingVSCPacket)

GetElapsedPacketMaturityTimes returns a slice of already elapsed PacketMaturityTimes, sorted by maturity times, i.e., the slice contains the IDs of the matured VSCPackets.

func (Keeper) GetEnabled 

func (k Keeper) GetEnabled(ctx sdk.Context) bool

GetEnabled returns the enabled flag for the consumer module

func (Keeper) GetEstimatedNextFeeDistribution added in v0.2.0 

func (k Keeper) GetEstimatedNextFeeDistribution(ctx sdk.Context) types.NextFeeDistributionEstimate

GetEstimatedNextFeeDistribution returns data about next fee distribution. Data represents an estimation of accumulated fees at the current block height.

func (Keeper) GetHeightValsetUpdateID 

func (k Keeper) GetHeightValsetUpdateID(ctx sdk.Context, height uint64) uint64

GetHeightValsetUpdateID gets the valset update id recorded for a given block height

func (Keeper) GetHistoricalEntries added in v0.2.0 

func (k Keeper) GetHistoricalEntries(ctx sdk.Context) int64

GetHistoricalEntries returns the number of historical info entries to persist in store

func (Keeper) GetHistoricalInfo 

func (k Keeper) GetHistoricalInfo(ctx sdk.Context, height int64) (stakingtypes.HistoricalInfo, bool)

GetHistoricalInfo gets the historical info at a given height

func (Keeper) GetLastTransmissionBlockHeight 

func (k Keeper) GetLastTransmissionBlockHeight(ctx sdk.Context) types.LastTransmissionBlockHeight

func (Keeper) GetParams 

func (k Keeper) GetParams(ctx sdk.Context) types.Params

GetParams returns the params for the consumer ccv module

func (Keeper) GetPendingChanges 

func (k Keeper) GetPendingChanges(ctx sdk.Context) (*ccv.ValidatorSetChangePacketData, bool)

GetPendingChanges gets the pending changes that haven't been flushed over ABCI

func (Keeper) GetPendingPackets added in v1.0.0 

func (k Keeper) GetPendingPackets(ctx sdk.Context) ccv.ConsumerPacketDataList

GetPendingPackets returns the pending CCV packets from the store

func (Keeper) GetPort 

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

GetPort returns the portID for the transfer module. Used in ExportGenesis

func (Keeper) GetProviderChannel 

func (k Keeper) GetProviderChannel(ctx sdk.Context) (string, bool)

GetProviderChannel gets the channelID for the channel to the provider.

func (Keeper) GetProviderClientID added in v0.1.4 

func (k Keeper) GetProviderClientID(ctx sdk.Context) (string, bool)

GetProviderClientID gets the clientID for the client to the provider.

func (Keeper) GetProviderFeePoolAddrStr 

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

func (Keeper) GetTransferTimeoutPeriod added in v0.2.0 

func (k Keeper) GetTransferTimeoutPeriod(ctx sdk.Context) time.Duration

GetTransferTimeoutPeriod returns the timeout period for sent transfer related ibc packets

func (Keeper) GetUnbondingPeriod added in v0.2.0 

func (k Keeper) GetUnbondingPeriod(ctx sdk.Context) time.Duration

func (Keeper) Hooks 

func (k Keeper) Hooks() Hooks

Return the wrapper struct

func (Keeper) InitGenesis 

func (k Keeper) InitGenesis(ctx sdk.Context, state *consumertypes.GenesisState) []abci.ValidatorUpdate

InitGenesis initializes the CCV consumer state and binds to PortID. The three states in which a consumer chain can start/restart:

  1. A client to the provider was never created, i.e. a new consumer chain is started for the first time.
  2. A consumer chain restarts after a client to the provider was created, but the CCV channel handshake is still in progress
  3. A consumer chain restarts after the CCV channel handshake was completed.

func (Keeper) IsBound 

func (k Keeper) IsBound(ctx sdk.Context, portID string) bool

IsBound checks if the transfer module is already bound to the desired port

func (Keeper) IsChannelClosed 

func (k Keeper) IsChannelClosed(ctx sdk.Context, channelID string) bool

IsChannelClosed returns a boolean whether a given channel is in the CLOSED state

func (Keeper) IsValidatorJailed 

func (k Keeper) IsValidatorJailed(ctx sdk.Context, addr sdk.ConsAddress) bool

IsJailed returns the outstanding slashing flag for the given validator adddress

func (Keeper) IterateValidators 

func (k Keeper) IterateValidators(sdk.Context, func(index int64, validator stakingtypes.ValidatorI) (stop bool))

IterateValidators - unimplemented on CCV keeper but perform a no-op in order to pass the slashing module InitGenesis. It is allowed since the condition verifying validator public keys in HandleValidatorSignature (x/slashing/keeper/infractions.go) is removed therefore it isn't required to store any validator public keys to the slashing states during genesis.

func (Keeper) Jail 

func (k Keeper) Jail(ctx sdk.Context, addr sdk.ConsAddress)

Jail - unimplemented on CCV keeper

func (Keeper) Logger 

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

Logger returns a module-specific logger.

func (Keeper) MaxValidators 

func (k Keeper) MaxValidators(sdk.Context) uint32

MaxValidators - unimplemented on CCV keeper

func (Keeper) MustGetCurrentValidatorsAsABCIUpdates added in v1.0.0 

func (k Keeper) MustGetCurrentValidatorsAsABCIUpdates(ctx sdk.Context) []abci.ValidatorUpdate

MustGetCurrentValidatorsAsABCIUpdates gets all cross-chain validators converted to the ABCI validator update type. It panics in case of failure.

func (Keeper) OnAcknowledgementPacket 

func (k Keeper) OnAcknowledgementPacket(ctx sdk.Context, packet channeltypes.Packet, ack channeltypes.Acknowledgement) error

OnAcknowledgementPacket executes application logic for acknowledgments of sent VSCMatured and Slash packets in conjunction with the ibc module's execution of "acknowledgePacket", according to https://github.com/cosmos/ibc/tree/main/spec/core/ics-004-channel-and-packet-semantics#processing-acknowledgements

func (Keeper) OnRecvVSCPacket 

func (k Keeper) OnRecvVSCPacket(ctx sdk.Context, packet channeltypes.Packet, newChanges ccv.ValidatorSetChangePacketData) exported.Acknowledgement

OnRecvVSCPacket sets the pending validator set changes that will be flushed to ABCI on Endblock and set the maturity time for the packet. Once the maturity time elapses, a VSCMatured packet is sent back to the provider chain.

Note: CCV uses an ordered IBC channel, meaning VSC packet changes will be accumulated (and later processed by ApplyCCValidatorChanges) s.t. more recent val power changes overwrite older ones.

func (Keeper) OutstandingDowntime 

func (k Keeper) OutstandingDowntime(ctx sdk.Context, address sdk.ConsAddress) bool

OutstandingDowntime returns the outstanding downtime flag for a given validator

func (Keeper) PacketMaturityTimeExists added in v1.0.0 

func (k Keeper) PacketMaturityTimeExists(ctx sdk.Context, vscId uint64, maturityTime time.Time) bool

PacketMaturityExists checks whether the packet maturity time for a given vscId and maturityTime exists.

Note: this method is only used in testing.

func (Keeper) QueryNextFeeDistribution added in v0.2.0 

func (k Keeper) QueryNextFeeDistribution(c context.Context,
	req *types.QueryNextFeeDistributionEstimateRequest) (*types.QueryNextFeeDistributionEstimateResponse, error)

func (Keeper) QueueSlashPacket added in v1.0.0 

func (k Keeper) QueueSlashPacket(ctx sdk.Context, validator abci.Validator, valsetUpdateID uint64, infraction stakingtypes.InfractionType)

QueueSlashPacket appends a slash packet containing the given validator data and slashing info to queue.

func (Keeper) QueueVSCMaturedPackets added in v1.0.0 

func (k Keeper) QueueVSCMaturedPackets(ctx sdk.Context)

QueueVSCMaturedPackets appends matured VSCs to an internal queue.

Note: Per spec, a VSC reaching maturity on a consumer chain means that all the unbonding operations that resulted in validator updates included in that VSC have matured on the consumer chain.

func (Keeper) SendPackets added in v1.0.0 

func (k Keeper) SendPackets(ctx sdk.Context)

SendPackets iterates queued packets and sends them in FIFO order. received VSC packets in order, and write acknowledgements for all matured VSC packets.

This method is a no-op if there is no established channel to provider or the queue is empty.

Note: Per spec, a VSC reaching maturity on a consumer chain means that all the unbonding operations that resulted in validator updates included in that VSC have matured on the consumer chain.

func (Keeper) SendRewardsToProvider added in v1.0.0 

func (k Keeper) SendRewardsToProvider(ctx sdk.Context) error

SendRewardsToProvider attempts to send to the provider (via IBC) all the block rewards allocated for the provider

func (Keeper) SetBlocksPerDistributionTransmission 

func (k Keeper) SetBlocksPerDistributionTransmission(ctx sdk.Context, bpdt int64)

func (Keeper) SetCCValidator 

func (k Keeper) SetCCValidator(ctx sdk.Context, v types.CrossChainValidator)

SetCCValidator sets a cross-chain validator under its validator address

func (Keeper) SetDistributionTransmissionChannel 

func (k Keeper) SetDistributionTransmissionChannel(ctx sdk.Context, channel string)

func (Keeper) SetHeightValsetUpdateID 

func (k Keeper) SetHeightValsetUpdateID(ctx sdk.Context, height, valsetUpdateId uint64)

SetHeightValsetUpdateID sets the valset update id for a given block height

func (Keeper) SetHistoricalInfo 

func (k Keeper) SetHistoricalInfo(ctx sdk.Context, height int64, hi *stakingtypes.HistoricalInfo)

SetHistoricalInfo sets the historical info at a given height

func (*Keeper) SetHooks 

func (k *Keeper) SetHooks(sh ccv.ConsumerHooks) *Keeper

func (Keeper) SetLastTransmissionBlockHeight 

func (k Keeper) SetLastTransmissionBlockHeight(ctx sdk.Context, ltbh types.LastTransmissionBlockHeight)

func (Keeper) SetOutstandingDowntime 

func (k Keeper) SetOutstandingDowntime(ctx sdk.Context, address sdk.ConsAddress)

SetOutstandingDowntime sets the outstanding downtime flag for a given validator

func (Keeper) SetPacketMaturityTime 

func (k Keeper) SetPacketMaturityTime(ctx sdk.Context, vscId uint64, maturityTime time.Time)

SetPacketMaturityTime sets the maturity time for a given received VSC packet id

func (Keeper) SetParams 

func (k Keeper) SetParams(ctx sdk.Context, params types.Params)

SetParams sets the paramset for the consumer module

func (Keeper) SetPendingChanges 

func (k Keeper) SetPendingChanges(ctx sdk.Context, updates ccv.ValidatorSetChangePacketData)

SetPendingChanges sets the pending validator set change packet that haven't been flushed to ABCI

func (Keeper) SetPendingPackets added in v1.0.0 

func (k Keeper) SetPendingPackets(ctx sdk.Context, packets ccv.ConsumerPacketDataList)

SetPendingPackets sets the pending CCV packets

func (Keeper) SetPort 

func (k Keeper) SetPort(ctx sdk.Context, portID string)

SetPort sets the portID for the CCV module. Used in InitGenesis

func (Keeper) SetProviderChannel 

func (k Keeper) SetProviderChannel(ctx sdk.Context, channelID string)

SetProviderChannel sets the channelID for the channel to the provider.

func (Keeper) SetProviderClientID added in v0.1.4 

func (k Keeper) SetProviderClientID(ctx sdk.Context, clientID string)

SetProviderClientID sets the clientID for the client to the provider. Set in InitGenesis

func (Keeper) SetProviderFeePoolAddrStr 

func (k Keeper) SetProviderFeePoolAddrStr(ctx sdk.Context, addr string)

func (Keeper) SetUnbondingPeriod added in v0.2.0 

func (k Keeper) SetUnbondingPeriod(ctx sdk.Context, period time.Duration)

Only used to set an unbonding period in diff tests

func (Keeper) Slash 

func (k Keeper) Slash(ctx sdk.Context, addr sdk.ConsAddress, infractionHeight, power int64, _ sdk.Dec, infraction stakingtypes.InfractionType)

Slash queues a slashing request for the the provider chain All queued slashing requests will be cleared in EndBlock

func (Keeper) TrackHistoricalInfo 

func (k Keeper) TrackHistoricalInfo(ctx sdk.Context)

TrackHistoricalInfo saves the latest historical-info and deletes the oldest heights that are below pruning height

func (Keeper) UnbondingTime 

func (k Keeper) UnbondingTime(ctx sdk.Context) time.Duration

UnbondingTime returns consumer unbonding period, satisfying the staking keeper interface

func (Keeper) Unjail 

func (k Keeper) Unjail(sdk.Context, sdk.ConsAddress)

Unjail - unimplemented on CCV keeper

func (Keeper) Validator 

func (k Keeper) Validator(ctx sdk.Context, addr sdk.ValAddress) stakingtypes.ValidatorI

Validator - unimplemented on CCV keeper

func (Keeper) ValidatorByConsAddr 

func (k Keeper) ValidatorByConsAddr(sdk.Context, sdk.ConsAddress) stakingtypes.ValidatorI

ValidatorByConsAddr returns an empty validator

func (Keeper) VerifyProviderChain 

func (k Keeper) VerifyProviderChain(ctx sdk.Context, connectionHops []string) error

VerifyProviderChain verifies that the chain trying to connect on the channel handshake is the expected provider chain.

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.