@ocap/tx-protocols 1.28.8 → 1.29.0

package/lib/protocols/rollup/close.js

@@ -1,104 +0,0 @@
-const { CustomError: Error } = require('@ocap/util/lib/error');
-const { Joi } = require('@arcblock/validator');
-const { Runner, pipes } = require('@ocap/tx-pipeline');
-const { account, rollup, stake } = require('@ocap/state');
-
-const { toStakeAddress } = require('@arcblock/did-util');
-const VerifySigners = require('./pipes/verify-signers');
-const VerifyStatus = require('./pipes/verify-status');
-const EnsureValidator = require('./pipes/ensure-validator');
-const EnsureTxGas = require('../../pipes/ensure-gas');
-const EnsureTxCost = require('../../pipes/ensure-cost');
-
-const runner = new Runner();
-
-// 1. verify itx
-const schema = Joi.object({
-  rollup: Joi.DID().prefix().role('ROLE_ROLLUP').required(),
-  message: Joi.string().trim().min(1).max(512).required(),
-  token: Joi.object({
-    address: Joi.DID().prefix().wallet('ethereum').required(),
-    value: Joi.BN().positive().required(),
-  }),
-  data: Joi.any().optional().allow(null),
-}).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(VerifyStatus({ paused: true, closed: false }));
-
-// 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' })
-);
-runner.use(
-  pipes.ExtractState({ from: 'signers', to: 'signerStates', status: 'INVALID_SIGNER_STATE', table: 'account' })
-);
-runner.use(pipes.VerifyAccountMigration({ signerKey: 'signerStates', stateKey: 'senderState', addressKey: 'tx.from' }));
-
-// 5. extract validator stake stakes
-runner.use((context, next) => {
-  const { validators, address } = context.rollupState;
-  context.stakes = validators.map((x) => toStakeAddress(x.address, address));
-  return next();
-});
-runner.use(pipes.ExtractState({ from: 'stakes', to: 'stakeStates', status: 'INVALID_STAKE_STATE', table: 'stake' }));
-
-// 6. Ensure tx fee and gas
-runner.use(EnsureTxGas((context) => ({ create: 0, update: context.stakeStates.length + 2, payment: 0 })));
-runner.use(EnsureTxCost({ attachSenderChanges: true }));
-
-// Save context snapshot before updating states
-runner.use(pipes.TakeStateSnapshot());
-
-// 7. update rollup state
-runner.use(
-  async (context, next) => {
-    const { tx, itx, rollupState, statedb, senderState, stakeStates, senderUpdates, updateVaults } = context;
-
-    const [newSenderState, newRollupState, newStakeStates] = await Promise.all([
-      // update sender state
-      statedb.account.update(
-        senderState.address,
-        account.update(senderState, { nonce: tx.nonce, ...senderUpdates }, context),
-        context
-      ),
-
-      // update rollup
-      statedb.rollup.update(itx.rollup, rollup.close(rollupState, context), context),
-
-      // update stake states
-      Promise.all(
-        stakeStates.map((x) =>
-          statedb.stake.update(
-            x.address,
-            stake.update(x, { revocable: true, leaveWaitingPeriod: rollupState.leaveWaitingPeriod }, context),
-            context
-          )
-        )
-      ),
-    ]);
-
-    await updateVaults();
-
-    context.senderState = newSenderState;
-    context.rollupState = newRollupState;
-    context.stakeStates = newStakeStates;
-
-    next();
-  },
-  { persistError: true }
-);
-
-runner.use(pipes.VerifyStateDiff());
-
-module.exports = runner;

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

