@ocap/tx-protocols 1.28.9 → 1.29.0

package/lib/protocols/asset/consume.js

@@ -1,105 +0,0 @@
-const { CustomError: Error } = require('@ocap/util/lib/error');
-const { Joi } = require('@arcblock/validator');
-const { Runner, pipes } = require('@ocap/tx-pipeline');
-const { account, asset } = require('@ocap/state');
-
-const debug = require('debug')(`${require('../../../package.json').name}:consume-asset`);
-
-const EnsureTxGas = require('../../pipes/ensure-gas');
-const EnsureTxCost = require('../../pipes/ensure-cost');
-
-const runner = new Runner();
-
-// Verify itx
-const schema = Joi.object({
-  address: Joi.DID().prefix().role('ROLE_ASSET').required(),
-  data: Joi.any().optional().allow(null),
-}).options({ stripUnknown: true, noDefaults: false });
-runner.use((context, next) => {
-  const { itx } = context;
-  const { error } = schema.validate(itx);
-  if (error) {
-    return next(new Error('INVALID_TX', `Invalid itx: ${error.message}`));
-  }
-
-  return next();
-});
-
-// Ensure asset exist
-runner.use(pipes.ExtractState({ from: 'itx.address', to: 'assetState', status: 'INVALID_ASSET', table: 'asset' }));
-
-// Ensure asset can be consumed
-runner.use((context, next) => {
-  const { issuer, consumedTime } = context.assetState;
-  if (!issuer) {
-    return next(new Error('INVALID_TX', 'Asset without issuer can not be consumed'));
-  }
-  if (consumedTime) {
-    return next(new Error('INVALID_TX', `Asset already consumed on ${consumedTime}`));
-  }
-
-  return next();
-});
-
-// 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 owner/issuer exist
-runner.use(
-  pipes.ExtractState({ from: 'assetState.issuer', to: 'issuerState', status: 'INVALID_ISSUER_STATE', table: 'account' })
-);
-runner.use(
-  pipes.ExtractState({ from: 'assetState.owner', to: 'ownerState', status: 'INVALID_OWNER_STATE', table: 'account' })
-);
-runner.use((context, next) => {
-  context.signerStates = [context.ownerState, context.issuerState];
-  context.signers = [context.ownerState.address, context.issuerState.address];
-  return next();
-});
-
-// Ensure owner and issuer signed: and not migrated
-runner.use(pipes.VerifyMultiSigV2({ signersKey: 'signers' }));
-runner.use(pipes.VerifyAccountMigration({ signerKey: 'signerStates' }));
-
-// 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 asset state
-runner.use(
-  async (context, next) => {
-    const { tx, itx, txTime, statedb, senderState, senderUpdates, assetState, updateVaults } = context;
-
-    const [newSenderState, newAssetState] = await Promise.all([
-      // update sender state
-      statedb.account.update(
-        senderState.address,
-        account.update(senderState, { nonce: tx.nonce, pk: tx.pk, ...senderUpdates }, context),
-        context
-      ),
-
-      // update asset state
-      statedb.asset.update(itx.address, asset.update(assetState, { consumedTime: txTime }, context), context),
-    ]);
-
-    await updateVaults();
-
-    context.senderState = newSenderState;
-    context.assetState = newAssetState;
-
-    debug('consume', newAssetState);
-
-    next();
-  },
-  { persistError: true }
-);
-
-runner.use(pipes.VerifyStateDiff());
-
-module.exports = runner;

package/lib/protocols/asset/create.js

