[Utility] Session Interface - GetSession Implementation (1st iteration)

Makefile

@@ -438,6 +438,7 @@ benchmark_p2p_addrbook: ## Benchmark all P2P addr book related tests
 # TODO          - General Purpose catch-all.
 # TECHDEBT      - Not a great implementation, but we need to fix it later.
 # IMPROVE       - A nice to have, but not a priority. It's okay if we never get to this.
+# OPTIMIZE      - An opportunity for performance improvement if/when it's necessary
 # DISCUSS       - Probably requires a lengthy offline discussion to understand next steps.
 # INCOMPLETE    - A change which was out of scope of a specific PR but needed to be documented.
 # INVESTIGATE   - TBD what was going on, but needed to continue moving and not get distracted.
@@ -453,7 +454,7 @@ benchmark_p2p_addrbook: ## Benchmark all P2P addr book related tests
 # BUG           - There is a known existing bug in this code
 # DISCUSS_IN_THIS_COMMIT - SHOULD NEVER BE COMMITTED TO MASTER. It is a way for the reviewer of a PR to start / reply to a discussion.
 # TODO_IN_THIS_COMMIT    - SHOULD NEVER BE COMMITTED TO MASTER. It is a way to start the review process while non-critical changes are still in progress
-TODO_KEYWORDS = -e "TODO" -e "TECHDEBT" -e "IMPROVE" -e "DISCUSS" -e "INCOMPLETE" -e "INVESTIGATE" -e "CLEANUP" -e "HACK" -e "REFACTOR" -e "CONSIDERATION" -e "TODO_IN_THIS_COMMIT" -e "DISCUSS_IN_THIS_COMMIT" -e "CONSOLIDATE" -e "DEPRECATE" -e "ADDTEST" -e "RESEARCH" -e "BUG"
+TODO_KEYWORDS = -e "TODO" -e "TECHDEBT" -e "IMPROVE" -e "OPTIMIZE" -e "DISCUSS" -e "INCOMPLETE" -e "INVESTIGATE" -e "CLEANUP" -e "HACK" -e "REFACTOR" -e "CONSIDERATION" -e "TODO_IN_THIS_COMMIT" -e "DISCUSS_IN_THIS_COMMIT" -e "CONSOLIDATE" -e "DEPRECATE" -e "ADDTEST" -e "RESEARCH" -e "BUG"
 
 # How do I use TODOs?
 # 1. <KEYWORD>: <Description of follow up work>;

build/config/genesis.json

@@ -4138,6 +4138,7 @@
     "fisherman_unstaking_blocks": 2016,
     "fisherman_minimum_pause_blocks": 4,
     "fisherman_max_pause_blocks": 672,
+    "fisherman_per_session": 1,
     "validator_minimum_stake": "15000000000",
     "validator_unstaking_blocks": 2016,
     "validator_minimum_pause_blocks": 4,
@@ -4192,6 +4193,7 @@
     "fisherman_unstaking_blocks_owner": "da034209758b78eaea06dd99c07909ab54c99b45",
     "fisherman_minimum_pause_blocks_owner": "da034209758b78eaea06dd99c07909ab54c99b45",
     "fisherman_max_paused_blocks_owner": "da034209758b78eaea06dd99c07909ab54c99b45",
+    "fisherman_per_session_owner": "da034209758b78eaea06dd99c07909ab54c99b45",
     "validator_minimum_stake_owner": "da034209758b78eaea06dd99c07909ab54c99b45",
     "validator_unstaking_blocks_owner": "da034209758b78eaea06dd99c07909ab54c99b45",
     "validator_minimum_pause_blocks_owner": "da034209758b78eaea06dd99c07909ab54c99b45",

build/config/genesis_localhost.json

@@ -159,6 +159,7 @@
     "fisherman_unstaking_blocks": 2016,
     "fisherman_minimum_pause_blocks": 4,
     "fisherman_max_pause_blocks": 672,
+    "fisherman_per_session": 1,
     "validator_minimum_stake": "15000000000",
     "validator_unstaking_blocks": 2016,
     "validator_minimum_pause_blocks": 4,
@@ -214,6 +215,7 @@
     "fisherman_unstaking_blocks_owner": "da034209758b78eaea06dd99c07909ab54c99b45",
     "fisherman_minimum_pause_blocks_owner": "da034209758b78eaea06dd99c07909ab54c99b45",
     "fisherman_max_paused_blocks_owner": "da034209758b78eaea06dd99c07909ab54c99b45",
+    "fisherman_per_session_owner": "da034209758b78eaea06dd99c07909ab54c99b45",
     "validator_minimum_stake_owner": "da034209758b78eaea06dd99c07909ab54c99b45",
     "validator_unstaking_blocks_owner": "da034209758b78eaea06dd99c07909ab54c99b45",
     "validator_minimum_pause_blocks_owner": "da034209758b78eaea06dd99c07909ab54c99b45",

