Introduce new flexible, resilient and modular architecture - reference list

[nazarhussain]

These are the main items to address in this phase:

• Have proper file structure in place
• The configuration aligned with module structure
• The code for modules to be decoupled (http-api)
• Easy prototyping any blockchain application

Continuation of this section will be followed by #3022.

Framework

Structure

• Restructure the file directories for components, modules and framework files Restructure the file directories for components, modules and framework files #2762
• Migrate Lisk Modular repository files to framework directory and create lisk-chain module Migrate Lisk Modular repository files to framework directory and create lisk-chain module #2763

UX

• Improve the UX/DX for creating a module for framework Improve the UX/DX for creating a module for framework #2863

Refactoring

• Refactor the event model and remove source from event Refactor the event model and remove source from event #2912
• Refactor the action layer for modules to load the actions directly not just names Refactor the action layer for modules to load the actions directly not just names #2913
• Refactor and verify the application cleanup logic for different cases Refactor and verify the application cleanup logic for different cases #2914
• Update the temp directory structure suitable for deployment Update the temp directory structure suitable for deployment and check the PID file before startup #2849

Validation

• Create controller/schemas/genesisBlock.js to validate genesis block Create controller/schemas/genesisBlock.js to validate genesis block #2884
• Create controller/schemas/constants.js to validate system-wide constants Create controller/schemas/constants.js to validate system wide constants #2889
• Update config/default/constants.js to only accept strings and integers instead of Date object Create controller/schemas/constants.js to validate system wide constants #2889

Multiprocess

• Update bus to support RPC connections and relevant channel should be introduced Update bus to support RPC connections and relevant channel should be introduced #3013
• Load http_api module as a child process Load http_api module as a child process #3059

Documentation

• Review and compile the JSDoc for framework Review Lisk Framework documentation #2845
• Review README and validate CLI options Update running application instructions in readme #2974 CLI option -c requires relative path #3115 Log file is missing and incorrect log level #3123
• Update README file to reflect the modular architecture changes Update README file to reflect the modular architecture changes #3075

Testing

• Move Mocha tests to a separate folder Move Mocha tests to a separate folder #2847
• Istanbul throws "Transformation error" exceptions Istanbul throws "Transformation error" exceptions #2858
• Import test suite structure from lisk-modular Import test suite structure from lisk-modular #2838
• Add unit tests for framework codebase Add unit tests for controller codebase  #2839
• Run mocha tests by npm scripts & Remove Gruntfile.js Run mocha tests by npm scripts & Remove Gruntfile.js #2935
• Add jest tests to CI pipeline Add jest tests to CI pipeline #2946
• Remove sequential tags from tests and Fix conflicting tests Remove sequential tags from tests and Fix conflicting tests #3089
• Add missing functional:put tests on Jenkins Add missing functional:put tests on Jenkins #3060
• Functional test code coverage is broken Functional test code coverage is broken #3100
• Review http_api module unit test coverage Implement pending unit tests for HTTP API module #2988

Dependencies

• Update docker configuration to match with current structure Update docker configuration to match with current structure #3039
• Update lisk scripts to work along new structure Update lisk scripts to work along new structure #3041

Chain Module

• Refactor the chain module initialization to simplify and maintainable Refactor the chain module initialization to simplify and maintainable  #2866
• Refactor the logic of all transaction files to have consistent dependencies Refactor the logic files of all transaction types to have consistent dependencies #2779

HTTP API module

• Resolve the conflicting responsibilities between api/controller and module of Delegates Resolve the conflicting responsibilities between api/controller and module of Delegates #2782
• Extract all API related codebase to a module named “http_api” Extract api codebase to http_api module #2770
• Initialize the storage, logger and cache components separately Initialize the storage, logger and cache components separately for http-api module #2771
• Load the “http_api” module through controller Load the “http_api” module through controller #2772
• Update the configuration files to group all configuration of HTTP API module "Cannot read property 'network' of undefined" #273
• Integrate “signatures” posting communication with chain module Integrate “signatures” posting communication with chain module #2774
• Integrate “transactions” posting communication with chain module Integrate “transactions” posting communication with chain module #2775
• Integrate “peers” fetching communication with chain module Integrate “peers” retrieval communication from chain module #2776
• Update fix all functional post tests for API Update all functional POST tests for API module #2777
• Update fix all functional get tests for API Update all functional GET tests for API module #2778
• Implement pending unit tests for HTTP API module Implement pending unit tests for HTTP API module #2988

Storage Component

• Update Account entity to have only getters and move other functions to chain specific implementation Update Account entity to have only getters and move other functions to chain specific implementation #2764
• Update Block entity to have only getters and move other functions to chain specific implementation Update Block entity to have only getters and move other functions to chain specific implementation #2765
• Update Transaction entity to have only getters and move other functions to chain specific implementation Update Transaction entity to have only getters and move other functions to chain specific implementation #2766
• Move Migration entity to chain module only Move Migration entity to chain module  #2767
• Move Round entity to chain module only Move Round entity to chain module  #2768
• Move Peer entity to chain module only Move Peer entity to chain module only #2769
• Storage component files should be exported via a predefined interface Storage component files exported via a predefined interface #2945