Merge branch 'issues/141/feat/in-memory-network' into issues/141/refa…

…ctor/in-memory-network

* issues/141/feat/in-memory-network:
  chore: review feedback improvements
  feat: update SMT to v0.9.2 (#311)
  fix: linter errors
  fixup! chore: review feedback improvements
  chore: review feedback improvements
  chore: review feedback improvements
  [Testing, Tooling] chore: in-memory network interface & config types (#289)
  trigger CI
  [Supplier] refactor: supplier module errors (#265)
  [Supplier] refactor: supplier module keys (#264)
  [Supplier] refactor: claim & proof protobufs + (#263)
  chore: review feedback improvements
  [Configs] feat: Add staking config parser of gateway staking (#302)
  chore: review feedback improvements
  fix: usage raw string literal
  chore: review feedback improvements
  [RingCache] Invalidate Cache On Redelegation Events (#239)

Makefile

@@ -274,19 +274,19 @@ gateway_list: ## List all the staked gateways
 
 .PHONY: gateway_stake
 gateway_stake: ## Stake tokens for the gateway specified (must specify the gateway env var)
- poktrolld --home=$(POKTROLLD_HOME) tx gateway stake-gateway 1000upokt --keyring-backend test --from $(GATEWAY) --node $(POCKET_NODE)
+ poktrolld --home=$(POKTROLLD_HOME) tx gateway stake-gateway --config $(POKTROLLD_HOME)/config/$(STAKE) --keyring-backend test --from $(GATEWAY) --node $(POCKET_NODE)
 
 .PHONY: gateway1_stake
 gateway1_stake: ## Stake gateway1
- GATEWAY=gateway1 make gateway_stake
+ GATEWAY=gateway1 STAKE=gateway1_stake_config.yaml make gateway_stake
 
 .PHONY: gateway2_stake
 gateway2_stake: ## Stake gateway2
- GATEWAY=gateway2 make gateway_stake
+ GATEWAY=gateway2 STAKE=gateway2_stake_config.yaml make gateway_stake
 
 .PHONY: gateway3_stake
 gateway3_stake: ## Stake gateway3
- GATEWAY=gateway3 make gateway_stake
+ GATEWAY=gateway3 STAKE=gateway3_stake_config.yaml make gateway_stake
 
 .PHONY: gateway_unstake
 gateway_unstake: ## Unstake an gateway (must specify the GATEWAY env var)

e2e/tests/init_test.go

@@ -5,6 +5,7 @@ package e2e
 import (
  "flag"
  "fmt"
+ "io/ioutil"
  "log"
  "os"
  "regexp"
@@ -166,17 +167,36 @@ func (s *suite) TheUserShouldWaitForSeconds(dur int64) {
 }
 
 func (s *suite) TheUserStakesAWithUpoktFromTheAccount(actorType string, amount int64, accName string) {
+ // Create a temporary config file
+ configPathPattern := fmt.Sprintf("%s_stake_config_*.yaml", accName)
+ configContent := fmt.Sprintf(`stake_amount: %d upokt`, amount)
+ configFile, err := ioutil.TempFile("", configPathPattern)
+ if err != nil {
+ s.Fatalf("error creating config file: %q", err)
+ }
+ if _, err = configFile.Write([]byte(configContent)); err != nil {
+ s.Fatalf("error writing config file: %q", err)
+ }
+
  args := []string{
  "tx",
  actorType,
  fmt.Sprintf("stake-%s", actorType),
- fmt.Sprintf("%dupokt", amount),
+ "--config",
+ configFile.Name(),
  "--from",
  accName,
  keyRingFlag,
  "-y",
  }
  res, err := s.pocketd.RunCommandOnHost("", args...)
+
+ // Remove the temporary config file
+ err = os.Remove(configFile.Name())
+ if err != nil {
+ s.Fatalf("error removing config file: %q", err)
+ }
+
  if err != nil {
  s.Fatalf("error staking %s: %s", actorType, err)
  }

go.mod

@@ -24,7 +24,6 @@ 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.3
  github.com/cosmos/gogoproto v1.4.11
  github.com/cosmos/ibc-go/v7 v7.1.0
@@ -36,7 +35,7 @@ require (
  github.com/grpc-ecosystem/grpc-gateway v1.16.0
  github.com/grpc-ecosystem/grpc-gateway/v2 v2.15.2
  github.com/noot/ring-go v0.0.0-20231019173746-6c4b33bcf03f
- github.com/pokt-network/smt v0.8.2
+ github.com/pokt-network/smt v0.9.2
  github.com/pokt-network/smt/kvstore/badger v0.0.0-20240104123447-abb5c71c14ce
  github.com/regen-network/gocuke v0.6.2
  github.com/rs/zerolog v1.29.1
@@ -48,7 +47,6 @@ 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
 )
@@ -92,6 +90,7 @@ 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
@@ -286,6 +285,7 @@ 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

go.sum

@@ -1598,8 +1598,8 @@ github.com/pmezard/go-difflib v0.0.0-20151028094244-d8ed2627bdf0/go.mod h1:iKH77
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 h1:Jamvg5psRIccs7FGNTlIRMkT8wgtp5eCXdBlqhYGL6U=
 github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
-github.com/pokt-network/smt v0.8.2 h1:pCuIuSrEiSZEc6fhjjUXM9395Jqduzx6fZI8MheSJLA=
-github.com/pokt-network/smt v0.8.2/go.mod h1:S4Ho4OPkK2v2vUCHNtA49XDjqUC/OFYpBbynRVYmxvA=
+github.com/pokt-network/smt v0.9.2 h1:h/GnFm1F6mNBbF1hopr+9+y7nr173SU55NX7NxTVU0Y=
+github.com/pokt-network/smt v0.9.2/go.mod h1:S4Ho4OPkK2v2vUCHNtA49XDjqUC/OFYpBbynRVYmxvA=
 github.com/pokt-network/smt/kvstore/badger v0.0.0-20240104123447-abb5c71c14ce h1:JCpmaD35pHq9VWbePNuysIVOX5ybmVzThNY2BcurjVE=
 github.com/pokt-network/smt/kvstore/badger v0.0.0-20240104123447-abb5c71c14ce/go.mod h1:VG/uGRf6wmiDnSxee8rmVtmtLXrVM2SK4/xXtrBFeZ0=
 github.com/polydawn/refmt v0.89.0 h1:ADJTApkvkeBZsN0tBTx8QjpD9JkmxbKp0cxfr9qszm4=

localnet/poktrolld/config/gateway1_stake_config.yaml

@@ -0,0 +1 @@
+stake_amount: 1000upokt

localnet/poktrolld/config/gateway2_stake_config.yaml

@@ -0,0 +1 @@
+stake_amount: 1000upokt

localnet/poktrolld/config/gateway3_stake_config.yaml

@@ -0,0 +1 @@
+stake_amount: 1000upokt

pkg/appgateserver/cmd/cmd.go

@@ -180,10 +180,12 @@ func setupAppGateServerDependencies(
  config.NewSupplyEventsQueryClientFn(queryNodeRPCURL), // leaf
  config.NewSupplyBlockClientFn(), // leaf
  config.NewSupplyQueryClientContextFn(queryNodeGRPCURL), // leaf
+ config.NewSupplyDelegationClientFn(), // leaf
  config.NewSupplyAccountQuerierFn(), // leaf
  config.NewSupplyApplicationQuerierFn(), // leaf
  config.NewSupplySessionQuerierFn(), // leaf
  config.NewSupplyRingCacheFn(),
+
  config.NewSupplyPOKTRollSDKFn(appGateConfig.SigningKey),
  }
 

pkg/client/block/client_integration_test.go

@@ -14,6 +14,8 @@ import (
  "github.com/pokt-network/poktroll/testutil/testclient/testblock"
 )
 
+// TODO(#255): Refactor this integration test to use an in-memory simulated network
+
 const blockIntegrationSubTimeout = 5 * time.Second
 
 func TestBlockClient_LastNBlocks(t *testing.T) {

pkg/client/delegation/client.go

@@ -11,15 +11,25 @@ import (
 
 const (
  // delegationEventQuery is the query used by the EventsQueryClient to subscribe
- // to new delegation events from the the application module on chain.
+ // to all application module events in order to filter for redelegation events.
  // See: https://docs.cosmos.network/v0.47/learn/advanced/events#subscribing-to-events
  // And: https://docs.cosmos.network/v0.47/learn/advanced/events#default-events
- delegationEventQuery = "message.action='pocket.application.EventRedelegation'"
+ // TODO_HACK(#280): Instead of listening to all events and doing a verbose
+ // filter, we should subscribe to both MsgDelegateToGateway and MsgUndelegateFromGateway
+ // messages directly, and filter those for the EventRedelegation event types.
+ // This would save the delegation client from listening to a lot of unnecessary
+ // events, that it filters out.
+ // NB: This is not currently possible because the observer pattern does not
+ // support multiplexing multiple observables into a single observable, that
+ // can supply the EventsReplayClient with both the MsgDelegateToGateway and
+ // MsgUndelegateFromGateway events.
+ delegationEventQuery = "tm.event='Tx' AND message.module='application'"
 
  // defaultRedelegationsReplayLimit is the number of redelegations that the
  // replay observable returned by LastNRedelegations() will be able to replay.
- // TODO_TECHDEBT/TODO_FUTURE: add a `redelegationsReplayLimit` field to the `delegationClient`
- // struct that defaults to this but can be overridden via an option.
+ // TODO_TECHDEBT/TODO_FUTURE: add a `redelegationsReplayLimit` field to the
+ // delegation client struct that defaults to this but can be overridden via
+ // an option in future work.
  defaultRedelegationsReplayLimit = 100
 )
 

pkg/client/delegation/client_test.go

@@ -2,7 +2,6 @@ package delegation_test
 
 import (
  "context"
- "encoding/json"
  "testing"
  "time"
 
@@ -12,29 +11,25 @@ import (
  "github.com/pokt-network/poktroll/pkg/client"
  "github.com/pokt-network/poktroll/pkg/client/delegation"
  "github.com/pokt-network/poktroll/testutil/sample"
+ "github.com/pokt-network/poktroll/testutil/testclient/testdelegation"
  "github.com/pokt-network/poktroll/testutil/testclient/testeventsquery"
- apptypes "github.com/pokt-network/poktroll/x/application/types"
 )
 
 const (
  testTimeoutDuration = 100 * time.Millisecond
 
  // duplicates pkg/client/delegation/client.go's delegationEventQuery for testing purposes.
- delegationEventQuery = "message.action='pocket.application.EventRedelegation'"
+ delegationEventQuery = "tm.event='Tx' AND message.module='application'"
 )
 
 func TestDelegationClient(t *testing.T) {
  var (
- expectedAddress = sample.AccAddress()
- expectedDelegationEvent = apptypes.EventRedelegation{
- AppAddress: expectedAddress,
- GatewayAddress: sample.AccAddress(),
- }
- ctx = context.Background()
+ expectedAppAddress = sample.AccAddress()
+ expectedGatewayAddress = sample.AccAddress()
+ ctx = context.Background()
  )
 
- expectedEventBz, err := json.Marshal(expectedDelegationEvent)
- require.NoError(t, err)
+ expectedEventBz := testdelegation.NewRedelegationEventBytes(t, expectedAppAddress, expectedGatewayAddress)
 
  eventsQueryClient := testeventsquery.NewAnyTimesEventsBytesEventsQueryClient(
  ctx, t,
@@ -58,6 +53,8 @@ func TestDelegationClient(t *testing.T) {
  name: "LastNRedelegations successfully returns latest redelegation",
  fn: func() client.Redelegation {
  lastRedelegation := delegationClient.LastNRedelegations(ctx, 1)[0]
+ require.Equal(t, expectedAppAddress, lastRedelegation.GetAppAddress())
+ require.Equal(t, expectedGatewayAddress, lastRedelegation.GetGatewayAddress())
  return lastRedelegation
  },
  },
@@ -69,7 +66,8 @@ func TestDelegationClient(t *testing.T) {
 
  // Ensure that the observable is replayable via Last.
  lastRedelegation := redelegationObs.Last(ctx, 1)[0]
- require.Equal(t, expectedAddress, lastRedelegation.GetAppAddress())
+ require.Equal(t, expectedAppAddress, lastRedelegation.GetAppAddress())
+ require.Equal(t, expectedGatewayAddress, lastRedelegation.GetGatewayAddress())
 
  return lastRedelegation
  },
@@ -90,7 +88,8 @@ func TestDelegationClient(t *testing.T) {
 
  select {
  case actualRedelegation := <-actualRedelegationCh:
- require.Equal(t, expectedAddress, actualRedelegation.GetAppAddress())
+ require.Equal(t, expectedAppAddress, actualRedelegation.GetAppAddress())
+ require.Equal(t, expectedGatewayAddress, actualRedelegation.GetGatewayAddress())
  case <-time.After(testTimeoutDuration):
  t.Fatal("timed out waiting for redelegation event")
  }

pkg/client/delegation/redelegation.go

@@ -1,16 +1,32 @@
 package delegation
 
+// TODO_TECHDEBT(#280): Refactor to use merged observables and subscribe to
+// MsgDelegateToGateway and MsgUndelegateFromGateway messages directly, instead
+// of listening to all events and doing a verbose filter.
+
 import (
  "encoding/json"
+ "strconv"
+
+ "cosmossdk.io/api/tendermint/abci"
 
  "github.com/pokt-network/poktroll/pkg/client"
  "github.com/pokt-network/poktroll/pkg/client/events"
 )
 
+// redelegationEventType is the type of the EventRedelegation event emitted by
+// both the MsgDelegateToGateway and MsgUndelegateFromGateway messages.
+const redelegationEventType = "pocket.application.EventRedelegation"
+
 var _ client.Redelegation = (*redelegation)(nil)
 
+// TxEvent is an alias for the CometBFT TxResult type used to decode the
+// response bytes from the EventsQueryClient's subscription
+type TxEvent = abci.TxResult
+
 // redelegation wraps the EventRedelegation event emitted by the application
-// module, for use in the observable
+// module, for use in the observable, it is one of the log entries embedded
+// within the log field of the response struct from the app module's query.
 type redelegation struct {
  AppAddress string `json:"app_address"`
  GatewayAddress string `json:"gateway_address"`
@@ -27,22 +43,57 @@ func (d redelegation) GetGatewayAddress() string {
 }
 
 // newRedelegationEventFactoryFn is a factory function that returns a
-// function that attempts to deserialise the given bytes into a redelegation
+// function that attempts to deserialize the given bytes into a redelegation
 // struct. If the delegate struct has an empty app address then an
 // ErrUnmarshalRedelegation error is returned. Otherwise if deserialisation
 // fails then the error is returned.
 func newRedelegationEventFactoryFn() events.NewEventsFn[client.Redelegation] {
- return func(redelegationEventBz []byte) (client.Redelegation, error) {
- redelegationEvent := new(redelegation)
- if err := json.Unmarshal(redelegationEventBz, redelegationEvent); err != nil {
+ return func(eventBz []byte) (client.Redelegation, error) {
+ txEvent := new(TxEvent)
+ // Try to deserialize the provided bytes into a TxEvent.
+ if err := json.Unmarshal(eventBz, txEvent); err != nil {
  return nil, err
  }
-
- if redelegationEvent.AppAddress == "" || redelegationEvent.GatewayAddress == "" {
-  return nil, events.ErrEventsUnmarshalEvent.
-  Wrapf("with redelegation: %s", string(redelegationEventBz))
+ // Check if the TxEvent has empty transaction bytes, which indicates
+ // the message is probably not a valid transaction event.
+ if len(txEvent.Tx) == 0 {
+ return nil, events.ErrEventsUnmarshalEvent.Wrap("empty transaction bytes")
  }
-
- return redelegationEvent, nil
+ // Iterate through the log entries to find EventRedelegation
+ for _, event := range txEvent.Result.Events {
+ if event.GetType_() != redelegationEventType {
+ continue
+ }
+ var redelegationEvent redelegation
+ for _, attr := range event.Attributes {
+ switch attr.Key {
+ case "app_address":
+ appAddr, err := unescape(attr.Value)
+ if err != nil {
+ return nil, events.ErrEventsUnmarshalEvent.Wrapf("cannot retrieve app address: %v", err)
+ }
+ redelegationEvent.AppAddress = appAddr
+ case "gateway_address":
+ gatewayAddr, err := unescape(attr.Value)
+ if err != nil {
+ return nil, events.ErrEventsUnmarshalEvent.Wrapf("cannot retrieve gateway address: %v", err)
+ }
+ redelegationEvent.GatewayAddress = gatewayAddr
+ default:
+ return nil, events.ErrEventsUnmarshalEvent.Wrapf("unknown attribute key: %s", attr.Key)
+ }
+ }
+ // Handle the redelegation event
+ if redelegationEvent.AppAddress == "" || redelegationEvent.GatewayAddress == "" {
+ return nil, events.ErrEventsUnmarshalEvent.
+ Wrapf("empty redelegation event: %s", string(eventBz))
+ }
+ return redelegationEvent, nil
+ }
+ return nil, events.ErrEventsUnmarshalEvent.Wrap("no redelegation event found")
  }
 }
+
+func unescape(s string) (string, error) {
+ return strconv.Unquote(s)
+}

pkg/client/events/replay_client.go

@@ -154,10 +154,10 @@ func (rClient *replayClient[T, R]) goRemapEventsSequence(ctx context.Context, pu
  func(ctx context.Context, eventTypeObs R) {
  if prevEventTypeObs != nil {
  // Just in case the assumption that all transport errors are
- // persistent does not hold, unsubscribe from the previous
- // event type observable in order to prevent unexpected and/or
- // duplicate notifications on the obsersvable returned by this
- // function.
+ // persistent (i.e. they occur once and do not repeat) does not
+ // hold, unsubscribe from the previous event type observable in
+ // order to prevent unexpected and/or duplicate notifications
+ // on the observable returned by this function.
  prevEventTypeObs.UnsubscribeAll()
  } else {
  prevEventTypeObs = eventTypeObs

pkg/client/events/replay_client_integration_test.go

@@ -89,6 +89,9 @@ func TestReplayClient_Remapping(t *testing.T) {
 
  eventNum := readEventCounter.Add(1) - 1
  event := newMessageEventBz(eventNum)
+ // After an arbitrary number of events (2 in this case), simulate
+ // the connection closing so that the replay client can remap the
+ // events it receives without the caller having to resubscribe.
  if eventNum == 2 {
  // Simulate the connection closing
  connMock.Close()

pkg/client/query/accquerier.go

@@ -52,7 +52,7 @@ func (aq *accQuerier) GetAccount(
  }
  var acc accounttypes.AccountI
  if err = queryCodec.UnpackAny(res.Account, &acc); err != nil {
- return nil, ErrQueryUnableToDeserialiseAccount.Wrapf("address: %s [%v]", address, err)
+ return nil, ErrQueryUnableToDeserializeAccount.Wrapf("address: %s [%v]", address, err)
  }
  return acc, nil
 }

pkg/client/query/errors.go

@@ -7,6 +7,6 @@ import (
 var (
  codespace = "query"
  ErrQueryAccountNotFound = sdkerrors.Register(codespace, 1, "account not found")
- ErrQueryUnableToDeserialiseAccount = sdkerrors.Register(codespace, 2, "unable to deserialise account")
+ ErrQueryUnableToDeserializeAccount = sdkerrors.Register(codespace, 2, "unable to deserialize account")
  ErrQueryRetrieveSession = sdkerrors.Register(codespace, 3, "error while trying to retrieve a session")
 )