From 127d9a01fd4e98c4411967450f51fd1753ee28e5 Mon Sep 17 00:00:00 2001 From: Sai Kumar <17549398+gsk967@users.noreply.github.com> Date: Wed, 6 Oct 2021 17:01:20 +0530 Subject: [PATCH] docs: add crisis module client docs (#10304) ## Description Closes: #10288 --- ### Author Checklist *All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.* I have... - [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] added `!` to the type prefix if API or client breaking change - [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [ ] provided a link to the relevant issue or specification - [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules) - [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing) - [ ] added a changelog entry to `CHANGELOG.md` - [ ] included comments for [documenting Go code](https://blog.golang.org/godoc) - [ ] updated the relevant documentation or specification - [ ] reviewed "Files changed" and left comments if necessary - [ ] confirmed all CI checks have passed ### Reviewers Checklist *All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.* I have... - [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] confirmed `!` in the type prefix if API or client breaking change - [ ] confirmed all author checklist items have been addressed - [ ] reviewed state machine logic - [ ] reviewed API design and naming - [ ] reviewed documentation is accurate - [ ] reviewed tests and test coverage - [ ] manually tested (if applicable) --- x/crisis/spec/05_client.md | 24 ++++++++++++++++++++++++ x/crisis/spec/README.md | 2 ++ 2 files changed, 26 insertions(+) create mode 100644 x/crisis/spec/05_client.md diff --git a/x/crisis/spec/05_client.md b/x/crisis/spec/05_client.md new file mode 100644 index 0000000000..bf7d6a4593 --- /dev/null +++ b/x/crisis/spec/05_client.md @@ -0,0 +1,24 @@ + +# Client + +## CLI +A user can query and interact with the `crisis` module using the CLI. + +### Transactions +The `tx` commands allow users to interact with the `crisis` module. +```bash +simd tx crisis --help +``` + +#### invariant-broken +The `invariant-broken` command submits proof when an invariant was broken to halt the chain +```bash +simd tx crisis invariant-broken [module-name] [invariant-route] [flags] +``` + +Example: +```bash +simd tx crisis invariant-broken bank total-supply --from=[keyname or address] +``` \ No newline at end of file diff --git a/x/crisis/spec/README.md b/x/crisis/spec/README.md index 3704da56d1..358fe38e3d 100644 --- a/x/crisis/spec/README.md +++ b/x/crisis/spec/README.md @@ -22,3 +22,5 @@ application initialization process. 3. **[Events](03_events.md)** - [Handlers](03_events.md#handlers) 4. **[Parameters](04_params.md)** +5. **[Client](05_client.md)** + - [CLI](05_client.md#cli)