Skip to content

Commit 0e623d8

Browse files
tac0turtlegithub-actions[bot]
authored andcommitted
chore: Sync docs from cosmos-sdk/docs
1 parent 4845163 commit 0e623d8

21 files changed

+69
-163
lines changed

docs/build/modules/README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,15 @@ proof-of-stake capabilities and governance.
1414

1515
* [Auth](./auth/README.md) - Authentication of accounts and transactions for Cosmos SDK applications.
1616
* [Bank](./bank/README.md) - Token transfer functionalities.
17-
* [Circuit](./circuit/README.md) - Circuit breaker module for pausing messages.
1817
* [Consensus](./consensus/README.md) - Consensus module for modifying CometBFT's ABCI consensus params.
1918
* [Distribution](./distribution/README.md) - Fee distribution, and staking token provision distribution.
20-
* [Evidence](./evidence/README.md) - Evidence handling for double signing, misbehaviour, etc.
2119
* [Governance](./gov/README.md) - On-chain proposals and voting.
2220
* [Genutil](./genutil/README.md) - Genesis utilities for the Cosmos SDK.
2321
* [Mint](./mint/README.md) - Creation of new units of staking token.
2422
* [Slashing](./slashing/README.md) - Validator punishment mechanisms.
2523
* [Staking](./staking/README.md) - Proof-of-Stake layer for public blockchains.
2624
* [Upgrade](./upgrade/README.md) - Software upgrades handling and coordination.
25+
* [Evidence](./evidence/README.md) - Evidence handling for double signing, misbehaviour, etc.
2726

2827
## Supplementary Modules
2928

@@ -38,13 +37,13 @@ capabilities of your blockchain or further specialize it.
3837

3938
## Deprecated Modules
4039

