[Testing] refractor: param update E2E tests as integration tests

e2e/tests/0_settlement.feature

@@ -25,8 +25,10 @@ Feature: Tokenomics Namespace
             | proof_requirement_threshold  | 839                                                              | coin  |
             | proof_missing_penalty        | 320                                                              | coin  |
             | proof_submission_fee         | 1000000                                                          | coin  |
-        And the "tokenomics" module parameters are set as follows
+        And all "proof" module params should be updated
+        And the "shared" module parameters are set as follows
             | compute_units_to_tokens_multiplier | 42                                                         | int64 |
+        And all "shared" module params should be updated
         When the supplier "supplier1" has serviced a session with "20" relays for service "anvil" for application "app1"
         # Wait for the Claim & Proof lifecycle
         And the user should wait for the "proof" module "CreateClaim" Message to be submitted
@@ -58,8 +60,10 @@ Feature: Tokenomics Namespace
             | proof_requirement_threshold  | 421                                                              | coin  |
             | proof_missing_penalty        | 320                                                              | coin  |
             | proof_submission_fee         | 1000000                                                          | coin  |
-        And the "tokenomics" module parameters are set as follows
+        And all "proof" module params should be updated
+        And the "shared" module parameters are set as follows
             | compute_units_to_tokens_multiplier | 42                                                         | int64 |
+        And all "shared" module params should be updated
         # Start servicing
         When the supplier "supplier1" has serviced a session with "10" relays for service "anvil" for application "app1"
         # Wait for the Claim & Proof lifecycle

e2e/tests/params_tx_test.go

