@ocap/tx-protocols 1.18.71 → 1.18.73

package/lib/pipes/ensure-cost.js

@@ -15,7 +15,11 @@ const { applyTokenUpdates, isGasStakeValid } = require('../util');
 // - gas: charged for every tx for creating/updating states on the ledger
 // - service fee: charged for creating tokens/assets/factories/rollups
 // - protocol fee: charged for moving tokens across the bridge
-module.exports = function CreateEnsureTxCostPipe({ attachSenderChanges = true, gasOnly = false } = {}) {
+module.exports = function CreateEnsureTxCostPipe({
+  attachSenderChanges = true,
+  throwOnInsufficientFund = true, // In some cases, we can tolerance insufficient fund, such as account migration
+  gasOnly = false,
+} = {}) {
   return async function EnsureTxCost(context, next) {
     // TODO: we are using the sender as gas payer, this may change in future
     const { config, statedb, txType, senderState, gasEstimate, gasVaultState, totalGas } = context;
@@ -63,92 +67,97 @@ module.exports = function CreateEnsureTxCostPipe({ attachSenderChanges = true, g
     context.gasStake = gasStake;
     debug('gasStake', gasStake, context.extra);
 
-    // If we have someone to pay for this tx
+    let isGasCharged = false;
     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)) {
-        return next(
-          new Error(
-            'INSUFFICIENT_FUND',
-            `Insufficient fund to pay for tx cost from ${senderState.address}, expected ${expected}, got ${actual}`
-          )
-        );
-      }
+      // If we have someone with enough balance to pay for this tx
+      if (actual.gte(expected)) {
+        isGasCharged = true;
 
-      // to be merged into later pipe
-      context.senderUpdates = applyTokenUpdates(
-        [{ address: config.token.address, value: txCost.toString(10) }],
-        senderState,
-        'sub'
-      );
-      context.senderChange = {
-        address: senderState.address,
-        token: config.token.address,
-        delta: `-${txCost.toString(10)}`,
-      };
+        // to be merged into later pipe
+        context.senderUpdates = applyTokenUpdates(
+          [{ address: config.token.address, value: txCost.toString(10) }],
+          senderState,
+          'sub'
+        );
+        context.senderChange = {
+          address: senderState.address,
+          token: config.token.address,
+          delta: `-${txCost.toString(10)}`,
+        };
 
-      debug({ changes, senderUpdates: context.senderUpdates });
+        debug({ changes, senderUpdates: context.senderUpdates });
 
-      // to be called in later pipes
-      context.updateVaults = async function updateVaults() {
-        const [newFeeVaultState, newGasVaultState] = await Promise.all([
-          changes.fee
-            ? statedb.account.update(
-                feeVaultState.address,
-                account.update(feeVaultState, applyTokenUpdates([changes.fee], feeVaultState, 'add'), context),
-                context
-              )
-            : Promise.resolve(feeVaultState),
-          changes.gas
-            ? statedb.account.update(
-                gasVaultState.address,
-                account.update(gasVaultState, applyTokenUpdates([changes.gas], gasVaultState, 'add'), context),
-                context
-              )
-            : Promise.resolve(gasVaultState),
-        ]);
+        // to be called in later pipes
+        context.updateVaults = async function updateVaults() {
+          const [newFeeVaultState, newGasVaultState] = await Promise.all([
+            changes.fee
+              ? statedb.account.update(
+                  feeVaultState.address,
+                  account.update(feeVaultState, applyTokenUpdates([changes.fee], feeVaultState, 'add'), context),
+                  context
+                )
+              : Promise.resolve(feeVaultState),
+            changes.gas
+              ? statedb.account.update(
+                  gasVaultState.address,
+                  account.update(gasVaultState, applyTokenUpdates([changes.gas], gasVaultState, 'add'), context),
+                  context
+                )
+              : Promise.resolve(gasVaultState),
+          ]);
 
-        context.feeVaultState = newFeeVaultState;
-        context.gasVaultState = newGasVaultState;
+          context.feeVaultState = newFeeVaultState;
+          context.gasVaultState = newGasVaultState;
 
-        context.updatedAccounts = context.updatedAccounts || [];
-        if (changes.fee) {
-          context.updatedAccounts.push({
-            address: feeVaultState.address,
-            token: config.token.address,
-            delta: changes.fee.value,
-            action: 'fee',
-          });
-          if (attachSenderChanges) {
+          context.updatedAccounts = context.updatedAccounts || [];
+          if (changes.fee) {
             context.updatedAccounts.push({
-              address: senderState.address,
+              address: feeVaultState.address,
               token: config.token.address,
-              delta: `-${changes.fee.value}`,
+              delta: changes.fee.value,
               action: 'fee',
             });
+            if (attachSenderChanges) {
+              context.updatedAccounts.push({
+                address: senderState.address,
+                token: config.token.address,
+                delta: `-${changes.fee.value}`,
+                action: 'fee',
+              });
+            }
           }
-        }
-        if (changes.gas) {
-          context.updatedAccounts.push({
-            address: gasVaultState.address,
-            token: config.token.address,
-            delta: changes.gas.value,
-            action: 'gas',
-          });
-          if (attachSenderChanges) {
+          if (changes.gas) {
             context.updatedAccounts.push({
-              address: senderState.address,
+              address: gasVaultState.address,
               token: config.token.address,
-              delta: `-${changes.gas.value}`,
+              delta: changes.gas.value,
               action: 'gas',
             });
+            if (attachSenderChanges) {
+              context.updatedAccounts.push({
+                address: senderState.address,
+                token: config.token.address,
+                delta: `-${changes.gas.value}`,
+                action: 'gas',
+              });
+            }
           }
-        }
 
-        context.gasPaid = true;
-      };
-    } else {
+          context.gasPaid = true;
+        };
+      } else if (throwOnInsufficientFund) {
+        return next(
+          new Error(
+            'INSUFFICIENT_FUND',
+            `Insufficient fund to pay for tx cost from ${senderState.address}, expected ${expected}, got ${actual}`
+          )
+        );
+      }
+    }
+
+    if (!isGasCharged) {
       context.senderUpdates = {};
       context.senderChange = null;
       context.updateVaults = noop;

package/lib/protocols/account/migrate.js

@@ -48,7 +48,7 @@ runner.use(
     return { create: 1, update: getRelatedAddresses(context.senderState).length, payment: 0 };
   })
 );
-runner.use(EnsureTxCost({ attachSenderChanges: true }));
+runner.use(EnsureTxCost({ attachSenderChanges: true, throwOnInsufficientFund: false }));
 
 // Create account state, and update old accounts
 runner.use(

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.18.71",
+  "version": "1.18.73",
   "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.71",
-    "@arcblock/did-util": "1.18.71",
-    "@arcblock/jwt": "1.18.71",
-    "@arcblock/validator": "1.18.71",
-    "@ocap/asset": "1.18.71",
-    "@ocap/mcrypto": "1.18.71",
-    "@ocap/merkle-tree": "1.18.71",
-    "@ocap/message": "1.18.71",
-    "@ocap/state": "1.18.71",
-    "@ocap/tx-pipeline": "1.18.71",
-    "@ocap/util": "1.18.71",
-    "@ocap/wallet": "1.18.71",
+    "@arcblock/did": "1.18.73",
+    "@arcblock/did-util": "1.18.73",
+    "@arcblock/jwt": "1.18.73",
+    "@arcblock/validator": "1.18.73",
+    "@ocap/asset": "1.18.73",
+    "@ocap/mcrypto": "1.18.73",
+    "@ocap/merkle-tree": "1.18.73",
+    "@ocap/message": "1.18.73",
+    "@ocap/state": "1.18.73",
+    "@ocap/tx-pipeline": "1.18.73",
+    "@ocap/util": "1.18.73",
+    "@ocap/wallet": "1.18.73",
     "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": "dc8eb886b0ed25f35ac06971bdf4c87ad6a49186"
+  "gitHead": "d33cc33687903ca7d473547c04fe6c6363c60609"
 }