Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

keeper

package

Go to main page

Versions in this module

v2

v2.3.0

Oct 19, 2022

v2.2.0

Oct 15, 2022

v2.1.1

Jul 27, 2022

v2.1.0

Jul 18, 2022

v2.0.0

Jul 13, 2022

Changes in this version

+ var EnableAdvanceEpoch = false

+ var EnableRatioPlan = false

+ func AllInvariants(k Keeper) sdk.Invariant

+ func HandlePublicPlanProposal(ctx sdk.Context, k Keeper, proposal *types.PublicPlanProposal) error

+ func NewMsgServerImpl(keeper Keeper) types.MsgServer

+ func NonNegativeHistoricalRewardsInvariant(k Keeper) sdk.Invariant

+ func NonNegativeOutstandingRewardsInvariant(k Keeper) sdk.Invariant

+ func OutstandingRewardsAmountInvariant(k Keeper) sdk.Invariant

+ func PositiveQueuedStakingAmountInvariant(k Keeper) sdk.Invariant

+ func PositiveStakingAmountInvariant(k Keeper) sdk.Invariant

+ func PositiveTotalStakingsAmountInvariant(k Keeper) sdk.Invariant

+ func RegisterInvariants(ir sdk.InvariantRegistry, k Keeper)

+ func RemainingRewardsAmountInvariant(k Keeper) sdk.Invariant

+ func StakingReservedAmountInvariant(k Keeper) sdk.Invariant

+ func UnharvestedRewardsAmountInvariant(k Keeper) sdk.Invariant

+ type AllocationInfo struct

+ Amount sdk.Coins

+ Plan types.PlanI

+ type Keeper struct

+ func NewKeeper(cdc codec.BinaryCodec, key sdk.StoreKey, paramSpace paramtypes.Subspace, ...) Keeper

+ func (k Keeper) AddPublicPlanProposal(ctx sdk.Context, proposals []types.AddPlanRequest) error

+ func (k Keeper) AdvanceEpoch(ctx sdk.Context) error

+ func (k Keeper) AllRewards(ctx sdk.Context, farmerAcc sdk.AccAddress) sdk.Coins

+ func (k Keeper) AllUnharvestedRewards(ctx sdk.Context, farmerAcc sdk.AccAddress) sdk.Coins

+ func (k Keeper) AllocateRewards(ctx sdk.Context) error

+ func (k Keeper) AllocationInfos(ctx sdk.Context) []AllocationInfo

+ func (k Keeper) CalculateRewards(ctx sdk.Context, farmerAcc sdk.AccAddress, stakingCoinDenom string, ...) (rewards sdk.DecCoins)

+ func (k Keeper) CreateFixedAmountPlan(ctx sdk.Context, msg *types.MsgCreateFixedAmountPlan, ...) (types.PlanI, error)

+ func (k Keeper) CreateRatioPlan(ctx sdk.Context, msg *types.MsgCreateRatioPlan, ...) (types.PlanI, error)

+ func (k Keeper) DecreaseOutstandingRewards(ctx sdk.Context, stakingCoinDenom string, amount sdk.DecCoins)

+ func (k Keeper) DecreaseTotalStakings(ctx sdk.Context, stakingCoinDenom string, amount sdk.Int)

+ func (k Keeper) DeleteAllHistoricalRewards(ctx sdk.Context, stakingCoinDenom string)

+ func (k Keeper) DeleteCurrentEpoch(ctx sdk.Context, stakingCoinDenom string)

+ func (k Keeper) DeleteHistoricalRewards(ctx sdk.Context, stakingCoinDenom string, epoch uint64)

+ func (k Keeper) DeleteOutstandingRewards(ctx sdk.Context, stakingCoinDenom string)

+ func (k Keeper) DeletePlan(ctx sdk.Context, plan types.PlanI)

+ func (k Keeper) DeletePublicPlanProposal(ctx sdk.Context, proposals []types.DeletePlanRequest) error

+ func (k Keeper) DeleteQueuedStaking(ctx sdk.Context, endTime time.Time, stakingCoinDenom string, ...)

+ func (k Keeper) DeleteStaking(ctx sdk.Context, stakingCoinDenom string, farmerAcc sdk.AccAddress)

+ func (k Keeper) DeleteTotalStakings(ctx sdk.Context, stakingCoinDenom string)

+ func (k Keeper) DeleteUnharvestedRewards(ctx sdk.Context, farmerAcc sdk.AccAddress, stakingCoinDenom string)

+ func (k Keeper) DerivePrivatePlanFarmingPoolAcc(ctx sdk.Context, name string) (sdk.AccAddress, error)

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

+ func (k Keeper) GetAllQueuedCoinsByFarmer(ctx sdk.Context, farmerAcc sdk.AccAddress) sdk.Coins

+ func (k Keeper) GetAllQueuedStakingAmountByFarmerAndDenom(ctx sdk.Context, farmerAcc sdk.AccAddress, stakingCoinDenom string) sdk.Int

