Ticket #211: finding unnecessary public functions in the Persistence Module

docs/development/FAQ.md

@@ -0,0 +1,10 @@
+# FAQ
+
+A list of common issues & resolutions shared by the V1 contributors
+
+## Avoid redundant files from iCloud backup
+
+* **Issue**: when working on MacOS with iCloud backup turned on, redundant files could be generated in GitHub projects. (e.g. `file.go` and `file 2.go`) Details can be found here in [this link](https://stackoverflow.com/a/62387243). 
+* **Solution**: adding `.nosync` as suffix to the workspace folder, e.g. `pocket.nosync`. Alternative, working in a folder that iCloud doesn't touch also works.
+
+## Consider turning of the `gofmt` in your IDE to prevent unexpected formatting

persistence/CHANGELOG.md

@@ -5,8 +5,11 @@ All notable changes to this module will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+**TODO:** consolidate `persistence/docs/CHANGELOG` and `persistence/CHANGELOG.md`
+
 ## [Unreleased]
 
+
 ## [0.0.0.6] - 2022-10-06
 
 - Don't ignore the exit code of `m.Run()` in the unit tests

persistence/account.go

@@ -17,13 +17,12 @@ const (
 
 // --- Account Functions ---
 
-//
 func (p PostgresContext) GetAccountAmount(address []byte, height int64) (amount string, err error) {
 	return p.getAccountAmountStr(hex.EncodeToString(address), height)
 }
 
 func (p PostgresContext) getAccountAmountStr(address string, height int64) (amount string, err error) {
-	ctx, tx, err := p.GetCtxAndTx()
+	ctx, tx, err := p.getCtxAndTx()
 	if err != nil {
 		return
 	}
@@ -51,9 +50,9 @@ func (p PostgresContext) SubtractAccountAmount(address []byte, amount string) er
 }
 
 // DISCUSS(team): If we are okay with `GetAccountAmount` return 0 as a default, this function can leverage
-//                `operationAccountAmount` with `*orig = *delta` and make everything much simpler.
+// `operationAccountAmount` with `*orig = *delta` and make everything much simpler.
 func (p PostgresContext) SetAccountAmount(address []byte, amount string) error {
-	ctx, tx, err := p.GetCtxAndTx()
+	ctx, tx, err := p.getCtxAndTx()
 	if err != nil {
 		return err
 	}
@@ -76,7 +75,7 @@ func (p *PostgresContext) operationAccountAmount(address []byte, deltaAmount str
 
 // TODO(andrew): remove address param
 func (p PostgresContext) InsertPool(name string, address []byte, amount string) error {
-	ctx, tx, err := p.GetCtxAndTx()
+	ctx, tx, err := p.getCtxAndTx()
 	if err != nil {
 		return err
 	}
@@ -91,7 +90,7 @@ func (p PostgresContext) InsertPool(name string, address []byte, amount string)
 }
 
 func (p PostgresContext) GetPoolAmount(name string, height int64) (amount string, err error) {
-	ctx, tx, err := p.GetCtxAndTx()
+	ctx, tx, err := p.getCtxAndTx()
 	if err != nil {
 		return
 	}
@@ -119,10 +118,10 @@ func (p PostgresContext) SubtractPoolAmount(name string, amount string) error {
 }
 
 // DISCUSS(team): If we are okay with `GetPoolAmount` return 0 as a default, this function can leverage
-//                `operationPoolAmount` with `*orig = *delta` and make everything much simpler.
+//	`operationPoolAmount` with `*orig = *delta` and make everything much simpler.
 // DISCUSS(team): Do we have a use-case for this function?
 func (p PostgresContext) SetPoolAmount(name string, amount string) error {
-	ctx, tx, err := p.GetCtxAndTx()
+	ctx, tx, err := p.getCtxAndTx()
 	if err != nil {
 		return err
 	}
@@ -144,7 +143,7 @@ func (p *PostgresContext) operationPoolOrAccAmount(name, amount string,
 	op func(*big.Int, *big.Int) error,
 	getAmount func(string, int64) (string, error),
 	insert func(name, amount string, height int64) string) error {
-	ctx, tx, err := p.GetCtxAndTx()
+	ctx, tx, err := p.getCtxAndTx()
 	if err != nil {
 		return err
 	}

persistence/application.go

@@ -2,8 +2,6 @@ package persistence
 
 import (
 	"encoding/hex"
-	"log"
-
 	"github.com/pokt-network/pocket/persistence/types"
 	"github.com/pokt-network/pocket/shared/modules"
 )
@@ -13,7 +11,7 @@ func (p PostgresContext) GetAppExists(address []byte, height int64) (exists bool
 }
 
 func (p PostgresContext) GetApp(address []byte, height int64) (operator, publicKey, stakedTokens, maxRelays, outputAddress string, pauseHeight, unstakingHeight int64, chains []string, err error) {
-	actor, err := p.GetActor(types.ApplicationActor, address, height)
+	actor, err := p.getActor(types.ApplicationActor, address, height)
 	operator = actor.Address
 	publicKey = actor.PublicKey
 	stakedTokens = actor.StakedAmount
@@ -50,16 +48,11 @@ func (p PostgresContext) UpdateApp(address []byte, maxRelays string, stakedAmoun
 }
 
 func (p PostgresContext) GetAppStakeAmount(height int64, address []byte) (string, error) {
-	return p.GetActorStakeAmount(types.ApplicationActor, address, height)
+	return p.getActorStakeAmount(types.ApplicationActor, address, height)
 }
 
 func (p PostgresContext) SetAppStakeAmount(address []byte, stakeAmount string) error {
-	return p.SetActorStakeAmount(types.ApplicationActor, address, stakeAmount)
-}
-
-func (p PostgresContext) DeleteApp(_ []byte) error {
-	log.Println("[DEBUG] DeleteApp is a NOOP")
-	return nil
+	return p.setActorStakeAmount(types.ApplicationActor, address, stakeAmount)
 }
 
 func (p PostgresContext) GetAppsReadyToUnstake(height int64, _ int32) ([]modules.IUnstakingActor, error) {

persistence/block.go

@@ -10,7 +10,7 @@ import (
 
 // OPTIMIZE(team): get from blockstore or keep in memory
 func (p PostgresContext) GetLatestBlockHeight() (latestHeight uint64, err error) {
-	ctx, tx, err := p.GetCtxAndTx()
+	ctx, tx, err := p.getCtxAndTx()
 	if err != nil {
 		return 0, err
 	}
@@ -21,7 +21,7 @@ func (p PostgresContext) GetLatestBlockHeight() (latestHeight uint64, err error)
 
 // OPTIMIZE(team): get from blockstore or keep in cache/memory
 func (p PostgresContext) GetBlockHash(height int64) ([]byte, error) {
-	ctx, tx, err := p.GetCtxAndTx()
+	ctx, tx, err := p.getCtxAndTx()
 	if err != nil {
 		return nil, err
 	}
@@ -67,7 +67,7 @@ func (p PostgresContext) StoreBlock(blockProtoBytes []byte) error {
 }
 
 func (p PostgresContext) InsertBlock(height uint64, hash string, proposerAddr []byte, quorumCert []byte) error {
-	ctx, tx, err := p.GetCtxAndTx()
+	ctx, tx, err := p.getCtxAndTx()
 	if err != nil {
 		return err
 	}

persistence/db.go

@@ -45,15 +45,15 @@ type PostgresContext struct {
 	txIndexer  indexer.TxIndexer
 }
 
-func (pg *PostgresContext) GetCtxAndTx() (context.Context, pgx.Tx, error) {
+func (pg *PostgresContext) getCtxAndTx() (context.Context, pgx.Tx, error) {
 	return context.TODO(), pg.GetTx(), nil
 }
 
 func (pg *PostgresContext) GetTx() pgx.Tx {
 	return pg.tx
 }
 
-func (pg *PostgresContext) GetCtx() (context.Context, error) {
+func (pg *PostgresContext) getCtx() (context.Context, error) {
 	return context.TODO(), nil
 }
 
@@ -187,7 +187,7 @@ func initializeBlockTables(ctx context.Context, db *pgx.Conn) error {
 
 // Exposed for testing purposes only
 func (p PostgresContext) DebugClearAll() error {
-	ctx, tx, err := p.GetCtxAndTx()
+	ctx, tx, err := p.getCtxAndTx()
 	if err != nil {
 		return err
 	}

persistence/docs/CHANGELOG.md

@@ -5,8 +5,42 @@ All notable changes to this module will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+**TODO:** consolidate `persistence/docs/CHANGELOG` and `persistence/CHANGELOG.md`
+
 ## [Unreleased]
 
+## [0.0.0.9] - 2022-11-04
+
+- Changed the following exposed functions to lowercase non-exported functions
+- [./pocket/persistence/]
+  - GetActor
+  - GetActorFromRow
+  - GetChainsForActor
+  - SetActorStakeAmount
+  - GetActorStakeAmount
+  - GetCtxAndTx
+  - GetCtx
+  - SetValidatorStakedTokens
+  - GetValidatorStakedTokens
+- [./pocket/persistence/types]
+  - ProtocolActorTableSchema
+  - ProtocolActorChainsTableSchema
+  - SelectChains
+  - ReadyToUnstake
+  - InsertChains
+  - UpdateUnstakingHeight
+  - UpdateStakeAmount
+  - UpdatePausedHeight
+  - UpdateUnstakedHeightIfPausedBefore
+  - AccToAccInterface
+  - TestInsertParams
+  - AccountOrPoolSchema
+  - InsertAcc
+  - SelectBalance
+- [./pocket/persistence/test]
+  - GetGenericActor
+  - NewTestGenericActor
+
 ## [0.0.0.8] - 2022-10-19
 
 - Fixed `ToPersistenceActors()` by filling all structure fields

persistence/fisherman.go

@@ -12,7 +12,7 @@ func (p PostgresContext) GetFishermanExists(address []byte, height int64) (exist
 }
 
 func (p PostgresContext) GetFisherman(address []byte, height int64) (operator, publicKey, stakedTokens, serviceURL, outputAddress string, pausedHeight, unstakingHeight int64, chains []string, err error) {
-	actor, err := p.GetActor(types.FishermanActor, address, height)
+	actor, err := p.getActor(types.FishermanActor, address, height)
 	operator = actor.Address
 	publicKey = actor.PublicKey
 	stakedTokens = actor.StakedAmount
@@ -49,11 +49,11 @@ func (p PostgresContext) UpdateFisherman(address []byte, serviceURL string, stak
 }
 
 func (p PostgresContext) GetFishermanStakeAmount(height int64, address []byte) (string, error) {
-	return p.GetActorStakeAmount(types.FishermanActor, address, height)
+	return p.getActorStakeAmount(types.FishermanActor, address, height)
 }
 
 func (p PostgresContext) SetFishermanStakeAmount(address []byte, stakeAmount string) error {
-	return p.SetActorStakeAmount(types.FishermanActor, address, stakeAmount)
+	return p.setActorStakeAmount(types.FishermanActor, address, stakeAmount)
 }
 
 func (p PostgresContext) GetFishermenReadyToUnstake(height int64, status int32) ([]modules.IUnstakingActor, error) {

persistence/genesis.go

@@ -155,12 +155,10 @@ func (m *persistenceModule) populateGenesisState(state modules.PersistenceGenesi
 }
 
 // TODO(pocket/issues/149): 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.
+//  interface.
 func (p PostgresContext) GetAllAccounts(height int64) (accs []modules.Account, err error) {
-	ctx, tx, err := p.GetCtxAndTx()
+	ctx, tx, err := p.getCtxAndTx()
 	if err != nil {
 		return nil, err
 	}
@@ -184,7 +182,7 @@ func (p PostgresContext) GetAllAccounts(height int64) (accs []modules.Account, e
 
 // CLEANUP: Consolidate with GetAllAccounts.
 func (p PostgresContext) GetAllPools(height int64) (accs []modules.Account, err error) {
-	ctx, tx, err := p.GetCtxAndTx()
+	ctx, tx, err := p.getCtxAndTx()
 	if err != nil {
 		return nil, err
 	}
@@ -203,7 +201,7 @@ func (p PostgresContext) GetAllPools(height int64) (accs []modules.Account, err
 }
 
 func (p PostgresContext) GetAllApps(height int64) (apps []modules.Actor, err error) {
-	ctx, tx, err := p.GetCtxAndTx()
+	ctx, tx, err := p.getCtxAndTx()
 	if err != nil {
 		return nil, err
 	}
@@ -214,15 +212,15 @@ func (p PostgresContext) GetAllApps(height int64) (apps []modules.Actor, err err
 	var actors []*types.Actor
 	for rows.Next() {
 		var actor *types.Actor
-		actor, height, err = p.GetActorFromRow(rows)
+		actor, height, err = p.getActorFromRow(rows)
 		if err != nil {
 			return
 		}
 		actors = append(actors, actor)
 	}
 	rows.Close()
 	for _, actor := range actors {
-		actor, err = p.GetChainsForActor(ctx, tx, types.ApplicationActor, actor, height)
+		actor, err = p.getChainsForActor(ctx, tx, types.ApplicationActor, actor, height)
 		if err != nil {
 			return
 		}
@@ -232,7 +230,7 @@ func (p PostgresContext) GetAllApps(height int64) (apps []modules.Actor, err err
 }
 
 func (p PostgresContext) GetAllValidators(height int64) (vals []modules.Actor, err error) {
-	ctx, tx, err := p.GetCtxAndTx()
+	ctx, tx, err := p.getCtxAndTx()
 	if err != nil {
 		return nil, err
 	}
@@ -243,15 +241,15 @@ func (p PostgresContext) GetAllValidators(height int64) (vals []modules.Actor, e
 	var actors []*types.Actor
 	for rows.Next() {
 		var actor *types.Actor
-		actor, height, err = p.GetActorFromRow(rows)
+		actor, height, err = p.getActorFromRow(rows)
 		if err != nil {
 			return
 		}
 		actors = append(actors, actor)
 	}
 	rows.Close()
 	for _, actor := range actors {
-		actor, err = p.GetChainsForActor(ctx, tx, types.ApplicationActor, actor, height)
+		actor, err = p.getChainsForActor(ctx, tx, types.ApplicationActor, actor, height)
 		if err != nil {
 			return
 		}
@@ -261,7 +259,7 @@ func (p PostgresContext) GetAllValidators(height int64) (vals []modules.Actor, e
 }
 
 func (p PostgresContext) GetAllServiceNodes(height int64) (sn []modules.Actor, err error) {
-	ctx, tx, err := p.GetCtxAndTx()
+	ctx, tx, err := p.getCtxAndTx()
 	if err != nil {
 		return nil, err
 	}
@@ -272,15 +270,15 @@ func (p PostgresContext) GetAllServiceNodes(height int64) (sn []modules.Actor, e
 	var actors []*types.Actor
 	for rows.Next() {
 		var actor *types.Actor
-		actor, height, err = p.GetActorFromRow(rows)
+		actor, height, err = p.getActorFromRow(rows)
 		if err != nil {
 			return
 		}
 		actors = append(actors, actor)
 	}
 	rows.Close()
 	for _, actor := range actors {
-		actor, err = p.GetChainsForActor(ctx, tx, types.ServiceNodeActor, actor, height)
+		actor, err = p.getChainsForActor(ctx, tx, types.ServiceNodeActor, actor, height)
 		if err != nil {
 			return
 		}
@@ -290,7 +288,7 @@ func (p PostgresContext) GetAllServiceNodes(height int64) (sn []modules.Actor, e
 }
 
 func (p PostgresContext) GetAllFishermen(height int64) (f []modules.Actor, err error) {
-	ctx, tx, err := p.GetCtxAndTx()
+	ctx, tx, err := p.getCtxAndTx()
 	if err != nil {
 		return nil, err
 	}
@@ -301,15 +299,15 @@ func (p PostgresContext) GetAllFishermen(height int64) (f []modules.Actor, err e
 	var actors []*types.Actor
 	for rows.Next() {
 		var actor *types.Actor
-		actor, height, err = p.GetActorFromRow(rows)
+		actor, height, err = p.getActorFromRow(rows)
 		if err != nil {
 			return
 		}
 		actors = append(actors, actor)
 	}
 	rows.Close()
 	for _, actor := range actors {
-		actor, err = p.GetChainsForActor(ctx, tx, types.FishermanActor, actor, height)
+		actor, err = p.getChainsForActor(ctx, tx, types.FishermanActor, actor, height)
 		if err != nil {
 			return
 		}