@ocap/tx-protocols 1.28.9 → 1.29.0

package/lib/protocols/asset/acquire-v2.js

@@ -1,262 +0,0 @@
-const { promisify } = require('node:util');
-const { Runner, pipes } = require('@ocap/tx-pipeline');
-const { account, asset, factory, delegation } = require('@ocap/state');
-const { CustomError: Error } = require('@ocap/util/lib/error');
-const { Joi, schemas } = require('@arcblock/validator');
-
-const debug = require('debug')(`${require('../../../package.json').name}:acquire-asset-v2`);
-
-// custom pipes
-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 execMintHook = require('./pipes/exec-mint-hook');
-const extractFactoryTokens = require('./pipes/extract-factory-tokens');
-
-const EnsureTxGas = require('../../pipes/ensure-gas');
-const EnsureTxCost = require('../../pipes/ensure-cost');
-
-const { applyTokenUpdates, applyTokenChange } = require('../../util');
-
-const verifyTokenBalance = promisify(pipes.VerifyTokenBalance({ ownerKey: 'senders', conditionKey: 'conditions' }));
-
-const runner = new Runner();
-
-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([]),
-  issuer: schemas.nftIssuer.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,
-    },
-  ])
-);
-
-runner.use(
-  pipes.ExtractState({ from: 'tx.from', to: 'senderState', status: 'INVALID_SENDER_STATE', table: 'account' })
-);
-runner.use(pipes.VerifyAccountMigration({ stateKey: 'senderState', addressKey: 'tx.from' }));
-
-runner.use(pipes.ExtractState({ from: 'tx.delegator', to: 'delegatorState', status: 'OK' }));
-runner.use(
-  pipes.ExtractState({ from: 'itx.factory', to: 'factoryState', status: 'INVALID_FACTORY_STATE', table: 'factory' })
-);
-runner.use(
-  pipes.VerifyDelegation({
-    type: 'signature',
-    signerKey: 'senderState',
-    delegatorKey: 'delegatorState',
-    getRequirements: (context) => context.factoryState.input.tokens.map((x) => ({ type: 'token', ...x })),
-  })
-);
-
-runner.use(
-  pipes.ExtractState({
-    from: 'factoryState.owner',
-    to: 'factoryOwnerState',
-    status: 'INVALID_OWNER_STATE',
-    table: 'account',
-  })
-);
-runner.use(
-  pipes.ExtractState({
-    from: 'factoryState.trustedIssuers',
-    to: 'issuerStates',
-    status: 'INVALID_ISSUER_STATE',
-    table: 'account',
-  })
-);
-runner.use(
-  pipes.ExtractState({ from: 'itx.issuer.id', to: 'issuerState', status: 'INVALID_ISSUER_STATE', table: 'account' })
-);
-runner.use(pipes.VerifyAccountMigration({ stateKey: 'issuerState', addressKey: 'itx.issuer.id' }));
-
-runner.use(
-  pipes.VerifyInfo([
-    {
-      error: 'FORBIDDEN',
-      message: 'Only factory owner and trusted issuers are allowed',
-      fn: ({ issuerState, factoryOwnerState, issuerStates = [] }) => {
-        return (
-          factoryOwnerState.address === issuerState.address ||
-          issuerStates.find((x) => x.address === issuerState.address)
-        );
-      },
-      persist: true,
-    },
-  ])
-);
-
-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',
-  })
-);
-
-// Though tokens are verified on factory creating phase, we need them here to construct tokenSymbols
-runner.use(extractFactoryTokens);
-runner.use(pipes.ExtractState({ from: 'tokenAddress', to: 'tokenStates', status: 'INVALID_TOKEN', table: 'token' }));
-
-// Verify itx
-runner.use(verifyMintLimit);
-runner.use(verifyItxVariables);
-runner.use(verifyItxAddress('acquire-v2'));
-runner.use(pipes.VerifyBlocked({ stateKeys: ['assetOwner'] }));
-runner.use(async (context, next) => {
-  const { factoryTokens, senderState } = context;
-  const condition = {
-    owner: senderState.address,
-    tokens: [...factoryTokens],
-  };
-
-  try {
-    await verifyTokenBalance({ senders: [senderState], conditions: [condition] });
-    return next();
-  } catch (err) {
-    return next(err);
-  }
-});
-runner.use(pipes.VerifyUpdater({ assetKey: 'assetStates', ownerKey: 'assetOwner' }));
-runner.use(verifyItxAssets);
-
-// Ensure tx fee and gas
-runner.use(
-  EnsureTxGas((context) => {
-    // FIXME: payment check
-    const result = { create: 1, update: 3, payment: 0 };
-    if (context.assetStates) {
-      result.update += context.assetStates.length;
-    }
-    if (context.delegatorState) {
-      result.update += 1;
-    }
-    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,
-      assetOwner,
-      factoryState,
-      factoryTokens,
-      delegationState,
-      mintedAsset,
-      mintedAddress,
-      senderChange,
-      updateVaults,
-      assetStates = [],
-    } = context;
-
-    // Sender updates
-    const senderUpdates = {
-      nonce: tx.nonce,
-      pk: tx.pk,
-      ...applyTokenUpdates(
-        factoryTokens,
-        senderChange ? applyTokenChange(senderState, senderChange) : senderState,
-        'sub'
-      ),
-    };
-
-    // Owner updates
-    const ownerUpdates = {};
-
-    // Factory updates
-    const factoryUpdates = { numMinted: factoryState.numMinted + 1 };
-    if (factoryState.settlement !== 'instant') {
-      // Move primary/secondary tokens to factory if we are not doing instant settlement
-      Object.assign(factoryUpdates, applyTokenUpdates(factoryTokens, factoryState, 'add'));
-      context.tokenUpdates = applyTokenUpdates(factoryTokens, { tokens: {} }, 'add');
-    }
-
-    const [newSenderState, assetState, newFactoryState, newAssetStates, newDelegationState] = await Promise.all([
-      // Update sender state
-      statedb.account.update(senderState.address, account.update(senderState, senderUpdates, context), context),
-
-      // Create new asset
-      statedb.asset.create(
-        itx.address,
-        asset.create({ ...mintedAsset, owner: assetOwner.address, address: mintedAddress }, context),
-        context
-      ),
-
-      // Update factory state
-      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)
-        )
-      ),
-
-      // Update delegation state
-      context.isDelegationChanged
-        ? statedb.delegation.update(delegationState.address, delegation.update(delegationState, {}, context), context)
-        : delegationState,
-
-      // Update delegator state
-      context.delegatorState
-        ? statedb.account.update(assetOwner.address, account.update(assetOwner, ownerUpdates, context), context)
-        : null,
-    ]);
-
-    await updateVaults();
-
-    context.senderState = newSenderState;
-    context.assetState = assetState;
-    context.factoryState = newFactoryState;
-    context.assetStates = newAssetStates;
-    context.delegationState = newDelegationState;
-
-    debug('acquire-v2', assetState);
-
-    next();
-  },
-  { persistError: true }
-);
-
-// run minting hooks for instant settlement
-runner.use(execMintHook, { persistError: true });
-
-runner.use(pipes.VerifyStateDiff());
-
-module.exports = runner;

