@ocap/tx-protocols 1.28.8 → 1.29.0

package/lib/protocols/rollup/pipes/verify-evidence.js

@@ -1,37 +0,0 @@
-const get = require('lodash/get');
-const { CustomError: Error } = require('@ocap/util/lib/error');
-const { toHex } = require('@ocap/util');
-const { toTypeInfo } = require('@arcblock/did');
-const { fromPublicKey } = require('@ocap/wallet');
-
-module.exports = function CreateVerifyEvidencePipe({ evidenceKey, signaturesKey, verifyMethod = 'verify' }) {
-  if (['verify', 'ethVerify'].includes(verifyMethod) === false) {
-    throw new Error(`Invalid verify method: ${verifyMethod}, supported methods are: verify, ethVerify`);
-  }
-
-  return async (context, next) => {
-    const evidence = get(context, evidenceKey);
-    const signatures = get(context, signaturesKey);
-
-    for (const sig of signatures) {
-      const { signer, pk, delegator, signature } = sig;
-
-      // if delegator is empty, pk and signer shall be a pair
-      // if delegator is not empty, pk and delegator shall be a pair
-      const address = delegator || signer;
-      const wallet = fromPublicKey(pk, toTypeInfo(address));
-
-      try {
-        if ((await wallet[verifyMethod](toHex(evidence), toHex(signature))) === false) {
-          return next(new Error('INVALID_SIGNATURE', `Signature for evidence from ${address} is not valid`));
-        }
-      } catch (err) {
-        return next(
-          new Error('INVALID_SIGNATURE', `Signature for evidence from ${address} verify failed: ${err.message}`)
-        );
-      }
-    }
-
-    return next();
-  };
-};

package/lib/protocols/rollup/pipes/verify-signers.js

@@ -1,87 +0,0 @@
-const get = require('lodash/get');
-const { CustomError: Error } = require('@ocap/util/lib/error');
-
-module.exports = function CreateVerifySignersPipe({ signersKey, allowSender = true, allowShrink = false }) {
-  return (context, next) => {
-    const { tx, rollupState } = context;
-    const { minSignerCount, maxSignerCount } = rollupState;
-
-    const signatures = get(context, signersKey);
-    const signerCount = signatures.length;
-
-    const seedValidators = rollupState.seedValidators.map((x) => x.address);
-    const validators = rollupState.validators.map((x) => x.address);
-
-    // ensure singer blacklist
-    if (!allowSender && signatures.some((x) => x.signer === tx.from)) {
-      return next(new Error('INVALID_SIGNATURE', `Invalid: ${signersKey}, sender not allowed to sign`));
-    }
-
-    // ensure signer count
-    // If we have a large validators pool, we expect at least minSignerCount signers
-    if (validators.length > minSignerCount) {
-      if (signerCount < minSignerCount) {
-        return next(
-          new Error(
-            'INVALID_SIGNATURE',
-            `Invalid: ${signersKey}, expect at least ${minSignerCount} signatures, got ${signerCount}`
-          )
-        );
-      }
-      if (signerCount > maxSignerCount) {
-        return next(
-          new Error(
-            'INVALID_SIGNATURE',
-            `Invalid: ${signersKey}, Expect at most ${maxSignerCount} signatures, got ${signerCount}`
-          )
-        );
-      }
-    } else {
-      // If we have a small validators pool, eg, the minSignerCount is 3, and we have only 2 validator,
-      // We expect all validators to sign before we have enough validators
-      // But on some occasions, we need to shrink the signer requirement, such as a validator want to leave a small validator pool.
-      let actualValidatorCount = validators.length;
-      if (!allowSender && allowShrink) {
-        actualValidatorCount -= 1;
-      }
-
-      const expectedSignerCount = Math.min(actualValidatorCount, minSignerCount);
-
-      if (signerCount < expectedSignerCount) {
-        return next(
-          new Error(
-            'INVALID_SIGNATURE',
-            `Invalid ${signersKey}, all validators are expected to sign because we have less than ${expectedSignerCount} validators`
-          )
-        );
-      }
-    }
-
-    // ensure seed validators exist
-    const signers = signatures.map((x) => x.signer);
-    const missingSigner = seedValidators.find((x) => signers.includes(x) === false);
-    if (missingSigner) {
-      return next(
-        new Error(
-          'INVALID_SIGNATURE',
-          `Invalid: ${signersKey}, missing signature from seed validator: ${missingSigner}`
-        )
-      );
-    }
-
-    // ensure signers exist in validators
-    const invalidSigner = signers.find((x) => validators.includes(x) === false);
-    if (invalidSigner) {
-      return next(
-        new Error(
-          'INVALID_SIGNATURE',
-          `Invalid: ${signersKey}, signer ${invalidSigner} does not exist in validator whitelist`
-        )
-      );
-    }
-
-    context.signers = signers;
-
-    return next();
-  };
-};

