Add optional data field with transaction - Closes #26

helpers/constants.js

@@ -53,7 +53,8 @@ var constants = {
 		secondsignature: 500000000,
 		delegate: 2500000000,
 		multisignature: 500000000,
-		dapp: 2500000000
+		dapp: 2500000000,
+		data: 10000000
 	},
 	feeStart: 1,
 	feeStartVolume: 10000 * 100000000,

logic/transfer.js

@@ -1,10 +1,11 @@
 'use strict';
 
 var constants = require('../helpers/constants.js');
+var bignum = require('../helpers/bignum.js');
 var slots = require('../helpers/slots.js');
 
 // Private fields
-var modules;
+var modules, library;
 
 /**
  * Main transfer logic.
@@ -13,7 +14,12 @@ var modules;
  * @classdesc Main transfer logic.
  */
 // Constructor
-function Transfer () {}
+function Transfer (logger, schema) {
+	library = {
+		logger: logger,
+		schema: schema,
+	};
+}
 
 // Public methods
 /**
@@ -33,7 +39,12 @@ Transfer.prototype.bind = function (accounts) {
  * @return {number} fee
  */
 Transfer.prototype.calculateFee = function (trs, sender) {
-	return constants.fees.send;
+	var fee = new bignum(constants.fees.send);
+	if (trs.asset && trs.asset.data) {
+		fee = fee.plus(constants.fees.data);
+	}
+
+	return Number(fee.toString());
 };
 
 /**
@@ -66,11 +77,21 @@ Transfer.prototype.process = function (trs, sender, cb) {
 };
 
 /**
+ * Creates a buffer with asset.transfer.data.
  * @param {transaction} trs
- * @return {null}
+ * @return {buffer} buf
+ * @throws {error} error
  */
 Transfer.prototype.getBytes = function (trs) {
-	return null;
+	var buf;
+
+	try {
+		buf = (trs.asset && trs.asset.data) ? Buffer.from(trs.asset.data, 'utf8') : null;
+	} catch (ex) {
+		throw ex;
+	}
+
+	return buf;
 };
 
 /**
@@ -153,29 +174,107 @@ Transfer.prototype.undoUnconfirmed = function (trs, sender, cb) {
 	return setImmediate(cb);
 };
 
+
 /**
- * Deletes blockId from transaction 
+ * @typedef {Object} transfer 
+ * @property {String} data
+ */
+Transfer.prototype.schema = {
+	id: 'transfer',
+	type: 'object',
+	properties: {
+		data: {
+			type: 'string',
+			minLength: 1,
+			maxLength: 64
+		}
+	}
+};
+
+/**
+ * Deletes blockId from transaction, and validates schema if asset exists.
  * @param {transaction} trs
  * @return {transaction}
  */
 Transfer.prototype.objectNormalize = function (trs) {
 	delete trs.blockId;
+
+	if (!trs.asset) {
+		return trs;
+	}
+
+	if (trs.asset.data === null || typeof trs.asset.data === 'undefined') {
+		delete trs.asset.data;
+	}
+
+	var report = library.schema.validate(trs.asset, Transfer.prototype.schema);
+
+	if (!report) {
+		throw 'Failed to validate transfer schema: ' + library.schema.getLastErrors().map(function (err) {
+			return err.message;
+		}).join(', ');
+	}
+
 	return trs;
 };
 
