address comments

cosmos · Sep 7, 2023 · 0422b08 · 0422b08
1 parent e8f28bf
commit 0422b08
Show file tree

Hide file tree

Showing 3 changed files with 45 additions and 5 deletions.
diff --git a/docs/docs/build/building-modules/02-messages-and-queries.md b/docs/docs/build/building-modules/02-messages-and-queries.md
@@ -49,7 +49,7 @@ https://github.com/cosmos/cosmos-sdk/blob/9c1e8b247cd47b5d3decda6e86fbc3bc996ee5
 
 In 0.50+ signers from the `GetSigners()` call is automated via a protobuf annotation. 
 
-Read more about the signer field [here](../building-apps/05-protobuf-annotations.md).
+Read more about the signer field [here](./05-protobuf-annotations.md).
 
 ```protobuf reference 
 https://github.com/cosmos/cosmos-sdk/blob/e6848d99b55a65d014375b295bdd7f9641aac95e/proto/cosmos/bank/v1beta1/tx.proto#L40

diff --git a/.../building-apps/05-protobuf-annotations.md → ...ilding-modules/05-protobuf-annotations.md b/.../building-apps/05-protobuf-annotations.md → ...ilding-modules/05-protobuf-annotations.md
@@ -10,7 +10,7 @@ This document explains the various protobuf scalars that have been added to make
 
 Signer specifies which field should be used to determine the signer of a message for the Cosmos SDK. This field can be used for clients as well to infer which field should be used to determine the signer of a message.
 
-Read more about the signer field [here](../building-modules/02-messages-and-queries.md).
+Read more about the signer field [here](./02-messages-and-queries.md).
 
 ```protobuf reference 
 https://github.com/cosmos/cosmos-sdk/blob/e6848d99b55a65d014375b295bdd7f9641aac95e/proto/cosmos/bank/v1beta1/tx.proto#L40
@@ -28,6 +28,30 @@ The scalar type defines a way for clients to understand how to construct protobu
 (cosmos_proto.scalar) = "cosmos.AddressString"
 ```
 
+Example of account address string scalar:
+
+```proto reference 
+https://github.com/cosmos/cosmos-sdk/blob/e6848d99b55a65d014375b295bdd7f9641aac95e/proto/cosmos/bank/v1beta1/tx.proto#L46
+```
+
+Example of validator address string scalar: 
+
+```proto reference 
+https://github.com/cosmos/cosmos-sdk/blob/e8f28bf5db18b8d6b7e0d94b542ce4cf48fed9d6/proto/cosmos/distribution/v1beta1/query.proto#L87
+```
+
+Example of Decimals scalar: 
+
+```proto reference
+https://github.com/cosmos/cosmos-sdk/blob/e8f28bf5db18b8d6b7e0d94b542ce4cf48fed9d6/proto/cosmos/distribution/v1beta1/distribution.proto#L26
+```
+
+Example of Int scalar: 
+
+```proto reference
+https://github.com/cosmos/cosmos-sdk/blob/e8f28bf5db18b8d6b7e0d94b542ce4cf48fed9d6/proto/cosmos/gov/v1/gov.proto#L137
+```
+
 There are a few options for what can be provided as a scalar: cosmos.AddressString, cosmos.ValidatorAddressString, cosmos.ConsensusAddressString, cosmos.Int, cosmos.Dec. 
 
 ## Implements_Interface
@@ -42,7 +66,7 @@ option (cosmos_proto.implements_interface) = "cosmos.auth.v1beta1.AccountI";
 
 The amino codec was removed in 0.50.0, this means there is not a need register `legacyAminoCodec`. To replace the amino codec, Amino protobuf annotations are used to provide information to the amino codec on how to encode and decode protobuf messages. 
 
-:::Note
+:::note
 Amino annotations are only used for backwards compatibility with amino. New modules should not use amino annotations. The 
 :::
 
@@ -56,20 +80,32 @@ Name specifies the amino name that would show up for the user in order for them
 option (amino.name) = "cosmos-sdk/BaseAccount";
 ```
 
+```proto reference
+https://github.com/cosmos/cosmos-sdk/blob/e8f28bf5db18b8d6b7e0d94b542ce4cf48fed9d6/proto/cosmos/bank/v1beta1/tx.proto#L41
+```
+
 ### Field_Name
 
 Field name specifies the amino name that would show up for the user in order for them see which field they are signing.
 
 ```proto
-(amino.field_name) = "public_key"
+uint64 height = 1 [(amino.field_name) = "public_key"];
+```
+
+```proto reference
+https://github.com/cosmos/cosmos-sdk/blob/e8f28bf5db18b8d6b7e0d94b542ce4cf48fed9d6/proto/cosmos/distribution/v1beta1/distribution.proto#L166
 ```
 
 ### Dont_OmitEmpty 
 
 Dont omitempty specifies that the field should not be omitted when encoding to amino. 
 
 ```proto
-(amino.dont_omitempty)   = true,
+repeated cosmos.base.v1beta1.Coin amount = 3 [(amino.dont_omitempty)   = true];
+```
+
+```proto reference
+https://github.com/cosmos/cosmos-sdk/blob/e8f28bf5db18b8d6b7e0d94b542ce4cf48fed9d6/proto/cosmos/bank/v1beta1/bank.proto#L56
 ```
 
 ### Encoding 
@@ -79,3 +115,7 @@ Encoding specifies the amino encoding that should be used when encoding to amino
 ```proto
 (amino.encoding)         = "legacy_coins",
 ```
+
+```proto reference
+https://github.com/cosmos/cosmos-sdk/blob/e8f28bf5db18b8d6b7e0d94b542ce4cf48fed9d6/proto/cosmos/bank/v1beta1/genesis.proto#L23
+```
diff --git a/...uilding-modules/05-beginblock-endblock.md → ...uilding-modules/06-beginblock-endblock.md b/...uilding-modules/05-beginblock-endblock.md → ...uilding-modules/06-beginblock-endblock.md