Scaffolded Tokenomics module (#251)

* Scaffolded tokenomics module * Fix make go_lint
pokt-network · Dec 8, 2023 · 0cc971c · 0cc971c
1 parent b732815
commit 0cc971c
Show file tree

Hide file tree

Showing 31 changed files with 965 additions and 22 deletions.
diff --git a/app/app.go b/app/app.go
@@ -110,8 +110,6 @@ import (
 	ibckeeper "github.com/cosmos/ibc-go/v7/modules/core/keeper"
 	solomachine "github.com/cosmos/ibc-go/v7/modules/light-clients/06-solomachine"
 	ibctm "github.com/cosmos/ibc-go/v7/modules/light-clients/07-tendermint"
-	"github.com/spf13/cast"
-
 	appparams "github.com/pokt-network/poktroll/app/params"
 	"github.com/pokt-network/poktroll/docs"
 	applicationmodule "github.com/pokt-network/poktroll/x/application"
@@ -132,6 +130,10 @@ import (
 	suppliermodule "github.com/pokt-network/poktroll/x/supplier"
 	suppliermodulekeeper "github.com/pokt-network/poktroll/x/supplier/keeper"
 	suppliermoduletypes "github.com/pokt-network/poktroll/x/supplier/types"
+	tokenomicsmodule "github.com/pokt-network/poktroll/x/tokenomics"
+	tokenomicsmodulekeeper "github.com/pokt-network/poktroll/x/tokenomics/keeper"
+	tokenomicsmoduletypes "github.com/pokt-network/poktroll/x/tokenomics/types"
+	"github.com/spf13/cast"
 )
 
 const (
@@ -197,6 +199,7 @@ var (
 		applicationmodule.AppModuleBasic{},
 		suppliermodule.AppModuleBasic{},
 		gatewaymodule.AppModuleBasic{},
+		tokenomicsmodule.AppModuleBasic{},
 		// this line is used by starport scaffolding # stargate/app/moduleBasic
 	)
 
@@ -283,6 +286,8 @@ type App struct {
 	SupplierKeeper    suppliermodulekeeper.Keeper
 
 	GatewayKeeper gatewaymodulekeeper.Keeper
+
+	TokenomicsKeeper tokenomicsmodulekeeper.Keeper
 	// this line is used by starport scaffolding # stargate/app/keeperDeclaration
 
 	// mm is the module manager
@@ -335,6 +340,7 @@ func New(
 		applicationmoduletypes.StoreKey,
 		suppliermoduletypes.StoreKey,
 		gatewaymoduletypes.StoreKey,
+		tokenomicsmoduletypes.StoreKey,
 		// this line is used by starport scaffolding # stargate/app/storeKey
 	)
 	tkeys := sdk.NewTransientStoreKeys(paramstypes.TStoreKey)
@@ -634,6 +640,14 @@ func New(
 	supplierModule := suppliermodule.NewAppModule(appCodec, app.SupplierKeeper, app.AccountKeeper, app.BankKeeper)
 	sessionModule := sessionmodule.NewAppModule(appCodec, app.SessionKeeper, app.AccountKeeper, app.BankKeeper)
 
+	app.TokenomicsKeeper = *tokenomicsmodulekeeper.NewKeeper(
+		appCodec,
+		keys[tokenomicsmoduletypes.StoreKey],
+		keys[tokenomicsmoduletypes.MemStoreKey],
+		app.GetSubspace(tokenomicsmoduletypes.ModuleName),
+	)
+	tokenomicsModule := tokenomicsmodule.NewAppModule(appCodec, app.TokenomicsKeeper, app.AccountKeeper, app.BankKeeper)
+
 	// this line is used by starport scaffolding # stargate/app/keeperDefinition
 
 	/**** IBC Routing ****/
@@ -701,6 +715,7 @@ func New(
 		applicationModule,
 		supplierModule,
 		gatewayModule,
+		tokenomicsModule,
 		// this line is used by starport scaffolding # stargate/app/appModule
 
 		crisis.NewAppModule(app.CrisisKeeper, skipGenesisInvariants, app.GetSubspace(crisistypes.ModuleName)), // always be last to make sure that it checks for all invariants and not only part of them
@@ -739,6 +754,7 @@ func New(
 		applicationmoduletypes.ModuleName,
 		suppliermoduletypes.ModuleName,
 		gatewaymoduletypes.ModuleName,
+		tokenomicsmoduletypes.ModuleName,
 		// this line is used by starport scaffolding # stargate/app/beginBlockers
 	)
 
@@ -770,6 +786,7 @@ func New(
 		applicationmoduletypes.ModuleName,
 		suppliermoduletypes.ModuleName,
 		gatewaymoduletypes.ModuleName,
+		tokenomicsmoduletypes.ModuleName,
 		// this line is used by starport scaffolding # stargate/app/endBlockers
 	)
 
@@ -806,6 +823,7 @@ func New(
 		applicationmoduletypes.ModuleName,
 		suppliermoduletypes.ModuleName,
 		gatewaymoduletypes.ModuleName,
+		tokenomicsmoduletypes.ModuleName,
 		// this line is used by starport scaffolding # stargate/app/initGenesis
 	}
 	app.mm.SetOrderInitGenesis(genesisModuleOrder...)
@@ -1036,6 +1054,7 @@ func initParamsKeeper(appCodec codec.BinaryCodec, legacyAmino *codec.LegacyAmino
 	paramsKeeper.Subspace(applicationmoduletypes.ModuleName)
 	paramsKeeper.Subspace(suppliermoduletypes.ModuleName)
 	paramsKeeper.Subspace(gatewaymoduletypes.ModuleName)
+	paramsKeeper.Subspace(tokenomicsmoduletypes.ModuleName)
 	// this line is used by starport scaffolding # stargate/app/paramSubspace
 
 	return paramsKeeper

diff --git a/docs/static/openapi.yml b/docs/static/openapi.yml
@@ -47176,7 +47176,7 @@ paths:
                             service:
                               title: >-
                                 The Service for which the application is
-                                configured
+                                configured for
                               type: object
                               properties:
                                 id:
@@ -47243,7 +47243,7 @@ paths:
                               service:
                                 title: >-
                                   The Service for which the supplier is
-                                  configured
+                                  configured for
                                 type: object
                                 properties:
                                   id:
@@ -47931,14 +47931,12 @@ paths:
                                   - GRPC
                                   - WEBSOCKET
                                   - JSON_RPC
-                                  - REST
                                 default: UNKNOWN_RPC
                                 description: |-
                                   - UNKNOWN_RPC: Undefined RPC type
                                    - GRPC: gRPC
                                    - WEBSOCKET: WebSocket
                                    - JSON_RPC: JSON-RPC
-                                   - REST: REST
                               configs:
                                 type: array
                                 items:
@@ -48082,14 +48080,12 @@ paths:
                                     - GRPC
                                     - WEBSOCKET
                                     - JSON_RPC
-                                    - REST
                                   default: UNKNOWN_RPC
                                   description: |-
                                     - UNKNOWN_RPC: Undefined RPC type
                                      - GRPC: gRPC
                                      - WEBSOCKET: WebSocket
                                      - JSON_RPC: JSON-RPC
-                                     - REST: REST
                                 configs:
                                   type: array
                                   items:
@@ -48237,6 +48233,46 @@ paths:
           type: boolean
       tags:
         - Query
+  /pokt-network/poktroll/tokenomics/params:
+    get:
+      summary: Parameters queries the parameters of the module.
+      operationId: PoktrollTokenomicsParams
+      responses:
+        '200':
+          description: A successful response.
+          schema:
+            type: object
+            properties:
+              params:
+                description: params holds all the parameters of this module.
+                type: object
+                properties:
+                  computeToTokensMultiplier:
+                    type: string
+                    format: uint64
+            description: >-
+              QueryParamsResponse is response type for the Query/Params RPC
+              method.
+        default:
+          description: An unexpected error response.
+          schema:
+            type: object
+            properties:
+              code:
+                type: integer
+                format: int32
+              message:
+                type: string
+              details:
+                type: array
+                items:
+                  type: object
+                  properties:
+                    '@type':
+                      type: string
+                  additionalProperties: {}
+      tags:
+        - Query
 definitions:
   cosmos.auth.v1beta1.AddressBytesToStringResponse:
     type: object
@@ -77500,7 +77536,7 @@ definitions:
                   type: object
                   properties:
                     service:
-                      title: The Service for which the application is configured
+                      title: The Service for which the application is configured for
                       type: object
                       properties:
                         id:
@@ -77564,7 +77600,7 @@ definitions:
                     type: object
                     properties:
                       service:
-                        title: The Service for which the supplier is configured
+                        title: The Service for which the supplier is configured for
                         type: object
                         properties:
                           id:
@@ -77754,7 +77790,7 @@ definitions:
               type: object
               properties:
                 service:
-                  title: The Service for which the application is configured
+                  title: The Service for which the application is configured for
                   type: object
                   properties:
                     id:
@@ -77816,7 +77852,7 @@ definitions:
                 type: object
                 properties:
                   service:
-                    title: The Service for which the supplier is configured
+                    title: The Service for which the supplier is configured for
                     type: object
                     properties:
                       id:
@@ -77996,7 +78032,6 @@ definitions:
       - GRPC
       - WEBSOCKET
       - JSON_RPC
-      - REST
     default: UNKNOWN_RPC
     description: |-
       - UNKNOWN_RPC: Undefined RPC type
@@ -78031,7 +78066,7 @@ definitions:
           type: object
           properties:
             service:
-              title: The Service for which the supplier is configured
+              title: The Service for which the supplier is configured for
               type: object
               properties:
                 id:
@@ -78064,7 +78099,6 @@ definitions:
                       - GRPC
                       - WEBSOCKET
                       - JSON_RPC
-                      - REST
                     default: UNKNOWN_RPC
                     description: |-
                       - UNKNOWN_RPC: Undefined RPC type
@@ -78122,7 +78156,6 @@ definitions:
           - GRPC
           - WEBSOCKET
           - JSON_RPC
-          - REST
         default: UNKNOWN_RPC
         description: |-
           - UNKNOWN_RPC: Undefined RPC type
@@ -78162,7 +78195,7 @@ definitions:
     type: object
     properties:
       service:
-        title: The Service for which the supplier is configured
+        title: The Service for which the supplier is configured for
         type: object
         properties:
           id:
@@ -78194,7 +78227,6 @@ definitions:
                 - GRPC
                 - WEBSOCKET
                 - JSON_RPC
-                - REST
               default: UNKNOWN_RPC
               description: |-
                 - UNKNOWN_RPC: Undefined RPC type
@@ -78449,14 +78481,12 @@ definitions:
                             - GRPC
                             - WEBSOCKET
                             - JSON_RPC
-                            - REST
                           default: UNKNOWN_RPC
                           description: |-
                             - UNKNOWN_RPC: Undefined RPC type
                              - GRPC: gRPC
                              - WEBSOCKET: WebSocket
                              - JSON_RPC: JSON-RPC
-                             - REST: REST
                         configs:
                           type: array
                           items:
@@ -78631,14 +78661,12 @@ definitions:
                           - GRPC
                           - WEBSOCKET
                           - JSON_RPC
-                          - REST
                         default: UNKNOWN_RPC
                         description: |-
                           - UNKNOWN_RPC: Undefined RPC type
                            - GRPC: gRPC
                            - WEBSOCKET: WebSocket
                            - JSON_RPC: JSON-RPC
-                           - REST: REST
                       configs:
                         type: array
                         items:
@@ -78685,3 +78713,21 @@ definitions:
         description: params holds all the parameters of this module.
         type: object
     description: QueryParamsResponse is response type for the Query/Params RPC method.
+  poktroll.tokenomics.Params:
+    type: object
+    properties:
+      computeToTokensMultiplier:
+        type: string
+        format: uint64
+    description: Params defines the parameters for the module.
+  poktroll.tokenomics.QueryParamsResponse:
+    type: object
+    properties:
+      params:
+        description: params holds all the parameters of this module.
+        type: object
+        properties:
+          computeToTokensMultiplier:
+            type: string
+            format: uint64
+    description: QueryParamsResponse is response type for the Query/Params RPC method.
diff --git a/proto/poktroll/tokenomics/genesis.proto b/proto/poktroll/tokenomics/genesis.proto
@@ -0,0 +1,12 @@
+syntax = "proto3";
+package poktroll.tokenomics;
+
+import "gogoproto/gogo.proto";
+import "poktroll/tokenomics/params.proto";
+
+option go_package = "github.com/pokt-network/poktroll/x/tokenomics/types";
+
+// GenesisState defines the tokenomics module's genesis state.
+message GenesisState {
+  Params params = 1 [(gogoproto.nullable) = false];
+}
diff --git a/proto/poktroll/tokenomics/params.proto b/proto/poktroll/tokenomics/params.proto
@@ -0,0 +1,13 @@
+syntax = "proto3";
+package poktroll.tokenomics;
+
+import "gogoproto/gogo.proto";
+
+option go_package = "github.com/pokt-network/poktroll/x/tokenomics/types";
+
+// Params defines the parameters for the module.
+message Params {
+  option (gogoproto.goproto_stringer) = false;
+
+  uint64 computeToTokensMultiplier = 1 [(gogoproto.moretags) = "yaml:\"compute_to_tokens_multiplier\""];
+}
diff --git a/proto/poktroll/tokenomics/query.proto b/proto/poktroll/tokenomics/query.proto
@@ -0,0 +1,26 @@
+syntax = "proto3";
+package poktroll.tokenomics;
+
+import "gogoproto/gogo.proto";
+import "google/api/annotations.proto";
+import "cosmos/base/query/v1beta1/pagination.proto";
+import "poktroll/tokenomics/params.proto";
+
+option go_package = "github.com/pokt-network/poktroll/x/tokenomics/types";
+
+// Query defines the gRPC querier service.
+service Query {
+  // Parameters queries the parameters of the module.
+  rpc Params(QueryParamsRequest) returns (QueryParamsResponse) {
+    option (google.api.http).get = "/pokt-network/poktroll/tokenomics/params";
+  }
+}
+
+// QueryParamsRequest is request type for the Query/Params RPC method.
+message QueryParamsRequest {}
+
+// QueryParamsResponse is response type for the Query/Params RPC method.
+message QueryParamsResponse {
+  // params holds all the parameters of this module.
+  Params params = 1 [(gogoproto.nullable) = false];
+}
diff --git a/proto/poktroll/tokenomics/tx.proto b/proto/poktroll/tokenomics/tx.proto
@@ -0,0 +1,7 @@
+syntax = "proto3";
+package poktroll.tokenomics;
+
+option go_package = "github.com/pokt-network/poktroll/x/tokenomics/types";
+
+// Msg defines the Msg service.
+service Msg {}