@ocap/tx-protocols 1.18.0 → 1.18.2

package/lib/pipes/ensure-cost.js

@@ -1,12 +1,15 @@
 const noop = require('lodash/noop');
 const { CustomError: Error } = require('@ocap/util/lib/error');
 const { fromTokenToUnit, BN } = require('@ocap/util');
+const JWT = require('@arcblock/jwt');
 const { account } = require('@ocap/state');
+const { toAddress } = require('@arcblock/did');
+const { toStakeAddress } = require('@arcblock/did-util');
 
 // eslint-disable-next-line global-require
 const debug = require('debug')(`${require('../../package.json').name}:pipes:ensure-cost`);
 
-const { applyTokenUpdates } = require('../util');
+const { applyTokenUpdates, isGasStakeValid } = require('../util');
 
 // We have a layered transaction cost design
 // - gas: charged for every tx for creating/updating states on the ledger
@@ -18,9 +21,9 @@ module.exports = function CreateEnsureTxCostPipe({ attachSenderChanges = true }
     const { config, statedb, txType, senderState, gasEstimate, gasVaultState, totalGas } = context;
     const feeVaultState = await statedb.account.get(config.vaults.txFee, context);
 
+    // Get service fee and gas fee
     const changes = {};
     let txCost = new BN(0);
-
     const txFee = config.transaction.txFee[txType];
     if (txFee) {
       const totalFee = fromTokenToUnit(txFee, config.token.decimal);
@@ -34,7 +37,28 @@ module.exports = function CreateEnsureTxCostPipe({ attachSenderChanges = true }
       context.gasVaultChange = changes.gas;
     }
 
-    if (senderState) {
+    // verify gas staking headers
+    const { tx, gasStakeHeaders = {} } = context;
+    const { token, pk } = gasStakeHeaders || {};
+    const gasStake = {};
+    if (token && pk) {
+      if (JWT.verify(token, pk) === false) {
+        return next(new Error('INVALID_GAS_HEADER', 'Gas headers can not be verified'));
+      }
+
+      const decoded = JWT.decode(token);
+      gasStake.owner = toAddress(decoded.iss);
+      gasStake.stakeId = toStakeAddress(gasStake.owner, gasStake.owner);
+    } else {
+      gasStake.owner = tx.from;
+      gasStake.stakeId = toStakeAddress(gasStake.owner, gasStake.owner);
+    }
+    gasStake.state = await statedb.stake.get(gasStake.stakeId, context);
+    gasStake.valid = isGasStakeValid(gasStake.state, config);
+    context.gasStake = gasStake;
+
+    // If we have someone to pay for this tx
+    if (senderState && !gasStake.valid) {
       const expected = new BN(gasEstimate.payment || 0).add(txCost);
       const actual = new BN(senderState.tokens[config.token.address] || 0);
       if (actual.lt(expected)) {

package/lib/protocols/asset/acquire-v2.js

@@ -121,7 +121,11 @@ runner.use(
     const senderUpdates = {
       nonce: tx.nonce,
       pk: tx.pk,
-      ...applyTokenUpdates(factoryTokens, applyTokenChange(senderState, senderChange), 'sub'),
+      ...applyTokenUpdates(
+        factoryTokens,
+        senderChange ? applyTokenChange(senderState, senderChange) : senderState,
+        'sub'
+      ),
     };
 
     // Owner updates

package/lib/protocols/governance/stake.js

@@ -3,6 +3,7 @@ const { promisify } = require('util');
 const isEmpty = require('empty-value');
 const { Joi } = require('@arcblock/validator');
 const { CustomError: Error } = require('@ocap/util/lib/error');
+const { BN, fromTokenToUnit } = require('@ocap/util');
 const { Runner, pipes } = require('@ocap/tx-pipeline');
 const { toStakeAddress } = require('@arcblock/did-util');
 const { account, asset, stake } = require('@ocap/state');
@@ -10,7 +11,7 @@ const { account, asset, stake } = require('@ocap/state');
 // eslint-disable-next-line global-require
 const debug = require('debug')(`${require('../../../package.json').name}:stake`);
 
-const { applyTokenUpdates, applyTokenChange } = require('../../util');
+const { applyTokenUpdates, applyTokenChange, isGasStakeAddress, isGasStakeInput } = require('../../util');
 
 const EnsureTxGas = require('../../pipes/ensure-gas');
 const EnsureTxCost = require('../../pipes/ensure-cost');
@@ -97,6 +98,37 @@ runner.use(async (context, next) => {
   return next();
 });
 
+// 8. handle tx gas stakes
+runner.use(async (context, next) => {
+  const { tx, itx, inputs, config } = context;
+  const { token, transaction } = config;
+  const { minStake, maxStake } = transaction.txGas;
+
+  // FIXME: delegation not supported here
+  context.isGasStake = isGasStakeAddress(tx.from, itx.address) && isGasStakeInput(inputs, token.address);
+
+  if (context.isGasStake) {
+    const [tokenInput] = inputs[0].tokensList;
+    const actualStake = new BN(tokenInput.value);
+    const expectedMinStake = fromTokenToUnit(minStake, token.decimal);
+    const expectedMaxStake = fromTokenToUnit(maxStake, token.decimal);
+    if (actualStake.lt(expectedMinStake)) {
+      return next(new Error('INVALID_TX', `Stake for gas should be greater than: ${minStake}`));
+    }
+    if (actualStake.gt(expectedMaxStake)) {
+      return next(new Error('INVALID_TX', `Stake for gas should be less than: ${maxStake}`));
+    }
+  }
+
+  if (context.isGasStake) {
+    context.revokeWaitingPeriod = transaction.txGas.stakeLockPeriod;
+  } else {
+    context.revokeWaitingPeriod = itx.revokeWaitingPeriod;
+  }
+
+  return next();
+});
+
 // Ensure tx fee and gas
 runner.use(
   EnsureTxGas((context) => {
@@ -192,7 +224,8 @@ runner.use(
               {
                 sender: tx.from,
                 revocable: !itx.locked,
-                ...pick(itx, ['address', 'receiver', 'message', 'data', 'revokeWaitingPeriod']),
+                revokeWaitingPeriod: context.revokeWaitingPeriod,
+                ...pick(itx, ['address', 'receiver', 'message', 'data']),
                 ...stakeUpdates,
               },
               context

package/lib/protocols/rollup/claim-reward.js

@@ -268,7 +268,7 @@ runner.use(
           let updateSet = applyTokenChange(x, updates.account[x.address]);
           if (x.address === senderState.address) {
             updateSet.nonce = tx.nonce;
-            updateSet = Object.assign(updateSet, applyTokenChange(updateSet, senderChange));
+            updateSet = Object.assign(updateSet, senderChange ? applyTokenChange(updateSet, senderChange) : {});
           }
 
           return statedb.account.update(x.address, account.update(x, updateSet, context), context);

package/lib/protocols/token/withdraw-v2.js

@@ -204,7 +204,9 @@ runner.use(
     const fee = getBNSum(itx.actualFee, itx.maxFee);
 
     let senderUpdates = applyTokenUpdates([{ address: itx.token.address, value: total }], senderState, 'sub');
-    senderUpdates = applyTokenChange(senderUpdates, senderChange);
+    if (senderChange) {
+      senderUpdates = applyTokenChange(senderUpdates, senderChange);
+    }
 
     // Burned amount should equal to user received amount
     const stakeUpdates = applyTokenUpdates(

package/lib/protocols/trade/exchange-v2.js

@@ -174,7 +174,9 @@ runner.use(
       receiverStateTokens[address] = new BN(receiverStateTokens[address] || '0').sub(delta).toString();
     }
 
-    const senderUpdates = applyTokenChange({ tokens: senderStateTokens }, senderChange);
+    const senderUpdates = senderChange
+      ? applyTokenChange({ tokens: senderStateTokens }, senderChange)
+      : { tokens: senderStateTokens };
 
     const [newSenderState, newReceiverState] = await Promise.all([
       // Update sender state

package/lib/protocols/trade/transfer-v2.js

@@ -128,7 +128,9 @@ runner.use(
       receiverTokens[token.address] = new BN(receiverTokens[token.address] || '0').add(delta).toString();
     }
 
-    const senderUpdates = applyTokenChange({ tokens: senderTokens }, senderChange);
+    const senderUpdates = senderChange
+      ? applyTokenChange({ tokens: senderTokens }, senderChange)
+      : { tokens: senderTokens };
 
     const [newSenderState, newReceiverState] = await Promise.all([
       // Update sender state

package/lib/util.js

@@ -1,7 +1,7 @@
 const groupBy = require('lodash/groupBy');
 const flattenDeep = require('lodash/flattenDeep');
 const { CustomError: Error } = require('@ocap/util/lib/error');
-const { BN } = require('@ocap/util');
+const { BN, fromTokenToUnit } = require('@ocap/util');
 const { decodeAny } = require('@ocap/message');
 const { toStakeAddress } = require('@arcblock/did-util');
 const cloneDeep = require('lodash/cloneDeep');
@@ -313,6 +313,53 @@ const ensureBlockReward = (rollupState, minReward, txStates) => {
   return result;
 };
 
+const isGasStakeAddress = (sender, stakeId) => toStakeAddress(sender, sender) === stakeId;
+const isGasStakeInput = (inputs, token) => {
+  if (inputs.length !== 1) {
+    return false;
+  }
+
+  const [{ assetsList, tokensList }] = inputs;
+  if (assetsList.length > 0) {
+    return false;
+  }
+  if (tokensList.length !== 1) {
+    return false;
+  }
+
+  const [tokenInput] = tokensList;
+  if (tokenInput.address !== token) {
+    return false;
+  }
+
+  return true;
+};
+const isGasStakeValid = (state, config) => {
+  if (!state) {
+    return false;
+  }
+
+  const { token, transaction } = config;
+  const { minStake } = transaction.txGas;
+  const expectedMin = fromTokenToUnit(minStake, token.decimal);
+
+  if (state.tokens) {
+    const actualStaked = new BN(state.tokens[token.address] || 0);
+    if (actualStaked.gte(expectedMin)) {
+      return true;
+    }
+  }
+
+  if (state.revokedTokens) {
+    const actualRevoked = new BN(state.revokedTokens[token.address] || 0);
+    if (actualRevoked.gte(expectedMin)) {
+      return true;
+    }
+  }
+
+  return false;
+};
+
 module.exports = {
   decodeAnySafe,
   applyTokenUpdates,
@@ -324,5 +371,8 @@ module.exports = {
   ensureBlockReward,
   getBNSum,
   isFixedFee,
+  isGasStakeAddress,
+  isGasStakeInput,
+  isGasStakeValid,
   RATE_BASE,
 };

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.18.0",
+  "version": "1.18.2",
   "description": "Predefined tx pipeline sets to execute certain type of transactions",
   "main": "lib/index.js",
   "files": [
@@ -21,17 +21,18 @@
   "author": "wangshijun <wangshijun2010@gmail.com> (http://github.com/wangshijun)",
   "license": "MIT",
   "dependencies": {
-    "@arcblock/did": "1.18.0",
-    "@arcblock/did-util": "1.18.0",
-    "@arcblock/validator": "1.18.0",
-    "@ocap/asset": "1.18.0",
-    "@ocap/mcrypto": "1.18.0",
-    "@ocap/merkle-tree": "1.18.0",
-    "@ocap/message": "1.18.0",
-    "@ocap/state": "1.18.0",
-    "@ocap/tx-pipeline": "1.18.0",
-    "@ocap/util": "1.18.0",
-    "@ocap/wallet": "1.18.0",
+    "@arcblock/did": "1.18.2",
+    "@arcblock/did-util": "1.18.2",
+    "@arcblock/jwt": "1.18.2",
+    "@arcblock/validator": "1.18.2",
+    "@ocap/asset": "1.18.2",
+    "@ocap/mcrypto": "1.18.2",
+    "@ocap/merkle-tree": "1.18.2",
+    "@ocap/message": "1.18.2",
+    "@ocap/state": "1.18.2",
+    "@ocap/tx-pipeline": "1.18.2",
+    "@ocap/util": "1.18.2",
+    "@ocap/wallet": "1.18.2",
     "debug": "^4.3.4",
     "deep-diff": "^1.0.2",
     "empty-value": "^1.0.1",
@@ -46,5 +47,5 @@
     "jest": "^27.5.1",
     "start-server-and-test": "^1.14.0"
   },
-  "gitHead": "c48f928ee4f0deddf0f5e4bcb82fd6ffd7f2bc99"
+  "gitHead": "7bd3abefcf732fcf5d4521622ca06db67671d853"
 }