keeper

Documentation

Index

• type Hooks
  • func (h Hooks) AfterDistributeMintedCoin(ctx sdk.Context)
  • func (h Hooks) AfterExitPool(ctx sdk.Context, sender sdk.AccAddress, poolId uint64, shareInAmount sdk.Int, ...)
  • func (h Hooks) AfterJoinPool(ctx sdk.Context, sender sdk.AccAddress, poolId uint64, enterCoins sdk.Coins, ...)
  • func (h Hooks) AfterPoolCreated(ctx sdk.Context, sender sdk.AccAddress, poolId uint64)
  • func (h Hooks) AfterSwap(ctx sdk.Context, sender sdk.AccAddress, poolId uint64, input sdk.Coins, ...)
• type Keeper
  • func NewKeeper(cdc codec.BinaryCodec, storeKey sdk.StoreKey, paramSpace paramtypes.Subspace, ...) Keeper
  • func (k Keeper) AllocateAsset(ctx sdk.Context) error
  • func (k Keeper) CreatePoolGauges(ctx sdk.Context, poolId uint64) error
  • func (k Keeper) ExportGenesis(ctx sdk.Context) *types.GenesisState
  • func (k Keeper) FundCommunityPoolFromModule(ctx sdk.Context, asset sdk.Coin) error
  • func (k Keeper) GetAllGauges(ctx sdk.Context) []incentivestypes.Gauge
  • func (k Keeper) GetDistrInfo(ctx sdk.Context) types.DistrInfo
  • func (k Keeper) GetLockableDurations(ctx sdk.Context) []time.Duration
  • func (k Keeper) GetParams(ctx sdk.Context) (params types.Params)
  • func (k Keeper) GetPoolGaugeId(ctx sdk.Context, poolId uint64, lockableDuration time.Duration) (uint64, error)
  • func (k Keeper) GetPoolIdFromGaugeId(ctx sdk.Context, gaugeId uint64, lockableDuration time.Duration) (uint64, error)
  • func (k Keeper) HandleReplacePoolIncentivesProposal(ctx sdk.Context, p *types.ReplacePoolIncentivesProposal) error
  • func (k Keeper) HandleUpdatePoolIncentivesProposal(ctx sdk.Context, p *types.UpdatePoolIncentivesProposal) error
  • func (k Keeper) Hooks() Hooks
  • func (k Keeper) InitGenesis(ctx sdk.Context, genState *types.GenesisState)
  • func (k Keeper) Logger(ctx sdk.Context) log.Logger
  • func (k Keeper) ReplaceDistrRecords(ctx sdk.Context, records ...types.DistrRecord) error
  • func (k Keeper) SetDistrInfo(ctx sdk.Context, distrInfo types.DistrInfo)
  • func (k Keeper) SetLockableDurations(ctx sdk.Context, lockableDurations []time.Duration)
  • func (k Keeper) SetParams(ctx sdk.Context, params types.Params)
  • func (k Keeper) SetPoolGaugeId(ctx sdk.Context, poolId uint64, lockableDuration time.Duration, gaugeId uint64)
  • func (k Keeper) UpdateDistrRecords(ctx sdk.Context, records ...types.DistrRecord) error
• type Querier
  • func NewQuerier(k Keeper) Querier
  • func (q Querier) DistrInfo(ctx context.Context, _ *types.QueryDistrInfoRequest) (*types.QueryDistrInfoResponse, error)
  • func (q Querier) ExternalIncentiveGauges(ctx context.Context, req *types.QueryExternalIncentiveGaugesRequest) (*types.QueryExternalIncentiveGaugesResponse, error)
  • func (q Querier) GaugeIds(ctx context.Context, req *types.QueryGaugeIdsRequest) (*types.QueryGaugeIdsResponse, error)
  • func (q Querier) IncentivizedPools(ctx context.Context, _ *types.QueryIncentivizedPoolsRequest) (*types.QueryIncentivizedPoolsResponse, error)
  • func (q Querier) LockableDurations(ctx context.Context, _ *types.QueryLockableDurationsRequest) (*types.QueryLockableDurationsResponse, error)
  • func (q Querier) Params(ctx context.Context, _ *types.QueryParamsRequest) (*types.QueryParamsResponse, error)

Types

type Hooks

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

func (Hooks) AfterDistributeMintedCoin

func (h Hooks) AfterDistributeMintedCoin(ctx sdk.Context)

Distribute coins after minter module allocate assets to pool-incentives module.

func (Hooks) AfterExitPool

func (h Hooks) AfterExitPool(ctx sdk.Context, sender sdk.AccAddress, poolId uint64, shareInAmount sdk.Int, exitCoins sdk.Coins)

AfterExitPool hook is a noop.

func (Hooks) AfterJoinPool

func (h Hooks) AfterJoinPool(ctx sdk.Context, sender sdk.AccAddress, poolId uint64, enterCoins sdk.Coins, shareOutAmount sdk.Int)

AfterJoinPool hook is a noop.

func (Hooks) AfterPoolCreated

func (h Hooks) AfterPoolCreated(ctx sdk.Context, sender sdk.AccAddress, poolId uint64)

AfterPoolCreated creates a gauge for each pool’s lockable duration.

func (Hooks) AfterSwap

func (h Hooks) AfterSwap(ctx sdk.Context, sender sdk.AccAddress, poolId uint64, input sdk.Coins, output sdk.Coins)

