@ocap/tx-protocols 1.28.9 → 1.29.1

package/lib/protocols/account/delegate.js

@@ -1,223 +0,0 @@
-const get = require('lodash/get');
-const cloneDeep = require('lodash/cloneDeep');
-const pick = require('lodash/pick');
-const { Joi } = require('@arcblock/validator');
-const { CustomError: Error } = require('@ocap/util/lib/error');
-const { delegation, account } = require('@ocap/state');
-const { Runner, pipes } = require('@ocap/tx-pipeline');
-const { toDelegateAddress } = require('@arcblock/did-util');
-const { formatMessage } = require('@ocap/message');
-
-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));
-
-const rateLimit = Joi.object({
-  interval: Joi.number().integer().greater(0).required(),
-  anchor: Joi.number().integer().min(0).optional().allow(null).default(0),
-});
-
-const tokenLimit = Joi.object({
-  address: Joi.DID().prefix().role('ROLE_TOKEN').required(),
-  toList: Joi.array().items(Joi.DID().prefix()).max(32).unique().optional().allow(null).default([]),
-  txCount: Joi.number().integer().min(0).empty('').optional().allow(null).default(0),
-  txAllowance: Joi.BN().optional().allow(null).default('0'),
-  totalAllowance: Joi.BN().optional().allow(null).default('0'),
-  validUntil: Joi.number().integer().min(0).empty('').optional().allow(null).default(0),
-  rate: rateLimit.optional().allow(null),
-});
-
-const assetLimit = Joi.object({
-  address: Joi.array()
-    .items(Joi.DID().prefix().role('ROLE_ASSET'))
-    .unique()
-    .max(1024)
-    .optional()
-    .allow(null)
-    .default([]),
-  toList: Joi.array().items(Joi.DID().prefix()).unique().max(32).optional().allow(null).default([]),
-  txCount: Joi.number().integer().min(0).empty('').optional().allow(null).default(0),
-  validUntil: Joi.number().integer().min(0).empty('').optional().allow(null).default(0),
-  rate: rateLimit.optional().allow(null),
-});
-
-// verify itx
-const schema = Joi.object({
-  address: Joi.DID().prefix().role('ROLE_DELEGATION').required(),
-  to: Joi.DID().prefix().required(),
-  opsList: Joi.array()
-    .items(
-      Joi.object({
-        typeUrl: Joi.string().required(),
-        limit: Joi.object({
-          tokensList: Joi.array()
-            .items(tokenLimit)
-            .unique((a, b) => a.address === b.address)
-            .max(32),
-          assetsList: Joi.array().items(assetLimit).max(32),
-        })
-          .optional()
-          .allow(null)
-          .default({ tokensList: [], assetsList: [] }),
-      })
-    )
-    .unique((a, b) => a.typeUrl === b.typeUrl)
-    .min(1)
-    .required(),
-  data: Joi.any().optional().allow(null),
-}).options({ stripUnknown: true, noDefaults: false });
-runner.use((context, next) => {
-  const { error, value } = schema.validate(context.itx);
-  if (error) {
-    return next(new Error('INVALID_TX', `Invalid itx: ${error.message}`));
-  }
-  context.formattedItx = formatMessage('DelegateTx', context.itx);
-  context.validatedItx = value;
-  return next();
-});
-runner.use(
-  pipes.VerifyInfo([
-    {
-      error: 'INVALID_TX',
-      message: 'Delegation address does not match',
-      fn: ({ itx, tx }) => toDelegateAddress(tx.from, itx.to) === itx.address,
-    },
-    {
-      error: 'INVALID_DELEGATION_TYPE_URL',
-      message: 'Delegation type url is not allowed',
-      fn: ({ formattedItx, config }) => {
-        const allowed = get(config, 'transaction.delegate.typeUrls', []);
-        return formattedItx.ops.every((op) => allowed.includes(op.typeUrl));
-      },
-    },
-  ])
-);
-
-// Ensure sender exist and not migrated
-runner.use(pipes.ExtractState({ from: 'tx.from', to: 'senderState', status: 'OK', table: 'account' }));
-runner.use(pipes.VerifyAccountMigration({ stateKey: 'senderState', addressKey: 'tx.from' }));
-
-// Ensure receiver exist and not migrated
-runner.use(pipes.ExtractState({ from: 'itx.to', to: 'receiverState', status: 'OK', table: 'account' }));
-runner.use(pipes.VerifyBlocked({ stateKeys: ['receiverState'] }));
-runner.use(pipes.VerifyAccountMigration({ stateKey: 'receiverState', addressKey: 'itx.to' }));
-
-// Ensure sender and receiver are not the same
-runner.use(pipes.AntiLandAttack({ senderState: 'senderState', receiverState: 'receiverState' }));
-
-// 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 }));
-
-// Save context snapshot before updating states
-runner.use(pipes.TakeStateSnapshot());
-
-// Create delegation state
-runner.use(
-  async (context, next) => {
-    const {
-      tx,
-      itx,
-      formattedItx,
-      validatedItx,
-      statedb,
-      senderState,
-      receiverState,
-      delegationState,
-      senderUpdates,
-      updateVaults,
-    } = context;
-
-    const merged = cloneDeep(formattedItx.ops).reduce(
-      (acc, x, i) => {
-        acc[x.typeUrl] = {
-          // This performs a reset of the limit
-          limit: {
-            tokens: (x.limit?.tokens || []).map((y, j) => {
-              const input = validatedItx.opsList[i].limit.tokensList[j];
-              return Object.assign(y, pick(input, ['txCount', 'txAllowance', 'totalAllowance', 'validUntil', 'rate']), {
-                txSent: 0,
-                lastTx: y.rate ? y.rate.anchor : 0,
-                spentAllowance: '0',
-              });
-            }),
-            assets: (x.limit?.assets || []).map((y, j) => {
-              const input = validatedItx.opsList[i].limit.assetsList[j];
-              return Object.assign(y, pick(input, ['txCount', 'validUntil', 'rate']), {
-                txSent: 0,
-                lastTx: y.rate ? y.rate.anchor : 0,
-              });
-            }),
-          },
-        };
-        return acc;
-      },
-      delegationState ? delegationState.ops : {}
-    );
-
-    const sender = senderState ? senderState.address : tx.from;
-    const receiver = receiverState ? receiverState.address : itx.to;
-
-    const [newSenderState, newReceiverState, newDelegationState] = await Promise.all([
-      // update sender
-      statedb.account.updateOrCreate(
-        senderState,
-        account.updateOrCreate(senderState, { ...senderUpdates, address: sender, nonce: tx.nonce, pk: tx.pk }, context),
-        context
-      ),
-
-      // update receiver
-      receiverState
-        ? Promise.resolve(receiverState)
-        : statedb.account.create(
-            receiver,
-            account.create({ address: receiver, tokens: { [context.config.token.address]: '0' } }, context),
-            context
-          ),
-
-      delegationState
-        ? statedb.delegation.update(itx.address, delegation.update(delegationState, { ...itx, from: sender, ops: merged }, context), context)
-        : statedb.delegation.create(itx.address, delegation.create({ ...itx, from: sender, ops: merged }, context), context),
-    ]);
-
-    await updateVaults();
-
-    debug(delegationState ? 'update' : 'create', newDelegationState);
-
-    // Update context
-    context.senderState = newSenderState;
-    context.receiverState = newReceiverState;
-    context.delegationState = newDelegationState;
-
-    return next();
-  },
-  { persistError: true }
-);
-
-runner.use(pipes.VerifyStateDiff());
-
-module.exports = runner;

