mint

package

v0.33.0 Latest Latest Go to latest Published: Mar 7, 2019 License: Apache-2.0 Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/1011sh/cosmos-sdk

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func BeginBlocker(ctx sdk.Context, k Keeper)
func InitGenesis(ctx sdk.Context, keeper Keeper, data GenesisState)
func ParamKeyTable() params.KeyTable
func ValidateGenesis(data GenesisState) error
type FeeCollectionKeeper
type GenesisState
type Keeper
- func NewKeeper(cdc *codec.Codec, key sdk.StoreKey, paramSpace params.Subspace, ...) Keeper
type Minter
type Params
- func DefaultParams() Params
- func NewParams(mintDenom string, ...) Params
type StakingKeeper

Constants ¶

View Source

const (
	// default paramspace for params keeper
	DefaultParamspace = "mint"

	// StoreKey is the default store key for mint
	StoreKey = "mint"
)

Variables ¶

View Source

var (

	// params store for inflation params
	ParamStoreKeyParams = []byte("params")
)

Functions ¶

func BeginBlocker ¶

func BeginBlocker(ctx sdk.Context, k Keeper)

Inflate every block, update inflation parameters once per hour

func InitGenesis ¶

func InitGenesis(ctx sdk.Context, keeper Keeper, data GenesisState)

new mint genesis

func ParamKeyTable ¶ added in v0.31.0

func ParamKeyTable() params.KeyTable

ParamTable for staking module

func ValidateGenesis ¶

func ValidateGenesis(data GenesisState) error

ValidateGenesis validates the provided staking genesis state to ensure the expected invariants holds. (i.e. params in correct bounds, no duplicate validators)

Types ¶

type FeeCollectionKeeper ¶

type FeeCollectionKeeper interface {
	AddCollectedFees(sdk.Context, sdk.Coins) sdk.Coins
}

expected fee collection keeper interface

type GenesisState ¶

type GenesisState struct {
	Minter Minter `json:"minter"` // minter object
	Params Params `json:"params"` // inflation params
}

GenesisState - all distribution state that must be provided at genesis

func DefaultGenesisState ¶

func DefaultGenesisState() GenesisState

get raw genesis raw message for testing

func ExportGenesis ¶ added in v0.26.0

func ExportGenesis(ctx sdk.Context, keeper Keeper) GenesisState

ExportGenesis returns a GenesisState for a given context and keeper. The GenesisState will contain the pool, and validator/delegator distribution info's

func NewGenesisState ¶

func NewGenesisState(minter Minter, params Params) GenesisState

type Keeper ¶

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

keeper of the staking store

func NewKeeper ¶

func NewKeeper(cdc *codec.Codec, key sdk.StoreKey,
	paramSpace params.Subspace, sk StakingKeeper, fck FeeCollectionKeeper) Keeper

func (Keeper) GetMinter ¶

func (k Keeper) GetMinter(ctx sdk.Context) (minter Minter)

get the minter

func (Keeper) GetParams ¶

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

get inflation params from the global param store

func (Keeper) SetMinter ¶

func (k Keeper) SetMinter(ctx sdk.Context, minter Minter)

set the minter

func (Keeper) SetParams ¶

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

set inflation params from the global param store

type Minter ¶

type Minter struct {
	Inflation        sdk.Dec `json:"inflation"`         // current annual inflation rate
	AnnualProvisions sdk.Dec `json:"annual_provisions"` // current annual expected provisions
}

Minter represents the minting state

func DefaultInitialMinter ¶ added in v0.27.0

func DefaultInitialMinter() Minter

default initial minter object for a new chain which uses an inflation rate of 13%

func InitialMinter ¶

func InitialMinter(inflation sdk.Dec) Minter

minter object for a new chain

func NewMinter ¶ added in v0.27.0

func NewMinter(inflation, annualProvisions sdk.Dec) Minter

Create a new minter object

func (Minter) BlockProvision ¶ added in v0.27.0

func (m Minter) BlockProvision(params Params) sdk.Coin

get the provisions for a block based on the annual provisions rate

func (Minter) NextAnnualProvisions ¶ added in v0.27.0

func (m Minter) NextAnnualProvisions(params Params, totalSupply sdk.Int) (
	provisions sdk.Dec)

calculate the annual provisions based on current total supply and inflation rate

func (Minter) NextInflationRate ¶ added in v0.27.0

func (m Minter) NextInflationRate(params Params, bondedRatio sdk.Dec) (
	inflation sdk.Dec)

get the new inflation rate for the next hour

type Params ¶

type Params struct {
	MintDenom           string  `json:"mint_denom"`            // type of coin to mint
	InflationRateChange sdk.Dec `json:"inflation_rate_change"` // maximum annual change in inflation rate
	InflationMax        sdk.Dec `json:"inflation_max"`         // maximum inflation rate
	InflationMin        sdk.Dec `json:"inflation_min"`         // minimum inflation rate
	GoalBonded          sdk.Dec `json:"goal_bonded"`           // goal of percent bonded atoms
	BlocksPerYear       uint64  `json:"blocks_per_year"`       // expected blocks per year
}

mint parameters

func DefaultParams ¶

func DefaultParams() Params

default minting module parameters

func NewParams ¶ added in v0.27.0

func NewParams(mintDenom string, inflationRateChange, inflationMax,
	inflationMin, goalBonded sdk.Dec, blocksPerYear uint64) Params

type StakingKeeper ¶ added in v0.30.0

type StakingKeeper interface {
	TotalTokens(ctx sdk.Context) sdk.Int
	BondedRatio(ctx sdk.Context) sdk.Dec
	InflateSupply(ctx sdk.Context, newTokens sdk.Int)
}

expected staking keeper

Source Files ¶

View all Source files

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