AfterSwap hook is a noop.

type Keeper

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

func NewKeeper

func NewKeeper(cdc codec.BinaryCodec, storeKey sdk.StoreKey, paramSpace paramtypes.Subspace, accountKeeper types.AccountKeeper, bankKeeper types.BankKeeper, incentivesKeeper types.IncentivesKeeper, distrKeeper types.DistrKeeper, gammKeeper types.GAMMKeeper) Keeper

func (Keeper) AllocateAsset

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

AllocateAsset allocates and distributes coin according a gauge’s proportional weight that is recorded in the record.

func (Keeper) CreatePoolGauges

func (k Keeper) CreatePoolGauges(ctx sdk.Context, poolId uint64) error

func (Keeper) ExportGenesis

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

func (Keeper) FundCommunityPoolFromModule

func (k Keeper) FundCommunityPoolFromModule(ctx sdk.Context, asset sdk.Coin) error

FundCommunityPoolFromModule allows the pool-incentives module to directly fund the community fund pool.

func (Keeper) GetAllGauges

func (k Keeper) GetAllGauges(ctx sdk.Context) []incentivestypes.Gauge

func (Keeper) GetDistrInfo

func (k Keeper) GetDistrInfo(ctx sdk.Context) types.DistrInfo

func (Keeper) GetLockableDurations

func (k Keeper) GetLockableDurations(ctx sdk.Context) []time.Duration

func (Keeper) GetParams

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

func (Keeper) GetPoolGaugeId

func (k Keeper) GetPoolGaugeId(ctx sdk.Context, poolId uint64, lockableDuration time.Duration) (uint64, error)

func (Keeper) GetPoolIdFromGaugeId

func (k Keeper) GetPoolIdFromGaugeId(ctx sdk.Context, gaugeId uint64, lockableDuration time.Duration) (uint64, error)

func (Keeper) HandleReplacePoolIncentivesProposal

func (k Keeper) HandleReplacePoolIncentivesProposal(ctx sdk.Context, p *types.ReplacePoolIncentivesProposal) error

func (Keeper) HandleUpdatePoolIncentivesProposal

func (k Keeper) HandleUpdatePoolIncentivesProposal(ctx sdk.Context, p *types.UpdatePoolIncentivesProposal) error

func (Keeper) Hooks

func (k Keeper) Hooks() Hooks

Create new pool incentives hooks.

func (Keeper) InitGenesis

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

func (Keeper) Logger

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

Logger returns a module-specific logger.

func (Keeper) ReplaceDistrRecords

func (k Keeper) ReplaceDistrRecords(ctx sdk.Context, records ...types.DistrRecord) error

This is checked for no err when a proposal is made, and executed when a proposal passes.

func (Keeper) SetDistrInfo

func (k Keeper) SetDistrInfo(ctx sdk.Context, distrInfo types.DistrInfo)

func (Keeper) SetLockableDurations

func (k Keeper) SetLockableDurations(ctx sdk.Context, lockableDurations []time.Duration)

func (Keeper) SetParams

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

func (Keeper) SetPoolGaugeId

func (k Keeper) SetPoolGaugeId(ctx sdk.Context, poolId uint64, lockableDuration time.Duration, gaugeId uint64)

func (Keeper) UpdateDistrRecords

func (k Keeper) UpdateDistrRecords(ctx sdk.Context, records ...types.DistrRecord) error

UpdateDistrRecords is checked for no err when a proposal is made, and executed when a proposal passes.

type Querier

type Querier struct {
	Keeper
}

Querier defines a wrapper around the x/pool-incentives keeper providing gRPC method handlers.

func NewQuerier

func NewQuerier(k Keeper) Querier

func (Querier) DistrInfo

func (q Querier) DistrInfo(ctx context.Context, _ *types.QueryDistrInfoRequest) (*types.QueryDistrInfoResponse, error)

DistrInfo returns gauges receiving pool rewards and their respective weights.

func (Querier) ExternalIncentiveGauges

func (q Querier) ExternalIncentiveGauges(ctx context.Context, req *types.QueryExternalIncentiveGaugesRequest) (*types.QueryExternalIncentiveGaugesResponse, error)

ExternalIncentiveGauges iterates over all gauges, returns gauges externally incentivized, excluding default gauges created with pool.

func (Querier) GaugeIds

func (q Querier) GaugeIds(ctx context.Context, req *types.QueryGaugeIdsRequest) (*types.QueryGaugeIdsResponse, error)

GaugeIds takes provided gauge request and returns the respective gaugeIDs.

func (Querier) IncentivizedPools

func (q Querier) IncentivizedPools(ctx context.Context, _ *types.QueryIncentivizedPoolsRequest) (*types.QueryIncentivizedPoolsResponse, error)

IncentivizedPools iterates over all gauges, returns default gauges created with pool.

func (Querier) LockableDurations

func (q Querier) LockableDurations(ctx context.Context, _ *types.QueryLockableDurationsRequest) (*types.QueryLockableDurationsResponse, error)

LockableDurations returns the lock durations that are incentivized through pool-incentives.

func (Querier) Params

func (q Querier) Params(ctx context.Context, _ *types.QueryParamsRequest) (*types.QueryParamsResponse, error)

Params return pool-incentives module params.