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.

Sign up for GitHub

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 mint docs #22108

Merged
merged 4 commits into from
Oct 7, 2024
Merged

docs: Update mint docs #22108

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
353f62f
docs: Update mint docs
lucaslopezf Oct 3, 2024
71ca2cc
enhance mint docs
lucaslopezf Oct 4, 2024
b1c21f6
Merge branch 'main' into lucas/mint-docs
lucaslopezf Oct 4, 2024
f9007bf
typo
lucaslopezf Oct 4, 2024
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
32 changes: 30 additions & 2 deletions x/mint/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ related to minting (in the `data` field)
* Minter: `0x00 -> ProtocolBuffer(minter)`

```protobuf reference
https://github.com/cosmos/cosmos-sdk/blob/release/v0.52.x/x/mint/proto/cosmos/mint/v1beta1/mint.proto#L11-L29
https://github.com/cosmos/cosmos-sdk/blob/v0.52.0-beta.1/x/mint/proto/cosmos/mint/v1beta1/mint.proto#L11-L29
```

### Params
Expand All @@ -122,7 +122,7 @@ A value of `0` indicates an unlimited supply.
* Params: `mint/params -> legacy_amino(params)`

```protobuf reference
https://github.com/cosmos/cosmos-sdk/blob/release/v0.52.x/x/mint/proto/cosmos/mint/v1beta1/mint.proto#L31-L73
https://github.com/cosmos/cosmos-sdk/blob/v0.52.0-beta.1/x/mint/proto/cosmos/mint/v1beta1/mint.proto#L31-L73
```

## Epoch minting
Expand Down Expand Up @@ -315,6 +315,12 @@ simd query mint params [flags]

Example:

```shell
simd query mint params
```

Example Output:

```yml
blocks_per_year: "4360000"
goal_bonded: "0.670000000000000000"
Expand All @@ -325,6 +331,28 @@ mint_denom: stake
max_supply: "0"
```

#### Transactions

The `tx` commands allow users to interact with the `mint` module.

```shell
simd tx mint --help
```

##### update-params-proposal

The `update-params-proposal` command allows users to submit a proposal to update the mint module parameters (Note: the entire params must be provided).

```shell
simd tx mint update-params-proposal [flags]
```

Example:

```shell
simd tx mint update-params-proposal '{ "mint_denom": "stake" }'
```

### gRPC

A user can query the `mint` module using gRPC endpoints.
Expand Down
Loading