package/lib/protocols/account/migrate.js

@@ -1,153 +0,0 @@
-const uniq = require('lodash/uniq');
-const flatten = require('lodash/flatten');
-const { CustomError: Error } = require('@ocap/util/lib/error');
-const { Joi } = require('@arcblock/validator');
-const { getRelatedAddresses } = require('@ocap/util/lib/get-related-addr');
-const { Runner, pipes } = require('@ocap/tx-pipeline');
-const { fromPublicKey, toTypeInfo } = require('@arcblock/did');
-const { account } = require('@ocap/state');
-const {
-  types: { RoleType },
-} = require('@ocap/mcrypto');
-
-const debug = require('debug')(`${require('../../../package.json').name}:migrate`);
-
-const EnsureTxGas = require('../../pipes/ensure-gas');
-const EnsureTxCost = require('../../pipes/ensure-cost');
-const { decodeAnySafe } = require('../../util');
-
-const runner = new Runner();
-
-runner.use(pipes.VerifyMultiSig(0));
-
-// verify itx
-const schema = Joi.object({
-  address: Joi.DID().prefix().required(),
-  pk: Joi.any().required(),
-  data: Joi.any().optional().allow(null),
-}).options({ stripUnknown: true, noDefaults: false });
-runner.use(({ itx }, next) => {
-  const { error } = schema.validate(itx);
-  if (error) {
-    return next(new Error('INVALID_TX', `Invalid itx: ${error.message}`));
-  }
-  return next();
-});
-runner.use(
-  pipes.VerifyInfo([
-    {
-      error: 'INVALID_RECEIVER_STATE',
-      message: 'Receiver pk and address does not match',
-      fn: ({ itx, tx }) => fromPublicKey(itx.pk, toTypeInfo(itx.address)) === itx.address && itx.address !== tx.from,
-    },
-  ])
-);
-
-// Ensure sender exist
-runner.use(pipes.ExtractState({ from: 'tx.from', to: 'senderState', status: 'OK', table: 'account' }));
-runner.use(pipes.VerifyAccountMigration({ stateKey: 'senderState', addressKey: 'tx.from' }));
-
-// Ensure tx fee and gas
-runner.use(
-  EnsureTxGas((context) => {
-    const { itx, senderState, tx } = context;
-    const isApplicationMigration = [senderState?.address || tx.from, itx.address].every(
-      (address) => toTypeInfo(address).role === RoleType.ROLE_APPLICATION
-    );
-
-    // Do not charge gas for migration between applications
-    if (isApplicationMigration) {
-      Object.defineProperty(context, 'txBaseGas', { value: false });
-      return { create: 0, update: 0, payment: 0 };
-    }
-
-    // Do not charge gas for connecting wallet from application
-    if (itx.data) {
-      const decoded = decodeAnySafe(itx.data);
-      if (decoded?.value && decoded.value.purpose === 'connect-wallet') {
-        Object.defineProperty(context, 'txBaseGas', { value: false });
-        return { create: 0, update: 0, payment: 0 };
-      }
-    }
-
-    return {
-      create: context.senderState ? 1 : 2,
-      update: context.senderState ? getRelatedAddresses(context.senderState).length : 0,
-      payment: 0,
-    };
-  })
-);
-runner.use(EnsureTxCost({ attachSenderChanges: true, throwOnInsufficientFund: false }));
-
-// Save context snapshot before updating states
-runner.use(pipes.TakeStateSnapshot());
-
-// Create account state, and update old accounts
-runner.use(
-  async (context, next) => {
-    const { tx, itx, statedb, senderUpdates, updateVaults } = context;
-
-    const sender = context.senderState;
-    const receiver = await statedb.account.get(itx.address, context);
-    const senderTokens = sender?.tokens || { [context.config.token.address]: '0' };
-    const senderAddress = sender?.address || tx.from;
-
-    // Ensure receiver does not exist
-    if (receiver) {
-      return next(new Error('INVALID_RECEIVER_STATE', 'Can not migrate to an existing account'));
-    }
-
-    // Create new account
-    const newAccount = await statedb.account.create(
-      itx.address,
-      account.create(
-        {
-          ...(sender || { tokens: senderTokens }), // copy all old account data to new account
-          ...senderUpdates,
-          address: itx.address,
-          pk: itx.pk,
-          migratedFrom: sender ? uniq(flatten([sender.address, ...sender.migratedFrom])) : [senderAddress],
-        },
-        context
-      ),
-      context
-    );
-    debug('new account', newAccount);
-
-    // Update old accounts
-    const addresses = sender ? getRelatedAddresses(sender) : [senderAddress];
-    const states = await Promise.all(
-      addresses.map(async (address) => {
-        let state = null;
-        if (address === senderAddress) {
-          state = account.updateOrCreate(
-            sender,
-            { address, tokens: senderTokens, migratedTo: itx.address, nonce: tx.nonce },
-            context
-          );
-          await statedb.account.updateOrCreate(sender, state, context);
-        } else {
-          const old = await statedb.account.get(address, { traceMigration: false, txn: context.txn });
-          state = account.update(old, { migratedTo: itx.address }, context);
-          await statedb.account.update(address, state, context);
-        }
-
-        return state;
-      })
-    );
-    debug('old accounts', states);
-
-    await updateVaults();
-
-    // Update context
-    context.receiverState = newAccount;
-    context.senderState = states.find((x) => x.address === senderAddress);
-
-    return next();
-  },
-  { persistError: true }
-);
-
-runner.use(pipes.VerifyStateDiff());
-
-module.exports = runner;

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

