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

Supply module readme #1090

Merged
merged 4 commits into from
Nov 1, 2023
Merged

Supply module readme #1090

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3eb809a
add readme for supply module
temaniarpit27 Oct 19, 2023
7cd93b1
modify readme
temaniarpit27 Oct 19, 2023
cff3a06
Update README.md
temaniarpit27 Oct 19, 2023
771ab8d
Update README.md
temaniarpit27 Oct 31, 2023
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
23 changes: 23 additions & 0 deletions supply/README.md
View file
Open in desktop
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]
```
marcello33 marked this conversation as resolved.
Show resolved Hide resolved
Loading