[Core] Productionize End-to-end tx from iteration 3 demo

build/pkeys/val1.json

@@ -0,0 +1 @@
+"6fd0bc54cc2dd205eaf226eebdb0451629b321f11d279013ce6fdd5a33059256b2eda2232ffb2750bf761141f70f75a03a025f65b2b2b417c7f8b3c9ca91e8e4"

build/pkeys/val2.json

@@ -0,0 +1 @@
+"5db3e9d97d04d6d70359de924bb02039c602080d6bf01a692bad31ad5ef93524c16043323c83ffd901a8bf7d73543814b8655aa4695f7bfb49d01926fc161cdb"

build/pkeys/val3.json

@@ -0,0 +1 @@
+"b37d3ba2f232060c41ba1177fea6008d885fcccad6826d64ee7d49f94d1dbc49a8b6be75d7551da093f788f7286c3a9cb885cfc8e52710eac5f1d5e5b4bf19b2"

build/pkeys/val4.json

@@ -0,0 +1 @@
+"c6c136d010d07d7f5e9944aa3594a10f9210dd3e26ebc1bc1516a6d957fd0df353ee26c82826694ffe1773d7b60d5f20dd9e91bdf8745544711bec5ff9c6fb4a"

consensus/doc/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.0.0.11] - 2022-12-06
+
+- Removed unused `consensus.UtilityMessage`
+
 ## [0.0.0.10] - 2022-11-30
 
 - Propagate `highPrepareQC` if available to the block being created

consensus/helpers.go

