Documentation ¶
Overview ¶
Package types is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- Constants
- Variables
- func ParamKeyTable() paramtypes.KeyTable
- func RegisterQueryHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterQueryHandlerClient(ctx context.Context, mux *runtime.ServeMux, client QueryClient) error
- func RegisterQueryHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterQueryHandlerServer(ctx context.Context, mux *runtime.ServeMux, server QueryServer) error
- func RegisterQueryServer(s grpc1.Server, srv QueryServer)
- func ValidateGenesis(data GenesisState) error
- type AccountKeeper
- type BankKeeper
- type CommunityPoolKeeper
- type DistributionProportions
- func (*DistributionProportions) Descriptor() ([]byte, []int)
- func (m *DistributionProportions) Marshal() (dAtA []byte, err error)
- func (m *DistributionProportions) MarshalTo(dAtA []byte) (int, error)
- func (m *DistributionProportions) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*DistributionProportions) ProtoMessage()
- func (m *DistributionProportions) Reset()
- func (m *DistributionProportions) Size() (n int)
- func (m *DistributionProportions) String() string
- func (m *DistributionProportions) Unmarshal(dAtA []byte) error
- func (m *DistributionProportions) XXX_DiscardUnknown()
- func (m *DistributionProportions) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *DistributionProportions) XXX_Merge(src proto.Message)
- func (m *DistributionProportions) XXX_Size() int
- func (m *DistributionProportions) XXX_Unmarshal(b []byte) error
- type EpochKeeper
- type GenesisState
- func (*GenesisState) Descriptor() ([]byte, []int)
- func (m *GenesisState) GetMinter() Minter
- func (m *GenesisState) GetParams() Params
- func (m *GenesisState) GetReductionStartedEpoch() int64
- func (m *GenesisState) Marshal() (dAtA []byte, err error)
- func (m *GenesisState) MarshalTo(dAtA []byte) (int, error)
- func (m *GenesisState) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*GenesisState) ProtoMessage()
- func (m *GenesisState) Reset()
- func (m *GenesisState) Size() (n int)
- func (m *GenesisState) String() string
- func (m *GenesisState) Unmarshal(dAtA []byte) error
- func (m *GenesisState) XXX_DiscardUnknown()
- func (m *GenesisState) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *GenesisState) XXX_Merge(src proto.Message)
- func (m *GenesisState) XXX_Size() int
- func (m *GenesisState) XXX_Unmarshal(b []byte) error
- type MintHooks
- type Minter
- func (*Minter) Descriptor() ([]byte, []int)
- func (m Minter) EpochProvision(params Params) sdk.Coin
- func (m Minter) GetDeveloperVestingEpochProvisions(params Params) sdk.DecCoin
- func (m Minter) GetInflationProvisions(params Params) sdk.DecCoin
- func (m *Minter) Marshal() (dAtA []byte, err error)
- func (m *Minter) MarshalTo(dAtA []byte) (int, error)
- func (m *Minter) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (m Minter) NextEpochProvisions(params Params) sdk.Dec
- func (*Minter) ProtoMessage()
- func (m *Minter) Reset()
- func (m *Minter) Size() (n int)
- func (m *Minter) String() string
- func (m *Minter) Unmarshal(dAtA []byte) error
- func (m Minter) Validate() error
- func (m *Minter) XXX_DiscardUnknown()
- func (m *Minter) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *Minter) XXX_Merge(src proto.Message)
- func (m *Minter) XXX_Size() int
- func (m *Minter) XXX_Unmarshal(b []byte) error
- type MultiMintHooks
- type Params
- func (*Params) Descriptor() ([]byte, []int)
- func (p Params) GetDeveloperVestingProportion() sdk.Dec
- func (m *Params) GetDistributionProportions() DistributionProportions
- func (m *Params) GetEpochIdentifier() string
- func (p Params) GetInflationProportion() sdk.Dec
- func (m *Params) GetMintDenom() string
- func (m *Params) GetMintingRewardsDistributionStartEpoch() int64
- func (m *Params) GetReductionPeriodInEpochs() int64
- func (m *Params) GetWeightedDeveloperRewardsReceivers() []WeightedAddress
- func (m *Params) Marshal() (dAtA []byte, err error)
- func (m *Params) MarshalTo(dAtA []byte) (int, error)
- func (m *Params) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (p *Params) ParamSetPairs() paramtypes.ParamSetPairs
- func (*Params) ProtoMessage()
- func (m *Params) Reset()
- func (m *Params) Size() (n int)
- func (p Params) String() string
- func (m *Params) Unmarshal(dAtA []byte) error
- func (p Params) Validate() error
- func (m *Params) XXX_DiscardUnknown()
- func (m *Params) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *Params) XXX_Merge(src proto.Message)
- func (m *Params) XXX_Size() int
- func (m *Params) XXX_Unmarshal(b []byte) error
- type QueryClient
- type QueryEpochProvisionsRequest
- func (*QueryEpochProvisionsRequest) Descriptor() ([]byte, []int)
- func (m *QueryEpochProvisionsRequest) Marshal() (dAtA []byte, err error)
- func (m *QueryEpochProvisionsRequest) MarshalTo(dAtA []byte) (int, error)
- func (m *QueryEpochProvisionsRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*QueryEpochProvisionsRequest) ProtoMessage()
- func (m *QueryEpochProvisionsRequest) Reset()
- func (m *QueryEpochProvisionsRequest) Size() (n int)
- func (m *QueryEpochProvisionsRequest) String() string
- func (m *QueryEpochProvisionsRequest) Unmarshal(dAtA []byte) error
- func (m *QueryEpochProvisionsRequest) XXX_DiscardUnknown()
- func (m *QueryEpochProvisionsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *QueryEpochProvisionsRequest) XXX_Merge(src proto.Message)
- func (m *QueryEpochProvisionsRequest) XXX_Size() int
- func (m *QueryEpochProvisionsRequest) XXX_Unmarshal(b []byte) error
- type QueryEpochProvisionsResponse
- func (*QueryEpochProvisionsResponse) Descriptor() ([]byte, []int)
- func (m *QueryEpochProvisionsResponse) Marshal() (dAtA []byte, err error)
- func (m *QueryEpochProvisionsResponse) MarshalTo(dAtA []byte) (int, error)
- func (m *QueryEpochProvisionsResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*QueryEpochProvisionsResponse) ProtoMessage()
- func (m *QueryEpochProvisionsResponse) Reset()
- func (m *QueryEpochProvisionsResponse) Size() (n int)
- func (m *QueryEpochProvisionsResponse) String() string
- func (m *QueryEpochProvisionsResponse) Unmarshal(dAtA []byte) error
- func (m *QueryEpochProvisionsResponse) XXX_DiscardUnknown()
- func (m *QueryEpochProvisionsResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *QueryEpochProvisionsResponse) XXX_Merge(src proto.Message)
- func (m *QueryEpochProvisionsResponse) XXX_Size() int
- func (m *QueryEpochProvisionsResponse) XXX_Unmarshal(b []byte) error
- type QueryParamsRequest
- func (*QueryParamsRequest) Descriptor() ([]byte, []int)
- func (m *QueryParamsRequest) Marshal() (dAtA []byte, err error)
- func (m *QueryParamsRequest) MarshalTo(dAtA []byte) (int, error)
- func (m *QueryParamsRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*QueryParamsRequest) ProtoMessage()
- func (m *QueryParamsRequest) Reset()
- func (m *QueryParamsRequest) Size() (n int)
- func (m *QueryParamsRequest) String() string
- func (m *QueryParamsRequest) Unmarshal(dAtA []byte) error
- func (m *QueryParamsRequest) XXX_DiscardUnknown()
- func (m *QueryParamsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *QueryParamsRequest) XXX_Merge(src proto.Message)
- func (m *QueryParamsRequest) XXX_Size() int
- func (m *QueryParamsRequest) XXX_Unmarshal(b []byte) error
- type QueryParamsResponse
- func (*QueryParamsResponse) Descriptor() ([]byte, []int)
- func (m *QueryParamsResponse) GetParams() Params
- func (m *QueryParamsResponse) Marshal() (dAtA []byte, err error)
- func (m *QueryParamsResponse) MarshalTo(dAtA []byte) (int, error)
- func (m *QueryParamsResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*QueryParamsResponse) ProtoMessage()
- func (m *QueryParamsResponse) Reset()
- func (m *QueryParamsResponse) Size() (n int)
- func (m *QueryParamsResponse) String() string
- func (m *QueryParamsResponse) Unmarshal(dAtA []byte) error
- func (m *QueryParamsResponse) XXX_DiscardUnknown()
- func (m *QueryParamsResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *QueryParamsResponse) XXX_Merge(src proto.Message)
- func (m *QueryParamsResponse) XXX_Size() int
- func (m *QueryParamsResponse) XXX_Unmarshal(b []byte) error
- type QueryServer
- type UnimplementedQueryServer
- type WeightedAddress
- func (*WeightedAddress) Descriptor() ([]byte, []int)
- func (m *WeightedAddress) GetAddress() string
- func (m *WeightedAddress) Marshal() (dAtA []byte, err error)
- func (m *WeightedAddress) MarshalTo(dAtA []byte) (int, error)
- func (m *WeightedAddress) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*WeightedAddress) ProtoMessage()
- func (m *WeightedAddress) Reset()
- func (m *WeightedAddress) Size() (n int)
- func (m *WeightedAddress) String() string
- func (m *WeightedAddress) Unmarshal(dAtA []byte) error
- func (m *WeightedAddress) XXX_DiscardUnknown()
- func (m *WeightedAddress) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *WeightedAddress) XXX_Merge(src proto.Message)
- func (m *WeightedAddress) XXX_Size() int
- func (m *WeightedAddress) XXX_Unmarshal(b []byte) error
Constants ¶
const ( // AttributeKeyEpochProvisions is the string representation of the // epoch provisions event attribute. AttributeKeyEpochProvisions = "epoch_provisions" // AttributeEpochNumber is the string representation of the // epoch number event attribute. AttributeEpochNumber = "epoch_number" )
Minting module event constants.
const ( // ModuleName is the module name. ModuleName = "mint" // DeveloperVestingModuleAcctName is the module acct name for developer vesting. DeveloperVestingModuleAcctName = "developer_vesting_unvested" // StoreKey is the default store key for mint. StoreKey = ModuleName // QuerierRoute is the querier route for the minting store. QuerierRoute = StoreKey // QueryParameters is an endpoint path for querying mint parameters. QueryParameters = "parameters" // QueryEpochProvisions is an endpoint path for querying mint epoch provisions. QueryEpochProvisions = "epoch_provisions" )
Variables ¶
var ( ErrAmountNilOrZero = errorsmod.Register(ModuleName, 2, "amount cannot be nil or zero") ErrModuleAccountAlreadyExist = errorsmod.Register(ModuleName, 3, "module account already exists") ErrModuleDoesnotExist = errorsmod.Register(ModuleName, 4, "module account does not exist") )
var ( ErrInvalidLengthGenesis = fmt.Errorf("proto: negative length found during unmarshaling") ErrIntOverflowGenesis = fmt.Errorf("proto: integer overflow") ErrUnexpectedEndOfGroupGenesis = fmt.Errorf("proto: unexpected end of group") )
var ( ErrInvalidLengthMint = fmt.Errorf("proto: negative length found during unmarshaling") ErrIntOverflowMint = fmt.Errorf("proto: integer overflow") ErrUnexpectedEndOfGroupMint = fmt.Errorf("proto: unexpected end of group") )
var ( KeyMintDenom = []byte("MintDenom") KeyGenesisEpochProvisions = []byte("GenesisEpochProvisions") KeyEpochIdentifier = []byte("EpochIdentifier") KeyReductionPeriodInEpochs = []byte("ReductionPeriodInEpochs") KeyReductionFactor = []byte("ReductionFactor") KeyPoolAllocationRatio = []byte("PoolAllocationRatio") KeyDeveloperRewardsReceiver = []byte("DeveloperRewardsReceiver") KeyMintingRewardsDistributionStartEpoch = []byte("MintingRewardsDistributionStartEpoch") )
Parameter store keys.
var ( ErrInvalidLengthQuery = fmt.Errorf("proto: negative length found during unmarshaling") ErrIntOverflowQuery = fmt.Errorf("proto: integer overflow") ErrUnexpectedEndOfGroupQuery = fmt.Errorf("proto: unexpected end of group") )
var LastReductionEpochKey = []byte{0x03}
LastReductionEpochKey is the key to use for the keeper store for storing the last epoch at which reduction occurred.
var MinterKey = []byte{0x00}
MinterKey is the key to use for the keeper store at which the Minter and its EpochProvisions are stored.
Functions ¶
func RegisterQueryHandler ¶
RegisterQueryHandler registers the http handlers for service Query to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterQueryHandlerClient ¶
func RegisterQueryHandlerClient(ctx context.Context, mux *runtime.ServeMux, client QueryClient) error
RegisterQueryHandlerClient registers the http handlers for service Query to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "QueryClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "QueryClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "QueryClient" to call the correct interceptors.
func RegisterQueryHandlerFromEndpoint ¶
func RegisterQueryHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterQueryHandlerFromEndpoint is same as RegisterQueryHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterQueryHandlerServer ¶
func RegisterQueryHandlerServer(ctx context.Context, mux *runtime.ServeMux, server QueryServer) error
RegisterQueryHandlerServer registers the http handlers for service Query to "mux". UnaryRPC :call QueryServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterQueryHandlerFromEndpoint instead.
func RegisterQueryServer ¶
func RegisterQueryServer(s grpc1.Server, srv QueryServer)
func ValidateGenesis ¶
func ValidateGenesis(data GenesisState) error
ValidateGenesis validates the provided genesis state to ensure the expected invariants holds.
Types ¶
type AccountKeeper ¶
type AccountKeeper interface { GetModuleAddress(name string) sdk.AccAddress HasAccount(ctx sdk.Context, addr sdk.AccAddress) bool SetModuleAccount(sdk.Context, types.ModuleAccountI) GetModuleAccount(ctx sdk.Context, moduleName string) types.ModuleAccountI }
AccountKeeper defines the contract required for account APIs.
type BankKeeper ¶
type BankKeeper interface { GetBalance(ctx sdk.Context, addr sdk.AccAddress, denom string) sdk.Coin SendCoinsFromModuleToAccount(ctx sdk.Context, senderModule string, recipientAddr sdk.AccAddress, amt sdk.Coins) error SendCoinsFromModuleToModule(ctx sdk.Context, senderModule, recipientModule string, amt sdk.Coins) error MintCoins(ctx sdk.Context, name string, amt sdk.Coins) error BurnCoins(ctx sdk.Context, name string, amt sdk.Coins) error AddSupplyOffset(ctx sdk.Context, denom string, offsetAmount sdk.Int) }
BankKeeper defines the contract needed to be fulfilled for banking and supply dependencies.
type CommunityPoolKeeper ¶
type CommunityPoolKeeper interface {
FundCommunityPool(ctx sdk.Context, amount sdk.Coins, sender sdk.AccAddress) error
}
CommunityPoolKeeper defines the contract needed to be fulfilled for distribution keeper.
type DistributionProportions ¶
type DistributionProportions struct { // staking defines the proportion of the minted mint_denom that is to be // allocated as staking rewards. Staking github_com_cosmos_cosmos_sdk_types.Dec `protobuf:"bytes,1,opt,name=staking,proto3,customtype=github.com/cosmos/cosmos-sdk/types.Dec" json:"staking" yaml:"staking"` // pool_incentives defines the proportion of the minted mint_denom that is // to be allocated as pool incentives. PoolIncentives github_com_cosmos_cosmos_sdk_types.Dec `` /* 166-byte string literal not displayed */ // developer_rewards defines the proportion of the minted mint_denom that is // to be allocated to developer rewards address. DeveloperRewards github_com_cosmos_cosmos_sdk_types.Dec `` /* 174-byte string literal not displayed */ // community_pool defines the proportion of the minted mint_denom that is // to be allocated to the community pool. CommunityPool github_com_cosmos_cosmos_sdk_types.Dec `` /* 162-byte string literal not displayed */ }
DistributionProportions defines the distribution proportions of the minted denom. In other words, defines which stakeholders will receive the minted denoms and how much.
func (*DistributionProportions) Descriptor ¶
func (*DistributionProportions) Descriptor() ([]byte, []int)
func (*DistributionProportions) Marshal ¶
func (m *DistributionProportions) Marshal() (dAtA []byte, err error)
func (*DistributionProportions) MarshalTo ¶
func (m *DistributionProportions) MarshalTo(dAtA []byte) (int, error)
func (*DistributionProportions) MarshalToSizedBuffer ¶
func (m *DistributionProportions) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*DistributionProportions) ProtoMessage ¶
func (*DistributionProportions) ProtoMessage()
func (*DistributionProportions) Reset ¶
func (m *DistributionProportions) Reset()
func (*DistributionProportions) Size ¶
func (m *DistributionProportions) Size() (n int)
func (*DistributionProportions) String ¶
func (m *DistributionProportions) String() string
func (*DistributionProportions) Unmarshal ¶
func (m *DistributionProportions) Unmarshal(dAtA []byte) error
func (*DistributionProportions) XXX_DiscardUnknown ¶
func (m *DistributionProportions) XXX_DiscardUnknown()
func (*DistributionProportions) XXX_Marshal ¶
func (m *DistributionProportions) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*DistributionProportions) XXX_Merge ¶
func (m *DistributionProportions) XXX_Merge(src proto.Message)
func (*DistributionProportions) XXX_Size ¶
func (m *DistributionProportions) XXX_Size() int
func (*DistributionProportions) XXX_Unmarshal ¶
func (m *DistributionProportions) XXX_Unmarshal(b []byte) error
type EpochKeeper ¶
type EpochKeeper interface {
GetEpochInfo(ctx sdk.Context, identifier string) epochstypes.EpochInfo
}
EpochKeeper defines the contract needed to be fulfilled for epochs keeper.
type GenesisState ¶
type GenesisState struct { // minter is an abstraction for holding current rewards information. Minter Minter `protobuf:"bytes,1,opt,name=minter,proto3" json:"minter"` // params defines all the paramaters of the mint module. Params Params `protobuf:"bytes,2,opt,name=params,proto3" json:"params"` // reduction_started_epoch is the first epoch in which the reduction of mint // begins. ReductionStartedEpoch int64 `` /* 158-byte string literal not displayed */ }
GenesisState defines the mint module's genesis state.
func DefaultGenesisState ¶
func DefaultGenesisState() *GenesisState
DefaultGenesisState creates a default GenesisState object.
func NewGenesisState ¶
func NewGenesisState(minter Minter, params Params, reductionStartedEpoch int64) *GenesisState
NewGenesisState creates a new GenesisState object.
func (*GenesisState) Descriptor ¶
func (*GenesisState) Descriptor() ([]byte, []int)
func (*GenesisState) GetMinter ¶
func (m *GenesisState) GetMinter() Minter
func (*GenesisState) GetParams ¶
func (m *GenesisState) GetParams() Params
func (*GenesisState) GetReductionStartedEpoch ¶
func (m *GenesisState) GetReductionStartedEpoch() int64
func (*GenesisState) Marshal ¶
func (m *GenesisState) Marshal() (dAtA []byte, err error)
func (*GenesisState) MarshalToSizedBuffer ¶
func (m *GenesisState) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*GenesisState) ProtoMessage ¶
func (*GenesisState) ProtoMessage()
func (*GenesisState) Reset ¶
func (m *GenesisState) Reset()
func (*GenesisState) Size ¶
func (m *GenesisState) Size() (n int)
func (*GenesisState) String ¶
func (m *GenesisState) String() string
func (*GenesisState) Unmarshal ¶
func (m *GenesisState) Unmarshal(dAtA []byte) error
func (*GenesisState) XXX_DiscardUnknown ¶
func (m *GenesisState) XXX_DiscardUnknown()
func (*GenesisState) XXX_Marshal ¶
func (m *GenesisState) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*GenesisState) XXX_Merge ¶
func (m *GenesisState) XXX_Merge(src proto.Message)
func (*GenesisState) XXX_Size ¶
func (m *GenesisState) XXX_Size() int
func (*GenesisState) XXX_Unmarshal ¶
func (m *GenesisState) XXX_Unmarshal(b []byte) error
type Minter ¶
type Minter struct { // epoch_provisions represent rewards for the current epoch. EpochProvisions github_com_cosmos_cosmos_sdk_types.Dec `` /* 170-byte string literal not displayed */ }
Minter represents the minting state.
func DefaultInitialMinter ¶
func DefaultInitialMinter() Minter
DefaultInitialMinter returns a default initial Minter object for a new chain.
func (*Minter) Descriptor ¶
func (Minter) EpochProvision ¶
EpochProvision returns the provisions for a block based on the epoch provisions rate.
func (Minter) GetDeveloperVestingEpochProvisions ¶
GetDeveloperVestingEpochProvisions returns the developer vesting provisions. These are calculated as the current epoch provisons * developer rewards proportion The returned denom is taken from input parameters.
func (Minter) GetInflationProvisions ¶
GetInflationProvisions returns the inflation provisions. These are calculated as the current epoch provisons * (1 - developer rewards proportion) The returned denom is taken from input parameters.
func (*Minter) MarshalToSizedBuffer ¶
func (Minter) NextEpochProvisions ¶
NextEpochProvisions returns the epoch provisions.
func (*Minter) ProtoMessage ¶
func (*Minter) ProtoMessage()
func (*Minter) XXX_DiscardUnknown ¶
func (m *Minter) XXX_DiscardUnknown()
func (*Minter) XXX_Marshal ¶
func (*Minter) XXX_Unmarshal ¶
type MultiMintHooks ¶
type MultiMintHooks []MintHooks
MultiMintHooks is a container for mint hooks. All hooks are run in sequence.
func NewMultiMintHooks ¶
func NewMultiMintHooks(hooks ...MintHooks) MultiMintHooks
NewMultiMintHooks returns new MultiMintHooks given hooks.
func (MultiMintHooks) AfterDistributeMintedCoin ¶
func (h MultiMintHooks) AfterDistributeMintedCoin(ctx sdk.Context)
AfterDistributeMintedCoin is a hook that runs after minter mints and distributes coins at the beginning of each epoch.
type Params ¶
type Params struct { // mint_denom is the denom of the coin to mint. MintDenom string `protobuf:"bytes,1,opt,name=mint_denom,json=mintDenom,proto3" json:"mint_denom,omitempty"` // genesis_epoch_provisions epoch provisions from the first epoch. GenesisEpochProvisions github_com_cosmos_cosmos_sdk_types.Dec `` /* 201-byte string literal not displayed */ // epoch_identifier mint epoch identifier e.g. (day, week). EpochIdentifier string `` /* 130-byte string literal not displayed */ // reduction_period_in_epochs the number of epochs it takes // to reduce the rewards. ReductionPeriodInEpochs int64 `` /* 169-byte string literal not displayed */ // reduction_factor is the reduction multiplier to execute // at the end of each period set by reduction_period_in_epochs. ReductionFactor github_com_cosmos_cosmos_sdk_types.Dec `` /* 170-byte string literal not displayed */ // distribution_proportions defines the distribution proportions of the minted // denom. In other words, defines which stakeholders will receive the minted // denoms and how much. DistributionProportions DistributionProportions `protobuf:"bytes,6,opt,name=distribution_proportions,json=distributionProportions,proto3" json:"distribution_proportions"` // weighted_developer_rewards_receivers is the address to receive developer // rewards with weights assignedt to each address. The final amount that each // address receives is: epoch_provisions * // distribution_proportions.developer_rewards * Address's Weight. WeightedDeveloperRewardsReceivers []WeightedAddress `` /* 188-byte string literal not displayed */ // minting_rewards_distribution_start_epoch start epoch to distribute minting // rewards MintingRewardsDistributionStartEpoch int64 `` /* 224-byte string literal not displayed */ }
Params holds parameters for the x/mint module.
func DefaultParams ¶
func DefaultParams() Params
DefaultParams returns the default minting module parameters.
func NewParams ¶
func NewParams( mintDenom string, genesisEpochProvisions sdk.Dec, epochIdentifier string, ReductionFactor sdk.Dec, reductionPeriodInEpochs int64, distrProportions DistributionProportions, weightedDevRewardsReceivers []WeightedAddress, mintingRewardsDistributionStartEpoch int64, ) Params
NewParams returns new mint module parameters initialized to the given values.
func (*Params) Descriptor ¶
func (Params) GetDeveloperVestingProportion ¶
GetDeveloperVestingProportion returns the developer vesting proportion of epoch provisions.
func (*Params) GetDistributionProportions ¶
func (m *Params) GetDistributionProportions() DistributionProportions
func (*Params) GetEpochIdentifier ¶
func (Params) GetInflationProportion ¶
GetInflationProportion returns the inflation proportion of epoch provisions.
func (*Params) GetMintDenom ¶
func (*Params) GetMintingRewardsDistributionStartEpoch ¶
func (*Params) GetReductionPeriodInEpochs ¶
func (*Params) GetWeightedDeveloperRewardsReceivers ¶
func (m *Params) GetWeightedDeveloperRewardsReceivers() []WeightedAddress
func (*Params) MarshalToSizedBuffer ¶
func (*Params) ParamSetPairs ¶
func (p *Params) ParamSetPairs() paramtypes.ParamSetPairs
Implements params.ParamSet.
func (*Params) ProtoMessage ¶
func (*Params) ProtoMessage()
func (Params) Validate ¶
Validate validates mint module parameters. Returns nil if valid, error otherwise
func (*Params) XXX_DiscardUnknown ¶
func (m *Params) XXX_DiscardUnknown()
func (*Params) XXX_Marshal ¶
func (*Params) XXX_Unmarshal ¶
type QueryClient ¶
type QueryClient interface { // Params returns the total set of minting parameters. Params(ctx context.Context, in *QueryParamsRequest, opts ...grpc.CallOption) (*QueryParamsResponse, error) // EpochProvisions returns the current minting epoch provisions value. EpochProvisions(ctx context.Context, in *QueryEpochProvisionsRequest, opts ...grpc.CallOption) (*QueryEpochProvisionsResponse, error) }
QueryClient is the client API for Query service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewQueryClient ¶
func NewQueryClient(cc grpc1.ClientConn) QueryClient
type QueryEpochProvisionsRequest ¶
type QueryEpochProvisionsRequest struct { }
QueryEpochProvisionsRequest is the request type for the Query/EpochProvisions RPC method.
func (*QueryEpochProvisionsRequest) Descriptor ¶
func (*QueryEpochProvisionsRequest) Descriptor() ([]byte, []int)
func (*QueryEpochProvisionsRequest) Marshal ¶
func (m *QueryEpochProvisionsRequest) Marshal() (dAtA []byte, err error)
func (*QueryEpochProvisionsRequest) MarshalTo ¶
func (m *QueryEpochProvisionsRequest) MarshalTo(dAtA []byte) (int, error)
func (*QueryEpochProvisionsRequest) MarshalToSizedBuffer ¶
func (m *QueryEpochProvisionsRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*QueryEpochProvisionsRequest) ProtoMessage ¶
func (*QueryEpochProvisionsRequest) ProtoMessage()
func (*QueryEpochProvisionsRequest) Reset ¶
func (m *QueryEpochProvisionsRequest) Reset()
func (*QueryEpochProvisionsRequest) Size ¶
func (m *QueryEpochProvisionsRequest) Size() (n int)
func (*QueryEpochProvisionsRequest) String ¶
func (m *QueryEpochProvisionsRequest) String() string
func (*QueryEpochProvisionsRequest) Unmarshal ¶
func (m *QueryEpochProvisionsRequest) Unmarshal(dAtA []byte) error
func (*QueryEpochProvisionsRequest) XXX_DiscardUnknown ¶
func (m *QueryEpochProvisionsRequest) XXX_DiscardUnknown()
func (*QueryEpochProvisionsRequest) XXX_Marshal ¶
func (m *QueryEpochProvisionsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*QueryEpochProvisionsRequest) XXX_Merge ¶
func (m *QueryEpochProvisionsRequest) XXX_Merge(src proto.Message)
func (*QueryEpochProvisionsRequest) XXX_Size ¶
func (m *QueryEpochProvisionsRequest) XXX_Size() int
func (*QueryEpochProvisionsRequest) XXX_Unmarshal ¶
func (m *QueryEpochProvisionsRequest) XXX_Unmarshal(b []byte) error
type QueryEpochProvisionsResponse ¶
type QueryEpochProvisionsResponse struct { // epoch_provisions is the current minting per epoch provisions value. EpochProvisions github_com_cosmos_cosmos_sdk_types.Dec `` /* 146-byte string literal not displayed */ }
QueryEpochProvisionsResponse is the response type for the Query/EpochProvisions RPC method.
func (*QueryEpochProvisionsResponse) Descriptor ¶
func (*QueryEpochProvisionsResponse) Descriptor() ([]byte, []int)
func (*QueryEpochProvisionsResponse) Marshal ¶
func (m *QueryEpochProvisionsResponse) Marshal() (dAtA []byte, err error)
func (*QueryEpochProvisionsResponse) MarshalTo ¶
func (m *QueryEpochProvisionsResponse) MarshalTo(dAtA []byte) (int, error)
func (*QueryEpochProvisionsResponse) MarshalToSizedBuffer ¶
func (m *QueryEpochProvisionsResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*QueryEpochProvisionsResponse) ProtoMessage ¶
func (*QueryEpochProvisionsResponse) ProtoMessage()
func (*QueryEpochProvisionsResponse) Reset ¶
func (m *QueryEpochProvisionsResponse) Reset()
func (*QueryEpochProvisionsResponse) Size ¶
func (m *QueryEpochProvisionsResponse) Size() (n int)
func (*QueryEpochProvisionsResponse) String ¶
func (m *QueryEpochProvisionsResponse) String() string
func (*QueryEpochProvisionsResponse) Unmarshal ¶
func (m *QueryEpochProvisionsResponse) Unmarshal(dAtA []byte) error
func (*QueryEpochProvisionsResponse) XXX_DiscardUnknown ¶
func (m *QueryEpochProvisionsResponse) XXX_DiscardUnknown()
func (*QueryEpochProvisionsResponse) XXX_Marshal ¶
func (m *QueryEpochProvisionsResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*QueryEpochProvisionsResponse) XXX_Merge ¶
func (m *QueryEpochProvisionsResponse) XXX_Merge(src proto.Message)
func (*QueryEpochProvisionsResponse) XXX_Size ¶
func (m *QueryEpochProvisionsResponse) XXX_Size() int
func (*QueryEpochProvisionsResponse) XXX_Unmarshal ¶
func (m *QueryEpochProvisionsResponse) XXX_Unmarshal(b []byte) error
type QueryParamsRequest ¶
type QueryParamsRequest struct { }
QueryParamsRequest is the request type for the Query/Params RPC method.
func (*QueryParamsRequest) Descriptor ¶
func (*QueryParamsRequest) Descriptor() ([]byte, []int)
func (*QueryParamsRequest) Marshal ¶
func (m *QueryParamsRequest) Marshal() (dAtA []byte, err error)
func (*QueryParamsRequest) MarshalTo ¶
func (m *QueryParamsRequest) MarshalTo(dAtA []byte) (int, error)
func (*QueryParamsRequest) MarshalToSizedBuffer ¶
func (m *QueryParamsRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*QueryParamsRequest) ProtoMessage ¶
func (*QueryParamsRequest) ProtoMessage()
func (*QueryParamsRequest) Reset ¶
func (m *QueryParamsRequest) Reset()
func (*QueryParamsRequest) Size ¶
func (m *QueryParamsRequest) Size() (n int)
func (*QueryParamsRequest) String ¶
func (m *QueryParamsRequest) String() string
func (*QueryParamsRequest) Unmarshal ¶
func (m *QueryParamsRequest) Unmarshal(dAtA []byte) error
func (*QueryParamsRequest) XXX_DiscardUnknown ¶
func (m *QueryParamsRequest) XXX_DiscardUnknown()
func (*QueryParamsRequest) XXX_Marshal ¶
func (m *QueryParamsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*QueryParamsRequest) XXX_Merge ¶
func (m *QueryParamsRequest) XXX_Merge(src proto.Message)
func (*QueryParamsRequest) XXX_Size ¶
func (m *QueryParamsRequest) XXX_Size() int
func (*QueryParamsRequest) XXX_Unmarshal ¶
func (m *QueryParamsRequest) XXX_Unmarshal(b []byte) error
type QueryParamsResponse ¶
type QueryParamsResponse struct { // params defines the parameters of the module. Params Params `protobuf:"bytes,1,opt,name=params,proto3" json:"params"` }
QueryParamsResponse is the response type for the Query/Params RPC method.
func (*QueryParamsResponse) Descriptor ¶
func (*QueryParamsResponse) Descriptor() ([]byte, []int)
func (*QueryParamsResponse) GetParams ¶
func (m *QueryParamsResponse) GetParams() Params
func (*QueryParamsResponse) Marshal ¶
func (m *QueryParamsResponse) Marshal() (dAtA []byte, err error)
func (*QueryParamsResponse) MarshalTo ¶
func (m *QueryParamsResponse) MarshalTo(dAtA []byte) (int, error)
func (*QueryParamsResponse) MarshalToSizedBuffer ¶
func (m *QueryParamsResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*QueryParamsResponse) ProtoMessage ¶
func (*QueryParamsResponse) ProtoMessage()
func (*QueryParamsResponse) Reset ¶
func (m *QueryParamsResponse) Reset()
func (*QueryParamsResponse) Size ¶
func (m *QueryParamsResponse) Size() (n int)
func (*QueryParamsResponse) String ¶
func (m *QueryParamsResponse) String() string
func (*QueryParamsResponse) Unmarshal ¶
func (m *QueryParamsResponse) Unmarshal(dAtA []byte) error
func (*QueryParamsResponse) XXX_DiscardUnknown ¶
func (m *QueryParamsResponse) XXX_DiscardUnknown()
func (*QueryParamsResponse) XXX_Marshal ¶
func (m *QueryParamsResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*QueryParamsResponse) XXX_Merge ¶
func (m *QueryParamsResponse) XXX_Merge(src proto.Message)
func (*QueryParamsResponse) XXX_Size ¶
func (m *QueryParamsResponse) XXX_Size() int
func (*QueryParamsResponse) XXX_Unmarshal ¶
func (m *QueryParamsResponse) XXX_Unmarshal(b []byte) error
type QueryServer ¶
type QueryServer interface { // Params returns the total set of minting parameters. Params(context.Context, *QueryParamsRequest) (*QueryParamsResponse, error) // EpochProvisions returns the current minting epoch provisions value. EpochProvisions(context.Context, *QueryEpochProvisionsRequest) (*QueryEpochProvisionsResponse, error) }
QueryServer is the server API for Query service.
type UnimplementedQueryServer ¶
type UnimplementedQueryServer struct { }
UnimplementedQueryServer can be embedded to have forward compatible implementations.
func (*UnimplementedQueryServer) EpochProvisions ¶
func (*UnimplementedQueryServer) EpochProvisions(ctx context.Context, req *QueryEpochProvisionsRequest) (*QueryEpochProvisionsResponse, error)
func (*UnimplementedQueryServer) Params ¶
func (*UnimplementedQueryServer) Params(ctx context.Context, req *QueryParamsRequest) (*QueryParamsResponse, error)
type WeightedAddress ¶
type WeightedAddress struct { Address string `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty" yaml:"address"` Weight github_com_cosmos_cosmos_sdk_types.Dec `protobuf:"bytes,2,opt,name=weight,proto3,customtype=github.com/cosmos/cosmos-sdk/types.Dec" json:"weight" yaml:"weight"` }
WeightedAddress represents an address with a weight assigned to it. The weight is used to determine the proportion of the total minted tokens to be minted to the address.
func (*WeightedAddress) Descriptor ¶
func (*WeightedAddress) Descriptor() ([]byte, []int)
func (*WeightedAddress) GetAddress ¶
func (m *WeightedAddress) GetAddress() string
func (*WeightedAddress) Marshal ¶
func (m *WeightedAddress) Marshal() (dAtA []byte, err error)
func (*WeightedAddress) MarshalToSizedBuffer ¶
func (m *WeightedAddress) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*WeightedAddress) ProtoMessage ¶
func (*WeightedAddress) ProtoMessage()
func (*WeightedAddress) Reset ¶
func (m *WeightedAddress) Reset()
func (*WeightedAddress) Size ¶
func (m *WeightedAddress) Size() (n int)
func (*WeightedAddress) String ¶
func (m *WeightedAddress) String() string
func (*WeightedAddress) Unmarshal ¶
func (m *WeightedAddress) Unmarshal(dAtA []byte) error
func (*WeightedAddress) XXX_DiscardUnknown ¶
func (m *WeightedAddress) XXX_DiscardUnknown()
func (*WeightedAddress) XXX_Marshal ¶
func (m *WeightedAddress) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*WeightedAddress) XXX_Merge ¶
func (m *WeightedAddress) XXX_Merge(src proto.Message)
func (*WeightedAddress) XXX_Size ¶
func (m *WeightedAddress) XXX_Size() int
func (*WeightedAddress) XXX_Unmarshal ¶
func (m *WeightedAddress) XXX_Unmarshal(b []byte) error