Skip to content

docs: retarget docs.cosmos.network/main links to sdk/latest #26817

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.

Sign up for GitHub

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

Open
imitater-dou wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: retarget docs.cosmos.network/main links to sdk/latest #26817

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions client/v2/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This document details how to build CLI and REST interfaces for a module. Example

:::note Pre-requisite Readings

* [CLI](https://docs.cosmos.network/main/core/cli)
* [CLI](https://docs.cosmos.network/sdk/latest/learn/concepts/cli-grpc-rest)

:::

Expand Down Expand Up @@ -103,7 +103,7 @@ keyring.NewAutoCLIKeyring(kb)
## Signing

`autocli` supports signing transactions with the keyring.
The [`cosmos.msg.v1.signer` protobuf annotation](https://docs.cosmos.network/main/build/building-modules/protobuf-annotations) defines the signer field of the message.
The [`cosmos.msg.v1.signer` protobuf annotation](https://docs.cosmos.network/sdk/latest/guides/reference/protobuf-annotations) defines the signer field of the message.
This field is automatically filled when using the `--from` flag or defining the signer as a positional argument.

:::warning
Expand Down Expand Up @@ -232,7 +232,7 @@ If not set to true, `AutoCLI` will not generate commands for the module if there

### Skip a command

AutoCLI automatically skips unsupported commands when [`cosmos_proto.method_added_in` protobuf annotation](https://docs.cosmos.network/main/build/building-modules/protobuf-annotations) is present.
AutoCLI automatically skips unsupported commands when [`cosmos_proto.method_added_in` protobuf annotation](https://docs.cosmos.network/sdk/latest/guides/reference/protobuf-annotations) is present.

Additionally, a command can be manually skipped using the `autocliv1.RpcCommandOptions`:

Expand Down
6 changes: 3 additions & 3 deletions contrib/x/circuit/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,20 @@ Circuit Breaker works with the idea that an address or set of addresses have the

The transactions are checked and can be rejected at two points:

* In `CircuitBreakerDecorator` [ante handler](https://docs.cosmos.network/main/learn/advanced/baseapp#antehandler):
* In `CircuitBreakerDecorator` [ante handler](https://docs.cosmos.network/sdk/latest/learn/concepts/baseapp#antehandler):

```go reference
https://github.com/cosmos/cosmos-sdk/blob/x/circuit/v0.1.0/x/circuit/ante/circuit.go#L27-L41
```

* With a [message router check](https://docs.cosmos.network/main/learn/advanced/baseapp#msg-service-router):
* With a [message router check](https://docs.cosmos.network/sdk/latest/learn/concepts/baseapp#msg-service-router):

```go reference
https://github.com/cosmos/cosmos-sdk/blob/v0.50.1/baseapp/msg_service_router.go#L104-L115
```

:::note
The `CircuitBreakerDecorator` works for most use cases, but [does not check the inner messages of a transaction](https://docs.cosmos.network/main/learn/beginner/tx-lifecycle#antehandler). This means some transactions (such as `x/authz` transactions or some `x/gov` transactions) may pass the ante handler. **This does not affect the circuit breaker** as the message router check will still fail the transaction.
The `CircuitBreakerDecorator` works for most use cases, but [does not check the inner messages of a transaction](https://docs.cosmos.network/sdk/latest/learn/concepts/lifecycle#antehandler). This means some transactions (such as `x/authz` transactions or some `x/gov` transactions) may pass the ante handler. **This does not affect the circuit breaker** as the message router check will still fail the transaction.
This tradeoff is to avoid introducing more dependencies in the `x/circuit` module. Chains can re-define the `CircuitBreakerDecorator` to check for inner messages if they wish to do so.
:::

Expand Down
2 changes: 1 addition & 1 deletion docs/spec/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ block.

## Modules specifications

Go to the [module directory](https://docs.cosmos.network/main/modules)
Go to the [module directory](https://docs.cosmos.network/sdk/latest/modules)

## CometBFT

Expand Down
2 changes: 1 addition & 1 deletion tools/cosmovisor/cmd/cosmovisor/help.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ the proposal. Cosmovisor interprets that data to perform an update: switch the c
and restart the App.

Configuration of Cosmovisor is done through environment variables, which are
documented in: https://docs.cosmos.network/main/build/tooling/cosmovisor`,
documented in: https://docs.cosmos.network/sdk/latest/guides/upgrades/cosmovisor`,
cosmovisor.EnvName, cosmovisor.EnvHome,
)
}
4 changes: 2 additions & 2 deletions x/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,11 @@ The following modules are deprecated. They will no longer be maintained activel

* [Crisis](../contrib/x/crisis/README.md) - _Deprecated_ halting the blockchain under certain circumstances (e.g. if an invariant is broken).
* [Params](./params/README.md) - _Deprecated_ Globally available parameter store.
* [NFT](../contrib/x/nft/README.md) - _Deprecated_ NFT module implemented based on [ADR43](https://docs.cosmos.network/main/build/architecture/adr-043-nft-module).
* [NFT](../contrib/x/nft/README.md) - _Deprecated_ NFT module implemented based on [ADR43](https://docs.cosmos.network/sdk/latest/reference/architecture/adr-043-nft-module).
* [Group](../enterprise/group/README.md) - Allows for the creation and management of on-chain multisig accounts (enterprise module).
* [Circuit](../contrib/x/circuit/README.md) _Deprecated_ - Circuit breaker module for pausing messages.

To learn more about the process of building modules, visit the [building modules reference documentation](https://docs.cosmos.network/main/building-modules/intro).
To learn more about the process of building modules, visit the [building modules reference documentation](https://docs.cosmos.network/sdk/latest/learn/concepts/modules).

## IBC

Expand Down
2 changes: 1 addition & 1 deletion x/auth/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ message BaseAccount {

### Vesting Account

See [Vesting](https://docs.cosmos.network/main/modules/auth/vesting/).
See [Vesting](https://docs.cosmos.network/sdk/latest/modules/auth/vesting).

## AnteHandlers

Expand Down
8 changes: 4 additions & 4 deletions x/auth/tx/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ sidebar_position: 1

:::note Pre-requisite Readings

* [Transactions](https://docs.cosmos.network/main/core/transactions#transaction-generation)
* [Encoding](https://docs.cosmos.network/main/core/encoding#transaction-encoding)
* [Transactions](https://docs.cosmos.network/sdk/latest/learn/concepts/transactions#transaction-generation)
* [Encoding](https://docs.cosmos.network/sdk/latest/learn/concepts/encoding#transaction-encoding)

:::

Expand Down Expand Up @@ -50,12 +50,12 @@ https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/x/auth/tx/config.go#L2
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/client/tx_config.go#L33-L50
```

The [`client.TxBuilder`](https://docs.cosmos.network/main/core/transactions#transaction-generation) interface is as well implemented by `x/auth/tx`.
The [`client.TxBuilder`](https://docs.cosmos.network/sdk/latest/learn/concepts/transactions#transaction-generation) interface is as well implemented by `x/auth/tx`.
A `client.TxBuilder` can be accessed with `TxConfig.NewTxBuilder()`.

### `TxEncoder`/ `TxDecoder`

More information about `TxEncoder` and `TxDecoder` can be found [here](https://docs.cosmos.network/main/core/encoding#transaction-encoding).
More information about `TxEncoder` and `TxDecoder` can be found [here](https://docs.cosmos.network/sdk/latest/learn/concepts/encoding#transaction-encoding).

## Client

Expand Down
2 changes: 1 addition & 1 deletion x/genutil/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The genutil commands are available under the `genesis` subcommand.

#### add-genesis-account

Add a genesis account to `genesis.json`. Learn more [here](https://docs.cosmos.network/main/run-node/run-node#adding-genesis-accounts).
Add a genesis account to `genesis.json`. Learn more [here](https://docs.cosmos.network/sdk/latest/node/run-node#adding-genesis-accounts).

#### collect-gentxs

Expand Down
2 changes: 1 addition & 1 deletion x/upgrade/client/cli/tx.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ func NewCmdSubmitUpgradeProposal(ac addresscodec.Codec) *cobra.Command {
Short: "Submit a software upgrade proposal",
Long: "Submit a software upgrade along with an initial deposit.\n" +
"Please specify a unique name and height for the upgrade to take effect.\n" +
"You may include info to reference a binary download link, in a format compatible with: https://docs.cosmos.network/main/tooling/cosmovisor",
"You may include info to reference a binary download link, in a format compatible with: https://docs.cosmos.network/sdk/latest/guides/upgrades/cosmovisor",
RunE: func(cmd *cobra.Command, args []string) error {
clientCtx, err := client.GetClientTxContext(cmd)
if err != nil {
Expand Down
2 changes: 1 addition & 1 deletion x/upgrade/doc.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ Without software support for upgrades, upgrading a live chain is risky because a
their state machines at exactly the same point in the process. If this is not done correctly, there can be state
inconsistencies which are hard to recover from.

For more information, read the documentation on https://docs.cosmos.network/main/modules/upgrade.
For more information, read the documentation on https://docs.cosmos.network/sdk/latest/modules/upgrade.
*/
package upgrade