@ocap/tx-protocols 1.19.14 → 1.19.16

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2018-2019 ArcBlock
+Copyright 2018-2025 ArcBlock
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

package/lib/execute.js

@@ -2,7 +2,6 @@
 const { promisify } = require('util');
 const get = require('lodash/get');
 const pick = require('lodash/pick');
-const omit = require('lodash/omit');
 const camelCase = require('lodash/camelCase');
 const { CustomError: Error } = require('@ocap/util/lib/error');
 const { Runner, pipes } = require('@ocap/tx-pipeline');
@@ -132,49 +131,76 @@ module.exports = ({ filter, runAsLambda }) => {
     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);
+      const startTime = Date.now();
+
+      await runAsLambda(async (txn) => {
+        runCount += 1;
+
+        // 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 });
+
+        try {
+          await execute(ctx, protocols, true);
+        } catch (err) {
+          if (runCount <= retryLimit && shouldRetry(err)) {
+            // throw the error to retry
+            throw err;
+          }
+          error = err;
+        }
 
-      try {
-        await runAsLambda((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 });
-          return execute(ctx, protocols, true);
-        });
-      } catch (err) {
-        error = err;
-      } finally {
-        if (shouldPersistTx(error)) {
-          try {
-            let txState = context.states.tx.create(ctx, error ? error.code || 'INTERNAL' : 'OK');
-            flushEvents(ctx, { txState });
-            await runAsLambda(async (txn) => {
-              ctx = { ...omit(ctx, ['txn']), txn };
-              if (error) {
-                await ensureGasFeePaid(ctx);
-                // Recreate tx to pick up gas related fields
-                txState = context.states.tx.create(ctx, error ? error.code || 'INTERNAL' : 'OK');
-              }
-              await context.statedb.tx.create(txState.hash, txState, ctx);
-            });
-            flushEvents(ctx, { txState });
-            ctx?.logger?.info('Tx finalized', {
-              txHash: ctx.txHash,
-              txStatus: error ? error.code || 'INTERNAL' : 'OK',
-              txState,
-              error,
-            });
-          } catch (err) {
-            const txState = context.states.tx.create(ctx, error ? error.code || 'INTERNAL' : 'OK', false);
-            ctx?.logger?.error('Failed to save invalid transaction to statedb', {
-              error: err,
-              txHash: ctx.txHash,
-              txState,
-            });
+        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);
           }
-        } else {
-          ctx?.logger?.error('Failed to execute transaction', { error, txHash: ctx.txHash });
+
+          await context.statedb.tx.create(txState.hash, txState, ctx);
+          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;
+          }
+
+          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;

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, fromUnitToToken } = require('@ocap/util');
+const { fromTokenToUnit, BN, fromUnitToToken, hexToNumber } = require('@ocap/util');
 const JWT = require('@arcblock/jwt');
 const { account } = require('@ocap/state');
 const { toAddress } = require('@arcblock/did');
