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

## Description ref: #10406 (reply in thread) 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.  --- ### 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) (cherry picked from commit 0a3660d) # Conflicts: # docs/core/proto-docs.md # proto/cosmos/bank/v1beta1/bank.proto # proto/cosmos/tx/v1beta1/tx.proto # types/tx/tx.pb.go # x/bank/types/bank.pb.go
cosmos · amaury1093 · Oct 29, 2021 · Oct 27, 2021 · Oct 27, 2021 · Oct 27, 2021
commit 5786f4ff0ba38dce6cc8a481867e4ceacbdef16f
@@ -13,6 +13,8 @@ option go_package = "github.com/cosmos/cosmos-sdk/x/auth/types";
 // Query defines the gRPC querier service.
 service Query {
   // Accounts returns all the existing accounts
+  //
+  // Since: cosmos-sdk 0.43
   rpc Accounts(QueryAccountsRequest) returns (QueryAccountsResponse) {
     option (google.api.http).get = "/cosmos/auth/v1beta1/accounts";
   }
@@ -29,12 +31,16 @@ service Query {
 }
 
 // QueryAccountsRequest is the request type for the Query/Accounts RPC method.
+//
+// Since: cosmos-sdk 0.43
 message QueryAccountsRequest {
   // pagination defines an optional pagination for the request.
   cosmos.base.query.v1beta1.PageRequest pagination = 1;
 }
 
 // QueryAccountsResponse is the response type for the Query/Accounts RPC method.
+//
+// Since: cosmos-sdk 0.43
 message QueryAccountsResponse {
   // accounts are the existing accounts
   repeated google.protobuf.Any accounts = 1 [(cosmos_proto.accepts_interface) = "AccountI"];

@@ -1,3 +1,4 @@
+// Since: cosmos-sdk 0.43
 syntax = "proto3";
 package cosmos.authz.v1beta1;
 

@@ -1,3 +1,4 @@
+// Since: cosmos-sdk 0.43
 syntax = "proto3";
 package cosmos.authz.v1beta1;
 

@@ -1,3 +1,4 @@
+// Since: cosmos-sdk 0.43
 syntax = "proto3";
 package cosmos.authz.v1beta1;
 

@@ -1,3 +1,4 @@
+// Since: cosmos-sdk 0.43
 syntax = "proto3";
 package cosmos.authz.v1beta1;
 

@@ -1,3 +1,4 @@
+// Since: cosmos-sdk 0.43
 syntax = "proto3";
 package cosmos.authz.v1beta1;
 

@@ -9,6 +9,8 @@ option go_package = "github.com/cosmos/cosmos-sdk/x/bank/types";
 
 // SendAuthorization allows the grantee to spend up to spend_limit coins from
 // the granter's account.
+//
+// Since: cosmos-sdk 0.43
 message SendAuthorization {
   option (cosmos_proto.implements_interface) = "Authorization";
 

@@ -85,8 +85,24 @@ message Metadata {
   // displayed in clients.
   string display = 4;
   // name defines the name of the token (eg: Cosmos Atom)
+  //
+  // Since: cosmos-sdk 0.43
   string name = 5;
   // symbol is the token symbol usually shown on exchanges (eg: ATOM). This can
   // be the same as the display.
+  //
+  // Since: cosmos-sdk 0.43
   string symbol = 6;
+<<<<<<< HEAD
+=======
+  // URI to a document (on or off-chain) that contains additional information. Optional.
+  //
+  // Since: cosmos-sdk 0.45
+  string uri = 7 [(gogoproto.customname) = "URI"];
+  // 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
+  string uri_hash = 8 [(gogoproto.customname) = "URIHash"];
+>>>>>>> 0a3660d2a (chore: Add "Since:" on proto doc comments (#10434))
 }
@@ -95,6 +95,8 @@ message QueryTotalSupplyRequest {
   option (gogoproto.goproto_getters) = false;
 
   // pagination defines an optional pagination for the request.
+  //
+  // Since: cosmos-sdk 0.43
   cosmos.base.query.v1beta1.PageRequest pagination = 1;
 }
 
@@ -106,6 +108,8 @@ message QueryTotalSupplyResponse {
       [(gogoproto.nullable) = false, (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.Coins"];
 
   // pagination defines the pagination in the response.
+  //
+  // Since: cosmos-sdk 0.43
   cosmos.base.query.v1beta1.PageResponse pagination = 2;
 }
 

@@ -32,6 +32,8 @@ message PageRequest {
   bool count_total = 4;
 
   // reverse is set to true if results are to be returned in the descending order.
+  //
+  // Since: cosmos-sdk 0.43
   bool reverse = 5;
 }
 

@@ -1,3 +1,4 @@
+// Since: cosmos-sdk 0.43
 syntax = "proto3";
 package cosmos.base.reflection.v2alpha1;
 

@@ -6,6 +6,8 @@ option go_package = "github.com/cosmos/cosmos-sdk/store/types";
 // StoreKVPair is a KVStore KVPair used for listening to state changes (Sets and Deletes)
 // It optionally includes the StoreKey for the originating KVStore and a Boolean flag to distinguish between Sets and
 // Deletes
+//
+// Since: cosmos-sdk 0.43
 message StoreKVPair {
   string store_key = 1; // the store key for the KVStore this pair originates from
   bool delete      = 2; // true indicates a delete operation, false indicates a set operation

@@ -123,6 +123,7 @@ message VersionInfo {
   string          build_tags         = 5;
   string          go_version         = 6;
   repeated Module build_deps         = 7;
+  // Since: cosmos-sdk 0.43
   string          cosmos_sdk_version = 8;
 }
 

@@ -1,3 +1,4 @@
+// Since: cosmos-sdk 0.43
 syntax = "proto3";
 package cosmos.crypto.secp256r1;
 

@@ -1,3 +1,4 @@
+// Since: cosmos-sdk 0.43
 syntax = "proto3";
 package cosmos.feegrant.v1beta1;
 

@@ -1,3 +1,4 @@
+// Since: cosmos-sdk 0.43
 syntax = "proto3";
 package cosmos.feegrant.v1beta1;
 

@@ -1,3 +1,4 @@
+// Since: cosmos-sdk 0.43
 syntax = "proto3";
 package cosmos.feegrant.v1beta1;
 

@@ -1,3 +1,4 @@
+// Since: cosmos-sdk 0.43
 syntax = "proto3";
 package cosmos.feegrant.v1beta1;
 

@@ -30,6 +30,8 @@ enum VoteOption {
 }
 
 // WeightedVoteOption defines a unit of vote for vote split.
+//
+// Since: cosmos-sdk 0.43
 message WeightedVoteOption {
   VoteOption option = 1;
   string     weight = 2 [
@@ -135,6 +137,7 @@ message Vote {
   // 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.
   VoteOption                  option  = 3 [deprecated = true];
+  // Since: cosmos-sdk 0.43
   repeated WeightedVoteOption options = 4 [(gogoproto.nullable) = false];
 }
 

@@ -18,6 +18,8 @@ service Msg {
   rpc Vote(MsgVote) returns (MsgVoteResponse);
 
   // VoteWeighted defines a method to add a weighted vote on a specific proposal.
+  //
+  // Since: cosmos-sdk 0.43
   rpc VoteWeighted(MsgVoteWeighted) returns (MsgVoteWeightedResponse);
 
   // Deposit defines a method to add deposit on a specific proposal.
@@ -62,6 +64,8 @@ message MsgVote {
 message MsgVoteResponse {}
 
 // MsgVoteWeighted defines a message to cast a vote.
+//
+// Since: cosmos-sdk 0.43
 message MsgVoteWeighted {
   option (gogoproto.equal)            = false;
   option (gogoproto.goproto_stringer) = false;
@@ -74,6 +78,8 @@ message MsgVoteWeighted {
 }
 
 // MsgVoteWeightedResponse defines the Msg/VoteWeighted response type.
+//
+// Since: cosmos-sdk 0.43
 message MsgVoteWeightedResponse {}
 
 // MsgDeposit defines a message to submit a deposit to an existing proposal.

@@ -8,6 +8,8 @@ import "cosmos/base/v1beta1/coin.proto";
 option go_package = "github.com/cosmos/cosmos-sdk/x/staking/types";
 
 // StakeAuthorization defines authorization for delegate/undelegate/redelegate.
+//
+// Since: cosmos-sdk 0.43
 message StakeAuthorization {
   option (cosmos_proto.implements_interface) = "Authorization";
 
@@ -31,6 +33,8 @@ message StakeAuthorization {
 }
 
 // AuthorizationType defines the type of staking module authorization type
+//
+// Since: cosmos-sdk 0.43
 enum AuthorizationType {
   // AUTHORIZATION_TYPE_UNSPECIFIED specifies an unknown authorization type
   AUTHORIZATION_TYPE_UNSPECIFIED = 0;

@@ -104,6 +104,8 @@ message SimulateRequest {
   // Deprecated. Send raw tx bytes instead.
   cosmos.tx.v1beta1.Tx tx = 1 [deprecated = true];
   // tx_bytes is the raw transaction.
+  //
+  // Since: cosmos-sdk 0.43
   bytes tx_bytes = 2;
 }
 

diff --git a/proto/cosmos/tx/v1beta1/tx.proto b/proto/cosmos/tx/v1beta1/tx.proto
@@ -108,6 +108,14 @@ message AuthInfo {
   // based on the cost of evaluating the body and doing signature verification
   // of the signers. This can be estimated via simulation.
   Fee fee = 2;
+<<<<<<< HEAD
+=======
+
+  // Tip is the optional tip used for meta-transactions.
+  //
+  // Since: cosmos-sdk 0.45
+  Tip tip = 3;
+>>>>>>> 0a3660d2a (chore: Add "Since:" on proto doc comments (#10434))
 }
 
 // SignerInfo describes the public key and signing mode of a single top-level

@@ -31,6 +31,8 @@ service Query {
   }
 
   // ModuleVersions queries the list of module versions from state.
+  //
+  // Since: cosmos-sdk 0.43
   rpc ModuleVersions(QueryModuleVersionsRequest) returns (QueryModuleVersionsResponse) {
     option (google.api.http).get = "/cosmos/upgrade/v1beta1/module_versions";
   }
@@ -77,11 +79,14 @@ message QueryUpgradedConsensusStateResponse {
   option deprecated = true;
   reserved 1;
 
+  // Since: cosmos-sdk 0.43
   bytes upgraded_consensus_state = 2;
 }
 
 // QueryModuleVersionsRequest is the request type for the Query/ModuleVersions
 // RPC method.
+//
+// Since: cosmos-sdk 0.43
 message QueryModuleVersionsRequest {
   // module_name is a field to query a specific module
   // consensus version from state. Leaving this empty will
@@ -91,6 +96,8 @@ message QueryModuleVersionsRequest {
 
 // QueryModuleVersionsResponse is the response type for the Query/ModuleVersions
 // RPC method.
+//
+// Since: cosmos-sdk 0.43
 message QueryModuleVersionsResponse {
   // module_versions is a list of module names with their consensus versions.
   repeated ModuleVersion module_versions = 1;

@@ -64,6 +64,8 @@ message CancelSoftwareUpgradeProposal {
 }
 
 // ModuleVersion specifies a module and its consensus version.
+//
+// Since: cosmos-sdk 0.43
 message ModuleVersion {
   option (gogoproto.equal)            = true;
   option (gogoproto.goproto_stringer) = true;

@@ -75,6 +75,8 @@ message PeriodicVestingAccount {
 // 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
 message PermanentLockedAccount {
   option (gogoproto.goproto_getters)  = false;
   option (gogoproto.goproto_stringer) = false;

diff --git a/types/tx/tx.pb.go b/types/tx/tx.pb.go