From 88ad108ba81c585bfbd3cc24d997c7aa40dc37bd Mon Sep 17 00:00:00 2001 From: Bot Anik <98603954+bot-anik@users.noreply.github.com> Date: Wed, 18 Dec 2024 13:30:29 +0000 Subject: [PATCH] feat(modules): add axone-protocol/axoned v11.0.1 modules documentation --- .../version-v11.0.1/logic.md | 510 ++++++++++++++++++ .../version-v11.0.1/mint.md | 255 +++++++++ .../version-v11.0.1/vesting.md | 273 ++++++++++ .../version-v11.0.1-sidebars.json | 8 + modules_versions.json | 1 + 5 files changed, 1047 insertions(+) create mode 100644 modules_versioned_docs/version-v11.0.1/logic.md create mode 100644 modules_versioned_docs/version-v11.0.1/mint.md create mode 100644 modules_versioned_docs/version-v11.0.1/vesting.md create mode 100644 modules_versioned_sidebars/version-v11.0.1-sidebars.json diff --git a/modules_versioned_docs/version-v11.0.1/logic.md b/modules_versioned_docs/version-v11.0.1/logic.md new file mode 100644 index 00000000000..3e64f3b917c --- /dev/null +++ b/modules_versioned_docs/version-v11.0.1/logic.md @@ -0,0 +1,510 @@ +[//]: # (This file is auto-generated. Please do not modify it yourself.) + +# Protobuf Documentation + + + +## 📝 Description + +This module implements a [Prolog](https://en.wikipedia.org/wiki/Prolog) logic interpreter (go-native) and +its [unification](https://en.wikipedia.org/wiki/Unification_(computer_science)) +algorithm to evaluate logical expressions against the current state of the blockchain. + +This distinctive module allows for the creation of advanced, goal-oriented queries and logical systems that can be +applied +to a wide range of use cases, while still maintaining the determinism and predictability of blockchain technology. It +also features a collection of predefined, blockchain-specific predicates that can be used to access information about +the state of the blockchain. + +## Concepts + +### Program + +A program is a text that is parsed and compiled by the interpreter. A program is composed of a set of predicates, which +are defined by the user and can be used to express the desired query logic. + +#### Predicate + +A predicate is a statement that describes a relationship between one or more variables or constants. A predicate +consists of a name followed by zero or more arguments. + +#### Rule & Fact + +A rule is a statement that describes a relationship between one or more variables or constants, similar to a predicate. +However, unlike a predicate, a rule also specifies one or more conditions that must be true in order for the +relationship described by the rule to hold. + +A rule has the following format: + +```prolog +head :- body. +``` + +The symbol `:-` is called the "if-then" operator, and it means that the relationship described in the head of the rule +holds only if the conditions in the body are true. + +For example: + +```prolog +grandfather(X,Y) :- father(X,Z), father(Z,Y). # X is the grandfather of Y if X is the father of Z and Z is the father of Y. +``` + +A fact is a special type of rule that has no body (with no `:-` and no conditions). A fact has the following format: + +```prolog +head. +``` + +For instance: + +```prolog +father(john, mary). # john is the father of mary. +``` + +#### Variable + +A variable is a predicate argument that is used as a placeholder for a value. It can represent any type of data, such as +numbers, strings, or lists. + +Variables are denoted by a name that starts with an uppercase letter, for example `X` or `Foo`. + +For instance: + +```prolog +father(X, mary). # ask for all X that are the father of mary. +``` + +### Query + +A query is a statement used to retrieve information from the blockchain. It can be sent against a program, but this +is optional. The interpreter evaluates the query and returns the result to the caller. Queries can be submitted to a +module using the `Ask` message. + +#### `Ask` + +The `Ask` message is used to submit a query to the module. It has the following format: + +```text +{ + string Program + string Query +} +``` + +The `Program` field is optional. If it is not specified, the query is just evaluated against the current state of the +blockchain. +If it is specified, the query is evaluated against the program that is passed as an argument. + +For instance: + +```text +{ + Program: "father(john, mary)." + Query: "father(X, mary)." +} +``` + +Gives: + +```json +{ + "height": "7235", + "gas_used": "9085", + "answer": { + "has_more": false, + "variables": [ + "X" + ], + "results": [ + { + "substitutions": [ + { + "variable": "X", + "expression": "john" + } + ] + } + ] + } +} +``` + +The logic module supports chain-specific predicates that can be used to query the state of the blockchain. For example, +the `chain_id` predicate can be used to retrieve the chain ID of the current blockchain. Several other predicates are +available, such as `block_height`, `block_time`... Please refer to the go documentation for the full list of available +predicates. + +For instance: + +```prolog +chain_id(X). # ask for the chain ID. +``` + +#### Response + +The response is an object that contains the following fields: + +- `height`: the height of the block at which the query was evaluated. +- `gas_used`: the amount of gas used to evaluate the query. +- `answer`: the result of the query. It is an object that contains the following fields: + - `has_more`: a boolean that indicates whether there are more results to be retrieved. It's just informative since no + more results can be retrieved. + - `variables`: an array of strings that contains the names of the variables that were used in the query. + - `results`: an array of objects that contains the solutions of the query. Each result is an object that contains the + following fields: + - `error`: an optional string that contains an error message if the query failed for the current solution. + - `substitutions`: an array of objects that contains the substitutions that were made to satisfy the query. A + substitution is a set of variable-value pairs that is used to replace variables with constants. A substitution + is the result of unification. A substitution is used to replace variables with constants when evaluating a rule. + +## Performance + +The performance of the logic module is closely tied to the complexity of the query and the size of the program. To +optimize performance, especially in a constrained environment like the blockchain, it is important to minimize the size of the +program. +Keep in mind that he module uses [backtracking](https://en.wikipedia.org/wiki/Backtracking) to search for solutions, +making it most effective when used for queries that are satisfiable. Indeed, if the query is not satisfiable, the module will +attempt to find a solution by [backtracking](https://en.wikipedia.org/wiki/Backtracking) and searching through possible +solutions for an extended period before ultimately being canceled. + +## Gas + +The `Ask` message incurs gas consumption, which is calculated as the sum of the gas used to evaluate each predicate during +the query evaluation process. Each predicate has a fixed gas cost that is based on its complexity. + +While querying the module does not require any fees, the use of gas serves as a mechanism to limit the size and +complexity of the query, ensuring optimal performance and fairness. + +## Security + +The logic module is a deterministic program that is executed in a sandboxed environment and does not have the ability +to submit transactions or make changes to the blockchain's state. It is therefore safe to use. + +To control the cpu and memory usage of the module, the module is limited by several different mechanisms: + +- `max_size`: the maximum size of the program that can be evaluated. +- `max_result_count`: the maximum number of results that can be returned by a query. + +The existing `query-gas-limit` configuration present in the `app.toml` can be used to constraint gas usage when not used +in the context of a transaction. + +Additional limitations are being considered for the future, such as restricting the number of variables that can be +utilized within a query, or limiting the depth of the backtracking algorithm. + +## Table of Contents + +- [logic/v1beta3/params.proto](#logic/v1beta3/params.proto) + - [Filter](#logic.v1beta3.Filter) + - [GasPolicy](#logic.v1beta3.GasPolicy) + - [Interpreter](#logic.v1beta3.Interpreter) + - [Limits](#logic.v1beta3.Limits) + - [Params](#logic.v1beta3.Params) + - [PredicateCost](#logic.v1beta3.PredicateCost) + +- [logic/v1beta3/genesis.proto](#logic/v1beta3/genesis.proto) + - [GenesisState](#logic.v1beta3.GenesisState) + +- [logic/v1beta3/types.proto](#logic/v1beta3/types.proto) + - [Answer](#logic.v1beta3.Answer) + - [Result](#logic.v1beta3.Result) + - [Substitution](#logic.v1beta3.Substitution) + +- [logic/v1beta3/query.proto](#logic/v1beta3/query.proto) + - [QueryServiceAskRequest](#logic.v1beta3.QueryServiceAskRequest) + - [QueryServiceAskResponse](#logic.v1beta3.QueryServiceAskResponse) + - [QueryServiceParamsRequest](#logic.v1beta3.QueryServiceParamsRequest) + - [QueryServiceParamsResponse](#logic.v1beta3.QueryServiceParamsResponse) + + - [QueryService](#logic.v1beta3.QueryService) + +- [logic/v1beta3/tx.proto](#logic/v1beta3/tx.proto) + - [MsgUpdateParams](#logic.v1beta3.MsgUpdateParams) + - [MsgUpdateParamsResponse](#logic.v1beta3.MsgUpdateParamsResponse) + + - [MsgService](#logic.v1beta3.MsgService) + +- [Scalar Value Types](#scalar-value-types) + + +

Top

+ +## logic/v1beta3/params.proto + + + +### Filter + +Filter defines the parameters for filtering the set of strings which can designate anything. +The filter is used to whitelist or blacklist strings. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| `whitelist` | [string](#string) | repeated | whitelist specifies a list of strings that are allowed. If this field is not specified, all strings (in the context of the filter) are allowed. | +| `blacklist` | [string](#string) | repeated | blacklist specifies a list of strings that are excluded from the set of allowed strings. If a string is included in both whitelist and blacklist, it will be excluded. This means that blacklisted strings prevails over whitelisted ones. If this field is not specified, no strings are excluded. | + + + +### GasPolicy + +GasPolicy defines the policy for calculating predicate invocation costs and the resulting gas consumption. +The gas policy is defined as a list of predicates and their associated unit costs, a default unit cost for predicates +if not specified in the list, and a weighting factor that is applied to the unit cost of each predicate to yield. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| `weighting_factor` | [uint64](#uint64) | | WeightingFactor is the factor that is applied to the unit cost of each predicate to yield the gas value. If set to 0, the value considered is 1. | +| `default_predicate_cost` | [uint64](#uint64) | | DefaultPredicateCost is the default unit cost of a predicate when not specified in the PredicateCosts list. If set to 0, the value considered is 1. | +| `predicate_costs` | [PredicateCost](#logic.v1beta3.PredicateCost) | repeated | PredicateCosts is the list of predicates and their associated unit costs. | + + + +### Interpreter + +Interpreter defines the various parameters for the interpreter. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| `predicates_filter` | [Filter](#logic.v1beta3.Filter) | | predicates_filter specifies the filter for the predicates that are allowed to be used by the interpreter. The filter is used to whitelist or blacklist predicates represented as `/[]`, for example: `findall/3`, or `call`. If a predicate name without arity is included in the filter, then all predicates with that name will be considered regardless of arity. For example, if `call` is included in the filter, then all predicates `call/1`, `call/2`, `call/3`... will be allowed. | +| `bootstrap` | [string](#string) | | bootstrap specifies the initial program to run when booting the logic interpreter. If not specified, the default boot sequence will be executed. | +| `virtual_files_filter` | [Filter](#logic.v1beta3.Filter) | | virtual_files_filter specifies the filter for the virtual files that are allowed to be used by the interpreter. The filter is used to whitelist or blacklist virtual files represented as URI, for example: `file:///path/to/file`, `cosmwasm:cw-storage:axone...?query=foo` The filter is applied to the components of the URI, for example: `file:///path/to/file` -> `file`, `/path/to/file` `cosmwasm:cw-storage:axone...?query=foo` -> `cosmwasm`, `cw-storage`, `axone...`, `query=foo` If a component is included in the filter, then all components with that name will be considered, starting from the beginning of the URI. For example, if `file` is included in the filter, then all URIs that start with `file` will be allowed, regardless of the rest of the components. But `file2` will not be allowed. If the component is not included in the filter, then the component is ignored and the next component is considered. | + + + +### Limits + +Limits defines the limits of the logic module. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| `max_size` | [uint64](#uint64) | | max_size specifies the maximum size, in bytes, that is accepted for a program. A value of 0 means that there is no limit on the size of the program. | +| `max_result_count` | [uint64](#uint64) | | max_result_count specifies the maximum number of results that can be requested for a query. A value of 0 means that there is no limit on the number of results. | +| `max_user_output_size` | [uint64](#uint64) | | max_user_output_size specifies the maximum number of bytes to keep in the user output. If the user output exceeds this size, the interpreter will overwrite the oldest bytes with the new ones to keep the size constant. A value of 0 means the user output is disabled. | +| `max_variables` | [uint64](#uint64) | | max_variables specifies the maximum number of variables that can be create by the interpreter. A value of 0 means that there is no limit on the number of variables. | + + + +### Params + +Params defines all the configuration parameters of the "logic" module. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| `interpreter` | [Interpreter](#logic.v1beta3.Interpreter) | | Interpreter specifies the parameter for the logic interpreter. | +| `limits` | [Limits](#logic.v1beta3.Limits) | | Limits defines the limits of the logic module. The limits are used to prevent the interpreter from running for too long. If the interpreter runs for too long, the execution will be aborted. | +| `gas_policy` | [GasPolicy](#logic.v1beta3.GasPolicy) | | GasPolicy defines the parameters for calculating predicate invocation costs. | + + + +### PredicateCost + +PredicateCost defines the unit cost of a predicate during its invocation by the interpreter. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| `predicate` | [string](#string) | | Predicate is the name of the predicate, optionally followed by its arity (e.g. "findall/3"). If no arity is specified, the unit cost is applied to all predicates with the same name. | +| `cost` | [uint64](#uint64) | | Cost is the unit cost of the predicate. If set to 0, the value considered is 1. | + + [//]: # (end messages) + + [//]: # (end enums) + + [//]: # (end HasExtensions) + + [//]: # (end services) + + +

Top

+ +## logic/v1beta3/genesis.proto + + + +### GenesisState + +GenesisState defines the logic module's genesis state. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| `params` | [Params](#logic.v1beta3.Params) | | The state parameters for the logic module. | + + [//]: # (end messages) + + [//]: # (end enums) + + [//]: # (end HasExtensions) + + [//]: # (end services) + + +

Top

+ +## logic/v1beta3/types.proto + + + +### Answer + +Answer represents the answer to a logic query. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| `has_more` | [bool](#bool) | | has_more specifies if there are more solutions than the ones returned. | +| `variables` | [string](#string) | repeated | variables represent all the variables in the query. | +| `results` | [Result](#logic.v1beta3.Result) | repeated | results represent all the results of the query. | + + + +### Result + +Result represents the result of a query. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| `error` | [string](#string) | | error specifies the error message if the query caused an error. | +| `substitutions` | [Substitution](#logic.v1beta3.Substitution) | repeated | substitutions represent all the substitutions made to the variables in the query to obtain the answer. | + + + +### Substitution + +Substitution represents a substitution made to the variables in the query to obtain the answer. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| `variable` | [string](#string) | | variable is the name of the variable. | +| `expression` | [string](#string) | | expression is the value substituted for the variable, represented directly as a Prolog term (e.g., atom, number, compound). | + + [//]: # (end messages) + + [//]: # (end enums) + + [//]: # (end HasExtensions) + + [//]: # (end services) + + +

Top

+ +## logic/v1beta3/query.proto + + + +### QueryServiceAskRequest + +QueryServiceAskRequest is request type for the QueryService/Ask RPC method. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| `program` | [string](#string) | | program is the logic program to be queried. | +| `query` | [string](#string) | | query is the query string to be executed. | +| `limit` | [uint64](#uint64) | | limit specifies the maximum number of solutions to be returned. This field is governed by max_result_count, which defines the upper limit of results that may be requested per query. If this field is not explicitly set, a default value of 1 is applied. | + + + +### QueryServiceAskResponse + +QueryServiceAskResponse is response type for the QueryService/Ask RPC method. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| `height` | [uint64](#uint64) | | height is the block height at which the query was executed. | +| `gas_used` | [uint64](#uint64) | | gas_used is the amount of gas used to execute the query. | +| `answer` | [Answer](#logic.v1beta3.Answer) | | answer is the answer to the query. | +| `user_output` | [string](#string) | | user_output is the output of the query execution, if any. the length of the output is limited by the max_query_output_size parameter. | + + + +### QueryServiceParamsRequest + +QueryServiceParamsRequest is request type for the QueryService/Params RPC method. + + + +### QueryServiceParamsResponse + +QueryServiceParamsResponse is response type for the QueryService/Params RPC method. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| `params` | [Params](#logic.v1beta3.Params) | | params holds all the parameters of this module. | + + [//]: # (end messages) + + [//]: # (end enums) + + [//]: # (end HasExtensions) + + + +### QueryService + +QueryService defines the gRPC querier service. + +| Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint | +| ----------- | ------------ | ------------- | ------------| ------- | -------- | +| `Params` | [QueryServiceParamsRequest](#logic.v1beta3.QueryServiceParamsRequest) | [QueryServiceParamsResponse](#logic.v1beta3.QueryServiceParamsResponse) | Params queries all parameters for the logic module. | GET|/axone-protocol/axoned/logic/params| +| `Ask` | [QueryServiceAskRequest](#logic.v1beta3.QueryServiceAskRequest) | [QueryServiceAskResponse](#logic.v1beta3.QueryServiceAskResponse) | Ask executes a logic query and returns the solutions found. Since the query is without any side-effect, the query is not executed in the context of a transaction and no fee is charged for this, but the execution is constrained by the current limits configured in the module. | GET|/axone-protocol/axoned/logic/ask| + + [//]: # (end services) + + +

Top

+ +## logic/v1beta3/tx.proto + + + +### MsgUpdateParams + +MsgUpdateParams defines a Msg for updating the x/logic module parameters. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| `authority` | [string](#string) | | authority is the address of the governance account. | +| `params` | [Params](#logic.v1beta3.Params) | | params defines the x/logic parameters to update. NOTE: All parameters must be supplied. | + + + +### MsgUpdateParamsResponse + +MsgUpdateParamsResponse defines the response structure for executing a +MsgUpdateParams message. + + [//]: # (end messages) + + [//]: # (end enums) + + [//]: # (end HasExtensions) + + + +### MsgService + +MsgService defines the service for the logic module. +Do nothing for now as the service is without any side effects. + +| Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint | +| ----------- | ------------ | ------------- | ------------| ------- | -------- | +| `UpdateParams` | [MsgUpdateParams](#logic.v1beta3.MsgUpdateParams) | [MsgUpdateParamsResponse](#logic.v1beta3.MsgUpdateParamsResponse) | UpdateParams defined a governance operation for updating the x/logic module parameters. The authority is hard-coded to the Cosmos SDK x/gov module account | | + + [//]: # (end services) + +## 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) | diff --git a/modules_versioned_docs/version-v11.0.1/mint.md b/modules_versioned_docs/version-v11.0.1/mint.md new file mode 100644 index 00000000000..9996738c6b1 --- /dev/null +++ b/modules_versioned_docs/version-v11.0.1/mint.md @@ -0,0 +1,255 @@ +[//]: # (This file is auto-generated. Please do not modify it yourself.) + +# 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 +[AXONE Whitepaper - Token Model](https://docs.axone.xyz/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](#mint/v1beta1/mint.proto) + - [Minter](#mint.v1beta1.Minter) + - [Params](#mint.v1beta1.Params) + +- [mint/v1beta1/genesis.proto](#mint/v1beta1/genesis.proto) + - [GenesisState](#mint.v1beta1.GenesisState) + +- [mint/v1beta1/query.proto](#mint/v1beta1/query.proto) + - [QueryAnnualProvisionsRequest](#mint.v1beta1.QueryAnnualProvisionsRequest) + - [QueryAnnualProvisionsResponse](#mint.v1beta1.QueryAnnualProvisionsResponse) + - [QueryInflationRequest](#mint.v1beta1.QueryInflationRequest) + - [QueryInflationResponse](#mint.v1beta1.QueryInflationResponse) + - [QueryParamsRequest](#mint.v1beta1.QueryParamsRequest) + - [QueryParamsResponse](#mint.v1beta1.QueryParamsResponse) + + - [Query](#mint.v1beta1.Query) + +- [mint/v1beta1/tx.proto](#mint/v1beta1/tx.proto) + - [MsgUpdateParams](#mint.v1beta1.MsgUpdateParams) + - [MsgUpdateParamsResponse](#mint.v1beta1.MsgUpdateParamsResponse) + + - [Msg](#mint.v1beta1.Msg) + +- [Scalar Value Types](#scalar-value-types) + + +

Top

+ +## mint/v1beta1/mint.proto + + + +### Minter + +Minter holds the state of minting within the blockchain. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| `inflation` | [string](#string) | | Current annual inflation rate. | +| `annual_provisions` | [string](#string) | | Current annual anticipated provisions. | + + + +### Params + +Params defines the parameters for the mint module. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| `mint_denom` | [string](#string) | | Denomination of the coin to be minted. | +| `inflation_coef` | [string](#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](#uint64) | | Estimated number of blocks per year. | +| `inflation_max` | [string](#string) | | Maximum annual inflation rate. | +| `inflation_min` | [string](#string) | | Minimum annual inflation rate. | + + [//]: # (end messages) + + [//]: # (end enums) + + [//]: # (end HasExtensions) + + [//]: # (end services) + + +

Top

+ +## mint/v1beta1/genesis.proto + + + +### GenesisState + +GenesisState defines the mint module's genesis state. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| `minter` | [Minter](#mint.v1beta1.Minter) | | minter is a space for holding current inflation information. | +| `params` | [Params](#mint.v1beta1.Params) | | params defines all the parameters of the module. | + + [//]: # (end messages) + + [//]: # (end enums) + + [//]: # (end HasExtensions) + + [//]: # (end services) + + +

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](#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](#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](#mint.v1beta1.Params) | | params defines the parameters of the module. | + + [//]: # (end messages) + + [//]: # (end enums) + + [//]: # (end HasExtensions) + + + +### Query + +Query provides defines the gRPC querier service. + +| Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint | +| ----------- | ------------ | ------------- | ------------| ------- | -------- | +| `Params` | [QueryParamsRequest](#mint.v1beta1.QueryParamsRequest) | [QueryParamsResponse](#mint.v1beta1.QueryParamsResponse) | Params returns the total set of minting parameters. | GET|/cosmos/mint/v1beta1/params| +| `Inflation` | [QueryInflationRequest](#mint.v1beta1.QueryInflationRequest) | [QueryInflationResponse](#mint.v1beta1.QueryInflationResponse) | Inflation returns the current minting inflation value. | GET|/cosmos/mint/v1beta1/inflation| +| `AnnualProvisions` | [QueryAnnualProvisionsRequest](#mint.v1beta1.QueryAnnualProvisionsRequest) | [QueryAnnualProvisionsResponse](#mint.v1beta1.QueryAnnualProvisionsResponse) | AnnualProvisions current minting annual provisions value. | GET|/cosmos/mint/v1beta1/annual_provisions| + + [//]: # (end services) + + +

Top

+ +## mint/v1beta1/tx.proto + + + +### MsgUpdateParams + +MsgUpdateParams is the Msg/UpdateParams request type. + +Since: cosmos-sdk 0.47 + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| `authority` | [string](#string) | | authority is the address that controls the module (defaults to x/gov unless overwritten). | +| `params` | [Params](#mint.v1beta1.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 + + [//]: # (end messages) + + [//]: # (end enums) + + [//]: # (end HasExtensions) + + + +### Msg + +Msg defines the x/mint Msg service. + +| Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint | +| ----------- | ------------ | ------------- | ------------| ------- | -------- | +| `UpdateParams` | [MsgUpdateParams](#mint.v1beta1.MsgUpdateParams) | [MsgUpdateParamsResponse](#mint.v1beta1.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 | | + + [//]: # (end services) + +## 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) | diff --git a/modules_versioned_docs/version-v11.0.1/vesting.md b/modules_versioned_docs/version-v11.0.1/vesting.md new file mode 100644 index 00000000000..ed1c14fd4eb --- /dev/null +++ b/modules_versioned_docs/version-v11.0.1/vesting.md @@ -0,0 +1,273 @@ +[//]: # (This file is auto-generated. Please do not modify it yourself.) + +# Protobuf Documentation + + + +## Table of Contents + +- [vesting/v1beta1/vesting.proto](#vesting/v1beta1/vesting.proto) + - [BaseVestingAccount](#vesting.v1beta1.BaseVestingAccount) + - [CliffVestingAccount](#vesting.v1beta1.CliffVestingAccount) + - [ContinuousVestingAccount](#vesting.v1beta1.ContinuousVestingAccount) + - [DelayedVestingAccount](#vesting.v1beta1.DelayedVestingAccount) + - [Period](#vesting.v1beta1.Period) + - [PeriodicVestingAccount](#vesting.v1beta1.PeriodicVestingAccount) + - [PermanentLockedAccount](#vesting.v1beta1.PermanentLockedAccount) + +- [vesting/v1beta1/tx.proto](#vesting/v1beta1/tx.proto) + - [MsgCreateCliffVestingAccount](#vesting.v1beta1.MsgCreateCliffVestingAccount) + - [MsgCreateCliffVestingAccountResponse](#vesting.v1beta1.MsgCreateCliffVestingAccountResponse) + - [MsgCreatePeriodicVestingAccount](#vesting.v1beta1.MsgCreatePeriodicVestingAccount) + - [MsgCreatePeriodicVestingAccountResponse](#vesting.v1beta1.MsgCreatePeriodicVestingAccountResponse) + - [MsgCreatePermanentLockedAccount](#vesting.v1beta1.MsgCreatePermanentLockedAccount) + - [MsgCreatePermanentLockedAccountResponse](#vesting.v1beta1.MsgCreatePermanentLockedAccountResponse) + - [MsgCreateVestingAccount](#vesting.v1beta1.MsgCreateVestingAccount) + - [MsgCreateVestingAccountResponse](#vesting.v1beta1.MsgCreateVestingAccountResponse) + + - [Msg](#vesting.v1beta1.Msg) + +- [Scalar Value Types](#scalar-value-types) + + +

Top

+ +## vesting/v1beta1/vesting.proto + + + +### BaseVestingAccount + +BaseVestingAccount implements the VestingAccount interface. It contains all +the necessary fields needed for any vesting account implementation. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| `base_account` | [cosmos.auth.v1beta1.BaseAccount](#cosmos.auth.v1beta1.BaseAccount) | | | +| `original_vesting` | [cosmos.base.v1beta1.Coin](#cosmos.base.v1beta1.Coin) | repeated | | +| `delegated_free` | [cosmos.base.v1beta1.Coin](#cosmos.base.v1beta1.Coin) | repeated | | +| `delegated_vesting` | [cosmos.base.v1beta1.Coin](#cosmos.base.v1beta1.Coin) | repeated | | +| `end_time` | [int64](#int64) | | Vesting end time, as unix timestamp (in seconds). | + + + +### CliffVestingAccount + +CliffVestingAccount implements the VestingAccount interface. It +continuously vests by unlocking coins after a cliff period linearly with respect to time. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| `base_vesting_account` | [BaseVestingAccount](#vesting.v1beta1.BaseVestingAccount) | | base_vesting_account implements the VestingAccount interface. It contains all the necessary fields needed for any vesting account implementation | +| `start_time` | [int64](#int64) | | start_time defines the time at which the vesting period begins | +| `cliff_time` | [int64](#int64) | | cliff_time defines the time at which the first portion of the vesting is unlocked | + + + +### ContinuousVestingAccount + +ContinuousVestingAccount implements the VestingAccount interface. It +continuously vests by unlocking coins linearly with respect to time. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| `base_vesting_account` | [BaseVestingAccount](#vesting.v1beta1.BaseVestingAccount) | | | +| `start_time` | [int64](#int64) | | Vesting start time, as unix timestamp (in seconds). | + + + +### DelayedVestingAccount + +DelayedVestingAccount implements the VestingAccount interface. It vests all +coins after a specific time, but non prior. In other words, it keeps them +locked until a specified time. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| `base_vesting_account` | [BaseVestingAccount](#vesting.v1beta1.BaseVestingAccount) | | | + + + +### Period + +Period defines a length of time and amount of coins that will vest. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| `length` | [int64](#int64) | | Period duration in seconds. | +| `amount` | [cosmos.base.v1beta1.Coin](#cosmos.base.v1beta1.Coin) | repeated | | + + + +### PeriodicVestingAccount + +PeriodicVestingAccount implements the VestingAccount interface. It +periodically vests by unlocking coins during each specified period. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| `base_vesting_account` | [BaseVestingAccount](#vesting.v1beta1.BaseVestingAccount) | | | +| `start_time` | [int64](#int64) | | | +| `vesting_periods` | [Period](#vesting.v1beta1.Period) | repeated | | + + + +### PermanentLockedAccount + +PermanentLockedAccount implements the VestingAccount interface. It does +not ever release coins, locking them indefinitely. Coins in this account can +still be used for delegating and for governance votes even while locked. + +Since: cosmos-sdk 0.43 + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| `base_vesting_account` | [BaseVestingAccount](#vesting.v1beta1.BaseVestingAccount) | | | + + [//]: # (end messages) + + [//]: # (end enums) + + [//]: # (end HasExtensions) + + [//]: # (end services) + + +

Top

+ +## vesting/v1beta1/tx.proto + + + +### MsgCreateCliffVestingAccount + +MsgCreateCliffVestingAccount defines a message that enables creating a cliff vesting +account. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| `from_address` | [string](#string) | | | +| `to_address` | [string](#string) | | | +| `amount` | [cosmos.base.v1beta1.Coin](#cosmos.base.v1beta1.Coin) | repeated | | +| `end_time` | [int64](#int64) | | | +| `cliff_time` | [int64](#int64) | | cliff time as unix time (in seconds) is the time at which the first portion of the vesting is unlocked. | + + + +### MsgCreateCliffVestingAccountResponse + +MsgCreateCliffVestingAccountResponse defines the Msg/CreateVestingAccount response type. + + + +### MsgCreatePeriodicVestingAccount + +MsgCreateVestingAccount defines a message that enables creating a vesting +account. + +Since: cosmos-sdk 0.46 + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| `from_address` | [string](#string) | | | +| `to_address` | [string](#string) | | | +| `start_time` | [int64](#int64) | | start of vesting as unix time (in seconds). | +| `vesting_periods` | [Period](#vesting.v1beta1.Period) | repeated | | + + + +### MsgCreatePeriodicVestingAccountResponse + +MsgCreateVestingAccountResponse defines the Msg/CreatePeriodicVestingAccount +response type. + +Since: cosmos-sdk 0.46 + + + +### MsgCreatePermanentLockedAccount + +MsgCreatePermanentLockedAccount defines a message that enables creating a permanent +locked account. + +Since: cosmos-sdk 0.46 + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| `from_address` | [string](#string) | | | +| `to_address` | [string](#string) | | | +| `amount` | [cosmos.base.v1beta1.Coin](#cosmos.base.v1beta1.Coin) | repeated | | + + + +### MsgCreatePermanentLockedAccountResponse + +MsgCreatePermanentLockedAccountResponse defines the Msg/CreatePermanentLockedAccount response type. + +Since: cosmos-sdk 0.46 + + + +### MsgCreateVestingAccount + +MsgCreateVestingAccount defines a message that enables creating a vesting +account. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| `from_address` | [string](#string) | | | +| `to_address` | [string](#string) | | | +| `amount` | [cosmos.base.v1beta1.Coin](#cosmos.base.v1beta1.Coin) | repeated | | +| `end_time` | [int64](#int64) | | end of vesting as unix time (in seconds). | +| `delayed` | [bool](#bool) | | | + + + +### MsgCreateVestingAccountResponse + +MsgCreateVestingAccountResponse defines the Msg/CreateVestingAccount response type. + + [//]: # (end messages) + + [//]: # (end enums) + + [//]: # (end HasExtensions) + + + +### Msg + +Msg defines the bank Msg service. + +| Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint | +| ----------- | ------------ | ------------- | ------------| ------- | -------- | +| `CreateVestingAccount` | [MsgCreateVestingAccount](#vesting.v1beta1.MsgCreateVestingAccount) | [MsgCreateVestingAccountResponse](#vesting.v1beta1.MsgCreateVestingAccountResponse) | CreateVestingAccount defines a method that enables creating a vesting account. | | +| `CreatePermanentLockedAccount` | [MsgCreatePermanentLockedAccount](#vesting.v1beta1.MsgCreatePermanentLockedAccount) | [MsgCreatePermanentLockedAccountResponse](#vesting.v1beta1.MsgCreatePermanentLockedAccountResponse) | CreatePermanentLockedAccount defines a method that enables creating a permanent locked account. + +Since: cosmos-sdk 0.46 | | +| `CreatePeriodicVestingAccount` | [MsgCreatePeriodicVestingAccount](#vesting.v1beta1.MsgCreatePeriodicVestingAccount) | [MsgCreatePeriodicVestingAccountResponse](#vesting.v1beta1.MsgCreatePeriodicVestingAccountResponse) | CreatePeriodicVestingAccount defines a method that enables creating a periodic vesting account. + +Since: cosmos-sdk 0.46 | | +| `CreateCliffVestingAccount` | [MsgCreateCliffVestingAccount](#vesting.v1beta1.MsgCreateCliffVestingAccount) | [MsgCreateCliffVestingAccountResponse](#vesting.v1beta1.MsgCreateCliffVestingAccountResponse) | CreateCliffVestingAccount defines a method that enables creating a cliff vesting account. | | + + [//]: # (end services) + +## 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) | diff --git a/modules_versioned_sidebars/version-v11.0.1-sidebars.json b/modules_versioned_sidebars/version-v11.0.1-sidebars.json new file mode 100644 index 00000000000..cff0c94e170 --- /dev/null +++ b/modules_versioned_sidebars/version-v11.0.1-sidebars.json @@ -0,0 +1,8 @@ +{ + "defaultSidebar": [ + { + "type": "autogenerated", + "dirName": "." + } + ] +} diff --git a/modules_versions.json b/modules_versions.json index b2e8f87c427..7d38b07a78b 100644 --- a/modules_versions.json +++ b/modules_versions.json @@ -1,4 +1,5 @@ [ + "v11.0.1", "v11.0.0", "v10.0.0" ]