Skip to content

Commit

Permalink
Merge pull request #1090 from maticnetwork/arpit/pos-1832
Browse files Browse the repository at this point in the history
Supply module readme
  • Loading branch information
temaniarpit27 authored Nov 1, 2023
2 parents f9fa508 + 771ab8d commit 034b3be
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions supply/README.md
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]
```

0 comments on commit 034b3be

Please sign in to comment.