Changelog Utility

Changelog

All notable changes to this module will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

[0.0.0.45] - 2023-06-06

• Adds servicer, fisherman, and validator utility modules

[0.0.0.44] - 2023-06-02

• Implemented GetIndexedTransaction
• Add some comments and rename a few functions throughout to have things be more self-explanatory
• Moved over all the business logic related to getting "signer candidates" into its own file for readability purposes

[0.0.0.43] - 2023-06-01

• Add a place-holder Servicer implementation
• Use mockgen and Bus for DI
• Cross-check the chains handled by a servicer using the Persistence module

[0.0.0.42] - 2023-06-01

• Added a utility feature list with must-have and nice-to-haves for MainNet and TestNet

[0.0.0.41] - 2023-05-30

• Added the E2E Feature Path Template to document, present and explain how to go about defining and scoping utility level features

[0.0.0.40] - 2023-05-04

• Expose HandleTransaction for use outside of utility
• Add placeholder functions HandleRelay() and HandleChallenge()
• Moved utility/types/errors.go into shared/core/types and updated their usage accordingly

[0.0.0.39] - 2023-05-03

• Rename TxResult to IndexedTransaction

[0.0.0.38] - 2023-04-28

• Introduced testing helper to test the UtilityModule interface implementation
• Implemented the GetSession function from the Utility module interface
• Added a sessionHydrator structure used to populate a new session

[0.0.0.37] - 2023-04-13

• Remove utility specific TxResult protobuf and interface
• Utilize the TxResult protobuf in shared/core/types

[0.0.0.36] - 2023-04-07

• Add wrapper functions for GetParameter()
• Add generic governance parameter accessor functions getParamOwner() and getGovParam()
• Refactor governance parameter accessor functions to use general wrapper functions
• Clean up tests

[0.0.0.35] - 2023-04-07

• 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
• Added stateHash validation against proposalBlock
• Added feature flag for stateHash validation (for testing purposes)
• Updated tests accordingly

[0.0.0.34] - 2023-04-06

• Updated to reflect pools address changes

[0.0.0.33] - 2023-03-30

• Improved logging throughout the module

[0.0.0.32] - 2023-03-26

• Refactored utilityContext into utilityUnitOfWork
• Added utilityUnitOfWorkFactory to create utilityUnitOfWork instances depending on the fact that the current node is Leader or Replica
• Updated tests

[0.0.0.31] - 2023-02-28

• Fixed bug where we were not removing txs from the mempool of replicas
• Added thorough documentation in different parts of the codebase
• Replace the Store() function with a .store accessor
• Removed the unnecessary getStoreAndHeight() function
• Simplified calculateMaxAppRelays to a temporary calculateAppSessionTokens implementation
• Improved the readability of the Block lifecycle and Message validation
• Simplified the testing utilities used
• Updated the session interface
• Renamed applyTx to hydrateTx and added documentation on its functionality
• Removed DefaultTxResult and added documentation to TxResult result

[0.0.0.30] - 2023-02-24

• Update logger value references with pointers
• Fix module test after logger refactor

[0.0.0.29] - 2023-02-21

• Rename ServiceNode Actor Type Name to Servicer

[0.0.0.28] - 2023-02-17

• Module embeds base_modules.IntegratableModule and base_modules.InterruptableModule for DRYness
• Logging error if ApplyTransaction fails (it was completely ignored before and it was really hard to understand what was going on)

[0.0.0.27] - 2023-02-14

• Added a Validatable type for basic validation
• Split business logic specific to certain actors (e.g. validator reward, app relays, message handling) into separate files
• Reduced the scope of functions and types that shouldn’t be exposed
• Upgraded the actors tests - a lot went here to help with understanding what’s going on but it’s still just a start
• Remove the Context struct; unnecessary abstraction
• Added comments and guidance on message, transaction and signature validation
• Added ITransaction, an interface for the Transaction protocol to help capture the functionality it adds to the core type
• DOC: Delineate between unstaking & unbonding in a few places throughout the codebase
• BUG: tx.Equals was comparing the same transaction against itself (major bug)
• BUG: StakingStatus enums in utility did not reflect the same protocol as in persistence (needs to be consolidated)

[0.0.0.26] - 2023-02-07

• Documentation update

[0.0.0.25] - 2023-02-06

• Address legacy linter errors from golangci-lint

[0.0.0.24] - 2023-02-06

• Changed readme to remove $ sign from code blocks

[0.0.0.23] - 2023-02-04

• Changed log lines to utilize new logger module.

[0.0.0.22] - 2023-02-03

• Introduced txFIFOMempool which extends the new GenericFIFOSet in order to replace the legacy logic
• Added tests for txFIFOMempool
• Accessing TxMempool via the bus in utilityContext

[0.0.0.21] - 2023-01-30

• Updated TestUtilityContext_SetPoolAmount, TestUtilityContext_GetMessageEditStakeSignerCandidates, TestUtilityContext_GetMessageUnpauseSignerCandidates, TestUtilityContext_GetMessageUnstakeSignerCandidates, and TestUtilityContext_UnstakePausedBefore to correct misplaced expected and actual values in require.Equal.

[0.0.0.20] - 2023-01-20

• Remove address []byte argument from InsertPool function

[0.0.0.19] - 2023-01-19

• Rewrite interface{} to any

[0.0.0.18] - 2023-01-14

• Updated "test/module_test.go" to encorporate MaxConnsCount, MinConnsCount, MaxConnLifetime, MaxConnIdleTime, and HealthCheckPeriod in persistence config.

[0.0.0.17] - 2023-01-11

