@ocap/tx-protocols 1.17.23 → 1.18.0

package/lib/pipes/ensure-cost.js

@@ -0,0 +1,116 @@
+const noop = require('lodash/noop');
+const { CustomError: Error } = require('@ocap/util/lib/error');
+const { fromTokenToUnit, BN } = require('@ocap/util');
+const { account } = require('@ocap/state');
+
+// eslint-disable-next-line global-require
+const debug = require('debug')(`${require('../../package.json').name}:pipes:ensure-cost`);
+
+const { applyTokenUpdates } = require('../util');
+
+// We have a layered transaction cost design
+// - 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 } = {}) {
+  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;
+    const feeVaultState = await statedb.account.get(config.vaults.txFee, context);
+
+    const changes = {};
+    let txCost = new BN(0);
+
+    const txFee = config.transaction.txFee[txType];
+    if (txFee) {
+      const totalFee = fromTokenToUnit(txFee, config.token.decimal);
+      txCost = txCost.add(totalFee);
+      changes.fee = { address: config.token.address, value: totalFee.toString(10) };
+      context.feeVaultChange = changes.fee;
+    }
+    if (totalGas.gt(new BN(0))) {
+      txCost = txCost.add(totalGas);
+      changes.gas = { address: config.token.address, value: totalGas.toString(10) };
+      context.gasVaultChange = changes.gas;
+    }
+
+    if (senderState) {
+      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}`
+          )
+        );
+      }
+
+      // 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)}`,
+        action: 'fee',
+      };
+
+      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),
+        ]);
+
+        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 (changes.gas) {
+          context.updatedAccounts.push({
+            address: gasVaultState.address,
+            token: config.token.address,
+            delta: changes.gas.value,
+            action: 'gas',
+          });
+        }
+        if (attachSenderChanges) {
+          context.updatedAccounts.push(context.senderChange);
+        }
+      };
+    } else {
+      context.senderUpdates = {};
+      context.senderChange = null;
+      context.updateVaults = noop;
+      context.updatedAccounts = [];
+    }
+
+    return next();
+  };
+};

package/lib/pipes/ensure-gas.js

@@ -0,0 +1,53 @@
+const { CustomError: Error } = require('@ocap/util/lib/error');
+const { BN, hexToNumber } = require('@ocap/util');
+
+// eslint-disable-next-line global-require
+const debug = require('debug')(`${require('../../package.json').name}:pipes:estimate-gas`);
+
+// Must be called after all state ready
+// Must be called before creating/updating any state
+// estimateTxGas should be a function that returns the following data:
+// - create: state creating ops
+// - update: state updating ops
+// - payment: sender payment amount of the gas token
+module.exports = function CreateGasEnsureFn(estimateTxGas) {
+  return async function EnsureTxGas(context, next) {
+    const { txHash, statedb, config } = context;
+
+    // total gas in native token
+    const { txGas } = config.transaction;
+    let totalGas = new BN(txGas.price * txGas.dataStorage * context.txSize);
+    const estimate = estimateTxGas(context);
+    totalGas = totalGas.add(new BN(txGas.price * txGas.createState * (estimate.create + 1))); // 1 = tx insert
+    totalGas = totalGas.add(new BN(txGas.price * txGas.updateState * estimate.update));
+
+    // gas receiver address
+    const { txGas: gasVaults } = config.vaults;
+    const index = hexToNumber(txHash.slice(txHash.length - 4)) % gasVaults.length;
+    const gasVault = gasVaults[index];
+
+    // extract gasReceiver
+    if (gasVault) {
+      const gasVaultState = await statedb.account.get(gasVault, context);
+      if (!gasVaultState) {
+        return next(new Error('INVALID_GAS_VAULT', `Can not find gas vault state: ${gasVault}`));
+      }
+
+      context.gasVaultState = gasVaultState;
+    }
+
+    debug({
+      txType: context.txType,
+      txHash: context.txHash,
+      txSize: context.txSize,
+      totalGas: totalGas.toString(10),
+      gasVault,
+      estimate,
+    });
+
+    context.totalGas = totalGas;
+    context.gasEstimate = estimate;
+
+    return next();
+  };
+};

