[Testing, Tooling] chore: in-memory network interface & config types

proto/pocket/supplier/claim.proto

@@ -4,11 +4,13 @@ package pocket.supplier;
 option go_package = "github.com/pokt-network/poktroll/x/supplier/types";
 
 import "cosmos_proto/cosmos.proto";
+import "pocket/session/session.proto";
 
 // Claim is the serialized object stored on-chain for claims pending to be proven
 message Claim {
  string supplier_address = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"]; // the address of the supplier that submitted this claim
- string session_id = 2; // session id from the SessionHeader
- uint64 session_end_block_height = 3; // session end block height from the SessionHeader
- bytes root_hash = 4; // smt.SMST#Root()
+ // The session header of the session that this claim is for.
+ session.SessionHeader session_header = 2;
+ // Root hash returned from smt.SMST#Root().
+ bytes root_hash = 3;
 }

proto/pocket/supplier/proof.proto

@@ -1,14 +1,16 @@
 syntax = "proto3";
 package pocket.supplier;
 
+import "cosmos_proto/cosmos.proto";
+import "pocket/session/session.proto";
+
 option go_package = "github.com/pokt-network/poktroll/x/supplier/types";
 
-// TODO_UPNEXT(@Olshansk): The structure below is the default (untouched) scaffolded type. Update
-// and productionize it for our use case.
 message Proof {
- string index = 1;
- string supplier_address = 2;
- string session_id = 3;
- string merkle_proof = 4;
+ string supplier_address = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
+ // The session header of the session that this claim is for.
+ session.SessionHeader session_header = 2;
+ // The serialized SMST proof from the `#ClosestProof()` method.
+ bytes closest_merkle_proof = 3;
 }
 

proto/pocket/supplier/query.proto

@@ -2,9 +2,10 @@ syntax = "proto3";
 
 package pocket.supplier;
 
+import "cosmos_proto/cosmos.proto";
+import "cosmos/base/query/v1beta1/pagination.proto";
 import "gogoproto/gogo.proto";
 import "google/api/annotations.proto";
-import "cosmos/base/query/v1beta1/pagination.proto";
 import "pocket/supplier/params.proto";
 import "pocket/shared/supplier.proto";
 import "pocket/supplier/claim.proto";
