@ocap/tx-protocols 1.18.124 → 1.18.126

package/lib/index.js

@@ -17,6 +17,7 @@ const mintAsset = require('./protocols/asset/mint');
 const createToken = require('./protocols/token/create');
 const stake = require('./protocols/governance/stake');
 const revokeStake = require('./protocols/governance/revoke-stake');
+const returnStake = require('./protocols/governance/return-stake');
 const claimStake = require('./protocols/governance/claim-stake');
 const slashStake = require('./protocols/governance/slash-stake');
 const depositTokenV2 = require('./protocols/token/deposit-v2');
@@ -69,6 +70,7 @@ const createExecutor = ({ filter, runAsLambda }) => {
     revokeStake,
     claimStake,
     slashStake,
+    returnStake,
 
     // rollup
     createRollup,

package/lib/protocols/governance/return-stake.js

@@ -0,0 +1,237 @@
+const isEmpty = require('empty-value');
+const { CustomError: Error } = require('@ocap/util/lib/error');
+const { BN } = require('@ocap/util');
+const { Joi, schemas } = require('@arcblock/validator');
+const { Runner, pipes } = require('@ocap/tx-pipeline');
+const { account, stake, asset } = require('@ocap/state');
+const { getRelatedAddresses } = require('@ocap/util/lib/get-related-addr');
+
+// eslint-disable-next-line global-require
+const debug = require('debug')(`${require('../../../package.json').name}:return-stake`);
+
+const { applyTokenUpdates, applyTokenChange } = require('../../util');
+const EnsureTxGas = require('../../pipes/ensure-gas');
+const EnsureTxCost = require('../../pipes/ensure-cost');
+
+const runner = new Runner();
+
+runner.use(pipes.VerifyMultiSig(0));
+
+// 0. verify itx
+const schema = Joi.object({
+  address: Joi.DID().prefix().role('ROLE_STAKE').required(),
+  message: Joi.string().trim().min(1).max(256).required(),
+  outputsList: schemas.multiInput.min(1).required(),
+  data: Joi.any().optional(),
+}).options({ stripUnknown: true, noDefaults: false });
+runner.use(({ itx }, next) => {
+  const { error } = schema.validate(itx);
+  return next(error ? new Error('INVALID_TX', `Invalid itx: ${error.message}`) : null);
+});
+
+// 1. verify itx.outputs
+runner.use(
+  pipes.VerifyTxInput({
+    fieldKey: 'itx.outputs',
+    inputsKey: 'outputs',
+    sendersKey: 'receivers',
+    tokensKey: 'tokens',
+    assetsKey: 'assets',
+  })
+);
+
+// 2. verify output
+runner.use(
+  pipes.VerifyInfo([
+    {
+      error: 'INSUFFICIENT_DATA',
+      message: 'Can not return stake without any output',
+      fn: ({ assets, tokens }) => !(isEmpty(tokens) && isEmpty(assets)),
+    },
+  ])
+);
+
+// 3. verify itx size: set hard limit here because more output leads to longer tx execute time
+runner.use(pipes.VerifyListSize({ listKey: ['outputs', 'receivers', 'tokens', 'assets'] }));
+
+// 4. verify sender & receiver
+runner.use(pipes.ExtractState({ from: 'tx.from', to: 'senderState', status: 'INVALID_SENDER_STATE', table: 'account' })); // prettier-ignore
+runner.use(pipes.ExtractState({ from: 'receivers', to: 'receiverStates', status: 'INVALID_RECEIVER_STATE', table: 'account' })); // prettier-ignore
+runner.use(pipes.VerifyAccountMigration({ stateKey: 'senderState', addressKey: 'tx.from' }));
+
+// 5. verify stake state
+runner.use(pipes.ExtractState({ from: 'itx.address', to: 'stakeState', status: 'INVALID_STAKE_STATE', table: 'stake' })); // prettier-ignore
+runner.use(
+  pipes.VerifyInfo([
+    {
+      error: 'INVALID_TX',
+      message: 'Can only return from none-self staking',
+      fn: ({ stakeState }) => stakeState.sender !== stakeState.receiver,
+    },
+    {
+      error: 'INVALID_TX',
+      message: 'Can only return stake from receiver',
+      fn: ({ senderState, stakeState }) => {
+        return getRelatedAddresses(senderState).includes(stakeState.receiver);
+      },
+    },
+    {
+      error: 'INVALID_TX',
+      message: 'Can only return stake to sender',
+      fn: ({ receiverStates, stakeState }) =>
+        receiverStates.every((x) => getRelatedAddresses(x).includes(stakeState.sender)),
+    },
+  ])
+);
+
+// 6. verify token state and balance from staked
+runner.use(pipes.ExtractState({ from: 'tokens', to: 'tokenStates', status: 'INVALID_TOKEN', table: 'token' }));
+runner.use((context, next) => {
+  const { outputs, stakeState } = context;
+  const tokens = {};
+  outputs.forEach(({ tokensList }) => {
+    tokensList.forEach(({ address, value }) => {
+      if (typeof tokens[address] === 'undefined') {
+        tokens[address] = new BN(0);
+      }
+      tokens[address] = tokens[address].add(new BN(value));
+    });
+  });
+
+  const lockedState = {
+    address: stakeState.address,
+    tokens: { ...stakeState.tokens },
+    assets: [...stakeState.assets],
+  };
+
+  context.lockedState = lockedState;
+  context.tokenCondition = {
+    owner: stakeState.address,
+    tokens: Object.keys(tokens).map((address) => ({ address, value: tokens[address] })),
+  };
+
+  next();
+});
+runner.use(pipes.VerifyTokenBalance({ ownerKey: 'lockedState', conditionKey: 'tokenCondition' }));
+runner.use(
+  pipes.VerifyInfo([
+    {
+      error: 'INVALID_TX',
+      message: 'Can not return assets that are not locked in the stake',
+      fn: ({ assets, lockedState }) => assets.every((x) => lockedState.assets.includes(x)),
+    },
+  ])
+);
+
+// 7. verify asset state and ownership
+runner.use(pipes.ExtractState({ from: 'assets', to: 'assetStates', status: 'INVALID_ASSET_STATE', table: 'asset' }));
+runner.use(pipes.VerifyTransferrable({ assets: 'assetStates' }));
+runner.use(pipes.VerifyUpdater({ assetKey: 'assetStates', ownerKey: 'stakeState' }));
+
+// ensure tx cost and gas
+runner.use(
+  EnsureTxGas((context) => {
+    const result = { create: 0, update: 2, payment: 0 };
+    if (context.receiverStates) {
+      result.update += context.receiverStates.length;
+    }
+    if (context.assetStates) {
+      result.update += context.assetStates.length;
+    }
+
+    return result;
+  })
+);
+runner.use(EnsureTxCost({ attachSenderChanges: true }));
+
+// 8. update statedb
+runner.use(
+  async (context, next) => {
+    const {
+      tx,
+      itx,
+      outputs,
+      statedb,
+      senderState,
+      receiverStates = [],
+      assetStates = [],
+      stakeState,
+      updateVaults,
+      senderChange,
+    } = context;
+
+    const receiverUpdates = {};
+    const assetUpdates = {};
+    const stakeUpdates = {
+      tokens: stakeState.tokens || {},
+      assets: stakeState.assets || [],
+    };
+
+    outputs.forEach((x) => {
+      const { owner, tokensList, assetsList } = x;
+
+      // move assets to output
+      stakeUpdates.assets = stakeUpdates.assets.filter((a) => assetsList.includes(a) === false);
+
+      // move tokens and assets from staked to output
+      const newTokens = applyTokenUpdates(tokensList, { tokens: stakeUpdates.tokens }, 'sub');
+      stakeUpdates.tokens = newTokens.tokens;
+
+      // Update receiver balance
+      const ownerState = receiverStates.find((s) => getRelatedAddresses(s).includes(owner));
+      receiverUpdates[ownerState.address] = applyTokenUpdates(tokensList, ownerState, 'add');
+      if (senderChange && ownerState.address === senderChange.address) {
+        receiverUpdates[ownerState.address] = applyTokenChange(receiverUpdates[ownerState.address], senderChange);
+      }
+
+      // Update asset owner
+      assetsList.forEach((a) => {
+        assetUpdates[a] = { owner: ownerState.address };
+      });
+    });
+
+    const [newSenderState, newReceiverStates, newStakeState, newAssetStates] = await Promise.all([
+      // Update sender state
+      statedb.account.update(
+        senderState.address,
+        account.update(
+          senderState,
+          Object.assign({ nonce: tx.nonce }, senderChange ? applyTokenChange(senderState, senderChange) : {}),
+          context
+        ),
+        context
+      ),
+
+      // Update receiver states
+      Promise.all(
+        receiverStates.map((x) =>
+          statedb.account.update(x.address, account.update(x, receiverUpdates[x.address], context), context)
+        )
+      ),
+
+      // Update stake state
+      statedb.stake.update(stakeState.address, stake.update(stakeState, stakeUpdates, context), context),
+
+      // Transfer assets to output account
+      Promise.all(
+        assetStates.map((x) =>
+          statedb.asset.update(x.address, asset.update(x, assetUpdates[x.address], context), context)
+        )
+      ),
+
+      updateVaults(),
+    ]);
+
+    context.senderState = newSenderState;
+    context.receiverStates = newReceiverStates;
+    context.stakeState = newStakeState;
+    context.assetStates = newAssetStates;
+
+    debug('return-stake', { address: itx.address, stakeUpdates, assetUpdates, senderChange, ...receiverUpdates });
+
+    next();
+  },
+  { persistError: true }
+);
+
+module.exports = runner;

package/lib/protocols/governance/slash-stake.js

@@ -74,12 +74,9 @@ runner.use(
     },
     {
       error: 'INVALID_TX',
-      message: 'Can only send slashed token/assets to vault, sender, or specified slasher',
-      fn: ({ config, receivers, stakeState, slasherStates }) =>
-        receivers.every(
-          (x) =>
-            x === stakeState.sender || x === config.vaults.slashedStake || slasherStates.some((s) => s.address === x)
-        ),
+      message: 'Can only send slashed token/assets to vault or specified slasher',
+      fn: ({ config, receivers, slasherStates }) =>
+        receivers.every((x) => x === config.vaults.slashedStake || slasherStates.some((s) => s.address === x)),
     },
   ])
 );

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.18.124",
+  "version": "1.18.126",
   "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.124",
