From 3eb809a839e90238214d27f1b7d4546444166ea7 Mon Sep 17 00:00:00 2001 From: Arpit Temani Date: Thu, 19 Oct 2023 21:36:09 +0530 Subject: [PATCH 1/4] add readme for supply module --- supply/README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 supply/README.md diff --git a/supply/README.md b/supply/README.md new file mode 100644 index 000000000..76cdd4979 --- /dev/null +++ b/supply/README.md @@ -0,0 +1,25 @@ +# Supply Module + +## Table of Contents + +* [Overview](#overview) +* [How does it work](#how-does-it-work) +* [How to add an event](#how-to-add-an-event) +* [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. The total supply is updated every time a Coin is minted (eg: as part of the inflation mechanism) or burned (eg: due to slashing or if a governance proposal is vetoed). + +## Query commands + +One can run the following query commands from the clerk module : + +* `total` - Query for a total supply of the chain. Takes params for checking the total supply of a particular coin + +### CLI commands + +``` +heimdallcli query supply total [denom] +``` From 7cd93b1e5ff3c5f557af4b6151b8c8f67c47adb7 Mon Sep 17 00:00:00 2001 From: Arpit Temani Date: Thu, 19 Oct 2023 21:57:11 +0530 Subject: [PATCH 2/4] modify readme --- supply/README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/supply/README.md b/supply/README.md index 76cdd4979..a074c4fda 100644 --- a/supply/README.md +++ b/supply/README.md @@ -3,20 +3,18 @@ ## Table of Contents * [Overview](#overview) -* [How does it work](#how-does-it-work) -* [How to add an event](#how-to-add-an-event) * [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. The total supply is updated every time a Coin is minted (eg: as part of the inflation mechanism) or burned (eg: due to slashing or if a governance proposal is vetoed). +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 clerk module : -* `total` - Query for a total supply of the chain. Takes params for checking the total supply of a particular coin +* `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 From cff3a06897846476009123d26207f56eccb5a98c Mon Sep 17 00:00:00 2001 From: Arpit Temani Date: Thu, 19 Oct 2023 22:17:16 +0530 Subject: [PATCH 3/4] Update README.md --- supply/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/supply/README.md b/supply/README.md index a074c4fda..b508dc3a6 100644 --- a/supply/README.md +++ b/supply/README.md @@ -12,7 +12,7 @@ provides a pattern for modules to hold/interact with Coins, and introduces the i ## Query commands -One can run the following query commands from the clerk module : +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 From 771ab8d6e10b828d5cc00fe905dd58780100fc9e Mon Sep 17 00:00:00 2001 From: Arpit Temani Date: Tue, 31 Oct 2023 23:36:50 +0530 Subject: [PATCH 4/4] Update README.md --- supply/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/supply/README.md b/supply/README.md index b508dc3a6..8a2ef4369 100644 --- a/supply/README.md +++ b/supply/README.md @@ -8,7 +8,7 @@ ## 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. +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