package/lib/protocols/rollup/pipes/verify-status.js

@@ -1,30 +0,0 @@
-const { pipes } = require('@ocap/tx-pipeline');
-
-module.exports = ({ paused, closed } = {}) => {
-  const fns = [];
-  if (paused === false) {
-    fns.push({
-      error: 'INVALID_TX',
-      message: 'The rollup is paused',
-      fn: (context) => !context.rollupState.paused,
-    });
-  }
-
-  if (paused === true) {
-    fns.push({
-      error: 'INVALID_TX',
-      message: 'The rollup is not paused',
-      fn: (context) => context.rollupState.paused,
-    });
-  }
-
-  if (closed === false) {
-    fns.push({
-      error: 'INVALID_TX',
-      message: 'The rollup is closed',
-      fn: (context) => !context.rollupState.closed,
-    });
-  }
-
-  return pipes.VerifyInfo(fns);
-};

package/lib/protocols/rollup/resume.js

@@ -1,75 +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 } = require('@ocap/state');
-
-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(),
-  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' }));
-
-// Ensure tx fee and gas
-runner.use(EnsureTxGas(() => ({ create: 0, update: 2, payment: 0 })));
-runner.use(EnsureTxCost({ attachSenderChanges: true }));
-
-// Save context snapshot before updating states
-runner.use(pipes.TakeStateSnapshot());
-
-// 5. update rollup state
-runner.use(
-  async (context, next) => {
-    const { tx, itx, rollupState, statedb, senderState, senderUpdates, updateVaults } = context;
-
-    const [newSenderState, newRollupState] = await Promise.all([
-      statedb.account.update(
-        senderState.address,
-        account.update(senderState, { nonce: tx.nonce, ...senderUpdates }, context),
-        context
-      ),
-      statedb.rollup.update(itx.rollup, rollup.resume(rollupState, context), context),
-    ]);
-
-    await updateVaults();
-
-    context.senderState = newSenderState;
-    context.rollupState = newRollupState;
-
-    next();
-  },
-  { persistError: true }
-);
-
-runner.use(pipes.VerifyStateDiff());
-
-module.exports = runner;

package/lib/protocols/rollup/update.js

@@ -1,122 +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 } = require('@ocap/state');
-
-const debug = require('debug')(`${require('../../../package.json').name}:update-rollup`);
-
-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 { decodeAnySafe } = require('../../util');
-
-const runner = new Runner();
-
-// 1. verify itx: client must use previous rollup state to construct this itx
-const schema = Joi.object({
-  rollup: Joi.DID().prefix().role('ROLE_ROLLUP').required(),
-
-  minStakeAmount: Joi.BN().greater(0).required(),
-  maxStakeAmount: Joi.BN().greater(Joi.ref('minStakeAmount')).required(),
-
-  minSignerCount: Joi.number().integer().required(),
-  maxSignerCount: Joi.number().integer().min(1).max(8).greater(Joi.ref('minSignerCount')).required(),
-
-  minBlockSize: Joi.number().integer().min(1).required(),
-  maxBlockSize: Joi.number().integer().min(1).max(10).greater(Joi.ref('minBlockSize')).required(),
-
-  minBlockInterval: Joi.number()
-    .integer()
-    .min(1)
-    .max(60 * 60)
-    .required(),
-  minBlockConfirmation: Joi.number().integer().min(1).max(100).required(),
-
-  minDepositAmount: Joi.BN().positive().required(),
-  maxDepositAmount: Joi.BN().greater(Joi.ref('minDepositAmount')).required(),
-  minWithdrawAmount: Joi.BN().positive().required(),
-  maxWithdrawAmount: Joi.BN().greater(Joi.ref('minWithdrawAmount')).required(),
-
-  depositFeeRate: Joi.number().integer().min(1).max(10000).required(),
-  withdrawFeeRate: Joi.number().integer().min(1).max(10000).required(),
-  publisherFeeShare: Joi.number().integer().min(1).max(10000).required(),
-  minDepositFee: Joi.BN().positive().required(),
-  maxDepositFee: Joi.BN().greater(Joi.ref('minDepositFee')).required(),
-  minWithdrawFee: Joi.BN().positive().required(),
-  maxWithdrawFee: Joi.BN().greater(Joi.ref('minWithdrawFee')).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);
-});
-
-runner.use(
-  pipes.VerifyInfo([
-    {
-      error: 'INVALID_TX',
-      message: 'Sum of itx.proposerFeeShare and itx.publisherFeeShare must be less than 10000',
-      fn: ({ itx }) => itx.proposerFeeShare + itx.publisherFeeShare < 10000,
-    },
-  ])
-);
-
-// 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: 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' }));
-
-// Ensure tx fee and gas
-runner.use(EnsureTxGas(() => ({ create: 0, update: 2, payment: 0 })));
-runner.use(EnsureTxCost({ attachSenderChanges: true }));
-
-// Save context snapshot before updating states
-runner.use(pipes.TakeStateSnapshot());
-
-// 5. update rollup state
-runner.use(
-  async (context, next) => {
-    const { tx, itx, rollupState, statedb, senderState, senderUpdates, updateVaults } = context;
-    const data = decodeAnySafe(itx.data);
-
-    const [newSenderState, newRollupState] = await Promise.all([
-      statedb.account.update(
-        senderState.address,
-        account.update(senderState, { nonce: tx.nonce, ...senderUpdates }, context),
-        context
-      ),
-      statedb.rollup.update(itx.rollup, rollup.update(rollupState, { ...itx, data }, context), context),
-    ]);
-
-    await updateVaults();
-
-    context.senderState = newSenderState;
-    context.rollupState = newRollupState;
-
-    debug('update-rollup', newRollupState);
-
-    next();
-  },
-  { persistError: true }
-);
-
-runner.use(pipes.VerifyStateDiff());
-
-module.exports = runner;

