@ocap/tx-protocols 1.18.88 → 1.18.90

package/lib/pipes/ensure-cost.js

@@ -1,6 +1,6 @@
 const noop = require('lodash/noop');
 const { CustomError: Error } = require('@ocap/util/lib/error');
-const { fromTokenToUnit, BN } = require('@ocap/util');
+const { fromTokenToUnit, BN, fromUnitToToken } = require('@ocap/util');
 const JWT = require('@arcblock/jwt');
 const { account } = require('@ocap/state');
 const { toAddress } = require('@arcblock/did');
@@ -11,6 +11,8 @@ const debug = require('debug')(`${require('../../package.json').name}:pipes:ensu
 
 const { applyTokenUpdates, isGasStakeValid } = require('../util');
 
+const ZERO = new BN(0);
+
 // We have a layered transaction cost design
 // - gas: charged for every tx for creating/updating states on the ledger
 // - service fee: charged for creating tokens/assets/factories/rollups
@@ -25,22 +27,6 @@ module.exports = function CreateEnsureTxCostPipe({
     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 (!gasOnly && txFee) {
-      const totalFee = fromTokenToUnit(txFee, config.token.decimal);
-      txCost = txCost.add(totalFee);
-      changes.fee = { address: config.token.address, value: totalFee.toString(10) };
-      context.feeVaultChange = changes.fee;
-    }
-    if (totalGas.gt(new BN(0))) {
-      txCost = txCost.add(totalGas);
-      changes.gas = { address: config.token.address, value: totalGas.toString(10) };
-      context.gasVaultChange = changes.gas;
-    }
-
     // verify gas staking headers
     const { tx, extra = {}, txHash } = context;
     const { token, pk } = extra.gasStakeHeaders || {};
@@ -58,6 +44,7 @@ module.exports = function CreateEnsureTxCostPipe({
         console.warn(`Invalid gas payer header for: ${txHash}`);
       }
     }
+    // fallback to tx sender
     if (!gasStake.owner) {
       gasStake.owner = tx.from;
       gasStake.stakeId = toStakeAddress(gasStake.owner, gasStake.owner);
@@ -67,13 +54,31 @@ module.exports = function CreateEnsureTxCostPipe({
     context.gasStake = gasStake;
     debug('gasStake', gasStake, context.extra);
 
-    let isGasCharged = false;
-    if (senderState && !gasStake.valid) {
+    // Get service fee and gas fee
+    const changes = {};
+    let txCost = new BN(0);
+    const txFee = config.transaction.txFee[txType];
+    // always charge tx fee
+    if (!gasOnly && txFee) {
+      const totalFee = fromTokenToUnit(txFee, config.token.decimal);
+      txCost = txCost.add(totalFee);
+      changes.fee = { address: config.token.address, value: totalFee.toString(10) };
+      context.feeVaultChange = changes.fee;
+    }
+    // only charge gas when gas stake is not valid
+    if (!gasStake.valid && totalGas.gt(ZERO)) {
+      txCost = txCost.add(totalGas);
+      changes.gas = { address: config.token.address, value: totalGas.toString(10) };
+      context.gasVaultChange = changes.gas;
+    }
+
+    let isCostCharged = false;
+    if (senderState && txCost.gt(ZERO)) {
       const expected = new BN(gasEstimate.payment || 0).add(txCost);
       const actual = new BN(senderState.tokens[config.token.address] || 0);
       // If we have someone with enough balance to pay for this tx
       if (actual.gte(expected)) {
-        isGasCharged = true;
+        isCostCharged = true;
 
         // to be merged into later pipe
         context.senderUpdates = applyTokenUpdates(
@@ -151,13 +156,16 @@ module.exports = function CreateEnsureTxCostPipe({
         return next(
           new Error(
             'INSUFFICIENT_FUND',
-            `Insufficient fund to pay for tx cost from ${senderState.address}, expected ${expected}, got ${actual}`
+            `Insufficient fund to pay for tx cost from ${senderState.address}, expected ${fromUnitToToken(
+              expected,
+              config.token.decimal
+            )}, got ${fromUnitToToken(actual, config.token.decimal)}`
           )
         );
       }
     }
 
-    if (!isGasCharged) {
+    if (!isCostCharged) {
       context.senderUpdates = {};
       context.senderChange = null;
       context.updateVaults = noop;

package/package.json

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