@ocap/state 1.21.3 → 1.22.1

package/lib/index.js

@@ -9,6 +9,7 @@ const stake = require('./states/stake');
 const rollup = require('./states/rollup');
 const rollupBlock = require('./states/rollup-block');
 const evidence = require('./states/evidence');
+const tokenFactory = require('./states/token-factory');
 
 const Blacklist = require('./states/blacklist');
 
@@ -24,6 +25,7 @@ module.exports = {
   rollup,
   rollupBlock,
   evidence,
+  tokenFactory,
 
   // indexes of the statedb to speed up reading
   indexes: [
@@ -38,6 +40,7 @@ module.exports = {
     'rollupBlock',
     'rollupValidator',
     'tokenDistribution',
+    'tokenFactory',
   ],
 
   tables: [
@@ -53,6 +56,7 @@ module.exports = {
     'rollupBlock',
     'evidence', // a simple key-value store
     'balance',
+    'tokenFactory',
   ],
 
   Blacklist,

package/lib/states/token-factory.js

@@ -0,0 +1,72 @@
+const pick = require('lodash/pick');
+const { Joi, schemas } = require('@arcblock/validator');
+
+const { create: createStateContext, update: updateStateContext } = require('../contexts/state');
+
+const curveSchema = Joi.alternatives().try(
+  Joi.object({
+    type: Joi.string().valid('linear').required(),
+    basePrice: Joi.BN().greater(0).required(),
+    slope: Joi.BN().greater(0).required(),
+  }),
+  Joi.object({
+    type: Joi.string().valid('constant').required(),
+    fixedPrice: Joi.BN().greater(0).required(),
+  }),
+  Joi.object({
+    type: Joi.string().valid('quadratic').required(),
+    basePrice: Joi.BN().greater(0).required(),
+    constant: Joi.number().greater(0).required(),
+  })
+);
+
+const stateSchema = Joi.object({
+  address: Joi.DID().prefix().role('ROLE_TOKEN_FACTORY').required(),
+  owner: Joi.DID().prefix().role('ROLE_ACCOUNT').required(),
+  tokenAddress: Joi.DID().prefix().role('ROLE_TOKEN').required(),
+  reserveAddress: Joi.DID().prefix().role('ROLE_TOKEN').required(),
+  currentSupply: Joi.BN().min(0).required(),
+  reserveBalance: Joi.BN().min(0).required(),
+  status: Joi.string().valid('ACTIVE', 'PAUSED').required(),
+  feeRate: Joi.number().min(0).max(2000).required(),
+  curve: curveSchema.required(),
+  context: schemas.context,
+  data: Joi.any().optional().allow(null),
+}).options({
+  stripUnknown: true,
+  noDefaults: false,
+});
+
+const create = (attrs, context) => {
+  const tokenFactory = {
+    context: createStateContext(context),
+    currentSupply: '0',
+    reserveBalance: '0',
+    status: 'ACTIVE',
+    ...pick(attrs, ['address', 'owner', 'tokenAddress', 'reserveAddress', 'curve', 'feeRate', 'data']),
+  };
+
+  if (!tokenFactory.data) {
+    tokenFactory.data = null;
+  }
+
+  return validate(tokenFactory);
+};
+
+const update = (state, attrs, context) =>
+  validate({
+    ...state,
+    ...pick(attrs, ['currentSupply', 'reserveBalance', 'feeRate']),
+    context: updateStateContext(state.context, context),
+  });
+
+const validate = (state) => {
+  const { value, error } = stateSchema.validate(state);
+  if (error) {
+    throw new Error(`Invalid token factory: ${error.details.map((x) => x.message).join(', ')}`);
+  }
+
+  return value;
+};
+
+module.exports = { create, update, validate, curveSchema };

package/lib/states/token.js

@@ -20,6 +20,7 @@ const create = (attrs, context) => {
       'foreignToken',
       'data',
       'issuer',
+      'tokenFactoryAddress',
     ]),
   };
 
@@ -37,4 +38,9 @@ const create = (attrs, context) => {
   return token;
 };
 
-module.exports = { create };
+const update = (state, attrs) => ({
+  ...state,
+  ...pick(attrs, ['totalSupply']),
+});
+
+module.exports = { create, update };

package/lib/states/tx.js

@@ -340,6 +340,66 @@ const getCreateTokenReceipts = (tx) => {
   return [issuerReceipt];
 };
 
+const getMintTokenReceipts = (tx, ctx) => {
+  const { reserveAddress, tokenAddress, owner } = ctx.tokenFactoryState;
+  const hasFee = ctx.reserveFee && new BN(ctx.reserveFee).gt(ZERO);
+
+  return [
+    {
+      address: tx.from,
+      changes: [
+        {
+          target: reserveAddress,
+          action: 'swap',
+          value: `-${ctx.reserveAmount}`,
+        },
+        hasFee && {
+          target: reserveAddress,
+          action: 'fee',
+          value: `-${ctx.reserveFee}`,
+        },
+      ].filter(Boolean),
+    },
+    {
+      address: tx.itxJson.receiver,
+      changes: [
+        {
+          target: tokenAddress,
+          action: 'mint',
+          value: `${tx.itxJson.amount}`,
+        },
+      ],
+    },
+    {
+      address: owner,
+      changes: hasFee ? [{ target: reserveAddress, action: 'fee', value: `${ctx.reserveFee}` }] : [],
+    },
+  ];
+};
+
+const getBurnTokenReceipts = (tx, ctx) => {
+  const { reserveAddress, tokenAddress, owner } = ctx.tokenFactoryState;
+  const hasFee = ctx.reserveFee && new BN(ctx.reserveFee).gt(ZERO);
+
+  return [
+    {
+      address: tx.from,
+      changes: [
+        { target: tokenAddress, action: 'burn', value: `-${tx.itxJson.amount}` },
+        hasFee && { target: reserveAddress, action: 'fee', value: `-${ctx.reserveFee}` },
+      ].filter(Boolean),
+    },
+    {
+      address: tx.itxJson.receiver,
+      changes: [{ target: reserveAddress, action: 'swap', value: `${ctx.reserveAmount}` }],
+    },
+    {
+      address: owner,
+      changes: hasFee ? [{ target: reserveAddress, action: 'fee', value: `${ctx.reserveFee}` }] : [],
+    },
+  ];
+};
+
 // Following only exist for legacy support purpose
 const getDepositTokenReceipts = (tx) => [
   {
@@ -580,6 +640,8 @@ const verifyTxReceipts = (receipts, typeUrl, ctx = {}) => {
       SetupSwapTx: ['swap'],
       RevokeSwapTx: ['swap'],
       RetrieveSwapTx: ['swap'],
+      MintTokenTx: ['swap', 'mint'],
+      BurnTokenTx: ['burn', 'swap'],
     }[typeUrl] || [];
 
   for (const [target, changes] of Object.entries(targets)) {
@@ -661,6 +723,10 @@ const getTxReceipts = ({ tx, code }, ctx = {}) => {
     receipts = receipts.concat(getAcquireAssetV3Receipts(tx, ctx));
   } else if (['CreateTokenTx'].includes(typeUrl)) {
     receipts = receipts.concat(getCreateTokenReceipts(tx, ctx));
+  } else if (['MintTokenTx'].includes(typeUrl)) {
+    receipts = receipts.concat(getMintTokenReceipts(tx, ctx));
+  } else if (['BurnTokenTx'].includes(typeUrl)) {
+    receipts = receipts.concat(getBurnTokenReceipts(tx, ctx));
   } else if (['DepositTokenTx'].includes(typeUrl)) {
     receipts = receipts.concat(getDepositTokenReceipts(tx, ctx));
   } else if (['WithdrawTokenTx'].includes(typeUrl)) {

package/package.json

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