-
Notifications
You must be signed in to change notification settings - Fork 182
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1090 from maticnetwork/arpit/pos-1832
Supply module readme
- Loading branch information
Showing
1 changed file
with
23 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# Supply Module | ||
|
||
## Table of Contents | ||
|
||
* [Overview](#overview) | ||
* [Query commands](#query-commands) | ||
|
||
## Overview | ||
|
||
The supply functionality passively tracks the total supply of coins within a chain, | ||
provides a pattern for modules to hold/interact with coins, and introduces the invariant check to verify a chain's total supply. The total supply of the network is equal to the sum of all coins from the account. | ||
|
||
## Query commands | ||
|
||
One can run the following query commands from the bank module : | ||
|
||
* `total` - Query for a total supply of the chain with different coins. Takes params for checking the total supply of a particular coin | ||
|
||
### CLI commands | ||
|
||
``` | ||
heimdallcli query supply total [denom] | ||
``` |