Skip to content

Commit

Permalink
docs: unify app wiring documentation (#12340)
Browse files Browse the repository at this point in the history
  • Loading branch information
julienrbrt authored Jun 29, 2022
1 parent 353b356 commit 1194321
Show file tree
Hide file tree
Showing 13 changed files with 49 additions and 40 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Ref: https://keepachangelog.com/en/1.0.0/

### API Breaking Changes

* (simapp) [#XXXXX](https://github.com/cosmos/cosmos-sdk/pull/XXXXX) Move `simapp.ConvertAddrsToValAddrs` and `simapp.CreateTestPubKeys ` to respectively `simtestutil.ConvertAddrsToValAddrs` and `simtestutil.CreateTestPubKeys` (`testutil/sims`)
* (simapp) [#12334](https://github.com/cosmos/cosmos-sdk/pull/12334) Move `simapp.ConvertAddrsToValAddrs` and `simapp.CreateTestPubKeys ` to respectively `simtestutil.ConvertAddrsToValAddrs` and `simtestutil.CreateTestPubKeys` (`testutil/sims`)
* (simapp) [#12312](https://github.com/cosmos/cosmos-sdk/pull/12312) Move `simapp.EmptyAppOptions` to `simtestutil.EmptyAppOptions` (`testutil/sims`)
* (simapp) [#12312](https://github.com/cosmos/cosmos-sdk/pull/12312) Remove `skipUpgradeHeights map[int64]bool` and `homePath string` from `NewSimApp` constructor as per migration of `x/upgrade` to app-wiring.
* (testutil) [#12278](https://github.com/cosmos/cosmos-sdk/pull/12278) Move all functions from `simapp/helpers` to `testutil/sims`
Expand Down
6 changes: 0 additions & 6 deletions x/evidence/spec/01_concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,3 @@ by the `Handler` should be persisted.
// slashing and potential jailing.
type Handler func(sdk.Context, Evidence) error
```

## App Wiring

The minimal app-wiring configuration for `x/evidence` is as follows:

+++ https://github.com/cosmos/cosmos-sdk/blob/main/x/evidence/testutil/app.yaml
5 changes: 5 additions & 0 deletions x/evidence/spec/08_app_wiring.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# App Wiring

The minimal app-wiring configuration for `x/evidence` is as follows:

+++ https://github.com/cosmos/cosmos-sdk/blob/main/x/evidence/testutil/app.yaml
5 changes: 5 additions & 0 deletions x/group/spec/06_app_wiring.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# App Wiring

The minimal app-wiring configuration for `x/group` is as follows:

+++ https://github.com/cosmos/cosmos-sdk/blob/main/x/group/testutil/app.yaml
41 changes: 21 additions & 20 deletions x/group/spec/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,33 +16,33 @@ This module allows the creation and management of on-chain multisig accounts and
## Contents

1. **[Concepts](01_concepts.md)**
- [Group](01_concepts.md#group)
- [Group Policy](01_concepts.md#group-policy)
- [Group With Policy](01_concepts.md#group-with-policy)
- [Decision Policy](01_concepts.md#decision-policy)
- [Proposal](01_concepts.md#proposal)
- [Voting](01_concepts.md#voting)
- [Executing Proposals](01_concepts.md#executing-proposals)
* [Group](01_concepts.md#group)
* [Group Policy](01_concepts.md#group-policy)
* [Group With Policy](01_concepts.md#group-with-policy)
* [Decision Policy](01_concepts.md#decision-policy)
* [Proposal](01_concepts.md#proposal)
* [Voting](01_concepts.md#voting)
* [Executing Proposals](01_concepts.md#executing-proposals)
2. **[State](02_state.md)**
* [Group Table](02_state.md#group-table)
* [Group Member Table](02_state.md#group-member-table)
* [Group Policy Table](02_state.md#group-policy-table)
* [Proposal](02_state.md#proposal-table)
* [Vote Table](02_state.md#vote-table)
3. **[Msg Service](03_messages.md)**
- [Msg/CreateGroup](03_messages.md#msgcreategroup)
- [Msg/UpdateGroupMembers](03_messages.md#msgupdategroupmembers)
- [Msg/UpdateGroupAdmin](03_messages.md#msgupdategroupadmin)
- [Msg/UpdateGroupMetadata](03_messages.md#msgupdategroupmetadata)
- [Msg/CreateGroupPolicy](03_messages.md#msgcreategrouppolicy)
- [Msg/CreateGroupWithPolicy](03_messages.md#msgcreategroupwithpolicy)
- [Msg/UpdateGroupPolicyAdmin](03_messages.md#msgupdategrouppolicyadmin)
- [Msg/UpdateGroupPolicyDecisionPolicy](03_messages.md#msgupdategrouppolicydecisionpolicy)
- [Msg/UpdateGroupPolicyMetadata](03_messages.md#msgupdategrouppolicymetadata)
- [Msg/CreateProposal](03_messages.md#msgcreateproposal)
- [Msg/WithdrawProposal](03_messages.md#msgwithdrawproposal)
- [Msg/Vote](03_messages.md#msgvote)
- [Msg/Exec](03_messages.md#msgexec)
* [Msg/CreateGroup](03_messages.md#msgcreategroup)
* [Msg/UpdateGroupMembers](03_messages.md#msgupdategroupmembers)
* [Msg/UpdateGroupAdmin](03_messages.md#msgupdategroupadmin)
* [Msg/UpdateGroupMetadata](03_messages.md#msgupdategroupmetadata)
* [Msg/CreateGroupPolicy](03_messages.md#msgcreategrouppolicy)
* [Msg/CreateGroupWithPolicy](03_messages.md#msgcreategroupwithpolicy)
* [Msg/UpdateGroupPolicyAdmin](03_messages.md#msgupdategrouppolicyadmin)
* [Msg/UpdateGroupPolicyDecisionPolicy](03_messages.md#msgupdategrouppolicydecisionpolicy)
* [Msg/UpdateGroupPolicyMetadata](03_messages.md#msgupdategrouppolicymetadata)
* [Msg/CreateProposal](03_messages.md#msgcreateproposal)
* [Msg/WithdrawProposal](03_messages.md#msgwithdrawproposal)
* [Msg/Vote](03_messages.md#msgvote)
* [Msg/Exec](03_messages.md#msgexec)
4. **[Events](04_events.md)**
* [EventCreateGroup](04_events.md#eventcreategroup)
* [EventUpdateGroup](04_events.md#eventupdategroup)
Expand All @@ -56,3 +56,4 @@ This module allows the creation and management of on-chain multisig accounts and
* [CLI](05_client.md#cli)
* [gRPC](05_client.md#grpc)
* [REST](05_client.md#rest)
6. **[App Wiring](06_app_wiring.md)**
6 changes: 0 additions & 6 deletions x/mint/spec/01_concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,3 @@ It can be broken down in the following way:
rate will stay constant
* If the inflation rate is above the goal %-bonded the inflation rate will
decrease until a minimum value is reached

## App Wiring

The minimal app-wiring configuration for `x/mint` is as follows:

+++ https://github.com/cosmos/cosmos-sdk/blob/main/x/mint/testutil/app.yaml
5 changes: 5 additions & 0 deletions x/mint/spec/07_client.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# App Wiring

The minimal app-wiring configuration for `x/mint` is as follows:

+++ https://github.com/cosmos/cosmos-sdk/blob/main/x/mint/testutil/app.yaml
1 change: 1 addition & 0 deletions x/mint/spec/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,4 @@ parent:
* [CLI](06_client.md#cli)
* [gRPC](06_client.md#grpc)
* [REST](06_client.md#rest)
7. **[App Wiring](07_app_wiring.md)**
6 changes: 0 additions & 6 deletions x/nft/spec/01_concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,3 @@ order: 1
## NFT

The full name of NFT is Non-Fungible Tokens. Because of the irreplaceable nature of NFT, it means that it can be used to represent unique things. The nft implemented by this module is fully compatible with Ethereum ERC721 standard.

## App Wiring

The minimal app-wiring configuration for `x/nft` is as follows:

+++ https://github.com/cosmos/cosmos-sdk/blob/main/x/nft/testutil/app.yaml
5 changes: 5 additions & 0 deletions x/nft/spec/05_app_wiring.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# App Wiring

The minimal app-wiring configuration for `x/nft` is as follows:

+++ https://github.com/cosmos/cosmos-sdk/blob/main/x/nft/testutil/app.yaml
1 change: 0 additions & 1 deletion x/params/spec/03_app_wiring.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

# App Wiring

The minimal app-wiring configuration for `x/params` is as follows:
Expand Down
5 changes: 5 additions & 0 deletions x/slashing/spec/10_app_wiring.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# App Wiring

The minimal app-wiring configuration for `x/slashing` is as follows:

+++ https://github.com/cosmos/cosmos-sdk/blob/main/x/slashing/testutil/app.yaml
1 change: 1 addition & 0 deletions x/slashing/spec/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,4 @@ This module will be used by the Cosmos Hub, the first hub in the Cosmos ecosyste
* [CLI](09_client.md#cli)
* [gRPC](09_client.md#grpc)
* [REST](09_client.md#rest)
10. **[App Wiring](10_app_wiring.md)**

0 comments on commit 1194321

Please sign in to comment.