@@ -41,6 +41,16 @@ func (s *suite) sendAuthzExecTx(signingKeyName, txJSONFilePath string) {
 
 	// TODO_IMPROVE: wait for the tx to be committed using an events query client
 	// instead of sleeping for a specific amount of time.
+	//
+	// First attempt:
+	// eventAttrMatchFn := newEventAttributeMatchFn("action", "/cosmos.authz.v1beta1.MsgExec")
+	// s.waitForTxResultEvent(eventAttrMatchFn)
+	//
+	// This resulted in observing many more events than expected, even accounting
+	// for those corresponding to the param reset step, which is automatically
+	// registered in a s.Cleanup() below. There are no useful attributes on these
+	// events such that we can filter out the noise.
+
 	s.Logf("waiting %d seconds for the authz exec tx to be committed...", txDelaySeconds)
 	time.Sleep(txDelaySeconds * time.Second)
 

e2e/tests/params_types_test.go

@@ -9,7 +9,7 @@ type (
 	paramNameKey = string
 )
 
-// paramsAnyMap is a map of param names to param values.
+// paramsAnyMap is a map of param names to param any values.
 type paramsAnyMap map[paramNameKey]paramAny
 
 // moduleParamsMap is a map of module names to params maps.

e2e/tests/session.feature

@@ -11,8 +11,10 @@ Feature: Session Namespace
         | proof_requirement_threshold  | 209                                                              | coin  |
         | proof_missing_penalty        | 320                                                              | coin  |
         | proof_submission_fee         | 1000000                                                          | coin  |
-    And the "tokenomics" module parameters are set as follows
+    And all "proof" module params should be updated
+    And the "shared" module parameters are set as follows
         | compute_units_to_tokens_multiplier | 42                                                         | int64 |
+    And all "shared" module params should be updated
     When the supplier "supplier1" has serviced a session with "5" relays for service "anvil" for application "app1"
     And the user should wait for the "proof" module "CreateClaim" Message to be submitted
     And the user should wait for the "proof" module "ClaimCreated" tx event to be broadcast

e2e/tests/session_steps_test.go

@@ -207,8 +207,7 @@ func (s *suite) waitForTxResultEvent(eventIsMatch func(*abci.Event) bool) (match
 	ctx, cancel := context.WithCancel(s.ctx)
 
 	// For each observed event, **asynchronously** check if it contains the given action.
-	channel.ForEach[*abci.TxResult](
-		ctx, s.txResultReplayClient.EventsSequence(ctx),
+	s.forEachTxResult(ctx,
 		func(_ context.Context, txResult *abci.TxResult) {
 			if txResult == nil {
 				return
@@ -225,13 +224,6 @@ func (s *suite) waitForTxResultEvent(eventIsMatch func(*abci.Event) bool) (match
 		},
 	)
 
-	select {
-	case <-time.After(eventTimeout):
-		s.Fatalf("ERROR: timed out waiting for tx result event")
-	case <-ctx.Done():
-		s.Log("Success; message detected before timeout.")
-	}
-
 	return matchedEvent
 }
 
@@ -245,8 +237,7 @@ func (s *suite) waitForNewBlockEvent(
 	ctx, done := context.WithCancel(s.ctx)
 
 	// For each observed event, **asynchronously** check if it contains the given action.
-	channel.ForEach[*block.CometNewBlockEvent](
-		ctx, s.newBlockEventsReplayClient.EventsSequence(ctx),
+	s.forEachBlockEvent(ctx,
 		func(_ context.Context, newBlockEvent *block.CometNewBlockEvent) {
 			if newBlockEvent == nil {
 				return
@@ -264,13 +255,6 @@ func (s *suite) waitForNewBlockEvent(
 			}
 		},
 	)
-
-	select {
-	case <-time.After(eventTimeout):
-		s.Fatalf("ERROR: timed out waiting for NewBlock event")
-	case <-ctx.Done():
-		s.Log("Success; message detected before timeout.")
-	}
 }
 
 // waitForBlockHeight waits for a NewBlock event to be observed whose height is
@@ -280,8 +264,7 @@ func (s *suite) waitForBlockHeight(targetHeight int64) {
 
 	// For each observed event, **asynchronously** check if it is greater than
 	// or equal to the target height
-	channel.ForEach[*block.CometNewBlockEvent](
-		ctx, s.newBlockEventsReplayClient.EventsSequence(ctx),
+	s.forEachBlockEvent(ctx,
 		func(_ context.Context, newBlockEvent *block.CometNewBlockEvent) {
 			if newBlockEvent == nil {
 				return
@@ -293,12 +276,46 @@ func (s *suite) waitForBlockHeight(targetHeight int64) {
 			}
 		},
 	)
+}
+
+// forEachBlockEvent calls blockEventFn for each observed block event **asynchronously**
+// and blocks on waiting for the given context to be cancelled. If the context is
+// not cancelled before eventTimeout, the test will fail.
+func (s *suite) forEachBlockEvent(
+	ctx context.Context,
+	blockEventFn func(_ context.Context, newBlockEvent *block.CometNewBlockEvent),
+) {
+	channel.ForEach[*block.CometNewBlockEvent](ctx,
+		s.newBlockEventsReplayClient.EventsSequence(ctx),
+		blockEventFn,
+	)
+
+	select {
+	case <-time.After(eventTimeout):
+		s.Fatalf("ERROR: timed out waiting new block event")
+	case <-ctx.Done():
+		s.Log("Success; new block event detected before timeout.")
+	}
+}
+
+// forEachTxResult calls txResult for each observed tx result **asynchronously**
+// and blocks on waiting for the given context to be cancelled. If the context is
+// not cancelled before eventTimeout, the test will fail.
+func (s *suite) forEachTxResult(
+	ctx context.Context,
+	txResultFn func(_ context.Context, txResult *abci.TxResult),
+) {
+
+	channel.ForEach[*abci.TxResult](ctx,
+		s.txResultReplayClient.EventsSequence(ctx),
+		txResultFn,
+	)
 
 	select {
 	case <-time.After(eventTimeout):
-		s.Fatalf("ERROR: timed out waiting for block height", targetHeight)
+		s.Fatalf("ERROR: timed out waiting for tx result")
 	case <-ctx.Done():
-		s.Log("Success; height detected before timeout.")
+		s.Log("Success; tx result detected before timeout.")
 	}
 }
 

e2e/tests/stake_supplier.feature

@@ -9,6 +9,7 @@ Feature: Stake Supplier Namespace
         And the user should be able to see standard output containing "code: 0"
         And the pocketd binary should exit without error
         And the user should wait for the "supplier" module "StakeSupplier" message to be submitted
+        And the user should wait for the "supplier" module "SupplierStaked" tx event to be broadcast
         And the "supplier" for account "supplier2" is staked with "1000070" uPOKT
         And the account balance of "supplier2" should be "1000070" uPOKT "less" than before
 
@@ -23,8 +24,9 @@ Feature: Stake Supplier Namespace
         And the user should be able to see standard output containing "code: 0"
         And the pocketd binary should exit without error
         And the supplier for account "supplier2" is unbonding
-        When the user waits for the supplier for account "supplier2" unbonding period to finish
-        Then the user verifies the "supplier" for account "supplier2" is not staked
+        And the user should wait for the "supplier" module "SupplierUnbondingBegin" tx event to be broadcast
+        And a "supplier" module "SupplierUnbondingEnd" end block event is broadcast
+        And the user verifies the "supplier" for account "supplier2" is not staked
         And the account balance of "supplier2" should be "1000070" uPOKT "more" than before
 
     Scenario: User can restake a Supplier waiting for it to become active again
@@ -40,4 +42,6 @@ Feature: Stake Supplier Namespace
         Then the session for application "app1" and service "anvil" contains the supplier "supplier2"
         # Cleanup to make this feature idempotent.
         And the user unstakes a "supplier" from the account "supplier2"
-        And the user waits for the supplier for account "supplier2" unbonding period to finish
+        And the supplier for account "supplier2" is unbonding
+        And the user should wait for the "supplier" module "SupplierUnbondingBegin" tx event to be broadcast
+        And a "supplier" module "SupplierUnbondingEnd" end block event is broadcast

e2e/tests/stake_supplier_steps_test.go

@@ -4,11 +4,10 @@ package e2e
 
 import (
 	"reflect"
-	"strings"
-	"unicode"
 
 	"github.com/stretchr/testify/require"
 
+	"github.com/pokt-network/poktroll/testutil/cases"
 	sharedtypes "github.com/pokt-network/poktroll/x/shared/types"
 )
 
@@ -61,7 +60,7 @@ func paramsAnyMapFromParamsStruct(paramStruct any) paramsAnyMap {
 	for i := 0; i < paramsReflectValue.NumField(); i++ {
 		fieldValue := paramsReflectValue.Field(i)
 		fieldStruct := paramsReflectValue.Type().Field(i)
-		paramName := toSnakeCase(fieldStruct.Name)
+		paramName := cases.ToSnakeCase(fieldStruct.Name)
 
 		fieldTypeName := fieldStruct.Type.Name()
 		// TODO_IMPROVE: MsgUpdateParam currently only supports int64 and not uint64 value types.
@@ -78,23 +77,3 @@ func paramsAnyMapFromParamsStruct(paramStruct any) paramsAnyMap {
 	}
 	return paramsMap
 }
-
-func toSnakeCase(str string) string {
-	var result strings.Builder
-
-	for i, runeValue := range str {
-		if unicode.IsUpper(runeValue) {
-			// If it's not the first letter, add an underscore
-			if i > 0 {
-				result.WriteRune('_')
-			}
-			// Convert to lowercase
-			result.WriteRune(unicode.ToLower(runeValue))
-		} else {
-			// Otherwise, just append the rune as-is
-			result.WriteRune(runeValue)
-		}
-	}
-
-	return result.String()
-}

go.mod

@@ -79,7 +79,10 @@ require (
 	gopkg.in/yaml.v2 v2.4.0
 )
 
-require github.com/jhump/protoreflect v1.16.0
+require (
+	cosmossdk.io/x/tx v0.13.4
+	github.com/jhump/protoreflect v1.16.0
+)
 
 require (
 	buf.build/gen/go/bufbuild/protovalidate/protocolbuffers/go v1.34.2-20240508200655-46a4cf4ba109.2 // indirect
@@ -92,7 +95,6 @@ require (
 	connectrpc.com/connect v1.16.2 // indirect
 	connectrpc.com/otelconnect v0.7.0 // indirect
 	cosmossdk.io/collections v0.4.0 // indirect
-	cosmossdk.io/x/tx v0.13.4 // indirect
 	filippo.io/edwards25519 v1.0.0 // indirect
 	github.com/99designs/go-keychain v0.0.0-20191008050251-8e49817e8af4 // indirect
 	github.com/99designs/keyring v1.2.1 // indirect

proto/poktroll/supplier/event.proto

@@ -0,0 +1,28 @@
+syntax = "proto3";
+package poktroll.supplier;
+
+option go_package = "github.com/pokt-network/poktroll/x/supplier/types";
+option (gogoproto.stable_marshaler_all) = true;
+
+import "cosmos_proto/cosmos.proto";
+import "gogoproto/gogo.proto";
+
+import "poktroll/shared/supplier.proto";
+
+// EventSupplierStaked is emitted with the commitment of the supplier stake message.
+message EventSupplierStaked {
+  poktroll.shared.Supplier supplier = 1 [(gogoproto.jsontag) = "supplier"];
+}
+
+// EventSupplierUnstaked is emitted with the commitment of the supplier unstake message.
+message EventSupplierUnbondingBegin {
+  poktroll.shared.Supplier supplier = 1 [(gogoproto.jsontag) = "supplier"];
+  int64 unbonding_height = 2 [(gogoproto.jsontag) = "unbonding_height"];
+}
+
+// EventSupplierUnbondingEnd is emitted with the commitment of last block of the
+// supplier unbonding period.
+message EventSupplierUnbondingEnd {
+  poktroll.shared.Supplier supplier = 1 [(gogoproto.jsontag) = "supplier"];
+  int64 unbonding_height = 2 [(gogoproto.jsontag) = "unbonding_height"];
+}