@ocap/tx-protocols 1.13.57 → 1.13.61

package/lib/protocols/account/declare.js

@@ -1,27 +1,27 @@
-const isEmpty = require('empty-value');
+const Error = require('@ocap/util/lib/error');
 const { Runner, pipes } = require('@ocap/tx-pipeline');
-const { account } = require('@ocap/state');
+const { account, Joi } = require('@ocap/state');
 const { toBase58 } = require('@ocap/util');
 
 const runner = new Runner();
 
 runner.use(pipes.VerifyMultiSig(0));
 
-// Verify itx
-runner.use(
-  pipes.VerifyInfo([
-    {
-      error: 'INSUFFICIENT_DATA',
-      message: 'Can not declare without moniker',
-      fn: ({ itx }) => !isEmpty(itx.moniker),
-    },
-    {
-      error: 'INVALID_MONIKER',
-      message: 'Moniker is not valid',
-      fn: ({ itx }) => /^[a-zA-Z0-9][-a-zA-Z0-9_]{2,40}$/.test(itx.moniker),
-    },
-  ])
-);
+// verify itx
+const schema = Joi.object({
+  issuer: Joi.DID().optional().allow(''),
+  moniker: Joi.string()
+    .regex(/^[a-zA-Z0-9][-a-zA-Z0-9_]{2,40}$/)
+    .required(),
+  data: Joi.any().optional(),
+}).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 sender does not exist
 runner.use(pipes.ExtractState({ from: 'tx.from', to: 'senderState' }));

package/lib/protocols/account/delegate.js

@@ -1,8 +1,8 @@
 /* eslint-disable max-len */
 const get = require('lodash/get');
-const isEmpty = require('empty-value');
+const Error = require('@ocap/util/lib/error');
 const getListField = require('@ocap/util/lib/get-list-field');
-const { delegation, account } = require('@ocap/state');
+const { delegation, account, Joi } = require('@ocap/state');
 const { Runner, pipes } = require('@ocap/tx-pipeline');
 const { toDelegateAddress } = require('@arcblock/did-util');
 
@@ -13,6 +13,27 @@ const runner = new Runner();
 
 runner.use(pipes.VerifyMultiSig(0));
 
