[Tokenomics] Implement difficulty proportional rewards (#840)

## Summary This PR incorporated the mining difficulty into the claim reward calculation. * Encapsulates the claimed tokens into a `claim.GetClaimeduPOKT(params, difficulty)` * Implements a test to assert that the difficulty based rewards are proportional to the off-chain relays served. * Removes unused `min_relay_difficulty_bits` gov. param. It is based on the preparation work of PR #836. ## Issue - #781 - #758 ## Type of change Select one or more from the following: - [x] New feature, functionality or library - [ ] Consensus breaking; add the `consensus-breaking` label if so. See #791 for details - [ ] Bug fix - [ ] Code health or cleanup - [ ] Documentation - [ ] Other (specify) ## Testing - [x] **Unit Tests**: `make go_develop_and_test` - [x] **LocalNet E2E Tests**: `make test_e2e` - [ ] **DevNet E2E Tests**: Add the `devnet-test-e2e` label to the PR. ## Sanity Checklist - [x] I have tested my changes using the available tooling - [x] I have commented my code - [x] I have performed a self-review of my own code; both comments & source code - [ ] I create and reference any new tickets, if applicable - [x] I have left TODOs throughout the codebase, if applicable --------- Co-authored-by: Bryan White <[email protected]> Co-authored-by: Daniel Olshansky <[email protected]> Co-authored-by: red-0ne <[email protected]>
pokt-network · Oct 11, 2024 · aab06af · aab06af
1 parent 10140b9
commit aab06af
Show file tree

Hide file tree

Showing 46 changed files with 1,370 additions and 817 deletions.
diff --git a/api/poktroll/proof/event.pulsar.go b/api/poktroll/proof/event.pulsar.go
diff --git a/api/poktroll/service/relay_mining_difficulty.pulsar.go b/api/poktroll/service/relay_mining_difficulty.pulsar.go
diff --git a/api/poktroll/tokenomics/event.pulsar.go b/api/poktroll/tokenomics/event.pulsar.go
diff --git a/config.yml b/config.yml
@@ -167,7 +167,7 @@ genesis:
         max_delegated_gateways: "7"
         min_stake:
           # TODO_MAINNET: Determine realistic amount for minimum application stake amount.
-          amount: "1000000" # 1 POKT
+          amount: "100000000" # 100 POKT
           denom: upokt
       applicationList:
         - address: pokt1mrqt5f7qh8uxs27cjm9t7v9e74a9vvdnq5jva4
@@ -179,7 +179,7 @@ genesis:
           stake:
             # NB: This value should be exactly 1upokt smaller than the value in
             # `supplier1_stake_config.yaml` so that the stake command causes a state change.
-            amount: "1000068"
+            amount: "100000068" # ~100 POKT
             denom: upokt
         - address: pokt1ad28jdap2zfanjd7hpkh984yveney6k9a42man
           delegatee_gateway_addresses: []
@@ -190,7 +190,7 @@ genesis:
           stake:
             # NB: This value should be exactly 1upokt smaller than the value in
             # `supplier1_stake_config.yaml` so that the stake command causes a state change.
-            amount: "1000068"
+            amount: "100000068" # ~100 POKT
             denom: upokt
     supplier:
       supplierList:

diff --git a/docusaurus/docs/develop/developer_guide/adding_params.md b/docusaurus/docs/develop/developer_guide/adding_params.md
@@ -148,9 +148,19 @@ with the default value for the new parameter.
         "@type": "/poktroll.proof.MsgUpdateParams",
         "authority": "pokt10d07y265gmmuvt4z0w9aw880jnsr700j8yv32t",
         "params": {
-          "min_relay_difficulty_bits": "0",
           "proof_request_probability": "0.25",
-          "proof_requirement_threshold": "20",
+          "proof_requirement_threshold":  {
+            "denom": "upokt",
+            "amount": "20000000"
+          },
+          "proof_missing_penalty": {
+            "amount": "320000000",
+            "denom": "upokt"
+          },
+          "proof_submission_fee": {
+            "amount": "1000000",
+            "denom": "upokt"
+          },
           "new_parameter_name": "100" // Add this line
         }
       }