build/localnet/manifests/configs.yaml

@@ -4142,6 +4142,7 @@ data:
         "fisherman_unstaking_blocks": 2016,
         "fisherman_minimum_pause_blocks": 4,
         "fisherman_max_pause_blocks": 672,
+        "fisherman_per_session": 1,
         "validator_minimum_stake": "15000000000",
         "validator_unstaking_blocks": 2016,
         "validator_minimum_pause_blocks": 4,
@@ -4196,6 +4197,7 @@ data:
         "fisherman_unstaking_blocks_owner": "da034209758b78eaea06dd99c07909ab54c99b45",
         "fisherman_minimum_pause_blocks_owner": "da034209758b78eaea06dd99c07909ab54c99b45",
         "fisherman_max_paused_blocks_owner": "da034209758b78eaea06dd99c07909ab54c99b45",
+        "fisherman_per_session_owner": "da034209758b78eaea06dd99c07909ab54c99b45",
         "validator_minimum_stake_owner": "da034209758b78eaea06dd99c07909ab54c99b45",
         "validator_unstaking_blocks_owner": "da034209758b78eaea06dd99c07909ab54c99b45",
         "validator_minimum_pause_blocks_owner": "da034209758b78eaea06dd99c07909ab54c99b45",

persistence/actor.go

@@ -1,10 +1,30 @@
 package persistence
 
 import (
+	"fmt"
+
 	"github.com/pokt-network/pocket/persistence/types"
 	coreTypes "github.com/pokt-network/pocket/shared/core/types"
 )
 
+// TODO_IN_THIS_COMMIT: Add tests for this function
+func (p *PostgresContext) GetActor(actorType coreTypes.ActorType, address []byte, height int64) (*coreTypes.Actor, error) {
+	var schema types.ProtocolActorSchema
+	switch actorType {
+	case types.ApplicationActor.GetActorType():
+		schema = types.ApplicationActor
+	case types.ServicerActor.GetActorType():
+		schema = types.ServicerActor
+	case types.FishermanActor.GetActorType():
+		schema = types.FishermanActor
+	case types.ValidatorActor.GetActorType():
+		schema = types.FishermanActor
+	default:
+		return nil, fmt.Errorf("invalid actor type: %s", actorType)
+	}
+	return p.getActor(schema, address, height)
+}
+
 // TODO (#399): All of the functions below following a structure similar to `GetAll<Actor>`
 // can easily be refactored and condensed into a single function using a generic type or a common
 // interface.
@@ -113,7 +133,7 @@ func (p *PostgresContext) GetAllFishermen(height int64) (f []*coreTypes.Actor, e
 	return
 }
 
