Documentation ¶
Index ¶
- Variables
- func AllInvariants(k Keeper) sdk.Invariant
- func NewQuerier(k Keeper) sdk.Querier
- func RegisterInvariants(ir sdk.InvariantRegistry, k Keeper)
- func TotalSupply(k Keeper) sdk.Invariant
- func VestingStoreKey(addr sdk.AccAddress) []byte
- type Keeper
- func (k Keeper) BurnCoins(ctx sdk.Context, moduleName string, amt sdk.Coins) error
- func (k Keeper) DelegateCoinsFromAccountToModule(ctx sdk.Context, senderAddr sdk.AccAddress, recipientModule string, ...) error
- func (k Keeper) GetAllVestings(ctx sdk.Context) (vestings []types.Vesting)
- func (k Keeper) GetModuleAccount(ctx sdk.Context, moduleName string) exported.ModuleAccountI
- func (k Keeper) GetModuleAccountAndPermissions(ctx sdk.Context, moduleName string) (exported.ModuleAccountI, []string)
- func (k Keeper) GetModuleAddress(moduleName string) sdk.AccAddress
- func (k Keeper) GetModuleAddressAndPermissions(moduleName string) (addr sdk.AccAddress, permissions []string)
- func (k Keeper) GetSupply(ctx sdk.Context) (supply exported.SupplyI)
- func (k Keeper) GetVesting(ctx sdk.Context, addr sdk.AccAddress) (exist bool, vesting types.Vesting)
- func (k Keeper) IterateVestings(ctx sdk.Context, process func(types.Vesting) (stop bool))
- func (k Keeper) Logger(ctx sdk.Context) log.Logger
- func (k Keeper) MintCoins(ctx sdk.Context, moduleName string, amt sdk.Coins) error
- func (k Keeper) RemoveVesting(ctx sdk.Context, address sdk.AccAddress)
- func (k Keeper) SendCoinsFromAccountToModule(ctx sdk.Context, senderAddr sdk.AccAddress, recipientModule string, ...) error
- func (k Keeper) SendCoinsFromModuleToAccount(ctx sdk.Context, senderModule string, recipientAddr sdk.AccAddress, ...) error
- func (k Keeper) SendCoinsFromModuleToModule(ctx sdk.Context, senderModule, recipientModule string, amt sdk.Coins) error
- func (k Keeper) SetModuleAccount(ctx sdk.Context, macc exported.ModuleAccountI)
- func (k Keeper) SetSupply(ctx sdk.Context, supply exported.SupplyI)
- func (k Keeper) SetVesting(ctx sdk.Context, vesting types.Vesting)
- func (k Keeper) UndelegateCoinsFromModuleToAccount(ctx sdk.Context, senderModule string, recipientAddr sdk.AccAddress, ...) error
- func (k Keeper) ValidatePermissions(macc exported.ModuleAccountI) error
Constants ¶
This section is empty.
Variables ¶
var ( SupplyKey = []byte{0x00} VestingStoreKeyPrefix = []byte{0x01} )
Keys for supply store Items are stored with the following key: values - 0x00: Supply
var DefaultCodespace = types.ModuleName
DefaultCodespace from the supply module
Functions ¶
func AllInvariants ¶
AllInvariants runs all invariants of the supply module.
func NewQuerier ¶
NewQuerier creates a querier for supply REST endpoints
func RegisterInvariants ¶
func RegisterInvariants(ir sdk.InvariantRegistry, k Keeper)
RegisterInvariants register all supply invariants
func TotalSupply ¶
TotalSupply checks that the total supply reflects all the coins held in accounts
func VestingStoreKey ¶
func VestingStoreKey(addr sdk.AccAddress) []byte
VestingStoreKey turn an address to key used to get it from the supply store
Types ¶
type Keeper ¶
type Keeper struct {
// contains filtered or unexported fields
}
Keeper of the supply store
func NewKeeper ¶
func NewKeeper(cdc *codec.Codec, key sdk.StoreKey, ak types.AccountKeeper, bk types.BankKeeper, maccPerms map[string][]string) Keeper
NewKeeper creates a new Keeper instance
func (Keeper) BurnCoins ¶
BurnCoins burns coins deletes coins from the balance of the module account. Panics if the name maps to a non-burner module account or if the amount is invalid.
func (Keeper) DelegateCoinsFromAccountToModule ¶
func (k Keeper) DelegateCoinsFromAccountToModule(ctx sdk.Context, senderAddr sdk.AccAddress, recipientModule string, amt sdk.Coins) error
DelegateCoinsFromAccountToModule delegates coins and transfers them from a delegator account to a module account
func (Keeper) GetAllVestings ¶
GetAllVestings returns all vestings in the supplyKeeper.
func (Keeper) GetModuleAccount ¶
GetModuleAccount gets the module account from the auth account store
func (Keeper) GetModuleAccountAndPermissions ¶
func (k Keeper) GetModuleAccountAndPermissions(ctx sdk.Context, moduleName string) (exported.ModuleAccountI, []string)
GetModuleAccountAndPermissions gets the module account from the auth account store and its registered permissions
func (Keeper) GetModuleAddress ¶
func (k Keeper) GetModuleAddress(moduleName string) sdk.AccAddress
GetModuleAddress returns an address based on the module name
func (Keeper) GetModuleAddressAndPermissions ¶
func (k Keeper) GetModuleAddressAndPermissions(moduleName string) (addr sdk.AccAddress, permissions []string)
GetModuleAddressAndPermissions returns an address and permissions based on the module name
func (Keeper) GetVesting ¶
func (k Keeper) GetVesting(ctx sdk.Context, addr sdk.AccAddress) (exist bool, vesting types.Vesting)
for Vesting GetVesting get vesting
func (Keeper) IterateVestings ¶
IterateVestings
func (Keeper) MintCoins ¶
MintCoins creates new coins from thin air and adds it to the module account. Panics if the name maps to a non-minter module account or if the amount is invalid.
func (Keeper) RemoveVesting ¶
func (k Keeper) RemoveVesting(ctx sdk.Context, address sdk.AccAddress)
RemoveAccount removes an account for the account mapper store.
func (Keeper) SendCoinsFromAccountToModule ¶
func (k Keeper) SendCoinsFromAccountToModule(ctx sdk.Context, senderAddr sdk.AccAddress, recipientModule string, amt sdk.Coins) error
SendCoinsFromAccountToModule transfers coins from an AccAddress to a ModuleAccount
func (Keeper) SendCoinsFromModuleToAccount ¶
func (k Keeper) SendCoinsFromModuleToAccount(ctx sdk.Context, senderModule string, recipientAddr sdk.AccAddress, amt sdk.Coins) error
SendCoinsFromModuleToAccount transfers coins from a ModuleAccount to an AccAddress
func (Keeper) SendCoinsFromModuleToModule ¶
func (k Keeper) SendCoinsFromModuleToModule(ctx sdk.Context, senderModule, recipientModule string, amt sdk.Coins) error
SendCoinsFromModuleToModule transfers coins from a ModuleAccount to another
func (Keeper) SetModuleAccount ¶
func (k Keeper) SetModuleAccount(ctx sdk.Context, macc exported.ModuleAccountI)
SetModuleAccount sets the module account to the auth account store nolint
func (Keeper) SetVesting ¶
SetAccount implements sdk.AccountKeeper.
func (Keeper) UndelegateCoinsFromModuleToAccount ¶
func (k Keeper) UndelegateCoinsFromModuleToAccount(ctx sdk.Context, senderModule string, recipientAddr sdk.AccAddress, amt sdk.Coins) error
UndelegateCoinsFromModuleToAccount undelegates the unbonding coins and transfers them from a module account to the delegator account
func (Keeper) ValidatePermissions ¶
func (k Keeper) ValidatePermissions(macc exported.ModuleAccountI) error
ValidatePermissions validates that the module account has been granted permissions within its set of allowed permissions.