Add validation of custom transaction - Closes #3877

elements/lisk-transactions/src/index.ts

@@ -50,6 +50,7 @@ import {
 	signRawTransaction,
 	signTransaction,
 	stringEndsWith,
+	transactionInterface,
 	validateAddress,
 	validateFee,
 	validateKeysgroup,
@@ -115,6 +116,7 @@ export {
 	TransactionResponse,
 	TransactionJSON,
 	TransactionError,
+	transactionInterface,
 	convertToAssetError,
 	constants,
 	exposedUtils as utils,

elements/lisk-transactions/src/utils/validation/index.ts

@@ -33,3 +33,4 @@ export {
 } from './validation';
 export { validateTransaction } from './validate_transaction';
 export { validator } from './validator';
+export { transactionInterface } from './schema';

elements/lisk-transactions/src/utils/validation/schema.ts

@@ -65,6 +65,64 @@ export const transaction = {
 	},
 };
 
+export const transactionInterface = {
+	required: [
+		'toJSON',
+		'isReady',
+		'getBytes',
+		'validate',
+		'verifyAgainstOtherTransactions',
+		'apply',
+		'undo',
+		'prepare',
+		'addMultisignature',
+		'addVerifiedMultisignature',
+		'isExpired',
+		'fromSync',
+	],
+	properties: {
+		toJSON: {
+			typeof: 'function',
+		},
+		isReady: {
+			typeof: 'function',
+		},
+		getBytes: {
+			typeof: 'function',
+		},
+		validate: {
+			typeof: 'function',
+		},
+		verifyAgainstOtherTransactions: {
+			typeof: 'function',
+		},
+		apply: {
+			typeof: 'function',
+		},
+		undo: {
+			typeof: 'function',
+		},
+		prepare: {
+			typeof: 'function',
+		},
+		addMultisignature: {
+			typeof: 'function',
+		},
+		addVerifiedMultisignature: {
+			typeof: 'function',
+		},
+		processMultisignatures: {
+			typeof: 'function',
+		},
+		isExpired: {
+			typeof: 'function',
+		},
+		fromSync: {
+			typeof: 'function',
+		},
+	},
+};
+
 // TODO: Add senderId and recipientId to required once deprecated functions relying on this schema are removed
 export const baseTransaction = {
 	$id: 'lisk/base-transaction',

framework/package.json

@@ -53,6 +53,7 @@
 		"@liskhq/lisk-transaction-pool": "0.1.0",
 		"@liskhq/lisk-transactions": "2.1.0",
 		"ajv": "6.7.0",
+		"ajv-keywords": "3.4.0",
 		"async": "2.6.1",
 		"bignumber.js": "8.0.2",
 		"bluebird": "3.5.3",

framework/src/controller/application.js

@@ -21,6 +21,7 @@ const {
 	DelegateTransaction,
 	VoteTransaction,
 	MultisignatureTransaction,
+	transactionInterface,
 } = require('@liskhq/lisk-transactions');
 const randomstring = require('randomstring');
 const _ = require('lodash');
@@ -233,10 +234,14 @@ class Application {
 		);
 
 		assert(
-			!Object.keys(this.getTransactions()).includes(Transaction.TYPE),
+			!Object.keys(this.getTransactions()).includes(
+				Transaction.TYPE.toString()
+			),
 			`A transaction type "${Transaction.TYPE}" is already registered.`
 		);
 
+		validator.validate(transactionInterface, Transaction.prototype);
+
 		if (matcher) {
 			Object.defineProperty(Transaction.prototype, 'matcher', {
 				get: () => matcher,

framework/src/controller/validator/index.js

@@ -21,6 +21,7 @@ const _ = require('lodash');
  * Custom Lisk Framework Validator implemented on top of Ajv (https://github.com/epoberezkin/ajv)
  */
 const Ajv = require('ajv');
+const ajvKeywords = require('ajv-keywords');
 const { SchemaValidationError } = require('../../errors');
 const formats = require('./formats');
 const ZSchema = require('./z_schema');
@@ -33,13 +34,17 @@ const validator = new Ajv({
 	$data: true,
 });
 
+ajvKeywords(validator);
+
 const parserAndValidator = new Ajv({
 	allErrors: true,
 	schemaId: 'auto',
 	useDefaults: false,
 	$data: true,
 });
 
+ajvKeywords(parserAndValidator);
+
 parserAndValidator.addKeyword('env', envKeyword);
 parserAndValidator.addKeyword('arg', argKeyword);
 

framework/src/errors.js

@@ -37,7 +37,6 @@ class SchemaValidationError extends FrameworkError {
 	 */
 	constructor(errors) {
 		super('Schema validation error');
-		this.message = JSON.stringify(errors, null, 2);
 		this.errors = errors;
 		this.message = JSON.stringify(errors, null, 2);
 	}

framework/test/jest/unit/specs/controller/__snapshots__/application.spec.js.snap

@@ -62,8 +62,6 @@ Object {
       "broadcasts": Object {
         "active": true,
         "broadcastInterval": 5000,
-        "broadcastLimit": 25,
-        "parallelLimit": 20,
         "relayLimit": 3,
         "releaseLimit": 25,
       },
@@ -75,12 +73,15 @@ Object {
         "inertTransactions": Array [],
         "multisignatures": Array [],
         "precedent": Object {
+          "disableDappTransaction": 0,
           "disableDappTransfer": 0,
         },
         "recipientExceedingUint64": Object {},
         "recipientLeadingZero": Object {},
+        "roundVotes": Array [],
         "rounds": Object {},
         "senderPublicKey": Array [],
+        "signSignature": Array [],
         "signatures": Array [],
         "transactionWithNullByte": Array [],
         "votes": Array [],
@@ -497,28 +498,14 @@ Object {
       },
       "loading": Object {
         "loadPerIteration": 5000,
-        "rebuildUpToRound": 0,
+        "rebuildUpToRound": null,
       },
-      "network": Object {
-        "access": Object {
-          "blackList": Array [],
-        },
-        "address": "0.0.0.0",
-        "enabled": true,
-        "list": Array [
-          Object {
-            "ip": "127.0.0.1",
-            "wsPort": 5000,
-          },
-        ],
-        "options": Object {
-          "broadhashConsensusCalculationInterval": 5000,
-          "httpHeadersTimeout": 5000,
-          "httpServerSetTimeout": 20000,
-          "timeout": 5000,
-          "wsEngine": "ws",
-        },
-        "wsPort": 5000,
+      "registeredTransactions": Object {
+        "0": [Function],
+        "1": [Function],
+        "2": [Function],
+        "3": [Function],
+        "4": [Function],
       },
       "syncing": Object {
         "active": true,
@@ -574,6 +561,22 @@ Object {
       },
       "trustProxy": false,
     },
+    "network": Object {
+      "ackTimeout": 20000,
+      "address": "0.0.0.0",
+      "blacklistedPeers": Array [],
+      "connectTimeout": 5000,
+      "discoveryInterval": 30000,
+      "emitPeerLimit": 25,
+      "seedPeers": Array [
+        Object {
+          "ip": "127.0.0.1",
+          "wsPort": 5000,
+        },
+      ],
+      "wsEngine": "ws",
+      "wsPort": 5000,
+    },
   },
 }
 `;