Protobuf Documentation

Function

The Minting Module plays a crucial role in the blockchain ecosystem, tasked with regulating the issuance of tokens to validators. This ensures the network's ongoing stability and viability. The module operates consistently, adjusting key parameters with each block to maintain a balanced token supply.

Calculation of Inflation

The method for determining the inflation rate is outlined in the OKP4 Whitepaper - Token Model.

Per-Block Token Generation

Given the annual inflation rate, the Minting Module calculates the exact amount of tokens to be generated for each block, based on the total number of blocks in a year.

Table of Contents

• mint/v1beta1/mint.proto
  • Minter
  • Params
• mint/v1beta1/genesis.proto
  • GenesisState
• mint/v1beta1/query.proto

  • QueryAnnualProvisionsRequest

  • QueryAnnualProvisionsResponse

  • QueryInflationRequest

  • QueryInflationResponse

  • QueryParamsRequest

  • QueryParamsResponse

  • Query

• mint/v1beta1/tx.proto

  • MsgUpdateParams

  • MsgUpdateParamsResponse

  • Msg

• Scalar Value Types

Top

mint/v1beta1/mint.proto

Minter

Minter holds the state of minting within the blockchain.

Field	Type	Label	Description
inflation	string		Current annual inflation rate.
annual_provisions	string		Current annual anticipated provisions.

Params

Params defines the parameters for the mint module.

Field	Type	Label	Description
mint_denom	string		Denomination of the coin to be minted.
inflation_coef	string		Annual inflation coefficient, influencing the inflation rate based on the bonded ratio. Values range from 0 to 1, with higher values indicating higher inflation.
blocks_per_year	uint64		Estimated number of blocks per year.
inflation_max	string		Maximum annual inflation rate.
inflation_min	string		Minimum annual inflation rate.

Top

mint/v1beta1/genesis.proto

GenesisState

GenesisState defines the mint module's genesis state.

Field	Type	Label	Description
minter	Minter		minter is a space for holding current inflation information.
params	Params		params defines all the parameters of the module.

Top

mint/v1beta1/query.proto

QueryAnnualProvisionsRequest

QueryAnnualProvisionsRequest is the request type for the Query/AnnualProvisions RPC method.

QueryAnnualProvisionsResponse

QueryAnnualProvisionsResponse is the response type for the Query/AnnualProvisions RPC method.

Field	Type	Label	Description
annual_provisions	bytes		annual_provisions is the current minting annual provisions value.

QueryInflationRequest

QueryInflationRequest is the request type for the Query/Inflation RPC method.

QueryInflationResponse

QueryInflationResponse is the response type for the Query/Inflation RPC method.

Field	Type	Label	Description
inflation	bytes		inflation is the current minting inflation value.

QueryParamsRequest

QueryParamsRequest is the request type for the Query/Params RPC method.

QueryParamsResponse

QueryParamsResponse is the response type for the Query/Params RPC method.

Field	Type	Label	Description
params	Params		params defines the parameters of the module.

Query

Query provides defines the gRPC querier service.

Method Name	Request Type	Response Type	Description	HTTP Verb	Endpoint
Params	QueryParamsRequest	QueryParamsResponse	Params returns the total set of minting parameters.	GET	/cosmos/mint/v1beta1/params
Inflation	QueryInflationRequest	QueryInflationResponse	Inflation returns the current minting inflation value.	GET	/cosmos/mint/v1beta1/inflation
AnnualProvisions	QueryAnnualProvisionsRequest	QueryAnnualProvisionsResponse	AnnualProvisions current minting annual provisions value.	GET	/cosmos/mint/v1beta1/annual_provisions

Top

mint/v1beta1/tx.proto

MsgUpdateParams

MsgUpdateParams is the Msg/UpdateParams request type.

Since: cosmos-sdk 0.47

Field	Type	Label	Description
authority	string		authority is the address that controls the module (defaults to x/gov unless overwritten).
params	Params		params defines the x/mint parameters to update.

NOTE: All parameters must be supplied. |

MsgUpdateParamsResponse

MsgUpdateParamsResponse defines the response structure for executing a MsgUpdateParams message.

Since: cosmos-sdk 0.47

Msg

Msg defines the x/mint Msg service.

Method Name	Request Type	Response Type	Description	HTTP Verb	Endpoint
UpdateParams	MsgUpdateParams	MsgUpdateParamsResponse	UpdateParams defines a governance operation for updating the x/mint module parameters. The authority is defaults to the x/gov module account.

Since: cosmos-sdk 0.47 | |

Scalar Value Types

.proto Type	Notes	C++	Java	Python	Go	C#	PHP	Ruby
double		double	double	float	float64	double	float	Float
float		float	float	float	float32	float	float	Float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long	int64	long	integer/string	Bignum
uint32	Uses variable-length encoding.	uint32	int	int/long	uint32	uint	integer	Bignum or Fixnum (as required)
uint64	Uses variable-length encoding.	uint64	long	int/long	uint64	ulong	integer/string	Bignum or Fixnum (as required)
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long	int64	long	integer/string	Bignum
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int	uint32	uint	integer	Bignum or Fixnum (as required)
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long	uint64	ulong	integer/string	Bignum
sfixed32	Always four bytes.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sfixed64	Always eight bytes.	int64	long	int/long	int64	long	integer/string	Bignum
bool		bool	boolean	boolean	bool	bool	boolean	TrueClass/FalseClass
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode	string	string	string	String (UTF-8)
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str	[]byte	ByteString	string	String (ASCII-8BIT)