keeper

package
v1.5.1 Latest Latest
Warning

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

Go to latest
Published: Jan 14, 2022 License: Apache-2.0 Imports: 12 Imported by: 23

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 farm module.

func NewMsgServerImpl

func NewMsgServerImpl(keeper Keeper) types.MsgServer

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

func ParamKeyTable

func ParamKeyTable() paramstypes.KeyTable

ParamKeyTable for farm module

func RegisterInvariants

func RegisterInvariants(ir sdk.InvariantRegistry, k Keeper)

RegisterInvariants registers all invariants

func RewardInvariant

func RewardInvariant(k Keeper) sdk.Invariant

RewardInvariant checks whether the amount of module account is consistent with the recorded in the farm

Types

type Keeper

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

Keeper of the farm store

func NewKeeper

func NewKeeper(
	cdc codec.Codec,
	storeKey sdk.StoreKey,
	bk types.BankKeeper,
	ak types.AccountKeeper,
	validateLPToken types.ValidateLPToken,
	paramSpace paramstypes.Subspace,
	feeCollectorName string,
) Keeper

func (Keeper) AdjustPool

func (k Keeper) AdjustPool(
	ctx sdk.Context,
	poolName string,
	reward sdk.Coins,
	rewardPerBlock sdk.Coins,
	creator sdk.AccAddress,
) (err error)

AdjustPool adjusts farm pool parameters

func (Keeper) CreatePool

func (k Keeper) CreatePool(
	ctx sdk.Context,
	name string,
	description string,
	lpTokenDenom string,
	startHeight int64,
	rewardPerBlock sdk.Coins,
	totalReward sdk.Coins,
	editable bool,
	creator sdk.AccAddress,
) error

CreatePool creates an new farm pool

func (Keeper) CreatePoolFee

func (k Keeper) CreatePoolFee(ctx sdk.Context) (fee sdk.Coin)

CreatePoolFee returns the create pool fee

func (Keeper) DeleteFarmInfo

func (k Keeper) DeleteFarmInfo(ctx sdk.Context, poolName, address string)

func (Keeper) DequeueActivePool

func (k Keeper) DequeueActivePool(ctx sdk.Context, poolName string, expiredHeight int64)

func (Keeper) DestroyPool

func (k Keeper) DestroyPool(ctx sdk.Context, poolName string, creator sdk.AccAddress) (sdk.Coins, error)

Destroy destroy an exist farm pool

func (Keeper) EnqueueActivePool

func (k Keeper) EnqueueActivePool(ctx sdk.Context, poolName string, expiredHeight int64)

func (Keeper) Expired

func (k Keeper) Expired(ctx sdk.Context, pool types.FarmPool) bool

func (Keeper) FarmPool

func (Keeper) FarmPools

func (Keeper) Farmer

func (Keeper) GetFarmInfo

func (k Keeper) GetFarmInfo(ctx sdk.Context, poolName, address string) (info types.FarmInfo, exist bool)

GetFarmer return the specified farmer

func (Keeper) GetParams

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

GetParams gets all parameteras as types.Params

func (Keeper) GetPool

func (k Keeper) GetPool(ctx sdk.Context, poolName string) (types.FarmPool, bool)

GetPool return the specified farm pool

func (Keeper) GetRewardRules

func (k Keeper) GetRewardRules(ctx sdk.Context, poolName string) (rules types.RewardRules)

func (Keeper) Harvest

func (k Keeper) Harvest(ctx sdk.Context, poolName string, sender sdk.AccAddress) (sdk.Coins, error)

Harvest creates an new farm pool

func (Keeper) IteratorActivePool

func (k Keeper) IteratorActivePool(ctx sdk.Context, fun func(pool types.FarmPool))

func (Keeper) IteratorAllFarmInfo

func (k Keeper) IteratorAllFarmInfo(ctx sdk.Context, fun func(farmer types.FarmInfo))

func (Keeper) IteratorAllPools

func (k Keeper) IteratorAllPools(ctx sdk.Context, fun func(pool types.FarmPool))

func (Keeper) IteratorExpiredPool

func (k Keeper) IteratorExpiredPool(ctx sdk.Context, height int64, fun func(pool types.FarmPool))

func (Keeper) IteratorFarmInfo

func (k Keeper) IteratorFarmInfo(ctx sdk.Context, address string, fun func(farmer types.FarmInfo))

func (Keeper) IteratorRewardRules

func (k Keeper) IteratorRewardRules(ctx sdk.Context, poolName string, fun func(r types.RewardRule))

func (Keeper) Logger

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

func (Keeper) MaxRewardCategories

func (k Keeper) MaxRewardCategories(ctx sdk.Context) (maxRewardCategories uint32)

MaxRewardCategories returns the maxRewardCategories

func (Keeper) Params

func (Keeper) Refund

func (k Keeper) Refund(ctx sdk.Context, pool types.FarmPool) (sdk.Coins, error)

Refund refund the remaining reward to pool creator

func (Keeper) SetFarmInfo

func (k Keeper) SetFarmInfo(ctx sdk.Context, farmer types.FarmInfo)

SetFarmer save the farmer information

func (Keeper) SetParams

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

SetParams sets the params to the store

func (Keeper) SetPool

func (k Keeper) SetPool(ctx sdk.Context, pool types.FarmPool)

CreatePool creates an new farm pool

func (Keeper) SetRewardRule

func (k Keeper) SetRewardRule(ctx sdk.Context, poolName string, rule types.RewardRule)

func (Keeper) SetRewardRules

func (k Keeper) SetRewardRules(ctx sdk.Context, poolName string, rules types.RewardRules)

func (Keeper) Stake

func (k Keeper) Stake(
	ctx sdk.Context,
	poolName string,
	lpToken sdk.Coin,
	sender sdk.AccAddress,
) (reward sdk.Coins, err error)

Stake is responsible for the user to mortgage the lp token to the system and get back the reward accumulated before then

func (Keeper) Unstake

func (k Keeper) Unstake(ctx sdk.Context, poolName string, lpToken sdk.Coin, sender sdk.AccAddress) (_ sdk.Coins, err error)

Unstake withdraw lp token from farm pool

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL