keeper

package
v0.50.5 Latest Latest
Warning

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

 Go to latest Published: Mar 12, 2024 License: Apache-2.0 Imports: 27 Imported by: 1,417

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func AllInvariants 

func AllInvariants(k Keeper) sdk.Invariant

AllInvariants runs all invariants of the distribution module

func CanWithdrawInvariant 

func CanWithdrawInvariant(k Keeper) sdk.Invariant

CanWithdrawInvariant checks that current rewards can be completely withdrawn

func ModuleAccountInvariant 

func ModuleAccountInvariant(k Keeper) sdk.Invariant

ModuleAccountInvariant checks that the coins held by the distr ModuleAccount is consistent with the sum of validator outstanding rewards

func NewMsgServerImpl added in v0.40.0 

func NewMsgServerImpl(keeper Keeper) types.MsgServer

NewMsgServerImpl returns an implementation of the distribution MsgServer interface for the provided Keeper.

func NonNegativeOutstandingInvariant 

func NonNegativeOutstandingInvariant(k Keeper) sdk.Invariant

NonNegativeOutstandingInvariant checks that outstanding unwithdrawn fees are never negative

func ReferenceCountInvariant 

func ReferenceCountInvariant(k Keeper) sdk.Invariant

ReferenceCountInvariant checks that the number of historical rewards records is correct

func RegisterInvariants 

func RegisterInvariants(ir sdk.InvariantRegistry, k Keeper)

register all distribution invariants

Types

type Hooks 

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

Wrapper struct

func (Hooks) AfterDelegationModified 

func (h Hooks) AfterDelegationModified(ctx context.Context, delAddr sdk.AccAddress, valAddr sdk.ValAddress) error

create new delegation period record

func (Hooks) AfterUnbondingInitiated added in v0.47.0 

func (h Hooks) AfterUnbondingInitiated(_ context.Context, _ uint64) error

func (Hooks) AfterValidatorBeginUnbonding 

func (h Hooks) AfterValidatorBeginUnbonding(_ context.Context, _ sdk.ConsAddress, _ sdk.ValAddress) error

func (Hooks) AfterValidatorBonded 

func (h Hooks) AfterValidatorBonded(_ context.Context, _ sdk.ConsAddress, _ sdk.ValAddress) error

func (Hooks) AfterValidatorCreated 

func (h Hooks) AfterValidatorCreated(ctx context.Context, valAddr sdk.ValAddress) error

initialize validator distribution record

func (Hooks) AfterValidatorRemoved 

func (h Hooks) AfterValidatorRemoved(ctx context.Context, _ sdk.ConsAddress, valAddr sdk.ValAddress) error

AfterValidatorRemoved performs clean up after a validator is removed

func (Hooks) BeforeDelegationCreated 

func (h Hooks) BeforeDelegationCreated(ctx context.Context, delAddr sdk.AccAddress, valAddr sdk.ValAddress) error

increment period

func (Hooks) BeforeDelegationRemoved 

func (h Hooks) BeforeDelegationRemoved(_ context.Context, _ sdk.AccAddress, _ sdk.ValAddress) error

func (Hooks) BeforeDelegationSharesModified 

func (h Hooks) BeforeDelegationSharesModified(ctx context.Context, delAddr sdk.AccAddress, valAddr sdk.ValAddress) error

withdraw delegation rewards (which also increments period)

func (Hooks) BeforeValidatorModified 

func (h Hooks) BeforeValidatorModified(_ context.Context, _ sdk.ValAddress) error

func (Hooks) BeforeValidatorSlashed 

func (h Hooks) BeforeValidatorSlashed(ctx context.Context, valAddr sdk.ValAddress, fraction sdkmath.LegacyDec) error

record the slash event

type Keeper 

type Keeper struct {
	Schema  collections.Schema
	Params  collections.Item[types.Params]
	FeePool collections.Item[types.FeePool]
	// contains filtered or unexported fields
}

Keeper of the distribution store

func NewKeeper 

func NewKeeper(
	cdc codec.BinaryCodec, storeService store.KVStoreService,
	ak types.AccountKeeper, bk types.BankKeeper, sk types.StakingKeeper,
	feeCollectorName, authority string,
) Keeper