+ func (k Keeper) GetAllStakedCoinsByFarmer(ctx sdk.Context, farmerAcc sdk.AccAddress) sdk.Coins

+ func (k Keeper) GetCodec() codec.BinaryCodec

+ func (k Keeper) GetCurrentEpoch(ctx sdk.Context, stakingCoinDenom string) uint64

+ func (k Keeper) GetCurrentEpochDays(ctx sdk.Context) uint32

+ func (k Keeper) GetGlobalPlanId(ctx sdk.Context) uint64

+ func (k Keeper) GetHistoricalRewards(ctx sdk.Context, stakingCoinDenom string, epoch uint64) (rewards types.HistoricalRewards, found bool)

+ func (k Keeper) GetLastEpochTime(ctx sdk.Context) (t time.Time, found bool)

+ func (k Keeper) GetNextPlanIdWithUpdate(ctx sdk.Context) uint64

+ func (k Keeper) GetNumActivePrivatePlans(ctx sdk.Context) int

+ func (k Keeper) GetOutstandingRewards(ctx sdk.Context, stakingCoinDenom string) (rewards types.OutstandingRewards, found bool)

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

+ func (k Keeper) GetPlan(ctx sdk.Context, id uint64) (plan types.PlanI, found bool)

+ func (k Keeper) GetPlans(ctx sdk.Context) (plans []types.PlanI)

+ func (k Keeper) GetQueuedStaking(ctx sdk.Context, endTime time.Time, stakingCoinDenom string, ...) (queuedStaking types.QueuedStaking, found bool)

+ func (k Keeper) GetStaking(ctx sdk.Context, stakingCoinDenom string, farmerAcc sdk.AccAddress) (staking types.Staking, found bool)

+ func (k Keeper) GetTotalStakings(ctx sdk.Context, stakingCoinDenom string) (totalStakings types.TotalStakings, found bool)

+ func (k Keeper) GetUnharvestedRewards(ctx sdk.Context, farmerAcc sdk.AccAddress, stakingCoinDenom string) (rewards types.UnharvestedRewards, found bool)

+ func (k Keeper) Harvest(ctx sdk.Context, farmerAcc sdk.AccAddress, stakingCoinDenoms []string) error

+ func (k Keeper) IncreaseOutstandingRewards(ctx sdk.Context, stakingCoinDenom string, amount sdk.DecCoins)

+ func (k Keeper) IncreaseTotalStakings(ctx sdk.Context, stakingCoinDenom string, amount sdk.Int)

+ func (k Keeper) IncreaseUnharvestedRewards(ctx sdk.Context, farmerAcc sdk.AccAddress, stakingCoinDenom string, ...)

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

+ func (k Keeper) IterateAllUnharvestedRewards(ctx sdk.Context, ...)

+ func (k Keeper) IterateCurrentEpochs(ctx sdk.Context, ...)

+ func (k Keeper) IterateHistoricalRewards(ctx sdk.Context, ...)

+ func (k Keeper) IterateMatureQueuedStakings(ctx sdk.Context, currTime time.Time, ...)

+ func (k Keeper) IterateOutstandingRewards(ctx sdk.Context, ...)

+ func (k Keeper) IteratePlans(ctx sdk.Context, cb func(plan types.PlanI) (stop bool))

+ func (k Keeper) IterateQueuedStakings(ctx sdk.Context, ...)

+ func (k Keeper) IterateQueuedStakingsByFarmer(ctx sdk.Context, farmerAcc sdk.AccAddress, ...)

+ func (k Keeper) IterateQueuedStakingsByFarmerAndDenom(ctx sdk.Context, farmerAcc sdk.AccAddress, stakingCoinDenom string, ...)

+ func (k Keeper) IterateQueuedStakingsByFarmerAndDenomReverse(ctx sdk.Context, farmerAcc sdk.AccAddress, stakingCoinDenom string, ...)

+ func (k Keeper) IterateStakings(ctx sdk.Context, ...)

+ func (k Keeper) IterateStakingsByFarmer(ctx sdk.Context, farmerAcc sdk.AccAddress, ...)

+ func (k Keeper) IterateTotalStakings(ctx sdk.Context, ...)

+ func (k Keeper) IterateUnharvestedRewardsByFarmer(ctx sdk.Context, farmerAcc sdk.AccAddress, ...)

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

+ func (k Keeper) MarshalPlan(plan types.PlanI) ([]byte, error)

+ func (k Keeper) ModifyPublicPlanProposal(ctx sdk.Context, proposals []types.ModifyPlanRequest) error

+ func (k Keeper) ProcessQueuedCoins(ctx sdk.Context, currTime time.Time)

+ func (k Keeper) ReleaseStakingCoins(ctx sdk.Context, farmerAcc sdk.AccAddress, stakingCoins sdk.Coins) error

+ func (k Keeper) RemovePlan(ctx sdk.Context, creator sdk.AccAddress, planId uint64) error

