docs: fix broken link

[seay404]

Description

Closes: #20127

---

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
• confirmed ! in 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
• reviewed "Files changed" and left comments if necessary
• included the necessary unit and integration tests
• added a changelog entry to CHANGELOG.md
• updated the relevant documentation or specification, including comments for documenting Go code
• 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 all author checklist items have been addressed
• reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

• Documentation
  • Corrected the link to ADR-020 in the advanced encoding section.
  • Updated references to ADR-019 and ADR-023 to point to the correct locations.

[coderabbitai]

Walkthrough

Walkthrough

The update primarily addresses broken links within the documentation due to path updates, specifically correcting and updating references to various Architecture Decision Records (ADRs). This includes fixing a link to ADR-020, using Any to encode interfaces in ADR-019, and minor URL adjustments for ADR-023.

Changes

File Path	Change Summary
docs/learn/advanced/...	Corrected link to ADR-020, updated references to ADR-019 and ADR-023, minor URL changes

Assessment against linked issues

Objective	Addressed	Explanation
Fix broken links due to docs path updates in markdown files #20127	✅

Possibly related issues

• [Documentation]: Fix broken links pointing to restructured CometBFT v1 documentation #19904: The changes in this PR do not directly address the issues with CometBFT documentation links, but it indicates an ongoing effort to update and correct documentation links which could be relevant. This issue might benefit from similar attention to detail in fixing links post-documentation restructuring.

---

Recent Review Details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 96c243e and e71c357.

Files selected for processing (1)

• docs/learn/advanced/05-encoding.md (4 hunks)

Additional Context Used

LanguageTool (85)

docs/learn/advanced/05-encoding.md (85)

Near line 8: Possible spelling mistake found.
Context: ... the Cosmos SDK is moving towards using gogoprotobuf for both state and client-side encodin...

---

Near line 25: Possible spelling mistake found.
Context: ...upport, Protocol Buffers, specifically gogoprotobuf,...

---

Near line 31: Possible spelling mistake found.
Context: ...ns and what is ultimately stored in the Merkle tree. For store encoding, protobuf def...

---

Near line 34: Possible spelling mistake found.
Context: ...n the Merkle tree. For store encoding, protobuf definitions can exist for any type and ...

---

Near line 35: Possible spelling mistake found.
Context: ... "intermediary" type. Specifically, the protobuf-based type definition is used for serializati...

---

Near line 39: Possible spelling mistake found.
Context: ... developers should take note to use the protobuf message definitions where possible. In...

---

Near line 41: Possible spelling mistake found.
Context: ...kage, there exists two core interfaces, BinaryCodec and JSONCodec, where the former enca...

---

Near line 41: Possible spelling mistake found.
Context: ... two core interfaces, BinaryCodec and JSONCodec, where the former encapsulates the cur...

---

Near line 45: Possible spelling mistake found.
Context: ...ad of generic interface{} types. The ProtoCodec, where both binary and JSON serializat...

---

Near line 46: Possible spelling mistake found.
Context: ...y and JSON serialization is handled via Protobuf. This means that modules may use Protob...

---

Near line 46: Possible spelling mistake found.
Context: ...otobuf. This means that modules may use Protobuf encoding, but the types must implement ...

---

Near line 47: Possible spelling mistake found.
Context: ... encoding, but the types must implement ProtoMarshaler. If modules wish to avoid implementing...

---

Near line 48: Unpaired symbol: ‘]’ seems to be missing
Context: ... their types, this is autogenerated via buf If modules use...

---

Near line 48: Possible spelling mistake found.
Context: ...their types, this is autogenerated via buf If modules use [C...

---

Near line 50: Possible spelling mistake found.
Context: ...g and decoding are handled, marshal and unmarshal should not be handled manually unless f...

---

Near line 86: Possible spelling mistake found.
Context: ... both these objects can be found in the [auth/tx module](https://docs.cosmos.network/ma...

---

Near line 100: Possible spelling mistake found.
Context: ...erface Encoding and Usage of Any The Protobuf DSL is strongly typed, which can make i...

---

Near line 100: Possible spelling mistake found.
Context: .... Imagine we want to create a Profile protobuf message that serves as a wrapper over [...

---

Near line 111: Possible spelling mistake found.
Context: ...4; } ``` In this Profile example, we hardcoded `account` as a `BaseAccount`. However, ...

---

Near line 111: Possible spelling mistake found.
Context: ...eexample, we hardcodedaccountas aBaseAccount`. However, there are several other type...

---

Near line 111: Possible spelling mistake found.
Context: ...in/build/modules/auth/vesting), such as BaseVestingAccount or ContinuousVestingAccount. All of ...

---

Near line 111: Possible spelling mistake found.
Context: ...sting), such as BaseVestingAccount or ContinuousVestingAccount. All of these accounts are different, ...

---

Near line 111: Possible spelling mistake found.
Context: ...e different, but they all implement the AccountI interface. How would you create a `Pro...

---

Near line 111: Possible missing comma found.
Context: ...Profilethat allows all these types of accounts with anaccount` field that accepts an...

