Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update docs before the next release #93

Merged
merged 3 commits into from
Nov 26, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ The budget module is a Cosmos SDK module that implements budget functionality. I

A primary use case is for Gravity DEX farming plan. The budget module can be used to create a budget plan that defines Cosmos Hub's FeeCollector module account where transaction gas fees and part of ATOM inflation are collected as source address and uses a custom module account (created by budget creator) as destination address. Read [spec docs](./x/budget/spec/01_concepts.md) to get to know more about the module.

⚠ **Budget module v1 is in active development** ⚠
- see the [main](https://github.com/tendermint/budget/tree/main) branch for the latest
- see [releases](https://github.com/tendermint/budget/releases) for the latest release
## Versions

See the [main](https://github.com/tendermint/budget/tree/main) branch for the latest, and see [releases](https://github.com/tendermint/budget/releases) for the latest release

## Dependencies

Expand All @@ -35,10 +35,9 @@ To get started to the project, visit the [TECHNICAL-SETUP.md](./TECHNICAL-SETUP.

## Documentation

The farming module documentation is available in [docs](./docs) folder and technical specification is available in [specs](https://github.com/tendermint/budget/blob/main/x/budget/spec/README.md) folder.

These are some of the documents that help you to quickly get you on board with the budget module.
The following documents are available to help you quickly get onboard with the budget module:

- [Technical specification](./x/budget/spec)
- [How to bootstrap a local network with budget module](./docs/Tutorials/localnet)
- [How to use Command Line Interfaces](./docs/How-To/cli)
- [How to use gRPC-gateway REST Routes](./docs/How-To)
Expand Down
47 changes: 31 additions & 16 deletions docs/How-To/api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,25 +11,14 @@ Description: A high-level overview of gRPC-gateway REST Routes in budget module.

In order to test out the following REST routes, you need to set up a local node to query from. You can refer to this [localnet tutorial](../../Tutorials/localnet) on how to build `budgetd` binary and bootstrap a local network in your local machine.

Query the address of `fee_collector` with address type 1(`AddressType20Bytes`)
http://localhost:1317/cosmos/budget/v1beta1/addresses/fee_collector?type=1 <!-- markdown-link-check-disable-line -->
- [Params](#Params)
- [Budgets](#Budgets)
- [Addresses](#Addresses)

```json
{
"address": "cosmos17xpfvakm2amg962yls6f84z3kell8c5lserqta"
}
```

Query the address of `GravityDEXFarmingBudget` on farming module with default address type 0(`AddressType32Bytes`)
http://localhost:1317/cosmos/budget/v1beta1/addresses/GravityDEXFarmingBudget?module_name=farming <!-- markdown-link-check-disable-line -->

```json
{
"address": "cosmos1228ryjucdpdv3t87rxle0ew76a56ulvnfst0hq0sscd3nafgjpqqkcxcky"
}
```
### Params

Query the values set as budget parameters

http://localhost:1317/cosmos/budget/v1beta1/params <!-- markdown-link-check-disable-line -->

```json
Expand All @@ -50,7 +39,10 @@ http://localhost:1317/cosmos/budget/v1beta1/params <!-- markdown-link-check-disa
}
```

### Budgets

Query all the budget plans exist in the network

http://localhost:1317/cosmos/budget/v1beta1/budgets <!-- markdown-link-check-disable-line -->

```json
Expand All @@ -74,4 +66,27 @@ http://localhost:1317/cosmos/budget/v1beta1/budgets <!-- markdown-link-check-dis
}
]
}
```


### Addresses

Query the address of `fee_collector` with address type 1(`AddressType20Bytes`)

http://localhost:1317/cosmos/budget/v1beta1/addresses/fee_collector?type=1 <!-- markdown-link-check-disable-line -->

```json
{
"address": "cosmos17xpfvakm2amg962yls6f84z3kell8c5lserqta"
}
```

Query the address of `GravityDEXFarmingBudget` on farming module with default address type 0(`AddressType32Bytes`)

http://localhost:1317/cosmos/budget/v1beta1/addresses/GravityDEXFarmingBudget?module_name=farming <!-- markdown-link-check-disable-line -->

```json
{
"address": "cosmos1228ryjucdpdv3t87rxle0ew76a56ulvnfst0hq0sscd3nafgjpqqkcxcky"
}
```
2 changes: 1 addition & 1 deletion docs/How-To/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ In order to test out the following command-line interfaces, you need to set up a

## Transaction

There is no command-line interface for the Budget module. However, in order to query budget parameters and plans we are going to submit a governance proposal to create a budget plan in this documentation.
There is no command-line interface for the budget module. However, in order to query budget parameters and plans we are going to submit a governance proposal to create a budget plan in this documentation.

### Propose a Budget Plan

Expand Down