41-
The following modules are deprecated. They will no longer be maintained and eventually will be removed
42-
in an upcoming release of the Cosmos SDK per our [release process](https://github.com/cosmos/cosmos-sdk/blob/main/RELEASE_PROCESS.md).
40+
The following modules are deprecated. They will no longer be maintained actively.
4341

44-
* [Crisis](./crisis/README.md) - _Deprecated_ halting the blockchain under certain circumstances (e.g. if an invariant is broken).
42+
* [Crisis](../contrib/x/crisis/README.md) - _Deprecated_ halting the blockchain under certain circumstances (e.g. if an invariant is broken).
4543
* [Params](./params/README.md) - _Deprecated_ Globally available parameter store.
46-
* [NFT](./nft/README.md) - _Deprecated_ NFT module implemented based on [ADR43](https://docs.cosmos.network/main/build/architecture/adr-043-nft-module). This module will be moved to the `cosmos-sdk-legacy` repo for use.
47-
* [Group](./group/README.md) - _Deprecated_ Allows for the creation and management of on-chain multisig accounts. This module will be moved to the `cosmos-sdk-legacy` repo for legacy use.
44+
* [NFT](../contrib/x/nft/README.md) - _Deprecated_ NFT module implemented based on [ADR43](https://docs.cosmos.network/main/build/architecture/adr-043-nft-module).
45+
* [Group](../contrib/x/group/README.md) - _Deprecated_ Allows for the creation and management of on-chain multisig accounts.
46+
* [Circuit](../contrib/x/circuit/README.md) _Deprecated_ - Circuit breaker module for pausing messages.
4847

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

docs/build/modules/circuit/README.md

Lines changed: 2 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ https://github.com/cosmos/cosmos-sdk/blob/v0.50.1/baseapp/msg_service_router.go#
2121
```
2222

2323
:::note
24-
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.
24+
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 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.
2525
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.
2626
:::
2727

@@ -91,7 +91,7 @@ Reset is called by an authorized account to enable execution for a specific msgU
9191

9292
```protobuf
9393
// ResetCircuitBreaker resumes processing of Msg's in the state machine that
94-
// have been paused using TripCircuitBreaker.
94+
// have been been paused using TripCircuitBreaker.
9595
rpc ResetCircuitBreaker(MsgResetCircuitBreaker) returns (MsgResetCircuitBreakerResponse);
9696
```
9797

@@ -168,92 +168,3 @@ The circuit module emits the following events:
168168
* `DisableListPrefix` - `0x02`
169169

170170
## Client - list and describe CLI commands and gRPC and REST endpoints
171-
172-
## Examples: Using Circuit Breaker CLI Commands
173-
174-
This section provides practical examples for using the Circuit Breaker module through the command-line interface (CLI). These examples demonstrate how to authorize accounts, disable (trip) specific message types, and re-enable (reset) them when needed.
175-
176-
### Querying Circuit Breaker Permissions
177-
178-
Check an account's current circuit breaker permissions:
179-
180-
```bash
181-
# Query permissions for a specific account
182-
<appd> query circuit account-permissions <account_address>
183-
184-
# Example:
185-
simd query circuit account-permissions cosmos1...
186-
```
187-
188-
Check which message types are currently disabled:
189-
190-
```bash
191-
# Query all disabled message types
192-
<appd> query circuit disabled-list
193-
194-
# Example:
195-
simd query circuit disabled-list
196-
```
197-
198-
### Authorizing an Account as Circuit Breaker
199-
200-
Only a super-admin or the module authority (typically the governance module account) can grant circuit breaker permissions to other accounts:
201-
202-
```bash
203-
# Grant LEVEL_ALL_MSGS permission (can disable any message type)
204-
<appd> tx circuit authorize <grantee_address> --level=ALL_MSGS --from=<super_admin_key> --gas=auto --gas-adjustment=1.5
205-
206-
# Grant LEVEL_SOME_MSGS permission (can only disable specific message types)
207-
<appd> tx circuit authorize <grantee_address> --level=SOME_MSGS --limit-type-urls="/cosmos.bank.v1beta1.MsgSend,/cosmos.staking.v1beta1.MsgDelegate" --from=<super_admin_key> --gas=auto --gas-adjustment=1.5
208-
209-
# Grant LEVEL_SUPER_ADMIN permission (can disable messages and authorize other accounts)
210-
<appd> tx circuit authorize <grantee_address> --level=SUPER_ADMIN --from=<super_admin_key> --gas=auto --gas-adjustment=1.5
211-
```
212-
213-
### Disabling Message Processing (Trip)
214-
215-
Disable specific message types to prevent their execution (requires authorization):
216-
217-
```bash
218-
# Disable a single message type
219-
<appd> tx circuit trip --type-urls="/cosmos.bank.v1beta1.MsgSend" --from=<authorized_key> --gas=auto --gas-adjustment=1.5
220-
221-
# Disable multiple message types
222-
<appd> tx circuit trip --type-urls="/cosmos.bank.v1beta1.MsgSend,/cosmos.staking.v1beta1.MsgDelegate" --from=<authorized_key> --gas=auto --gas-adjustment=1.5
223-
224-
# Disable all message types (emergency measure)
225-
<appd> tx circuit trip --from=<authorized_key> --gas=auto --gas-adjustment=1.5
226-
```
227-
228-
### Re-enabling Message Processing (Reset)
229-
230-
Re-enable previously disabled message types (requires authorization):
231-
232-
```bash
233-
# Re-enable a single message type
234-
<appd> tx circuit reset --type-urls="/cosmos.bank.v1beta1.MsgSend" --from=<authorized_key> --gas=auto --gas-adjustment=1.5
235-
236-
# Re-enable multiple message types
237-
<appd> tx circuit reset --type-urls="/cosmos.bank.v1beta1.MsgSend,/cosmos.staking.v1beta1.MsgDelegate" --from=<authorized_key> --gas=auto --gas-adjustment=1.5
238-
239-
# Re-enable all disabled message types
240-
<appd> tx circuit reset --from=<authorized_key> --gas=auto --gas-adjustment=1.5
241-
```
242-
243-
### Usage in Emergency Scenarios
244-
245-
In case of a critical vulnerability in a specific message type:
246-
247-
1. Quickly disable the vulnerable message type:
248-
249-
```bash
250-
<appd> tx circuit trip --type-urls="/cosmos.vulnerable.v1beta1.MsgVulnerable" --from=<authorized_key> --gas=auto --gas-adjustment=1.5
251-
```
252-
253-
2. After a fix is deployed, re-enable the message type:
254-
255-
```bash
256-
<appd> tx circuit reset --type-urls="/cosmos.vulnerable.v1beta1.MsgVulnerable" --from=<authorized_key> --gas=auto --gas-adjustment=1.5
257-
```
258-
259-
This allows chains to surgically disable problematic functionality without halting the entire chain, providing time for developers to implement and deploy fixes.

docs/build/modules/crisis/README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ sidebar_position: 1
44

55
# `x/crisis`
66

7-
NOTE: `x/crisis` is deprecated as of Cosmos SDK v0.53 and will be removed in the next release.
8-
97
## Overview
108

119
The crisis module halts the blockchain under the circumstance that a blockchain
@@ -66,7 +64,7 @@ The crisis module emits the following events:
6664

6765
### Handlers
6866

69-
#### MsgVerifyInvariant
67+
#### MsgVerifyInvariance
7068

7169
| Type | Attribute Key | Attribute Value |
7270
|-----------|---------------|------------------|

docs/build/modules/gov/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2532,7 +2532,7 @@ The gov module has two locations for metadata where users can provide further co
25322532

25332533
### Proposal
25342534

2535-
Location: off-chain as json object stored on IPFS (mirrors [group proposal](../group/README.md#metadata))
2535+
Location: off-chain as json object stored on IPFS (mirrors [group proposal](../../contrib/x/group/README.md#metadata))
25362536

25372537
```json
25382538
{
@@ -2552,7 +2552,7 @@ In v0.46, the `authors` field is a comma-separated string. Frontends are encoura
25522552

25532553
### Vote
25542554

2555-
Location: on-chain as json within 255 character limit (mirrors [group vote](../group/README.md#metadata))
2555+
Location: on-chain as json within 255 character limit (mirrors [group vote](../../contrib/x/group/README.md#metadata))
25562556

25572557
```json
25582558
{

docs/build/modules/group/README.md

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ sidebar_position: 1
44

55
# `x/group`
66

7-
⚠️ **DEPRECATED**: This package is deprecated and will be removed in the next major release. The `x/group` module will be moved to a separate repo `github.com/cosmos/cosmos-sdk-legacy`.
8-
97
## Abstract
108

119
The following documents specify the group module.
@@ -87,7 +85,7 @@ A decision policy is the mechanism by which members of a group can vote on
8785
proposals, as well as the rules that dictate whether a proposal should pass
8886
or not based on its tally outcome.
8987

90-
All decision policies generally would have a minimum execution period and a
88+
All decision policies generally would have a mininum execution period and a
9189
maximum voting window. The minimum execution period is the minimum amount of time
9290
that must pass after submission in order for a proposal to potentially be executed, and it may
9391
be set to 0. The maximum voting window is the maximum time after submission that a proposal may
@@ -103,7 +101,7 @@ custom decision policies, as long as they adhere to the `DecisionPolicy`
103101
interface:
104102

105103
```go reference
106-
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/x/group/types.go#L27-L45
104+
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/x/group/types.go#L27-L45
107105
```
108106

109107
#### Threshold decision policy
@@ -212,7 +210,7 @@ Proposals and votes are automatically pruned to avoid state bloat.
212210
Votes are pruned:
213211

214212
* either after a successful tally, i.e. a tally whose result passes the decision
215-
policy's rules, which can be triggered by a `Msg/Exec` or a
213+
policy's rules, which can be trigged by a `Msg/Exec` or a
216214
`Msg/{SubmitProposal,Vote}` with the `Exec` field set,
217215
* or on `EndBlock` right after the proposal's voting period end. This applies to proposals with status `aborted` or `withdrawn` too.
218216

@@ -339,7 +337,7 @@ The metadata has a maximum length that is chosen by the app developer, and
339337
passed into the group keeper as a config.
340338

341339
```go reference
342-
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/proto/cosmos/group/v1/tx.proto#L67-L80
340+
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/group/v1/tx.proto#L67-L80
343341
```
344342

345343
It's expected to fail if
@@ -352,7 +350,7 @@ It's expected to fail if
352350
Group members can be updated with the `UpdateGroupMembers`.
353351

354352
```go reference
355-
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/proto/cosmos/group/v1/tx.proto#L88-L102
353+
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/group/v1/tx.proto#L88-L102
356354
```
357355

358356
In the list of `MemberUpdates`, an existing member can be removed by setting its weight to 0.
@@ -367,7 +365,7 @@ It's expected to fail if:
367365
The `UpdateGroupAdmin` can be used to update a group admin.
368366

369367
```go reference
370-
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/proto/cosmos/group/v1/tx.proto#L107-L120
368+
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/group/v1/tx.proto#L107-L120
371369
```
372370

373371
It's expected to fail if the signer is not the admin of the group.
@@ -377,7 +375,7 @@ It's expected to fail if the signer is not the admin of the group.
377375
The `UpdateGroupMetadata` can be used to update a group metadata.
378376

379377
```go reference
380-
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/proto/cosmos/group/v1/tx.proto#L125-L138
378+
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/group/v1/tx.proto#L125-L138
381379
```
382380

383381
It's expected to fail if:
@@ -390,7 +388,7 @@ It's expected to fail if:
390388
A new group policy can be created with the `MsgCreateGroupPolicy`, which has an admin address, a group id, a decision policy and some optional metadata.
391389

392390
```go reference
393-
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/proto/cosmos/group/v1/tx.proto#L147-L165
391+
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/group/v1/tx.proto#L147-L165
394392
```
395393

396394
It's expected to fail if:
@@ -404,7 +402,7 @@ It's expected to fail if:
404402
A new group with policy can be created with the `MsgCreateGroupWithPolicy`, which has an admin address, a list of members, a decision policy, a `group_policy_as_admin` field to optionally set group and group policy admin with group policy address and some optional metadata for group and group policy.
405403

406404
```go reference
407-
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/proto/cosmos/group/v1/tx.proto#L191-L215
405+
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/group/v1/tx.proto#L191-L215
408406
```
409407

410408
It's expected to fail for the same reasons as `Msg/CreateGroup` and `Msg/CreateGroupPolicy`.
@@ -414,7 +412,7 @@ It's expected to fail for the same reasons as `Msg/CreateGroup` and `Msg/CreateG
414412
The `UpdateGroupPolicyAdmin` can be used to update a group policy admin.
415413

416414
```go reference
417-
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/proto/cosmos/group/v1/tx.proto#L173-L186
415+
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/group/v1/tx.proto#L173-L186
418416
```
419417

420418
It's expected to fail if the signer is not the admin of the group policy.
@@ -424,7 +422,7 @@ It's expected to fail if the signer is not the admin of the group policy.
424422
The `UpdateGroupPolicyDecisionPolicy` can be used to update a decision policy.
425423

426424
```go reference
427-
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/proto/cosmos/group/v1/tx.proto#L226-L241
425+
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/group/v1/tx.proto#L226-L241
428426
```
429427

430428
It's expected to fail if:
@@ -437,7 +435,7 @@ It's expected to fail if:
437435
The `UpdateGroupPolicyMetadata` can be used to update a group policy metadata.
438436

439437
```go reference
440-
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/proto/cosmos/group/v1/tx.proto#L246-L259
438+
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/group/v1/tx.proto#L246-L259
441439
```
442440

443441
It's expected to fail if:
@@ -451,7 +449,7 @@ A new proposal can be created with the `MsgSubmitProposal`, which has a group po
451449
An optional `Exec` value can be provided to try to execute the proposal immediately after proposal creation. Proposers signatures are considered as yes votes in this case.
452450

453451
```go reference
454-
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/proto/cosmos/group/v1/tx.proto#L281-L315
452+
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/group/v1/tx.proto#L281-L315
455453
```
456454

457455
It's expected to fail if:
@@ -464,7 +462,7 @@ It's expected to fail if:
464462
A proposal can be withdrawn using `MsgWithdrawProposal` which has an `address` (can be either a proposer or the group policy admin) and a `proposal_id` (which has to be withdrawn).
465463

466464
```go reference
467-
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/proto/cosmos/group/v1/tx.proto#L323-L333
465+
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/group/v1/tx.proto#L323-L333
468466
```
469467

470468
It's expected to fail if:
@@ -478,7 +476,7 @@ A new vote can be created with the `MsgVote`, given a proposal id, a voter addre
478476
An optional `Exec` value can be provided to try to execute the proposal immediately after voting.
479477

480478
```go reference
481-
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/proto/cosmos/group/v1/tx.proto#L338-L358
479+
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/group/v1/tx.proto#L338-L358
482480
```
483481

484482
It's expected to fail if:
@@ -491,7 +489,7 @@ It's expected to fail if:
491489
A proposal can be executed with the `MsgExec`.
492490

493491
```go reference
494-
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/proto/cosmos/group/v1/tx.proto#L363-L373
492+
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/group/v1/tx.proto#L363-L373
495493
```
496494

497495
The messages that are part of this proposal won't be executed if:
@@ -504,7 +502,7 @@ The messages that are part of this proposal won't be executed if:
504502
The `MsgLeaveGroup` allows group member to leave a group.
505503

506504
```go reference
507-
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/proto/cosmos/group/v1/tx.proto#L381-L391
505+
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/group/v1/tx.proto#L381-L391
508506
```
509507

510508
It's expected to fail if:

docs/build/modules/nft/README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ sidebar_position: 1
44

55
# `x/nft`
66

7-
⚠️ **DEPRECATED**: This package is deprecated and will be removed in the next major release. The `x/nft` module will be moved to a separate repo `github.com/cosmos/cosmos-sdk-legacy`.
8-
97
## Contents
108

119
## Abstract

0 commit comments

Comments
 (0)