---

Near line 111: Possible spelling mistake found.
Context: ...with an account field that accepts an AccountI interface? ```go reference https://gi...

---

Near line 117: Possible spelling mistake found.
Context: ...buf/any.proto)s to encode interfaces in protobuf. An Any contains an arbitrary seriali...

---

Near line 117: Possible spelling mistake found.
Context: ...ws us to pack arbitrary Go types inside protobuf messages. Our new Profile then looks ...

---

Near line 130: Add a space between sentences.
Context: ... "pack" it inside an Any first, using codectypes.NewAnyWithValue: ```go var myAccount AccountI myAccou...

---

Near line 153: Possible spelling mistake found.
Context: ... convenience, the Cosmos SDK provides a MarshalInterface method to bundle these two steps. Have...

---

Near line 153: In American English, “take a look” is more commonly used.
Context: ...face` method to bundle these two steps. Have a look at [a real-life example in the x/auth m...

---

Near line 171: Possible spelling mistake found.
Context: ...embedding Profile) must implement the UnpackInterfaces method: ```go func (p *Profile) Unpac...

---

Near line 184: Possible spelling mistake found.
Context: ... &account) } return nil } ``` The UnpackInterfaces gets called recursively on all structs...

---

Near line 184: An accent character was used instead of an apostrophe.
Context: ... implementing this method, to allow all Anys to have their GetCachedValue() correc...

---

Near line 186: Possible spelling mistake found.
Context: ...t interface encoding, and especially on UnpackInterfaces and how the Any's type_url gets re...

---

Near line 186: Possible spelling mistake found.
Context: ... UnpackInterfaces and how the Any's type_url gets resolved using the `InterfaceRegi...

---

Near line 186: Possible spelling mistake found.
Context: ...y's type_urlgets resolved using theInterfaceRegistry`, please refer to [ADR-019](../../archi...

---

Near line 192: This sentence does not start with an uppercase letter.
Context: ...everal places (non-exhaustive list): * the cryptotypes.PubKey interface for enco...

---

Near line 192: Add a space between sentences.
Context: ...al places (non-exhaustive list): * the cryptotypes.PubKey interface for encoding different types...

---

Near line 193: Add a space between sentences.
Context: ...g different types of public keys, * the sdk.Msg interface for encoding different Msg...

---

Near line 193: An accent character was used instead of an apostrophe.
Context: ...k.Msginterface for encoding differentMsgs in a transaction, * the AccountI` inte...

---

Near line 194: Possible spelling mistake found.
Context: ...ifferent Msgs in a transaction, * the AccountI interface for encoding different types...

---

Near line 195: Possible spelling mistake found.
Context: ...e) in the x/auth query responses, * the EvidenceI interface for encoding different types...

---

Near line 196: Possible spelling mistake found.
Context: ...idences in the x/evidence module, * the AuthorizationI interface for encoding different types...

---

Near line 196: Possible spelling mistake found.
Context: ...rface for encoding different types of x/authz authorizations, * the [Validator](htt...

---

Near line 199: Possible spelling mistake found.
Context: ...r. A real-life example of encoding the pubkey as Any inside the Validator struct in...

---

Near line 205: Possible spelling mistake found.
Context: .../validator.go#L41-L64 ``` #### Any's TypeURL When packing a protobuf message inside...

---

Near line 207: Possible spelling mistake found.
Context: ... ####Any's TypeURL When packing a protobuf message inside an Any`, the message's ...

---

Near line 207: Possible spelling mistake found.
Context: ...some implementations of Any, like the gogoproto one, there's generally [a resolvable pr...

---

Near line 207: Consider shortening this phrase to avoid wordiness.
Context: ...87-L91). However, in the Cosmos SDK, we made the decision to not include such prefix, to have sho...

---

Near line 209: Possible spelling mistake found.
Context: ... Cosmos SDK is also switching away from gogoproto to the official `google.golang.org/prot...

---

Near line 209: Possible spelling mistake found.
Context: ...ogle.golang.org/protobuf(known as the Protobuf API v2). Its defaultAny` implementati...

---

Near line 215: Add a space between sentences.
Context: ...oto/anyutil", which create an official anypb.Anywithout inserting the prefixes: *an...

---

Near line 220: Add a space between sentences.
Context: ...il.MarshalFrom For example, to pack asdk.MsgcalledinternalMsg`, use: ```diff im...

---

