Skip to content

Commit

Permalink
chore: update documentation from cosmos-sdk/docs (#249)
Browse files Browse the repository at this point in the history
chore: Sync docs from cosmos-sdk/docs

Co-authored-by: tac0turtle <24299864+tac0turtle@users.noreply.github.com>
  • Loading branch information
github-actions[bot] and tac0turtle authored Jan 6, 2025
1 parent 64d1f0d commit 00ae1e4
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 6 deletions.
4 changes: 2 additions & 2 deletions docs/build/architecture/adr-069-gov-improvements.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,8 @@ Voter can only vote NO on the proposal. If the NO threshold is reached, the opti
Two governance parameters will be in added [`v1.Params`][5] to support optimistic proposals:

```protobuf
// optimistic_authorized_addreses is an optional governance parameter that limits the authorized accounts that can submit optimistic proposals
repeated string optimistic_authorized_addreses = 17 [(cosmos_proto.scalar) = "cosmos.AddressString"];
// optimistic_authorized_addresses is an optional governance parameter that limits the authorized accounts that can submit optimistic proposals
repeated string optimistic_authorized_addresses = 17 [(cosmos_proto.scalar) = "cosmos.AddressString"];
// Optimistic rejected threshold defines at which percentage of NO votes, the optimistic proposal should fail and be converted to a standard proposal.
string optimistic_rejected_threshold = 18 [(cosmos_proto.scalar) = "cosmos.Dec"];
Expand Down
4 changes: 3 additions & 1 deletion docs/build/modules/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebar_position: 0

Here are some production-grade modules that can be used in Cosmos SDK applications, along with their respective documentation:

* [Accounts](./accounts/README.md) - Tools and infrastructure for creating advanced smart accounts.
* [Auth](./auth/README.md) - Authentication of accounts and transactions for Cosmos SDK applications.
* [Authz](./authz/README.md) - Authorization for accounts to perform actions on behalf of other accounts.
* [Bank](./bank/README.md) - Token transfer functionalities.
Expand All @@ -18,6 +19,7 @@ Here are some production-grade modules that can be used in Cosmos SDK applicatio
* [Feegrant](./feegrant/README.md) - Grant fee allowances for executing transactions.
* [Genutil](./genutil/README.md) - Genesis utilities for the Cosmos SDK.
* [Governance](./gov/README.md) - On-chain proposals and voting.
* [Group](./group/README.md) - On-chain multisig accounts creation and management.
* [Mint](./mint/README.md) - Creation of new units of staking token.
* [NFT](./nft/README.md) - NFT module implemented based on [ADR43](https://docs.cosmos.network/main/build/architecture/adr-043-nft-module).
* [Params](./params/README.md) - Globally available parameter store.
Expand All @@ -28,7 +30,7 @@ Here are some production-grade modules that can be used in Cosmos SDK applicatio
* [Upgrade](./upgrade/README.md) - Software upgrades handling and coordination.
* [Validate](./validate/README.md) - Global ante/post handlers and tx validator setup.

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/main/build/building-modules/intro).

## IBC

Expand Down
2 changes: 1 addition & 1 deletion docs/build/packages/02-collections.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ Since a module can have multiple collections, the following is expected:
We don't want a collection to write over the state of the other collection so we pass it a prefix, which defines a storage
partition owned by the collection.

If you already built modules, the prefix translates to the items you were creating in your ``types/keys.go`` file, example: https://github.com/cosmos/cosmos-sdk/blob/main/x/feegrant/key.go#L27
If you already built modules, the prefix translates to the items you were creating in your ``types/keys.go`` file, example: https://github.com/cosmos/cosmos-sdk/blob/v0.52.0-rc.1/x/feegrant/key.go#L16~L22

your old:

Expand Down
2 changes: 1 addition & 1 deletion docs/build/rfc/rfc-003-crosslang.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ These bytes can be used by the **state handler** to determine what type of state

A **state token** is an opaque array of 32-bytes that is passed in each message request.
The hypervisor has no knowledge of what this token represents or how it is created,
but it is expected that modules that mange state do understand this token and use it to manage all state changes
but it is expected that modules that manage state do understand this token and use it to manage all state changes
in consistent transactions.
All side effects regarding state, events, etc. are expected to coordinate around the usage of this token.
It is possible that state modules expose methods for creating new **state tokens**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ Since a module can have multiple collections, the following is expected:
We don't want a collection to write over the state of the other collection so we pass it a prefix, which defines a storage
partition owned by the collection.

If you already built modules, the prefix translates to the items you were creating in your ``types/keys.go`` file, example: https://github.com/cosmos/cosmos-sdk/blob/main/x/feegrant/key.go#L27
If you already built modules, the prefix translates to the items you were creating in your ``types/keys.go`` file, example: https://github.com/cosmos/cosmos-sdk/blob/v0.52.0-rc.1/x/feegrant/key.go#L16~L22

your old:

Expand Down

0 comments on commit 00ae1e4

Please sign in to comment.