[Persistence][Utility] Separate all CreateAndApply functions into more functional components - Issue #508

consensus/doc/CHANGELOG.md

@@ -7,12 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.0.0.43] - 2023-04-04
+
+- Renamed `CreateAndApplyProposalBlock` to `CreateProposalBlock`
+
 ## [0.0.0.42] - 2023-04-03
 
 - Add `fsm_handler.go` to handle FSM transition events in consensus module
 - Update State Machine mock in `utils_test.go`
-- Update state_sync module with additional function definitions 
-  
+- Update state_sync module with additional function definitions
+
 ## [0.0.0.41] - 2023-03-30
 
 - Improve & simplify `utilityUnitOfWork` management

consensus/e2e_tests/utils_test.go

@@ -459,7 +459,7 @@ func baseLeaderUtilityUnitOfWorkMock(t *testing.T, genesisState *genesis.Genesis
 	rwContextMock.EXPECT().Release().AnyTimes()
 
 	utilityLeaderUnitOfWorkMock.EXPECT().
-		CreateAndApplyProposalBlock(gomock.Any(), maxTxBytes).
+		CreateProposalBlock(gomock.Any(), maxTxBytes).
 		Return(stateHash, make([][]byte, 0), nil).
 		AnyTimes()
 	utilityLeaderUnitOfWorkMock.EXPECT().

consensus/hotstuff_leader.go

@@ -399,7 +399,7 @@ func (m *consensusModule) prepareBlock(qc *typesCons.QuorumCertificate) (*coreTy
 	}
 
 	// Reap the mempool for transactions to be applied in this block
-	stateHash, txs, err := leaderUOW.CreateAndApplyProposalBlock(m.privateKey.Address(), maxTxBytes)
+	stateHash, txs, err := leaderUOW.CreateProposalBlock(m.privateKey.Address(), maxTxBytes)
 
 	if err != nil {
 		return nil, err

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.48] - 2023-04-06
+
+- Renamed `CreateAndApplyProposalBlock` to `CreateProposalBlock`
+
 ## [0.0.0.47] - 2023-04-06
 
 - Updated to reflect pools address changes

shared/docs/PROTOCOL_STATE_HASH.md

@@ -94,7 +94,7 @@ sequenceDiagram
 When applying the block during the `NEWROUND` message shown above, the majority of the flow is similar between the _leader_ and the _replica_ with one of the major differences being a call to the `Utility` module as seen below.
 
 - `ApplyBlock` - Uses the existing set of transactions to validate & propose
-- `CreateAndApplyProposalBlock` - Reaps the mempool for a new set of transaction to validate and propose
+- `CreateProposalBlock` - Reaps the mempool for a new set of transaction to validate and propose
 
 ```mermaid
 graph TD
@@ -115,14 +115,14 @@ graph TD
     I[Is prepareQC.view > lockedQC.view] --> |"No<br>(lockedQC.block)"| Z
     I[Is prepareQC.view > lockedQC.view] --> |"Yes<br>(prepareQC.block)"| Z
 
-    H[CreateAndApplyProposalBlock]
+    H[CreateProposalBlock]
     Z[ApplyBlock]
 ```
 
 As either the _leader_ or _replica_, the following steps are followed to apply the proposal transactions in the block.
 
 1. Update the `UtilityUnitOfWork` with the proposed block
-2. Call either `ApplyBlock` or `CreateAndApplyProposalBlock` based on the flow above
+2. Call either `ApplyBlock` or `CreateProposalBlock` based on the flow above
 
 ```mermaid
 sequenceDiagram
@@ -135,7 +135,7 @@ sequenceDiagram
         U->>-C: err_code
 
         %% Apply the block to the local proposal state
-        C->>+U: ApplyBlock / CreateAndApplyProposalBlock
+        C->>+U: ApplyBlock / CreateProposalBlock
         U->>-C: err_code
 ```
 

shared/modules/utility_module.go

@@ -42,9 +42,6 @@ type UnstakingActor interface {
 
 // CONSIDERATION: Consider removing `Utility` from `UtilityUnitOfWork` altogether
 
-// TECHDEBT(@deblasis): `CreateAndApplyProposalBlock` and `ApplyBlock` should be be refactored into a
-// `GetProposalBlock` and `ApplyProposalBlock` functions
-
 // UtilityUnitOfWork is a unit of work (https://martinfowler.com/eaaCatalog/unitOfWork.html) that allows for atomicity and commit/rollback functionality
 type UtilityUnitOfWork interface {
 	IntegratableModule
@@ -53,7 +50,6 @@ type UtilityUnitOfWork interface {
 	// It does not apply, validate or commit the changes.
 	// For example, it can be use during state sync to set a proposed state transition before validation.
 	// TODO: Investigate a way to potentially simplify the interface by removing this function.
-	// TODO: @deblasis: there's still some mix and match between blockHash and stateHash
 	SetProposalBlock(blockHash string, proposerAddr []byte, txs [][]byte) error
 
 	// ApplyBlock applies the context's in-memory proposed state (i.e. the txs in this context).
@@ -71,10 +67,8 @@ type UtilityUnitOfWork interface {
 type LeaderUtilityUnitOfWork interface {
 	UtilityUnitOfWork
 
-	// CreateAndApplyProposalBlock reaps the mempool for txs to be proposed in a new block, and
-	// applies them to this context after validation.
-	// TODO: #508 new signature
-	CreateAndApplyProposalBlock(proposer []byte, maxTxBytes uint64) (stateHash string, txs [][]byte, err error)
+	// CreateProposalBlock reaps the mempool for txs to be proposed in a new block.
+	CreateProposalBlock(proposer []byte, maxTxBytes uint64) (stateHash string, txs [][]byte, err error)
 }
 
 type ReplicaUtilityUnitOfWork interface {

utility/doc/CHANGELOG.md

@@ -9,6 +9,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [0.0.0.34] - 2023-04-06
 
+- Renamed `CreateAndApplyProposalBlock` to `CreateProposalBlock`
+- Added `GetPrevBlockByzantineValidators` and `ProposalBlockNotSet` errors
+- Instrumented `CreateProposalBlock` and `ApplyBlock` with log statements
+- Refactored functions for block creation and application to be more readable/modular
+- Added TODOs for future refactoring
+- Renamed `u` to `uow` for consistency
+
+## [0.0.0.34] - 2023-04-06
+
 - Updated to reflect pools address changes
 
 ## [0.0.0.33] - 2023-03-30

utility/types/error.go

@@ -40,7 +40,7 @@ func NewError(code Code, msg string) Error {
 	}
 }
 
-// NextCode: 133
+// NextCode: 135
 type Code float64 // CONSIDERATION: Should these be a proto enum or a golang iota?
 
 //nolint:gosec // G101 - Not hard-coded credentials
@@ -115,6 +115,7 @@ const (
 	CodeInvalidServiceURLError            Code = 70
 	CodeNotExistsError                    Code = 71
 	CodeGetMissedBlocksError              Code = 72
+	CodeGetPrevBlockByzantineValidators   Code = 134
 	CodeEmptyHashError                    Code = 73
 	CodeInvalidBlockHeightError           Code = 74
 	CodeUnequalPublicKeysError            Code = 75
@@ -174,6 +175,7 @@ const (
 	CodeGetHeightError                    Code = 129
 	CodeUnknownActorType                  Code = 130
 	CodeUnknownMessageType                Code = 131
+	CodeProposalBlockNotSet               Code = 133
 )
 
 const (
@@ -184,6 +186,7 @@ const (
 	UnequalVoteTypesError             = "the vote types are not equal"
 	UnequalPublicKeysError            = "the two public keys are not equal"
 	GetMissedBlocksError              = "an error occurred getting the missed blocks field"
+	GetPrevBlockByzantineValidators   = "an error occurred getting the previous block's byzantine validators"
 	DecodeMessageError                = "unable to decode the message"
 	NotExistsError                    = "the actor does not exist in the state"
 	InvalidServiceURLError            = "the service url is not valid"
@@ -284,6 +287,7 @@ const (
 	InvalidTransactionCountError      = "the total transactions are less than the block transactions"
 	EmptyTimestampError               = "the timestamp field is empty"
 	EmptyProposerError                = "the proposer field is empty"
+	ProposalBlockNotSet               = "the proposal block is not set"
 	EmptyNetworkIDError               = "the network id field is empty"
 	InvalidHashLengthError            = "the length of the hash is not the correct size"
 	NilQuorumCertificateError         = "the quorum certificate is nil"
@@ -366,6 +370,10 @@ func ErrGetMissedBlocks(err error) Error {
 	return NewError(CodeGetMissedBlocksError, fmt.Sprintf("%s: %s", GetMissedBlocksError, err.Error()))
 }
 
+func ErrGetPrevBlockByzantineValidators(err error) Error {
+	return NewError(CodeGetPrevBlockByzantineValidators, fmt.Sprintf("%s: %s", GetPrevBlockByzantineValidators, err.Error()))
+}
+
 func ErrGetStakedTokens(err error) Error {
 	return NewError(CodeGetStakedAmountError, GetStakedAmountsError)
 }
@@ -767,6 +775,10 @@ func ErrEmptyProposer() Error {
 	return NewError(CodeEmptyProposerError, EmptyProposerError)
 }
 
+func ErrProposalBlockNotSet() Error {
+	return NewError(CodeProposalBlockNotSet, ProposalBlockNotSet)
+}
+
 func ErrEmptyTimestamp() Error {
 	return NewError(CodeEmptyTimestampError, EmptyTimestampError)
 }