NewKeeper creates a new distribution Keeper instance

func (Keeper) AllocateTokens 

func (k Keeper) AllocateTokens(ctx context.Context, totalPreviousPower int64, bondedVotes []abci.VoteInfo) error

AllocateTokens performs reward and fee distribution to all validators based on the F1 fee distribution specification.

func (Keeper) AllocateTokensToValidator 

func (k Keeper) AllocateTokensToValidator(ctx context.Context, val stakingtypes.ValidatorI, tokens sdk.DecCoins) error

AllocateTokensToValidator allocate tokens to a particular validator, splitting according to commission.

func (Keeper) CalculateDelegationRewards 

func (k Keeper) CalculateDelegationRewards(ctx context.Context, val stakingtypes.ValidatorI, del stakingtypes.DelegationI, endingPeriod uint64) (rewards sdk.DecCoins, err error)

calculate the total rewards accrued by a delegation

func (Keeper) DeleteAllValidatorHistoricalRewards 

func (k Keeper) DeleteAllValidatorHistoricalRewards(ctx context.Context)

delete all historical rewards

func (Keeper) DeleteAllValidatorSlashEvents 

func (k Keeper) DeleteAllValidatorSlashEvents(ctx context.Context)

delete all slash events

func (Keeper) DeleteDelegatorStartingInfo 

func (k Keeper) DeleteDelegatorStartingInfo(ctx context.Context, val sdk.ValAddress, del sdk.AccAddress) error

delete the starting info associated with a delegator

func (Keeper) DeleteDelegatorWithdrawAddr 

func (k Keeper) DeleteDelegatorWithdrawAddr(ctx context.Context, delAddr, withdrawAddr sdk.AccAddress) error

delete a delegator withdraw addr

func (Keeper) DeleteValidatorAccumulatedCommission 

func (k Keeper) DeleteValidatorAccumulatedCommission(ctx context.Context, val sdk.ValAddress) error

delete accumulated commission for a validator

func (Keeper) DeleteValidatorCurrentRewards 

func (k Keeper) DeleteValidatorCurrentRewards(ctx context.Context, val sdk.ValAddress) error

delete current rewards for a validator

func (Keeper) DeleteValidatorHistoricalReward 

func (k Keeper) DeleteValidatorHistoricalReward(ctx context.Context, val sdk.ValAddress, period uint64) error

delete a historical reward

func (Keeper) DeleteValidatorHistoricalRewards 

func (k Keeper) DeleteValidatorHistoricalRewards(ctx context.Context, val sdk.ValAddress)

delete historical rewards for a validator

func (Keeper) DeleteValidatorOutstandingRewards 

func (k Keeper) DeleteValidatorOutstandingRewards(ctx context.Context, val sdk.ValAddress) error

delete validator outstanding rewards

func (Keeper) DeleteValidatorSlashEvents 

func (k Keeper) DeleteValidatorSlashEvents(ctx context.Context, val sdk.ValAddress)

delete slash events for a particular validator

func (Keeper) DistributeFromFeePool 

func (k Keeper) DistributeFromFeePool(ctx context.Context, amount sdk.Coins, receiveAddr sdk.AccAddress) error

DistributeFromFeePool distributes funds from the distribution module account to a receiver address while updating the community pool

func (Keeper) ExportGenesis added in v0.40.0 

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

ExportGenesis returns a GenesisState for a given context and keeper.

func (Keeper) FundCommunityPool 

func (k Keeper) FundCommunityPool(ctx context.Context, amount sdk.Coins, sender sdk.AccAddress) error

FundCommunityPool allows an account to directly fund the community fund pool. The amount is first added to the distribution module account and then directly added to the pool. An error is returned if the amount cannot be sent to the module account.

func (Keeper) GetAuthority added in v0.47.0 

func (k Keeper) GetAuthority() string

GetAuthority returns the x/distribution module's authority.

func (Keeper) GetCommunityTax 

func (k Keeper) GetCommunityTax(ctx context.Context) (math.LegacyDec, error)

GetCommunityTax returns the current distribution community tax.

func (Keeper) GetDelegatorStartingInfo 

