From 0bee58a11b9cb5c4f9ac78f27fee264d4978d429 Mon Sep 17 00:00:00 2001 From: likhita-809 <78951027+likhita-809@users.noreply.github.com> Date: Mon, 11 Oct 2021 14:13:20 +0530 Subject: [PATCH] docs: add client spec for vesting (#10336) ## Description Closes: #10293 --- ### 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/auth/spec/07_client.md | 45 ++++++++++++++++++++++++++++++++++++++++ x/auth/spec/README.md | 4 +++- 2 files changed, 48 insertions(+), 1 deletion(-) create mode 100644 x/auth/spec/07_client.md diff --git a/x/auth/spec/07_client.md b/x/auth/spec/07_client.md new file mode 100644 index 0000000000..d7f2fbe3d7 --- /dev/null +++ b/x/auth/spec/07_client.md @@ -0,0 +1,45 @@ + + +# Client + +## CLI + +A user can query and interact with the `vesting` module using the CLI. + +### Transactions + +The `tx` commands allow users to interact with the `vesting` module. + +```bash +simd tx vesting --help +``` + +#### create-periodic-vesting-account + +The `create-periodic-vesting-account` command creates a new vesting account funded with an allocation of tokens, where a sequence of coins and period length in seconds. Periods are sequential, in that the duration of of a period only starts at the end of the previous period. The duration of the first period starts upon account creation. + +```bash +simd tx vesting create-periodic-vesting-account [to_address] [periods_json_file] [flags] +``` + +Example: + +```bash +simd tx vesting create-periodic-vesting-account cosmos1.. periods.json +``` + +#### create-vesting-account + +The `create-vesting-account` command creates a new vesting account funded with an allocation of tokens. The account can either be a delayed or continuous vesting account, which is determined by the '--delayed' flag. All vesting accouts created will have their start time set by the committed block's time. The end_time must be provided as a UNIX epoch timestamp. + +```bash +simd tx vesting create-vesting-account [to_address] [amount] [end_time] [flags] +``` + +Example: + +```bash +simd tx vesting create-vesting-account cosmos1.. 100stake 2592000 +``` \ No newline at end of file diff --git a/x/auth/spec/README.md b/x/auth/spec/README.md index b8a96aaa7c..99ebabb0ca 100644 --- a/x/auth/spec/README.md +++ b/x/auth/spec/README.md @@ -36,4 +36,6 @@ This module is used in the Cosmos Hub. - [Genesis Initialization](05_vesting.md#genesis-initialization) - [Examples](05_vesting.md#examples) - [Glossary](05_vesting.md#glossary) -6. **[Parameters](07_params.md)** +6. **[Parameters](06_params.md)** +7. **[Client](07_client.md)** + - [CLI](07_client.md#cli)