package/lib/protocols/asset/acquire-v3.js

@@ -1,330 +0,0 @@
-const { promisify } = require('node:util');
-const isEqual = require('lodash/isEqual');
-const { BN } = require('@ocap/util');
-const { Runner, pipes } = require('@ocap/tx-pipeline');
-const { account, asset, factory } = require('@ocap/state');
-const { CustomError: Error } = require('@ocap/util/lib/error');
-const { Joi, schemas } = require('@arcblock/validator');
-
-const debug = require('debug')(`${require('../../../package.json').name}:acquire-asset-v3`);
-
-const { applyTokenUpdates, applyTokenChange } = require('../../util');
-
-// custom pipes
-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 execMintHook = require('./pipes/exec-mint-hook');
-const extractFactoryTokens = require('./pipes/extract-factory-tokens');
-
-const EnsureTxGas = require('../../pipes/ensure-gas');
-const EnsureTxCost = require('../../pipes/ensure-cost');
-
-const verifyAssetOwner = promisify(pipes.VerifyUpdater({ assetKey: 'assets', ownerKey: 'owner' }));
-
-const runner = new Runner();
-
-// 1. extract & verify itx input
-const schema = Joi.object({
-  factory: Joi.DID().prefix().role('ROLE_FACTORY').required(),
-  address: Joi.DID().prefix().role('ROLE_ASSET').required(),
-  inputsList: schemas.multiInput.min(1).required(),
-  owner: schemas.tokenHolder.required(),
-  variablesList: Joi.array().items(schemas.variableInput).optional().allow(null).default([]),
-  issuer: schemas.nftIssuer.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,
-    },
-  ])
-);
-runner.use(
-  pipes.VerifyTxInput({
-    fieldKey: 'itx.inputs',
-    inputsKey: 'inputs',
-    sendersKey: 'senders',
-    tokensKey: 'tokens',
-    assetsKey: 'assets',
-  })
-);
-
-// 2. verify itx size: set hard limit here because more inputs leads to longer tx execute time
-runner.use(pipes.VerifyListSize({ listKey: ['inputs', 'senders', 'tokens', 'assets'] }));
-
-// 3. verify multi sig
-runner.use(pipes.VerifyMultiSigV2({ signersKey: 'senders' }));
-
-// 4. verify against factory state
-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_OWNER_STATE',
-    table: 'account',
-  })
-);
-runner.use(
-  pipes.ExtractState({
-    from: 'factoryState.trustedIssuers',
-    to: 'issuerStates',
-    status: 'INVALID_ISSUER_STATE',
-    table: 'account',
-  })
-);
-runner.use(
-  pipes.ExtractState({ from: 'itx.issuer.id', to: 'issuerState', status: 'INVALID_ISSUER_STATE', table: 'account' })
-);
-runner.use(pipes.VerifyAccountMigration({ stateKey: 'issuerState', addressKey: 'itx.issuer.id' }));
-runner.use(
-  pipes.VerifyInfo([
-    {
-      error: 'FORBIDDEN',
-      message: 'Only factory owner and trusted issuers are allowed',
-      fn: ({ issuerState, factoryOwnerState, issuerStates = [] }) => {
-        return (
-          factoryOwnerState.address === issuerState.address ||
-          issuerStates.find((x) => x.address === issuerState.address)
-        );
-      },
-      persist: true,
-    },
-  ])
-);
-runner.use(extractFactoryTokens);
-runner.use(verifyMintLimit);
-runner.use(verifyItxVariables);
-runner.use(
-  pipes.VerifyInfo([
-    {
-      error: 'INVALID_TX',
-      message: 'Input token address does not match with factory input requirement',
-      fn: (ctx) => isEqual(ctx.tokens, ctx.tokenAddress),
-    },
-    {
-      error: 'INVALID_TX',
-      message: 'Input token amount does not match with factory input requirement',
-      fn: ({ inputs, factoryTokens }) => {
-        const inputMap = {};
-
-        inputs.forEach(({ tokensList }) => {
-          tokensList.forEach(({ address, value }) => {
-            if (typeof inputMap[address] === 'undefined') {
-              inputMap[address] = new BN(0);
-            }
-            inputMap[address] = inputMap[address].add(new BN(value));
-          });
-        });
-
-        const expectedTokens = factoryTokens.reduce((acc, x) => {
-          acc[x.address] = new BN(x.value);
-          return acc;
-        }, {});
-
-        return Object.keys(expectedTokens).every((address) => inputMap[address].eq(expectedTokens[address]));
-      },
-    },
-  ])
-);
-
-// 5. verify sender & signer & owner
-runner.use(pipes.ExtractState({ from: 'tx.from', to: 'senderState', status: 'OK', table: 'account' }));
-runner.use(
-  pipes.ExtractState({ from: 'senders', to: 'signerStates', status: 'INVALID_SIGNER_STATE', table: 'account' })
-);
-runner.use(pipes.ExtractState({ from: 'itx.owner', to: 'ownerState', status: 'OK', table: 'account' }));
-runner.use(pipes.VerifyAccountMigration({ signerKey: 'signerStates', stateKey: 'senderState', addressKey: 'tx.from' }));
-runner.use(pipes.VerifyBlocked({ stateKeys: ['signerStates', 'ownerState'] }));
-
-// 6. verify token state and balance
-runner.use(pipes.ExtractState({ from: 'tokens', to: 'tokenStates', status: 'INVALID_TOKEN', table: 'token' }));
-runner.use(pipes.VerifyTokenBalance({ ownerKey: 'signerStates', conditionKey: 'inputs' }));
-
-// 7. verify asset state and ownership
-runner.use(pipes.ExtractState({ from: 'assets', to: 'assetStates', status: 'OK', table: 'asset' }));
-runner.use(async (context, next) => {
-  const { inputs, assetStates = [], signerStates } = context;
-  for (const input of inputs) {
-    const { owner, assetsList } = input;
-    const states = assetStates.filter((x) => assetsList.includes(x.address));
-    const signer = signerStates.find((x) => x.address === owner);
-
-    try {
-      await verifyAssetOwner({ assets: states, owner: signer });
-    } catch (err) {
-      return next(err);
-    }
-  }
-
-  return next();
-});
-runner.use(
-  pipes.ExtractState({
-    from: 'factoryState.input.assets',
-    to: 'expectedFactoryStates',
-    status: 'OK',
-    table: 'factory',
-  })
-);
-
-// Verify itx
-runner.use(verifyItxAddress('acquire-v3'));
-runner.use(verifyItxAssets);
-
-// Ensure tx fee and gas
-runner.use(
-  EnsureTxGas((context) => {
-    // FIXME: payment check
-    const result = { create: 1, update: 2, payment: 0 };
-    if (context.assetStates) {
-      result.update += context.assetStates.length;
-    }
-    if (context.signerStates) {
-      result.update += context.signerStates.length;
-    }
-    if (!context.ownerState) {
-      result.create += 1;
-    }
-    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,
-      inputs,
-      statedb,
-      senderState,
-      ownerState,
-      factoryState,
-      factoryTokens,
-      mintedAsset,
-      mintedAddress,
-      signerStates,
-      senderChange,
-      updateVaults,
-      assetStates = [],
-    } = context;
-
-    const signerUpdates = {};
-    inputs.forEach((x) => {
-      const { owner, tokensList } = x;
-      signerUpdates[owner] = applyTokenUpdates(
-        tokensList,
-        signerStates.find((s) => s.address === owner),
-        'sub'
-      );
-      if (senderChange && owner === senderChange.address) {
-        signerUpdates[owner] = applyTokenChange(signerUpdates[owner], senderChange);
-      }
-    });
-
-    const isAlsoSigner = !!signerUpdates[tx.from];
-    const owner = ownerState ? ownerState.address : itx.owner;
-
-    // Factory updates
-    const factoryUpdates = { numMinted: factoryState.numMinted + 1 };
-
-    // Move primary/secondary tokens to factory if we are not doing instant settlement
-    if (factoryState.settlement !== 'instant') {
-      Object.assign(factoryUpdates, applyTokenUpdates(factoryTokens, factoryState, 'add'));
-      context.tokenUpdates = applyTokenUpdates(factoryTokens, { tokens: {} }, 'add');
-    }
-
-    const [newSenderState, newReceiverState, assetState, newSignerStates, newFactoryState, newAssetStates] =
-      await Promise.all([
-        // update sender
-        statedb.account.updateOrCreate(
-          senderState,
-          account.updateOrCreate(
-            senderState,
-            Object.assign(
-              { address: tx.from, nonce: tx.nonce, pk: tx.pk },
-              signerUpdates[tx.from] || (senderChange ? applyTokenChange(senderState, senderChange) : {})
-            ),
-            context
-          ),
-          context
-        ),
-
-        // create receiver if not exist: asset owner
-        ownerState || owner === tx.from
-          ? Promise.resolve(ownerState)
-          : statedb.account.create(owner, account.create({ address: owner }, context), context),
-
-        // Create asset
-        statedb.asset.create(
-          itx.address,
-          asset.create({ ...mintedAsset, owner, address: mintedAddress }, context),
-          context
-        ),
-
-        // Update signer state
-        Promise.all(
-          signerStates
-            .filter((x) => x.address !== tx.from)
-            .map((x) =>
-              statedb.account.update(x.address, account.update(x, signerUpdates[x.address], context), context)
-            )
-        ),
-
-        // Update factory state
-        statedb.factory.update(factoryState.address, factory.update(factoryState, factoryUpdates, context), context),
-
-        // Mark asset 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 = owner === tx.from ? newSenderState : newReceiverState;
-    context.signerStates = isAlsoSigner ? newSignerStates.concat(newSenderState) : newSignerStates;
-    context.assetState = assetState;
-    context.factoryState = newFactoryState;
-    context.assetStates = newAssetStates;
-
-    debug('acquire-v3', assetState);
-
-    next();
-  },
-  { persistError: true }
-);
-
-// run minting hooks for instant settlement
-runner.use(execMintHook, { persistError: true });
-
-runner.use(pipes.VerifyStateDiff());
-
-module.exports = runner;

package/lib/protocols/asset/calls/README.md

@@ -1,5 +0,0 @@
-# ABOUT
-
-This folder contains reusable pipelines for contract calls.
-
-These pipelines does not actually update the statedb, it just return an `updateSet` for the caller to execute.

package/lib/protocols/asset/calls/transfer-token.js

@@ -1,36 +0,0 @@
-const cloneDeep = require('lodash/cloneDeep');
-const { BN } = require('@ocap/util');
-const { Runner, pipes } = require('@ocap/tx-pipeline');
-
-const debug = require('debug')(`${require('../../../../package.json').name}:acquire-asset:transfer-token`);
-
-const runner = new Runner();
-
-runner.use(pipes.ExtractState({ from: 'args.to', to: 'receiverState', status: 'INVALID_RECEIVER_STATE' }));
-
-runner.use((context, next) => {
-  const { states, receiverState, args } = context;
-  const { tokenAddress, amount } = args;
-
-  const delta = new BN(amount);
-  const newTokens = cloneDeep(receiverState.tokens || {});
-  if (newTokens[tokenAddress]) {
-    const old = new BN(newTokens[tokenAddress]);
-    newTokens[tokenAddress] = old.add(delta).toString();
-  } else {
-    newTokens[tokenAddress] = delta.toString();
-  }
-
-  context.updateSet = {
-    address: receiverState.address,
-    updates: states.account.update(receiverState, { tokens: newTokens }, context),
-    delta: amount,
-    token: tokenAddress,
-  };
-
-  debug('contract.transfer-token', context.updateSet);
-
-  next();
-});
-
-module.exports = runner;

package/lib/protocols/asset/calls/transfer.js

@@ -1,28 +0,0 @@
-const { BN } = require('@ocap/util');
-const { Runner, pipes } = require('@ocap/tx-pipeline');
-
-const debug = require('debug')(`${require('../../../../package.json').name}:acquire-asset:transfer`);
-
-const runner = new Runner();
-
-runner.use(pipes.ExtractState({ from: 'args.to', to: 'receiverState', status: 'INVALID_RECEIVER_STATE' }));
-
-runner.use((context, next) => {
-  const { states, receiverState, args } = context;
-
-  const old = new BN(receiverState.balance);
-  const delta = new BN(args.amount);
-
-  context.updateSet = {
-    address: receiverState.address,
-    updates: states.account.update(receiverState, { balance: old.add(delta).toString() }, context),
-    delta: args.amount,
-    token: '',
-  };
-
-  debug('contract.transfer', context.updateSet);
-
-  next();
-});
-
-module.exports = runner;