func (k Keeper) GetDelegatorStartingInfo(ctx context.Context, val sdk.ValAddress, del sdk.AccAddress) (period types.DelegatorStartingInfo, err error)

get the starting info associated with a delegator

func (Keeper) GetDelegatorWithdrawAddr 

func (k Keeper) GetDelegatorWithdrawAddr(ctx context.Context, delAddr sdk.AccAddress) (sdk.AccAddress, error)

get the delegator withdraw address, defaulting to the delegator address

func (Keeper) GetDistributionAccount 

func (k Keeper) GetDistributionAccount(ctx context.Context) sdk.ModuleAccountI

GetDistributionAccount returns the distribution ModuleAccount

func (Keeper) GetPreviousProposerConsAddr 

func (k Keeper) GetPreviousProposerConsAddr(ctx context.Context) (sdk.ConsAddress, error)

GetPreviousProposerConsAddr returns the proposer consensus address for the current block.

func (Keeper) GetTotalRewards 

func (k Keeper) GetTotalRewards(ctx context.Context) (totalRewards sdk.DecCoins)

GetTotalRewards returns the total amount of fee distribution rewards held in the store

func (Keeper) GetValidatorAccumulatedCommission 

func (k Keeper) GetValidatorAccumulatedCommission(ctx context.Context, val sdk.ValAddress) (commission types.ValidatorAccumulatedCommission, err error)

get accumulated commission for a validator

func (Keeper) GetValidatorCurrentRewards 

func (k Keeper) GetValidatorCurrentRewards(ctx context.Context, val sdk.ValAddress) (rewards types.ValidatorCurrentRewards, err error)

get current rewards for a validator

func (Keeper) GetValidatorHistoricalReferenceCount 

func (k Keeper) GetValidatorHistoricalReferenceCount(ctx context.Context) (count uint64)

historical reference count (used for testcases)

func (Keeper) GetValidatorHistoricalRewards 

func (k Keeper) GetValidatorHistoricalRewards(ctx context.Context, val sdk.ValAddress, period uint64) (rewards types.ValidatorHistoricalRewards, err error)

get historical rewards for a particular period

func (Keeper) GetValidatorOutstandingRewards 

func (k Keeper) GetValidatorOutstandingRewards(ctx context.Context, val sdk.ValAddress) (rewards types.ValidatorOutstandingRewards, err error)

get validator outstanding rewards

func (Keeper) GetValidatorOutstandingRewardsCoins 

func (k Keeper) GetValidatorOutstandingRewardsCoins(ctx context.Context, val sdk.ValAddress) (sdk.DecCoins, error)

get outstanding rewards

func (Keeper) GetValidatorSlashEvent 

func (k Keeper) GetValidatorSlashEvent(ctx context.Context, val sdk.ValAddress, height, period uint64) (event types.ValidatorSlashEvent, found bool, err error)

get slash event for height

func (Keeper) GetWithdrawAddrEnabled 

func (k Keeper) GetWithdrawAddrEnabled(ctx context.Context) (enabled bool, err error)

GetWithdrawAddrEnabled returns the current distribution withdraw address enabled parameter.

func (Keeper) HasDelegatorStartingInfo 

func (k Keeper) HasDelegatorStartingInfo(ctx context.Context, val sdk.ValAddress, del sdk.AccAddress) (bool, error)

check existence of the starting info associated with a delegator

func (Keeper) Hooks 

func (k Keeper) Hooks() Hooks

Create new distribution hooks

func (Keeper) IncrementValidatorPeriod 

func (k Keeper) IncrementValidatorPeriod(ctx context.Context, val stakingtypes.ValidatorI) (uint64, error)

increment validator period, returning the period just ended

func (Keeper) InitGenesis added in v0.40.0 

func (k Keeper) InitGenesis(ctx sdk.Context, data types.GenesisState)

InitGenesis sets distribution information for genesis

func (Keeper) IterateDelegatorStartingInfos 

func (k Keeper) IterateDelegatorStartingInfos(ctx context.Context, handler func(val sdk.ValAddress, del sdk.AccAddress, info types.DelegatorStartingInfo) (stop bool))

iterate over delegator starting infos

func (Keeper) IterateDelegatorWithdrawAddrs 

