Require cosmos.msg.v1 annotations

[aaronc]

Summary

Require valid cosmos.msg.v1.signer and cosmos.msg.v1.service annotations so that dynamic clients can rely on them.

Problem Definition

In #10977, @fdymylja added the cosmos.msg.v1.signer proto option but had to remove the logic which makes the field required (#10977 (comment)) because of some complexities with the gogo proto global registry and the work was never finished.

In #13178, the cosmos.msg.v1.service option was added which allows clients to dynamically distinguish Msg and Query services.

If we can ensure that these options are consistently applied, then clients will know:

• which fields of a Msg need to be signed
• which services are used to make transactions and which are used for queries

These .proto options can be leveraged in the future by the Cosmos SDK framework itself in order to simplify service registration and ADR 033 clients as described in #12972. Also the sdk.Msg type itself can be simplified with cosmos.msg.v1.signer which will allow Msg.GetSigners to be removed and take us much closer to removing bech32 globals (#9690).

Proposal

Implement validation logic that runs when Msg services are registered that:

• checks that all sdk.Msg types have a valid cosmos.msg.v1.signer annotation
• checks that all Msg services are annotated with cosmos.msg.v1.service

We can access the full gogo proto registry with the functionality add to our fork in cosmos/gogoproto#13. The original validation work that had been started in #10977 can be found at https://github.com/cosmos/cosmos-sdk/blob/7e0c199b61349f226cdbabf4b1cfcabc911390ff/types/module/assert_signers.go.

[amaury1093]

We can make this issue as the whole "cosmos.msg.v1" validation issue, which means also adding validation for the newyl added Amino annotations too #13407, ref #13501 (review)

I can work on a PR that does all validations at once.

[aaronc]

We can make this issue as the whole "cosmos.msg.v1" validation issue, which means also adding validation for the newyl added Amino annotations too #13407, ref #13501 (review)

I can work on a PR that does all validations at once.

Great thank you 🙏

[aaronc]

Can we validate that amino annotations match what's registered in the amino codec and struct field tags? That would be great because it will allow easy, clean deprecation of amino registration soon

[amaury1093]

That's what I'd like to explore too. The validation will start from the pulsar types, to be able to read annotations easily. The challenge is to get the associated gogo generated reflect.Type, which is used by go-amino's registry. Probably there's a way to do this by going throuhg our interfaceRegistry.

[amaury1093]

I'll actually down-scope this issue to only tackle cosmos.msg.v1.signer and cosmos.msg.v1.service, as initially written in the first post, because they are easier.

I created another issue for the amino.name annotations #14682.