@ocap/tx-protocols 1.23.0 → 1.24.0

package/lib/protocols/token/create.js

@@ -30,6 +30,10 @@ const schema = Joi.object({
   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),
   tokenFactoryAddress: Joi.forbidden(),
   data: Joi.any().optional().allow(null),

package/lib/protocols/token-factory/burn.js

@@ -3,6 +3,7 @@ const { Joi, schemas } = require('@arcblock/validator');
 const { BN, fromUnitToToken } = require('@ocap/util');
 const { Runner, pipes } = require('@ocap/tx-pipeline');
 const { account, tokenFactory, token } = require('@ocap/state');
+const pick = require('lodash/pick');
 
 const EnsureTxGas = require('../../pipes/ensure-gas');
 const EnsureTxCost = require('../../pipes/ensure-cost');
@@ -252,7 +253,7 @@ runner.use(
     }
     // Ensure the sender exists in accountUpdates, because even if there is no balance change, we need to update his nonce
     if (!accountUpdates[tx.from]) {
-      accountUpdates[tx.from] = {};
+      accountUpdates[tx.from] = senderState || {};
     }
 
     // update owner
@@ -281,12 +282,14 @@ runner.use(
           // We can use updateOrCreate here because the owner and signer have already been validated to exist earlier,
           // the sender and receiver are allowed to be created in the transaction.
           const state = [senderState, receiverState, ownerState, ...signerStates].find((x) => x?.address === address);
-          const senderUpdated = address === tx.from ? { nonce: tx.nonce, pk: tx.pk } : {};
-          return statedb.account.updateOrCreate(
-            state,
-            account.updateOrCreate(state, Object.assign({ address }, senderUpdated, updates), context),
-            context
-          );
+
+          // Should only update nonce and pk for sender and new accounts
+          const actualUpdates =
+            address === tx.from || !state
+              ? { ...updates, address, nonce: tx.nonce, pk: tx.pk }
+              : pick(updates, ['tokens']);
+
+          return statedb.account.updateOrCreate(state, account.updateOrCreate(state, actualUpdates, context), context);
         })
       ),
 

package/lib/protocols/token-factory/create.js

@@ -31,6 +31,7 @@ const schema = Joi.object({
     unit: Joi.string().min(1).max(6).lowercase().required(),
     decimal: Joi.number().min(6).max(18).required(),
     icon: Joi.string().optional().allow(null).valid(''),
+    maxTotalSupply: Joi.alternatives().try(Joi.BN().greater(0), Joi.string().valid('')).optional().allow(null),
   }).required(),
   data: Joi.any().optional().allow(null),
 }).options({ stripUnknown: true, noDefaults: false });