@@ -1,151 +0,0 @@
-const { CustomError: Error } = require('@ocap/util/lib/error');
-const cloneDeep = require('lodash/cloneDeep');
-const { Runner, pipes } = require('@ocap/tx-pipeline');
-const { account, asset, delegation } = require('@ocap/state');
-const { formatMessage } = require('@ocap/message');
-const { toAssetAddress } = require('@arcblock/did-util');
-
-const debug = require('debug')(`${require('../../../package.json').name}:create-asset`);
-
-const { decodeAnySafe, getDelegationRequirements } = require('../../util');
-
-const EnsureTxGas = require('../../pipes/ensure-gas');
-const EnsureTxCost = require('../../pipes/ensure-cost');
-
-const runner = new Runner();
-
-// Verify itx
-runner.use((context, next) => {
-  const itx = formatMessage('CreateAssetTx', context.itx);
-  const { error } = asset.schema.validate(itx);
-  if (error) {
-    return next(new Error('INVALID_TX', `Invalid itx: ${error.message}`));
-  }
-  return next();
-});
-runner.use(
-  pipes.VerifyInfo([
-    {
-      error: 'INVALID_ASSET',
-      message: 'Asset address is not valid',
-      fn: (context) => {
-        const itx = cloneDeep(context.itx);
-        itx.data = decodeAnySafe(itx.data);
-        itx.address = '';
-
-        // Save for later use
-        context.assetData = itx.data;
-        context.signers = [itx.issuer].filter(Boolean);
-
-        return toAssetAddress(itx) === context.itx.address;
-      },
-    },
-  ])
-);
-
-// Ensure issuer signed
-runner.use(pipes.VerifyMultiSigV2({ signersKey: 'signers' }));
-
-// Ensure asset not exist
-runner.use(pipes.ExtractState({ from: 'itx.address', to: 'assetState', status: 'OK' }));
-runner.use(
-  pipes.VerifyInfo([
-    {
-      error: 'INVALID_ASSET',
-      message: 'This asset already exist on chain',
-      fn: (context) => !context.assetState,
-    },
-  ])
-);
-
-// Ensure issuer exist
-runner.use(
-  pipes.ExtractState({ from: 'itx.issuer', to: 'issuerState', status: 'INVALID_ISSUER_STATE', table: 'account' })
-);
-runner.use(pipes.VerifyAccountMigration({ signerKey: 'issuerState' }));
-
-// 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,
-  })
-);
-
-// Check if parent is a factory
-runner.use(pipes.ExtractState({ from: 'itx.parent', to: 'factoryState', status: 'OK', table: 'factory' }));
-runner.use(
-  pipes.VerifyInfo([
-    // For security consideration, user can not create fake assets from a factory
-    // https://github.com/ArcBlock/blockchain/issues/97
-    {
-      error: 'CREATE_FROM_FACTORY',
-      message: 'You can only get asset from factory from acquire or mint',
-      fn: ({ itx, factoryState }) => !(itx.parent && factoryState),
-      persist: true,
-    },
-  ])
-);
-
-// Ensure parent exist
-runner.use(pipes.ExtractState({ from: 'itx.parent', to: 'parentAsset', status: 'INVALID_ASSET', table: 'asset' }));
-
-// Ensure tx fee and gas
-runner.use(EnsureTxGas(() => ({ create: 1, update: 2, payment: 0 })));
-runner.use(EnsureTxCost({ attachSenderChanges: true }));
-
-// Save context snapshot before updating states
-runner.use(pipes.TakeStateSnapshot());
-
-// Update asset state
-runner.use(
-  async (context, next) => {
-    const { tx, itx, assetData, statedb, senderState, delegatorState, delegationState, senderUpdates, updateVaults } =
-      context;
-    const owner = delegatorState ? delegatorState.address : senderState.address;
-
-    const [newSenderState, assetState, newDelegationState] = await Promise.all([
-      statedb.account.update(
-        senderState.address,
-        account.update(senderState, { nonce: tx.nonce, pk: tx.pk, ...senderUpdates }, context),
-        context
-      ),
-
-      statedb.asset.create(
-        itx.address,
-        asset.create({ ...itx, tags: itx.tagsList, data: assetData, owner }, context),
-        context
-      ),
-
-      // Update delegation state
-      context.isDelegationChanged
-        ? statedb.delegation.update(delegationState.address, delegation.update(delegationState, {}, context), context)
-        : delegationState,
-    ]);
-
-    await updateVaults();
-
-    context.senderState = newSenderState;
-    context.assetState = assetState;
-    context.delegationState = newDelegationState;
-
-    debug('createAsset', assetState);
-
-    next();
-  },
-  { persistError: true }
-);
-
-runner.use(pipes.VerifyStateDiff());
-
-module.exports = runner;

package/lib/protocols/asset/mint.js

