feat: Municipal Inflation MVP

docs/architecture/adr-023-protobuf-naming.md

@@ -138,7 +138,7 @@ or significantly alter the package in the near future
 significantly refactor/rework the functionality in the near future but not remove it
 * modules _can and should_ have types in both stable (i.e. `v1` or `v2`) and unstable (`alpha` or `beta`) packages.
 
-*`alpha` and `beta` should not be used to avoid responsibility for maintaining compatibility.*
+_`alpha` and `beta` should not be used to avoid responsibility for maintaining compatibility._
 Whenever code is released into the wild, especially on a blockchain, there is a high cost to changing things. In some
 cases, for instance with immutable smart contracts, a breaking change may be impossible to fix.
 

docs/core/proto-docs.md

@@ -394,6 +394,7 @@
 
 - [cosmos/mint/v1beta1/mint.proto](#cosmos/mint/v1beta1/mint.proto)
     - [Minter](#cosmos.mint.v1beta1.Minter)
+    - [MunicipalInflation](#cosmos.mint.v1beta1.MunicipalInflation)
     - [Params](#cosmos.mint.v1beta1.Params)
 
 - [cosmos/mint/v1beta1/genesis.proto](#cosmos/mint/v1beta1/genesis.proto)
@@ -404,6 +405,8 @@
     - [QueryAnnualProvisionsResponse](#cosmos.mint.v1beta1.QueryAnnualProvisionsResponse)
     - [QueryInflationRequest](#cosmos.mint.v1beta1.QueryInflationRequest)
     - [QueryInflationResponse](#cosmos.mint.v1beta1.QueryInflationResponse)
+    - [QueryMunicipalInflationRequest](#cosmos.mint.v1beta1.QueryMunicipalInflationRequest)
+    - [QueryMunicipalInflationResponse](#cosmos.mint.v1beta1.QueryMunicipalInflationResponse)
     - [QueryParamsRequest](#cosmos.mint.v1beta1.QueryParamsRequest)
     - [QueryParamsResponse](#cosmos.mint.v1beta1.QueryParamsResponse)
 
@@ -5748,6 +5751,24 @@ Minter represents the minting state.
 | ----- | ---- | ----- | ----------- |
 | `inflation` | [string](#string) |  | current annual inflation rate |
 | `annual_provisions` | [string](#string) |  | current annual expected provisions |
+| `municipal_inflation` | [MunicipalInflation](#cosmos.mint.v1beta1.MunicipalInflation) | repeated | map<string, Inflation> inflations = 3; |
+
+
+
+
+
+
+<a name="cosmos.mint.v1beta1.MunicipalInflation"></a>
+
+### MunicipalInflation
+Inflation holds parameters for individual native token inflation
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| `denom` | [string](#string) |  |  |
+| `target_address` | [string](#string) |  |  |
+| `inflation` | [string](#string) |  | current annual inflation rate |
 
 
 
@@ -5872,6 +5893,32 @@ method.
 
 
 
+<a name="cosmos.mint.v1beta1.QueryMunicipalInflationRequest"></a>
+
+### QueryMunicipalInflationRequest
+QueryMunicipalInflationRequest is the request type for the Query/MunicipalInflation RPC method.
+
+
+
+
+
+
+<a name="cosmos.mint.v1beta1.QueryMunicipalInflationResponse"></a>
+
+### QueryMunicipalInflationResponse
+QueryInflationResponse is the response type for the Query/Inflation RPC
+method.
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| `inflations` | [MunicipalInflation](#cosmos.mint.v1beta1.MunicipalInflation) | repeated | inflation is the current minting inflation value. |
+
+
+
+
+
+
 <a name="cosmos.mint.v1beta1.QueryParamsRequest"></a>
 
 ### QueryParamsRequest
@@ -5912,6 +5959,7 @@ Query provides defines the gRPC querier service.
 | ----------- | ------------ | ------------- | ------------| ------- | -------- |
 | `Params` | [QueryParamsRequest](#cosmos.mint.v1beta1.QueryParamsRequest) | [QueryParamsResponse](#cosmos.mint.v1beta1.QueryParamsResponse) | Params returns the total set of minting parameters. | GET|/cosmos/mint/v1beta1/params|
 | `Inflation` | [QueryInflationRequest](#cosmos.mint.v1beta1.QueryInflationRequest) | [QueryInflationResponse](#cosmos.mint.v1beta1.QueryInflationResponse) | Inflation returns the current minting inflation value. | GET|/cosmos/mint/v1beta1/inflation|
+| `MunicipalInflation` | [QueryMunicipalInflationRequest](#cosmos.mint.v1beta1.QueryMunicipalInflationRequest) | [QueryMunicipalInflationResponse](#cosmos.mint.v1beta1.QueryMunicipalInflationResponse) | Inflation returns the current minting inflation value. | GET|/cosmos/mint/v1beta1/municipal_inflation|
 | `AnnualProvisions` | [QueryAnnualProvisionsRequest](#cosmos.mint.v1beta1.QueryAnnualProvisionsRequest) | [QueryAnnualProvisionsResponse](#cosmos.mint.v1beta1.QueryAnnualProvisionsResponse) | AnnualProvisions current minting annual provisions value. | GET|/cosmos/mint/v1beta1/annual_provisions|
 
  <!-- end services -->

go.mod

@@ -17,6 +17,7 @@ require (
 	github.com/gogo/protobuf v1.3.3
 	github.com/golang/mock v1.6.0
 	github.com/golang/protobuf v1.5.2
+	github.com/golangci/golangci-lint v1.48.0
 	github.com/gorilla/handlers v1.5.1
 	github.com/gorilla/mux v1.8.0
 	github.com/grpc-ecosystem/go-grpc-middleware v1.3.0
@@ -52,8 +53,6 @@ require (
 	gopkg.in/yaml.v2 v2.4.0
 )
 
-require github.com/golangci/golangci-lint v1.48.0
-
 require (
 	4d63.com/gochecknoglobals v0.1.0 // indirect
 	filippo.io/edwards25519 v1.0.0-beta.2 // indirect

proto/cosmos/mint/v1beta1/mint.proto

@@ -16,6 +16,21 @@ message Minter {
     (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
     (gogoproto.nullable)   = false
   ];
+
+  //  map<string, Inflation> inflations = 3;
+  repeated MunicipalInflation municipal_inflation = 3;
+}
+
+// Inflation holds parameters for individual native token inflation
+message MunicipalInflation {
+  string denom          = 1;
+  string target_address = 2;
+  // current annual inflation rate
+  string inflation = 3 [
+    (gogoproto.moretags)   = "yaml:\"inflation_rate\"",
+    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
+    (gogoproto.nullable)   = false
+  ];
 }
 
 // Params holds parameters for the mint module.

proto/cosmos/mint/v1beta1/query.proto

@@ -19,6 +19,11 @@ service Query {
     option (google.api.http).get = "/cosmos/mint/v1beta1/inflation";
   }
 
+  // Inflation returns the current minting inflation value.
+  rpc MunicipalInflation(QueryMunicipalInflationRequest) returns (QueryMunicipalInflationResponse) {
+    option (google.api.http).get = "/cosmos/mint/v1beta1/municipal_inflation";
+  }
+
   // AnnualProvisions current minting annual provisions value.
   rpc AnnualProvisions(QueryAnnualProvisionsRequest) returns (QueryAnnualProvisionsResponse) {
     option (google.api.http).get = "/cosmos/mint/v1beta1/annual_provisions";
@@ -37,13 +42,23 @@ message QueryParamsResponse {
 // QueryInflationRequest is the request type for the Query/Inflation RPC method.
 message QueryInflationRequest {}
 
+// QueryMunicipalInflationRequest is the request type for the Query/MunicipalInflation RPC method.
+message QueryMunicipalInflationRequest {}
+
 // QueryInflationResponse is the response type for the Query/Inflation RPC
 // method.
 message QueryInflationResponse {
   // inflation is the current minting inflation value.
   bytes inflation = 1 [(gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec", (gogoproto.nullable) = false];
 }
 
+// QueryInflationResponse is the response type for the Query/Inflation RPC
+// method.
+message QueryMunicipalInflationResponse {
+  // inflation is the current minting inflation value.
+  repeated MunicipalInflation inflations = 1;
+}
+
 // QueryAnnualProvisionsRequest is the request type for the
 // Query/AnnualProvisions RPC method.
 message QueryAnnualProvisionsRequest {}

x/mint/abci.go

@@ -1,14 +1,102 @@
 package mint
 
 import (
-	"time"
-
 	"github.com/cosmos/cosmos-sdk/telemetry"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/x/mint/keeper"
 	"github.com/cosmos/cosmos-sdk/x/mint/types"
+	"time"
+)
+
+type MunicipalInflationCache struct {
+	blocksPerYear      uint64
+	perBlockInflations map[string]sdk.Dec // {denom: inflationPerBlock}
+}
+
+var (
+	// NOTE(pb): This is *NOT* thread safe.
+	//			 However, in our case, this global variable is by design
+	//			 *NOT* supposed to be accessed simultaneously in multiple
+	//			 different threads, or in global scope somewhere else.
+	//			 Once such requirements arise, concept of this global variable
+	//			 needs to be changed to something what is thread safe.
+	infCache = MunicipalInflationCache{0, nil}
 )
 
+// NOTE(pb): Not thread safe, as per comment above.
+func (cache *MunicipalInflationCache) refresh(minter *types.Minter, blocksPerYear uint64) {
+	if err := types.ValidateMunicipalInflations(minter.MunicipalInflation); err != nil {
+		panic(err)
+	}
+
+	cache.blocksPerYear = blocksPerYear
+	cache.perBlockInflations = map[string]sdk.Dec{}
+
+	for _, inflation := range minter.MunicipalInflation {
+		inflationPerBlock, err := types.CalculateInflationPerBlock(inflation, blocksPerYear)
+		if err != nil {
+			panic(err)
+		}
+
+		cache.perBlockInflations[inflation.Denom] = inflationPerBlock
+	}
+}
+
+// NOTE(pb): Not thread safe, as per comment above.
+func (cache *MunicipalInflationCache) refreshIfNecessary(minter *types.Minter, blocksPerYear uint64) {
+	if infCache.blocksPerYear != blocksPerYear {
+		cache.refresh(minter, blocksPerYear)
+	}
+}
+
+// HandleMunicipalInflation iterates through all other native tokens specified in the minter.MunicipalInflation structure, and processes
+// the minting of new coins in line with the respective inflation rate of each denomination
+func HandleMunicipalInflation(ctx sdk.Context, k keeper.Keeper) {
+	minter := k.GetMinter(ctx)
+	params := k.GetParams(ctx)
+
+	infCache.refreshIfNecessary(&minter, params.BlocksPerYear)
+
+	// iterate through native denominations
+	for _, inflation := range minter.MunicipalInflation {
+		denom := inflation.Denom
+		targetAddress := inflation.TargetAddress
+
+		// gather supply value & calculate number of new tokens created from relevant inflation
+		totalDenomSupply := k.BankKeeper.GetSupply(ctx, denom)
+		coinsToMint := types.CalculateInflationIssuance(infCache.perBlockInflations[inflation.Denom], totalDenomSupply)
+
+		err := k.MintCoins(ctx, coinsToMint)
+
+		if err != nil {
+			panic(err)
+		}
+
+		// send these new tokens to respective target address
+		// TODO(JS): investigate whether this should be carried out in distribution module or not
+
+		// Convert targetAddress to sdk.AccAddress
+		acc, err := sdk.AccAddressFromBech32(targetAddress)
+		if err != nil {
+			panic(err)
+		}
+
+		err = k.BankKeeper.SendCoinsFromModuleToAccount(ctx, types.ModuleName, acc, coinsToMint)
+		if err != nil {
+			panic(err)
+		}
+		ctx.EventManager().EmitEvent(
+			sdk.NewEvent(
+				types.EventTypeMunicipalMint,
+				sdk.NewAttribute(types.AttributeKeyDenom, inflation.Denom),
+				sdk.NewAttribute(types.AttributeKeyInflation, inflation.Inflation.String()),
+				sdk.NewAttribute(types.AttributeKeyTargetAddr, inflation.TargetAddress),
+				sdk.NewAttribute(sdk.AttributeKeyAmount, coinsToMint.String()),
+			),
+		)
+	}
+}
+
 // BeginBlocker mints new tokens for the previous block.
 func BeginBlocker(ctx sdk.Context, k keeper.Keeper) {
 	defer telemetry.ModuleMeasureSince(types.ModuleName, time.Now(), telemetry.MetricKeyBeginBlocker)

x/mint/client/cli/query.go

@@ -23,6 +23,7 @@ func GetQueryCmd() *cobra.Command {
 	mintingQueryCmd.AddCommand(
 		GetCmdQueryParams(),
 		GetCmdQueryInflation(),
+		GetCmdQueryMunicipalInflation(),
 		GetCmdQueryAnnualProvisions(),
 	)
 
@@ -87,6 +88,35 @@ func GetCmdQueryInflation() *cobra.Command {
 	return cmd
 }
 
+// GetCmdQueryMunicipalInflation implements a command to return all token
+// inflation values.
+func GetCmdQueryMunicipalInflation() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "municipal-inflation",
+		Short: "Query municipal inflation configurations for all registered denominations",
+		Args:  cobra.NoArgs,
+		RunE: func(cmd *cobra.Command, args []string) error {
+			clientCtx, err := client.GetClientQueryContext(cmd)
+			if err != nil {
+				return err
+			}
+			queryClient := types.NewQueryClient(clientCtx)
+
+			params := &types.QueryMunicipalInflationRequest{}
+			res, err := queryClient.MunicipalInflation(cmd.Context(), params)
+			if err != nil {
+				return err
+			}
+
+			return clientCtx.PrintString(fmt.Sprintf("%s\n", res.Inflations))
+		},
+	}
+
+	flags.AddQueryFlagsToCmd(cmd)
+
+	return cmd
+}
+
 // GetCmdQueryAnnualProvisions implements a command to return the current minting
 // annual provisions value.
 func GetCmdQueryAnnualProvisions() *cobra.Command {

x/mint/client/rest/grpc_query_test.go

@@ -83,6 +83,15 @@ func (s *IntegrationTestSuite) TestQueryGRPC() {
 				Inflation: sdk.NewDecWithPrec(3, 2),
 			},
 		},
+		{
+			"gRPC request inflations",
+			fmt.Sprintf("%s/cosmos/mint/v1beta1/inflations", baseURL),
+			map[string]string{},
+			&minttypes.QueryMunicipalInflationResponse{},
+			&minttypes.QueryMunicipalInflationResponse{
+				Inflations: nil,
+			},
+		},
 		{
 			"gRPC request annual provisions",
 			fmt.Sprintf("%s/cosmos/mint/v1beta1/annual_provisions", baseURL),

x/mint/client/testutil/suite.go

@@ -89,6 +89,40 @@ mint_denom: stake`,
 	}
 }
 
+func (s *IntegrationTestSuite) TestGetCmdQueryInflations() {
+	val := s.network.Validators[0]
+
+	testCases := []struct {
+		name           string
+		args           []string
+		expectedOutput string
+	}{
+		{
+			"json output",
+			[]string{fmt.Sprintf("--%s=1", flags.FlagHeight), fmt.Sprintf("--%s=json", tmcli.OutputFlag)},
+			`[]`,
+		},
+		{
+			"text output",
+			[]string{fmt.Sprintf("--%s=1", flags.FlagHeight), fmt.Sprintf("--%s=text", tmcli.OutputFlag)},
+			`[]`,
+		},
+	}
+
+	for _, tc := range testCases {
+		tc := tc
+
+		s.Run(tc.name, func() {
+			cmd := cli.GetCmdQueryMunicipalInflation()
+			clientCtx := val.ClientCtx
+
+			out, err := clitestutil.ExecTestCLICmd(clientCtx, cmd, tc.args)
+			s.Require().NoError(err)
+			s.Require().Equal(tc.expectedOutput, strings.TrimSpace(out.String()))
+		})
+	}
+}
+
 func (s *IntegrationTestSuite) TestGetCmdQueryInflation() {
 	val := s.network.Validators[0]