Update block schema to include transactionRoot - Closes #5210

commander/src/commands/network-identifier.ts

@@ -21,7 +21,7 @@ import { flags as commonFlags } from '../utils/flags';
 
 export default class NetworkIdentifierCommand extends BaseCommand {
 	static description = `
-  Creates Network identifier for the given genesis payload hash and community identifier.
+  Creates Network identifier for the given genesis block transaction root and community identifier.
 	`;
 
 	static examples = [
@@ -30,8 +30,8 @@ export default class NetworkIdentifierCommand extends BaseCommand {
 
 	static args = [
 		{
-			name: 'genesisPayloadHash',
-			description: 'Payload hash of genesis block from the network.',
+			name: 'genesisBlockTransactionRoot',
+			description: 'Transaction root of genesis block from the network.',
 			required: true,
 		},
 	];
@@ -49,10 +49,10 @@ export default class NetworkIdentifierCommand extends BaseCommand {
 		const {
 			flags: { 'community-identifier': communityIdentifier },
 			// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-			args: { genesisPayloadHash },
+			args: { genesisBlockTransactionRoot },
 		} = this.parse(NetworkIdentifierCommand);
 		const networkIdentifier = getNetworkIdentifier(
-			genesisPayloadHash as string,
+			genesisBlockTransactionRoot as string,
 			communityIdentifier,
 		);
 		this.print({ networkIdentifier });

commander/src/commands/transaction/create/pom.ts

@@ -36,7 +36,7 @@ interface RawHeader {
 	readonly generatorPublicKey: string;
 	readonly numberOfTransactions: number;
 	readonly payloadLength: number;
-	readonly payloadHash: string;
+	readonly transactionRoot: string;
 	readonly totalAmount: string;
 	readonly totalFee: string;
 	readonly reward: string;

commander/src/utils/api.ts

@@ -31,9 +31,9 @@ export const getAPIClient = ({
 	nodes,
 	network,
 }: APIClientOptions): APIClient => {
-	const genesisBlockPayloadHash = NETHASHES[network] || network;
+	const genesisBlockTransactionRoot = NETHASHES[network] || network;
 	// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
 	const clientNodes = nodes && nodes.length > 0 ? nodes : seedNodes[network];
 
-	return new APIClient(clientNodes, { genesisBlockPayloadHash });
+	return new APIClient(clientNodes, { genesisBlockTransactionRoot });
 };

commander/test/commands/config/set.test.ts

@@ -197,7 +197,7 @@ describe('config:set', () => {
 				.stdout()
 				.command(['config:set', 'api.network', validNethash])
 				.it(
-					'should set api.network to the custom genesisBlockPayloadHash',
+					'should set api.network to the custom genesisBlockTransactionRoot',
 					() => {
 						const newConfig = {
 							...defaultConfig,

commander/test/commands/transaction/create/pom.test.ts

@@ -34,7 +34,7 @@ describe('transaction:create:pom', () => {
 		totalFee: '10000000000',
 		reward: '10000000000',
 		payloadLength: 0,
-		payloadHash:
+		transactionRoot:
 			'e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855',
 		generatorPublicKey:
 			'addb0e15a44b0fdc6ff291be28d8c98f5551d0cd9218d749e30ddb87c6e31ca9',
@@ -54,7 +54,7 @@ describe('transaction:create:pom', () => {
 		totalFee: '10000000000',
 		reward: '10000000000',
 		payloadLength: 0,
-		payloadHash:
+		transactionRoot:
 			'e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855',
 		generatorPublicKey:
 			'addb0e15a44b0fdc6ff291be28d8c98f5551d0cd9218d749e30ddb87c6e31ca9',

elements/lisk-api-client/src/api_client.ts

@@ -99,14 +99,14 @@ export class APIClient {
 
 	public static createMainnetAPIClient(options?: InitOptions): APIClient {
 		return new APIClient(constants.MAINNET_NODES, {
-			genesisBlockPayloadHash: constants.MAINNET_NETHASH,
+			genesisBlockTransactionRoot: constants.MAINNET_NETHASH,
 			...options,
 		});
 	}
 
 	public static createTestnetAPIClient(options?: InitOptions): APIClient {
 		return new APIClient(constants.TESTNET_NODES, {
-			genesisBlockPayloadHash: constants.TESTNET_NETHASH,
+			genesisBlockTransactionRoot: constants.TESTNET_NETHASH,
 			...options,
 		});
 	}
@@ -170,8 +170,8 @@ export class APIClient {
 
 		this.headers = {
 			...commonHeaders,
-			...(options.genesisBlockPayloadHash
-				? { nethash: options.genesisBlockPayloadHash }
+			...(options.genesisBlockTransactionRoot
+				? { nethash: options.genesisBlockTransactionRoot }
 				: {}),
 			...(options.client ? getClientHeaders(options.client) : {}),
 		};

elements/lisk-api-client/src/api_types.ts

@@ -43,7 +43,7 @@ export interface HashMap {
 export interface InitOptions {
 	readonly bannedNodes?: ReadonlyArray<string>;
 	readonly client?: object;
-	readonly genesisBlockPayloadHash?: string;
+	readonly genesisBlockTransactionRoot?: string;
 	readonly node?: string;
 	readonly randomizeNodes?: boolean;
 }

elements/lisk-api-client/test/api_client.spec.ts

@@ -90,7 +90,7 @@ describe('APIClient module', () => {
 
 		it('should call initialize with the nodes and provided options', () => {
 			const providedOptions = {
-				genesisBlockPayloadHash:
+				genesisBlockTransactionRoot:
 					'0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef',
 			};
 			apiClient = new APIClient(defaultNodes, providedOptions);
@@ -185,7 +185,7 @@ describe('APIClient module', () => {
 
 			it('should set custom headers with supplied options', () => {
 				apiClient = new APIClient(defaultNodes, {
-					genesisBlockPayloadHash: testnetHash,
+					genesisBlockTransactionRoot: testnetHash,
 					client: {
 						name: 'LiskHub',
 						version: '5.0',
@@ -197,7 +197,7 @@ describe('APIClient module', () => {
 
 			it('should not set User-Agent header when client options were not given', () => {
 				apiClient = new APIClient(defaultNodes, {
-					genesisBlockPayloadHash: testnetHash,
+					genesisBlockTransactionRoot: testnetHash,
 				});
 				return expect(apiClient.headers).not.toHaveProperty('User-Agent');
 			});

elements/lisk-bft/test/fixtures/blocks.ts

@@ -23,7 +23,7 @@ export const BlockHeader = stampit.compose({
 			'56d63b563e00332ec31451376f5f2665fcf7e118d45e68f8db0b00db5963b56bc6776a42d520978c1522c39545c9aff62a7d5bdcf851bf65904b2c2158870f00',
 		generatorPublicKey: '',
 		numberOfTransactions: 2,
-		payloadHash:
+		transactionRoot:
 			'be0df321b1653c203226add63ac0d13b3411c2f4caf0a213566cbd39edb7ce3b',
 		payloadLength: 494,
 		height: 489,

elements/lisk-chain/package.json

@@ -37,6 +37,7 @@
 		"@liskhq/lisk-cryptography": "2.5.0-alpha.0",
 		"@liskhq/lisk-db": "0.1.0",
 		"@liskhq/lisk-transactions": "4.0.0-alpha.0",
+		"@liskhq/lisk-tree": "0.1.0",
 		"@types/node": "12.12.11",
 		"debug": "4.1.1",
 		"lodash.clonedeep": "4.5.0",

elements/lisk-chain/src/chain.ts

@@ -63,7 +63,7 @@ import {
 import * as blocksUtils from './utils';
 import {
 	validateBlockSlot,
-	validatePayload,
+	validateTransactionRoot,
 	validatePreviousBlockProperty,
 	validateReward,
 	validateSignature,
@@ -347,7 +347,7 @@ export class Chain {
 			throw invalidTransactionResponse.errors;
 		}
 
-		validatePayload(block, this.constants.maxPayloadLength);
+		validateTransactionRoot(block, this.constants.maxPayloadLength);
 
 		// Update id
 		// eslint-disable-next-line no-param-reassign

elements/lisk-chain/src/schema.ts

@@ -35,7 +35,7 @@ export const baseBlockSchema = {
 		numberOfTransactions: {
 			type: 'integer',
 		},
-		payloadHash: {
+		transactionRoot: {
 			type: 'string',
 			format: 'hex',
 		},
@@ -76,7 +76,7 @@ export const baseBlockSchema = {
 		'blockSignature',
 		'generatorPublicKey',
 		'numberOfTransactions',
-		'payloadHash',
+		'transactionRoot',
 		'payloadLength',
 		'timestamp',
 		'totalAmount',

elements/lisk-chain/src/types.ts

@@ -75,7 +75,7 @@ export interface BlockHeaderJSON {
 	generatorPublicKey: string;
 	numberOfTransactions: number;
 	payloadLength: number;
-	payloadHash: string;
+	transactionRoot: string;
 	totalAmount: string;
 	totalFee: string;
 	reward: string;

elements/lisk-chain/src/validate.ts

@@ -12,8 +12,13 @@
  * Removal or modification of this copyright notice is prohibited.
  */
 
-import { hash, verifyData } from '@liskhq/lisk-cryptography';
+import {
+	verifyData,
+	stringToBuffer,
+	bufferToHex,
+} from '@liskhq/lisk-cryptography';
 import { BaseTransaction } from '@liskhq/lisk-transactions';
+import { MerkleTree } from '@liskhq/lisk-tree';
 
 import { Slots } from './slots';
 import { BlockInstance, GenesisBlock } from './types';
@@ -74,7 +79,14 @@ export const validateReward = (
 	}
 };
 
-export const validatePayload = (
+export const getTransactionRoot = (ids: ReadonlyArray<string>): string => {
+	const idsAsBuffers = ids.map(id => stringToBuffer(id));
+	const tree = new MerkleTree(idsAsBuffers);
+
+	return bufferToHex(tree.root);
+};
+
+export const validateTransactionRoot = (
 	block: BlockInstance,
 	maxPayloadLength: number,
 ): void => {
@@ -84,32 +96,26 @@ export const validatePayload = (
 
 	let totalAmount = BigInt(0);
 	let totalFee = BigInt(0);
-	const transactionsBytesArray: Buffer[] = [];
+	const transactionIds: string[] = [];
 	const appliedTransactions: { [id: string]: BaseTransaction } = {};
 
 	block.transactions.forEach(transaction => {
-		const transactionBytes = transaction.getBytes();
-
 		// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
 		if (appliedTransactions[transaction.id]) {
 			throw new Error(`Encountered duplicate transaction: ${transaction.id}`);
 		}
 
+		transactionIds.push(transaction.id);
 		appliedTransactions[transaction.id] = transaction;
-		// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-		if (transactionBytes) {
-			transactionsBytesArray.push(transactionBytes);
-		}
 		// eslint-disable-next-line
 		totalAmount += BigInt((transaction.asset as any).amount || 0);
 		totalFee += BigInt(transaction.fee);
 	});
 
-	const transactionsBuffer = Buffer.concat(transactionsBytesArray);
-	const payloadHash = hash(transactionsBuffer).toString('hex');
+	const transactionRoot = getTransactionRoot(transactionIds);
 
-	if (payloadHash !== block.payloadHash) {
-		throw new Error('Invalid payload hash');
+	if (transactionRoot !== block.transactionRoot) {
+		throw new Error('Invalid transaction root');
 	}
 
 	if (totalAmount !== BigInt(block.totalAmount)) {

elements/lisk-chain/src/verify.ts

@@ -119,7 +119,7 @@ export class BlocksVerify {
 	public matchGenesisBlock(block: BlockHeader): boolean {
 		return (
 			block.id === this.genesisBlock.id &&
-			block.payloadHash === this.genesisBlock.payloadHash &&
+			block.transactionRoot === this.genesisBlock.transactionRoot &&
 			block.blockSignature === this.genesisBlock.blockSignature
 		);
 	}

elements/lisk-chain/test/fixtures/block.ts

@@ -23,7 +23,7 @@ export const Block = stampit.compose({
 			'56d63b563e00332ec31451376f5f2665fcf7e118d45e68f8db0b00db5963b56bc6776a42d520978c1522c39545c9aff62a7d5bdcf851bf65904b2c2158870f00',
 		generatorPublicKey: '',
 		numberOfTransactions: 2,
-		payloadHash:
+		transactionRoot:
 			'be0df321b1653c203226add63ac0d13b3411c2f4caf0a213566cbd39edb7ce3b',
 		payloadLength: 494,
 		height: 489,

elements/lisk-chain/test/fixtures/genesis_block.json

@@ -10,7 +10,7 @@
 	"totalFee": "0",
 	"communityIdentifier": "Lisk",
 	"generatorPublicKey": "e925106c5b0f276dfb0a3d60c4ed6068ec0181a70dab680199d65369fb69b9f8",
-	"payloadHash": "19074b69c97e6f6b86969bb62d4f15b888898b499777bda56a3a2ee642a7f20a",
+	"transactionRoot": "19074b69c97e6f6b86969bb62d4f15b888898b499777bda56a3a2ee642a7f20a",
 	"payloadLength": 39677,
 	"totalAmount": "10000000000000000",
 	"transactions": [

elements/lisk-chain/test/unit/chain.spec.ts

@@ -30,7 +30,7 @@ jest.mock('events');
 jest.mock('@liskhq/lisk-db');
 
 const networkIdentifier = getNetworkIdentifier(
-	genesisBlock.payloadHash,
+	genesisBlock.transactionRoot,
 	'Lisk',
 );
 
@@ -136,12 +136,12 @@ describe('chain', () => {
 				await expect(chainInstance.init()).rejects.toEqual(error);
 			});
 
-			it('should throw an error if the genesis block payloadHash is different', async () => {
+			it('should throw an error if the genesis block transactionRoot is different', async () => {
 				// Arrange
 				const error = new Error('Genesis block does not match');
 				const mutatedGenesisBlock = {
 					...genesisBlock,
-					payloadHash: genesisBlock.payloadHash.replace('0', '1'),
+					transactionRoot: genesisBlock.transactionRoot.replace('0', '1'),
 				};
 				when(db.get)
 					.calledWith(`blocks:height:${formatInt(1)}`)
@@ -290,7 +290,7 @@ describe('chain', () => {
 		const blockJSON = {
 			totalFee: '10000000',
 			totalAmount: '1',
-			payloadHash:
+			transactionRoot:
 				'564352bc451aca0e2aeca2aebf7a3d7af18dbac73eaa31623971bfc63d20339c',
 			payloadLength: 117,
 			numberOfTransactions: 1,

elements/lisk-chain/test/unit/data_access/data_access.spec.ts

@@ -507,7 +507,7 @@ describe('data_access', () => {
 		const blockJSON = {
 			totalFee: '10000000',
 			totalAmount: '1',
-			payloadHash:
+			transactionRoot:
 				'564352bc451aca0e2aeca2aebf7a3d7af18dbac73eaa31623971bfc63d20339c',
 			payloadLength: 117,
 			numberOfTransactions: 1,

elements/lisk-chain/test/unit/process.spec.ts

@@ -57,7 +57,7 @@ describe('blocks/header', () => {
 		epochTime: new Date(Date.UTC(2016, 4, 24, 17, 0, 0, 0)).toISOString(),
 	};
 	const networkIdentifier = getNetworkIdentifier(
-		genesisBlock.payloadHash,
+		genesisBlock.transactionRoot,
 		genesisBlock.communityIdentifier,
 	);
 
@@ -170,7 +170,7 @@ describe('blocks/header', () => {
 			});
 		});
 
-		describe('when payload hash is incorrect', () => {
+		describe('when transaction root is incorrect', () => {
 			it('should throw error', () => {
 				// Arrange
 				const txs = new Array(20).fill(0).map(() =>
@@ -187,12 +187,12 @@ describe('blocks/header', () => {
 						}) as TransactionJSON,
 					),
 				);
-				block = newBlock({ transactions: txs, payloadHash: '1234567890' });
+				block = newBlock({ transactions: txs, transactionRoot: '1234567890' });
 				blockBytes = getBytes(block);
 				// Act & assert
 				expect(() =>
 					chainInstance.validateBlockHeader(block, blockBytes),
-				).toThrow('Invalid payload hash');
+				).toThrow('Invalid transaction root');
 			});
 		});
 

elements/lisk-chain/test/unit/transactions.spec.ts

@@ -48,7 +48,7 @@ describe('blocks/transactions', () => {
 		epochTime: new Date(Date.UTC(2016, 4, 24, 17, 0, 0, 0)).toISOString(),
 	};
 	const networkIdentifier = getNetworkIdentifier(
-		genesisBlock.payloadHash,
+		genesisBlock.transactionRoot,
 		genesisBlock.communityIdentifier,
 	);