LaconicNetwork/cosmos-sdk
7
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity

chore: Add "Since:" on proto doc comments (#10434)

Browse Source 
<!--
The default pull request template is for types feat, fix, or refactor.
For other templates, add one of the following parameters to the url:
- template=docs.md
- template=other.md
-->

## Description

ref: https://github.com/cosmos/cosmos-sdk/discussions/10406#discussioncomment-1533289

For clients to know whether a protobuf feature is available for a certain SDK version, we decided to use the [`@since` doc comment](https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html#@since) inside protobuf files.

<!-- Add a description of the changes that this PR introduces and the files that
are the most critical to review. -->

---

### Author Checklist

*All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.*

I have...

- [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] added `!` to the type prefix if API or client breaking change
- [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting))
- [ ] provided a link to the relevant issue or specification
- [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules)
- [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing)
- [ ] added a changelog entry to `CHANGELOG.md`
- [ ] included comments for [documenting Go code](https://blog.golang.org/godoc)
- [ ] updated the relevant documentation or specification
- [ ] reviewed "Files changed" and left comments if necessary
- [ ] confirmed all CI checks have passed

### Reviewers Checklist

*All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.*

I have...

- [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] confirmed `!` in the type prefix if API or client breaking change
- [ ] confirmed all author checklist items have been addressed 
- [ ] reviewed state machine logic
- [ ] reviewed API design and naming
- [ ] reviewed documentation is accurate
- [ ] reviewed tests and test coverage
- [ ] manually tested (if applicable)
This commit is contained in:
Amaury
2021-10-27 14:13:35 +00:00
committed by GitHub
parent d8196920aa
commit 0a3660d2ac
42 changed files with 208 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/core/proto-docs.md
+76 -26
View File
@@ -855,7 +855,9 @@ pagination. Ex:
| `offset` | [uint64](#uint64) | | offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| `limit` | [uint64](#uint64) | | limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| `count_total` | [bool](#bool) | | count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| `reverse` | [bool](#bool) | | reverse is set to true if results are to be returned in the descending order. |
| `reverse` | [bool](#bool) | | reverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43 |
@@ -1020,6 +1022,8 @@ QueryAccountResponse is the response type for the Query/Account RPC method.
### QueryAccountsRequest
QueryAccountsRequest is the request type for the Query/Accounts RPC method.
Since: cosmos-sdk 0.43
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
@@ -1035,6 +1039,8 @@ QueryAccountsRequest is the request type for the Query/Accounts RPC method.
### QueryAccountsResponse
QueryAccountsResponse is the response type for the Query/Accounts RPC method.
Since: cosmos-sdk 0.43
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
@@ -1109,7 +1115,9 @@ Query defines the gRPC querier service.
| Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint |
| ----------- | ------------ | ------------- | ------------| ------- | -------- |
| `Accounts` | [QueryAccountsRequest](#cosmos.auth.v1beta1.QueryAccountsRequest) | [QueryAccountsResponse](#cosmos.auth.v1beta1.QueryAccountsResponse) | Accounts returns all the existing accounts | GET|/cosmos/auth/v1beta1/accounts|
| `Accounts` | [QueryAccountsRequest](#cosmos.auth.v1beta1.QueryAccountsRequest) | [QueryAccountsResponse](#cosmos.auth.v1beta1.QueryAccountsResponse) | Accounts returns all the existing accounts
Since: cosmos-sdk 0.43 | GET|/cosmos/auth/v1beta1/accounts|
| `Account` | [QueryAccountRequest](#cosmos.auth.v1beta1.QueryAccountRequest) | [QueryAccountResponse](#cosmos.auth.v1beta1.QueryAccountResponse) | Account returns account details based on address. | GET|/cosmos/auth/v1beta1/accounts/{address}|
| `Params` | [QueryParamsRequest](#cosmos.auth.v1beta1.QueryParamsRequest) | [QueryParamsResponse](#cosmos.auth.v1beta1.QueryParamsResponse) | Params queries all parameters. | GET|/cosmos/auth/v1beta1/params|
| `ModuleAccounts` | [QueryModuleAccountsRequest](#cosmos.auth.v1beta1.QueryModuleAccountsRequest) | [QueryModuleAccountsResponse](#cosmos.auth.v1beta1.QueryModuleAccountsResponse) | ModuleAccounts returns all the existing module accounts. | GET|/cosmos/auth/v1beta1/module_accounts|
@@ -1125,7 +1133,7 @@ Query defines the gRPC querier service.
<p align="right"><a href="#top">Top</a></p>
## cosmos/authz/v1beta1/authz.proto
Since: cosmos-sdk 0.43
<a name="cosmos.authz.v1beta1.GenericAuthorization"></a>
@@ -1174,7 +1182,7 @@ the provide method with expiration time.
<p align="right"><a href="#top">Top</a></p>
## cosmos/authz/v1beta1/event.proto
Since: cosmos-sdk 0.43
<a name="cosmos.authz.v1beta1.EventGrant"></a>
@@ -1224,7 +1232,7 @@ EventRevoke is emitted on Msg/Revoke
<p align="right"><a href="#top">Top</a></p>
## cosmos/authz/v1beta1/genesis.proto
Since: cosmos-sdk 0.43
<a name="cosmos.authz.v1beta1.GenesisState"></a>
@@ -1273,7 +1281,7 @@ GrantAuthorization defines the GenesisState/GrantAuthorization type.
<p align="right"><a href="#top">Top</a></p>
## cosmos/authz/v1beta1/query.proto
Since: cosmos-sdk 0.43
<a name="cosmos.authz.v1beta1.QueryGranterGrantsRequest"></a>
@@ -1563,7 +1571,7 @@ tags are stringified and the log is JSON decoded.
<p align="right"><a href="#top">Top</a></p>
## cosmos/authz/v1beta1/tx.proto
Since: cosmos-sdk 0.43
<a name="cosmos.authz.v1beta1.MsgExec"></a>
@@ -1773,6 +1781,8 @@ IntProto defines a Protobuf wrapper around an Int object.
SendAuthorization allows the grantee to spend up to spend_limit coins from
the granter's account.
Since: cosmos-sdk 0.43
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
@@ -1846,10 +1856,18 @@ a basic token.
| `denom_units` | [DenomUnit](#cosmos.bank.v1beta1.DenomUnit) | repeated | denom_units represents the list of DenomUnit's for a given coin |
| `base` | [string](#string) | | base represents the base denom (should be the DenomUnit with exponent = 0). |
| `display` | [string](#string) | | display indicates the suggested denom that should be displayed in clients. |
| `name` | [string](#string) | | name defines the name of the token (eg: Cosmos Atom) |
| `symbol` | [string](#string) | | symbol is the token symbol usually shown on exchanges (eg: ATOM). This can be the same as the display. |
| `uri` | [string](#string) | | URI to a document (on or off-chain) that contains additional information. Optional. |
| `uri_hash` | [string](#string) | | URIHash is a sha256 hash of a document pointed by URI. It's used to verify that the document didn't change. Optional. |
| `name` | [string](#string) | | name defines the name of the token (eg: Cosmos Atom)
Since: cosmos-sdk 0.43 |
| `symbol` | [string](#string) | | symbol is the token symbol usually shown on exchanges (eg: ATOM). This can be the same as the display.
Since: cosmos-sdk 0.43 |
| `uri` | [string](#string) | | URI to a document (on or off-chain) that contains additional information. Optional.
Since: cosmos-sdk 0.45 |
| `uri_hash` | [string](#string) | | URIHash is a sha256 hash of a document pointed by URI. It's used to verify that the document didn't change. Optional.
Since: cosmos-sdk 0.45 |
@@ -2232,7 +2250,9 @@ method.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| `pagination` | [cosmos.base.query.v1beta1.PageRequest](#cosmos.base.query.v1beta1.PageRequest) | | pagination defines an optional pagination for the request. |
| `pagination` | [cosmos.base.query.v1beta1.PageRequest](#cosmos.base.query.v1beta1.PageRequest) | | pagination defines an optional pagination for the request.
Since: cosmos-sdk 0.43 |
@@ -2249,7 +2269,9 @@ method
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| `supply` | [cosmos.base.v1beta1.Coin](#cosmos.base.v1beta1.Coin) | repeated | supply is the supply of the coins |
| `pagination` | [cosmos.base.query.v1beta1.PageResponse](#cosmos.base.query.v1beta1.PageResponse) | | pagination defines the pagination in the response. |
| `pagination` | [cosmos.base.query.v1beta1.PageResponse](#cosmos.base.query.v1beta1.PageResponse) | | pagination defines the pagination in the response.
Since: cosmos-sdk 0.43 |
@@ -2497,7 +2519,7 @@ ReflectionService defines a service for interface reflection.
<p align="right"><a href="#top">Top</a></p>
## cosmos/base/reflection/v2alpha1/reflection.proto
Since: cosmos-sdk 0.43
<a name="cosmos.base.reflection.v2alpha1.AppDescriptor"></a>
@@ -3037,6 +3059,8 @@ StoreKVPair is a KVStore KVPair used for listening to state changes (Sets and De
It optionally includes the StoreKey for the originating KVStore and a Boolean flag to distinguish between Sets and
Deletes
Since: cosmos-sdk 0.43
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
@@ -3354,7 +3378,7 @@ VersionInfo is the type for the GetNodeInfoResponse message.
| `build_tags` | [string](#string) | | |
| `go_version` | [string](#string) | | |
| `build_deps` | [Module](#cosmos.base.tendermint.v1beta1.Module) | repeated | |
| `cosmos_sdk_version` | [string](#string) | | |
| `cosmos_sdk_version` | [string](#string) | | Since: cosmos-sdk 0.43 |
@@ -3896,7 +3920,7 @@ This prefix is followed with the x-coordinate.
<p align="right"><a href="#top">Top</a></p>
## cosmos/crypto/secp256r1/keys.proto
Since: cosmos-sdk 0.43
<a name="cosmos.crypto.secp256r1.PrivKey"></a>
@@ -5007,7 +5031,7 @@ Msg defines the evidence Msg service.
<p align="right"><a href="#top">Top</a></p>
## cosmos/feegrant/v1beta1/feegrant.proto
Since: cosmos-sdk 0.43
<a name="cosmos.feegrant.v1beta1.AllowedMsgAllowance"></a>
@@ -5093,7 +5117,7 @@ as well as a limit per time period.
<p align="right"><a href="#top">Top</a></p>
## cosmos/feegrant/v1beta1/genesis.proto
Since: cosmos-sdk 0.43
<a name="cosmos.feegrant.v1beta1.GenesisState"></a>
@@ -5124,7 +5148,7 @@ GenesisState contains a set of fee allowances, persisted from the store
<p align="right"><a href="#top">Top</a></p>
## cosmos/feegrant/v1beta1/query.proto
Since: cosmos-sdk 0.43
<a name="cosmos.feegrant.v1beta1.QueryAllowanceRequest"></a>
@@ -5214,7 +5238,7 @@ Query defines the gRPC querier service.
<p align="right"><a href="#top">Top</a></p>
## cosmos/feegrant/v1beta1/tx.proto
Since: cosmos-sdk 0.43
<a name="cosmos.feegrant.v1beta1.MsgGrantAllowance"></a>
@@ -5450,7 +5474,7 @@ A Vote consists of a proposal ID, the voter, and the vote option.
| `proposal_id` | [uint64](#uint64) | | |
| `voter` | [string](#string) | | |
| `option` | [VoteOption](#cosmos.gov.v1beta1.VoteOption) | | **Deprecated.** Deprecated: Prefer to use `options` instead. This field is set in queries if and only if `len(options) == 1` and that option has weight 1. In all other cases, this field will default to VOTE_OPTION_UNSPECIFIED. |
| `options` | [WeightedVoteOption](#cosmos.gov.v1beta1.WeightedVoteOption) | repeated | |
| `options` | [WeightedVoteOption](#cosmos.gov.v1beta1.WeightedVoteOption) | repeated | Since: cosmos-sdk 0.43 |
@@ -5477,6 +5501,8 @@ VotingParams defines the params for voting on governance proposals.
### WeightedVoteOption
WeightedVoteOption defines a unit of vote for vote split.
Since: cosmos-sdk 0.43
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
@@ -5950,6 +5976,8 @@ MsgVoteResponse defines the Msg/Vote response type.
### MsgVoteWeighted
MsgVoteWeighted defines a message to cast a vote.
Since: cosmos-sdk 0.43
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
@@ -5967,6 +5995,8 @@ MsgVoteWeighted defines a message to cast a vote.
### MsgVoteWeightedResponse
MsgVoteWeightedResponse defines the Msg/VoteWeighted response type.
Since: cosmos-sdk 0.43
@@ -5987,7 +6017,9 @@ Msg defines the bank Msg service.
| ----------- | ------------ | ------------- | ------------| ------- | -------- |
| `SubmitProposal` | [MsgSubmitProposal](#cosmos.gov.v1beta1.MsgSubmitProposal) | [MsgSubmitProposalResponse](#cosmos.gov.v1beta1.MsgSubmitProposalResponse) | SubmitProposal defines a method to create new proposal given a content. | |
| `Vote` | [MsgVote](#cosmos.gov.v1beta1.MsgVote) | [MsgVoteResponse](#cosmos.gov.v1beta1.MsgVoteResponse) | Vote defines a method to add a vote on a specific proposal. | |
| `VoteWeighted` | [MsgVoteWeighted](#cosmos.gov.v1beta1.MsgVoteWeighted) | [MsgVoteWeightedResponse](#cosmos.gov.v1beta1.MsgVoteWeightedResponse) | VoteWeighted defines a method to add a weighted vote on a specific proposal. | |
| `VoteWeighted` | [MsgVoteWeighted](#cosmos.gov.v1beta1.MsgVoteWeighted) | [MsgVoteWeightedResponse](#cosmos.gov.v1beta1.MsgVoteWeightedResponse) | VoteWeighted defines a method to add a weighted vote on a specific proposal.
Since: cosmos-sdk 0.43 | |
| `Deposit` | [MsgDeposit](#cosmos.gov.v1beta1.MsgDeposit) | [MsgDepositResponse](#cosmos.gov.v1beta1.MsgDepositResponse) | Deposit defines a method to add deposit on a specific proposal. | |
<!-- end services -->
@@ -8120,6 +8152,8 @@ Msg defines the slashing Msg service.
### StakeAuthorization
StakeAuthorization defines authorization for delegate/undelegate/redelegate.
Since: cosmos-sdk 0.43
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
@@ -8155,6 +8189,8 @@ Validators defines list of validator addresses.
### AuthorizationType
AuthorizationType defines the type of staking module authorization type
Since: cosmos-sdk 0.43
| Name | Number | Description |
| ---- | ------ | ----------- |
| AUTHORIZATION_TYPE_UNSPECIFIED | 0 | AUTHORIZATION_TYPE_UNSPECIFIED specifies an unknown authorization type |
@@ -9429,7 +9465,9 @@ transaction.
| ----- | ---- | ----- | ----------- |
| `signer_infos` | [SignerInfo](#cosmos.tx.v1beta1.SignerInfo) | repeated | signer_infos defines the signing modes for the required signers. The number and order of elements must match the required signers from TxBody's messages. The first element is the primary signer and the one which pays the fee. |
| `fee` | [Fee](#cosmos.tx.v1beta1.Fee) | | Fee is the fee and gas limit for the transaction. The first signer is the primary signer and the one which pays the fee. The fee can be calculated based on the cost of evaluating the body and doing signature verification of the signers. This can be estimated via simulation. |
| `tip` | [Tip](#cosmos.tx.v1beta1.Tip) | | Tip is the optional tip used for meta-transactions. |
| `tip` | [Tip](#cosmos.tx.v1beta1.Tip) | | Tip is the optional tip used for meta-transactions.
Since: cosmos-sdk 0.45 |
@@ -9762,7 +9800,9 @@ RPC method.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| `tx` | [Tx](#cosmos.tx.v1beta1.Tx) | | **Deprecated.** tx is the transaction to simulate. Deprecated. Send raw tx bytes instead. |
| `tx_bytes` | [bytes](#bytes) | | tx_bytes is the raw transaction. |
| `tx_bytes` | [bytes](#bytes) | | tx_bytes is the raw transaction.
Since: cosmos-sdk 0.43 |
@@ -9864,6 +9904,8 @@ upgrade.
### ModuleVersion
ModuleVersion specifies a module and its consensus version.
Since: cosmos-sdk 0.43
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
@@ -9993,6 +10035,8 @@ method.
QueryModuleVersionsRequest is the request type for the Query/ModuleVersions
RPC method.
Since: cosmos-sdk 0.43
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
@@ -10009,6 +10053,8 @@ RPC method.
QueryModuleVersionsResponse is the response type for the Query/ModuleVersions
RPC method.
Since: cosmos-sdk 0.43
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
@@ -10044,7 +10090,7 @@ RPC method.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| `upgraded_consensus_state` | [bytes](#bytes) | | |
| `upgraded_consensus_state` | [bytes](#bytes) | | Since: cosmos-sdk 0.43 |
@@ -10067,7 +10113,9 @@ Query defines the gRPC upgrade querier service.
| `CurrentPlan` | [QueryCurrentPlanRequest](#cosmos.upgrade.v1beta1.QueryCurrentPlanRequest) | [QueryCurrentPlanResponse](#cosmos.upgrade.v1beta1.QueryCurrentPlanResponse) | CurrentPlan queries the current upgrade plan. | GET|/cosmos/upgrade/v1beta1/current_plan|
| `AppliedPlan` | [QueryAppliedPlanRequest](#cosmos.upgrade.v1beta1.QueryAppliedPlanRequest) | [QueryAppliedPlanResponse](#cosmos.upgrade.v1beta1.QueryAppliedPlanResponse) | AppliedPlan queries a previously applied upgrade plan by its name. | GET|/cosmos/upgrade/v1beta1/applied_plan/{name}|
| `UpgradedConsensusState` | [QueryUpgradedConsensusStateRequest](#cosmos.upgrade.v1beta1.QueryUpgradedConsensusStateRequest) | [QueryUpgradedConsensusStateResponse](#cosmos.upgrade.v1beta1.QueryUpgradedConsensusStateResponse) | UpgradedConsensusState queries the consensus state that will serve as a trusted kernel for the next version of this chain. It will only be stored at the last height of this chain. UpgradedConsensusState RPC not supported with legacy querier This rpc is deprecated now that IBC has its own replacement (https://github.com/cosmos/ibc-go/blob/2c880a22e9f9cc75f62b527ca94aa75ce1106001/proto/ibc/core/client/v1/query.proto#L54) | GET|/cosmos/upgrade/v1beta1/upgraded_consensus_state/{last_height}|
| `ModuleVersions` | [QueryModuleVersionsRequest](#cosmos.upgrade.v1beta1.QueryModuleVersionsRequest) | [QueryModuleVersionsResponse](#cosmos.upgrade.v1beta1.QueryModuleVersionsResponse) | ModuleVersions queries the list of module versions from state. | GET|/cosmos/upgrade/v1beta1/module_versions|
| `ModuleVersions` | [QueryModuleVersionsRequest](#cosmos.upgrade.v1beta1.QueryModuleVersionsRequest) | [QueryModuleVersionsResponse](#cosmos.upgrade.v1beta1.QueryModuleVersionsResponse) | ModuleVersions queries the list of module versions from state.
Since: cosmos-sdk 0.43 | GET|/cosmos/upgrade/v1beta1/module_versions|
<!-- end services -->
@@ -10175,6 +10223,8 @@ 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 |
| ----- | ---- | ----- | ----------- |