laconicd-deprecated/x/feemarket/spec/08_client.md
Thomas Nguy a2c26208ed
docs: add spec for feemarket module (#889)
* add spec for feemarket

* update spec from comments

* update spec

* update abstract

* update with grpc query

* add more content for tip section

* update specs with latest behavior

* cleanup unused store prefix

* Update x/feemarket/spec/01_concepts.md

* Apply suggestions from code review

Co-authored-by: Federico Kunze Küllmer <31522760+fedekunze@users.noreply.github.com>
2022-02-25 12:49:18 +00:00

93 lines
2.2 KiB
Markdown
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!--
order: 8 -->
# Client
## CLI
A user can query and interact with the `feemarket` module using the CLI.
### Queries
The `query` commands allow users to query `feemarket` state.
```go
ethermintd query feemarket --help
```
#### Base Fee
The `base-fee` command allows users to query the block base fee by height.
```
ethermintd query feemarket base-fee [height] [flags]
```
Example:
```
ethermintd query feemarket base-fee 5...
```
Example Output:
```
base_fee: "512908936"
```
#### Block Gas
The `block-gas` command allows users to query the block gas by height.
```
ethermintd query feemarket block-gas [height] [flags]
```
Example:
```
ethermintd query feemarket block-gas 5...
```
Example Output:
```
gas: "21000"
```
#### Params
The `params` command allows users to query the module params.
```
ethermintd query params subspace [subspace] [key] [flags]
```
Example:
```
ethermintd query params subspace feemarket ElasticityMultiplier ...
```
Example Output:
```
key: ElasticityMultiplier
subspace: feemarket
value: "2"
```
## gRPC
### Queries
| Verb | Method | Description |
| ------ | ---------------------------------------------------- | -------------------------------------------------------------------------- |
| `gRPC` | `ethermint.feemarket.v1.Query/Params` | Get the module params |
| `gRPC` | `ethermint.feemarket.v1.Query/BaseFee` | Get the block base fee |
| `gRPC` | `ethermint.feemarket.v1.Query/BlockGas` | Get the block gas used |
| `GET` | `/feemarket/evm/v1/params` | Get the module params |
| `GET` | `/feemarket/evm/v1/base_fee` | Get the block base fee |
| `GET` | `/feemarket/evm/v1/block_gas` | Get the block gas used |