func (k Keeper) IterateDelegatorWithdrawAddrs(ctx context.Context, handler func(del, addr sdk.AccAddress) (stop bool))

iterate over delegator withdraw addrs

func (Keeper) IterateValidatorAccumulatedCommissions 

func (k Keeper) IterateValidatorAccumulatedCommissions(ctx context.Context, handler func(val sdk.ValAddress, commission types.ValidatorAccumulatedCommission) (stop bool))

iterate over accumulated commissions

func (Keeper) IterateValidatorCurrentRewards 

func (k Keeper) IterateValidatorCurrentRewards(ctx context.Context, handler func(val sdk.ValAddress, rewards types.ValidatorCurrentRewards) (stop bool))

iterate over current rewards

func (Keeper) IterateValidatorHistoricalRewards 

func (k Keeper) IterateValidatorHistoricalRewards(ctx context.Context, handler func(val sdk.ValAddress, period uint64, rewards types.ValidatorHistoricalRewards) (stop bool))

iterate over historical rewards

func (Keeper) IterateValidatorOutstandingRewards 

func (k Keeper) IterateValidatorOutstandingRewards(ctx context.Context, handler func(val sdk.ValAddress, rewards types.ValidatorOutstandingRewards) (stop bool))

iterate validator outstanding rewards

func (Keeper) IterateValidatorSlashEvents 

func (k Keeper) IterateValidatorSlashEvents(ctx context.Context, handler func(val sdk.ValAddress, height uint64, event types.ValidatorSlashEvent) (stop bool))

iterate over all slash events

func (Keeper) IterateValidatorSlashEventsBetween 

func (k Keeper) IterateValidatorSlashEventsBetween(ctx context.Context, val sdk.ValAddress, startingHeight, endingHeight uint64,
	handler func(height uint64, event types.ValidatorSlashEvent) (stop bool),
)

iterate over slash events between heights, inclusive

func (Keeper) Logger 

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

Logger returns a module-specific logger.

func (Keeper) SetDelegatorStartingInfo 

func (k Keeper) SetDelegatorStartingInfo(ctx context.Context, val sdk.ValAddress, del sdk.AccAddress, period types.DelegatorStartingInfo) error

set the starting info associated with a delegator

func (Keeper) SetDelegatorWithdrawAddr 

func (k Keeper) SetDelegatorWithdrawAddr(ctx context.Context, delAddr, withdrawAddr sdk.AccAddress) error

set the delegator withdraw address

func (Keeper) SetPreviousProposerConsAddr 

func (k Keeper) SetPreviousProposerConsAddr(ctx context.Context, consAddr sdk.ConsAddress) error

set the proposer public key for this block

func (Keeper) SetValidatorAccumulatedCommission 

func (k Keeper) SetValidatorAccumulatedCommission(ctx context.Context, val sdk.ValAddress, commission types.ValidatorAccumulatedCommission) error

set accumulated commission for a validator

func (Keeper) SetValidatorCurrentRewards 

func (k Keeper) SetValidatorCurrentRewards(ctx context.Context, val sdk.ValAddress, rewards types.ValidatorCurrentRewards) error

set current rewards for a validator

func (Keeper) SetValidatorHistoricalRewards 

func (k Keeper) SetValidatorHistoricalRewards(ctx context.Context, val sdk.ValAddress, period uint64, rewards types.ValidatorHistoricalRewards) error

set historical rewards for a particular period

func (Keeper) SetValidatorOutstandingRewards 

func (k Keeper) SetValidatorOutstandingRewards(ctx context.Context, val sdk.ValAddress, rewards types.ValidatorOutstandingRewards) error

set validator outstanding rewards

func (Keeper) SetValidatorSlashEvent 

func (k Keeper) SetValidatorSlashEvent(ctx context.Context, val sdk.ValAddress, height, period uint64, event types.ValidatorSlashEvent) error

set slash event for height

func (Keeper) SetWithdrawAddr 

func (k Keeper) SetWithdrawAddr(ctx context.Context, delegatorAddr, withdrawAddr sdk.AccAddress) error

SetWithdrawAddr sets a new address that will receive the rewards upon withdrawal

func (Keeper) WithdrawDelegationRewards 