@@ -1,413 +0,0 @@
-const pick = require('lodash/pick');
-const cloneDeep = require('lodash/cloneDeep');
-const { CustomError: Error } = require('@ocap/util/lib/error');
-const MerkleTree = require('@ocap/merkle-tree');
-const { Joi, schemas, patterns } = require('@arcblock/validator');
-const { formatMessage } = require('@ocap/message');
-const { toStakeAddress } = require('@arcblock/did-util');
-const { Runner, pipes } = require('@ocap/tx-pipeline');
-const { account, stake, rollup, rollupBlock, tx: Tx } = require('@ocap/state');
-
-const debug = require('debug')(`${require('../../../package.json').name}:create-rollup-block`);
-
-const VerifySigners = require('./pipes/verify-signers');
-const VerifyEvidence = require('./pipes/verify-evidence');
-const VerifyStatus = require('./pipes/verify-status');
-const EnsureValidator = require('./pipes/ensure-validator');
-const EnsureTxGas = require('../../pipes/ensure-gas');
-const EnsureTxCost = require('../../pipes/ensure-cost');
-
-const { applyTokenChange, ensureBlockReward, getRewardLocker } = require('../../util');
-
-const runner = new Runner();
-
-// 1. verify itx
-const schema = Joi.object({
-  hash: Joi.string().regex(patterns.txHash).required(),
-  height: Joi.number().integer().greater(0).required(),
-  merkleRoot: Joi.string().regex(patterns.txHash).required(),
-  previousHash: Joi.string().when('height', {
-    is: 1,
-    then: Joi.string().optional().allow(null).allow(''),
-    otherwise: Joi.string().regex(patterns.txHash).required(),
-  }),
-  txsHash: Joi.string().regex(patterns.txHash).required(),
-  txsList: Joi.array().items(Joi.string().regex(patterns.txHash).required()).min(1).unique().required(),
-  proposer: Joi.DID().prefix().wallet('ethereum').required(),
-  signaturesList: schemas.multiSig.min(1).required(),
-  rollup: Joi.DID().prefix().role('ROLE_ROLLUP').required(),
-  minReward: Joi.BN().min(0).required(),
-  governance: Joi.boolean().default(false),
-  data: Joi.any().optional().allow(null),
-}).options({ stripUnknown: true, noDefaults: false });
-
-runner.use((context, next) => {
-  const { tx, itx } = context;
-
-  context.formattedItx = formatMessage('CreateRollupBlockTx', itx);
-
-  const { error } = schema.validate(itx);
-  if (error) {
-    return next(new Error('INVALID_TX', error.message));
-  }
-
-  // ensure proposer same with tx.from
-  if (tx.from !== itx.proposer) {
-    return next(new Error('INVALID_TX', 'itx.proposer must be same with tx.from'));
-  }
-
-  // ensure proposer in signer list
-  if (tx.signaturesList.some((x) => x.signer === itx.proposer) === false) {
-    return next(new Error('INVALID_TX', 'itx.proposer must exist in signatures'));
-  }
-
-  // ensure tx hash match with txs
-  const txsHash = MerkleTree.getListHash(itx.txsList);
-  if (txsHash !== itx.txsHash) {
-    return next(new Error('INVALID_TX', 'itx.txsHash does not match with itx.txs'));
-  }
-
-  // ensure block hash is correct
-  const blockHash = MerkleTree.getBlockHash({
-    ...pick(itx, ['height', 'merkleRoot', 'txsHash']),
-    previousHash: itx.height === 1 ? '' : itx.previousHash,
-  });
-  if (blockHash !== itx.hash) {
-    return next(new Error('INVALID_TX', 'itx.hash invalid'));
-  }
-
-  return next();
-});
-
-// 2. verify rollup state & height
-runner.use(pipes.ExtractState({ from: 'itx.rollup', to: 'rollupState', status: 'INVALID_ROLLUP', table: 'rollup' }));
-runner.use(EnsureValidator());
-runner.use(VerifyStatus({ closed: false }));
-runner.use((context, next) => {
-  const { itx, rollupState } = context;
-
-  if (itx.height !== rollupState.blockHeight + 1) {
-    return next(
-      new Error('INVALID_TX', `Expect new block height to be ${rollupState.blockHeight + 1}, got ${itx.height}`)
-    );
-  }
-
-  if (itx.governance) {
-    // ensure minReward for governance block
-    if (itx.minReward !== '0') {
-      return next(new Error('INVALID_TX', 'itx.minReward should be 0 for governance block'));
-    }
-    // ensure blockSize for governance block
-    if (itx.txsList.length !== 1) {
-      return next(new Error('INVALID_TX', 'itx.txs should contain only 1 tx for governance block'));
-    }
-  } else {
-    if (rollupState.paused) {
-      return next(new Error('INVALID_TX', 'Normal block is only allowed when rollup is not paused'));
-    }
-
-    // ensure block size
-    const blockSize = itx.txsList.length;
-    if (blockSize < rollupState.minBlockSize) {
-      return next(
-        new Error('INVALID_TX', `Expect at least ${rollupState.minBlockSize} tx in the block, got ${blockSize}`)
-      );
-    }
-    if (blockSize > rollupState.maxBlockSize) {
-      return next(
-        new Error('INVALID_TX', `Expect at most ${rollupState.maxBlockSize} tx in the block, got ${blockSize}`)
-      );
-    }
-  }
-
-  return next();
-});
-
-// 4. verify evidence signers, signatures, state
-runner.use(VerifySigners({ signersKey: 'itx.signaturesList', allowSender: true }));
-runner.use(VerifyEvidence({ evidenceKey: 'itx.hash', signaturesKey: 'itx.signaturesList', verifyMethod: 'ethVerify' }));
-
-// 3. verify signers & 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' })
-);
-runner.use(
-  pipes.ExtractState({ from: 'signers', to: 'signerStates', status: 'INVALID_SIGNER_STATE', table: 'account' })
-);
-runner.use(pipes.VerifyAccountMigration({ signerKey: 'signerStates', stateKey: 'senderState', addressKey: 'tx.from' }));
-
-// 5. verify previous block
-runner.use(pipes.ExtractState({ from: 'itx.previousHash', to: 'previousBlock', status: 'OK', table: 'rollupBlock' }));
-runner.use((context, next) => {
-  const { txTime, itx, previousBlock, rollupState } = context;
-  if (itx.height > 1) {
-    if (!previousBlock) {
-      return next(new Error('INVALID_TX', `Rollup block with height ${itx.height} does not exist`));
-    }
-
-    if (itx.height !== previousBlock.height + 1) {
-      return next(
-        new Error(
-          'INVALID_TX',
-          `Unexpected previous block height, expected ${itx.height - 1}, got ${previousBlock.height}`
-        )
-      );
-    }
-
-    // ensure minBlockInterval for normal blocks
-    if (itx.governance === false) {
-      const minBlockTime = +new Date(previousBlock.context.genesisTime) + rollupState.minBlockInterval * 1000;
-      const newBlockTime = +new Date(txTime);
-      if (newBlockTime < minBlockTime) {
-        return next(
-          new Error(
-            'INVALID_TX',
-            `Block does not comply with minBlockInterval: ${new Date(minBlockTime).toISOString()}`
-          )
-        );
-      }
-    }
-  }
-
-  return next();
-});
-
-// 6. verify new block
-runner.use(pipes.ExtractState({ from: 'itx.hash', to: 'newBlock', status: 'OK', table: 'rollupBlock' }));
-runner.use((context, next) => {
-  if (context.newBlock) {
-    return next(new Error('INVALID_TX', `Rollup block with height ${context.itx.height} already exists`));
-  }
-
-  return next();
-});
-
-// 7. verify token state
-runner.use(
-  pipes.ExtractState({ from: 'rollupState.tokenAddress', to: 'tokenState', status: 'INVALID_TOKEN', table: 'token' })
-);
-
-// 8. verify txs
-runner.use(pipes.ExtractState({ from: 'itx.txsList', to: 'txStates', status: 'INVALID_TX', table: 'tx' }));
-runner.use(({ itx, txStates }, next) => {
-  const normalTxTypes = ['deposit_token_v2', 'withdraw_token_v2'];
-  const governanceTxTypes = ['pause_rollup', 'resume_rollup', 'migrate_rollup'];
-
-  // ensure not finalized
-  const finalizedTx = txStates.some((x) => x.finalized);
-  if (finalizedTx) {
-    return next(new Error('INVALID_TX', 'Should not include finalized tx in later block'));
-  }
-
-  // ensure tx are successfully executed
-  const invalidStatusTx = txStates.some((x) => x.code !== 'OK');
-  if (invalidStatusTx) {
-    return next(new Error('INVALID_TX', 'Rollup block can only include successful executed transactions'));
-  }
-
-  // ensure governance block only contains governance tx
-  if (itx.governance) {
-    if (txStates.some((x) => governanceTxTypes.includes(x.type) === false)) {
-      return next(
-        new Error('INVALID_TX', `Governance block can only include governance txs: ${governanceTxTypes.join(',')}`)
-      );
-    }
-  } else {
-    // ensure tx type for normal block
-    const invalidTypeTx = txStates.some((x) => normalTxTypes.includes(x.type) === false);
-    if (invalidTypeTx) {
-      return next(new Error('INVALID_TX', `Rollup block can only include normal txs: ${normalTxTypes.join(',')}`));
-    }
-  }
-
-  // ensure rollup belonging
-  const invalidRollupTx = txStates.some((x) => x.tx.itxJson.rollup !== itx.rollup);
-  if (invalidRollupTx) {
-    return next(new Error('INVALID_TX', `Rollup block can only include tx from rollup ${itx.rollup}`));
-  }
-
-  // ensure merkleRoot: deposit_token tx not included in the merkleTree
-  const merkleTree = MerkleTree.getBlockMerkleTree(
-    txStates
-      .map((x) => {
-        if (x.type === 'withdraw_token_v2') {
-          return { hash: x.hash, to: x.tx.itxJson.to, amount: x.tx.itxJson.token.value };
-        }
-        if (x.type === 'pause_rollup') {
-          return { hash: x.hash, to: MerkleTree.BLACK_HOLE, amount: '0' };
-        }
-        if (x.type === 'resume_rollup') {
-          return { hash: x.hash, to: MerkleTree.BLACK_HOLE, amount: '0' };
-        }
-        if (x.type === 'migrate_rollup') {
-          return { hash: x.hash, to: x.tx.itxJson.to, amount: '0' };
-        }
-        return null;
-      })
-      .filter(Boolean)
-  );
-  if (merkleTree.getHexRoot() !== itx.merkleRoot) {
-    return next(new Error('INVALID_TX', 'Invalid rollup block merkle root'));
-  }
-
-  return next();
-});
-
-// 9. verify staking: used for minting & burning
-runner.use((context, next) => {
-  const { itx, txStates } = context;
-
-  const depositProposerStakeAddr = txStates
-    .filter((x) => x.type === 'deposit_token_v2')
-    .map((x) => toStakeAddress(x.tx.itxJson.proposer, itx.rollup));
-
-  const withdrawLockerStakeAddr = txStates
-    .filter((x) => x.type === 'withdraw_token_v2')
-    .map((x) => toStakeAddress(x.tx.from, itx.rollup));
-
-  context.stakeAddress = [...depositProposerStakeAddr, ...withdrawLockerStakeAddr, getRewardLocker(itx.rollup)];
-
-  return next();
-});
-runner.use(
-  pipes.ExtractState({ from: 'stakeAddress', to: 'stakeStates', status: 'INVALID_STAKE_STATE', table: 'stake' })
-);
-
-// 10. ensure block reward and dynamic tx fees
-runner.use((context, next) => {
-  const { itx, txStates, rollupState } = context;
-  try {
-    const result = ensureBlockReward(rollupState, itx.minReward, txStates);
-    context.senders = Object.keys(result.accountUpdates);
-    Object.assign(context, result);
-    return next();
-  } catch (err) {
-    return next(err);
-  }
-});
-runner.use(
-  pipes.ExtractState({ from: 'senders', to: 'senderStates', status: 'INVALID_SENDER_STATE', table: 'account' })
-);
-
-// Ensure tx fee and gas
-runner.use(
-  EnsureTxGas((context) => {
-    const result = { create: 1, update: 2, payment: 0 };
-
-    result.update += context.stakeStates.filter((x) => context.stakeUpdates[x.address]).length;
-    result.update += context.txStates.length;
-    result.update += (context.senderStates || []).length;
-
-    return result;
-  })
-);
-runner.use(EnsureTxCost({ attachSenderChanges: true }));
-
-// Save context snapshot before updating states
-runner.use(pipes.TakeStateSnapshot());
-
-// 11. update state: mint tokens for deposits, burn tokens for withdraws
-runner.use(
-  async (context, next) => {
-    const {
-      tx,
-      itx,
-      statedb,
-      rollupState,
-      senderState,
-      stakeStates,
-      txStates,
-      formattedItx,
-      senderUpdates,
-      updateVaults,
-    } = context;
-    const senderStates = context.senderStates || [];
-
-    const [newSenderState, newStakeStates, newSenderStates, newRollupState, rollupBlockState, newTxStates] =
-      await Promise.all([
-        // update sender(proposer) account
-        statedb.account.update(
-          senderState.address,
-          account.update(senderState, { nonce: tx.nonce, ...senderUpdates }, 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
-            )
-          )
-        ),
-
-        // 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
-        ),
-
-        // 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))
-        ),
-      ]);
-
-    await updateVaults();
-
-    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.push(...cloneDeep(Object.values(context.stakeUpdates)));
-    context.updatedAccounts.push(...cloneDeep(Object.values(context.accountUpdates)));
-
-    debug('create-rollup-block', { itx, updatedAccounts: context.updatedAccounts });
-
-    next();
-  },
-  { persistError: true }
-);
-
-runner.use(pipes.VerifyStateDiff());
-
-module.exports = runner;