@ocap/tx-protocols 1.20.1 → 1.20.3

package/README.md

@@ -5,7 +5,7 @@ Defines the interface of OCAP query resolver.
 ## Usage
 
 ```shell
-yarn add @ocap/tx-pipeline
+pnpm install @ocap/tx-pipeline
 ```
 
 Then:

package/lib/execute.js

@@ -1,7 +1,7 @@
 /* eslint-disable consistent-return */
-const { promisify } = require('util');
 const get = require('lodash/get');
 const pick = require('lodash/pick');
+const merge = require('lodash/merge');
 const camelCase = require('lodash/camelCase');
 const { CustomError: Error } = require('@ocap/util/lib/error');
 const { Runner, pipes } = require('@ocap/tx-pipeline');
@@ -9,9 +9,8 @@ const { Runner, pipes } = require('@ocap/tx-pipeline');
 const createEnsureGasFn = require('./pipes/ensure-gas');
 const createEnsureCostFn = require('./pipes/ensure-cost');
 
-// FIXME: DeprecationWarning: Calling promisify on a function that returns a Promise is likely a mistake.
-const ensureTxGas = promisify(createEnsureGasFn(() => ({ create: 0, update: 2 })));
-const ensureTxCost = promisify(createEnsureCostFn({ attachSenderChanges: true, gasOnly: true }));
+const ensureTxGas = createEnsureGasFn(() => ({ create: 0, update: 2 }));
+const ensureTxCost = createEnsureCostFn({ attachSenderChanges: true, gasOnly: true });
 
 const getTxName = (typeUrl) => camelCase(typeUrl.split(':').pop());
 
