keeper

Documentation

Index

• func NewMsgServerImpl(keeper Keeper) incentive.MsgServer
• type Keeper
  • func NewKeeper(cdc codec.Codec, storeKey storetypes.StoreKey, bk incentive.BankKeeper, ...) Keeper
  • func (k Keeper) ClaimReward(_ sdk.Context, _ sdk.AccAddress, _ incentive.BondTier, _ sdk.Coin) (sdk.Coins, error)
  • func (k Keeper) GetRewardAccumulator(ctx sdk.Context, bondDenom, rewardDenom string, tier incentive.BondTier) sdk.DecCoin
  • func (k Keeper) GetRewardTracker(ctx sdk.Context, addr sdk.AccAddress, bondDenom, rewardDenom string, ...) sdk.DecCoin
  • func (k Keeper) IterateAccountBonds(ctx sdk.Context, addr sdk.AccAddress, ...) error
  • func (k Keeper) KVStore(ctx sdk.Context) sdk.KVStore
  • func (k Keeper) Logger(ctx sdk.Context) log.Logger
  • func (k Keeper) ModuleBalance(ctx sdk.Context, denom string) sdk.Coin
  • func (k Keeper) SetRewardAccumulator(ctx sdk.Context, bondDenom string, reward sdk.DecCoin, tier incentive.BondTier) error
  • func (k Keeper) UpdateRewardTracker(ctx sdk.Context, addr sdk.AccAddress, tier incentive.BondTier, ...) error
  • func (k Keeper) UpdateRewards(ctx sdk.Context) error
• type Querier
  • func NewQuerier(k Keeper) Querier
  • func (q Querier) Bonded(_ context.Context, req *incentive.QueryBonded) (*incentive.QueryBondedResponse, error)
  • func (q Querier) CompletedIncentivePrograms(goCtx context.Context, req *incentive.QueryCompletedIncentivePrograms) (*incentive.QueryCompletedIncentiveProgramsResponse, error)
  • func (q Querier) IncentiveProgram(goCtx context.Context, req *incentive.QueryIncentiveProgram) (*incentive.QueryIncentiveProgramResponse, error)
  • func (q Querier) OngoingIncentivePrograms(goCtx context.Context, req *incentive.QueryOngoingIncentivePrograms) (*incentive.QueryOngoingIncentiveProgramsResponse, error)
  • func (q Querier) Params(goCtx context.Context, req *incentive.QueryParams) (*incentive.QueryParamsResponse, error)
  • func (q Querier) PendingRewards(_ context.Context, req *incentive.QueryPendingRewards) (*incentive.QueryPendingRewardsResponse, error)
  • func (q Querier) TotalBonded(_ context.Context, req *incentive.QueryTotalBonded) (*incentive.QueryTotalBondedResponse, error)
  • func (q Querier) TotalUnbonding(_ context.Context, req *incentive.QueryTotalUnbonding) (*incentive.QueryTotalUnbondingResponse, error)
  • func (q Querier) Unbondings(goCtx context.Context, req *incentive.QueryUnbondings) (*incentive.QueryUnbondingsResponse, error)
  • func (q Querier) UpcomingIncentivePrograms(goCtx context.Context, req *incentive.QueryUpcomingIncentivePrograms) (*incentive.QueryUpcomingIncentiveProgramsResponse, error)

Functions

func NewMsgServerImpl

func NewMsgServerImpl(keeper Keeper) incentive.MsgServer

NewMsgServerImpl returns an implementation of MsgServer for the x/incentive module.

Types

type Keeper

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

func NewKeeper

func NewKeeper(
	cdc codec.Codec,
	storeKey storetypes.StoreKey,
	bk incentive.BankKeeper,
	lk incentive.LeverageKeeper,
) Keeper

func (Keeper) ClaimReward

func (k Keeper) ClaimReward(_ sdk.Context, _ sdk.AccAddress, _ incentive.BondTier, _ sdk.Coin,
) (sdk.Coins, error)

ClaimReward claims a single account's bonded uToken tier's reward, then updates its reward tracker. Returns rewards claimed.

func (Keeper) GetRewardAccumulator

func (k Keeper) GetRewardAccumulator(ctx sdk.Context, bondDenom, rewardDenom string, tier incentive.BondTier,
) sdk.DecCoin

GetRewardAccumulator retrieves the reward accumulator of a reward token for a single bonded uToken and tier - for example, how much UMEE (reward) would have been earned by 1 ATOM bonded to the middle tier since genesis.