@@ -1,110 +0,0 @@
-const get = require('lodash/get');
-const cloneDeep = require('lodash/cloneDeep');
-const { Joi } = require('@arcblock/validator');
-const { CustomError: Error } = require('@ocap/util/lib/error');
-const { getListField } = require('@ocap/util/lib/get-list-field');
-const { Runner, pipes } = require('@ocap/tx-pipeline');
-const { delegation, account } = require('@ocap/state');
-const { toDelegateAddress } = require('@arcblock/did-util');
-
-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));
-
-// Verify itx
-const schema = Joi.object({
-  address: Joi.DID().prefix().role('ROLE_DELEGATION').required(),
-  to: Joi.DID().prefix().required(),
-  typeUrlsList: Joi.array().items(Joi.string().required()).min(1).required(),
-  data: Joi.any().optional().allow(null),
-}).options({ stripUnknown: true, noDefaults: false });
-runner.use(({ itx }, next) => {
-  const { error } = schema.validate(itx);
-  if (error) {
-    return next(new Error('INVALID_TX', `Invalid itx: ${error.message}`));
-  }
-  return next();
-});
-runner.use(
-  pipes.VerifyInfo([
-    {
-      error: 'OK',
-      fn: (context) => {
-        context.typeUrls = getListField(context, 'itx.typeUrls');
-        return true;
-      },
-    },
-    {
-      error: 'INVALID_TX',
-      message: 'Delegation address does not match',
-      fn: ({ itx, tx }) => toDelegateAddress(tx.from, itx.to) === itx.address,
-    },
-    {
-      error: 'INVALID_DELEGATION_TYPE_URL',
-      message: 'Delegation type url is not allowed',
-      fn: ({ typeUrls, config }) => {
-        const allowed = get(config, 'transaction.delegate.typeUrls', []);
-        return typeUrls.every((x) => allowed.includes(x));
-      },
-    },
-  ])
-);
-
-// Ensure sender/receiver/delegation exist
-runner.use(
-  pipes.ExtractState({ from: 'itx.address', to: 'delegationState', status: 'INVALID_DELEGATION', table: 'delegation' })
-);
-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 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());
-
-// Update delegation state
-runner.use(
-  async (context, next) => {
-    const { tx, itx, typeUrls, statedb, senderState, senderUpdates, delegationState, updateVaults } = context;
-
-    debug('update', { address: itx.address, typeUrls });
-
-    const newOps = cloneDeep(delegationState.ops);
-    typeUrls.forEach((x) => delete newOps[x]);
-
-    const [newSenderState, newDelegationState] = await Promise.all([
-      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
-      ),
-    ]);
-
-    await updateVaults();
-
-    // Update context
-    context.senderState = newSenderState;
-    context.delegationState = newDelegationState;
-
-    return next();
-  },
-  { persistError: true }
-);
-
-runner.use(pipes.VerifyStateDiff());
-
-module.exports = runner;