@@ -1,199 +0,0 @@
-const { Runner, pipes } = require('@ocap/tx-pipeline');
-const { CustomError: Error } = require('@ocap/util/lib/error');
-const { Joi, schemas } = require('@arcblock/validator');
-const { account, asset, factory } = require('@ocap/state');
-
-const debug = require('debug')(`${require('../../../package.json').name}:mint-asset`);
-
-const verifyMintLimit = require('./pipes/verify-mint-limit');
-const verifyItxVariables = require('./pipes/verify-itx-variables');
-const verifyItxAssets = require('./pipes/verify-itx-assets');
-const verifyItxAddress = require('./pipes/verify-itx-address');
-
-const runner = new Runner();
-
-const EnsureTxGas = require('../../pipes/ensure-gas');
-const EnsureTxCost = require('../../pipes/ensure-cost');
-
-runner.use(pipes.VerifyMultiSig(0));
-
-// verify itx
-const schema = Joi.object({
-  factory: Joi.DID().prefix().role('ROLE_FACTORY').required(),
-  address: Joi.DID().prefix().role('ROLE_ASSET').required(),
-  assetsList: Joi.array().items(Joi.DID().prefix().role('ROLE_ASSET')).default([]),
-  variablesList: Joi.array().items(schemas.variableInput).optional().allow(null).default([]),
-  owner: schemas.tokenHolder.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();
-});
-
-// ensure asset not exist
-runner.use(pipes.ExtractState({ from: 'itx.address', to: 'duplicateAsset', status: 'OK', table: 'asset' }));
-runner.use(
-  pipes.VerifyInfo([
-    {
-      error: 'FORBIDDEN',
-      message: 'Asset with same address already exists',
-      fn: ({ duplicateAsset }) => !duplicateAsset,
-      persist: true,
-    },
-  ])
-);
-
-// 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 factory exist
-runner.use(
-  pipes.ExtractState({ from: 'itx.factory', to: 'factoryState', status: 'INVALID_FACTORY_STATE', table: 'factory' })
-);
-runner.use(
-  pipes.ExtractState({
-    from: 'factoryState.owner',
-    to: 'factoryOwnerState',
-    status: 'INVALID_ISSUER_STATE',
-    table: 'account',
-  })
-);
-
-// Ensure issuer exist: read them here because some maybe migrated
-runner.use(
-  pipes.ExtractState({
-    from: 'factoryState.trustedIssuers',
-    to: 'issuerStates',
-    status: 'INVALID_ISSUER_STATE',
-    table: 'account',
-  })
-);
-
-runner.use(pipes.ExtractState({ from: 'itx.owner', to: 'ownerState', status: 'OK', table: 'account' }));
-runner.use(pipes.VerifyBlocked({ stateKeys: ['ownerState'] }));
-runner.use(
-  pipes.VerifyInfo([
-    {
-      error: 'FORBIDDEN',
-      message: 'Only factory owner and trusted issuers are allowed to mint',
-      fn: ({ factoryOwnerState, senderState, issuerStates }) =>
-        senderState.address === factoryOwnerState.address ||
-        issuerStates.find((x) => x.address === senderState.address),
-      persist: true,
-    },
-  ])
-);
-
-// Prepare for itx.assets verify
-runner.use(pipes.ExtractState({ from: 'itx.assetsList', to: 'assetStates', status: 'OK', table: 'asset' }));
-runner.use(
-  pipes.ExtractState({
-    from: 'factoryState.input.assets',
-    to: 'expectedFactoryStates',
-    status: 'OK',
-    table: 'factory',
-  })
-);
-
-runner.use(verifyMintLimit);
-runner.use(verifyItxVariables);
-runner.use(verifyItxAddress('mint'));
-runner.use(pipes.VerifyUpdater({ assetKey: 'assetStates', ownerKey: 'ownerState' }));
-runner.use(verifyItxAssets);
-
-// Ensure tx fee and gas
-runner.use(
-  EnsureTxGas((context) => {
-    const result = { create: 1, update: 2, payment: 0 };
-    if (!context.ownerState) {
-      result.create += 1;
-    }
-    if (context.assetStates) {
-      result.update += context.assetStates.length;
-    }
-
-    return result;
-  })
-);
-runner.use(EnsureTxCost({ attachSenderChanges: true }));
-
-// Save context snapshot before updating states
-runner.use(pipes.TakeStateSnapshot());
-
-// update statedb
-runner.use(
-  async (context, next) => {
-    const {
-      tx,
-      itx,
-      txTime,
-      statedb,
-      senderState,
-      factoryState,
-      mintedAsset,
-      mintedAddress,
-      ownerState,
-      senderUpdates,
-      assetStates = [],
-      updateVaults,
-      ownerAddress,
-    } = context;
-
-    const factoryUpdates = { numMinted: factoryState.numMinted + 1 };
-
-    const [newSenderState, newReceiverState, assetState, newFactoryState, newAssetStates] = await Promise.all([
-      // update sender
-      statedb.account.update(
-        senderState.address,
-        account.update(senderState, { nonce: tx.nonce, pk: tx.pk, ...senderUpdates }, context),
-        context
-      ),
-
-      // create receiver if not exist: asset owner
-      ownerState
-        ? Promise.resolve(ownerState)
-        : statedb.account.create(ownerAddress, account.create({ address: ownerAddress }, context), context),
-
-      // create asset
-      statedb.asset.create(
-        itx.address,
-        asset.create({ ...mintedAsset, owner: ownerAddress, address: mintedAddress }, context),
-        context
-      ),
-
-      // update factory
-      statedb.factory.update(factoryState.address, factory.update(factoryState, factoryUpdates, context), context),
-
-      // mark input assets as consumed
-      Promise.all(
-        assetStates.map((x) =>
-          statedb.asset.update(x.address, asset.update(x, { consumedTime: txTime }, context), context)
-        )
-      ),
-    ]);
-
-    await updateVaults();
-
-    context.senderState = newSenderState;
-    context.receiverState = newReceiverState;
-    context.assetState = assetState;
-    context.factoryState = newFactoryState;
-    context.assetStates = newAssetStates;
-
-    debug('mint', assetState);
-
-    next();
-  },
-  { persistError: true }
-);
-
-runner.use(pipes.VerifyStateDiff());
-
-module.exports = runner;