@@ -26,7 +26,6 @@ const (
 	ByzantineThreshold = float64(2) / float64(3)
 
 	HotstuffMessageContentType = "consensus.HotstuffMessage"
-	UtilityMessageContentType  = "consensus.UtilityMessage"
 )
 
 var (

consensus/module.go

@@ -235,6 +235,7 @@ func (m *consensusModule) GetPrivateKey() (cryptoPocket.PrivateKey, error) {
 func (m *consensusModule) HandleMessage(message *anypb.Any) error {
 	m.m.Lock()
 	defer m.m.Unlock()
+
 	switch message.MessageName() {
 	case HotstuffMessageContentType:
 		msg, err := codec.GetCodec().FromAny(message)
@@ -248,8 +249,6 @@ func (m *consensusModule) HandleMessage(message *anypb.Any) error {
 		if err := m.handleHotstuffMessage(hotstuffMessage); err != nil {
 			return err
 		}
-	case UtilityMessageContentType:
-		panic("[WARN] UtilityMessage handling is not implemented by consensus yet...")
 	default:
 		return typesCons.ErrUnknownConsensusMessageType(message.MessageName())
 	}

docs/demos/iteration_3_end_to_end_tx.md

@@ -0,0 +1,134 @@
+# Iteration 3 Demo <!-- omit in toc -->
+
+**Table of Contents**
+
+- [Goals](#goals)
+- [Shell #1: Setup LocalNet](#shell-1-setup-localnet)
+- [Shell #2: Setup Consensus debugger](#shell-2-setup-consensus-debugger)
+- [Shell #3: Inspect the data in the database for node1](#shell-3-inspect-the-data-in-the-database-for-node1)
+- [Shell #4: Inspect the data in the database for node3](#shell-4-inspect-the-data-in-the-database-for-node3)
+- [Shell #5: Trigger a send transaction from the CLI](#shell-5-trigger-a-send-transaction-from-the-cli)
+  - [Available Commands](#available-commands)
+  - [First Transaction](#first-transaction)
+  - [Second Transaction](#second-transaction)
+- [\[Optional\] Shell #6: See Swagger UI](#optional-shell-6-see-swagger-ui)
+
+## Goals
+
+The first video of this demo can be accessed [here](https://drive.google.com/file/d/1IOrzq-XJP04BJjyqPPpPu873aSfwrnur/view?usp=sharing).
+
+The goal of iteration 3 was to have a success end-to-end transaction that:
+
+- Uses docker-compose on LocalNet
+- Is composed of 4 hard-coded validator nodes
+- Starts the LocalNet from genesis
+- Uses the CLI to send a transaction
+- Uses a basic version of HotPOKT for consensus
+- Uses a basic version of RainTree for brodcast
+
+<img width="842" alt="Screenshot 2022-12-05 at 9 02 28 PM" src="https://user-images.githubusercontent.com/1892194/205820691-26e801e4-ff79-4132-a7a1-358860ca2335.png">
+
+## Shell #1: Setup LocalNet
+
+```bash
+m̶a̶k̶e̶ ̶d̶o̶c̶k̶e̶r̶_̶w̶i̶p̶e̶ # [Optional] Clear everything (takes a long time)
+make # show all the commands
+make docker_wipe_nodes # clear all the 4 validator nodes
+make db_drop # clear the existing database
+make compose_and_watch # Start 4 validator node LocalNet
+```
+
+## Shell #2: Setup Consensus debugger
+
+```bash
+make client_start && make client_connect # start the consensus debugger
+```
+
+Use `TriggerNextView` and `PrintNodeState` to increment and inspect each node's `height/round/step`.
+
+## Shell #3: Inspect the data in the database for node1
+
+Connect to the SQL DB of node #1:
+
+```bash
+make db_show_schemas # show that there are 4 node schemas
+make db_cli_node # connect to the default node 1
+```
+
+Query the blocks, accounts and pools from the DB:
+
+```sql
+show search_path;
+select height, hash from block;
+select * from account;
+select * from pool;
+```
+
+## Shell #4: Inspect the data in the database for node3
+
+```bash
+psqlSchema=node3 make db_cli_node # connect to node 3
+```
+
+Query the blocks, accounts and pools from the DB:
+
+```sql
+show search_path;
+select height, hash from block;
+select * from account;
+select * from pool;
+```
+
+## Shell #5: Trigger a send transaction from the CLI
+
+### Available Commands
+
+Show all the commands available in the CLI:
+
+```bash
+go run app/client/*.go
+```
+
+### First Transaction
+
+Trigger a send transaction from validator 1 to validator 2.
+
+```bash
+go run app/client/*.go --path_to_private_key_file=/Users/olshansky/workspace/pocket/pocket/build/pkeys/val1.json Account Send 6f66574e1f50f0ef72dff748c3f11b9e0e89d32a 67eb3f0a50ae459fecf666be0e93176e92441317 1000
+```
+
+1. Use shell #2 to `TriggerNextView` and confirm height increased via `PrintNodeState`
+   - You may need to do this more than once in case there's a bug.
+2. Use shell #3 to inspect how the balances changes
+   - You should see new records with the height `1`
+   - You should see that the `DAO` got some money
+   - You should see that funds were moved from one account to another
+3. Use shell #4 to inspect how the balances changes
+   - You should see the same data as above
+4. Use shell #2 to `ShowLatestBlockInStore`
+   - You should see the data for the block at height `1`
+
+### Second Transaction
+
+Trigger a send transaction from validator 2 to validator 1.
+
+```bash
+go run app/client/*.go --path_to_private_key_file=/Users/olshansky/workspace/pocket/pocket/build/pkeys/val2.json Account Send 67eb3f0a50ae459fecf666be0e93176e92441317 6f66574e1f50f0ef72dff748c3f11b9e0e89d32a 1000
+```
+
+1. Use shell #2 to `TriggerNextView` (one or more times) and confirm height increased via `PrintNodeState`
+   - You may need to do this more than once in case there's a bug.
+2. Use shell #3 to inspect how the balances changes
+   - You should see new records with the height `2`
+   - You should see that the `DAO` got some money
+   - You should see that funds were moved from one account to another
+3. Use shell #4 to inspect how the balances changes
+   - You should see the same data as above
+4. Use shell #2 to `ShowLatestBlockInStore`
+   - You should see the data for the block at height `2`
+
+## [Optional] Shell #6: See Swagger UI
+
+```bash
+make swagger-ui
+```

persistence/CHANGELOG.md

@@ -9,6 +9,10 @@ TODO: consolidate `persistence/docs/CHANGELOG` and `persistence/CHANGELOG.md`
 
 ## [Unreleased]
 
+## [0.0.0.10] - 2022-12-06
+
+- Changed the scope of `TransactionExists` from the `PostgresContext` to the `PersistenceModule`
+
 ## [0.0.0.9] - 2022-11-30
 
 Core StateHash changes

persistence/block.go

@@ -9,6 +9,22 @@ import (
 	"github.com/pokt-network/pocket/shared/codec"
 )
 
+func (p *persistenceModule) TransactionExists(transactionHash string) (bool, error) {
+	hash, err := hex.DecodeString(transactionHash)
+	if err != nil {
+		return false, err
+	}
+	res, err := p.txIndexer.GetByHash(hash)
+	if res == nil {
+		// check for not found
+		if err != nil && err.Error() == kvstore.BadgerKeyNotFoundError {
+			return false, nil
+		}
+		return false, err
+	}
+	return true, err
+}
+
 // OPTIMIZE: evaluate if it's faster to get this from the blockstore (or cache) than the SQL engine
 func (p PostgresContext) GetLatestBlockHeight() (latestHeight uint64, err error) {
 	ctx, tx, err := p.getCtxAndTx()
@@ -40,22 +56,6 @@ func (p PostgresContext) GetHeight() (int64, error) {
 	return p.Height, nil
 }
 
-func (p PostgresContext) TransactionExists(transactionHash string) (bool, error) {
-	hash, err := hex.DecodeString(transactionHash)
-	if err != nil {
-		return false, err
-	}
-	res, err := p.txIndexer.GetByHash(hash)
-	if res == nil {
-		// check for not found
-		if err != nil && err.Error() == kvstore.BadgerKeyNotFoundError {
-			return false, nil
-		}
-		return false, err
-	}
-	return true, err
-}
-
 // DISCUSS: this might be retrieved from the block store - temporarily we will access it directly from the module
 //       following the pattern of the Consensus Module prior to pocket/issue-#315
 // TODO(#284): Remove blockProtoBytes from the interface

persistence/debug.go

@@ -41,8 +41,8 @@ func (m *persistenceModule) HandleDebugMessage(debugMessage *messaging.DebugMess
 	return nil
 }
 
-// IMPROVE: Add an iterator to the `kvstore` and use that instead
 func (m *persistenceModule) showLatestBlockInStore(_ *messaging.DebugMessage) {
+	// TODO: Add an iterator to the `kvstore` and use that instead
 	height := m.GetBus().GetConsensusModule().CurrentHeight() - 1
 	blockBytes, err := m.GetBlockStore().Get(heightToBytes(int64(height)))
 	if err != nil {

rpc/doc/CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.0.0.2] - 2022-12-06
+
+- Updated `PostV1ClientBroadcastTxSync` to broadcast the transaction it receives
+- Avoid creating an unnecessary utility context and use the utility module directly
+
 ## [0.0.0.1] - 2022-11-02
 
 ### Added

rpc/handlers.go

@@ -7,6 +7,8 @@ import (
 
 	"github.com/labstack/echo/v4"
 	"github.com/pokt-network/pocket/app"
+	"github.com/pokt-network/pocket/shared/codec"
+	typesUtil "github.com/pokt-network/pocket/utility/types"
 )
 
 func (s *rpcServer) GetV1Health(ctx echo.Context) error {
@@ -18,24 +20,24 @@ func (s *rpcServer) GetV1Version(ctx echo.Context) error {
 }
 
 func (s *rpcServer) PostV1ClientBroadcastTxSync(ctx echo.Context) error {
-	params := new(RawTXRequest)
-	if err := ctx.Bind(params); err != nil {
+	txParams := new(RawTXRequest)
+	if err := ctx.Bind(txParams); err != nil {
 		return ctx.String(http.StatusBadRequest, "bad request")
 	}
-	bz, err := hex.DecodeString(params.RawHexBytes)
+
+	txBz, err := hex.DecodeString(txParams.RawHexBytes)
 	if err != nil {
 		return ctx.String(http.StatusBadRequest, "cannot decode tx bytes")
 	}
-	height := s.GetBus().GetConsensusModule().CurrentHeight()
-	uCtx, err := s.GetBus().GetUtilityModule().NewContext(int64(height))
-	if err != nil {
-		defer func() { log.Fatalf("[ERROR] Failed to create UtilityContext: %v", err) }()
+
+	if err = s.GetBus().GetUtilityModule().CheckTransaction(txBz); err != nil {
 		return ctx.String(http.StatusInternalServerError, err.Error())
 	}
-	err = uCtx.CheckTransaction(bz)
-	if err != nil {
+
+	if err := s.broadcastMessage(txBz); err != nil {
 		return ctx.String(http.StatusInternalServerError, err.Error())
 	}
+
 	return nil
 }
 
@@ -47,3 +49,22 @@ func (s *rpcServer) GetV1ConsensusState(ctx echo.Context) error {
 		Step:   int64(consensus.CurrentStep()),
 	})
 }
+
+// Broadcast to the entire validator set
+func (s *rpcServer) broadcastMessage(msgBz []byte) error {
+	utilMsg := &typesUtil.TransactionGossipMessage{
+		Tx: msgBz,
+	}
+
+	anyUtilityMessage, err := codec.GetCodec().ToAny(utilMsg)
+	if err != nil {
+		log.Printf("[ERROR] Failed to create Any proto from transaction gossip: %v", err)
+		return err
+	}
+
+	if err := s.GetBus().GetP2PModule().Broadcast(anyUtilityMessage); err != nil {
+		log.Printf("[ERROR] Failed to broadcast utility message: %v", err)
+		return err
+	}
+	return nil
+}

shared/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.0.0.5] - 2022-12-06
+
+- Change the `bus` to be a pointer receiver rather than a value receiver in all the functions it implements
+
 ## [0.0.0.4] - 2022-11-30
 
 Debug:

shared/bus.go

@@ -128,44 +128,44 @@ func CreateBusWithOptionalModules(
 	return bus
 }
 
-func (m bus) PublishEventToBus(e *messaging.PocketEnvelope) {
+func (m *bus) PublishEventToBus(e *messaging.PocketEnvelope) {
 	m.channel <- *e
 }
 
-func (m bus) GetBusEvent() *messaging.PocketEnvelope {
+func (m *bus) GetBusEvent() *messaging.PocketEnvelope {
 	e := <-m.channel
 	return &e
 }
 
-func (m bus) GetEventBus() modules.EventsChannel {
+func (m *bus) GetEventBus() modules.EventsChannel {
 	return m.channel
 }
 
-func (m bus) GetPersistenceModule() modules.PersistenceModule {
+func (m *bus) GetPersistenceModule() modules.PersistenceModule {
 	return m.persistence
 }
 
-func (m bus) GetP2PModule() modules.P2PModule {
+func (m *bus) GetP2PModule() modules.P2PModule {
 	return m.p2p
 }
 
-func (m bus) GetUtilityModule() modules.UtilityModule {
+func (m *bus) GetUtilityModule() modules.UtilityModule {
 	return m.utility
 }
 
-func (m bus) GetConsensusModule() modules.ConsensusModule {
+func (m *bus) GetConsensusModule() modules.ConsensusModule {
 	return m.consensus
 }
 
-func (m bus) GetTelemetryModule() modules.TelemetryModule {
+func (m *bus) GetTelemetryModule() modules.TelemetryModule {
 	return m.telemetry
 }
 
-func (m bus) GetLoggerModule() modules.LoggerModule {
+func (m *bus) GetLoggerModule() modules.LoggerModule {
 	return m.logger
 }
 
-func (m bus) GetRPCModule() modules.RPCModule {
+func (m *bus) GetRPCModule() modules.RPCModule {
 	return m.rpc
 }