-    "@arcblock/did-util": "1.18.124",
-    "@arcblock/jwt": "1.18.124",
-    "@arcblock/validator": "1.18.124",
-    "@ocap/asset": "1.18.124",
-    "@ocap/mcrypto": "1.18.124",
-    "@ocap/merkle-tree": "1.18.124",
-    "@ocap/message": "1.18.124",
-    "@ocap/state": "1.18.124",
-    "@ocap/tx-pipeline": "1.18.124",
-    "@ocap/util": "1.18.124",
-    "@ocap/wallet": "1.18.124",
+    "@arcblock/did": "1.18.126",
+    "@arcblock/did-util": "1.18.126",
+    "@arcblock/jwt": "1.18.126",
+    "@arcblock/validator": "1.18.126",
+    "@ocap/asset": "1.18.126",
+    "@ocap/mcrypto": "1.18.126",
+    "@ocap/merkle-tree": "1.18.126",
+    "@ocap/message": "1.18.126",
+    "@ocap/state": "1.18.126",
+    "@ocap/tx-pipeline": "1.18.126",
+    "@ocap/util": "1.18.126",
+    "@ocap/wallet": "1.18.126",
     "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": "c48ab6ae29affa47c479c77333ce3a4dc40ba46a"
+  "gitHead": "f25463b1fb916131d6cca7077cc12badb4abd52e"
 }