package/lib/protocols/token/create.js

@@ -1,199 +0,0 @@
-const isEmpty = require('empty-value');
-const cloneDeep = require('lodash/cloneDeep');
-const uniq = require('lodash/uniq');
-const { Joi, schemas } = require('@arcblock/validator');
-const { CustomError: Error } = require('@ocap/util/lib/error');
-const { Runner, pipes } = require('@ocap/tx-pipeline');
-const { account, token, delegation } = require('@ocap/state');
-const { toTokenAddress } = require('@arcblock/did-util');
-const { fromTokenToUnit } = require('@ocap/util');
-
-const debug = require('debug')(`${require('../../../package.json').name}:create-token`);
-const { decodeAnySafe, getDelegationRequirements } = require('../../util');
-
-const EnsureTxGas = require('../../pipes/ensure-gas');
-const EnsureTxCost = require('../../pipes/ensure-cost');
-
-const MAX_TOTAL_SUPPLY = fromTokenToUnit(10000 * 100000000, 18); // 32
-
-const runner = new Runner();
-
-runner.use(pipes.VerifyMultiSig(0));
-
-const schema = Joi.object({
-  address: Joi.DID().prefix().role('ROLE_TOKEN').required(),
-  name: Joi.string().min(1).max(32).required(),
-  description: Joi.string().min(16).max(128).required(),
-  symbol: Joi.string().min(2).max(6).uppercase().required(),
-  unit: Joi.string().min(1).max(6).lowercase().required(),
-  decimal: Joi.number().min(2).max(18).required(),
-  icon: Joi.string().optional().allow(null).valid(''),
-  totalSupply: Joi.BN().greater(0).max(MAX_TOTAL_SUPPLY).required(),
-  initialSupply: Joi.BN().greater(0).max(Joi.ref('totalSupply')).required(),
-  maxTotalSupply: Joi.alternatives()
-    .try(Joi.BN().greater(0).max(Joi.ref('totalSupply')), Joi.string().valid(''))
-    .optional()
-    .allow(null),
-  foreignToken: schemas.foreignToken.optional().allow(null).default(null),
-  spendersList: Joi.array().items(Joi.DID().prefix()).max(30).optional().allow(null).default(null),
-  tokenFactoryAddress: Joi.forbidden(),
-  data: Joi.any().optional().allow(null),
-}).options({ stripUnknown: true, noDefaults: false });
-
-// 1. verify itx
-runner.use(({ itx }, next) => {
-  const { error, value } = schema.validate(itx);
-  if (error) {
-    return next(new Error('INVALID_TX', `Invalid itx: ${error.message}`));
-  }
-
-  // convert spendersList to spenders
-  itx.spenders = value.spendersList?.length ? uniq(value.spendersList) : null;
-  delete itx.spendersList;
-
-  return next();
-});
-
-runner.use(
-  pipes.VerifyInfo([
-    {
-      error: 'INVALID_TOKEN',
-      message: 'Token address is not valid',
-      fn: (context) => {
-        const itx = cloneDeep(context.itx);
-        itx.data = decodeAnySafe(itx.data);
-        itx.address = '';
-
-        return toTokenAddress(itx) === context.itx.address;
-      },
-    },
-  ])
-);
-
-// Ensure sender exist
-runner.use(
-  pipes.ExtractState({ from: 'tx.from', to: 'senderState', status: 'INVALID_SENDER_STATE', table: 'account' })
-);
-runner.use(pipes.VerifyAccountMigration({ stateKey: 'senderState', addressKey: 'tx.from' }));
-
-// Ensure delegation
-runner.use(pipes.ExtractState({ from: 'tx.delegator', to: 'delegatorState', status: 'OK', table: 'account' }));
-runner.use(pipes.VerifyAccountMigration({ stateKey: 'delegatorState', addressKey: 'tx.delegator' }));
-runner.use(
-  pipes.VerifyDelegation({
-    type: 'signature',
-    signerKey: 'senderState',
-    delegatorKey: 'delegatorState',
-    getRequirements: getDelegationRequirements,
-  })
-);
-
-// Ensure token not exist
-runner.use(pipes.ExtractState({ from: 'itx.address', to: 'tokenState', table: 'token', status: 'OK' }));
-runner.use(
-  pipes.VerifyInfo([
-    {
-      error: 'DUPLICATE_TOKEN',
-      message: 'Token address already exists on chain',
-      fn: (context) => isEmpty(context.tokenState),
-    },
-  ])
-);
-
-// Ensure uniqueness of token symbol
-runner.use(
-  async function EnsureTokenSymbol(context, next) {
-    const { symbol } = context.config.token;
-    if (symbol.toLowerCase() === context.itx.symbol.toLowerCase()) {
-      return next(new Error('DUPLICATE_SYMBOL', `Token symbol can not be ${symbol}`));
-    }
-
-    const exist = await context.statedb.token.existBySymbol(context.itx.symbol, context);
-    if (exist) {
-      return next(new Error('DUPLICATE_SYMBOL', 'Token symbol already exists'));
-    }
-
-    return next();
-  },
-  { persistError: true }
-);
-
-// Ensure tx fee and gas
-runner.use(
-  EnsureTxGas((context) => {
-    const result = { create: 1, update: 2, payment: 0 };
-    if (context.delegatorState) {
-      result.update += 1;
-    }
-
-    return result;
-  })
-);
-runner.use(EnsureTxCost({ attachSenderChanges: true }));
-
-// Save context snapshot before updating states
-runner.use(pipes.TakeStateSnapshot());
-
-// Update sender state, token state
-runner.use(
-  async (context, next) => {
-    const { tx, itx, statedb, senderState, delegatorState, delegationState, senderUpdates, updateVaults } = context;
-    const data = decodeAnySafe(itx.data);
-    const owner = delegatorState ? delegatorState.address : senderState.address;
-
-    const delegatorUpdates = {};
-    senderUpdates.tokens = senderUpdates.tokens || senderState.tokens;
-
-    // We are definitely creating a different token, so it is safe to set tokens to initial supply
-    // For delegated create-token, the delegator is the actual token-holder
-    if (delegatorState) {
-      delegatorUpdates.tokens = delegatorState.tokens || {};
-      delegatorUpdates.tokens[itx.address] = itx.initialSupply;
-    } else {
-      senderUpdates.tokens[itx.address] = itx.initialSupply;
-    }
-
-    const [newSenderState, tokenState, newDelegatorState, newDelegationState] = await Promise.all([
-      statedb.account.update(
-        senderState.address,
-        account.update(senderState, { nonce: tx.nonce, pk: tx.pk, ...senderUpdates }, context),
-        context
-      ),
-
-      statedb.token.create(
-        itx.address,
-        token.create({ ...cloneDeep(itx), data, issuer: owner, type: 'Token' }, context),
-        context
-      ),
-
-      delegatorState
-        ? statedb.account.update(
-            delegatorState.address,
-            account.update(delegatorState, delegatorUpdates, context),
-            context
-          )
-        : null,
-
-      // Update delegation state
-      context.isDelegationChanged
-        ? statedb.delegation.update(delegationState.address, delegation.update(delegationState, {}, context), context)
-        : delegationState,
-    ]);
-
-    await updateVaults();
-
-    context.senderState = newSenderState;
-    context.tokenState = tokenState;
-    context.delegatorState = newDelegatorState;
-    context.delegationState = newDelegationState;
-
-    debug('create token v2', tokenState);
-
-    next();
-  },
-  { persistError: true }
-);
-
-runner.use(pipes.VerifyStateDiff());
-
-module.exports = runner;