@ocap/tx-protocols 1.23.1 → 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/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

@@ -116,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;

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.23.1",
+  "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.1",
-    "@arcblock/did-util": "1.23.1",
-    "@arcblock/jwt": "1.23.1",
-    "@arcblock/validator": "1.23.1",
-    "@ocap/asset": "1.23.1",
-    "@ocap/client": "1.23.1",
-    "@ocap/mcrypto": "1.23.1",
-    "@ocap/merkle-tree": "1.23.1",
-    "@ocap/message": "1.23.1",
-    "@ocap/state": "1.23.1",
-    "@ocap/tx-pipeline": "1.23.1",
-    "@ocap/util": "1.23.1",
-    "@ocap/wallet": "1.23.1"
+    "@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.1",
-    "@ocap/statedb-memory": "1.23.1"
+    "@ocap/e2e-test": "1.24.0",
+    "@ocap/statedb-memory": "1.24.0"
   },
   "scripts": {
     "lint": "eslint tests lib",