func (Keeper) GetRewardTracker

func (k Keeper) GetRewardTracker(ctx sdk.Context,
	addr sdk.AccAddress, bondDenom, rewardDenom string, tier incentive.BondTier,
) sdk.DecCoin

GetRewardTracker retrieves the reward tracker of a reward token for a single bonded uToken and tier on one account - this is the value of the reward accumulator for those specific denoms and tier the last time this account performed and action that requires a reward tracker update (i.e. Bond, Claim, BeginUnbonding, or being Liquidated).

func (Keeper) IterateAccountBonds

func (k Keeper) IterateAccountBonds(ctx sdk.Context, addr sdk.AccAddress,
	_ func(ctx sdk.Context, addr sdk.AccAddress, _ incentive.BondTier, _ sdk.Coin) error,
) error

IterateAccountBonds iterates over all bonded uTokens for an address by each individual uToken denom and tier

func (Keeper) KVStore

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

KVStore returns the module's KVStore

func (Keeper) Logger

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

func (Keeper) ModuleBalance

func (k Keeper) ModuleBalance(ctx sdk.Context, denom string) sdk.Coin

ModuleBalance returns the amount of a given token held in the x/incentive module account

func (Keeper) SetRewardAccumulator

func (k Keeper) SetRewardAccumulator(ctx sdk.Context,
	bondDenom string, reward sdk.DecCoin, tier incentive.BondTier,
) error

SetRewardAccumulator sets the reward accumulator of a reward token for a single bonded uToken and tier.

func (Keeper) UpdateRewardTracker

func (k Keeper) UpdateRewardTracker(ctx sdk.Context, addr sdk.AccAddress, tier incentive.BondTier, bondDenom string,
) error

UpdateRewardTracker updates all reward trackers matching a specific account + tier + bonded uToken denom by setting them to the current values of that tier + uToken denom's reward accumulators

func (Keeper) UpdateRewards

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

UpdateRewards increases the module's LastInterestTime and any rewardAccumulators associated with ongoing incentive programs.

type Querier

type Querier struct {
	Keeper
}

Querier implements a QueryServer for the x/incentive module.

func NewQuerier

func NewQuerier(k Keeper) Querier

func (Querier) Bonded

func (q Querier) Bonded(
	_ context.Context,
	req *incentive.QueryBonded,
) (*incentive.QueryBondedResponse, error)

func (Querier) CompletedIncentivePrograms

func (q Querier) CompletedIncentivePrograms(
	goCtx context.Context,
	req *incentive.QueryCompletedIncentivePrograms,
) (*incentive.QueryCompletedIncentiveProgramsResponse, error)

func (Querier) IncentiveProgram

func (q Querier) IncentiveProgram(
	goCtx context.Context,
	req *incentive.QueryIncentiveProgram,
) (*incentive.QueryIncentiveProgramResponse, error)

func (Querier) OngoingIncentivePrograms

func (q Querier) OngoingIncentivePrograms(
	goCtx context.Context,
	req *incentive.QueryOngoingIncentivePrograms,
) (*incentive.QueryOngoingIncentiveProgramsResponse, error)

func (Querier) Params

func (q Querier) Params(
	goCtx context.Context,
	req *incentive.QueryParams,
) (*incentive.QueryParamsResponse, error)

func (Querier) PendingRewards

func (q Querier) PendingRewards(
	_ context.Context,
	req *incentive.QueryPendingRewards,
) (*incentive.QueryPendingRewardsResponse, error)

func (Querier) TotalBonded

func (q Querier) TotalBonded(
	_ context.Context,
	req *incentive.QueryTotalBonded,
) (*incentive.QueryTotalBondedResponse, error)

func (Querier) TotalUnbonding

func (q Querier) TotalUnbonding(
	_ context.Context,
	req *incentive.QueryTotalUnbonding,
) (*incentive.QueryTotalUnbondingResponse, error)

func (Querier) Unbondings

func (q Querier) Unbondings(
	goCtx context.Context,
	req *incentive.QueryUnbondings,
) (*incentive.QueryUnbondingsResponse, error)

func (Querier) UpcomingIncentivePrograms

func (q Querier) UpcomingIncentivePrograms(
	goCtx context.Context,
	req *incentive.QueryUpcomingIncentivePrograms,
) (*incentive.QueryUpcomingIncentiveProgramsResponse, error)