@@ -81,10 +82,10 @@ runner.use(
 
 // Ensure symbol is not internal
 runner.use((context, next) => {
-  const { internalSymbols } = context.config;
+  const { reservedSymbols } = context.config;
   const { symbol } = context.itx.token;
 
-  if (internalSymbols.includes(symbol.toUpperCase())) {
+  if (reservedSymbols.includes(symbol.toUpperCase())) {
     return next(new Error('INVALID_SYMBOL', `Token symbol can not be ${symbol}`));
   }
 

package/lib/protocols/token-factory/mint.js

@@ -3,6 +3,7 @@ const { Joi, schemas } = require('@arcblock/validator');
 const { BN, fromUnitToToken } = require('@ocap/util');
 const { Runner, pipes } = require('@ocap/tx-pipeline');
 const { account, tokenFactory, token } = require('@ocap/state');
+const pick = require('lodash/pick');
 
 const EnsureTxGas = require('../../pipes/ensure-gas');
 const EnsureTxCost = require('../../pipes/ensure-cost');
@@ -115,6 +116,26 @@ runner.use(
   })
 );
 
+// verify max supply
+runner.use((context, next) => {
+  const { tokenState, itx } = context;
+
+  if (tokenState.maxTotalSupply) {
+    const availableSupply = new BN(tokenState.maxTotalSupply).sub(new BN(tokenState.totalSupply));
+
+    if (new BN(itx.amount).gt(availableSupply)) {
+      return next(
+        new Error(
+          'INVALID_TOKEN',
+          `Maximum mintable tokens are ${fromUnitToToken(availableSupply, tokenState.decimal)} ${tokenState.symbol}`
+        )
+      );
+    }
+  }
+
+  next();
+});
+
 // verify slippage
 runner.use((context, next) => {
   const { reserveAmount, reserveFee, inputs, tokenFactoryState } = context;
@@ -237,7 +258,7 @@ runner.use(
     }
     // Ensure the sender exists in accountUpdates, because even if there is no balance change, we need to update his nonce
     if (!accountUpdates[tx.from]) {
-      accountUpdates[tx.from] = {};
+      accountUpdates[tx.from] = senderState || {};
     }
 
     // update owner
@@ -266,12 +287,14 @@ runner.use(
           // We can use updateOrCreate here because the owner and signer have already been validated to exist earlier,
           // the sender and receiver are allowed to be created in the transaction.
           const state = [senderState, receiverState, ownerState, ...signerStates].find((x) => x?.address === address);
-          const senderUpdated = address === tx.from ? { nonce: tx.nonce, pk: tx.pk } : {};
-          return statedb.account.updateOrCreate(
-            state,
-            account.updateOrCreate(state, Object.assign({ address }, senderUpdated, updates), context),
-            context
-          );
+
+          // Should only update nonce and pk for sender and new accounts
+          const actualUpdates =
+            address === tx.from || !state
+              ? { ...updates, address, nonce: tx.nonce, pk: tx.pk }
+              : pick(updates, ['tokens']);
+
+          return statedb.account.updateOrCreate(state, account.updateOrCreate(state, actualUpdates, context), context);
         })
       ),
 

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.23.0",
+  "version": "1.24.0",
   "description": "Predefined tx pipeline sets to execute certain type of transactions",
   "main": "lib/index.js",
   "files": [
@@ -18,19 +18,19 @@
     "empty-value": "^1.0.1",
     "lodash": "^4.17.21",
     "url-join": "^4.0.1",
-    "@arcblock/did": "1.23.0",
-    "@arcblock/did-util": "1.23.0",
-    "@arcblock/jwt": "1.23.0",
-    "@arcblock/validator": "1.23.0",
-    "@ocap/asset": "1.23.0",
-    "@ocap/client": "1.23.0",
-    "@ocap/mcrypto": "1.23.0",
-    "@ocap/merkle-tree": "1.23.0",
-    "@ocap/message": "1.23.0",
-    "@ocap/state": "1.23.0",
-    "@ocap/tx-pipeline": "1.23.0",
-    "@ocap/util": "1.23.0",
-    "@ocap/wallet": "1.23.0"
+    "@arcblock/did": "1.24.0",
+    "@arcblock/jwt": "1.24.0",
+    "@ocap/asset": "1.24.0",
+    "@arcblock/validator": "1.24.0",
+    "@ocap/client": "1.24.0",
+    "@ocap/mcrypto": "1.24.0",
+    "@ocap/merkle-tree": "1.24.0",
+    "@ocap/message": "1.24.0",
+    "@arcblock/did-util": "1.24.0",
+    "@ocap/state": "1.24.0",
+    "@ocap/tx-pipeline": "1.24.0",
+    "@ocap/util": "1.24.0",
+    "@ocap/wallet": "1.24.0"
   },
   "resolutions": {
     "bn.js": "5.2.1",
@@ -39,8 +39,8 @@
   "devDependencies": {
     "jest": "^29.7.0",
     "start-server-and-test": "^1.14.0",
-    "@ocap/e2e-test": "1.23.0",
-    "@ocap/statedb-memory": "1.23.0"
+    "@ocap/e2e-test": "1.24.0",
+    "@ocap/statedb-memory": "1.24.0"
   },
   "scripts": {
     "lint": "eslint tests lib",