• Deprecated GetBlocksPerSession() in favour of the more general parameter getter function GetParameter()
• Update unit test for GetBlocksPerSession() to use the GetParameter() function

[0.0.0.16] - 2023-01-10

• Updated module constructor to accept a bus and not a runtimeMgr anymore
• Registering module with the bus via RegisterModule method

[0.0.0.15] - 2023-01-03

• Renamed enum names as per code-review
• Using defaults from test_artifacts for tests
• Updated tests to reflect the above changes

[0.0.0.14] - 2022-12-21

• Updated to use the new centralized config and genesis handling
• Updated to use the new Actor struct under coreTypes
• Updated tests and mocks

[0.0.0.13] - 2022-12-10

• Introduce SetProposalBlock and local vars to keep proposal state
• Maintaining proposal block state (proposer, hash, transactions) in local context

[0.0.0.12] - 2022-12-06

• Introduce a general purpose HandleMessage method at the utility level
• Move the scope of CheckTransaction from the context to the module level
• Add an IsEmpty function to the Mempool
• Rename DeleteTransaction to RemoveTransaction in the mempool
• Rename LatestHeight to Height in the utilityContext
• Add comments inside CheckTransaction so its functionality is clearer
• Add comments and cleanup the code in mempool.go

[0.0.0.11] - 2022-11-30

• Minor lifecycle changes needed to supported the implementation of ComputeAppHash as a replacement for GetAppHash in #285

[0.0.0.10] - 2022-11-15

• Propagating the quorumCertificate appropriately on block commit
• Removed Latest from getters related to retrieving the context of the proposed block

[0.0.0.9] - 2022-11-01

• Remove TxResult from the utility module interface (added in TxIndexer integration of transaction indexer (issue-#168) #302)
• Combined creation and application of block in proposer lifecycle

[0.0.0.8] - 2022-10-17

• Added Relay Protocol interfaces and diagrams

[0.0.0.7] - 2022-10-14

• Added session interfaces and diagrams
• Moved TxIndexer package to persistence module
• Added new proto structure DefaultTxResult
• Integrated the TxIndexer into the lifecycle
  • Captured TxResult from each played transaction
  • Moved the storage of transactions to the Consensus Module
  • Returned the TxResults in the ApplyBlock() and GetProposalTransactions()
  • AnteHandleMessage() now returns signer
  • ApplyTransaction() returns TxResult

#235 Config and genesis handling

• Updated to use RuntimeMgr
• Made UtilityModule struct unexported
• Updated tests and mocks
• Removed some cross-module dependencies

[0.0.0.6] - 2022-10-06

• Don't ignore the exit code of m.Run() in the unit tests
• Fixed several broken unit tests related to type casting
• Removed some unit tests (e.g. TestUtilityContext_UnstakesPausedBefore) that were legacy and replaced by more general ones (e.g. TestUtilityContext_UnstakePausedBefore)
• Avoid exporting unnecessary test helpers

[0.0.0.5] - 2022-09-29

• Remove unused StoreBlock function from the utility module interface

[0.0.0.4] - 2022-09-23

• Created UtilityConfig
• Added max_mempool_transaction_bytes and max_mempool_transactions to the utility config to allow dynamic configuration of the mempool
• Matched configuration unmarshalling pattern of other modules
• Added V0 mempool default configurations
• Regenerated build files with new mempool config
• Consolidated UtilActorType in utility and utility/types to typesUtil.ActorType
• Deprecated all code in actor.go and replaced with test helpers
• Converted stake status to proto.enum (int32)
• Added DISCUSS items around shared code and StakeStatus
• Removed no-op DeleteActor code
• Improved unit test for UnstakeActorsThatAreReady()
• Removed all usages of fmt.Sprintf() from the testing package
• Replaced all usages of requre.True/require.False with require.Equal unless checking a boolean
• Added helper function for getting height and store for a readable and consistent typesUtil.Error value
• Added testing.M argument to newTestingPersistenceModule
• Moved in-function literal arguments for newTestingPersistenceModule to private constants
• Added the address parameter to ErrInsufficientFunds function for easier debugging
• Added unit test for LegacyVote.ValidateBasic()
• Added ErrUnknownActorType to all switch statements on actorType
• Removed import of consTypes (consensus module)

[0.0.0.3] - 2022-09-15

• Consolidated TransactionHash to call a single implementation in shared/crypto/sha3
• Extracted function calls from places where we were using the same logic

[0.0.0.2] - 2022-08-25

Encapsulate structures previously in shared #163

• Ensured proto structures implement shared interfaces
• UtilityConfig uses shared interfaces in order to accept MockUtilityConfig in test_artifacts
• Moved all utilty tests from shared to tests package
• Left TODO for tests package still importing persistence for NewTestPersistenceModule
  • This is one of the last places where cross-module importing exists

[0.0.1] - 2022-07-20

• Removed transaction fees from the transaction structure as fees will be enforced at the state level
• Removed actor specific messages (besides DoubleSign) and added actorType field to the struct
• Removed pause messages and functionality as it is out of scope for the current POS iteration
• Removed session and test-scoring as it's out of scope for the current POS iteration
• Consolidated unit test functionality for actors
• Modified pre-persistence to match persistence for Update(actor), 'amountToAdd' is now just 'amount'

[0.0.0] - 2022-03-15

• Added minimal 'proof of stake' implementation with few Pocket Specific terminologies and actors
  • Structures
    • Accounts
    • Validators
    • Fishermen
    • Applications
    • Servicers
    • Pools
  • Messages
    • Stake
    • Unstake
    • EditStake
    • Pause
    • Unpause
    • Send
• Added initial governance params