package/lib/protocols/asset/pipes/exec-mint-hook.js

@@ -1,62 +0,0 @@
-// contract calls
-const cloneDeep = require('lodash/cloneDeep');
-const transferCall = require('../calls/transfer');
-const transferTokenCall = require('../calls/transfer-token');
-
-const contractCalls = {
-  transfer: transferCall,
-  transferToken: transferTokenCall,
-};
-
-module.exports = async (context, next) => {
-  const { statedb, factoryState, tokenUpdates, config } = context;
-
-  if (factoryState.settlement === 'instant') {
-    const mintHook = factoryState.hooks.find((x) => x.name === 'mint');
-    if (mintHook && mintHook.type === 'contract') {
-      context.updatedAccounts = context.updatedAccounts || [];
-
-      // These calls must be run sequentially, because different calls may update same account
-      const clone = cloneDeep(mintHook.compiled);
-      const mintHookStates = {};
-      for (const x of clone) {
-        // Convert transfer to transferToken call for backwards compatibility
-        if (x.call === 'transfer') {
-          x.call = 'transferToken';
-          x.args.tokenAddress = config.token.address;
-        }
-
-        const pipeline = contractCalls[x.call];
-        const { updateSet } = await pipeline.runAsync({
-          states: context.states,
-          statedb,
-          txn: context.txn,
-          txTime: context.txTime,
-          txHash: context.txHash,
-          logger: context.logger,
-          args: x.args,
-        });
-
-        mintHookStates[updateSet.address] = await statedb.account.update(updateSet.address, updateSet.updates, context);
-        context.updatedAccounts.push(updateSet);
-      }
-
-      context.mintHookStates = Object.values(mintHookStates);
-    }
-  } else {
-    context.receipts = [
-      {
-        address: factoryState.address,
-        changes: Object.keys(tokenUpdates.tokens)
-          .map((x) => ({
-            target: x,
-            action: 'transfer',
-            value: tokenUpdates.tokens[x],
-          }))
-          .filter((x) => x.value > 0),
-      },
-    ];
-  }
-
-  next();
-};

package/lib/protocols/asset/pipes/extract-factory-tokens.js

@@ -1,18 +0,0 @@
-const uniqBy = require('lodash/uniqBy');
-const { BN } = require('@ocap/util');
-const { createSortedList } = require('@ocap/util/lib/create-sorted-list');
-
-// Create token requirements from factoryState
-module.exports = (context, next) => {
-  const { factoryState, config } = context;
-  context.factoryTokens = [...factoryState.input.tokens];
-
-  const exist = context.factoryTokens.find((x) => x.address === config.token.address);
-  if (!exist && new BN(factoryState.input.value).gt(new BN(0))) {
-    context.factoryTokens.push({ address: config.token.address, value: factoryState.input.value });
-  }
-
-  context.factoryTokens = uniqBy(context.factoryTokens, 'address');
-  context.tokenAddress = createSortedList(context.factoryTokens.map((x) => x.address));
-  next();
-};

package/lib/protocols/asset/pipes/verify-itx-address.js

