@silasdavis/legacy-db/lib/unsafe.js

Javascript library that calls a Hyperledger Burrow server over rpc.

/**
 * @file unsafe.js
 * @fileOverview Factory module for the Unsafe class.
 * @author Andreas Olofsson
 * @module unsafe
 */

'use strict'

var util = require('./util')
var nUtil = require('util')

/**
 * Create a new instance of the Unsafe class.
 *
 * @param {module:rpc/client~Client} client - The client object.
 * @param {module:validation~Validator} validator - The validator object.
 * @returns {Unsafe} - A new instance of the Unsafe class.
 */
exports.createInstance = function (server, validator) {
  return new Unsafe(server, validator)
}

/**
 * Unsafe is used to call functions that require extra safety precautions. These usually involve
 * transmitting or receiving a private key.
 *
 * @param {module:rpc/client~Client} client - The client object.
 * @param {module:validation~Validator} validator - The validator object.
 * @constructor
 */
function Unsafe (server, validator) {
  util.ComponentBase.call(this, server)
  this._validator = validator
}

nUtil.inherits(Unsafe, util.ComponentBase)

/**
 * Generate an account.
 *
 * NOTE: This requires a private key to be sent from the server to the client.
 *
 * @param {*} context - an object containing information for the validator.
 * @param {module:rpc/rpc~methodCallback} callback - The callback function.
 */
Unsafe.prototype.genPrivAccount = function (context, callback) {
  if (!this._validator.validate(context)) {
    callback(new Error('Validation failed'))
  }
  this.server.genPrivAccount(callback)
}

/**
 * Transact to the account at the given address.
 *
 * @param {string} privKey - The private key that will be used to sign.
 * @param {string} address - The address to the account holding the code. Set it to null if
 * doing a tx create.
 * @param {string} data - The input data.
 * @param {number} gasLimit - The gas limit.
 * @param {number} fee - The fee.
 * @param {*} context - an object containing information for the validator.
 * @param {module:rpc/rpc~methodCallback} callback - The callback function.
 */
Unsafe.prototype.transact = function (privKey, address, data, gasLimit, fee, context, callback) {
  if (!this._validator.validate(context)) {
    callback(new Error('Validation failed'))
  }
  if (!util.isPrivKey(privKey)) {
    callback(new Error("'privKey' is not a proper private key string."))
  }
  if (address !== '') {
    if (!util.isAddress(address)) {
      callback(new Error("'address' is not a proper address string."))
    }
  }
  if (!util.isHex(data)) {
    callback(new Error("'data' is not a proper hex string."))
  }

  this.server.transact({
    priv_key: privKey,
    address,
    data,
    gas_limit: gasLimit,
    fee
  }, callback)
}

/**
 * Transact to the account at the given address, and hold until the transaction has
 * been committed to a block (or not).
 *
 * @param {string} priv_key - The private key that will be used to sign.
 * @param {string} address - The address to the account holding the code. Set it to null if
 * doing a tx create.
 * @param {string} data - The input data.
 * @param {number} gas_limit - The gas limit.
 * @param {number} fee - The fee.
 * @param {*} context - an object containing information for the validator.
 * @param {module:rpc/rpc~methodCallback} callback - The callback function.
 */
Unsafe.prototype.transactAndHold = function (privKey, address, data, gasLimit, fee, context, callback) {
  if (!this._validator.validate(context)) {
    callback(new Error('Validation failed'))
  }
  if (!util.isPrivKey(privKey)) {
    callback(new Error("'privKey' is not a proper private key string."))
  }
  if (address !== '') {
    if (!util.isAddress(address)) {
      callback(new Error("'address' is not a proper address string."))
    }
  }
  if (!util.isHex(data)) {
    callback(new Error("'data' is not a proper hex string."))
  }
  var param = {priv_key: privKey, address, data, gas_limit: gasLimit, fee}
  this.server.transactAndHold(param, callback)
}

/**
 * Send to the account at the given address.
 *
 * Note: This requires a private key to be sent to the blockchain client.
 *
 * @param {string} privKey - The private key that will be used to sign.
 * @param {string} toAddress - The target account address.
 * @param {number} amount - The amount to send.
 * @param {*} context - an object containing information for the validator.
 * @param {module:rpc/rpc~methodCallback} callback - The callback function.
 */
Unsafe.prototype.send = function (privKey, toAddress, amount, context, callback) {
  if (!this._validator.validate(context)) {
    callback(new Error('Validation failed'))
  }
  if (!util.isPrivKey(privKey)) {
    callback(new Error("'privKey' is not a proper private key string."))
  }
  if (toAddress !== '') {
    if (!util.isAddress(toAddress)) {
      callback(new Error("'address' is not a proper address string."))
    }
  }

  this.server.send({
    priv_key: privKey,
    to_address: toAddress,
    amount
  }, callback)
}

/**
 * Transact to the account at the given address, and hold until the transaction has
 * been committed to a block (or not).
 *
 * @param {string} privKey - The private key that will be used to sign.
 * @param {string} toAddress - The target account address.
 * @param {number} amount - The amount to send.
 * @param {*} context - an object containing information for the validator.
 * @param {module:rpc/rpc~methodCallback} callback - The callback function.
 */
Unsafe.prototype.sendAndHold = function (privKey, toAddress, amount, context, callback) {
  if (!this._validator.validate(context)) {
    callback(new Error('Validation failed'))
  }
  if (!util.isPrivKey(privKey)) {
    callback(new Error("'privKey' is not a proper private key string."))
  }
  if (toAddress !== '') {
    if (!util.isAddress(toAddress)) {
      callback(new Error("'address' is not a proper address string."))
    }
  }

  this.server.sendAndHold({
    priv_key: privKey,
    to_address: toAddress,
    amount
  }, callback)
}

/**
 * Transact to the name registry. The name registry is essentially a distributed key-value store that comes
 * with the client. Accessing the registry is done via the NameReg.
 *
 * Note: This requires a private key to be sent to the server.
 *
 * @param {string} privKey - The private key that will be used to sign.
 * @param {string} name - The key, or name.
 * @param {string} data - The data that should be stored.
 * @param {number} amount - The amount of tokens to send.
 * @param {number} fee - The fee.
 * @param {*} context - an object containing information for the validator.
 * @param {module:rpc/rpc~methodCallback} callback - The callback function.
 */
Unsafe.prototype.transactNameReg = function (privKey, name, data, amount, fee, context, callback) {
  if (!this._validator.validate(context)) {
    callback(new Error('Validation failed'))
  }
  if (!util.isPrivKey(privKey)) {
    callback(new Error("'privKey' is not a proper private key string."))
  }
    // 'name' must be a non-empty string.
  if (!name || typeof (name) !== 'string') {
    callback(new Error("'name' is empty."))
  }
    // 'data' must be a string.
  if (typeof (data) !== 'string') {
    callback(new Error("'data' is not a string."))
  }

  this.server.transactNameReg({
    priv_key: privKey,
    name,
    data,
    amount,
    fee
  }, callback)
}

/**
 * Set a new validator object.
 *
 * @param {module:validation~Validator} validator - The validator object.
 */
Unsafe.prototype.setValidator = function (validator) {
  this._validator = validator
}