Near line 220: Possible spelling mistake found.
Context: ...For example, to pack a sdk.Msg called internalMsg, use: ```diff import ( - "google.gol...

---

Near line 237: Possible spelling mistake found.
Context: ...## FAQ ### How to create modules using protobuf encoding #### Defining module types P...

---

Near line 240: Possible spelling mistake found.
Context: ...f encoding #### Defining module types Protobuf types can be defined to encode: * stat...

---

Near line 244: Make sure that the single character ‘s’ is correct and is not a typing error.
Context: ... be defined to encode: * state * [Msgs](../../build/building-modules/02-messag...

---

Near line 251: Possible spelling mistake found.
Context: ...e.com/protocol-buffers/docs/style) and Buf, s...

---

Near line 251: Unpaired symbol: ‘]’ seems to be missing
Context: .../docs/style-guide), see more details in [ADR 023](../../architecture/adr-023-prot...

---

Near line 253: Possible spelling mistake found.
Context: ...aming.md) ### How to update modules to protobuf encoding If modules do not contain any...

---

Near line 255: Only proper nouns start with an uppercase character (there are exceptions for headlines).
Context: ...ntain any interfaces (e.g. Account or Content), then they may simply migrate any exi...

---

Near line 257: Possible spelling mistake found.
Context: ...isted via their concrete Amino codec to Protobuf (see 1. for further guidelines) and acc...

---

Near line 257: This sentence does not start with an uppercase letter.
Context: ...oncrete Amino codec to Protobuf (see 1. for further guidelines) and accept a `Marsh...

---

Near line 257: Possible spelling mistake found.
Context: ...1. for further guidelines) and accept a Marshaler as the codec which is implemented via ...

---

Near line 257: Possible spelling mistake found.
Context: ... the codec which is implemented via the ProtoCodec without any further customization. Ho...

---

Near line 260: Add a space between sentences.
Context: ...es an interface, it must wrap it in the sdk.Any (from /types package) type. To do th...

---

Near line 260: Consider a more expressive alternative.
Context: ...k.Any(from/types` package) type. To do that, a module-level .proto file must u...

---

Near line 260: Don’t put a space before the full stop.
Context: ...ackage) type. To do that, a module-level .proto file must use [`google.protobuf.An...

---

Near line 260: Add a space between sentences.
Context: ...at, a module-level .proto file must use [google.protobuf.Any](https://github.com/protocolbuffers/pr...

---

Near line 262: Only proper nouns start with an uppercase character (there are exceptions for headlines).
Context: ..., in the x/evidence module defines an Evidence interface, which is used by the `MsgSu...

---

Near line 262: Possible spelling mistake found.
Context: ...idenceinterface, which is used by theMsgSubmitEvidence. The structure definition must use sd...

---

Near line 262: Add a space between sentences.
Context: ...nce. The structure definition must use sdk.Any` to wrap the evidence file. In the prot...

---

Near line 262: Possible missing comma found.
Context: ...to wrap the evidence file. In the proto file we define it as follows: ```protobuf /...

---

Near line 273: Add a space between sentences.
Context: ...beta1.Evidence"]; } ``` The Cosmos SDK codec.Codec interface provides support methods `Ma...

---

Near line 273: Possible spelling mistake found.
Context: ...decinterface provides support methodsMarshalInterfaceandUnmarshalInterface` to easy encod...

---

Near line 273: Possible spelling mistake found.
Context: ... support methods MarshalInterface and UnmarshalInterface to easy encoding of state to Any. M...

---

Near line 273: The preposition ‘for’ seems more likely in this position.
Context: ...shalInterfaceandUnmarshalInterfaceto easy encoding of state toAny`. Modul...

---

Near line 275: Possible spelling mistake found.
Context: ...Module should register interfaces using InterfaceRegistry which provides a mechanism for registe...

---

Near line 275: Add a space between sentences.
Context: ...a mechanism for registering interfaces: RegisterInterface(protoName string, iface interface{}, impls ...proto.Message) and implementations: `RegisterImpleme...

---

Near line 275: Add a space between sentences.
Context: ......proto.Message)and implementations:RegisterImplementations(iface interface{}, impls ...proto.Message)` that can be safely unpacked from Any,...

---

Near line 281: Possible spelling mistake found.
Context: ...egistry.go#L28-L75 ``` In addition, an UnpackInterfaces phase should be introduced to deserial...

---

Near line 281: Possible spelling mistake found.
Context: ...terfaces` phase should be introduced to deserialization to unpack interfaces before they're nee...

---

Near line 281: Possible spelling mistake found.
Context: ...npack interfaces before they're needed. Protobuf types that contain a protobuf Any eit...

---

Near line 281: Possible spelling mistake found.
Context: ...e needed. Protobuf types that contain a protobuf Any either directly or via one of the...

---

Near line 281: Possible spelling mistake found.
Context: ...e of their members should implement the UnpackInterfacesMessage interface: ```go type UnpackInterface...

Path-based Instructions (1)

docs/learn/advanced/05-encoding.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

Additional comments not posted (3)

docs/learn/advanced/05-encoding.md (3)

96-96: Update the link to ADR-020 to ensure it points to the correct location.

---

117-117: Update the reference to ADR-019 to reflect its new usage of Any for encoding interfaces in protobuf.

---

186-186: Minor changes in URLs for ADR-023 have been made to correct previous errors.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[samricotta]

Thanks!