-// IMPROVE: This is a proof of concept. Ideally we should have a single query that returns all actors.
+// OPTIMIZE: Ideally we should have a single query that returns all actors.
 func (p *PostgresContext) GetAllStakedActors(height int64) (allActors []*coreTypes.Actor, err error) {
 	type actorGetter func(height int64) ([]*coreTypes.Actor, error)
 	actorGetters := []actorGetter{p.GetAllValidators, p.GetAllServicers, p.GetAllFishermen, p.GetAllApps}

persistence/test/module_test.go

@@ -9,7 +9,8 @@ import (
 )
 
 func TestPersistenceContextParallelReadWrite(t *testing.T) {
-	prepareAndCleanContext(t)
+	clearAllState()
+	t.Cleanup(clearAllState)
 
 	// variables for testing
 	_, _, poolAddr := keygen.GetInstance().Next()
@@ -57,7 +58,8 @@ func TestPersistenceContextParallelReadWrite(t *testing.T) {
 }
 
 func TestPersistenceContextTwoWritesErrors(t *testing.T) {
-	prepareAndCleanContext(t)
+	clearAllState()
+	t.Cleanup(clearAllState)
 
 	// Opening up first write context succeeds
 	rwCtx1, err := testPersistenceMod.NewRWContext(0)
@@ -74,7 +76,8 @@ func TestPersistenceContextTwoWritesErrors(t *testing.T) {
 }
 
 func TestPersistenceContextSequentialWrites(t *testing.T) {
-	prepareAndCleanContext(t)
+	clearAllState()
+	t.Cleanup(clearAllState)
 
 	// Opening up first write context succeeds
 	writeContext1, err := testPersistenceMod.NewRWContext(0)
@@ -93,7 +96,8 @@ func TestPersistenceContextSequentialWrites(t *testing.T) {
 }
 
 func TestPersistenceContextMultipleParallelReads(t *testing.T) {
-	prepareAndCleanContext(t)
+	clearAllState()
+	t.Cleanup(clearAllState)
 
 	// Opening up first read context succeeds
 	readContext1, err := testPersistenceMod.NewReadContext(0)
@@ -111,10 +115,3 @@ func TestPersistenceContextMultipleParallelReads(t *testing.T) {
 	readContext2.Release()
 	readContext3.Release()
 }
-
-func prepareAndCleanContext(t *testing.T) {
-	// Cleanup context after the test
-	t.Cleanup(clearAllState)
-
-	clearAllState()
-}

persistence/test/setup_test.go

@@ -41,8 +41,8 @@ var (
 	StakeToUpdate        = utils.BigIntToString((&big.Int{}).Add(DefaultStakeBig, DefaultDeltaBig))
 
 	DefaultStakeStatus     = int32(coreTypes.StakeStatus_Staked)
-	DefaultPauseHeight     = int64(-1) // pauseHeight=-1 means not paused
-	DefaultUnstakingHeight = int64(-1) // pauseHeight=-1 means not unstaking
+	DefaultPauseHeight     = int64(-1) // pauseHeight=-1 implies not paused
+	DefaultUnstakingHeight = int64(-1) // unstakingHeight=-1 implies not unstaking
 
 	OlshanskyURL    = "https://olshansky.info"
 	OlshanskyChains = []string{"OLSH"}
@@ -53,8 +53,10 @@ var (
 	genesisStateNumServicers    = 1
 	genesisStateNumApplications = 1
 	genesisStateNumFishermen    = 1
+
+	// Initialized in TestMain
+	testPersistenceMod modules.PersistenceModule
 )
-var testPersistenceMod modules.PersistenceModule // initialized in TestMain
 
 // See https://github.com/ory/dockertest as reference for the template of this code
 // Postgres example can be found here: https://github.com/ory/dockertest/blob/v3/examples/PostgreSQL.md

persistence/test/state_test.go

@@ -44,9 +44,9 @@ func TestStateHash_DeterministicStateWhenUpdatingAppStake(t *testing.T) {
 	// logic changes, these hashes will need to be updated based on the test output.
 	// TODO: Add an explicit updateSnapshots flag to the test to make this more clear.
 	stateHashes := []string{
-		"3a9a33c4d6b106f656c859296cd5ac16b608980d1d921f6de77051a707f48cb5",
-		"ec3d62106f1ca61dfe9c1d80a16c4ee3923550db5175389777bd1ecd9d50136e",
-		"e440914fba03bbb5ff4fbb73f760e4e75c3635263bbf7c15ca649870ee865222",
+		"93be62191cbc09fea4cf2046bea8e55ccf5e4c6fa7b483a55470d1bca85c3732",
+		"c2ed842d32b099de26dba1fa6d14f367504daf6b914076004aa3df5f7858e5be",
+		"a60fef8fe1b3c5b208041f43cb14641167eeb67faee730ae7d0689765bb9d487",
 	}
 
 	stakeAmount := initialStakeAmount

persistence/types/gov_test.go

@@ -41,6 +41,7 @@ func TestInsertParams(t *testing.T) {
 				"('fisherman_unstaking_blocks', -1, 'BIGINT', 2016)," +
 				"('fisherman_minimum_pause_blocks', -1, 'SMALLINT', 4)," +
 				"('fisherman_max_pause_blocks', -1, 'SMALLINT', 672)," +
+				"('fisherman_per_session', -1, 'SMALLINT', 1)," +
 				"('validator_minimum_stake', -1, 'STRING', '15000000000')," +
 				"('validator_unstaking_blocks', -1, 'BIGINT', 2016)," +
 				"('validator_minimum_pause_blocks', -1, 'SMALLINT', 4)," +
@@ -95,6 +96,7 @@ func TestInsertParams(t *testing.T) {
 				"('fisherman_unstaking_blocks_owner', -1, 'STRING', 'da034209758b78eaea06dd99c07909ab54c99b45')," +
 				"('fisherman_minimum_pause_blocks_owner', -1, 'STRING', 'da034209758b78eaea06dd99c07909ab54c99b45')," +
 				"('fisherman_max_paused_blocks_owner', -1, 'STRING', 'da034209758b78eaea06dd99c07909ab54c99b45')," +
+				"('fisherman_per_session_owner', -1, 'STRING', 'da034209758b78eaea06dd99c07909ab54c99b45')," +
 				"('validator_minimum_stake_owner', -1, 'STRING', 'da034209758b78eaea06dd99c07909ab54c99b45')," +
 				"('validator_unstaking_blocks_owner', -1, 'STRING', 'da034209758b78eaea06dd99c07909ab54c99b45')," +
 				"('validator_minimum_pause_blocks_owner', -1, 'STRING', 'da034209758b78eaea06dd99c07909ab54c99b45')," +