diff --git a/makefiles/params.mk b/makefiles/params.mk
@@ -40,10 +40,6 @@ params_get_proof: ## Get the proof module params
 params_update_proof_all: ## Update the proof module params
 	poktrolld tx authz exec ./tools/scripts/params/proof_all.json $(PARAM_FLAGS)
 
-.PHONY: params_update_proof_min_relay_difficulty_bits
-params_update_proof_min_relay_difficulty_bits: ## Update the proof module min_relay_difficulty_bits param
-	poktrolld tx authz exec ./tools/scripts/params/proof_min_relay_difficulty_bits.json $(PARAM_FLAGS)
-
 .PHONY: params_update_proof_proof_request_probability
 params_update_proof_proof_request_probability: ## Update the proof module proof_request_probability param
 	poktrolld tx authz exec ./tools/scripts/params/proof_proof_request_probability.json $(PARAM_FLAGS)

diff --git a/pkg/client/interface.go b/pkg/client/interface.go
@@ -356,7 +356,7 @@ type ProofQueryClient interface {
 type ServiceQueryClient interface {
 	// GetService queries the chain for the details of the service provided
 	GetService(ctx context.Context, serviceId string) (sharedtypes.Service, error)
-	GetServiceRelayDifficultyTargetHash(ctx context.Context, serviceId string) (servicetypes.RelayMiningDifficulty, error)
+	GetServiceRelayDifficulty(ctx context.Context, serviceId string) (servicetypes.RelayMiningDifficulty, error)
 }
 
 // BankQueryClient defines an interface that enables the querying of the

diff --git a/pkg/client/query/servicequerier.go b/pkg/client/query/servicequerier.go
@@ -5,8 +5,11 @@ import (
 
 	"cosmossdk.io/depinject"
 	"github.com/cosmos/gogoproto/grpc"
+	"google.golang.org/grpc/codes"
+	"google.golang.org/grpc/status"
 
 	"github.com/pokt-network/poktroll/pkg/client"
+	"github.com/pokt-network/poktroll/pkg/crypto/protocol"
 	servicetypes "github.com/pokt-network/poktroll/x/service/types"
 	sharedtypes "github.com/pokt-network/poktroll/x/shared/types"
 )
@@ -61,9 +64,9 @@ func (servq *serviceQuerier) GetService(
 	return res.Service, nil
 }
 
-// GetServiceRelayDifficultyTargetHash queries the onchain data for
+// GetServiceRelayDifficulty queries the onchain data for
 // the relay mining difficulty associated with the given service.
-func (servq *serviceQuerier) GetServiceRelayDifficultyTargetHash(
+func (servq *serviceQuerier) GetServiceRelayDifficulty(
 	ctx context.Context,
 	serviceId string,
 ) (servicetypes.RelayMiningDifficulty, error) {
@@ -72,8 +75,19 @@ func (servq *serviceQuerier) GetServiceRelayDifficultyTargetHash(
 	}
 
 	res, err := servq.serviceQuerier.RelayMiningDifficulty(ctx, req)
+	if status.Code(err) == codes.NotFound {
+		newServiceDifficulty := servicetypes.RelayMiningDifficulty{
+			ServiceId:    serviceId,
+			BlockHeight:  0,
+			NumRelaysEma: 0,
+			TargetHash:   protocol.BaseRelayDifficultyHashBz,
+		}
+
+		return newServiceDifficulty, nil
+	}
 	if err != nil {
 		return servicetypes.RelayMiningDifficulty{}, err
 	}
+
 	return res.RelayMiningDifficulty, nil
 }
diff --git a/pkg/crypto/rings/client.go b/pkg/crypto/rings/client.go
@@ -46,6 +46,7 @@ type ringClient struct {
 // - polylog.Logger
 // - client.ApplicationQueryClient
 // - client.AccountQueryClient
+// - client.SharedQueryClient
 func NewRingClient(deps depinject.Config) (_ crypto.RingClient, err error) {
 	rc := new(ringClient)
 

diff --git a/pkg/relayer/miner/gen/gen_fixtures.go b/pkg/relayer/miner/gen/gen_fixtures.go
@@ -40,7 +40,6 @@ const (
 	defaultSvcID = "svc1"
 )
 
-// TODO_FOLLOWUP(@olshansk, #690): Do a global anycase grep for "DifficultyBits" and update/remove things appropriately.
 var (
 	// flagDifficultyThresholdHashStr is the difficulty threshold hash, as a hex string, that a
 	// randomized, serialized relay must be greater than to be included in the

diff --git a/pkg/relayer/miner/miner.go b/pkg/relayer/miner/miner.go
@@ -128,11 +128,9 @@ func (mnr *miner) getServiceRelayDifficultyTargetHash(ctx context.Context, req *
 		return nil, fmt.Errorf("invalid session header: %w", err)
 	}
 
-	serviceRelayDifficulty, err := mnr.serviceQueryClient.GetServiceRelayDifficultyTargetHash(ctx, sessionHeader.ServiceId)
+	serviceRelayDifficulty, err := mnr.serviceQueryClient.GetServiceRelayDifficulty(ctx, sessionHeader.ServiceId)
 	if err != nil {
-		// TODO_IMPROVE: log the error and a message saying the default relay difficulty target hash
-		// is being used.
-		return protocol.BaseRelayDifficultyHashBz, nil
+		return nil, err
 	}
 
 	return serviceRelayDifficulty.GetTargetHash(), nil

diff --git a/pkg/relayer/miner/miner_test.go b/pkg/relayer/miner/miner_test.go
@@ -46,12 +46,10 @@ func TestMiner_MinedRelays(t *testing.T) {
 		expectedMinedRelays                   = unmarshalHexMinedRelays(t, marshaledMinableRelaysHex)
 	)
 
-	proofQueryClientMock := testqueryclients.NewTestProofQueryClient(t)
-
 	testqueryclients.SetServiceRelayDifficultyTargetHash(t, testSvcId, testRelayMiningTargetHash)
 	serviceQueryClientMock := testqueryclients.NewTestServiceQueryClient(t)
 
-	deps := depinject.Supply(proofQueryClientMock, serviceQueryClientMock)
+	deps := depinject.Supply(serviceQueryClientMock)
 	mnr, err := miner.NewMiner(deps)
 	require.NoError(t, err)
 

diff --git a/pkg/relayer/session/claim.go b/pkg/relayer/session/claim.go
@@ -315,10 +315,12 @@ func (rs *relayerSessionsManager) payableProofsSessionTrees(
 		).Warn().Msg("supplier operator cannot afford to submit proof for claim, skipping")
 	}
 
-	logger.Warn().Msgf(
-		"Supplier operator %q can only afford %d out of %d claims",
-		supplierOpeartorAddress, len(claimableSessionTrees), len(sessionTrees),
-	)
+	if len(claimableSessionTrees) < len(sessionTrees) {
+		logger.Warn().Msgf(
+			"Supplier operator %q can only afford %d out of %d claims",
+			supplierOpeartorAddress, len(claimableSessionTrees), len(sessionTrees),
+		)
+	}
 
 	return claimableSessionTrees, nil
 }
diff --git a/pkg/relayer/session/proof.go b/pkg/relayer/session/proof.go
@@ -15,7 +15,6 @@ import (
 	"github.com/pokt-network/poktroll/x/proof/types"
 	prooftypes "github.com/pokt-network/poktroll/x/proof/types"
 	"github.com/pokt-network/poktroll/x/shared"
-	tokenomics "github.com/pokt-network/poktroll/x/tokenomics"
 )
 
 // submitProofs maps over the given claimedSessions observable.
@@ -277,24 +276,25 @@ func (rs *relayerSessionsManager) isProofRequired(
 	// Create the claim object and use its methods to determine if a proof is required.
 	claim := claimFromSessionTree(sessionTree)
 
-	// Get the number of compute units accumulated through the given session.
-	numClaimComputeUnits, err := claim.GetNumClaimedComputeUnits()
+	proofParams, err := rs.proofQueryClient.GetParams(ctx)
 	if err != nil {
 		return false, err
 	}
 
-	proofParams, err := rs.proofQueryClient.GetParams(ctx)
+	sharedParams, err := rs.sharedQueryClient.GetParams(ctx)
 	if err != nil {
 		return false, err
 	}
 
-	sharedParams, err := rs.sharedQueryClient.GetParams(ctx)
+	// Retrieving the relay mining difficulty for the service at hand
+	serviceId := claim.GetSessionHeader().GetServiceId()
+	relayMiningDifficulty, err := rs.serviceQueryClient.GetServiceRelayDifficulty(ctx, serviceId)
 	if err != nil {
 		return false, err
 	}
 
 	// The amount of uPOKT being claimed.
-	claimedAmount, err := tokenomics.NumComputeUnitsToCoin(*sharedParams, numClaimComputeUnits)
+	claimedAmount, err := claim.GetClaimeduPOKT(*sharedParams, relayMiningDifficulty)
 	if err != nil {
 		return false, err
 	}

diff --git a/pkg/relayer/session/session_test.go b/pkg/relayer/session/session_test.go
@@ -60,6 +60,8 @@ func requireProofCountEqualsExpectedValueFromProofParams(t *testing.T, proofPara
 		Id:                   "svc",
 		ComputeUnitsPerRelay: 2,
 	}
+
+	testqueryclients.SetServiceRelayDifficultyTargetHash(t, service.Id, protocol.BaseRelayDifficultyHashBz)
 	// Add the service to the existing services.
 	testqueryclients.AddToExistingServices(t, service)
 
@@ -157,12 +159,14 @@ func TestRelayerSessionsManager_InsufficientBalanceForProofSubmission(t *testing
 		ComputeUnitsPerRelay: 1,
 	}
 	testqueryclients.AddToExistingServices(t, lowCUPRService)
+	testqueryclients.SetServiceRelayDifficultyTargetHash(t, lowCUPRService.Id, protocol.BaseRelayDifficultyHashBz)
 
 	highCUPRService := sharedtypes.Service{
 		Id:                   "highCUPRService",
 		ComputeUnitsPerRelay: 2,
 	}
 	testqueryclients.AddToExistingServices(t, highCUPRService)
+	testqueryclients.SetServiceRelayDifficultyTargetHash(t, highCUPRService.Id, protocol.BaseRelayDifficultyHashBz)
 
 	lowCUPRServiceActiveSession := &sessiontypes.Session{
 		Header: &sessiontypes.SessionHeader{

diff --git a/proto/poktroll/proof/event.proto b/proto/poktroll/proof/event.proto
@@ -13,7 +13,7 @@ message EventClaimCreated {
   uint64 num_relays = 2 [(gogoproto.jsontag) = "num_relays"];
   uint64 num_claimed_compute_units = 4 [(gogoproto.jsontag) = "num_claimed_compute_units"];
   uint64 num_estimated_compute_units = 5 [(gogoproto.jsontag) = "num_estimated_compute_units"];
-  cosmos.base.v1beta1.Coin claimed_amount_upokt = 6 [(gogoproto.jsontag) = "claimed_amount_upokt"];
+  cosmos.base.v1beta1.Coin claimed_upokt = 6 [(gogoproto.jsontag) = "claimed_upokt"];
 }
 
 // TODO_TEST: Add coverage for claim updates.
@@ -22,7 +22,7 @@ message EventClaimUpdated {
   uint64 num_relays = 2 [(gogoproto.jsontag) = "num_relays"];
   uint64 num_claimed_compute_units = 4 [(gogoproto.jsontag) = "num_claimed_compute_units"];
   uint64 num_estimated_compute_units = 5 [(gogoproto.jsontag) = "num_estimated_compute_units"];
-  cosmos.base.v1beta1.Coin claimed_amount_upokt = 6 [(gogoproto.jsontag) = "claimed_amount_upokt"];
+  cosmos.base.v1beta1.Coin claimed_upokt = 6 [(gogoproto.jsontag) = "claimed_upokt"];
 }
 
 message EventProofSubmitted {
@@ -31,7 +31,7 @@ message EventProofSubmitted {
   uint64 num_relays = 3 [(gogoproto.jsontag) = "num_relays"];
   uint64 num_claimed_compute_units = 4 [(gogoproto.jsontag) = "num_claimed_compute_units"];
   uint64 num_estimated_compute_units = 5 [(gogoproto.jsontag) = "num_estimated_compute_units"];
-  cosmos.base.v1beta1.Coin claimed_amount_upokt = 6 [(gogoproto.jsontag) = "claimed_amount_upokt"];
+  cosmos.base.v1beta1.Coin claimed_upokt = 6 [(gogoproto.jsontag) = "claimed_upokt"];
 }
 
 // TODO_TEST: Add coverage for proof updates.
@@ -41,5 +41,5 @@ message EventProofUpdated {
   uint64 num_relays = 3 [(gogoproto.jsontag) = "num_relays"];
   uint64 num_claimed_compute_units = 4 [(gogoproto.jsontag) = "num_claimed_compute_units"];
   uint64 num_estimated_compute_units = 5 [(gogoproto.jsontag) = "num_estimated_compute_units"];
-  cosmos.base.v1beta1.Coin claimed_amount_upokt = 6 [(gogoproto.jsontag) = "claimed_amount_upokt"];
+  cosmos.base.v1beta1.Coin claimed_upokt = 6 [(gogoproto.jsontag) = "claimed_upokt"];
 }
diff --git a/proto/poktroll/service/relay_mining_difficulty.proto b/proto/poktroll/service/relay_mining_difficulty.proto
@@ -8,6 +8,7 @@ import "gogoproto/gogo.proto";
 
 // RelayMiningDifficulty is a message used to store the on-chain Relay Mining
 // difficulty associated with a specific service ID.
+// TODO_TECHDEBT: Embed this message in the Service message.
 message RelayMiningDifficulty {
     // The service ID the relay mining difficulty is associated with.
     string service_id = 1;

diff --git a/proto/poktroll/tokenomics/event.proto b/proto/poktroll/tokenomics/event.proto
@@ -29,9 +29,9 @@ message EventClaimExpired {
     // Number of estimated compute units claimed as a function of the number of claimed
     // compute units and the relay difficulty multiplier for the particular service.
     uint64 num_estimated_compute_units = 5 [(gogoproto.jsontag) = "num_estimated_compute_units"];
-    // The amount of uPOKT claimed to be rewarded for the work done as a function of
+    // The uPOKT coin claimed to be rewarded for the work done as a function of
     // the number of estimated compute units and the compute uints to token multiplier.
-    cosmos.base.v1beta1.Coin claimed_amount_upokt = 6 [(gogoproto.jsontag) = "claimed_amount_upokt"];
+    cosmos.base.v1beta1.Coin claimed_upokt = 6 [(gogoproto.jsontag) = "claimed_upokt"];
 }
 
 // EventClaimSettled is an event emitted whenever a claim is settled.
@@ -48,9 +48,9 @@ message EventClaimSettled {
     // Number of estimated compute units claimed as a function of the number of claimed
     // compute units and the relay difficulty multiplier for the particular service.
     uint64 num_estimated_compute_units = 5 [(gogoproto.jsontag) = "num_estimated_compute_units"];
-    // The amount of uPOKT claimed to be rewarded for the work done as a function of
+    // The uPOKT coin claimed to be rewarded for the work done as a function of
     // the number of estimated compute units and the compute uints to token multiplier.
-    cosmos.base.v1beta1.Coin claimed_amount_upokt = 6 [(gogoproto.jsontag) = "claimed_amount_upokt"];
+    cosmos.base.v1beta1.Coin claimed_upokt = 6 [(gogoproto.jsontag) = "claimed_upokt"];
 }
 
 // EventApplicationOverserviced is emitted when an application has less stake than