+ func (k Keeper) ReserveStakingCoins(ctx sdk.Context, farmerAcc sdk.AccAddress, stakingCoins sdk.Coins) error

+ func (k Keeper) Rewards(ctx sdk.Context, farmerAcc sdk.AccAddress, stakingCoinDenom string) sdk.Coins

+ func (k Keeper) SetCurrentEpoch(ctx sdk.Context, stakingCoinDenom string, currentEpoch uint64)

+ func (k Keeper) SetCurrentEpochDays(ctx sdk.Context, epochDays uint32)

+ func (k Keeper) SetGlobalPlanId(ctx sdk.Context, id uint64)

+ func (k Keeper) SetHistoricalRewards(ctx sdk.Context, stakingCoinDenom string, epoch uint64, ...)

+ func (k Keeper) SetLastEpochTime(ctx sdk.Context, t time.Time)

+ func (k Keeper) SetOutstandingRewards(ctx sdk.Context, stakingCoinDenom string, rewards types.OutstandingRewards)

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

+ func (k Keeper) SetPlan(ctx sdk.Context, plan types.PlanI)

+ func (k Keeper) SetQueuedStaking(ctx sdk.Context, endTime time.Time, stakingCoinDenom string, ...)

+ func (k Keeper) SetStaking(ctx sdk.Context, stakingCoinDenom string, farmerAcc sdk.AccAddress, ...)

+ func (k Keeper) SetTotalStakings(ctx sdk.Context, stakingCoinDenom string, totalStakings types.TotalStakings)

+ func (k Keeper) SetUnharvestedRewards(ctx sdk.Context, farmerAcc sdk.AccAddress, stakingCoinDenom string, ...)

+ func (k Keeper) Stake(ctx sdk.Context, farmerAcc sdk.AccAddress, amount sdk.Coins) error

+ func (k Keeper) TerminateEndedPlans(ctx sdk.Context) error

+ func (k Keeper) TerminatePlan(ctx sdk.Context, plan types.PlanI) error

+ func (k Keeper) UnmarshalPlan(bz []byte) (plan types.PlanI, err error)

+ func (k Keeper) Unstake(ctx sdk.Context, farmerAcc sdk.AccAddress, amount sdk.Coins) error

+ func (k Keeper) ValidateOutstandingRewardsAmount(ctx sdk.Context) error

+ func (k Keeper) ValidateRemainingRewardsAmount(ctx sdk.Context) error

+ func (k Keeper) ValidateStakingReservedAmount(ctx sdk.Context) error

+ func (k Keeper) ValidateUnharvestedRewardsAmount(ctx sdk.Context) error

+ func (k Keeper) WithdrawAllRewards(ctx sdk.Context, farmerAcc sdk.AccAddress) (sdk.Coins, error)

+ func (k Keeper) WithdrawRewards(ctx sdk.Context, farmerAcc sdk.AccAddress, stakingCoinDenom string, ...) (sdk.Coins, error)

+ type Migrator struct

+ func NewMigrator(keeper Keeper) Migrator

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

+ type Querier struct

+ func (k Querier) CurrentEpochDays(c context.Context, req *types.QueryCurrentEpochDaysRequest) (*types.QueryCurrentEpochDaysResponse, error)

+ func (k Querier) HistoricalRewards(c context.Context, req *types.QueryHistoricalRewardsRequest) (*types.QueryHistoricalRewardsResponse, error)

+ func (k Querier) Params(c context.Context, _ *types.QueryParamsRequest) (*types.QueryParamsResponse, error)

+ func (k Querier) Plan(c context.Context, req *types.QueryPlanRequest) (*types.QueryPlanResponse, error)

+ func (k Querier) Plans(c context.Context, req *types.QueryPlansRequest) (*types.QueryPlansResponse, error)

+ func (k Querier) Position(c context.Context, req *types.QueryPositionRequest) (*types.QueryPositionResponse, error)

+ func (k Querier) QueuedStakings(c context.Context, req *types.QueryQueuedStakingsRequest) (*types.QueryQueuedStakingsResponse, error)

+ func (k Querier) Rewards(c context.Context, req *types.QueryRewardsRequest) (*types.QueryRewardsResponse, error)

+ func (k Querier) Stakings(c context.Context, req *types.QueryStakingsRequest) (*types.QueryStakingsResponse, error)

+ func (k Querier) TotalStakings(c context.Context, req *types.QueryTotalStakingsRequest) (*types.QueryTotalStakingsResponse, error)

+ func (k Querier) UnharvestedRewards(c context.Context, req *types.QueryUnharvestedRewardsRequest) (*types.QueryUnharvestedRewardsResponse, error)

v2.0.0-rc3

Jul 6, 2022

v2.0.0-rc2

Jul 4, 2022

v2.0.0-rc1

Jun 30, 2022

Other modules containing this package

github.com/crescent-network/crescent

github.com/crescent-network/crescent/v3

github.com/crescent-network/crescent/v4

github.com/crescent-network/crescent/v5