feat: ADR-009: Supply module

app/app.go

@@ -96,6 +96,10 @@ import (
  subspaceskeeper "github.com/desmos-labs/desmos/v3/x/subspaces/keeper"
  subspacestypes "github.com/desmos-labs/desmos/v3/x/subspaces/types"
 
+ "github.com/desmos-labs/desmos/v3/x/supply"
+ supplykeeper "github.com/desmos-labs/desmos/v3/x/supply/keeper"
+ supplytypes "github.com/desmos-labs/desmos/v3/x/supply/types"
+
  authkeeper "github.com/cosmos/cosmos-sdk/x/auth/keeper"
  bankkeeper "github.com/cosmos/cosmos-sdk/x/bank/keeper"
  crisiskeeper "github.com/cosmos/cosmos-sdk/x/crisis/keeper"
@@ -222,6 +226,7 @@ var (
  profiles.AppModuleBasic{},
  relationships.AppModuleBasic{},
  subspaces.AppModuleBasic{},
+ supply.AppModuleBasic{},
  )
 
  // Module account permissions
@@ -284,6 +289,7 @@ type DesmosApp struct {
  SubspacesKeeper subspaceskeeper.Keeper
  ProfileKeeper profileskeeper.Keeper
  RelationshipsKeeper relationshipskeeper.Keeper
+ SupplyKeeper supplykeeper.Keeper
 
  // Module Manager
  mm *module.Manager
@@ -330,7 +336,7 @@ func NewDesmosApp(
  authzkeeper.StoreKey, wasm.StoreKey,
 
  // Custom modules
- profilestypes.StoreKey, relationshipstypes.StoreKey, subspacestypes.StoreKey,
+ profilestypes.StoreKey, relationshipstypes.StoreKey, subspacestypes.StoreKey, supplytypes.StoreKey,
  )
  tkeys := sdk.NewTransientStoreKeys(paramstypes.TStoreKey)
  memKeys := sdk.NewMemoryStoreKeys(capabilitytypes.MemStoreKey)
@@ -455,6 +461,8 @@ func NewDesmosApp(
  subspacestypes.NewMultiSubspacesHooks(app.RelationshipsKeeper.Hooks()),
  )
 
+ app.SupplyKeeper = supplykeeper.NewKeeper(app.appCodec, app.AccountKeeper, app.BankKeeper, app.DistrKeeper)
+
  // Create static IBC router, add transfer route, then set and seal it
  ibcRouter := porttypes.NewRouter()
  ibcRouter.AddRoute(ibctransfertypes.ModuleName, transferModule)
@@ -554,6 +562,7 @@ func NewDesmosApp(
  subspaces.NewAppModule(appCodec, app.SubspacesKeeper, app.AccountKeeper, app.BankKeeper),
  profilesModule,
  relationships.NewAppModule(appCodec, app.RelationshipsKeeper, app.SubspacesKeeper, profilesv4.NewKeeper(keys[profilestypes.StoreKey], appCodec), app.AccountKeeper, app.BankKeeper),
+ supply.NewAppModule(appCodec, app.SupplyKeeper),
  )
 
  // During begin block slashing happens after distr.BeginBlocker so that
@@ -585,6 +594,7 @@ func NewDesmosApp(
  subspacestypes.ModuleName,
  relationshipstypes.ModuleName,
  profilestypes.ModuleName,
+ supplytypes.ModuleName,
  )
  app.mm.SetOrderEndBlockers(
  crisistypes.ModuleName,
@@ -610,6 +620,7 @@ func NewDesmosApp(
  subspacestypes.ModuleName,
  relationshipstypes.ModuleName,
  profilestypes.ModuleName,
+ supplytypes.ModuleName,
  )
 
  // NOTE: The genutils module must occur after staking so that pools are
@@ -642,6 +653,7 @@ func NewDesmosApp(
  subspacestypes.ModuleName,
  profilestypes.ModuleName,
  relationshipstypes.ModuleName,
+ supplytypes.ModuleName,
 
  crisistypes.ModuleName,
  )
@@ -673,6 +685,7 @@ func NewDesmosApp(
  subspacestypes.ModuleName,
  relationshipstypes.ModuleName,
  profilestypes.ModuleName,
+ supplytypes.ModuleName,
 
  crisistypes.ModuleName,
  )
@@ -707,6 +720,7 @@ func NewDesmosApp(
  wasm.NewAppModule(appCodec, &app.WasmKeeper, app.StakingKeeper),
 
  // Custom modules
+ supply.NewAppModule(appCodec, app.SupplyKeeper),
  subspaces.NewAppModule(appCodec, app.SubspacesKeeper, app.AccountKeeper, app.BankKeeper),
  profilesModule,
  relationships.NewAppModule(appCodec, app.RelationshipsKeeper, app.SubspacesKeeper, profilesv4.NewKeeper(keys[profilestypes.StoreKey], appCodec), app.AccountKeeper, app.BankKeeper),

docs/architecture/adr-009-supply-module.md

@@ -8,7 +8,7 @@
 
 ## Status
 
-DRAFTED
+ACCEPTED
 
 ## Abstract
 
@@ -24,7 +24,8 @@ The APIs will be exposed in a new module called `x/supply` that will have the pu
 
 ### Queries
 
-All the following APIs will have a custom param named `multiplier` that allows to set the multiplier to be used when returning the values. A `multiplier` of `0` will identify the whole token amount, while a multiplier of `1.000.000` will make the result display the values in millionth of units.
+All the following APIs will have a custom param named `divider` that allows to set the divider to be used when 
+returning the values. A `divider` of `0` will identify the whole token amount, while a divider of `1.000.000` will make the result display the values in millionth of units.
 
 #### Total Supply
 

proto/desmos/supply/v1/query.proto

@@ -0,0 +1,73 @@
+syntax = "proto3";
+package desmos.supply.v1;
+
+import "gogoproto/gogo.proto";
+import "google/api/annotations.proto";
+import "google/protobuf/any.proto";
+import "cosmos_proto/cosmos.proto";
+import "cosmos/base/v1beta1/coin.proto";
+
+option go_package = "github.com/desmos-labs/desmos/v3/x/supply/types";
+
+
+// Query defines the gRPC querier service.
+service Query {
+
+ // TotalSupply queries the total supply of the given denom, converted with the given divider
+ rpc TotalSupply(QueryTotalSupplyRequest)
+ returns (QueryTotalSupplyResponse) {
+ option (google.api.http).get = "/desmos/supply/v1/total-supply/{denom}";
+ }
+
+ // CirculatingSupply queries the amount of tokens circulating in the market of the given
+ rpc CirculatingSupply(QueryCirculatingSupplyRequest)
+ returns (QueryCirculatingSupplyResponse) {
+ option (google.api.http).get = "/desmos/supply/v1/circulating-supply/{denom}";
+ }
+}
+
+// QueryTotalSupplyRequest is the request type for Query/TotalSupply RPC method
+message QueryTotalSupplyRequest {
+ option (gogoproto.equal) = false;
+ option (gogoproto.goproto_getters) = false;
+
+ // coin denom to query the circulating supply for
+ string denom = 1;
+
+ // divider is a factor used to convert the supply amount to the desired representation
+ uint64 divider = 2;
+}
+
+// QueryTotalSupplyResponse is the response type for the Query/TotalSupply RPC method
+message QueryTotalSupplyResponse {
+ option (gogoproto.equal) = false;
+ option (gogoproto.goproto_getters) = false;
+
+ string total_supply = 1 [
+ (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Int",
+ (gogoproto.nullable) = false
+ ];
+}
+
+// QueryCirculatingSupplyRequest is the request type for the Query/CirculatingSupply RPC method
+message QueryCirculatingSupplyRequest {
+ option (gogoproto.equal) = false;
+ option (gogoproto.goproto_getters) = false;
+
+ // coin denom to query the circulating supply for
+ string denom = 1;
+
+ // divider is a factor used to convert the supply amount to the desired representation
+ uint64 divider = 2;
+}
+
+// QueryCirculatingSupplyRequest is the response type for the Query/CirculatingSupply RPC method
+message QueryCirculatingSupplyResponse {
+ option (gogoproto.equal) = false;
+ option (gogoproto.goproto_getters) = false;
+
+ string circulating_supply = 1 [
+ (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Int",
+ (gogoproto.nullable) = false
+ ];
+}

x/supply/client/cli/cli_test.go

@@ -0,0 +1,174 @@
+package cli_test
+
+import (
+ "fmt"
+ "testing"
+
+ clitestutil "github.com/cosmos/cosmos-sdk/testutil/cli"
+ "github.com/cosmos/cosmos-sdk/testutil/network"
+ sdk "github.com/cosmos/cosmos-sdk/types"
+ authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
+ banktypes "github.com/cosmos/cosmos-sdk/x/bank/types"
+ stakingtypes "github.com/cosmos/cosmos-sdk/x/staking/types"
+ "github.com/desmos-labs/desmos/v3/testutil"
+ "github.com/desmos-labs/desmos/v3/x/supply/client/cli"
+ "github.com/desmos-labs/desmos/v3/x/supply/types"
+ "github.com/stretchr/testify/suite"
+ tmcli "github.com/tendermint/tendermint/libs/cli"
+)
+
+type IntegrationTestSuite struct {
+ suite.Suite
+
+ cfg network.Config
+ network *network.Network
+}
+
+func TestIntegrationTestSuite(t *testing.T) {
+ suite.Run(t, new(IntegrationTestSuite))
+}
+
+func (s *IntegrationTestSuite) SetupSuite() {
+ s.T().Log("setting up integration test suite")
+
+ cfg := testutil.DefaultConfig()
+ genesisState := cfg.GenesisState
+ cfg.NumValidators = 2
+
+ var authData authtypes.GenesisState
+ s.Require().NoError(cfg.Codec.UnmarshalJSON(genesisState[authtypes.ModuleName], &authData))
+
+ var bankData banktypes.GenesisState
+ s.Require().NoError(cfg.Codec.UnmarshalJSON(genesisState[banktypes.ModuleName], &bankData))
+
+ var stakingData stakingtypes.GenesisState
+ s.Require().NoError(cfg.Codec.UnmarshalJSON(genesisState[stakingtypes.ModuleName], &stakingData))
+
+ s.cfg = cfg
+ s.network = network.New(s.T(), cfg)
+ _, err := s.network.WaitForHeight(1)
+ s.Require().NoError(err)
+}
+
+func (s *IntegrationTestSuite) TearDownSuite() {
+ s.T().Log("tearing down integration test suite")
+ s.network.Cleanup()
+}
+
+func (s *IntegrationTestSuite) TestCmdQueryTotalSupply() {
+ val := s.network.Validators[0]
+
+ testCases := []struct {
+ name string
+ args []string
+ shouldErr bool
+ expectedOutput types.QueryTotalSupplyResponse
+ }{
+ {
+ name: "invalid denom returns error",
+ args: []string{
+ "",
+ fmt.Sprintf("--%s=json", tmcli.OutputFlag),
+ },
+ shouldErr: true,
+ },
+ {
+ name: "total supply returned correctly without divider conversion applied",
+ args: []string{
+ "stake",
+ fmt.Sprintf("--%s=json", tmcli.OutputFlag),
+ },
+ shouldErr: false,
+ expectedOutput: types.QueryTotalSupplyResponse{TotalSupply: sdk.NewInt(1000000020)},
+ },
+ {
+ name: " total supply returned correctly with divider conversion applied",
+ args: []string{
+ "stake",
+ "100",
+ fmt.Sprintf("--%s=json", tmcli.OutputFlag),
+ },
+ shouldErr: false,
+ expectedOutput: types.QueryTotalSupplyResponse{TotalSupply: sdk.NewInt(10000000)},
+ },
+ }
+
+ for _, tc := range testCases {
+ tc := tc
+
+ s.Run(tc.name, func() {
+ cmd := cli.GetCmdQueryTotalSupply()
+ clientCtx := val.ClientCtx
+ out, err := clitestutil.ExecTestCLICmd(clientCtx, cmd, tc.args)
+
+ if tc.shouldErr {
+ s.Require().Error(err)
+ } else {
+ s.Require().NoError(err)
+
+ var response types.QueryTotalSupplyResponse
+ s.Require().NoError(clientCtx.JSONCodec.UnmarshalJSON(out.Bytes(), &response), out.String())
+ s.Require().Equal(tc.expectedOutput.TotalSupply, response.TotalSupply)
+ }
+ })
+ }
+}
+
+func (s *IntegrationTestSuite) TestCmdQueryCirculatingSupply() {
+ val := s.network.Validators[0]
+
+ testCases := []struct {
+ name string
+ args []string
+ shouldErr bool
+ expectedOutput types.QueryCirculatingSupplyResponse
+ }{
+ {
+ name: "invalid denom returns error",
+ args: []string{
+ "",
+ fmt.Sprintf("--%s=json", tmcli.OutputFlag),
+ },
+ shouldErr: true,
+ },
+ {
+ name: "circulating supply returned correctly without divider conversion applied",
+ args: []string{
+ "stake",
+ fmt.Sprintf("--%s=json", tmcli.OutputFlag),
+ },
+ shouldErr: false,
+ expectedOutput: types.QueryCirculatingSupplyResponse{CirculatingSupply: sdk.NewInt(1000000020)},
+ },
+ {
+ name: " circulating supply returned correctly with divider conversion applied",
+ args: []string{
+ "stake",
+ "100",
+ fmt.Sprintf("--%s=json", tmcli.OutputFlag),
+ },
+ shouldErr: false,
+ expectedOutput: types.QueryCirculatingSupplyResponse{CirculatingSupply: sdk.NewInt(10000000)},
+ },
+ }
+
+ for _, tc := range testCases {
+ tc := tc
+
+ s.Run(tc.name, func() {
+ cmd := cli.GetCmdQueryCirculatingSupply()
+ clientCtx := val.ClientCtx
+ out, err := clitestutil.ExecTestCLICmd(clientCtx, cmd, tc.args)
+
+ if tc.shouldErr {
+ s.Require().Error(err)
+ } else {
+ s.Require().NoError(err)
+
+ var response types.QueryCirculatingSupplyResponse
+ s.Require().NoError(clientCtx.JSONCodec.UnmarshalJSON(out.Bytes(), &response), out.String())
+ s.Require().Equal(tc.expectedOutput.CirculatingSupply, response.CirculatingSupply)
+ }
+ })
+ }
+}