@@ -50,24 +49,45 @@ module.exports = ({ filter, runAsLambda }) => {
   pre.use(pipes.VerifySignature);
 
   // charge gas fee for errored tx
-  const ensureGasFeePaid = async (context) => {
-    try {
-      await ensureTxGas(context);
-      await ensureTxCost(context);
+  const ensureGasFeePaid = (context) => {
+    const gasRunner = new Runner();
+
+    gasRunner.use(ensureTxGas);
+    gasRunner.use(ensureTxCost);
+    gasRunner.use(async (ctx, next) => {
+      const { tx, statedb, senderUpdates, updateVaults } = ctx;
+
+      // If senderState does not exist and there is no stakeId for gas, an error will be thrown in ensureTxCost before here.
+      // So if there is no senderState here, it means there has a stake for gas, so allowed to continue.
+      if (ctx.senderState) {
+        const senderState = ctx.stateSnapshot?.[ctx.senderState.address] || ctx.senderState;
+        await statedb.account.update(
+          senderState.address,
+          ctx.states.account.update(senderState, { nonce: tx.nonce, pk: tx.pk, ...senderUpdates }, ctx),
+          ctx
+        );
+        await updateVaults();
+      }
 
-      const { tx, statedb, senderState, senderUpdates, updateVaults } = context;
+      return next();
+    });
 
-      await Promise.all([
-        statedb.account.update(
-          senderState.address,
-          context.states.account.update(senderState, { nonce: tx.nonce, pk: tx.pk, ...senderUpdates }, context),
-          context
-        ),
-      ]);
-      await updateVaults();
-    } catch (err) {
-      context.logger?.error('Failed to charge gas fee for errored tx', { error: err, txHash: context.txHash });
-    }
+    return new Promise((resolve, reject) => {
+      gasRunner.run(context, (err) => {
+        if (err) {
+          context.logger?.error('Failed to charge gas fee for errored tx', {
+            error: err,
+            tx: context.tx,
+            txBase64: context.txBase64,
+            txHash: context.txHash,
+          });
+          reject(err);
+          return;
+        }
+
+        resolve();
+      });
+    });
   };
 
   // eslint-disable-next-line require-await
@@ -86,124 +106,131 @@ module.exports = ({ filter, runAsLambda }) => {
         }
 
         // eslint-disable-next-line no-shadow
-        protocol.run(context, async (err) => {
-          // 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);
+        protocol.run(context, async (error) => {
+          if (isRetrySupported) {
+            if (error) {
+              return reject(error);
             }
+            return resolve(context);
+          }
+
+          const txStatus = error ? error.code || 'INTERNAL' : 'OK';
+          let txState = context.states.tx.create(context, txStatus);
 
-            let txState;
+          if (shouldPersistTx(error)) {
             try {
-              txState = context.states.tx.create(context, err ? err.code || 'INTERNAL' : 'OK');
+              if (error) {
+                await ensureGasFeePaid(context);
+                // Recreate tx to pick up gas related fields
+                txState = context.states.tx.create(context, txStatus);
+              }
+
               await context.statedb.tx.create(txState.hash, txState, context);
-              context.logger?.info('Tx finalized', {
-                txHash: context.txHash,
-                txStatus: err ? err.code || 'INTERNAL' : 'OK',
-                txState,
-                error: err,
-              });
+              flushEvents(context, { txState });
             } catch (e) {
-              context.logger?.error('Failed to save invalid transaction to statedb', {
+              context.logger?.error('Failed to save transaction to statedb', {
                 error: e,
+                txError: error,
                 txHash: context.txHash,
                 txState,
               });
-              return reject(e);
+              // If we get an internal error here, should return the original tx error to client
+              return reject(error);
             }
-
-            flushEvents(context, { txState });
           }
 
-          // after executing the transaction
-          if (err) {
-            context.logger?.error('Failed to execute transaction', { error: err, txHash: context.txHash });
-            return reject(err);
-          }
+          context.logger?.info('Tx finalized', {
+            txHash: context.txHash,
+            txStatus,
+            txState,
+            error,
+          });
 
-          resolve(context);
+          if (error) {
+            return reject(error);
+          }
+          return resolve(context);
         });
       });
     });
 
   if (typeof runAsLambda === 'function') {
     return async (context, protocols) => {
-      let ctx = null;
-      let error = null;
-      let runCount = 0;
-      const retryLimit = context.statedb?.config?.retryLimit || 0;
-      const shouldRetry = context.statedb?.config?.shouldRetry || (() => false);
+      let ctx = context;
       const startTime = Date.now();
 
-      await runAsLambda(async (txn) => {
-        runCount += 1;
+      try {
+        const txState = await runAsLambda(
+          async (txn) => {
+            // create a new context each time in case we are retrying
+            ctx = pick(context, ['txBase64', 'statedb', 'indexdb', 'config', 'states', 'filter', 'extra', 'logger']);
+            ctx.txn = txn;
 
-        // create a new context each time in case we are retrying
-        ctx = pick(context, ['txBase64', 'statedb', 'indexdb', 'config', 'states', 'filter', 'extra', 'logger']);
-        Object.defineProperty(ctx, 'txn', { value: txn });
+            await execute(ctx, protocols, true);
 
-        try {
-          await execute(ctx, protocols, true);
-        } catch (err) {
-          if (runCount <= retryLimit && shouldRetry(err)) {
-            // throw the error to retry
-            throw err;
-          }
-          error = err;
-        }
+            const state = context.states.tx.create(ctx, 'OK');
+            await context.statedb.tx.create(state.hash, state, ctx);
 
-        if (error && !shouldPersistTx(error)) {
-          ctx.logger?.error('Failed to execute transaction', { error, txHash: ctx.txHash });
-          // throw the error to the abort transaction
-          throw error;
-        }
-
-        // create tx
-        const txStatus = error ? error.code || 'INTERNAL' : 'OK';
-        try {
-          let txState = context.states.tx.create(ctx, txStatus);
-          flushEvents(ctx, { txState });
-
-          if (error) {
-            await ensureGasFeePaid(ctx);
-            // Recreate tx to pick up gas related fields
-            txState = context.states.tx.create(ctx, txStatus);
-          }
+            return state;
+          },
+          { cleanWorkingSet: true, verifyHash: true }
+        );
 
-          await context.statedb.tx.create(txState.hash, txState, ctx);
-          flushEvents(ctx, { txState });
+        // update indexdb after statedb commit
+        flushEvents(ctx, { txState });
 
-          ctx.logger?.info('Tx finalized', {
-            txHash: ctx.txHash,
-            txStatus,
-            txState,
-            error,
-            runCount,
-            duration: Date.now() - startTime,
-          });
-        } catch (err) {
-          if (runCount <= retryLimit && shouldRetry(err)) {
-            // throw error to retry
-            throw err;
+        ctx.logger?.info('Tx finalized', {
+          txHash: ctx.txHash,
+          txState,
+          txStatus: 'OK',
+          duration: Date.now() - startTime,
+        });
+      } catch (error) {
+        const txStatus = error.code || 'INTERNAL';
+        let txState = ctx.tx ? context.states.tx.create(ctx, txStatus, false) : null;
+
+        ctx.logger?.error('Failed to execute transaction', { error, txHash: ctx.txHash, txState });
+
+        if (txState && shouldPersistTx(error)) {
+          try {
+            txState = await runAsLambda(async (txn) => {
+              ctx = Object.assign({}, ctx, { txn, cacheStates: null });
+
+              await ensureGasFeePaid(ctx);
+
+              // Recreate tx to pick up gas related fields
+              const state = context.states.tx.create(ctx, txStatus);
+              await ctx.statedb.tx.create(state.hash, state, ctx);
+
+              return state;
+            });
+
+            // update indexdb after statedb commit
+            flushEvents(ctx, { txState });
+
+            ctx.logger?.info('Tx finalized', {
+              txHash: ctx.txHash,
+              txState,
+              txStatus,
+              error,
+              duration: Date.now() - startTime,
+            });
+          } catch (err) {
+            ctx.logger?.error('Failed to save invalid transaction to statedb', {
+              error: err,
+              txError: error,
+              txHash: ctx.txHash,
+              txState,
+            });
+            // If we get an error here, should return the original tx error to client
+            throw error;
           }
-
-          const txState = context.states.tx.create(ctx, txStatus, false);
-          ctx.logger?.error('Failed to save invalid transaction to statedb', {
-            error: err,
-            protocolError: error,
-            txHash: ctx.txHash,
-            txState,
-            duration: Date.now() - startTime,
-          });
-
-          // throw error to abort transaction
-          throw err;
         }
-      });
 
-      if (error) {
         throw error;
+      } finally {
+        // Merge new ctx to original context
+        merge(context, ctx);
       }
 
       return ctx;

package/lib/pipes/ensure-cost.js

@@ -24,7 +24,7 @@ module.exports = function CreateEnsureTxCostPipe({
 } = {}) {
   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, gasVault, totalGas } = context;
+    const { config, statedb, txType, senderState, gasEstimate, totalGas } = context;
 
     // verify gas staking headers
     const { tx, extra = {}, txHash } = context;
@@ -83,11 +83,11 @@ module.exports = function CreateEnsureTxCostPipe({
     }
 
     let isCostCharged = false;
-    if (senderState && txCost.gt(ZERO)) {
+    if (txCost.gt(ZERO)) {
       const expected = new BN(gasEstimate.payment || 0).add(txCost);
-      const actual = new BN(senderState.tokens[config.token.address] || 0);
+      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)) {
+      if (senderState && actual.gte(expected)) {
         isCostCharged = true;
 
         // to be merged into later pipe
@@ -108,7 +108,7 @@ module.exports = function CreateEnsureTxCostPipe({
         context.updateVaults = async function updateVaults() {
           const [feeVaultState, gasVaultState] = await Promise.all([
             changes.fee ? statedb.account.get(context.feeVault, context) : null,
-            changes.gas ? statedb.account.get(gasVault, context) : null,
+            changes.gas ? statedb.account.get(context.gasVault, context) : null,
           ]);
 
           const [newFeeVaultState, newGasVaultState] = await Promise.all([
@@ -167,11 +167,13 @@ module.exports = function CreateEnsureTxCostPipe({
 
           context.gasPaid = true;
         };
+      } else if (!senderState) {
+        return next(new Error('INVALID_GAS_PAYER', `Gas payer ${tx.from} does not exist on chain`));
       } else if (throwOnInsufficientFund) {
         return next(
           new Error(
             'INSUFFICIENT_FUND',
-            `Insufficient fund to pay for tx cost from ${senderState.address}, expected ${fromUnitToToken(
+            `Insufficient fund to pay for tx cost from ${senderState?.address || tx.from}, expected ${fromUnitToToken(
               expected,
               config.token.decimal
             )}, got ${fromUnitToToken(actual, config.token.decimal)}`

package/lib/protocols/account/migrate.js

@@ -69,7 +69,6 @@ runner.use(
   })
 );
 runner.use(EnsureTxCost({ attachSenderChanges: true, throwOnInsufficientFund: false }));
-runner.use(pipes.VerifyGasPayer());
 
 // Save context snapshot before updating states
 runner.use(pipes.TakeStateSnapshot());

package/lib/protocols/governance/stake.js

@@ -178,7 +178,6 @@ runner.use(
   })
 );
 runner.use(EnsureTxCost({ attachSenderChanges: true }));
-runner.use(pipes.VerifyGasPayer());
 
 // Save context snapshot before updating states
 runner.use(pipes.TakeStateSnapshot());

package/package.json

@@ -3,41 +3,36 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.20.1",
+  "version": "1.20.3",
   "description": "Predefined tx pipeline sets to execute certain type of transactions",
   "main": "lib/index.js",
   "files": [
     "lib"
   ],
-  "scripts": {
-    "lint": "eslint tests lib",
-    "lint:fix": "eslint --fix tests lib",
-    "start": "node tools/start-chain.js",
-    "test": "jest --forceExit --detectOpenHandles",
-    "test:ci": "jest --forceExit --detectOpenHandles --coverage",
-    "coverage": "start-server-and-test start http://127.0.0.1:4001 test:ci"
-  },
   "keywords": [],
   "author": "wangshijun <wangshijun2010@gmail.com> (http://github.com/wangshijun)",
   "license": "MIT",
   "dependencies": {
-    "@arcblock/did": "1.20.1",
-    "@arcblock/did-util": "1.20.1",
-    "@arcblock/jwt": "1.20.1",
-    "@arcblock/validator": "1.20.1",
-    "@ocap/asset": "1.20.1",
-    "@ocap/mcrypto": "1.20.1",
-    "@ocap/merkle-tree": "1.20.1",
-    "@ocap/message": "1.20.1",
-    "@ocap/state": "1.20.1",
-    "@ocap/tx-pipeline": "1.20.1",
-    "@ocap/util": "1.20.1",
-    "@ocap/wallet": "1.20.1",
     "debug": "^4.3.6",
     "deep-diff": "^1.0.2",
     "empty-value": "^1.0.1",
     "lodash": "^4.17.21",
-    "url-join": "^4.0.1"
+    "url-join": "^4.0.1",
+    "@arcblock/did": "1.20.3",
+    "@arcblock/did-util": "1.20.3",
+    "@arcblock/jwt": "1.20.3",
+    "@arcblock/validator": "1.20.3",
+    "@ocap/asset": "1.20.3",
+    "@ocap/mcrypto": "1.20.3",
+    "@ocap/merkle-tree": "1.20.3",
+    "@ocap/message": "1.20.3",
+    "@ocap/state": "1.20.3",
+    "@ocap/util": "1.20.3",
+    "@ocap/wallet": "1.20.3",
+    "@ocap/tx-pipeline": "1.20.3",
+    "@ocap/e2e-test": "1.20.3",
+    "@ocap/client": "1.20.3",
+    "@ocap/statedb-memory": "1.20.3"
   },
   "resolutions": {
     "bn.js": "5.2.1",
@@ -47,5 +42,12 @@
     "jest": "^29.7.0",
     "start-server-and-test": "^1.14.0"
   },
-  "gitHead": "f73bddbe4b86106fd348e43ce9e19a626acdc9f6"
-}
+  "scripts": {
+    "lint": "eslint tests lib",
+    "lint:fix": "eslint --fix tests lib",
+    "start": "node tools/start-chain.js",
+    "test": "jest --forceExit --detectOpenHandles",
+    "test:ci": "jest --forceExit --detectOpenHandles --coverage",
+    "coverage": "start-server-and-test start http://127.0.0.1:4001 test:ci"
+  }
+}