+Transfer.prototype.dbTable = 'transfer';
+
+Transfer.prototype.dbFields = [
+	'data',
+	'transactionId'
+];
+
 /**
+ * @typedef transferAsset
+ * @property {String} data
+ */
+
+/**
+ * Checks if asset exists, if so, returns value, otherwise returns null.
  * @param {Object} raw
- * @return {null}
+ * @return {transferAsset|null}
  */
 Transfer.prototype.dbRead = function (raw) {
+	if (raw.tf_data) {
+		return {data: raw.tf_data};
+	}
+
 	return null;
 };
 
 /**
+ * @typedef trsPromise
+ * @property {string} table
+ * @property {array} fields
+ * @property {object} values
+ */
+
+/**
+ * Checks if asset exists, if so, returns transfer table promise, otherwise returns null.
  * @param {transaction} trs
- * @return {null}
+ * @return {trsPromise|null}
  */
 Transfer.prototype.dbSave = function (trs) {
+	if (trs.asset && trs.asset.data) {
+		var data;
+
+		try {
+			data = Buffer.from(trs.asset.data, 'utf8');
+		} catch (ex) {
+			throw ex;
+		}
+
+		return {
+			table: this.dbTable,
+			fields: this.dbFields,
+			values: {
+				data: data,
+				transactionId: trs.id
+			}
+		};
+	}
+
 	return null;
 };
 

modules/transactions.js

@@ -57,7 +57,7 @@ function Transactions (cb, scope) {
 	);
 
 	__private.assetTypes[transactionTypes.SEND] = library.logic.transaction.attachAssetType(
-		transactionTypes.SEND, new Transfer()
+		transactionTypes.SEND, new Transfer(library.logger, library.schema)
 	);
 
 	setImmediate(cb, null, self);
@@ -240,6 +240,7 @@ __private.getById = function (id, cb) {
 
 		var rawTransaction = rows[0];
 		var queryNames = {};
+		queryNames[transactionTypes.SEND] = 'getTransferById';
 		queryNames[transactionTypes.SIGNATURE] = 'getSignatureById';
 		queryNames[transactionTypes.DELEGATE] = 'getDelegateById';
 		queryNames[transactionTypes.VOTE] = 'getVotesById';
@@ -651,7 +652,6 @@ Transactions.prototype.shared = {
 				}
 
 				return setImmediate(cb, null, {transaction: transaction});
-
 			});
 		});
 	},

package.json

@@ -80,7 +80,7 @@
     "istanbul-middleware": "=0.2.2",
     "jsdoc": "=3.4.3",
     "jsdox": "=0.4.10",
-    "lisk-js": "=0.4.3",
+    "lisk-js": "git://github.com/LiskHQ/lisk-js#optional_data_test",
     "mocha": "=3.4.2",
     "moment": "=2.18.1",
     "pm2": "=2.4.6",

sql/migrations/20170814143733_createTransferTrsTable.sql

@@ -0,0 +1,15 @@
+/**
+ * Create transfer trs table and index.
+ */
+
+BEGIN;
+
+CREATE TABLE IF NOT EXISTS "transfer" (
+  "data" BYTEA NOT NULL,
+  "transactionId" VARCHAR(20) NOT NULL,
+  FOREIGN KEY("transactionId") REFERENCES "trs"("id") ON DELETE CASCADE
+);
+
+CREATE INDEX IF NOT EXISTS "transfer_trs_id" ON "transfer"("transactionId");
+
+COMMIT;

sql/migrations/20170814144034_recreateFullBlockListView.sql