package/lib/protocols/account/delegate.js

@@ -10,6 +10,9 @@ const { toDelegateAddress } = require('@arcblock/did-util');
 // eslint-disable-next-line global-require
 const debug = require('debug')(`${require('../../../package.json').name}:delegate`);
 
+const EnsureTxGas = require('../../pipes/ensure-gas');
+const EnsureTxCost = require('../../pipes/ensure-cost');
+
 const runner = new Runner();
 
 runner.use(pipes.VerifyMultiSig(0));
@@ -62,17 +65,39 @@ runner.use(
 );
 
 // Ensure sender/receiver exist
-runner.use(pipes.ExtractState({ from: 'tx.from', to: 'senderState', status: 'OK', table: 'account' }));
+runner.use(
+  pipes.ExtractState({ from: 'tx.from', to: 'senderState', status: 'INVALID_SENDER_STATE', table: 'account' })
+);
 runner.use(pipes.VerifyAccountMigration({ senderKey: 'senderState' }));
 runner.use(pipes.ExtractState({ from: 'itx.to', to: 'receiverState', status: 'OK', table: 'account' }));
 
 // Extract delegation
 runner.use(pipes.ExtractState({ from: 'itx.address', to: 'delegationState', table: 'delegation', status: 'OK' }));
 
+// Ensure tx fee and gas
+runner.use(
+  EnsureTxGas((context) => {
+    const result = { create: 0, update: 1, payment: 0 };
+    if (context.receiverState) {
+      result.update += 1;
+    } else {
+      result.create += 1;
+    }
+    if (context.delegationState) {
+      result.update += 1;
+    } else {
+      result.create += 1;
+    }
+
+    return result;
+  })
+);
+runner.use(EnsureTxCost({ attachSenderChanges: true }));
+
 // Create delegation state
 runner.use(
   async (context, next) => {
-    const { tx, itx, ops, statedb, senderState, receiverState, delegationState } = context;
+    const { tx, itx, ops, statedb, senderState, receiverState, delegationState, senderUpdates, updateVaults } = context;
 
     const opsObj = ops.reduce(
       (acc, x) => {
@@ -94,7 +119,7 @@ runner.use(
       // update sender
       statedb.account.updateOrCreate(
         senderState,
-        account.updateOrCreate(senderState, { address: sender, nonce: tx.nonce, pk: tx.pk }, context),
+        account.updateOrCreate(senderState, { ...senderUpdates, address: sender, nonce: tx.nonce, pk: tx.pk }, context),
         context
       ),
 
@@ -107,6 +132,8 @@ runner.use(
       delegationState
         ? statedb.delegation.update(itx.address, delegation.update(delegationState, { ...itx, ops: opsObj }, context), context) // prettier-ignore
         : statedb.delegation.create(itx.address, delegation.create({ ...itx, ops: opsObj }, context), context),
+
+      updateVaults(),
     ]);
 
     debug(delegationState ? 'update' : 'create', newDelegationState);

package/lib/protocols/account/migrate.js

@@ -8,6 +8,9 @@ const { account } = require('@ocap/state');
 // eslint-disable-next-line global-require
 const debug = require('debug')(`${require('../../../package.json').name}:migrate`);
 
+const EnsureTxGas = require('../../pipes/ensure-gas');
+const EnsureTxCost = require('../../pipes/ensure-cost');
+
 const runner = new Runner();
 
 runner.use(pipes.VerifyMultiSig(0));
@@ -39,10 +42,18 @@ runner.use(
 runner.use(pipes.ExtractState({ from: 'tx.from', to: 'senderState', status: 'INVALID_SENDER_STATE', table: 'account' })); // prettier-ignore
 runner.use(pipes.VerifyAccountMigration({ senderKey: 'senderState' }));
 
+// Ensure tx fee and gas
+runner.use(
+  EnsureTxGas((context) => {
+    return { create: 1, update: getRelatedAddresses(context.senderState).length, payment: 0 };
+  })
+);
+runner.use(EnsureTxCost({ attachSenderChanges: true }));
+
 // Create account state, and update old accounts
 runner.use(
   async (context, next) => {
-    const { tx, itx, statedb } = context;
+    const { tx, itx, statedb, senderUpdates, updateVaults } = context;
 
     const sender = context.senderState;
     const receiver = await statedb.account.get(itx.address, context);
@@ -58,6 +69,7 @@ runner.use(
       account.create(
         {
           ...sender, // copy all old account data to new account
+          ...senderUpdates,
           address: itx.address,
           pk: itx.pk,
           migratedFrom: [sender.address],
@@ -86,6 +98,8 @@ runner.use(
     );
     debug('old accounts', states);
 
+    await updateVaults();
+
     // Update context
     context.receiverState = newAccount;
     context.senderState = states.find((x) => x.address === sender.from);

package/lib/protocols/account/revoke-delegate.js

@@ -10,6 +10,9 @@ const { toDelegateAddress } = require('@arcblock/did-util');
 // eslint-disable-next-line global-require
 const debug = require('debug')(`${require('../../../package.json').name}:delegate`);
 
+const EnsureTxGas = require('../../pipes/ensure-gas');
+const EnsureTxCost = require('../../pipes/ensure-cost');
+
 const runner = new Runner();
 
 runner.use(pipes.VerifyMultiSig(0));
@@ -59,10 +62,14 @@ runner.use(pipes.ExtractState({ from: 'itx.address', to: 'delegationState', stat
 runner.use(pipes.ExtractState({ from: 'tx.from', to: 'senderState', status: 'INVALID_SENDER_STATE', table: 'account' })); // prettier-ignore
 runner.use(pipes.VerifyAccountMigration({ senderKey: 'senderState' }));
 
+// Ensure tx fee and gas
+runner.use(EnsureTxGas(() => ({ create: 0, update: 2, payment: 0 })));
+runner.use(EnsureTxCost({ attachSenderChanges: true }));
+
 // Update delegation state
 runner.use(
   async (context, next) => {
-    const { tx, itx, typeUrls, statedb, senderState, delegationState } = context;
+    const { tx, itx, typeUrls, statedb, senderState, senderUpdates, delegationState, updateVaults } = context;
 
     debug('update', { address: itx.address, typeUrls });
 
@@ -70,12 +77,17 @@ runner.use(
     typeUrls.forEach((x) => delete newOps[x]);
 
     const [newSenderState, newDelegationState] = await Promise.all([
-      statedb.account.update(senderState.address, account.update(senderState, { nonce: tx.nonce }, context), context),
+      statedb.account.update(
+        senderState.address,
+        account.update(senderState, { ...senderUpdates, nonce: tx.nonce }, context),
+        context
+      ),
       statedb.delegation.update(
         itx.address,
         delegation.update(context.delegationState, { ops: newOps }, context),
         context
       ),
+      updateVaults(),
     ]);
 
     // Update context

package/lib/protocols/asset/acquire-v2.js

@@ -15,7 +15,10 @@ const verifyItxAddress = require('./pipes/verify-itx-address');
 const execMintHook = require('./pipes/exec-mint-hook');
 const extractFactoryTokens = require('./pipes/extract-factory-tokens');
 
-const { applyTokenUpdates } = require('../../util');
+const EnsureTxGas = require('../../pipes/ensure-gas');
+const EnsureTxCost = require('../../pipes/ensure-cost');
+
+const { applyTokenUpdates, applyTokenChange } = require('../../util');
 
 const verifyTokenBalance = promisify(pipes.VerifyTokenBalance({ ownerKey: 'senders', conditionKey: 'conditions' }));
 
@@ -79,6 +82,22 @@ runner.use(async (context, next) => {
 runner.use(pipes.VerifyUpdater({ assetKey: 'assetStates', ownerKey: 'assetOwner' }));
 runner.use(verifyItxAssets);
 
+// Ensure tx fee and gas
+runner.use(
+  EnsureTxGas((context) => {
+    // FIXME: payment check
+    const result = { create: 1, update: 2, payment: 0 };
+    if (context.assetStates) {
+      result.update += context.assetStates.length;
+    }
+    if (context.delegatorState) {
+      result.update += 1;
+    }
+    return result;
+  })
+);
+runner.use(EnsureTxCost({ attachSenderChanges: true }));
+
 // update statedb
 runner.use(
   async (context, next) => {
@@ -93,6 +112,8 @@ runner.use(
       factoryTokens,
       mintedAsset,
       mintedAddress,
+      senderChange,
+      updateVaults,
       assetStates = [],
     } = context;
 
@@ -100,7 +121,7 @@ runner.use(
     const senderUpdates = {
       nonce: tx.nonce,
       pk: tx.pk,
-      ...applyTokenUpdates(factoryTokens, senderState, 'sub'),
+      ...applyTokenUpdates(factoryTokens, applyTokenChange(senderState, senderChange), 'sub'),
     };
 
     // Owner updates
@@ -139,6 +160,8 @@ runner.use(
       context.delegatorState
         ? statedb.account.update(assetOwner.address, account.update(assetOwner, ownerUpdates, context), context)
         : null,
+
+      updateVaults(),
     ]);
 
     context.senderState = newSenderState;

package/lib/protocols/asset/acquire-v3.js

@@ -10,7 +10,7 @@ const { account, asset, factory } = require('@ocap/state');
 // eslint-disable-next-line global-require
 const debug = require('debug')(`${require('../../../package.json').name}:acquire-asset-v3`);
 
-const { applyTokenUpdates } = require('../../util');
+const { applyTokenUpdates, applyTokenChange } = require('../../util');
 
 // custom pipes
 const verifyAcquireParams = require('./pipes/verify-acquire-params');
@@ -21,6 +21,9 @@ const verifyItxAddress = require('./pipes/verify-itx-address');
 const execMintHook = require('./pipes/exec-mint-hook');
 const extractFactoryTokens = require('./pipes/extract-factory-tokens');
 
+const EnsureTxGas = require('../../pipes/ensure-gas');
+const EnsureTxCost = require('../../pipes/ensure-cost');
+
 const verifyAssetOwner = promisify(pipes.VerifyUpdater({ assetKey: 'assets', ownerKey: 'owner' }));
 
 const runner = new Runner();
@@ -136,6 +139,25 @@ runner.use(
 runner.use(verifyItxAddress('acquire-v3'));
 runner.use(verifyItxAssets);
 
+// Ensure tx fee and gas
+runner.use(
+  EnsureTxGas((context) => {
+    // FIXME: payment check
+    const result = { create: 1, update: 2, payment: 0 };
+    if (context.assetStates) {
+      result.update += context.assetStates.length;
+    }
+    if (context.signerStates) {
+      result.update += context.signerStates.length;
+    }
+    if (!context.ownerState) {
+      result.create += 1;
+    }
+    return result;
+  })
+);
+runner.use(EnsureTxCost({ attachSenderChanges: true }));
+
 // update statedb
 runner.use(
   async (context, next) => {
@@ -152,6 +174,8 @@ runner.use(
       mintedAsset,
       mintedAddress,
       signerStates,
+      senderChange,
+      updateVaults,
       assetStates = [],
     } = context;
 
@@ -163,6 +187,9 @@ runner.use(
         signerStates.find((s) => s.address === owner),
         'sub'
       );
+      if (senderChange && owner === senderChange.address) {
+        signerUpdates[owner] = applyTokenChange(signerUpdates[owner], senderChange);
+      }
     });
 
     const isAlsoSigner = !!signerUpdates[tx.from];
@@ -184,7 +211,10 @@ runner.use(
           senderState,
           account.updateOrCreate(
             senderState,
-            Object.assign({ address: tx.from, nonce: tx.nonce, pk: tx.pk }, signerUpdates[tx.from] || {}),
+            Object.assign(
+              { address: tx.from, nonce: tx.nonce, pk: tx.pk },
+              signerUpdates[tx.from] || (senderChange ? applyTokenChange(senderState, senderChange) : {})
+            ),
             context
           ),
           context
@@ -220,6 +250,8 @@ runner.use(
             statedb.asset.update(x.address, asset.update(x, { consumedTime: txTime }, context), context)
           )
         ),
+
+        updateVaults(),
       ]);
 
     context.senderState = newSenderState;

package/lib/protocols/asset/create.js

@@ -1,6 +1,5 @@
 /* eslint-disable indent */
 const { CustomError: Error } = require('@ocap/util/lib/error');
-const isEmpty = require('lodash/isEmpty');
 const cloneDeep = require('lodash/cloneDeep');
 const { Runner, pipes } = require('@ocap/tx-pipeline');
 const { account, asset } = require('@ocap/state');
@@ -11,7 +10,9 @@ const { toAssetAddress } = require('@arcblock/did-util');
 const debug = require('debug')(`${require('../../../package.json').name}:create-asset`);
 
 const { decodeAnySafe } = require('../../util');
-const ensureServiceFee = require('../rollup/pipes/ensure-service-fee');
+
+const EnsureTxGas = require('../../pipes/ensure-gas');
+const EnsureTxCost = require('../../pipes/ensure-cost');
 
 const runner = new Runner();
 
@@ -89,16 +90,17 @@ runner.use(
 // Ensure parent exist
 runner.use(pipes.ExtractState({ from: 'itx.parent', to: 'parentAsset', status: 'INVALID_ASSET', table: 'asset' }));
 
-runner.use(ensureServiceFee);
+// Ensure tx fee and gas
+runner.use(EnsureTxGas(() => ({ create: 1, update: 1, payment: 0 })));
+runner.use(EnsureTxCost({ attachSenderChanges: true }));
 
 // Update asset state
 runner.use(
   async (context, next) => {
-    const { tx, itx, assetData, statedb, senderState, delegatorState, senderUpdates, vaultState, vaultUpdates } =
-      context;
+    const { tx, itx, assetData, statedb, senderState, delegatorState, senderUpdates, updateVaults } = context;
     const owner = delegatorState ? delegatorState.address : senderState.address;
 
-    const [newSenderState, assetState, newVaultState] = await Promise.all([
+    const [newSenderState, assetState] = await Promise.all([
       statedb.account.update(
         senderState.address,
         account.update(senderState, { nonce: tx.nonce, pk: tx.pk, ...senderUpdates }, context),
@@ -111,14 +113,11 @@ runner.use(
         context
       ),
 
-      isEmpty(vaultUpdates)
-        ? vaultState
-        : statedb.account.update(vaultState.address, account.update(vaultState, vaultUpdates, context), context),
+      updateVaults(),
     ]);
 
     context.senderState = newSenderState;
     context.assetState = assetState;
-    context.vaultState = newVaultState;
 
     debug('createAsset', assetState);
 

package/lib/protocols/asset/mint.js

@@ -13,6 +13,9 @@ const verifyItxAddress = require('./pipes/verify-itx-address');
 
 const runner = new Runner();
 
+const EnsureTxGas = require('../../pipes/ensure-gas');
+const EnsureTxCost = require('../../pipes/ensure-cost');
+
 runner.use(pipes.VerifyMultiSig(0));
 runner.use(verifyAcquireParams('mint'));
 
@@ -69,6 +72,22 @@ runner.use(verifyItxAddress('mint'));
 runner.use(pipes.VerifyUpdater({ assetKey: 'assetStates', ownerKey: 'ownerState' }));
 runner.use(verifyItxAssets);
 
+// Ensure tx fee and gas
+runner.use(
+  EnsureTxGas((context) => {
+    const result = { create: 1, update: 2, payment: 0 };
+    if (!context.ownerState) {
+      result.create += 1;
+    }
+    if (context.assetStates) {
+      result.update += context.assetStates.length;
+    }
+
+    return result;
+  })
+);
+runner.use(EnsureTxCost({ attachSenderChanges: true }));
+
 // update statedb
 runner.use(
   async (context, next) => {
@@ -82,17 +101,22 @@ runner.use(
       mintedAsset,
       mintedAddress,
       ownerState,
+      senderUpdates,
       assetStates = [],
+      updateVaults,
     } = context;
 
     const owner = ownerState ? ownerState.address : itx.owner;
 
-    const senderUpdates = { nonce: tx.nonce, pk: tx.pk };
     const factoryUpdates = { numMinted: factoryState.numMinted + 1 };
 
     const [newSenderState, newReceiverState, assetState, newFactoryState, newAssetStates] = await Promise.all([
       // update sender
-      statedb.account.update(senderState.address, account.update(senderState, senderUpdates, context), context),
+      statedb.account.update(
+        senderState.address,
+        account.update(senderState, { nonce: tx.nonce, pk: tx.pk, ...senderUpdates }, context),
+        context
+      ),
 
       // create receiver if not exist: asset owner
       ownerState
@@ -115,6 +139,8 @@ runner.use(
           statedb.asset.update(x.address, asset.update(x, { consumedTime: txTime }, context), context)
         )
       ),
+
+      updateVaults(),
     ]);
 
     context.senderState = newSenderState;

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

@@ -15,7 +15,7 @@ module.exports = async (context, next) => {
   if (factoryState.settlement === 'instant') {
     const mintHook = factoryState.hooks.find((x) => x.name === 'mint');
     if (mintHook && mintHook.type === 'contract') {
-      context.updatedAccounts = [];
+      context.updatedAccounts = context.updatedAccounts || [];
 
       // These calls must be run sequentially, because different calls may update same account
       const clone = cloneDeep(mintHook.compiled);

package/lib/protocols/asset/update.js

@@ -9,6 +9,9 @@ const debug = require('debug')(`${require('../../../package.json').name}:update-
 
 const { decodeAnySafe } = require('../../util');
 
+const EnsureTxGas = require('../../pipes/ensure-gas');
+const EnsureTxCost = require('../../pipes/ensure-cost');
+
 const runner = new Runner();
 
 runner.use(pipes.VerifyMultiSig(0));
@@ -74,16 +77,20 @@ runner.use(async (context, next) => {
   return next();
 });
 
+// Ensure tx fee and gas
+runner.use(EnsureTxGas(() => ({ create: 0, update: 2, payment: 0 })));
+runner.use(EnsureTxCost({ attachSenderChanges: true }));
+
 // Update asset state
 runner.use(
   async (context, next) => {
-    const { tx, itx, newData, statedb, senderState, assetState } = context;
+    const { tx, itx, newData, statedb, senderState, senderUpdates, assetState, updateVaults } = context;
 
     const [newSenderState, newAssetState] = await Promise.all([
       // update owner state
       statedb.account.update(
         senderState.address,
-        account.update(senderState, { nonce: tx.nonce, pk: tx.pk }, context),
+        account.update(senderState, { nonce: tx.nonce, pk: tx.pk, ...senderUpdates }, context),
         context
       ),
 
@@ -97,6 +104,8 @@ runner.use(
         ),
         context
       ),
+
+      updateVaults(),
     ]);
 
     context.senderState = newSenderState;