Documentation
¶
Index ¶
- Variables
- func CanWithdrawInvariant(k Keeper) sdk.Invariant
- func GetTestAddrs() ([]sdk.ValAddress, []crypto.PubKey, []sdk.ConsAddress)
- func HandleCommunityPoolSpendProposal(ctx sdk.Context, k Keeper, p types.CommunityPoolSpendProposal) error
- func MakeTestCodec() *codec.Codec
- func ModuleAccountInvariant(k Keeper) sdk.Invariant
- func NewQuerier(k Keeper) sdk.Querier
- func NewTestSysCoin(i int64, precison int64) sdk.SysCoin
- func NewTestSysCoins(i int64, precison int64) sdk.SysCoins
- func NonNegativeCommissionsInvariant(k Keeper) sdk.Invariant
- func ReInit()
- func RegisterInvariants(ir sdk.InvariantRegistry, k Keeper)
- type Hooks
- func (h Hooks) AfterValidatorBeginUnbonding(_ sdk.Context, _ sdk.ConsAddress, _ sdk.ValAddress)
- func (h Hooks) AfterValidatorBonded(_ sdk.Context, _ sdk.ConsAddress, _ sdk.ValAddress)
- func (h Hooks) AfterValidatorCreated(ctx sdk.Context, valAddr sdk.ValAddress)
- func (h Hooks) AfterValidatorDestroyed(ctx sdk.Context, consAddr sdk.ConsAddress, valAddr sdk.ValAddress)
- func (h Hooks) AfterValidatorRemoved(ctx sdk.Context, _ sdk.ConsAddress, valAddr sdk.ValAddress)
- func (h Hooks) BeforeValidatorModified(_ sdk.Context, _ sdk.ValAddress)
- type Keeper
- func CreateTestInputAdvanced(t *testing.T, isCheckTx bool, initPower int64, communityTax sdk.Dec) (sdk.Context, auth.AccountKeeper, bank.Keeper, Keeper, staking.Keeper, ...)
- func CreateTestInputDefault(t *testing.T, isCheckTx bool, initPower int64) (sdk.Context, auth.AccountKeeper, Keeper, staking.Keeper, types.SupplyKeeper)
- func NewKeeper(cdc *codec.Codec, key sdk.StoreKey, paramSpace params.Subspace, ...) Keeper
- func (k Keeper) AllocateTokens(ctx sdk.Context, totalPreviousPower int64, previousProposer sdk.ConsAddress, ...)
- func (k Keeper) AllocateTokensToValidator(ctx sdk.Context, val exported.ValidatorI, tokens sdk.SysCoins)
- func (k Keeper) GetCommunityTax(ctx sdk.Context) (percent sdk.Dec)
- func (k Keeper) GetDelegatorWithdrawAddr(ctx sdk.Context, delAddr sdk.AccAddress) sdk.AccAddress
- func (k Keeper) GetDistributionAccount(ctx sdk.Context) exported.ModuleAccountI
- func (k Keeper) GetFeePool(ctx sdk.Context) (feePool types.FeePool)
- func (k Keeper) GetFeePoolCommunityCoins(ctx sdk.Context) sdk.SysCoins
- func (k Keeper) GetParams(ctx sdk.Context) (params types.Params)
- func (k Keeper) GetPreviousProposerConsAddr(ctx sdk.Context) (consAddr sdk.ConsAddress)
- func (k Keeper) GetValidatorAccumulatedCommission(ctx sdk.Context, val sdk.ValAddress) (commission types.ValidatorAccumulatedCommission)
- func (k Keeper) GetWithdrawAddrEnabled(ctx sdk.Context) (enabled bool)
- func (k Keeper) Hooks() Hooks
- func (k Keeper) IterateDelegatorWithdrawAddrs(ctx sdk.Context, ...)
- func (k Keeper) IterateValidatorAccumulatedCommissions(ctx sdk.Context, ...)
- func (k Keeper) Logger(ctx sdk.Context) log.Logger
- func (k Keeper) SetCommunityTax(ctx sdk.Context, percent sdk.Dec)
- func (k Keeper) SetDelegatorWithdrawAddr(ctx sdk.Context, delAddr, withdrawAddr sdk.AccAddress)
- func (k Keeper) SetFeePool(ctx sdk.Context, feePool types.FeePool)
- func (k Keeper) SetParams(ctx sdk.Context, params types.Params)
- func (k Keeper) SetPreviousProposerConsAddr(ctx sdk.Context, consAddr sdk.ConsAddress)
- func (k Keeper) SetValidatorAccumulatedCommission(ctx sdk.Context, val sdk.ValAddress, ...)
- func (k Keeper) SetWithdrawAddr(ctx sdk.Context, delegatorAddr sdk.AccAddress, withdrawAddr sdk.AccAddress) error
- func (k Keeper) SetWithdrawAddrEnabled(ctx sdk.Context, enabled bool)
- func (k Keeper) WithdrawValidatorCommission(ctx sdk.Context, valAddr sdk.ValAddress) (sdk.Coins, error)
Constants ¶
This section is empty.
Variables ¶
var ( // TODO move to common testing package for all modules // test addresses TestAddrs = []sdk.AccAddress{ delAddr1, delAddr2, delAddr3, delAddr4, valAccAddr1, valAccAddr2, valAccAddr3, valAccAddr4, } )
nolint: deadcode unused
Functions ¶
func CanWithdrawInvariant ¶
CanWithdrawInvariant checks that current commission can be completely withdrawn
func GetTestAddrs ¶
func GetTestAddrs() ([]sdk.ValAddress, []crypto.PubKey, []sdk.ConsAddress)
GetTestAddrs returns valOpAddrs, valConsPks, valConsAddrs for test
func HandleCommunityPoolSpendProposal ¶
func HandleCommunityPoolSpendProposal(ctx sdk.Context, k Keeper, p types.CommunityPoolSpendProposal) error
HandleCommunityPoolSpendProposal is a handler for executing a passed community spend proposal
func MakeTestCodec ¶
MakeTestCodec creates a codec used only for testing
func ModuleAccountInvariant ¶
ModuleAccountInvariant checks that the coins held by the distr ModuleAccount is consistent with the sum of accumulated commissions
func NewQuerier ¶
NewQuerier creates a querier for distribution REST endpoints
func NewTestSysCoin ¶ added in v0.16.0
NewTestSysCoin returns one dec coin
func NewTestSysCoins ¶ added in v0.16.0
NewTestSysCoins returns dec coins
func NonNegativeCommissionsInvariant ¶
NonNegativeCommissionsInvariant checks that accumulated commissions unwithdrawned fees are never negative
func RegisterInvariants ¶
func RegisterInvariants(ir sdk.InvariantRegistry, k Keeper)
RegisterInvariants registers all distribution invariants
Types ¶
type Hooks ¶
type Hooks struct {
// contains filtered or unexported fields
}
Hooks is struct of keepers from other module
func (Hooks) AfterValidatorBeginUnbonding ¶
func (h Hooks) AfterValidatorBeginUnbonding(_ sdk.Context, _ sdk.ConsAddress, _ sdk.ValAddress)
func (Hooks) AfterValidatorBonded ¶
func (h Hooks) AfterValidatorBonded(_ sdk.Context, _ sdk.ConsAddress, _ sdk.ValAddress)
func (Hooks) AfterValidatorCreated ¶
func (h Hooks) AfterValidatorCreated(ctx sdk.Context, valAddr sdk.ValAddress)
AfterValidatorCreated initializes validator distribution record
func (Hooks) AfterValidatorDestroyed ¶
func (h Hooks) AfterValidatorDestroyed(ctx sdk.Context, consAddr sdk.ConsAddress, valAddr sdk.ValAddress)
AfterValidatorDestroyed nothing to do
func (Hooks) AfterValidatorRemoved ¶
func (h Hooks) AfterValidatorRemoved(ctx sdk.Context, _ sdk.ConsAddress, valAddr sdk.ValAddress)
AfterValidatorRemoved cleans up for after validator is removed
func (Hooks) BeforeValidatorModified ¶
func (h Hooks) BeforeValidatorModified(_ sdk.Context, _ sdk.ValAddress)
nolint - unused hooks
type Keeper ¶
type Keeper struct {
// contains filtered or unexported fields
}
Keeper of the distribution store
func CreateTestInputAdvanced ¶
func CreateTestInputAdvanced(t *testing.T, isCheckTx bool, initPower int64, communityTax sdk.Dec) ( sdk.Context, auth.AccountKeeper, bank.Keeper, Keeper, staking.Keeper, params.Keeper, types.SupplyKeeper)
CreateTestInputAdvanced hogpodge of all sorts of input required for testing
func CreateTestInputDefault ¶
func CreateTestInputDefault(t *testing.T, isCheckTx bool, initPower int64) ( sdk.Context, auth.AccountKeeper, Keeper, staking.Keeper, types.SupplyKeeper)
CreateTestInputDefault test input with default values
func NewKeeper ¶
func NewKeeper( cdc *codec.Codec, key sdk.StoreKey, paramSpace params.Subspace, sk types.StakingKeeper, supplyKeeper types.SupplyKeeper, feeCollectorName string, blacklistedAddrs map[string]bool, ) Keeper
NewKeeper creates a new distribution Keeper instance
func (Keeper) AllocateTokens ¶
func (k Keeper) AllocateTokens(ctx sdk.Context, totalPreviousPower int64, previousProposer sdk.ConsAddress, previousVotes []abci.VoteInfo)
AllocateTokens allocates fees from fee_collector 1. 25% rewards to validators, equally. 2. 75% rewards to validators and candidates, by shares' weight
func (Keeper) AllocateTokensToValidator ¶
func (k Keeper) AllocateTokensToValidator(ctx sdk.Context, val exported.ValidatorI, tokens sdk.SysCoins)
AllocateTokensToValidator allocate tokens to a particular validator, splitting according to commissions
func (Keeper) GetCommunityTax ¶
GetCommunityTax returns the current CommunityTax rate from the global param store nolint: errcheck
func (Keeper) GetDelegatorWithdrawAddr ¶
func (k Keeper) GetDelegatorWithdrawAddr(ctx sdk.Context, delAddr sdk.AccAddress) sdk.AccAddress
GetDelegatorWithdrawAddr returns the delegator withdraw address, defaulting to the delegator address
func (Keeper) GetDistributionAccount ¶
func (k Keeper) GetDistributionAccount(ctx sdk.Context) exported.ModuleAccountI
GetDistributionAccount returns the distribution ModuleAccount
func (Keeper) GetFeePool ¶
GetFeePool returns the global fee pool distribution info
func (Keeper) GetFeePoolCommunityCoins ¶
GetFeePoolCommunityCoins returns the community coins
func (Keeper) GetParams ¶ added in v0.16.0
GetParams returns the total set of distribution parameters.
func (Keeper) GetPreviousProposerConsAddr ¶
func (k Keeper) GetPreviousProposerConsAddr(ctx sdk.Context) (consAddr sdk.ConsAddress)
GetPreviousProposerConsAddr returns the proposer public key for this block
func (Keeper) GetValidatorAccumulatedCommission ¶
func (k Keeper) GetValidatorAccumulatedCommission(ctx sdk.Context, val sdk.ValAddress) ( commission types.ValidatorAccumulatedCommission)
GetValidatorAccumulatedCommission returns accumulated commission for a validator
func (Keeper) GetWithdrawAddrEnabled ¶
GetWithdrawAddrEnabled returns the current WithdrawAddrEnabled nolint: errcheck
func (Keeper) IterateDelegatorWithdrawAddrs ¶
func (k Keeper) IterateDelegatorWithdrawAddrs(ctx sdk.Context, handler func(del sdk.AccAddress, addr sdk.AccAddress) (stop bool))
IterateDelegatorWithdrawAddrs iterates over delegator withdraw addrs
func (Keeper) IterateValidatorAccumulatedCommissions ¶
func (k Keeper) IterateValidatorAccumulatedCommissions(ctx sdk.Context, handler func(val sdk.ValAddress, commission types.ValidatorAccumulatedCommission) (stop bool))
IterateValidatorAccumulatedCommissions iterates over accumulated commissions
func (Keeper) SetCommunityTax ¶
SetCommunityTax sets the value of community tax nolint: errcheck
func (Keeper) SetDelegatorWithdrawAddr ¶
func (k Keeper) SetDelegatorWithdrawAddr(ctx sdk.Context, delAddr, withdrawAddr sdk.AccAddress)
SetDelegatorWithdrawAddr sets the delegator withdraw address
func (Keeper) SetFeePool ¶
SetFeePool sets the global fee pool distribution info
func (Keeper) SetParams ¶ added in v0.16.0
SetParams sets the distribution parameters to the param space.
func (Keeper) SetPreviousProposerConsAddr ¶
func (k Keeper) SetPreviousProposerConsAddr(ctx sdk.Context, consAddr sdk.ConsAddress)
SetPreviousProposerConsAddr sets the proposer public key for this block
func (Keeper) SetValidatorAccumulatedCommission ¶
func (k Keeper) SetValidatorAccumulatedCommission(ctx sdk.Context, val sdk.ValAddress, commission types.ValidatorAccumulatedCommission)
SetValidatorAccumulatedCommission sets accumulated commission for a validator
func (Keeper) SetWithdrawAddr ¶
func (k Keeper) SetWithdrawAddr(ctx sdk.Context, delegatorAddr sdk.AccAddress, withdrawAddr sdk.AccAddress) error
SetWithdrawAddr sets a new address that will receive the rewards upon withdrawal
func (Keeper) SetWithdrawAddrEnabled ¶
SetWithdrawAddrEnabled sets the value of enabled nolint: errcheck
func (Keeper) WithdrawValidatorCommission ¶
func (k Keeper) WithdrawValidatorCommission(ctx sdk.Context, valAddr sdk.ValAddress) (sdk.Coins, error)
WithdrawValidatorCommission withdraws validator commission