@@ -76,7 +77,7 @@ message QueryAllSupplierResponse {
 
 message QueryGetClaimRequest {
  string session_id = 1;
- string supplier_address = 2;
+ string supplier_address = 2 [(cosmos_proto.scalar) = "cosmos.AddressString"];
 }
 
 message QueryGetClaimResponse {

testutil/network/config.go

@@ -0,0 +1,86 @@
+package network
+
+import (
+ "fmt"
+ "testing"
+ "time"
+
+ db "github.com/cometbft/cometbft-db"
+ "github.com/cometbft/cometbft/libs/rand"
+ "github.com/cosmos/cosmos-sdk/baseapp"
+ "github.com/cosmos/cosmos-sdk/crypto/hd"
+ "github.com/cosmos/cosmos-sdk/crypto/keyring"
+ sdkservertypes "github.com/cosmos/cosmos-sdk/server/types"
+ pruninttypes "github.com/cosmos/cosmos-sdk/store/pruning/types"
+ "github.com/cosmos/cosmos-sdk/testutil/network"
+ "github.com/cosmos/cosmos-sdk/testutil/sims"
+ sdk "github.com/cosmos/cosmos-sdk/types"
+ "github.com/cosmos/cosmos-sdk/x/auth/types"
+
+ "github.com/pokt-network/poktroll/app"
+)
+
+// GetNumApplications returns the number of applications to be created in the network at genesis.
+func (cfg *InMemoryNetworkConfig) GetNumApplications(t *testing.T) int {
+ t.Helper()
+
+ if cfg.NumApplications > 0 {
+ return cfg.NumApplications
+ }
+
+ return cfg.AppSupplierPairingRatio * cfg.NumSuppliers
+}
+
+// GetNumKeyringAccounts returns the number of keyring accounts needed for the given configuration.
+func (cfg *InMemoryNetworkConfig) GetNumKeyringAccounts(t *testing.T) int {
+ t.Helper()
+
+ return cfg.NumGateways + cfg.NumSuppliers + cfg.GetNumApplications(t)
+}
+
+// DefaultConfig will initialize config for the network with custom application,
+// genesis and single validator. All other parameters are inherited from cosmos-sdk/testutil/network.DefaultConfig
+//
+// TODO_UPNEXT(@bryanchriswhite #285): Remove _ prefix after DebugConfig is removed from network.go.
+func _DefaultConfig() network.Config {
+ var (
+ encoding = app.MakeEncodingConfig()
+ chainID = "chain-" + rand.NewRand().Str(6)
+ )
+ return network.Config{
+ Codec: encoding.Marshaler,
+ TxConfig: encoding.TxConfig,
+ LegacyAmino: encoding.Amino,
+ InterfaceRegistry: encoding.InterfaceRegistry,
+ AccountRetriever: types.AccountRetriever{},
+ AppConstructor: func(val network.ValidatorI) sdkservertypes.Application {
+ return app.New(
+ val.GetCtx().Logger,
+ db.NewMemDB(),
+ nil,
+ true,
+ map[int64]bool{},
+ val.GetCtx().Config.RootDir,
+ 0,
+ encoding,
+ sims.EmptyAppOptions{},
+ baseapp.SetPruning(pruninttypes.NewPruningOptionsFromString(val.GetAppConfig().Pruning)),
+ baseapp.SetMinGasPrices(val.GetAppConfig().MinGasPrices),
+ baseapp.SetChainID(chainID),
+ )
+ },
+ GenesisState: app.ModuleBasics.DefaultGenesis(encoding.Marshaler),
+ TimeoutCommit: 2 * time.Second,
+ ChainID: chainID,
+ NumValidators: 1,
+ BondDenom: sdk.DefaultBondDenom,
+ MinGasPrices: fmt.Sprintf("0.000006%s", sdk.DefaultBondDenom),
+ AccountTokens: sdk.TokensFromConsensusPower(1000, sdk.DefaultPowerReduction),
+ StakingTokens: sdk.TokensFromConsensusPower(500, sdk.DefaultPowerReduction),
+ BondedTokens: sdk.TokensFromConsensusPower(100, sdk.DefaultPowerReduction),
+ PruningStrategy: pruninttypes.PruningOptionNothing,
+ CleanupDir: true,
+ SigningAlgo: string(hd.Secp256k1Type),
+ KeyringOptions: []keyring.Option{},
+ }
+}

testutil/network/interface.go

@@ -0,0 +1,30 @@
+package network
+
+import (
+ "context"
+ "testing"
+
+ "github.com/cosmos/cosmos-sdk/client"
+ "github.com/cosmos/cosmos-sdk/testutil/network"
+)
+
+// InMemoryCosmosNetwork encapsulates the cosmos-sdk testutil network instance and
+// the responsibility of initializing it, along with (optional) additional/ setup,
+// in #Start(). It also provides access to additional cosmos-sdk testutil network
+// internals via corresponding methods.
+type InMemoryCosmosNetwork interface {
+ // GetClientCtx returns a cosmos-sdk client.Context associated with the
+ // underlying cosmos-sdk testutil network instance.
+ GetClientCtx(*testing.T) client.Context
+
+ // GetNetworkConfig returns the underlying cosmos-sdk testutil network config.
+ GetNetworkConfig(*testing.T) *network.Config
+
+ // GetNetwork returns the underlying cosmos-sdk testutil network instance.
+ GetNetwork(*testing.T) *network.Network
+
+ // Start initializes the in-memory network, performing any setup
+ // (e.g. preparing on-chain state) for the test scenarios which
+ // will be exercised afterward.
+ Start(context.Context, *testing.T)
+}

testutil/network/types.go

@@ -0,0 +1,56 @@
+package network
+
+import (
+ "github.com/cosmos/cosmos-sdk/crypto/keyring"
+ "github.com/cosmos/cosmos-sdk/testutil/network"
+)
+
+// TestMerkleProofPath is intended to be used as a "path" in a merkle tree for
+// which to generate a proof.
+var TestMerkleProofPath = []byte("test_proof_merkle_path")
+
+// InMemoryNetworkConfig is a **SHARED** config struct for use by InMemoryCosmosNetwork
+// implementations to configure themselves, provide the necessary parameters to set-up
+// code, and initialize the underlying cosmos-sdk testutil network.
+//
+// Examples of set-up operations include but are not limited to:
+// - Creating accounts in the local keyring.
+// - Creating genesis state for (a) module(s).
+// - Executing on-chain transactions (i.e. on-chain, non-genesis state).
+type InMemoryNetworkConfig struct {
+ // NumSessions is the number of sessions (with sequential start heights) for
+ // which the network should generate claims and proofs.
+ NumSessions int
+
+ // NumRelaysPerSession is the number of nodes to be inserted into each claim's
+ // session tree prior to generating the corresponding proof.
+ NumRelaysPerSession int
+
+ // NumSuppliers is the number of suppliers that should be created at genesis.
+ NumSuppliers int
+
+ // NumGateways is the number of gateways that should be created at genesis.
+ NumGateways int
+
+ // NumApplications is the number of applications that should be created at genesis.
+ // Usage is mutually exclusive with AppSupplierPairingRatio. This is enforced by
+ // InMemoryCosmosNetwork implementations.
+ NumApplications int
+
+ // AppSupplierPairingRatio is the number of applications, per supplier, that
+ // share a serviceId (i.e. will be in the same session).
+ // Usage is mutually exclusive with NumApplications. This is enforced by
+ // InMemoryCosmosNetwork implementations.
+ AppSupplierPairingRatio int
+
+ // CosmosCfg is the configuration for the underlying cosmos-sdk testutil network.
+ CosmosCfg *network.Config
+
+ // Keyring is the keyring to be used by clients of the cosmos-sdk testutil network.
+ // It is intended to be populated with a sufficient number of accounts for the
+ // InMemoryCosmosNetwork implementation's use cases. BaseInMemoryCosmosNetwork
+ // implements a #GetNumKeyringAccounts() for this purpose.
+ // This keyring is associated with the cosmos client context returned from
+ // BaseInMemoryCosmosNetwork#GetClientCtx().
+ Keyring keyring.Keyring
+}

x/session/keeper/query_get_session.go

@@ -32,7 +32,7 @@ func (k Keeper) GetSession(goCtx context.Context, req *types.QueryGetSessionRequ
  blockHeight = ctx.BlockHeight()
  }
 
- sessionHydrator := NewSessionHydrator(req.ApplicationAddress, req.Service.Id, req.BlockHeight)
+ sessionHydrator := NewSessionHydrator(req.ApplicationAddress, req.Service.Id, blockHeight)
  session, err := k.HydrateSession(ctx, sessionHydrator)
  if err != nil {
  return nil, err

x/session/keeper/session_hydrator.go

@@ -96,7 +96,9 @@ func (k Keeper) hydrateSessionMetadata(ctx sdk.Context, sh *sessionHydrator) err
  }
 
  sh.session.NumBlocksPerSession = NumBlocksPerSession
- sh.session.SessionNumber = int64(sh.blockHeight / NumBlocksPerSession)
+ sh.session.SessionNumber = sh.blockHeight / NumBlocksPerSession
+
+ // NB: SessionStartBlockHeight should be aligned to NumBlocksPerSession.
  sh.sessionHeader.SessionStartBlockHeight = sh.blockHeight - (sh.blockHeight % NumBlocksPerSession)
  sh.sessionHeader.SessionEndBlockHeight = sh.sessionHeader.SessionStartBlockHeight + NumBlocksPerSession
  return nil

x/supplier/client/cli/helpers_test.go

@@ -214,10 +214,15 @@ func createClaim(
 
  // TODO_TECHDEBT: Forward the actual claim in the response once the response is updated to return it.
  return &types.Claim{
- SupplierAddress: supplierAddr,
- SessionId: sessionId,
- SessionEndBlockHeight: uint64(sessionEndHeight),
- RootHash: rootHash,
+ SupplierAddress: supplierAddr,
+ SessionHeader: &sessiontypes.SessionHeader{
+ ApplicationAddress: appAddress,
+ Service: &sharedtypes.Service{Id: testServiceId},
+ SessionId: sessionId,
+ SessionStartBlockHeight: sessionStartHeight,
+ SessionEndBlockHeight: sessionEndHeight,
+ },
+ RootHash: rootHash,
  }
 }
 

x/supplier/client/cli/query_claim.go

@@ -82,14 +82,16 @@ func CmdShowClaim() *cobra.Command {
  cmd := &cobra.Command{
  Use: "show-claim <session_id> <supplier_addr>",
  Short: "shows a specific claim",
- Long: `List a specific claim that the node being queried has access to (if it still exists)
+ Long: `List a specific claim that the node being queried has access to (if it still exists).
 
-A unique claim can be defined via a session_id that a supplier participated in
+A unique claim can be defined via a session_id that the given supplier participated in.
+Claims are pruned, according to protocol parameters, some time after their respective proof has been submitted and any dispute window has elapsed.
+This is done to minimize the rate state accumulation by effectively eliminating claims as a long-term factor to persistence requirements.
 
 Example:
 $ poktrolld --home=$(POKTROLLD_HOME) q claim show-claims <session_id> <supplier_address> --node $(POCKET_NODE)`,
  Args: cobra.ExactArgs(2),
- RunE: func(cmd *cobra.Command, args []string) (err error) {
+ RunE: func(cmd *cobra.Command, args []string) error {
  sessionId := args[0]
  supplierAddr := args[1]