[Relay Mining] Emit events and refactor test helpers (#610)

- `Event` - Emitting an event when the relay mining difficulty is updated - `Flaky` - Added some flaky comments/pointers in different places - `Refactor` - the event filtering function into a shared location - `Utils` - Updated testing to support a signed mined relay Co-authored-by: Bryan White <[email protected]> Co-authored-by: Dima K <[email protected]>
pokt-network · Jun 20, 2024 · 7146146 · 7146146
1 parent e7dad9b
commit 7146146
Show file tree

Hide file tree

Showing 23 changed files with 2,490 additions and 2,282 deletions.
diff --git a/api/poktroll/tokenomics/event.pulsar.go b/api/poktroll/tokenomics/event.pulsar.go
diff --git a/docs/static/openapi.yml b/docs/static/openapi.yml
diff --git a/e2e/tests/init_test.go b/e2e/tests/init_test.go
@@ -291,7 +291,7 @@ func (s *suite) getConfigFileContent(amount int64, actorType, serviceId string)
 			      rpc_type: json_rpc`,
 			amount, serviceId)
 	default:
-		s.Fatalf("unknown actor type %s", actorType)
+		s.Fatalf("ERROR: unknown actor type %s", actorType)
 	}
 	fmt.Println(yaml.NormalizeYAMLIndentation(configContent))
 	return yaml.NormalizeYAMLIndentation(configContent)
@@ -339,7 +339,7 @@ func (s *suite) TheApplicationIsStakedForService(appName string, serviceId strin
 			return
 		}
 	}
-	s.Fatalf("application %s is not staked for service %s", appName, serviceId)
+	s.Fatalf("ERROR: application %s is not staked for service %s", appName, serviceId)
 }
 
 func (s *suite) TheSupplierIsStakedForService(supplierName string, serviceId string) {
@@ -348,7 +348,7 @@ func (s *suite) TheSupplierIsStakedForService(supplierName string, serviceId str
 			return
 		}
 	}
-	s.Fatalf("supplier %s is not staked for service %s", supplierName, serviceId)
+	s.Fatalf("ERROR: supplier %s is not staked for service %s", supplierName, serviceId)
 }
 
 func (s *suite) TheSessionForApplicationAndServiceContainsTheSupplier(appName string, serviceId string, supplierName string) {
@@ -377,7 +377,7 @@ func (s *suite) TheSessionForApplicationAndServiceContainsTheSupplier(appName st
 			return
 		}
 	}
-	s.Fatalf("session for app %s and service %s does not contain supplier %s", appName, serviceId, supplierName)
+	s.Fatalf("ERROR: session for app %s and service %s does not contain supplier %s", appName, serviceId, supplierName)
 }
 
 func (s *suite) TheApplicationSendsTheSupplierARequestForServiceWithPathAndData(appName, supplierName, serviceId, path, requestData string) {
@@ -572,7 +572,7 @@ func (s *suite) validateAmountChange(prevAmount, currAmount int, expectedAmountC
 		require.LessOrEqual(s, currAmount, prevAmount, "%s %s expected to have less upokt but actually had more", accName, balanceType)
 		require.Equal(s, expectedAmountChange, deltaAmount, "%s %s expected) decrease in upokt was incorrect", accName, balanceType)
 	default:
-		s.Fatalf("unknown condition %s", condition)
+		s.Fatalf("ERROR: unknown condition %s", condition)
 	}
 
 }

diff --git a/e2e/tests/parse_params_test.go b/e2e/tests/parse_params_test.go
@@ -67,7 +67,7 @@ func (s *suite) parseParam(table gocuke.DataTable, rowIdx int) paramAny {
 		coinValue := cosmostypes.NewCoin(volatile.DenomuPOKT, math.NewInt(coinAmount))
 		paramValue = &coinValue
 	default:
-		s.Fatalf("unexpected param type %q", paramType)
+		s.Fatalf("ERROR: unexpected param type %q", paramType)
 	}
 
 	return paramAny{
@@ -116,7 +116,7 @@ func (s *suite) newTokenomicsMsgUpdateParams(params paramsMap) cosmostypes.Msg {
 		case tokenomicstypes.ParamComputeUnitsToTokensMultiplier:
 			msgUpdateParams.Params.ComputeUnitsToTokensMultiplier = uint64(paramValue.value.(int64))
 		default:
-			s.Fatalf("unexpected %q type param name %q", paramValue.typeStr, paramName)
+			s.Fatalf("ERROR: unexpected %q type param name %q", paramValue.typeStr, paramName)
 		}
 	}
 	return proto.Message(msgUpdateParams)
@@ -141,7 +141,7 @@ func (s *suite) newProofMsgUpdateParams(params paramsMap) cosmostypes.Msg {
 		case prooftypes.ParamProofMissingPenalty:
 			msgUpdateParams.Params.ProofMissingPenalty = paramValue.value.(*cosmostypes.Coin)
 		default:
-			s.Fatalf("unexpected %q type param name %q", paramValue.typeStr, paramName)
+			s.Fatalf("ERROR: unexpected %q type param name %q", paramValue.typeStr, paramName)
 		}
 	}
 	return proto.Message(msgUpdateParams)
@@ -168,7 +168,7 @@ func (s *suite) newSharedMsgUpdateParams(params paramsMap) cosmostypes.Msg {
 		case sharedtypes.ParamProofWindowCloseOffsetBlocks:
 			msgUpdateParams.Params.ProofWindowCloseOffsetBlocks = uint64(paramValue.value.(int64))
 		default:
-			s.Fatalf("unexpected %q type param name %q", paramValue.typeStr, paramName)
+			s.Fatalf("ERROR: unexpected %q type param name %q", paramValue.typeStr, paramName)
 		}
 	}
 	return proto.Message(msgUpdateParams)
@@ -188,7 +188,7 @@ func (s *suite) newAppMsgUpdateParams(params paramsMap) cosmostypes.Msg {
 		case apptypes.ParamMaxDelegatedGateways:
 			msgUpdateParams.Params.MaxDelegatedGateways = uint64(paramValue.value.(int64))
 		default:
-			s.Fatalf("unexpected %q type param name %q", paramValue.typeStr, paramName)
+			s.Fatalf("ERROR: unexpected %q type param name %q", paramValue.typeStr, paramName)
 		}
 	}
 	return proto.Message(msgUpdateParams)
@@ -208,7 +208,7 @@ func (s *suite) newServiceMsgUpdateParams(params paramsMap) cosmostypes.Msg {
 		case servicetypes.ParamAddServiceFee:
 			msgUpdateParams.Params.AddServiceFee = uint64(paramValue.value.(int64))
 		default:
-			s.Fatalf("unexpected %q type param name %q", paramValue.typeStr, paramName)
+			s.Fatalf("ERROR: unexpected %q type param name %q", paramValue.typeStr, paramName)
 		}
 	}
 	return proto.Message(msgUpdateParams)

diff --git a/e2e/tests/reset_params_test.go b/e2e/tests/reset_params_test.go
@@ -96,7 +96,7 @@ func (s *suite) msgUpdateParamsToDefaultsAny(moduleName string) *codectypes.Any
 			},
 		)
 	default:
-		s.Fatalf("unknown module name: %s", moduleName)
+		s.Fatalf("ERROR: unknown module name: %s", moduleName)
 	}
 	require.NoError(s, err)
 

diff --git a/e2e/tests/session_steps_test.go b/e2e/tests/session_steps_test.go
@@ -10,13 +10,15 @@ import (
 
 	"cosmossdk.io/depinject"
 	abci "github.com/cometbft/cometbft/abci/types"
+	cosmostypes "github.com/cosmos/cosmos-sdk/types"
 	"github.com/stretchr/testify/require"
 
 	"github.com/pokt-network/poktroll/pkg/client"
 	"github.com/pokt-network/poktroll/pkg/client/block"
 	"github.com/pokt-network/poktroll/pkg/client/events"
 	"github.com/pokt-network/poktroll/pkg/client/tx"
 	"github.com/pokt-network/poktroll/pkg/observable/channel"
+	testutilevents "github.com/pokt-network/poktroll/testutil/events"
 	"github.com/pokt-network/poktroll/testutil/testclient"
 	prooftypes "github.com/pokt-network/poktroll/x/proof/types"
 	tokenomicstypes "github.com/pokt-network/poktroll/x/tokenomics/types"
@@ -25,7 +27,7 @@ import (
 const (
 	// eventTimeout is the duration of time to wait after sending a valid tx
 	// before the test should time out (fail).
-	eventTimeout = 60 * time.Second
+	eventTimeout = 100 * time.Second
 	// testServiceId is the service ID used for testing purposes that is
 	// expected to be available in LocalNet.
 	testServiceId = "anvil"
@@ -166,13 +168,23 @@ func (s *suite) TheClaimCreatedBySupplierForServiceForApplicationShouldBeSuccess
 		if event.Type != "poktroll.tokenomics.EventClaimSettled" {
 			return false
 		}
-		claimSettledEvent := s.abciToClaimSettledEvent(event)
+
+		// Parse the event
+		testutilevents.QuoteEventMode(event)
+		typedEvent, err := cosmostypes.ParseTypedEvent(*event)
+		require.NoError(s, err)
+		require.NotNil(s, typedEvent)
+		claimSettledEvent, ok := typedEvent.(*tokenomicstypes.EventClaimSettled)
+		require.True(s, ok)
+
+		// Assert that the claim was settled for the correct application, supplier, and service.
 		claim := claimSettledEvent.Claim
 		require.Equal(s, app.Address, claim.SessionHeader.ApplicationAddress)
 		require.Equal(s, supplier.Address, claim.SupplierAddress)
 		require.Equal(s, serviceId, claim.SessionHeader.Service.Id)
 		require.Greater(s, claimSettledEvent.ComputeUnits, uint64(0), "compute units should be greater than 0")
 		s.Logf("Claim settled for %d compute units w/ proof requirement: %t\n", claimSettledEvent.ComputeUnits, claimSettledEvent.ProofRequired)
+
 		return true
 	}
 
@@ -235,7 +247,7 @@ func (s *suite) waitForTxResultEvent(targetAction string) {
 
 	select {
 	case <-time.After(eventTimeout):
-		s.Fatalf("timed out waiting for message with action %q", targetAction)
+		s.Fatalf("ERROR: timed out waiting for message with action %q", targetAction)
 	case <-ctx.Done():
 		s.Log("Success; message detected before timeout.")
 	}
@@ -280,47 +292,8 @@ func (s *suite) waitForNewBlockEvent(
 
 	select {
 	case <-time.After(eventTimeout):
-		s.Fatalf("timed out waiting for NewBlock event")
+		s.Fatalf("ERROR: timed out waiting for NewBlock event")
 	case <-ctx.Done():
 		s.Log("Success; message detected before timeout.")
 	}
 }
-
-// abciToClaimSettledEvent converts an abci.Event to a tokenomics.EventClaimSettled
-//
-
-func (s *suite) abciToClaimSettledEvent(event *abci.Event) *tokenomicstypes.EventClaimSettled {
-	var claimSettledEvent tokenomicstypes.EventClaimSettled
-
-	// TODO_TECHDEBT: Investigate why `cosmostypes.ParseTypedEvent(*event)` throws
-	// an error where cosmostypes is imported from "github.com/cosmos/cosmos-sdk/types"
-	// resulting in the following error:
-	// 'json: error calling MarshalJSON for type json.RawMessage: invalid character 'E' looking for beginning of value'
-	// typedEvent, err := cosmostypes.ParseTypedEvent(*event)
-
-	for _, attr := range event.Attributes {
-		switch string(attr.Key) {
-		case "claim":
-			var claim prooftypes.Claim
-			if err := s.cdc.UnmarshalJSON([]byte(attr.Value), &claim); err != nil {
-				s.Fatalf("Failed to unmarshal claim: %v", err)
-			}
-			claimSettledEvent.Claim = &claim
-		case "compute_units":
-			value := string(attr.Value)
-			value = value[1 : len(value)-1] // Remove surrounding quotes
-			computeUnits, err := strconv.ParseUint(value, 10, 64)
-			if err != nil {
-				s.Fatalf("Failed to parse compute_units: %v", err)
-			}
-			claimSettledEvent.ComputeUnits = computeUnits
-		case "proof_required":
-			proofRequired, err := strconv.ParseBool(string(attr.Value))
-			if err != nil {
-				s.Fatalf("Failed to parse proof_required: %v", err)
-			}
-			claimSettledEvent.ProofRequired = proofRequired
-		}
-	}
-	return &claimSettledEvent
-}
diff --git a/pkg/relayer/miner/miner_test.go b/pkg/relayer/miner/miner_test.go
@@ -70,7 +70,7 @@ func TestMiner_MinedRelays(t *testing.T) {
 
 	// Assert that all minable relay fixtures were published to minedRelays.
 	actualMinedRelaysMu.Lock()
-	require.EqualValues(t, expectedMinedRelays, actualMinedRelays)
+	require.EqualValues(t, expectedMinedRelays, actualMinedRelays, "TODO_FLAKY: Try re-running with 'go test -v -count=1 -run TestMiner_MinedRelays ./pkg/relayer/miner/...'")
 	actualMinedRelaysMu.Unlock()
 }
 

diff --git a/pkg/relayer/session/session_test.go b/pkg/relayer/session/session_test.go
@@ -25,23 +25,28 @@ import (
 	"github.com/pokt-network/poktroll/testutil/testclient/testsupplier"
 	"github.com/pokt-network/poktroll/testutil/testpolylog"
 	"github.com/pokt-network/poktroll/testutil/testrelayer"
+	sessiontypes "github.com/pokt-network/poktroll/x/session/types"
 	"github.com/pokt-network/poktroll/x/shared"
 	sharedtypes "github.com/pokt-network/poktroll/x/shared/types"
 )
 
 func TestRelayerSessionsManager_Start(t *testing.T) {
-	const (
-		sessionStartHeight = 1
-		sessionEndHeight   = 2
-	)
-
 	// TODO_TECHDEBT(#446): Centralize the configuration for the SMT spec.
 	var (
 		_, ctx         = testpolylog.NewLoggerWithCtx(context.Background(), polyzero.DebugLevel)
 		spec           = smt.NewTrieSpec(sha256.New(), true)
 		emptyBlockHash = make([]byte, spec.PathHasherSize())
+		activeSession  *sessiontypes.Session
 	)
 
+	activeSession = &sessiontypes.Session{
+		Header: &sessiontypes.SessionHeader{
+			SessionStartBlockHeight: 1,
+			SessionEndBlockHeight:   2,
+		},
+	}
+	sessionHeader := activeSession.GetHeader()
+
 	// Set up dependencies.
 	blocksObs, blockPublishCh := channel.NewReplayObservable[client.Block](ctx, 1)
 	blockClient := testblock.NewAnyTimesCommittedBlocksSequenceBlockClient(t, emptyBlockHash, blocksObs)
@@ -94,20 +99,22 @@ func TestRelayerSessionsManager_Start(t *testing.T) {
 	relayerSessionsManager.Start(ctx)
 
 	// Publish a mined relay to the minedRelaysPublishCh to insert into the session tree.
-	minedRelay := testrelayer.NewMinedRelay(t, sessionStartHeight, sessionEndHeight, supplierAddress)
+	minedRelay := testrelayer.NewUnsignedMinedRelay(t, activeSession, supplierAddress)
 	minedRelaysPublishCh <- minedRelay
 
 	// Wait a tick to allow the relayer sessions manager to process asynchronously.
 	// It should have created a session tree for the relay.
 	time.Sleep(10 * time.Millisecond)
 
 	// Publish a block to the blockPublishCh to simulate non-actionable blocks.
+	sessionStartHeight := sessionHeader.GetSessionStartBlockHeight()
 	noopBlock := testblock.NewAnyTimesBlock(t, emptyBlockHash, sessionStartHeight)
 	blockPublishCh <- noopBlock
 
 	// Calculate the session grace period end block height to emit that block height
 	// to the blockPublishCh to trigger claim creation for the session.
 	sharedParams := sharedtypes.DefaultParams()
+	sessionEndHeight := sessionHeader.GetSessionEndBlockHeight()
 	sessionClaimWindowOpenHeight := shared.GetClaimWindowOpenHeight(&sharedParams, sessionEndHeight)
 
 	// Publish a block to the blockPublishCh to trigger claim creation for the session.

diff --git a/proto/poktroll/tokenomics/event.proto b/proto/poktroll/tokenomics/event.proto
@@ -20,3 +20,13 @@ message EventClaimSettled {
     uint64 compute_units = 2;
     bool proof_required = 3;
 }
+
+// EventRelayMiningDifficultyUpdated is an event emitted whenever the relay mining difficulty is updated
+// for a given service.
+message EventRelayMiningDifficultyUpdated {
+    string service_id = 1;
+    string prev_target_hash_hex_encoded = 2;
+    string new_target_hash_hex_encoded = 3;
+    uint64 prev_num_relays_ema = 4;
+    uint64 new_num_relays_ema = 5;
+}