supply

Documentation

Index

• type WrappedSupplyKeeper
  • func WrapSupplyKeeperBurnToCommunityPool(supplyKeeper supply.Keeper) WrappedSupplyKeeper
  • func (k WrappedSupplyKeeper) BurnCoins(ctx sdk.Context, moduleName string, amt sdk.Coins) sdk.Error
  • func (k *WrappedSupplyKeeper) SetDistrKeeper(distrKeeper *distr.Keeper)

Types

type WrappedSupplyKeeper

type WrappedSupplyKeeper struct {
	supply.Keeper
	// contains filtered or unexported fields
}

WrappedSupplyKeeper encapsulates the underlying supply keeper and overrides its BurnCoins function to send the coins to the community pool instead of just destroying them.

Note that distrKeeper keeps the reference to the distr module keeper. Due to the circular dependency between supply-distr-staking, distrKeeper cannot be initialized when the struct is created. Rather, SetDistrKeeper is expected to be called to set `distrKeeper`.

func WrapSupplyKeeperBurnToCommunityPool

func WrapSupplyKeeperBurnToCommunityPool(supplyKeeper supply.Keeper) WrappedSupplyKeeper

WrapSupplyKeeperBurnToCommunityPool creates a new instance of WrappedSupplyKeeper with its distrKeeper member set to nil.

func (WrappedSupplyKeeper) BurnCoins

func (k WrappedSupplyKeeper) BurnCoins(
	ctx sdk.Context, moduleName string, amt sdk.Coins,
) sdk.Error

BurnCoins moves the specified amount of coins from the given module name to the community pool. The total supply of the coins will not change.

func (*WrappedSupplyKeeper) SetDistrKeeper

func (k *WrappedSupplyKeeper) SetDistrKeeper(distrKeeper *distr.Keeper)

SetDistrKeeper sets distr module keeper for this WrappedSupplyKeeper instance.