This document explains the various protobuf scalars that have been added to make working with protobuf easier for Cosmos SDK application developers
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.
option (cosmos.msg.v1.signer) = "from_address";
The scalar type defines a way for clients to understand how to construct protobuf messages according to what is expected by the module and sdk.
(cosmos_proto.scalar) = "cosmos.AddressString"
Example of account address string scalar:
Example of validator address string scalar:
Example of Decimals scalar:
Example of Int scalar:
There are a few options for what can be provided as a scalar: cosmos.AddressString, cosmos.ValidatorAddressString, cosmos.ConsensusAddressString, cosmos.Int, cosmos.Dec.
Implement interface is used to provide information to client tooling like telescope on how to encode and decode protobuf messages.
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.
Amino annotations are only used for backwards compatibility with amino. New modules are not required use amino annotations.
The below annotations are used to provide information to the amino codec on how to encode and decode protobuf messages in a backwards compatible manner.
Name specifies the amino name that would show up for the user in order for them see which message they are signing.
option (amino.name) = "cosmos-sdk/BaseAccount";
Field name specifies the amino name that would show up for the user in order for them see which field they are signing.
uint64 height = 1 [(amino.field_name) = "public_key"];
Dont omitempty specifies that the field should not be omitted when encoding to amino.
repeated cosmos.base.v1beta1.Coin amount = 3 [(amino.dont_omitempty) = true];
Encoding instructs the amino json marshaler how to encode certain fields that may differ from the standard encoding behaviour. The most common example of this is how
repeated cosmos.base.v1beta1.Coin is encoded when using the amino json encoding format. The
legacy_coins option tells the json marshaler how to encode a null slice of
(amino.encoding) = "legacy_coins",