@@ -0,0 +1,67 @@
+/**
+ * Recreate full_blocks_list, add join for transfer table.
+ */
+
+BEGIN; 
+
+DROP VIEW IF EXISTS full_blocks_list;
+
+CREATE VIEW full_blocks_list AS
+
+SELECT b."id" AS "b_id",
+       b."version" AS "b_version",
+       b."timestamp" AS "b_timestamp",
+       b."height" AS "b_height",
+       b."previousBlock" AS "b_previousBlock",
+       b."numberOfTransactions" AS "b_numberOfTransactions",
+       (b."totalAmount")::bigint AS "b_totalAmount",
+       (b."totalFee")::bigint AS "b_totalFee",
+       (b."reward")::bigint AS "b_reward",
+       b."payloadLength" AS "b_payloadLength",
+       ENCODE(b."payloadHash", 'hex') AS "b_payloadHash",
+       ENCODE(b."generatorPublicKey", 'hex') AS "b_generatorPublicKey",
+       ENCODE(b."blockSignature", 'hex') AS "b_blockSignature",
+       t."id" AS "t_id",
+       t."rowId" AS "t_rowId",
+       t."type" AS "t_type",
+       t."timestamp" AS "t_timestamp",
+       ENCODE(t."senderPublicKey", 'hex') AS "t_senderPublicKey",
+       t."senderId" AS "t_senderId",
+       t."recipientId" AS "t_recipientId",
+       (t."amount")::bigint AS "t_amount",
+       (t."fee")::bigint AS "t_fee",
+       ENCODE(t."signature", 'hex') AS "t_signature",
+       ENCODE(t."signSignature", 'hex') AS "t_signSignature",
+       ENCODE(s."publicKey", 'hex') AS "s_publicKey",
+       d."name" AS "d_username",
+       v."votes" AS "v_votes",
+       m."min" AS "m_min",
+       m."lifetime" AS "m_lifetime",
+       m."keysgroup" AS "m_keysgroup",
+       dapp."name" AS "dapp_name",
+       dapp."description" AS "dapp_description",
+       dapp."tags" AS "dapp_tags",
+       dapp."type" AS "dapp_type",
+       dapp."link" AS "dapp_link",
+       dapp."category" AS "dapp_category",
+       dapp."icon" AS "dapp_icon",
+       it."dappId" AS "in_dappId",
+       ot."dappId" AS "ot_dappId",
+       ot."outTransactionId" AS "ot_outTransactionId",
+       ENCODE(t."requesterPublicKey", 'hex') AS "t_requesterPublicKey",
+       CONVERT_FROM(tf."data", 'utf8') AS "tf_data",
+       t."signatures" AS "t_signatures"
+
+FROM blocks b
+
+LEFT OUTER JOIN trs AS t ON t."blockId" = b."id"
+LEFT OUTER JOIN delegates AS d ON d."tx_id" = t."id"
+LEFT OUTER JOIN votes AS v ON v."transactionId" = t."id"
+LEFT OUTER JOIN signatures AS s ON s."transactionId" = t."id"
+LEFT OUTER JOIN multisignatures AS m ON m."transactionId" = t."id"
+LEFT OUTER JOIN dapps AS dapp ON dapp."transactionId" = t."id"
+LEFT OUTER JOIN intransfer AS it ON it."transactionId" = t."id"
+LEFT OUTER JOIN outtransfer AS ot ON ot."transactionId" = t."id"
+LEFT OUTER JOIN transfer AS tf ON tf."transactionId" = t."id";
+
+COMMIT;

sql/transactions.js

@@ -46,6 +46,8 @@ var TransactionsSql = {
 
 	getById: 'SELECT *, ENCODE ("t_senderPublicKey", \'hex\') AS "t_senderPublicKey", ENCODE ("m_recipientPublicKey", \'hex\') AS "m_recipientPublicKey" FROM trs_list WHERE "t_id" = ${id}',
 
+	getTransferById: 'SELECT CONVERT_FROM(data, \'utf8\') AS "tf_data" FROM transfer WHERE "transactionId" = ${id}',
+
 	getVotesById: 'SELECT votes AS "v_votes" FROM votes WHERE "transactionId" = ${id}',
 
 	getDelegateById: 'SELECT username AS "d_username" FROM delegates WHERE "transactionId" = ${id}',

test/api/blocks.js

@@ -72,7 +72,7 @@ describe('GET /api/blocks/getfees', function () {
 			node.expect(res.body).to.have.property('fees');
 			node.expect(res.body.fees.send).to.equal(node.fees.transactionFee);
 			node.expect(res.body.fees.vote).to.equal(node.fees.voteFee);
-			node.expect(res.body.fees.dapp).to.equal(node.fees.dappAddFee);
+			node.expect(res.body.fees.dapp).to.equal(node.fees.dappRegistrationFee);
 			node.expect(res.body.fees.secondsignature).to.equal(node.fees.secondPasswordFee);
 			node.expect(res.body.fees.delegate).to.equal(node.fees.delegateRegistrationFee);
 			node.expect(res.body.fees.multisignature).to.equal(node.fees.multisignatureRegistrationFee);