@ocap/tx-protocols 1.13.69 → 1.13.73

package/lib/index.js

@@ -23,8 +23,12 @@ const createRollup = require('./protocols/rollup/create');
 const updateRollup = require('./protocols/rollup/update');
 const joinRollup = require('./protocols/rollup/join');
 const leaveRollup = require('./protocols/rollup/leave');
+const pauseRollup = require('./protocols/rollup/pause');
+const resumeRollup = require('./protocols/rollup/resume');
 const createRollupBlock = require('./protocols/rollup/create-block');
 const claimBlockReward = require('./protocols/rollup/claim-reward');
+const migrateRollupContract = require('./protocols/rollup/migrate-contract');
+const migrateRollupToken = require('./protocols/rollup/migrate-token');
 
 const executor = require('./execute');
 
@@ -67,8 +71,12 @@ const createExecutor = ({ filter, runAsLambda }) => {
     updateRollup,
     joinRollup,
     leaveRollup,
+    pauseRollup,
+    resumeRollup,
     createRollupBlock,
     claimBlockReward,
+    migrateRollupContract,
+    migrateRollupToken,
   };
 
   const execute = executor({ filter, runAsLambda });

package/lib/protocols/rollup/create-block.js

@@ -252,70 +252,74 @@ runner.use(
     const { tx, itx, statedb, rollupState, senderState, stakeStates, txStates, formattedItx } = context;
     const senderStates = context.senderStates || [];
 
-    const [newSenderState, newStakeStates, newSenderStates, newRollupState, rollupBlockState] = await Promise.all([
-      // update sender(proposer) account
-      statedb.account.update(
-        senderState.address,
-        account.update(senderState, Object.assign({ nonce: tx.nonce }), context),
-        context
-      ),
-
-      // update stake states
-      Promise.all(
-        stakeStates.map((x) =>
-          context.stakeUpdates[x.address]
-            ? statedb.stake.update(
-                x.address,
-                stake.update(x, applyTokenChange(x, context.stakeUpdates[x.address]), context),
-                context
-              )
-            : Promise.resolve(x)
-        )
-      ),
-
-      // update tx owner states: those may get refund
-      Promise.all(
-        senderStates.map((x) =>
-          statedb.account.update(
-            x.address,
-            account.update(x, applyTokenChange(x, context.accountUpdates[x.address]), context),
-            context
+    const [newSenderState, newStakeStates, newSenderStates, newRollupState, rollupBlockState, newTxStates] =
+      await Promise.all([
+        // update sender(proposer) account
+        statedb.account.update(
+          senderState.address,
+          account.update(senderState, Object.assign({ nonce: tx.nonce }), context),
+          context
+        ),
+
+        // update stake states
+        Promise.all(
+          stakeStates.map((x) =>
+            context.stakeUpdates[x.address]
+              ? statedb.stake.update(
+                  x.address,
+                  stake.update(x, applyTokenChange(x, context.stakeUpdates[x.address]), context),
+                  context
+                )
+              : Promise.resolve(x)
           )
-        )
-      ),
-
-      // Update rollup state
-      statedb.rollup.update(
-        rollupState.address,
-        rollup.update(rollupState, { blockHeight: itx.height, blockHash: itx.hash }, context),
-        context
-      ),
-
-      // Create rollup block
-      statedb.rollupBlock.create(
-        itx.hash,
-        rollupBlock.create(
-          {
-            ...formattedItx,
-            ...['rewardAmount', 'mintedAmount', 'burnedAmount'].reduce((acc, x) => {
-              acc[x] = context[x].toString(10);
-              return acc;
-            }, {}),
-          },
+        ),
+
+        // update tx owner states: those may get refund
+        Promise.all(
+          senderStates.map((x) =>
+            statedb.account.update(
+              x.address,
+              account.update(x, applyTokenChange(x, context.accountUpdates[x.address]), context),
+              context
+            )
+          )
+        ),
+
+        // Update rollup state
+        statedb.rollup.update(
+          rollupState.address,
+          rollup.update(rollupState, { blockHeight: itx.height, blockHash: itx.hash }, context),
+          context
+        ),
+
+        // Create rollup block
+        statedb.rollupBlock.create(
+          itx.hash,
+          rollupBlock.create(
+            {
+              ...formattedItx,
+              ...['rewardAmount', 'mintedAmount', 'burnedAmount'].reduce((acc, x) => {
+                acc[x] = context[x].toString(10);
+                return acc;
+              }, {}),
+            },
+            context
+          ),
           context
         ),
-        context
-      ),
 
-      // Update tx states: mark as finalized
-      Promise.all(txStates.map((x) => statedb.tx.update(x.hash, Tx.update(x, { finalized: true, tx: x.tx }), context))),
-    ]);
+        // Update tx states: mark as finalized
+        Promise.all(
+          txStates.map((x) => statedb.tx.update(x.hash, Tx.update(x, { finalized: true, tx: x.tx }), context))
+        ),
+      ]);
 
     context.senderState = newSenderState;
     context.stakeStates = newStakeStates.filter((x) => context.stakeUpdates[x.address]);
     context.newSenderStates = newSenderStates;
     context.rollupState = newRollupState;
     context.rollupBlockState = rollupBlockState;
+    context.txStates = newTxStates;
 
     context.updatedAccounts = [...Object.values(context.stakeUpdates), ...Object.values(context.accountUpdates)];
 

package/lib/protocols/rollup/create.js

@@ -58,6 +58,7 @@ runner.use(
 
         // Save for later use
         context.rollupData = itx.data;
+        context.seedValidators = itx.seedValidatorsList.map((x) => x.address);
 
         return toRollupAddress(itx) === context.itx.address;
       },
@@ -65,11 +66,10 @@ runner.use(
   ])
 );
 
-// 1. ensure sender exist
-runner.use(
-  pipes.ExtractState({ from: 'tx.from', to: 'senderState', status: 'INVALID_SENDER_STATE', table: 'account' })
-);
-runner.use(pipes.VerifyAccountMigration({ senderKey: 'senderState' }));
+// 1. ensure sender & validators exist
+runner.use(pipes.ExtractState({ from: 'tx.from', to: 'senderState', status: 'INVALID_SENDER_STATE', table: 'account' })); // prettier-ignore
+runner.use(pipes.ExtractState({ from: 'seedValidators', to: 'validatorStates', status: 'INVALID_VALIDATOR_STATE', table: 'account' })); // prettier-ignore
+runner.use(pipes.VerifyAccountMigration({ signerKey: 'validatorStates', senderKey: 'senderState' }));
 
 // 2. ensure token exist and match
 runner.use(pipes.ExtractState({ from: 'itx.tokenAddress', to: 'tokenState', status: 'INVALID_TOKEN', table: 'token' }));
@@ -125,9 +125,6 @@ runner.use(
         rollup.create(
           {
             ...formattedItx,
-            paused: false,
-            blockHeight: 0,
-            blockHash: '',
             issuer: senderState.address,
             validators: formattedItx.seedValidators,
             data: rollupData,

package/lib/protocols/rollup/migrate-contract.js

@@ -0,0 +1,53 @@
+const Error = require('@ocap/util/lib/error');
+const Joi = require('@ocap/validator');
+const { Runner, pipes } = require('@ocap/tx-pipeline');
+const { account, rollup } = require('@ocap/state');
+
+const VerifySigners = require('./pipes/verify-signers');
+const EnsureValidator = require('./pipes/ensure-validator');
+
+const runner = new Runner();
+
+// 1. verify itx
+const schema = Joi.object({
+  rollup: Joi.DID().role('ROLE_ROLLUP').required(),
+  to: Joi.DID().wallet('ethereum').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);
+});
+
+// 2. verify rollup
+runner.use(pipes.ExtractState({ from: 'itx.rollup', to: 'rollupState', status: 'INVALID_ROLLUP', table: 'rollup' }));
+runner.use(EnsureValidator(true));
+
+// 3. verify tx signers and signatures
+runner.use(VerifySigners({ signersKey: 'tx.signaturesList', allowSender: true }));
+runner.use(pipes.VerifyMultiSigV2({ signersKey: 'signers' }));
+
+// 4. verify sender and signer states
+runner.use(pipes.ExtractState({ from: 'tx.from', to: 'senderState', status: 'INVALID_SENDER_STATE', table: 'account' })); // prettier-ignore
+runner.use(pipes.ExtractState({ from: 'signers', to: 'signerStates', status: 'INVALID_SIGNER_STATE', table: 'account' })); // prettier-ignore
+runner.use(pipes.VerifyAccountMigration({ signerKey: 'signerStates', senderKey: 'senderState' }));
+
+// 5. update rollup state
+runner.use(
+  async (context, next) => {
+    const { tx, itx, rollupState, statedb, senderState } = context;
+
+    const [newSenderState, newRollupState] = await Promise.all([
+      statedb.account.update(senderState.address, account.update(senderState, { nonce: tx.nonce }, context), context),
+      statedb.rollup.update(itx.rollup, rollup.migrate(rollupState, itx.to, context), context),
+    ]);
+
+    context.senderState = newSenderState;
+    context.rollupState = newRollupState;
+
+    next();
+  },
+  { persistError: true }
+);
+
+module.exports = runner;

package/lib/protocols/rollup/migrate-token.js

@@ -0,0 +1,66 @@
+const Error = require('@ocap/util/lib/error');
+const Joi = require('@ocap/validator');
+const { Runner, pipes } = require('@ocap/tx-pipeline');
+const { account } = require('@ocap/state');
+
+const VerifySigners = require('./pipes/verify-signers');
+const EnsureValidator = require('./pipes/ensure-validator');
+
+const runner = new Runner();
+
+// 1. verify itx
+const schema = Joi.object({
+  rollup: Joi.DID().role('ROLE_ROLLUP').required(),
+  from: Joi.DID().wallet('ethereum').required(),
+  to: Joi.DID().wallet('ethereum').required(),
+  token: Joi.object({
+    address: Joi.DID().wallet('ethereum').required(),
+    value: Joi.BN().positive().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);
+});
+
+// 2. verify rollup
+runner.use(pipes.ExtractState({ from: 'itx.rollup', to: 'rollupState', status: 'INVALID_ROLLUP', table: 'rollup' }));
+runner.use(EnsureValidator(true));
+runner.use(({ itx, rollupState }, next) => {
+  if (rollupState.migrateHistory.includes(itx.from) === false) {
+    return next(new Error('INVALID_MIGRATE_ATTEMPT', 'itx.from must exist in rollup migrate history'));
+  }
+  if (itx.to !== rollupState.contractAddress) {
+    return next(new Error('INVALID_MIGRATE_ATTEMPT', 'itx.to must equal to latest rollup contract address'));
+  }
+
+  return next();
+});
+
+// 3. verify tx signers and signatures
+runner.use(VerifySigners({ signersKey: 'tx.signaturesList', allowSender: true }));
+runner.use(pipes.VerifyMultiSigV2({ signersKey: 'signers' }));
+
+// 4. verify sender and signer states
+runner.use(pipes.ExtractState({ from: 'tx.from', to: 'senderState', status: 'INVALID_SENDER_STATE', table: 'account' })); // prettier-ignore
+runner.use(pipes.ExtractState({ from: 'signers', to: 'signerStates', status: 'INVALID_SIGNER_STATE', table: 'account' })); // prettier-ignore
+runner.use(pipes.VerifyAccountMigration({ signerKey: 'signerStates', senderKey: 'senderState' }));
+
+// 5. update state
+runner.use(
+  async (context, next) => {
+    const { tx, statedb, senderState } = context;
+
+    const [newSenderState] = await Promise.all([
+      statedb.account.update(senderState.address, account.update(senderState, { nonce: tx.nonce }, context), context),
+    ]);
+
+    context.senderState = newSenderState;
+
+    next();
+  },
+  { persistError: true }
+);
+
+module.exports = runner;

package/lib/protocols/rollup/pause.js

@@ -0,0 +1,52 @@
+const Error = require('@ocap/util/lib/error');
+const Joi = require('@ocap/validator');
+const { Runner, pipes } = require('@ocap/tx-pipeline');
+const { account, rollup } = require('@ocap/state');
+
+const VerifySigners = require('./pipes/verify-signers');
+const EnsureValidator = require('./pipes/ensure-validator');
+
+const runner = new Runner();
+
+// 1. verify itx
+const schema = Joi.object({
+  rollup: Joi.DID().role('ROLE_ROLLUP').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);
+});
+
+// 2. verify rollup
+runner.use(pipes.ExtractState({ from: 'itx.rollup', to: 'rollupState', status: 'INVALID_ROLLUP', table: 'rollup' }));
+runner.use(EnsureValidator(true));
+
+// 3. verify tx signers and signatures
+runner.use(VerifySigners({ signersKey: 'tx.signaturesList', allowSender: true }));
+runner.use(pipes.VerifyMultiSigV2({ signersKey: 'signers' }));
+
+// 4. verify sender and signer states
+runner.use(pipes.ExtractState({ from: 'tx.from', to: 'senderState', status: 'INVALID_SENDER_STATE', table: 'account' })); // prettier-ignore
+runner.use(pipes.ExtractState({ from: 'signers', to: 'signerStates', status: 'INVALID_SIGNER_STATE', table: 'account' })); // prettier-ignore
+runner.use(pipes.VerifyAccountMigration({ signerKey: 'signerStates', senderKey: 'senderState' }));
+
+// 5. update rollup state
+runner.use(
+  async (context, next) => {
+    const { tx, itx, rollupState, statedb, senderState } = context;
+
+    const [newSenderState, newRollupState] = await Promise.all([
+      statedb.account.update(senderState.address, account.update(senderState, { nonce: tx.nonce }, context), context),
+      statedb.rollup.update(itx.rollup, rollup.pause(rollupState, context), context),
+    ]);
+
+    context.senderState = newSenderState;
+    context.rollupState = newRollupState;
+
+    next();
+  },
+  { persistError: true }
+);
+
+module.exports = runner;

package/lib/protocols/rollup/pipes/ensure-validator.js

@@ -0,0 +1,10 @@
+module.exports = (isSeed) => async (context, next) => {
+  const { rollupState, tx } = context;
+
+  const validators = isSeed ? rollupState.seedValidators : rollupState.validators;
+  if (validators.some((x) => x.address === tx.from) === false) {
+    return next(new Error('INVALID_TX', 'Tx sender is not an expected validator'));
+  }
+
+  return next();
+};

package/lib/protocols/rollup/resume.js

@@ -0,0 +1,52 @@
+const Error = require('@ocap/util/lib/error');
+const Joi = require('@ocap/validator');
+const { Runner, pipes } = require('@ocap/tx-pipeline');
+const { account, rollup } = require('@ocap/state');
+
+const VerifySigners = require('./pipes/verify-signers');
+const EnsureValidator = require('./pipes/ensure-validator');
+
+const runner = new Runner();
+
+// 1. verify itx
+const schema = Joi.object({
+  rollup: Joi.DID().role('ROLE_ROLLUP').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);
+});
+
+// 2. verify rollup
+runner.use(pipes.ExtractState({ from: 'itx.rollup', to: 'rollupState', status: 'INVALID_ROLLUP', table: 'rollup' }));
+runner.use(EnsureValidator(true));
+
+// 3. verify tx signers and signatures
+runner.use(VerifySigners({ signersKey: 'tx.signaturesList', allowSender: true }));
+runner.use(pipes.VerifyMultiSigV2({ signersKey: 'signers' }));
+
+// 4. verify sender and signer states
+runner.use(pipes.ExtractState({ from: 'tx.from', to: 'senderState', status: 'INVALID_SENDER_STATE', table: 'account' })); // prettier-ignore
+runner.use(pipes.ExtractState({ from: 'signers', to: 'signerStates', status: 'INVALID_SIGNER_STATE', table: 'account' })); // prettier-ignore
+runner.use(pipes.VerifyAccountMigration({ signerKey: 'signerStates', senderKey: 'senderState' }));
+
+// 5. update rollup state
+runner.use(
+  async (context, next) => {
+    const { tx, itx, rollupState, statedb, senderState } = context;
+
+    const [newSenderState, newRollupState] = await Promise.all([
+      statedb.account.update(senderState.address, account.update(senderState, { nonce: tx.nonce }, context), context),
+      statedb.rollup.update(itx.rollup, rollup.resume(rollupState, context), context),
+    ]);
+
+    context.senderState = newSenderState;
+    context.rollupState = newRollupState;
+
+    next();
+  },
+  { persistError: true }
+);
+
+module.exports = runner;

package/lib/protocols/rollup/update.js

@@ -15,7 +15,6 @@ const runner = new Runner();
 // 1. verify itx: client must use previous rollup state to construct this itx
 const schema = Joi.object({
   rollup: Joi.DID().role('ROLE_ROLLUP').required(),
-  paused: Joi.boolean().required(),
 
   minStakeAmount: Joi.BN().greater(0).required(),
   maxStakeAmount: Joi.BN().greater(Joi.ref('minStakeAmount')).required(),

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.13.69",
+  "version": "1.13.73",
   "description": "Predefined tx pipeline sets to execute certain type of transactions",
   "main": "lib/index.js",
   "files": [
@@ -19,17 +19,17 @@
   "author": "wangshijun <wangshijun2010@gmail.com> (http://github.com/wangshijun)",
   "license": "MIT",
   "dependencies": {
-    "@arcblock/did": "1.13.69",
-    "@arcblock/did-util": "1.13.69",
-    "@ocap/asset": "1.13.69",
-    "@ocap/mcrypto": "1.13.69",
-    "@ocap/merkle-tree": "1.13.69",
-    "@ocap/message": "1.13.69",
-    "@ocap/state": "1.13.69",
-    "@ocap/tx-pipeline": "1.13.69",
-    "@ocap/util": "1.13.69",
-    "@ocap/validator": "1.13.69",
-    "@ocap/wallet": "1.13.69",
+    "@arcblock/did": "1.13.73",
+    "@arcblock/did-util": "1.13.73",
+    "@ocap/asset": "1.13.73",
+    "@ocap/mcrypto": "1.13.73",
+    "@ocap/merkle-tree": "1.13.73",
+    "@ocap/message": "1.13.73",
+    "@ocap/state": "1.13.73",
+    "@ocap/tx-pipeline": "1.13.73",
+    "@ocap/util": "1.13.73",
+    "@ocap/validator": "1.13.73",
+    "@ocap/wallet": "1.13.73",
     "debug": "^4.3.2",
     "empty-value": "^1.0.1",
     "lodash": "^4.17.21",
@@ -42,5 +42,5 @@
   "devDependencies": {
     "jest": "^27.3.1"
   },
-  "gitHead": "7520d994d592dc4fe50612a665c94d7fa4d5b143"
+  "gitHead": "ffce10eaa7c72fe6d6fdc534f7e15cbdb3e6a917"
 }