-
Notifications
You must be signed in to change notification settings - Fork 3.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore: Fix all broken links #20204
chore: Fix all broken links #20204
Changes from all commits
ac93610
1ad41a6
5cdc741
9604ce3
8fc839d
912618b
d1a5064
99dfbf3
1325913
620a68f
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -7,13 +7,13 @@ sidebar_position: 1 | |||||
:::note Synopsis | ||||||
|
||||||
The Cosmos SDK allows much easier wiring of an `app.go` thanks to App Wiring and [`depinject`](../packages/01-depinject.md). | ||||||
Learn more about the rationale of App Wiring in [ADR-057](../architecture/adr-057-app-wiring.md). | ||||||
Learn more about the rationale of App Wiring in [ADR-057](../../architecture/adr-057-app-wiring.md). | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ensure consistency in the documentation of ADR-057. - Learn more about the rationale of App Wiring in [ADR-057](../../architecture/adr-057-app-wiring.md).
+ Learn more about the rationale of App Wiring in [ADR-057](../../architecture/adr-057-app-wiring.md). Committable suggestion
Suggested change
|
||||||
|
||||||
::: | ||||||
|
||||||
:::note Pre-requisite Readings | ||||||
|
||||||
* [ADR 057: App Wiring](../architecture/adr-057-app-wiring.md) | ||||||
* [ADR 057: App Wiring](../../architecture/adr-057-app-wiring.md) | ||||||
* [Depinject Documentation](../packages/01-depinject.md) | ||||||
* [Modules depinject-ready](../building-modules/15-depinject.md) | ||||||
|
||||||
|
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -19,7 +19,7 @@ A Protobuf `Msg` service processes [messages](./02-messages-and-queries.md#messa | |||||
|
||||||
Each module should define a Protobuf `Msg` service, which will be responsible for processing requests (implementing `sdk.Msg`) and returning responses. | ||||||
|
||||||
As further described in [ADR 031](../architecture/adr-031-msg-service.md), this approach has the advantage of clearly specifying return types and generating server and client code. | ||||||
As further described in [ADR 031](../../architecture/adr-031-msg-service.md), this approach has the advantage of clearly specifying return types and generating server and client code. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Clarify the documentation on ADR 031. - As further described in [ADR 031](../../architecture/adr-031-msg-service.md), this approach has the advantage of clearly specifying return types and generating server and client code.
+ As further described in [ADR 031](../../architecture/adr-031-msg-service.md), this approach has the advantage of clearly specifying return types and generating server and client code. Committable suggestion
Suggested change
|
||||||
|
||||||
Protobuf generates a `MsgServer` interface based on a definition of `Msg` service. It is the role of the module developer to implement this interface, by implementing the state transition logic that should happen upon receival of each `sdk.Msg`. As an example, here is the generated `MsgServer` interface for `x/bank`, which exposes two `sdk.Msg`s: | ||||||
|
||||||
|
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -83,7 +83,7 @@ x/{module_name} | |||||
* `abci.go`: The module's `BeginBlocker` and `EndBlocker` implementations (this file is only required if `BeginBlocker` and/or `EndBlocker` need to be defined). | ||||||
* `autocli.go`: The module [autocli](https://docs.cosmos.network/main/core/autocli) options. | ||||||
* `simulation/`: The module's [simulation](./14-simulator.md) package defines functions used by the blockchain simulator application (`simapp`). | ||||||
* `README.md`: The module's specification documents outlining important concepts, state storage structure, and message and event type definitions. Learn more how to write module specs in the [spec guidelines](../spec/SPEC_MODULE.md). | ||||||
* `README.md`: The module's specification documents outlining important concepts, state storage structure, and message and event type definitions. Learn more how to write module specs in the [spec guidelines](../../spec/SPEC_MODULE.md). | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Update the link to point to the correct location. - Learn more how to write module specs in the [spec guidelines](../../spec/SPEC_MODULE.md).
+ Learn more about how to write module specs in the [spec guidelines](../../spec/SPEC_MODULE.md). Committable suggestion
Suggested change
|
||||||
* The root directory includes type definitions for messages, events, and genesis state, including the type definitions generated by Protocol Buffers. | ||||||
* `codec.go`: The module's registry methods for interface types. | ||||||
* `errors.go`: The module's sentinel errors. | ||||||
|
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -62,4 +62,4 @@ func (m Migrator) Migrate1to2(ctx sdk.Context) error { | |||||
} | ||||||
``` | ||||||
|
||||||
To see example code of changes that were implemented in a migration of balance keys, check out [migrateBalanceKeys](https://github.com/cosmos/cosmos-sdk/blob/v0.50.0-alpha.0/x/bank/migrations/v2/store.go#L55-L76). For context, this code introduced migrations of the bank store that updated addresses to be prefixed by their length in bytes as outlined in [ADR-028](../architecture/adr-028-public-key-addresses.md). | ||||||
To see example code of changes that were implemented in a migration of balance keys, check out [migrateBalanceKeys](https://github.com/cosmos/cosmos-sdk/blob/v0.50.0-alpha.0/x/bank/migrations/v2/store.go#L55-L76). For context, this code introduced migrations of the bank store that updated addresses to be prefixed by their length in bytes as outlined in [ADR-028](../../architecture/adr-028-public-key-addresses.md). | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Correct the spelling mistake in the link text. - To see example code of changes that were implemented in a migration of balance keys, check out [migrateBalanceKeys](https://github.com/cosmos/cosmos-sdk/blob/v0.50.0-alpha.0/x/bank/migrations/v2/store.go#L55-L76).
+ To see example code of changes that were implemented in a migration of balance keys, check out [migrateBalanceKeys](https://github.com/cosmos/cosmos-sdk/blob/v0.50.0-alpha.0/x/bank/migrations/v2/store.go#L55-L76). Committable suggestion
Suggested change
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -32,7 +32,7 @@ This module is used in the Cosmos Hub. | |
|
||
## Concepts | ||
|
||
**Note:** The auth module is different from the [authz module](../modules/authz/). | ||
**Note:** The auth module is different from the [authz module](../authz/). | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Consider enhancing the description of the Would you like me to draft a more detailed description for these modules? |
||
|
||
The differences are: | ||
|
||
|
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -40,7 +40,7 @@ on behalf of one account to other accounts. The design is defined in the [ADR 03 | |||||
A *grant* is an allowance to execute a Msg by the grantee on behalf of the granter. | ||||||
Authorization is an interface that must be implemented by a concrete authorization logic to validate and execute grants. Authorizations are extensible and can be defined for any Msg service method even outside of the module where the Msg method is defined. See the `SendAuthorization` example in the next section for more details. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Consider simplifying the phrase to avoid redundancy. - even outside of the module where the Msg method is defined
+ outside the module where the Msg method is defined Committable suggestion
Suggested change
|
||||||
|
||||||
**Note:** The authz module is different from the [auth (authentication)](../modules/auth/) module that is responsible for specifying the base transaction and account types. | ||||||
**Note:** The authz module is different from the [auth (authentication)](../auth/) module that is responsible for specifying the base transaction and account types. | ||||||
|
||||||
```go reference | ||||||
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/x/authz/authorizations.go#L11-L25 | ||||||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Update the location of
coin.ParseCoin
to reflect the PR description accurately.Committable suggestion