@ocap/tx-protocols 1.17.23 → 1.18.1

package/lib/util.js

@@ -1,7 +1,7 @@
 const groupBy = require('lodash/groupBy');
 const flattenDeep = require('lodash/flattenDeep');
 const { CustomError: Error } = require('@ocap/util/lib/error');
-const { BN } = require('@ocap/util');
+const { BN, fromTokenToUnit } = require('@ocap/util');
 const { decodeAny } = require('@ocap/message');
 const { toStakeAddress } = require('@arcblock/did-util');
 const cloneDeep = require('lodash/cloneDeep');
@@ -68,7 +68,7 @@ const applyTokenUpdates = (tokens, state, operator) => {
     const requirement = new BN(value);
     const balance = new BN(oldTokens[address] || 0);
     const newBalance = balance[operator](requirement);
-    if (newBalance.lt(ZERO)) {
+    if (newBalance.isNeg()) {
       throw new Error('NEGATIVE_TOKEN_BALANCE', `Negative token balance when applyTokenUpdates for ${address}`);
     }
     newTokens[address] = newBalance.toString(10);
@@ -104,13 +104,13 @@ const getTxFee = ({ amount, feeRate, maxFee, minFee, stringify = true }) => {
   if (feeRate < 0) {
     throw new Error('NEGATIVE_FEE_RATE', 'Unexpected negative feeRate when getTxFee, abort!');
   }
-  if (userAmount.lt(ZERO)) {
+  if (userAmount.isNeg()) {
     throw new Error('NEGATIVE_AMOUNT', 'Unexpected negative amount when getTxFee, abort!');
   }
-  if (maxFeeAmount.lt(ZERO)) {
+  if (maxFeeAmount.isNeg()) {
     throw new Error('NEGATIVE_MAX_FEE', 'Unexpected negative maxFee when getTxFee, abort!');
   }
-  if (minFeeAmount.lt(ZERO)) {
+  if (minFeeAmount.isNeg()) {
     throw new Error('NEGATIVE_MIN_FEE', 'Unexpected negative minFee when getTxFee, abort!');
   }
 
@@ -143,7 +143,7 @@ const getTxFee = ({ amount, feeRate, maxFee, minFee, stringify = true }) => {
 
 const splitTxFee = ({ total, shares = {}, stringify = true }) => {
   const totalAmount = new BN(total);
-  if (totalAmount.lt(ZERO)) {
+  if (totalAmount.isNeg()) {
     throw new Error('NEGATIVE_TOTAL_AMOUNT', 'Unexpected negative total when splitTxFee, abort!');
   }
   Object.keys(shares).forEach((key) => {
@@ -211,14 +211,14 @@ const ensureBlockReward = (rollupState, minReward, txStates) => {
 
     let actualFee = new BN(0);
     // If totalMissingFee is less than 0, then the tx will be charged for fixedFee
-    if (totalMissingFee.lt(ZERO)) {
+    if (totalMissingFee.isNeg()) {
       actualFee = defaults.reward;
     } else {
       // Else the tx is charged for a portion of totalMissingFee
       actualFee = totalMissingFee.mul(maxFee).div(totalDynamicFee);
     }
 
-    if (actualFee.lt(ZERO)) {
+    if (actualFee.isNeg()) {
       throw new Error('NEGATIVE_ACTUAL_FEE', 'Got negative actualFee for tx, abort!');
     }
 
@@ -313,6 +313,53 @@ const ensureBlockReward = (rollupState, minReward, txStates) => {
   return result;
 };
 
+const isGasStakeAddress = (sender, stakeId) => toStakeAddress(sender, sender) === stakeId;
+const isGasStakeInput = (inputs, token) => {
+  if (inputs.length !== 1) {
+    return false;
+  }
+
+  const [{ assetsList, tokensList }] = inputs;
+  if (assetsList.length > 0) {
+    return false;
+  }
+  if (tokensList.length !== 1) {
+    return false;
+  }
+
+  const [tokenInput] = tokensList;
+  if (tokenInput.address !== token) {
+    return false;
+  }
+
+  return true;
+};
+const isGasStakeValid = (state, config) => {
+  if (!state) {
+    return false;
+  }
+
+  const { token, transaction } = config;
+  const { minStake } = transaction.txGas;
+  const expectedMin = fromTokenToUnit(minStake, token.decimal);
+
+  if (state.tokens) {
+    const actualStaked = new BN(state.tokens[token.address] || 0);
+    if (actualStaked.gte(expectedMin)) {
+      return true;
+    }
+  }
+
+  if (state.revokedTokens) {
+    const actualRevoked = new BN(state.revokedTokens[token.address] || 0);
+    if (actualRevoked.gte(expectedMin)) {
+      return true;
+    }
+  }
+
+  return false;
+};
+
 module.exports = {
   decodeAnySafe,
   applyTokenUpdates,
@@ -324,5 +371,8 @@ module.exports = {
   ensureBlockReward,
   getBNSum,
   isFixedFee,
+  isGasStakeAddress,
+  isGasStakeInput,
+  isGasStakeValid,
   RATE_BASE,
 };

package/package.json

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

package/lib/protocols/rollup/pipes/ensure-service-fee.js

@@ -1,37 +0,0 @@
-const { CustomError: Error } = require('@ocap/util/lib/error');
-const { fromTokenToUnit, BN } = require('@ocap/util');
-
-const { applyTokenUpdates } = require('../../../util');
-
-module.exports = async (context, next) => {
-  const { config, statedb, txType, senderState } = context;
-  const txFee = config.transaction.txFee[txType];
-  const vaultState = await statedb.account.get(config.vaults.txFee, context);
-
-  if (!txFee) {
-    context.senderUpdates = {};
-    context.vaultUpdates = {};
-    context.vaultState = vaultState;
-    context.updatedAccounts = [];
-    return next();
-  }
-
-  const expected = fromTokenToUnit(txFee, config.token.decimal);
-  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 fee, expected ${txFee}`));
-  }
-
-  const tokenChange = { address: config.token.address, value: expected.toString(10) };
-
-  context.senderUpdates = applyTokenUpdates([tokenChange], senderState, 'sub');
-  context.vaultUpdates = applyTokenUpdates([tokenChange], vaultState, 'add');
-  context.vaultState = vaultState;
-
-  context.updatedAccounts = [
-    { address: senderState.address, token: config.token.address, delta: `-${tokenChange.value}`, action: 'fee' },
-    { address: vaultState.address, token: config.token.address, delta: tokenChange.value, action: 'fee' },
-  ];
-
-  return next();
-};