tic-traction/Action.js

var Ling = require('fon.ling')
var Ticrypto = require('tic.crypto')

/** ****************** Public of instance ********************/

const DAD = module.exports = function Action (prop) {
  this._class = this.constructor.name
  this.setProp(prop)
  this.type = this.constructor.name
}
DAD.__proto__ = Ling
DAD._table = DAD.name
const MOM = DAD.prototype
MOM.__proto__ = Ling.prototype

/** ****************** Shared by instances ********************/
MOM._tablekey = 'hash'
MOM._model = {
  hash: { default: undefined, sqlite: 'TEXT UNIQUE', mysql: 'VARCHAR(64) PRIMARY KEY' }, // 不纳入签名和哈希
  version: { default: 0, sqlite: 'INTEGER' },
  type: { default: 'Action', sqlite: 'TEXT', mysql: 'VARCHAR(100)' }, // 是否放在 assets里更好？这里该放action自己的version
  blockHash: { default: undefined, sqlite: 'TEXT', mysql: 'VARCHAR(64)' }, // 不纳入签名和哈希。只为了方便查找
  timestamp: { default: undefined, sqlite: 'TEXT', mysql: 'CHAR(24)' },
  actorPubkey: { default: undefined, sqlite: 'TEXT', mysql: 'BINARY(32)' },
  actorAddress: { default: undefined, sqlite: 'TEXT', mysql: 'VARCHAR(50)' },
  actorSignature: { default: undefined, sqlite: 'TEXT', mysql: 'BINARY(64)' }, // 不纳入签名，纳入哈希
  toAddress: { default: undefined, sqlite: 'TEXT', mysql: 'VARCHAR(50)' },
  amount: { default: 0, sqlite: 'NUMERIC', mysql: 'BIGINT' },
  fee: { default: 0, sqlite: 'NUMERIC', mysql: 'BIGINT' },
  message: { default: undefined, sqlite: 'TEXT', mysql: 'VARCHAR(256)' },
  dataIndex: { default: undefined, sqlite: 'TEXT', mysql: 'VARCHAR(50)' }, // 用于索引json中存储数据，
  method: { default: undefined, sqlite: 'TEXT' },
  json: { default: undefined, sqlite: 'TEXT' } // 给不同类型的 ActionXxx 子类来自定义其所需的数据结构
}

MOM.packMe = function (keypair) { // 由前端调用，后台不创建
  this.actorPubkey = keypair.pubkey
  this.actorAddress = Ticrypto.pubkey2address(keypair.pubkey)
  this.timestamp = new Date()

  this.signMe(keypair.seckey)
  this.hashMe()
  return this
}

MOM.signMe = function (seckey) { // 由前端调用，后台不该进行签名
  let json = this.getJson({ exclude: ['hash', 'blockHash', 'actorSignature'] }) // 是前端用户发起事务时签字，这时候还不知道进入哪个区块，所以不能计入blockHash
  this.actorSignature = Ticrypto.sign(json, seckey)
  return this
}

MOM.hashMe = function () {
  this.hash = Ticrypto.hash(this.getJson({ exclude: ['hash', 'blockHash'] })) // block.hash 受到所包含的actionList影响，所以action不能受blockHash影响，否则循环了
  return this
}

DAD.getJson = function (action, option = {}) {
  let data = {}
  let sortedKey = Object.keys(DAD.prototype._model).sort()
  for (let exkey of option.exclude) { sortedKey.splice(sortedKey.indexOf(exkey), 1) }
  for (let key of sortedKey) { // 忽略一些不需要签名的属性
    data[key] = action[key]
  }
  let json = JSON.stringify(data)
  return json
}

DAD.verifySig = function (action) {
  let json = DAD.getJson(action, { exclude: ['hash', 'blockHash', 'actorSignature'] })
  let res = Ticrypto.verify(json, action.actorSignature, action.actorPubkey)
  return res
}

DAD.verifyAddress = function (action) {
  return action.actorAddress === Ticrypto.pubkey2address(action.actorPubkey)
}

DAD.verifyHash = function (action) {
  return action.hash === Ticrypto.hash(DAD.getJson(action, { exclude: ['hash', 'blockHash'] }))
}

MOM.validateMe = async function() { // 子类应当覆盖本方法。
  // to implement in subclasses: 检查子类事务内容的格式
  let typedAction = new wo[this.type](this)
  return await typedAction.validateMe()
}
DAD.validate = async function (action) {
  mylog.info(`Validating action type=${action.type} of hash=${action.hash}`)
  let typedAction = new wo[action.type](action)
  return await typedAction.validateMe()
}

MOM.executeMe = async function() { // 子类应当覆盖本方法。
  // to implement in subclasses: 把action的影响，汇总登记到其他表格（用于辅助的、索引的表格），方便快速索引、处理。每种事务类型都要重定义这个方法。
  let typedAction = new wo[this.type](this)
  return await typedAction.executeMe()
}
DAD.execute = async function (action) {
  mylog.info(`Excecuting action type=${action.type} of hash=${action.hash}`)
  let typedAction = new wo[action.type](action)
  return await typedAction.executeMe()
}

/**
 * 获取一批交易，在出块时调用。调用actionPool的内容被深拷贝到currentActionPool后自动清空。
 * 所以在一次出块期间只能调用一次
 */
DAD.getActionBatch = function () {
  let actionBatch = {
    actionPool: JSON.parse(JSON.stringify(DAD.actionPool)), // deep copy
    totalAmount: DAD.actionPoolInfo.totalAmount,
    totalFee: DAD.actionPoolInfo.totalFee
  }
  DAD.actionPool = {}
  DAD.actionPoolInfo = {
    totalAmount: 0,
    totalFee: 0
  }
  return actionBatch
}

/** ********************* Public of class *******************/
DAD.api = {}

DAD.api.getAction = async function (option) {
  return await DAD.getOne(option)
}

DAD.api.getActionList = async function (option) {
  return await DAD.getAll(option)
}

DAD.api.prepare = async function (option) {
  if (typeof option === 'string') {
    try {
      option = JSON.parse(option)
    } catch (error) {}
  }
  // 前端发来action数据，进行格式检查（不检查是否可执行--这和事务类型、执行顺序有关）后放入缓冲池。
  if (option && option.Action && option.Action.type && option.Action.hash && !DAD.actionPool[option.Action.hash]) {
    if (DAD.verifyAddress(option.Action) && // 只检查所有事务通用的格式
        DAD.verifySig(option.Action) &&
        DAD.verifyHash(option.Action) &&
        !DAD.actionPool[option.Action.hash] &&
        (await DAD.validate(option.Action)) // 调用子类的 validate 方法，检查子类的事务内容格式
    ) {
      DAD.actionPool[option.Action.hash] = option.Action
      DAD.actionPoolInfo.totalAmount += option.Action.amount || 0
      DAD.actionPoolInfo.totalFee += option.Action.fee || 0
      wo.NodeNet.broadcast({ Action: option.Action })
      return option.Action
    }
  }
  return null // 非法的交易数据
}
wo.NodeNet.on('broadcast', DAD.api.prepare)
/** ******************** Private in class *******************/

DAD.actionPool = {} // 交易池，在执行getActionBatch时被清空
// DAD.currentActionPool = {} // 仅包含0~40秒的交易,40~59秒的交易将被堆积到actionPool。
DAD.actionPoolInfo = {
  totalAmount: 0,
  totalFee: 0
}