@ocap/state 1.27.6 → 1.27.8

package/lib/states/token-factory.js

@@ -11,7 +11,7 @@ const curveSchema = Joi.alternatives().try(
   }),
   Joi.object({
     type: Joi.string().valid('constant').required(),
-    fixedPrice: Joi.BN().greater(0).required(),
+    fixedPrice: Joi.BN().min(1).required(),
   }),
   Joi.object({
     type: Joi.string().valid('quadratic').required(),
@@ -29,7 +29,7 @@ const stateSchema = Joi.object({
   reserveBalance: Joi.BN().min(0).required(),
   status: Joi.string().valid('ACTIVE', 'PAUSED').required(),
   feeRate: Joi.number().min(0).max(2000).required(),
-  curve: curveSchema.required(),
+  curve: curveSchema.optional().allow(null),
   context: schemas.context,
   data: Joi.any().optional().allow(null),
 }).options({

package/lib/states/token.js

@@ -2,10 +2,13 @@ const pick = require('lodash/pick');
 const cloneDeep = require('lodash/cloneDeep');
 const { toChecksumAddress } = require('@arcblock/did/lib/type');
 const { toAddress, BN } = require('@ocap/util');
-const { Joi } = require('@arcblock/validator');
+const { Joi, schemas } = require('@arcblock/validator');
 
 const { create: createStateContext } = require('../contexts/state');
 
+const isTest = process.env.NODE_ENV === 'development' || process.env.NODE_ENV === 'test' || process.env.CI;
+
+// Schema for metadata.value - used independently in token factory protocols
 const metadataSchema = Joi.object({
   communityUrl: Joi.string()
     .uri({ scheme: ['https'], allowRelative: false })
@@ -15,6 +18,44 @@ const metadataSchema = Joi.object({
   issuer: Joi.string().max(64).required(),
 }).options({ stripUnknown: true, noDefaults: false });
 
+const stateSchema = Joi.object({
+  address: Joi.DID().prefix().role('ROLE_TOKEN').required(),
+  name: Joi.string().min(1).max(32).required(),
+  description: Joi.string().min(16).max(128).required(),
+  symbol: Joi.string().min(2).max(6).uppercase().required(),
+  unit: Joi.string().min(1).max(6).lowercase().required(),
+  decimal: Joi.number().min(6).max(18).required(),
+  icon: Joi.string().optional().allow(null, ''),
+  totalSupply: Joi.BN().min(0).required(),
+  initialSupply: Joi.BN().min(0).required(),
+  maxTotalSupply: Joi.alternatives().try(Joi.BN().greater(0), Joi.string().valid('')).optional().allow(null),
+  foreignToken: schemas.foreignToken.optional().allow(null),
+  issuer: Joi.DID().prefix().optional().allow(null, ''),
+  website: Joi.string()
+    .uri({
+      scheme: isTest ? ['http', 'https'] : ['https'],
+      allowRelative: false,
+    })
+    .max(256)
+    .optional()
+    .allow(null, ''),
+  metadata: Joi.object({
+    type: Joi.string().valid('json').required(),
+    value: metadataSchema.optional(),
+  })
+    .optional()
+    .allow(null),
+  tokenFactoryAddress: Joi.DID().prefix().role('ROLE_TOKEN_FACTORY').optional().allow(null, ''),
+  spenders: Joi.array().items(Joi.DID().prefix()).max(30).optional().allow(null),
+  minters: Joi.array().items(Joi.DID().prefix()).max(30).optional().allow(null),
+  type: Joi.string().valid('Token', 'CreditToken', 'BondingCurveToken').optional().allow(null, ''),
+  context: schemas.context,
+  data: Joi.any().optional().allow(null),
+}).options({
+  stripUnknown: true,
+  noDefaults: false,
+});
+
 const create = (attrs, context) => {
   const token = {
     context: createStateContext(context),
@@ -35,6 +76,9 @@ const create = (attrs, context) => {
       'website',
       'metadata',
       'tokenFactoryAddress',
+      'spenders',
+      'minters',
+      'type',
     ]),
   };
 
@@ -68,15 +112,13 @@ const validate = (state) => {
 
   const data = cloneDeep(state);
 
-  if (data.metadata?.value) {
-    const { value, error } = metadataSchema.validate(data.metadata.value, { stripUnknown: true });
-    if (error) {
-      throw new Error('INVALID_TOKEN', 'Invalid token metadata');
-    }
-    data.metadata.value = value;
+  // Validate the entire state with stateSchema
+  const { value, error } = stateSchema.validate(data);
+  if (error) {
+    throw new Error('INVALID_TOKEN', `Invalid token state: ${error.message}`);
   }
 
-  return data;
+  return value;
 };
 
-module.exports = { create, update, metadataSchema };
+module.exports = { create, update, metadataSchema, stateSchema };

package/lib/states/tx.js

@@ -358,22 +358,29 @@ const getMintTokenReceipts = (tx, ctx) => {
     };
   });
 
-  return inputReceipts.concat([
-    {
-      address: tx.itxJson.receiver,
-      changes: [
-        {
-          target: tokenAddress,
-          action: 'mint',
-          value: `${tx.itxJson.amount}`,
-        },
-      ],
-    },
-    {
-      address: owner,
-      changes: hasFee ? [{ target: reserveAddress, action: 'fee', value: `${ctx.reserveFee}` }] : [],
-    },
-  ]);
+  return inputReceipts
+    .concat([
+      {
+        address: tx.itxJson.receiver,
+        changes: [
+          {
+            target: tokenAddress,
+            action: 'mint',
+            value: `${tx.itxJson.amount}`,
+          },
+        ],
+      },
+    ])
+    .concat(
+      hasFee
+        ? [
+            {
+              address: owner,
+              changes: [{ target: reserveAddress, action: 'fee', value: `${ctx.reserveFee}` }],
+            },
+          ]
+        : []
+    );
 };
 
 const getBurnTokenReceipts = (tx, ctx) => {
@@ -381,7 +388,7 @@ const getBurnTokenReceipts = (tx, ctx) => {
   const { reserveAddress, tokenAddress, owner } = tokenFactoryState;
 
   const fee = new BN(ctx.reserveFee || '0');
-  const receiveAmount = new BN(ctx.reserveAmount).sub(fee).toString();
+  const receiveAmount = new BN(ctx.reserveAmount || '0').sub(fee);
 
   const inputReceipts = inputChanges.map((input) => {
     return {
@@ -396,16 +403,27 @@ const getBurnTokenReceipts = (tx, ctx) => {
     };
   });
 
-  return inputReceipts.concat([
-    {
-      address: tx.itxJson.receiver,
-      changes: [{ target: reserveAddress, action: 'swap', value: receiveAmount }],
-    },
-    {
-      address: owner,
-      changes: fee.gt(ZERO) ? [{ target: reserveAddress, action: 'fee', value: `${ctx.reserveFee}` }] : [],
-    },
-  ]);
+  return inputReceipts
+    .concat(
+      receiveAmount.gt(ZERO)
+        ? [
+            {
+              address: tx.itxJson.receiver,
+              changes: [{ target: reserveAddress, action: 'swap', value: receiveAmount.toString() }],
+            },
+          ]
+        : []
+    )
+    .concat(
+      fee.gt(ZERO)
+        ? [
+            {
+              address: owner,
+              changes: [{ target: reserveAddress, action: 'fee', value: fee.toString() }],
+            },
+          ]
+        : []
+    );
 };
 
 // Following only exist for legacy support purpose

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.27.6",
+  "version": "1.27.8",
   "description": "",
   "main": "lib/index.js",
   "files": [
@@ -12,18 +12,18 @@
   "dependencies": {
     "bloom-filters": "^1.3.9",
     "lodash": "^4.17.21",
-    "@arcblock/did": "1.27.6",
-    "@arcblock/validator": "1.27.6",
-    "@ocap/contract": "1.27.6",
-    "@ocap/mcrypto": "1.27.6",
-    "@ocap/message": "1.27.6",
-    "@ocap/util": "1.27.6",
-    "@ocap/wallet": "1.27.6"
+    "@arcblock/did": "1.27.8",
+    "@arcblock/validator": "1.27.8",
+    "@ocap/contract": "1.27.8",
+    "@ocap/mcrypto": "1.27.8",
+    "@ocap/message": "1.27.8",
+    "@ocap/util": "1.27.8",
+    "@ocap/wallet": "1.27.8"
   },
   "devDependencies": {
     "jest": "^29.7.0",
     "start-server-and-test": "^1.14.0",
-    "@ocap/e2e-test": "1.27.6"
+    "@ocap/e2e-test": "1.27.8"
   },
   "keywords": [],
   "author": "wangshijun <wangshijun2010@gmail.com> (http://github.com/wangshijun)",