[Tokenomics] SettleSessionAccounting first implementation (emissions=burn)

app/app.go

@@ -7,6 +7,8 @@ import (
 	"os"
 	"path/filepath"
 
+	// this line is used by starport scaffolding # stargate/app/moduleImport
+
 	autocliv1 "cosmossdk.io/api/cosmos/autocli/v1"
 	reflectionv1 "cosmossdk.io/api/cosmos/reflection/v1"
 	dbm "github.com/cometbft/cometbft-db"
@@ -108,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"
@@ -133,6 +133,7 @@ import (
 	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 (
@@ -660,6 +661,8 @@ func New(
 		keys[tokenomicsmoduletypes.MemStoreKey],
 		app.GetSubspace(tokenomicsmoduletypes.ModuleName),
 		app.BankKeeper,
+		app.ApplicationKeeper,
+		app.SupplierKeeper,
 		authority,
 	)
 	tokenomicsModule := tokenomicsmodule.NewAppModule(appCodec, app.TokenomicsKeeper, app.AccountKeeper, app.BankKeeper)

docs/static/openapi.yml

@@ -47184,7 +47184,7 @@ paths:
                             service:
                               title: >-
                                 The Service for which the application is
-                                configured
+                                configured for
                               type: object
                               properties:
                                 id:
@@ -47251,7 +47251,7 @@ paths:
                               service:
                                 title: >-
                                   The Service for which the supplier is
-                                  configured
+                                  configured for
                                 type: object
                                 properties:
                                   id:
@@ -47287,14 +47287,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:
@@ -77918,7 +77916,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:
@@ -77982,7 +77980,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:
@@ -78017,14 +78015,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:
@@ -78174,7 +78170,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:
@@ -78236,7 +78232,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:
@@ -78271,14 +78267,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:
@@ -78425,7 +78419,6 @@ definitions:
        - GRPC: gRPC
        - WEBSOCKET: WebSocket
        - JSON_RPC: JSON-RPC
-       - REST: REST
     title: Enum to define RPC types
   pocket.shared.Supplier:
     type: object
@@ -78454,7 +78447,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:
@@ -78494,7 +78487,6 @@ definitions:
                        - GRPC: gRPC
                        - WEBSOCKET: WebSocket
                        - JSON_RPC: JSON-RPC
-                       - REST: REST
                   configs:
                     type: array
                     items:
@@ -78553,7 +78545,6 @@ definitions:
            - GRPC: gRPC
            - WEBSOCKET: WebSocket
            - JSON_RPC: JSON-RPC
-           - REST: REST
       configs:
         type: array
         items:
@@ -78587,7 +78578,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:
@@ -78626,7 +78617,6 @@ definitions:
                  - GRPC: gRPC
                  - WEBSOCKET: WebSocket
                  - JSON_RPC: JSON-RPC
-                 - REST: REST
             configs:
               type: array
               items:

e2e/tests/init_test.go

@@ -16,14 +16,15 @@ import (
 
 	tmcli "github.com/cometbft/cometbft/libs/cli"
 	"github.com/cosmos/cosmos-sdk/codec"
+	"github.com/regen-network/gocuke"
+	"github.com/stretchr/testify/require"
+
 	"github.com/pokt-network/poktroll/app"
 	"github.com/pokt-network/poktroll/testutil/testclient"
 	apptypes "github.com/pokt-network/poktroll/x/application/types"
 	sessiontypes "github.com/pokt-network/poktroll/x/session/types"
 	sharedtypes "github.com/pokt-network/poktroll/x/shared/types"
 	suppliertypes "github.com/pokt-network/poktroll/x/supplier/types"
-	"github.com/regen-network/gocuke"
-	"github.com/stretchr/testify/require"
 )
 
 var (

e2e/tests/session.feature

@@ -5,7 +5,7 @@ Feature: Session Namespace
   Scenario: Supplier completes claim/proof lifecycle for a valid session
     Given the user has the pocketd binary installed
     When the supplier "supplier1" has serviced a session with "5" relays for service "svc1" for application "app1"
-    And after the supplier creates a claim for the session for service "svc1" for application "app1"
+    And the user should wait for "5" seconds
     Then the claim created by supplier "supplier1" for service "svc1" for application "app1" should be persisted on-chain
 #  TODO_IMPROVE: ...
 #    And an event should be emitted...

e2e/tests/tokenomics.feature

@@ -0,0 +1,13 @@
+Feature: Tokenomics Namespaces
+
+    # This test
+    Scenario: Basic tokenomics validation that Supplier mint equals Application burn
+        Given the user has the pocketd binary installed
+        And an account exists for "supplier1"
+        And an account exists for "app1"
+        When the supplier "supplier1" has serviced a session with "20" relays for service "svc1" for application "app1"
+        And the user should wait for "5" seconds
+        # TODO_UPNEXT(@Olshansk, #359): Expand on the two expectations below after integrating the tokenomics module
+        # into the supplier module.
+        # Then the account balance of "supplier1" should be "1000" uPOKT "more" than before
+        # And the account balance of "app1" should be "1000" uPOKT "less" than before

go.mod

@@ -24,6 +24,7 @@ require (
 	github.com/athanorlabs/go-dleq v0.1.0
 	github.com/cometbft/cometbft v0.37.2
 	github.com/cometbft/cometbft-db v0.8.0
+	github.com/cosmos/cosmos-proto v1.0.0-beta.2
 	github.com/cosmos/cosmos-sdk v0.47.5
 	github.com/cosmos/gogoproto v1.4.11
 	github.com/cosmos/ibc-go/v7 v7.3.1
@@ -50,6 +51,7 @@ require (
 	golang.org/x/crypto v0.15.0
 	golang.org/x/exp v0.0.0-20230905200255-921286631fa9
 	golang.org/x/sync v0.5.0
+	google.golang.org/genproto/googleapis/api v0.0.0-20230913181813-007df8e322eb
 	google.golang.org/grpc v1.59.0
 	gopkg.in/yaml.v2 v2.4.0
 )
@@ -96,7 +98,6 @@ require (
 	github.com/containerd/cgroups v1.1.0 // indirect
 	github.com/coreos/go-systemd/v22 v22.5.0 // indirect
 	github.com/cosmos/btcutil v1.0.5 // indirect
-	github.com/cosmos/cosmos-proto v1.0.0-beta.2 // indirect
 	github.com/cosmos/go-bip39 v1.0.0 // indirect
 	github.com/cosmos/gogogateway v1.2.0 // indirect
 	github.com/cosmos/iavl v0.20.0 // indirect
@@ -293,7 +294,6 @@ require (
 	google.golang.org/api v0.143.0 // indirect
 	google.golang.org/appengine v1.6.7 // indirect
 	google.golang.org/genproto v0.0.0-20230913181813-007df8e322eb // indirect
-	google.golang.org/genproto/googleapis/api v0.0.0-20230913181813-007df8e322eb // indirect
 	google.golang.org/genproto/googleapis/rpc v0.0.0-20230920204549-e6e6cdab5c13 // indirect
 	google.golang.org/protobuf v1.31.0 // indirect
 	gopkg.in/ini.v1 v1.67.0 // indirect

pkg/sdk/errors.go

@@ -1,6 +1,11 @@
 package sdk
 
-import sdkerrors "cosmossdk.io/errors"
+import (
+	sdkerrors "cosmossdk.io/errors"
+)
+
+// TODO_TECHDEBT: Do a source code wise find-replace using regex pattern match
+// of `sdkerrors\.Wrapf\(([a-zA-Z]+), ` with `$1.Wrapf(`
 
 var (
 	codespace                           = "poktrollsdk"

testutil/keeper/tokenomics.go

@@ -16,27 +16,71 @@ import (
 	"github.com/golang/mock/gomock"
 	"github.com/stretchr/testify/require"
 
+	"github.com/pokt-network/poktroll/testutil/sample"
 	mocks "github.com/pokt-network/poktroll/testutil/tokenomics/mocks"
+	apptypes "github.com/pokt-network/poktroll/x/application/types"
+	sharedtypes "github.com/pokt-network/poktroll/x/shared/types"
+	suppliertypes "github.com/pokt-network/poktroll/x/supplier/types"
 	"github.com/pokt-network/poktroll/x/tokenomics/keeper"
 	"github.com/pokt-network/poktroll/x/tokenomics/types"
 )
 
-func TokenomicsKeeper(t testing.TB) (*keeper.Keeper, sdk.Context) {
+func TokenomicsKeeper(t testing.TB) (
+	k *keeper.Keeper, s sdk.Context,
+	appAddr, supplierAddr string,
+) {
 	storeKey := sdk.NewKVStoreKey(types.StoreKey)
 	memStoreKey := storetypes.NewMemoryStoreKey(types.MemStoreKey)
 
+	// Initialize the in-memory tendermint database
 	db := tmdb.NewMemDB()
 	stateStore := store.NewCommitMultiStore(db)
 	stateStore.MountStoreWithDB(storeKey, storetypes.StoreTypeIAVL, db)
 	stateStore.MountStoreWithDB(memStoreKey, storetypes.StoreTypeMemory, nil)
 	require.NoError(t, stateStore.LoadLatestVersion())
 
+	// Initialize the codec and other necessary components
 	registry := codectypes.NewInterfaceRegistry()
 	cdc := codec.NewProtoCodec(registry)
+	ctrl := gomock.NewController(t)
 
+	// The on-chain governance address
 	authority := authtypes.NewModuleAddress("gov").String()
 
-	ctrl := gomock.NewController(t)
+	// Prepare the test application
+	application := apptypes.Application{
+		Address: sample.AccAddress(),
+		Stake:   &sdk.Coin{Denom: "upokt", Amount: sdk.NewInt(100000)},
+	}
+
+	// Prepare the test supplier
+	supplier := sharedtypes.Supplier{
+		Address: sample.AccAddress(),
+		Stake:   &sdk.Coin{Denom: "upokt", Amount: sdk.NewInt(100000)},
+	}
+
+	// Mock the application keeper
+	mockApplicationKeeper := mocks.NewMockApplicationKeeper(ctrl)
+	mockApplicationKeeper.EXPECT().
+		GetApplication(gomock.Any(), gomock.Eq(application.Address)).
+		Return(application, true).
+		AnyTimes()
+	mockApplicationKeeper.EXPECT().
+		GetApplication(gomock.Any(), gomock.Not(application.Address)).
+		Return(apptypes.Application{}, false).
+		AnyTimes()
+	mockApplicationKeeper.EXPECT().
+		SetApplication(gomock.Any(), gomock.Any()).
+		AnyTimes()
+
+	// Mock the supplier keeper
+	mockSupplierKeeper := mocks.NewMockSupplierKeeper(ctrl)
+	mockSupplierKeeper.EXPECT().
+		GetSupplier(gomock.Any(), supplier.Address).
+		Return(supplier, true).
+		AnyTimes()
+
+	// Mock the bank keeper
 	mockBankKeeper := mocks.NewMockBankKeeper(ctrl)
 	mockBankKeeper.EXPECT().
 		MintCoins(gomock.Any(), gomock.Any(), gomock.Any()).
@@ -45,36 +89,39 @@ func TokenomicsKeeper(t testing.TB) (*keeper.Keeper, sdk.Context) {
 		BurnCoins(gomock.Any(), gomock.Any(), gomock.Any()).
 		AnyTimes()
 	mockBankKeeper.EXPECT().
-		SendCoinsFromModuleToAccount(gomock.Any(), gomock.Any(), types.ModuleName, gomock.Any()).
+		SendCoinsFromModuleToAccount(gomock.Any(), suppliertypes.ModuleName, gomock.Any(), gomock.Any()).
 		AnyTimes()
 	mockBankKeeper.EXPECT().
-		SendCoinsFromModuleToModule(gomock.Any(), types.ModuleName, gomock.Any(), gomock.Any()).
+		SendCoinsFromAccountToModule(gomock.Any(), gomock.Any(), apptypes.ModuleName, gomock.Any()).
 		AnyTimes()
 	mockBankKeeper.EXPECT().
-		SendCoinsFromAccountToModule(gomock.Any(), types.ModuleName, gomock.Any(), gomock.Any()).
+		UndelegateCoinsFromModuleToAccount(gomock.Any(), apptypes.ModuleName, gomock.Any(), gomock.Any()).
 		AnyTimes()
 
+	// Initialize the tokenomics keeper
 	paramsSubspace := typesparams.NewSubspace(cdc,
 		types.Amino,
 		storeKey,
 		memStoreKey,
 		"TokenomicsParams",
 	)
-	k := keeper.NewKeeper(
+	tokenomicsKeeper := keeper.NewKeeper(
 		cdc,
 		storeKey,
 		memStoreKey,
 		paramsSubspace,
 
 		mockBankKeeper,
+		mockApplicationKeeper,
+		mockSupplierKeeper,
 
 		authority,
 	)
 
 	ctx := sdk.NewContext(stateStore, tmproto.Header{}, false, log.NewNopLogger())
 
 	// Initialize params
-	k.SetParams(ctx, types.DefaultParams())
+	tokenomicsKeeper.SetParams(ctx, types.DefaultParams())
 
-	return k, ctx
+	return tokenomicsKeeper, ctx, application.Address, supplier.Address
 }

x/session/types/errors.go

@@ -15,4 +15,5 @@ var (
 	ErrSessionInvalidAppAddress      = sdkerrors.Register(ModuleName, 5, "invalid application address for session")
 	ErrSessionInvalidService         = sdkerrors.Register(ModuleName, 6, "invalid service in session")
 	ErrSessionInvalidBlockHeight     = sdkerrors.Register(ModuleName, 7, "invalid block height for session")
+	ErrSessionInvalidSessionId       = sdkerrors.Register(ModuleName, 8, "invalid sessionId")
 )