@ocap/tx-protocols 1.18.21 → 1.18.23

package/lib/execute.js

@@ -1,4 +1,5 @@
 /* eslint-disable consistent-return */
+const { promisify } = require('util');
 const get = require('lodash/get');
 const pick = require('lodash/pick');
 const omit = require('lodash/omit');
@@ -6,6 +7,12 @@ const camelCase = require('lodash/camelCase');
 const { CustomError: Error } = require('@ocap/util/lib/error');
 const { Runner, pipes } = require('@ocap/tx-pipeline');
 
+const createEnsureGasFn = require('./pipes/ensure-gas');
+const createEnsureCostFn = require('./pipes/ensure-cost');
+
+const ensureTxGas = promisify(createEnsureGasFn(() => ({ create: 0, update: 2 })));
+const ensureTxCost = promisify(createEnsureCostFn({ attachSenderChanges: true, gasOnly: true }));
+
 const getTxName = (typeUrl) => camelCase(typeUrl.split(':').pop());
 
 const flushEvents = (context, extra = {}) => {
@@ -16,6 +23,7 @@ const flushEvents = (context, extra = {}) => {
 };
 
 const shouldPersistTx = (err) => !err || get(err, 'props.persist');
+const logError = (...args) => process.env.NODE_ENV !== 'test' && console.error(...args);
 
 module.exports = ({ filter, runAsLambda }) => {
   // pipeline before executing the transaction
@@ -41,13 +49,33 @@ module.exports = ({ filter, runAsLambda }) => {
   pre.use(pipes.VerifyTxSize);
   pre.use(pipes.VerifySignature);
 
+  // charge gas fee for errored tx
+  const ensureGasFeePaid = async (context) => {
+    try {
+      await ensureTxGas(context);
+      await ensureTxCost(context);
+
+      const { tx, statedb, senderState, senderUpdates, updateVaults } = context;
+
+      await Promise.all([
+        statedb.account.update(
+          senderState.address,
+          context.states.account.update(senderState, { nonce: tx.nonce, pk: tx.pk, ...senderUpdates }, context),
+          context
+        ),
+
+        updateVaults(),
+      ]);
+    } catch (err) {
+      logError('Failed to charge gas fee for errored tx', err);
+    }
+  };
+
   const execute = async (context, protocols, isRetrySupported = false) =>
     new Promise((resolve, reject) => {
       pre.run(context, (err) => {
         if (err) {
-          if (process.env.NODE_ENV !== 'test') {
-            console.error('Failed to prepare transaction', err);
-          }
+          logError('Failed to prepare transaction', err);
           return reject(err);
         }
 
@@ -62,12 +90,16 @@ module.exports = ({ filter, runAsLambda }) => {
           // we should only flush events when retry is not supported
           // otherwise the outer caller should handle these 2
           if (shouldPersistTx(err) && isRetrySupported === false) {
+            if (err) {
+              await ensureGasFeePaid(context);
+            }
+
             let txState;
             try {
               txState = context.states.tx.create(context, err ? err.code || 'INTERNAL' : 'OK');
               await context.statedb.tx.create(txState.hash, txState, context);
             } catch (e) {
-              console.error('Failed to save transaction to statedb', e);
+              logError('Failed to save transaction to statedb', e);
               return reject(e);
             }
 
@@ -76,7 +108,7 @@ module.exports = ({ filter, runAsLambda }) => {
 
           // after executing the transaction
           if (err) {
-            // console.error('Failed to execute transaction', err);
+            logError('Failed to execute transaction', err);
             return reject(err);
           }
 
@@ -102,15 +134,20 @@ module.exports = ({ filter, runAsLambda }) => {
       } finally {
         if (shouldPersistTx(error)) {
           try {
-            const txState = context.states.tx.create(ctx, error ? error.code || 'INTERNAL' : 'OK');
+            let txState = context.states.tx.create(ctx, error ? error.code || 'INTERNAL' : 'OK');
             flushEvents(ctx, { txState });
             await runAsLambda(async (txn) => {
               const newCtx = { ...omit(ctx, ['txn']), txn };
+              if (error) {
+                await ensureGasFeePaid(newCtx);
+                // Recreate tx to pick up gas related fields
+                txState = context.states.tx.create(newCtx, error ? error.code || 'INTERNAL' : 'OK');
+              }
               await context.statedb.tx.create(txState.hash, txState, newCtx);
               flushEvents(newCtx, { txState });
             });
           } catch (err) {
-            console.error('failed to save invalid transaction to statedb', err);
+            logError('failed to save invalid transaction to statedb', err);
           }
         }
       }

package/lib/pipes/ensure-cost.js

@@ -15,7 +15,7 @@ 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 } = {}) {
+module.exports = function CreateEnsureTxCostPipe({ attachSenderChanges = true, 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;
@@ -25,7 +25,7 @@ module.exports = function CreateEnsureTxCostPipe({ attachSenderChanges = true }
     const changes = {};
     let txCost = new BN(0);
     const txFee = config.transaction.txFee[txType];
-    if (txFee) {
+    if (!gasOnly && txFee) {
       const totalFee = fromTokenToUnit(txFee, config.token.decimal);
       txCost = txCost.add(totalFee);
       changes.fee = { address: config.token.address, value: totalFee.toString(10) };
@@ -145,6 +145,8 @@ module.exports = function CreateEnsureTxCostPipe({ attachSenderChanges = true }
             });
           }
         }
+
+        context.gasPaid = true;
       };
     } else {
       context.senderUpdates = {};

package/lib/protocols/token/create.js

@@ -79,20 +79,23 @@ runner.use(
   ])
 );
 
-// Ensure uniq ness of token symbol
-runner.use(async (context, next) => {
-  const { symbol } = context.config.token;
-  if (symbol.toLowerCase() === context.itx.symbol.toLowerCase()) {
-    return next(new Error('DUPLICATE_SYMBOL', `Token symbol can not be ${symbol}`));
-  }
+// Ensure uniqueness of token symbol
+runner.use(
+  async function EnsureTokenSymbol(context, next) {
+    const { symbol } = context.config.token;
+    if (symbol.toLowerCase() === context.itx.symbol.toLowerCase()) {
+      return next(new Error('DUPLICATE_SYMBOL', `Token symbol can not be ${symbol}`));
+    }
 
-  const exist = await context.statedb.token.existBySymbol(context.itx.symbol, context);
-  if (exist) {
-    return next(new Error('DUPLICATE_SYMBOL', 'Token symbol already exists'));
-  }
+    const exist = await context.statedb.token.existBySymbol(context.itx.symbol, context);
+    if (exist) {
+      return next(new Error('DUPLICATE_SYMBOL', 'Token symbol already exists'));
+    }
 
-  return next();
-});
+    return next();
+  },
+  { persistError: true }
+);
 
 // Ensure tx fee and gas
 runner.use(

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.18.21",
+  "version": "1.18.23",
   "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.21",
-    "@arcblock/did-util": "1.18.21",
-    "@arcblock/jwt": "1.18.21",
-    "@arcblock/validator": "1.18.21",
-    "@ocap/asset": "1.18.21",
-    "@ocap/mcrypto": "1.18.21",
-    "@ocap/merkle-tree": "1.18.21",
-    "@ocap/message": "1.18.21",
-    "@ocap/state": "1.18.21",
-    "@ocap/tx-pipeline": "1.18.21",
-    "@ocap/util": "1.18.21",
-    "@ocap/wallet": "1.18.21",
+    "@arcblock/did": "1.18.23",
+    "@arcblock/did-util": "1.18.23",
+    "@arcblock/jwt": "1.18.23",
+    "@arcblock/validator": "1.18.23",
+    "@ocap/asset": "1.18.23",
+    "@ocap/mcrypto": "1.18.23",
+    "@ocap/merkle-tree": "1.18.23",
+    "@ocap/message": "1.18.23",
+    "@ocap/state": "1.18.23",
+    "@ocap/tx-pipeline": "1.18.23",
+    "@ocap/util": "1.18.23",
+    "@ocap/wallet": "1.18.23",
     "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": "be5df6f70d48c8c5026cd7bb42d53b270ddeb344"
+  "gitHead": "bb57afdd756f4a9608e53e40c91060c32b97f2f8"
 }