@@ -71,6 +71,17 @@ module.exports = function CreateEnsureTxCostPipe({
       context.gasVaultChange = changes.gas;
     }
 
+    // pick fee vault
+    if (changes.fee) {
+      if (config.vaults.txFees?.length) {
+        const feeIndex = hexToNumber(txHash.slice(-8)) % config.vaults.txFees.length;
+        const feeVault = config.vaults.txFees[feeIndex];
+        context.feeVault = feeVault;
+      } else {
+        context.feeVault = config.vaults.txFee;
+      }
+    }
+
     let isCostCharged = false;
     if (senderState && txCost.gt(ZERO)) {
       const expected = new BN(gasEstimate.payment || 0).add(txCost);
@@ -96,8 +107,8 @@ module.exports = function CreateEnsureTxCostPipe({
         // to be called in later pipes
         context.updateVaults = async function updateVaults() {
           const [feeVaultState, gasVaultState] = await Promise.all([
-            statedb.account.get(config.vaults.txFee, context),
-            statedb.account.get(gasVault, context),
+            changes.fee ? statedb.account.get(context.feeVault, context) : null,
+            changes.gas ? statedb.account.get(gasVault, context) : null,
           ]);
 
           const [newFeeVaultState, newGasVaultState] = await Promise.all([
@@ -107,18 +118,18 @@ module.exports = function CreateEnsureTxCostPipe({
                   account.update(feeVaultState, applyTokenUpdates([changes.fee], feeVaultState, 'add'), context),
                   context
                 )
-              : Promise.resolve(feeVaultState),
+              : null,
             changes.gas
               ? statedb.account.update(
                   gasVaultState.address,
                   account.update(gasVaultState, applyTokenUpdates([changes.gas], gasVaultState, 'add'), context),
                   context
                 )
-              : Promise.resolve(gasVaultState),
+              : null,
           ]);
 
-          context.feeVaultState = newFeeVaultState;
-          context.gasVaultState = newGasVaultState;
+          if (newFeeVaultState) context.feeVaultState = newFeeVaultState;
+          if (newGasVaultState) context.gasVaultState = newGasVaultState;
 
           context.updatedAccounts = context.updatedAccounts || [];
           if (changes.fee) {

package/lib/pipes/ensure-gas.js

@@ -27,8 +27,8 @@ module.exports = function CreateGasEnsureFn(estimateTxGas) {
 
     // gas receiver address
     const { txGas: gasVaults } = config.vaults;
-    const index = hexToNumber(txHash.slice(txHash.length - 4)) % gasVaults.length;
-    const gasVault = gasVaults[index];
+    const gasIndex = hexToNumber(txHash.slice(-8)) % gasVaults.length;
+    const gasVault = gasVaults[gasIndex];
     context.gasVault = gasVault;
 
     debug({

package/lib/protocols/asset/pipes/exec-mint-hook.js

@@ -34,6 +34,7 @@ module.exports = async (context, next) => {
           txn: context.txn,
           txTime: context.txTime,
           txHash: context.txHash,
+          logger: context.logger,
           args: x.args,
         });
 

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

@@ -6,9 +6,7 @@ const { Joi, schemas } = require('@arcblock/validator');
 const { BN } = require('@ocap/util');
 const { Runner, pipes } = require('@ocap/tx-pipeline');
 const { account, delegation } = require('@ocap/state');
-
-// eslint-disable-next-line global-require
-const debug = require('debug')(`${require('../../../package.json').name}:transfer-v2`);
+const { toStakeAddress } = require('@arcblock/did-util');
 
 const EnsureTxGas = require('../../pipes/ensure-gas');
 const EnsureTxCost = require('../../pipes/ensure-cost');
@@ -82,7 +80,38 @@ runner.use((context, next) => {
   next();
 });
 
-runner.use(pipes.ExtractState({ from: 'tx.from', to: 'senderState', status: 'INVALID_SENDER_STATE', table: 'account' })); // prettier-ignore
+runner.use(
+  EnsureTxGas((context) => {
+    // FIXME: payment check
+    const result = { create: 0, update: 2, payment: 0 };
+    result.update += context.assetStates?.length || 0;
+
+    if (context.receiverState) {
+      result.update += 1;
+    } else {
+      result.create += 1;
+    }
+
+    return result;
+  })
+);
+
+// Pre-query states to cache them for later use
+runner.use(async (context, next) => {
+  const { statedb, tx, gasVault } = context;
+  const accounts = [tx.from, context.receiver, gasVault].filter(Boolean);
+
+  await Promise.all([
+    ...accounts.map((x) => statedb.account.get(x, context)),
+    statedb.stake.get(toStakeAddress(tx.from, tx.from), context),
+  ]);
+
+  next();
+});
+
+runner.use(
+  pipes.ExtractState({ from: 'tx.from', to: 'senderState', status: 'INVALID_SENDER_STATE', table: 'account' })
+);
 runner.use(pipes.VerifyAccountMigration({ stateKey: 'senderState', addressKey: 'tx.from' }));
 
 runner.use(pipes.ExtractState({ from: 'tokenAddress', to: 'tokenStates', status: 'INVALID_TOKEN', table: 'token' }));
@@ -119,21 +148,6 @@ runner.use(pipes.VerifyTransferrable({ assets: 'assetStates' }));
 runner.use(pipes.VerifyUpdater({ assetKey: 'assetStates', ownerKey: 'senderState' }));
 
 // Ensure tx fee and gas
-runner.use(
-  EnsureTxGas((context) => {
-    // FIXME: payment check
-    const result = { create: 0, update: 2, payment: 0 };
-    result.update += context.assetStates?.length || 0;
-
-    if (context.receiverState) {
-      result.update += 1;
-    } else {
-      result.create += 1;
-    }
-
-    return result;
-  })
-);
 runner.use(EnsureTxCost({ attachSenderChanges: true }));
 
 // transfer assets to new owner
@@ -152,7 +166,6 @@ runner.use(
   async (context, next) => {
     const {
       tx,
-      itx,
       tokens,
       senderState,
       receiverAddr,
@@ -196,13 +209,11 @@ runner.use(
         : delegationState,
     ]);
 
-    await updateVaults();
-
     context.senderState = newSenderState;
     context.receiverState = newReceiverState;
     context.delegationState = newDelegationState;
 
-    debug('transfer-v2', { from: tx.from, to: itx.to, tokens });
+    await updateVaults();
 
     next();
   },

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.19.14",
+  "version": "1.19.16",
   "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.19.14",
-    "@arcblock/did-util": "1.19.14",
-    "@arcblock/jwt": "1.19.14",
-    "@arcblock/validator": "1.19.14",
-    "@ocap/asset": "1.19.14",
-    "@ocap/mcrypto": "1.19.14",
-    "@ocap/merkle-tree": "1.19.14",
-    "@ocap/message": "1.19.14",
-    "@ocap/state": "1.19.14",
-    "@ocap/tx-pipeline": "1.19.14",
-    "@ocap/util": "1.19.14",
-    "@ocap/wallet": "1.19.14",
+    "@arcblock/did": "1.19.16",
+    "@arcblock/did-util": "1.19.16",
+    "@arcblock/jwt": "1.19.16",
+    "@arcblock/validator": "1.19.16",
+    "@ocap/asset": "1.19.16",
+    "@ocap/mcrypto": "1.19.16",
+    "@ocap/merkle-tree": "1.19.16",
+    "@ocap/message": "1.19.16",
+    "@ocap/state": "1.19.16",
+    "@ocap/tx-pipeline": "1.19.16",
+    "@ocap/util": "1.19.16",
+    "@ocap/wallet": "1.19.16",
     "debug": "^4.3.6",
     "deep-diff": "^1.0.2",
     "empty-value": "^1.0.1",
@@ -40,12 +40,12 @@
     "url-join": "^4.0.1"
   },
   "resolutions": {
-    "bn.js": "5.1.3",
+    "bn.js": "5.2.1",
     "elliptic": "6.5.3"
   },
   "devDependencies": {
     "jest": "^29.7.0",
     "start-server-and-test": "^1.14.0"
   },
-  "gitHead": "97e9e70872b2b6c46bdda5d4f4bce8a890d4bd63"
+  "gitHead": "9c3c349e48fc3c5a63aba6068ba5d31cc46d81c9"
 }