docs: add docs on proto annotations

[tac0turtle]

Description

ref: #14682

this pr describes various protobuf annotations that have been added over time to make working with protobuf easier for application developers

---

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 in the PR title
• added ! to the type prefix if API or client breaking change
• targeted the correct branch (see PR Targeting)
• provided a link to the relevant issue or specification
• followed the guidelines for building modules
• included the necessary unit and integration tests
• added a changelog entry to CHANGELOG.md
• included comments for documenting Go code
• 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 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)

[aaronc]

Just a note to also describe AddressBytes, ValidatorAddressString/Bytes and ConsensusAddressString/Bytes. Basically we want to cover all of what is in the global config and sdk.{Acc/Val/Cons}Address

[tac0turtle]

Closing due to inactivity. I will pick this up after abci++ is merged

[julienrbrt]

Typo here.

[julienrbrt]

Can we maybe give an example? It is quite important that the scalar annotations are correct for the addresses as AutoCLI relies on it (otherwise it will just be considered as a string without any validation)

[tac0turtle]

i think you should assume it wont be correct and/or they wont be implemented at all. I can add it but we shouldnt assume its used

[julienrbrt]

I feel like it is the role of developer removing their CLI for AutoCLI to verify the annotation. Hence I thought a small mention was useful.

However, AutoCLI will still work without it. Addresses will simply not be verified (if you have an annotation there will be a field verification that you input a valid address).

[tac0turtle]

for sure, added it. It will be hard to get people to adopt this. Many times with proto its write once and forget till you need a change. Adding annotations will be harder to for people to integrate

[julienrbrt]

It should be more in building modules imho.

[julienrbrt]

lgtm