func (k Keeper) WithdrawDelegationRewards(ctx context.Context, delAddr sdk.AccAddress, valAddr sdk.ValAddress) (sdk.Coins, error)

withdraw rewards from a delegation

func (Keeper) WithdrawValidatorCommission 

func (k Keeper) WithdrawValidatorCommission(ctx context.Context, valAddr sdk.ValAddress) (sdk.Coins, error)

withdraw validator commission

type Migrator added in v0.43.0 

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

Migrator is a struct for handling in-place store migrations.

func NewMigrator added in v0.43.0 

func NewMigrator(keeper Keeper, legacySubspace exported.Subspace) Migrator

NewMigrator returns a new Migrator.

func (Migrator) Migrate1to2 added in v0.43.0 

func (m Migrator) Migrate1to2(ctx sdk.Context) error

Migrate1to2 migrates from version 1 to 2.

func (Migrator) Migrate2to3 added in v0.47.0 

func (m Migrator) Migrate2to3(ctx sdk.Context) error

Migrate2to3 migrates the x/distribution module state from the consensus version 2 to version 3. Specifically, it takes the parameters that are currently stored and managed by the x/params module and stores them directly into the x/distribution module state.

type Querier added in v0.47.0 

type Querier struct {
	Keeper
}

func NewQuerier 

func NewQuerier(keeper Keeper) Querier

func (Querier) CommunityPool added in v0.47.0 

func (k Querier) CommunityPool(ctx context.Context, req *types.QueryCommunityPoolRequest) (*types.QueryCommunityPoolResponse, error)

CommunityPool queries the community pool coins

func (Querier) DelegationRewards added in v0.47.0 

func (k Querier) DelegationRewards(ctx context.Context, req *types.QueryDelegationRewardsRequest) (*types.QueryDelegationRewardsResponse, error)

DelegationRewards the total rewards accrued by a delegation

func (Querier) DelegationTotalRewards added in v0.47.0 

func (k Querier) DelegationTotalRewards(ctx context.Context, req *types.QueryDelegationTotalRewardsRequest) (*types.QueryDelegationTotalRewardsResponse, error)

DelegationTotalRewards the total rewards accrued by a each validator

func (Querier) DelegatorValidators added in v0.47.0 

func (k Querier) DelegatorValidators(ctx context.Context, req *types.QueryDelegatorValidatorsRequest) (*types.QueryDelegatorValidatorsResponse, error)

DelegatorValidators queries the validators list of a delegator

func (Querier) DelegatorWithdrawAddress added in v0.47.0 

func (k Querier) DelegatorWithdrawAddress(ctx context.Context, req *types.QueryDelegatorWithdrawAddressRequest) (*types.QueryDelegatorWithdrawAddressResponse, error)

DelegatorWithdrawAddress queries Query/delegatorWithdrawAddress

func (Querier) Params added in v0.47.0 

func (k Querier) Params(ctx context.Context, req *types.QueryParamsRequest) (*types.QueryParamsResponse, error)

Params queries params of distribution module

func (Querier) ValidatorCommission added in v0.47.0 

func (k Querier) ValidatorCommission(ctx context.Context, req *types.QueryValidatorCommissionRequest) (*types.QueryValidatorCommissionResponse, error)

ValidatorCommission queries accumulated commission for a validator

func (Querier) ValidatorDistributionInfo added in v0.47.0 

func (k Querier) ValidatorDistributionInfo(ctx context.Context, req *types.QueryValidatorDistributionInfoRequest) (*types.QueryValidatorDistributionInfoResponse, error)

ValidatorDistributionInfo query validator's commission and self-delegation rewards

func (Querier) ValidatorOutstandingRewards added in v0.47.0 

func (k Querier) ValidatorOutstandingRewards(ctx context.Context, req *types.QueryValidatorOutstandingRewardsRequest) (*types.QueryValidatorOutstandingRewardsResponse, error)

ValidatorOutstandingRewards queries rewards of a validator address

func (Querier) ValidatorSlashes added in v0.47.0 

func (k Querier) ValidatorSlashes(ctx context.Context, req *types.QueryValidatorSlashesRequest) (*types.QueryValidatorSlashesResponse, error)

ValidatorSlashes queries slash events of a validator

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.