+// verify itx
+const schema = Joi.object({
+  address: Joi.DID().role('ROLE_DELEGATION').required(),
+  to: Joi.DID().required(),
+  opsList: Joi.array()
+    .items(
+      Joi.object({
+        typeUrl: Joi.string().required(),
+      })
+    )
+    .min(1)
+    .required(),
+  data: Joi.any().optional(),
+}).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([
     {
@@ -22,11 +43,6 @@ runner.use(
         return true;
       },
     },
-    {
-      error: 'INSUFFICIENT_DATA',
-      message: 'itx.address, itx.to and itx.ops should not be empty',
-      fn: ({ itx, ops }) => !isEmpty(itx.address) && !isEmpty(itx.to) && ops.length > 0,
-    },
     {
       error: 'INVALID_TX',
       message: 'Delegation address does not match',

package/lib/protocols/account/migrate.js

@@ -1,9 +1,8 @@
-const isEmpty = require('empty-value');
 const Error = require('@ocap/util/lib/error');
 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 { account, Joi } = require('@ocap/state');
 
 // eslint-disable-next-line global-require
 const debug = require('debug')(`${require('../../../package.json').name}:migrate`);
@@ -12,14 +11,21 @@ const runner = new Runner();
 
 runner.use(pipes.VerifyMultiSig(0));
 
-// Verify itx
+// verify itx
+const schema = Joi.object({
+  address: Joi.DID().required(),
+  pk: Joi.any().required(),
+  data: Joi.any().optional(),
+}).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: 'INSUFFICIENT_DATA',
-      message: 'itx.address and itx.pk should not be empty',
-      fn: ({ itx }) => !isEmpty(itx.pk) && !isEmpty(itx.address),
-    },
     {
       error: 'INVALID_RECEIVER_STATE',
       message: 'Receiver pk and address does not match',

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

@@ -1,9 +1,8 @@
 const get = require('lodash/get');
 const cloneDeep = require('lodash/cloneDeep');
-const isEmpty = require('empty-value');
 const getListField = require('@ocap/util/lib/get-list-field');
 const { Runner, pipes } = require('@ocap/tx-pipeline');
-const { delegation, account } = require('@ocap/state');
+const { delegation, account, Joi } = require('@ocap/state');
 const { toDelegateAddress } = require('@arcblock/did-util');
 
 // eslint-disable-next-line global-require
@@ -14,6 +13,19 @@ const runner = new Runner();
 runner.use(pipes.VerifyMultiSig(0));
 
 // Verify itx
+const schema = Joi.object({
+  address: Joi.DID().role('ROLE_DELEGATION').required(),
+  to: Joi.DID().required(),
+  typeUrlsList: Joi.array().items(Joi.string().required()).min(1).required(),
+  data: Joi.any().optional(),
+}).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([
     {
@@ -23,11 +35,6 @@ runner.use(
         return true;
       },
     },
-    {
-      error: 'INSUFFICIENT_DATA',
-      message: 'itx.address, itx.to and itx.typeUrls should not be empty',
-      fn: ({ itx, typeUrls }) => !isEmpty(itx.address) && !isEmpty(itx.to) && typeUrls.length > 0,
-    },
     {
       error: 'INVALID_TX',
       message: 'Delegation address does not match',

package/lib/protocols/asset/create.js

@@ -1,8 +1,8 @@
 /* eslint-disable indent */
-const isEmpty = require('empty-value');
+const Error = require('@ocap/util/lib/error');
 const cloneDeep = require('lodash/cloneDeep');
 const { Runner, pipes } = require('@ocap/tx-pipeline');
-const { account, asset } = require('@ocap/state');
+const { account, asset, Joi } = require('@ocap/state');
 const { toAssetAddress } = require('@arcblock/did-util');
 
 // eslint-disable-next-line global-require
@@ -14,18 +14,26 @@ const runner = new Runner();
 
 runner.use(pipes.VerifyMultiSig(0));
 
+// Verify itx
+const schema = Joi.object({
+  moniker: Joi.string().min(2).max(255).required(),
+  data: Joi.any().required(),
+  readonly: Joi.boolean().default(false),
+  transferrable: Joi.boolean().default(false),
+  ttl: Joi.number().min(0).default(0),
+  parent: Joi.DID().optional().allow(''),
+  address: Joi.DID().role('ROLE_ASSET').required(),
+  issuer: Joi.DID().optional().allow(''),
+}).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: 'INSUFFICIENT_DATA',
-      message: 'itx.address, itx.moniker and itx.data must not be empty',
-      fn: ({ itx }) => itx.address && itx.moniker && itx.data,
-    },
-    {
-      error: 'INVALID_MONIKER',
-      message: 'Length of asset moniker should between 2 and 255 characters',
-      fn: ({ itx }) => itx.moniker.length >= 2 && itx.moniker.length <= 255,
-    },
     {
       error: 'INVALID_ASSET',
       message: 'Asset address is not valid',
@@ -50,7 +58,7 @@ runner.use(
     {
       error: 'INVALID_ASSET',
       message: 'This asset already exist on chain',
-      fn: (context) => isEmpty(context.assetState),
+      fn: (context) => !context.assetState,
     },
   ])
 );

package/lib/protocols/asset/update.js

@@ -1,5 +1,6 @@
+const Error = require('@ocap/util/lib/error');
 const { Runner, pipes } = require('@ocap/tx-pipeline');
-const { account, asset } = require('@ocap/state');
+const { account, asset, Joi } = require('@ocap/state');
 
 // eslint-disable-next-line global-require
 const debug = require('debug')(`${require('../../../package.json').name}:update-asset`);
@@ -10,20 +11,19 @@ const runner = new Runner();
 
 runner.use(pipes.VerifyMultiSig(0));
 
-runner.use(
-  pipes.VerifyInfo([
-    {
-      error: 'INSUFFICIENT_DATA',
-      message: 'itx.data, itx.moniker and itx.address must not be empty',
-      fn: ({ itx }) => itx.address && itx.moniker && itx.data,
-    },
-    {
-      error: 'INVALID_MONIKER',
-      message: 'Length of asset moniker should between 2 and 255 characters',
-      fn: ({ itx }) => itx.moniker.length >= 2 && itx.moniker.length <= 255,
-    },
-  ])
-);
+// Verify itx
+const schema = Joi.object({
+  address: Joi.DID().role('ROLE_ASSET').required(),
+  moniker: Joi.string().min(2).max(255).required(),
+  data: Joi.any().optional(),
+}).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 exist owned by sender and can be modified
 runner.use(pipes.ExtractState({ from: 'itx.address', to: 'assetState', status: 'INVALID_ASSET' }));

package/lib/protocols/rollup/claim-reward.js

@@ -9,10 +9,10 @@ const { account, stake, evidence, rollupBlock, Joi } = require('@ocap/state');
 // eslint-disable-next-line global-require
 const debug = require('debug')(`${require('../../../package.json').name}:claim-block-reward`);
 
+const { toStakeAddress } = require('@arcblock/did-util');
 const VerifySigners = require('./pipes/verify-signers');
-const { applyTokenChange, splitBlockReward, getBlockRewardLocker } = require('../../util');
+const { applyTokenChange, splitTxFee, getBNSum, getRewardLocker, RATE_BASE } = require('../../util');
 
-const ZERO = new BN(0);
 const runner = new Runner();
 
 // 1. verify itx
@@ -39,12 +39,21 @@ runner.use((context, next) => {
     return next(new Error('INVALID_TX', 'itx.publisher must be same with tx.from'));
   }
 
-  context.lockerAddress = getBlockRewardLocker(itx.rollup);
+  context.lockerAddress = getRewardLocker(itx.rollup);
 
   return next();
 });
 
-// 2. verify rollup and block state
+// 2. ensure evidence not exist
+runner.use(pipes.ExtractState({ from: 'itx.evidence.hash', to: 'evidenceSeen', status: 'OK', table: 'evidence' }));
+runner.use(pipes.ExtractState({ from: 'itx.blockHash', to: 'blockClaimed', status: 'OK', table: 'evidence' }));
+runner.use(({ evidenceSeen, blockClaimed }, next) => {
+  if (evidenceSeen) return next(new Error('INVALID_TX', 'Claim evidence already seen on this chain'));
+  if (blockClaimed) return next(new Error('INVALID_TX', 'Block reward already claimed before this tx'));
+  return next();
+});
+
+// 3. verify rollup and block state
 runner.use(pipes.ExtractState({ from: 'itx.rollup', to: 'rollupState', status: 'INVALID_ROLLUP', table: 'rollup' }));
 runner.use(pipes.ExtractState({ from: 'itx.blockHash', to: 'blockState', status: 'INVALID_ROLLUP_BLOCK', table: 'rollupBlock' })); // prettier-ignore
 runner.use((context, next) => {
@@ -55,24 +64,28 @@ runner.use((context, next) => {
   if (blockState.height !== itx.blockHeight) {
     return next(new Error('INVALID_TX', 'Rollup block height does not match'));
   }
+
+  // If the publisher is not the producer, he should wait at least rollupState.publishWaitingPeriod
+  if (blockState.proposer !== itx.publisher) {
+    const proposedAt = +new Date(blockState.context.genesisTime);
+    const publishedAt = +new Date(context.txTime);
+    if (proposedAt + rollupState.publishWaitingPeriod * 1000 > publishedAt) {
+      return next(new Error('INVALID_TX', 'Rollup block can only be published by producer during waiting period'));
+    }
+  }
+
+  context.producerStake = toStakeAddress(blockState.proposer, itx.rollup);
+
   return next();
 });
 
-// 3. verify tx signers & signatures
+// 4. verify tx signers & signatures
 runner.use(VerifySigners({ signersKey: 'tx.signaturesList', allowSender: true }));
 runner.use(pipes.VerifyMultiSigV2({ signersKey: 'signers' }));
 
-// 4. verify block reward locker
+// 5. verify block reward locker
 runner.use(pipes.ExtractState({ from: 'lockerAddress', to: 'lockerState', status: 'INVALID_LOCKER_STATE', table: 'stake' })); // prettier-ignore
-
-// 5. ensure evidence not exist
-runner.use(pipes.ExtractState({ from: 'itx.evidence.hash', to: 'evidenceSeen', status: 'OK', table: 'evidence' }));
-runner.use(pipes.ExtractState({ from: 'itx.blockHash', to: 'blockClaimed', status: 'OK', table: 'evidence' }));
-runner.use(({ evidenceSeen, blockClaimed }, next) => {
-  if (evidenceSeen) return next(new Error('INVALID_TX', 'Claim evidence already seen on this chain'));
-  if (blockClaimed) return next(new Error('INVALID_TX', 'Block reward already claimed before this tx'));
-  return next();
-});
+runner.use(pipes.ExtractState({ from: 'producerStake', to: 'stakeState', status: 'INVALID_STAKE_STATE', table: 'stake' })); // prettier-ignore
 
 // 6. verify sender and signer states
 runner.use(pipes.ExtractState({ from: 'tx.from', to: 'senderState', status: 'INVALID_SENDER_STATE', table: 'account' })); // prettier-ignore
@@ -85,8 +98,7 @@ runner.use(pipes.ExtractState({ from: 'rollupState.tokenAddress', to: 'tokenStat
 // 8. split and aggregate block reward for each tx and the block
 runner.use(pipes.ExtractState({ from: 'blockState.txs', to: 'txs', status: 'INVALID_TX', table: 'tx' }));
 runner.use(async (context, next) => {
-  const { itx, txs, rollupState, blockState, lockerState, tokenState } = context;
-  const { depositFeeRate, withdrawFeeRate, minDepositFee, maxDepositFee, minWithdrawFee, maxWithdrawFee } = rollupState;
+  const { itx, txs, rollupState, blockState, lockerState, tokenState, stakeState } = context;
   const { proposerFeeShare, publisherFeeShare } = rollupState;
 
   const shares = {
@@ -95,23 +107,28 @@ runner.use(async (context, next) => {
     validator: 10000 - publisherFeeShare - proposerFeeShare,
   };
 
-  // 1. loop through the tx and split reward
   const changes = { account: [], stake: [] };
+
+  // 0. handle slash case
+  // TODO: the producer stake balance should be enough for slashing
+  const shouldSlash = blockState.proposer !== itx.publisher;
+  if (shouldSlash) {
+    const slashAmount = new BN(rollupState.minStakeAmount).mul(new BN(rollupState.publishSlashRate)).div(RATE_BASE);
+    const slashShare = slashAmount.div(new BN(2));
+    changes.stake.push({ address: stakeState.address, delta: `-${slashAmount.toString(10)}`, action: 'slash' });
+    changes.stake.push({ address: lockerState.address, delta: slashShare.toString(10), action: 'slash' });
+    changes.account.push({ address: itx.publisher, delta: slashShare.toString(10), action: 'reward' });
+  }
+
+  // 1. loop through the tx and split reward
   txs.forEach((x) => {
-    const amount = x.tx.itxJson.token.value;
+    const { actualFee } = x.tx.itxJson;
+    const { publisher, proposer, validator } = splitTxFee({ total: actualFee, shares, stringify: false });
+
+    changes.stake.push({ address: lockerState.address, delta: `-${actualFee}`, action: 'claim' });
+    changes.account.push({ address: itx.publisher, delta: publisher.toString(10), action: 'fee' });
+
     if (x.type === 'deposit_token_v2') {
-      const { fee, feeShares } = splitBlockReward({
-        total: amount,
-        feeRate: depositFeeRate,
-        maxFee: maxDepositFee,
-        minFee: minDepositFee,
-        shares,
-        stringify: false,
-      });
-      changes.stake.push({ address: lockerState.address, delta: `-${fee}`, action: 'claim' });
-
-      const { publisher, proposer, validator } = feeShares;
-      changes.account.push({ address: itx.publisher, delta: publisher.toString(10), action: 'fee' });
       changes.account.push({ address: x.tx.itxJson.proposer, delta: proposer.toString(10), action: 'fee' });
 
       // block and tx signers share the validator part
@@ -122,18 +139,6 @@ runner.use(async (context, next) => {
         changes.account.push({ address: v, delta: validatorShare.toString(10), action: 'fee' })
       );
     } else if (x.type === 'withdraw_token_v2') {
-      const { fee, feeShares } = splitBlockReward({
-        total: amount,
-        feeRate: withdrawFeeRate,
-        maxFee: maxWithdrawFee,
-        minFee: minWithdrawFee,
-        shares,
-        stringify: false,
-      });
-      changes.stake.push({ address: lockerState.address, delta: `-${fee}`, action: 'claim' });
-
-      const { publisher, proposer, validator } = feeShares;
-      changes.account.push({ address: itx.publisher, delta: publisher.toString(10), action: 'fee' });
       changes.account.push({ address: blockState.proposer, delta: proposer.toString(10), action: 'fee' });
 
       // block signers share the validator part
@@ -157,7 +162,7 @@ runner.use(async (context, next) => {
       acc[x] = {
         address: x,
         token: tokenState.address,
-        delta: grouped.stake[x].reduce((a, u) => a.add(new BN(u.delta)), ZERO),
+        delta: getBNSum(...grouped.stake[x].map((c) => c.delta)),
         action: grouped.stake[x][grouped.stake[x].length - 1].action,
       };
       return acc;
@@ -166,7 +171,7 @@ runner.use(async (context, next) => {
       acc[x] = {
         address: x,
         token: tokenState.address,
-        delta: grouped.account[x].reduce((a, u) => a.add(new BN(u.delta)), ZERO),
+        delta: getBNSum(...grouped.account[x].map((c) => c.delta)),
         action: grouped.account[x][grouped.account[x].length - 1].action,
       };
       return acc;
@@ -179,8 +184,6 @@ runner.use(async (context, next) => {
   return next();
 });
 
-// TODO: verify locker balance
-
 // 9. extract all accounts that will be updated exist
 runner.use((context, next) => {
   const { updates, senderState, signerStates } = context;
@@ -208,17 +211,23 @@ runner.use((context, next) => {
 });
 
 // 10. update state
-// FIXME: (future) we have a low probability of encounter QLDB 40 documents in a single transaction limit
 runner.use(
   async (context, next) => {
-    const { tx, itx, updates, statedb, senderState, blockState, lockerState, accountStates } = context;
-
-    // This balance from the locker will be checked when apply updates
-    const lockerUpdates = applyTokenChange(lockerState, updates.stake[lockerState.address]);
+    const { tx, itx, updates, statedb, senderState, blockState, lockerState, stakeState, accountStates } = context;
 
-    const [newAccountStates, newLockerState, newBlockState] = await Promise.all([
-      // update locker state
-      statedb.stake.update(lockerState.address, stake.update(lockerState, lockerUpdates, context), context),
+    const [newStakeStates, newAccountStates, newBlockState] = await Promise.all([
+      // update stake states
+      Promise.all(
+        [lockerState, stakeState].map((x) =>
+          updates.stake[x.address]
+            ? statedb.stake.update(
+                x.address,
+                stake.update(x, applyTokenChange(x, updates.stake[x.address]), context),
+                context
+              )
+            : x
+        )
+      ),
 
       // update accounts(proposer, publisher, validator)
       Promise.all(
@@ -254,12 +263,12 @@ runner.use(
       ),
     ]);
 
-    context.updatedAccounts = cloneDeep([...Object.values(updates.account), ...Object.values(updates.stake)]);
-    context.updatedAccounts.forEach((x) => (x.delta = x.delta.toString(10))); // eslint-disable-line
+    context.stakeStates = newStakeStates;
     context.accountStates = newAccountStates;
-    context.stakeState = newLockerState;
     context.blockState = newBlockState;
 
+    context.updatedAccounts = cloneDeep([...Object.values(updates.account), ...Object.values(updates.stake)]);
+
     debug('claim-block-reward', itx);
 
     next();