Introduce on-chain architecture

[shuse2]

Description

Defining and applying the module system for the on-chain block processing. It combines current block processing, transaction processing and schema definition and split them into 4 modules, token, sequence, DPoS and keys.

• Token module is responsible for managing the balance including the transfer asset.
• Sequence module is responsible for managing the nonce.
• DPoS module is responsible for managing the DPoS properties and selection of the validators including register, vote, unlock and punishment assets.
• Key module is responsible for multi-signature and signature validation including the register asset.

Each module will have possibility to add hooks as below:

// BaseModule to be extended per module
class BaseModule {
  public name: string;
  public type: number;
  // List of transaction assets for this module
  public assets: BaseAsset[];
  // Schema of account asset to be used in this module
  public accountSchema?: Schema;
  // Set of actions which can be called from framework
  public actions?: Map<string, ActionHandler>;
  // Set of events name that will be emitted from this module
  public events?: string[];
  // Set of actions which can be called from other modules during the block processing
  public reducers?: Map<string, ReduceHandler>;
  // A function which will be called for all transactions regardless of modules.
  public beforeTransactionApply?: ({tx: Transaction, stateStore: StateStore, moduleAccess}) => void;
  // A function which will be called for all transactions regardless of modules.
  public afterTransactionApply?: ({tx: Transaction, stateStore: StateStore, moduleAccess}) => void;
  // A function which will be called while applying genesis block
  public afterGenesisBlockApply?: ({block: GenesisBlock, stateStore: StateStore, consensus: Consensus, moduleAccess}) => void;
  // A function which will be called in sequence at beforeBlockApply step
  public beforeBlockApply?: ({block: Block, stateStore: StateStore, moduleAccess}) => void;
  // A function which will be called in sequence at afterBlockApply step
  public afterBlockApply?: ({block: Block, stateStore: StateStore, consensus: Consensus, moduleAccess}) => void;
}

Also asset will have the hooks as below, which will be exactly the same as current custom transaction hooks.

class BaseAsset<K> {
  // Name of the module which will be used in the path resolution
  public name: string;
  public type: number;
  // Base fee to be included in the minFee
  public baseFee?: bigint;
  // Schema of the content of this asset
  public assetSchema: Schema;
  // Validation function that can be implemented if additional 
  public applyAsset: ({senderID:Buffer, asset: K, stateStore: StateStore, moduleAccess }) => void;
  // Validation function that can be implemented if additional 
  public validateAsset?: (asset: K) => void;
}

Motivation

The main motivations for introducing an on-chain architecture to the Lisk SDK are as follows:

• Enable developers to make block level state changes
• Enable developers to define per module account schemas
• Encapsulate the application domain properly

Tasks

Sprint 25

• Create BaseModule and BaseAsset with module skeletons Create BaseModule and BaseAsset with module skeletons #5604
• Create Sequence module Create Sequence module #5606
• Create Keys module Create Keys module #5607
• Create DPoS module Create DPoS module #5608
• Update lisk-chain to support the on-chain architecture Update lisk-chain to support the on-chain architecture #5609
• Update processor to handle on-chain architecture hooks Update processor to handle on-chain architecture hooks #5610
• Update application to support on-chain architecture Update application to support on-chain architecture #5611
• Update framework/node to support on-chain architecture Update framework/node to support on-chain architecture #5612
• Update lisk-bft to support on-chain architecture Update lisk-bft to support on-chain architecture #5613
• Update protocol spec to support on-chain architecture Update protocol spec to support on-chain architecture #5615
• Update transaction-pool to support on-chain architecture Update transaction-pool to support on-chain architecture #5619
• Expose required interface for module development Expose required interface for module development #5623
• Update lisk-genesis to support on-chain architecture Update lisk-genesis to support on-chain architecture #5640
• Fix outdated lisk-coded protocol spec Fix outdated lisk-coded protocol spec #5647
• Type of genesis block is not consistent Type of genesis block is not consistent #5649
• Improve coverage and tests in general for keys module Improve coverage and tests in general for keys module #5653

Sprint 26

• Update variable names of module interface Update variable names of module interface #5639
• Cleanup unused code and integration tests Cleanup unused code and integration tests #5614
• Create Token module Create Token module #5605
• Add del on state store account Add del on state store account #5631
• Add support for module action and events Add support for module action and events #5645
• Create a new event VALIDATOR_CHANGED in lisk-chain Create a new event VALIDATOR_CHANGED in lisk-chain #5656
• Improve coverage and tests in general for token module Improve coverage and tests in general for token module #5663