@@ -1,54 +0,0 @@
-const { CustomError: Error } = require('@ocap/util/lib/error');
-const { mintFromFactory } = require('@ocap/asset');
-
-const debug = require('debug')('@ocap/tx-protocols:pipes:verify-itx-address');
-
-module.exports = (mode) => (context, next) => {
-  const { itx, senderState, factoryState, delegatorState, factoryInputs } = context;
-
-  let issuer = null;
-  let owner = null;
-
-  if (mode === 'acquire-v2') {
-    owner = delegatorState || senderState;
-    issuer = itx.issuer;
-    context.assetOwner = owner;
-  } else if (mode === 'acquire-v3') {
-    owner = { address: itx.owner };
-    issuer = itx.issuer;
-  } else if (mode === 'mint') {
-    owner = { address: itx.owner };
-    issuer = {
-      id: senderState.address,
-      pk: senderState.pk,
-      name: senderState.moniker,
-    };
-  }
-
-  const minted = mintFromFactory({
-    factory: factoryState,
-    inputs: factoryInputs,
-    owner: owner.address,
-    issuer,
-  });
-
-  if (minted.address !== itx.address) {
-    debug('asset address mismatch', {
-      owner,
-      issuer,
-      minted,
-      itx,
-      factoryInputs,
-      factoryState,
-      senderState,
-      delegatorState,
-    });
-    return next(new Error('INVALID_ASSET', 'Invalid itx.address: does not match with minted asset address'));
-  }
-
-  context.ownerAddress = owner.address;
-  context.mintedAsset = minted.asset;
-  context.mintedAddress = minted.address;
-
-  return next();
-};

package/lib/protocols/asset/pipes/verify-itx-assets.js

@@ -1,51 +0,0 @@
-const { CustomError: Error } = require('@ocap/util/lib/error');
-const { getListField } = require('@ocap/util/lib/get-list-field');
-
-module.exports = (context, next) => {
-  const { factoryState, expectedFactoryStates = [], assetStates: actualAssetStates = [], itx } = context;
-  const { assets: expectedAssets } = factoryState.input;
-
-  if (expectedAssets.length === 0) {
-    return next();
-  }
-
-  const inputAssets = getListField(itx, 'assets');
-
-  // Are all input assets found on chain?
-  if (inputAssets.length > actualAssetStates.length) {
-    return next(new Error('INVALID_ASSET', 'Input asset does not exist on chain'));
-  }
-
-  // https://github.com/ArcBlock/blockchain/issues/96
-  // If factory.input.assets are all factory
-  if (expectedFactoryStates.length === expectedAssets.length) {
-    // Just ensure that input assets are minted from any of the factory
-    // They do not need to match on number
-    if (actualAssetStates.every((x) => x.parent && expectedAssets.includes(x.parent)) === false) {
-      return next(new Error('INVALID_ASSET', 'Input asset not minted from any of factory.input.assets'));
-    }
-    if (actualAssetStates.every((x) => !x.consumedTime) === false) {
-      return next(new Error('INVALID_ASSET', 'Some input asset already consumed'));
-    }
-
-    return next();
-  }
-
-  // For specific assets, they must not be consumed
-  // For factory, they must exist on chain
-  for (const address of expectedAssets) {
-    const plainAsset = actualAssetStates.find((x) => x.address === address);
-    if (plainAsset) {
-      if (plainAsset.consumedTime) {
-        return next(new Error('INVALID_ASSET', `Input asset ${address} already consumed`));
-      }
-    } else {
-      const childAsset = actualAssetStates.find((x) => x.parent === address);
-      if (!childAsset) {
-        return next(new Error('INVALID_ASSET', `Input asset not found ${address}`));
-      }
-    }
-  }
-
-  return next();
-};

package/lib/protocols/asset/pipes/verify-itx-variables.js

@@ -1,26 +0,0 @@
-const { CustomError: Error } = require('@ocap/util/lib/error');
-const { getListField } = require('@ocap/util/lib/get-list-field');
-
-module.exports = (context, next) => {
-  const { factoryState, itx } = context;
-  const { variables } = factoryState.input;
-
-  // validate input variables
-  const factoryInputs = getListField(itx, 'variables').reduce((acc, x) => {
-    acc[x.name] = x.value;
-    return acc;
-  }, {});
-  const missingVariables = variables.filter((x) => x.required && !factoryInputs[x.name]);
-  if (missingVariables.length) {
-    return next(
-      new Error(
-        'INVALID_FACTORY_INPUT',
-        `Invalid itx.variables: missing required input variable: ${missingVariables.map((x) => x.name).join(', ')}`
-      )
-    );
-  }
-
-  context.factoryInputs = factoryInputs;
-
-  return next();
-};

package/lib/protocols/asset/pipes/verify-mint-limit.js

@@ -1,13 +0,0 @@
-const { CustomError: Error } = require('@ocap/util/lib/error');
-
-module.exports = ({ factoryState }, next) => {
-  if (factoryState.limit === 0) {
-    return next();
-  }
-
-  if (factoryState.numMinted < factoryState.limit) {
-    return next();
-  }
-
-  return next(new Error('EXCEED_MINT_LIMIT', 'This request will exceed factory mint limit'));
-};