@ocap/asset 1.17.11 → 1.17.12

package/lib/index.d.ts

@@ -28,6 +28,7 @@ export declare type TPreMintResult = TMintResult & {
     variables: TInputMap;
     issuer: TIssuerInput;
 };
+export declare const isValidNotation: (notation: string) => boolean;
 export declare const isValidHook: (hook: THook, quota?: $TSFixMe, throwOnError?: boolean) => boolean;
 export declare const isValidFactory: (props: $TSFixMe) => boolean;
 /**

package/lib/index.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatFactoryState = exports.preMintFromFactory = exports.mintFromFactory = exports.findPrerenderKeys = exports.isValidFactory = exports.isValidHook = void 0;
+exports.formatFactoryState = exports.preMintFromFactory = exports.mintFromFactory = exports.findPrerenderKeys = exports.isValidFactory = exports.isValidHook = exports.isValidNotation = void 0;
 /* eslint-disable @typescript-eslint/ban-ts-comment */
 const get_1 = __importDefault(require("lodash/get"));
 const set_1 = __importDefault(require("lodash/set"));
@@ -16,6 +16,7 @@ const is_absolute_url_1 = __importDefault(require("is-absolute-url"));
 const cloneDeep_1 = __importDefault(require("lodash/cloneDeep"));
 const did_1 = require("@arcblock/did");
 const vc_1 = require("@arcblock/vc");
+const validator_1 = require("@arcblock/validator");
 const did_util_1 = require("@arcblock/did-util");
 const mcrypto_1 = require("@ocap/mcrypto");
 const util_1 = require("@ocap/util");
@@ -24,6 +25,8 @@ const debug_1 = __importDefault(require("debug"));
 const debug = (0, debug_1.default)('@ocap/asset');
 const SUPPORTED_HOOK_NAMES = ['mint', 'postMint'];
 const SUPPORTED_HOOK_TYPES = ['contract', 'url'];
+const isValidNotation = (notation) => ['ctx', 'data', 'input'].includes(notation.split('.').shift());
+exports.isValidNotation = isValidNotation;
 const isValidHook = (hook, quota, throwOnError = false) => {
     if (SUPPORTED_HOOK_TYPES.includes(hook.type) === false) {
         return false;
@@ -53,68 +56,53 @@ const isValidHook = (hook, quota, throwOnError = false) => {
     return false;
 };
 exports.isValidHook = isValidHook;
-// FIXME: we should use Joi to validate the schema
 // @link https://github.com/improbable-eng/ts-protoc-gen
 const isValidFactory = (props) => {
     if (!props) {
         throw new Error('Factory props should not be empty');
     }
-    // required props
-    const missingProp = ['name', 'description', 'input', 'output', 'settlement'].find((x) => !props[x]);
-    if (missingProp) {
-        throw new Error(`Factory ${missingProp} prop should not be empty`);
-    }
-    if (['instant', 'periodic'].includes(props.settlement) === false) {
-        throw new Error('Factory settlement prop should only be instant or periodic');
+    const { value, error } = validator_1.schemas.factorySchema.validate(props);
+    if (error) {
+        throw new Error(`Invalid factory: ${error.details.map((x) => x.message).join(', ')}`);
     }
     // input.tokens and input.assets should not be empty
-    if (['value', 'tokens', 'assets'].every((x) => (0, isEmpty_1.default)(props.input[x]))) {
+    if (['tokens', 'assets'].every((x) => (0, isEmpty_1.default)(value.input[x])) && value.input.value <= 0) {
         throw new Error('Factory input should contain at least one token or asset');
     }
-    if ((0, uniqBy_1.default)(props.input.tokens, 'address').length !== props.input.tokens.length) {
+    if ((0, uniqBy_1.default)(value.input.tokens, 'address').length !== value.input.tokens.length) {
         throw new Error('Factory token input should not contains duplicate address');
     }
-    if ((0, uniq_1.default)(props.input.assets).length !== props.input.assets.length) {
+    if ((0, uniq_1.default)(value.input.assets).length !== value.input.assets.length) {
         throw new Error('Factory asset input should not contains duplicate address');
     }
-    for (const token of props.input.tokens) {
-        try {
-            // eslint-disable-next-line no-new
-            new util_1.BN(token.value);
-        }
-        catch (err) {
-            throw new Error(`Factory token ${token.address} is invalid: token value is not valid big number`);
-        }
-    }
-    // validate output
-    if (!props.output || typeof props.output !== 'object') {
-        throw new Error('Factory output should be an object');
-    }
     try {
         // should be a valid mustache template when serialized as json
-        const template = JSON.stringify(props.output);
-        mustache_1.default.parse(template);
+        const template = JSON.stringify(value.output, null, 2);
+        const result = mustache_1.default.parse(template);
+        if (result.filter(([type]) => type === 'name').some(([, notation]) => (0, exports.isValidNotation)(notation) === false)) {
+            throw new Error('Invalid tags found in the output template');
+        }
     }
     catch (err) {
         throw new Error('Factory output should be a valid mustache template when serialized as json');
     }
     // validate hooks
-    const quota = (0, contract_1.getQuota)(props.input);
-    if (Array.isArray(props.hooks)) {
-        const invalidHook = props.hooks.find((x) => (0, exports.isValidHook)(x, quota, true) === false);
+    const quota = (0, contract_1.getQuota)(value.input);
+    if (Array.isArray(value.hooks)) {
+        const invalidHook = value.hooks.find((x) => (0, exports.isValidHook)(x, quota, true) === false);
         if (invalidHook) {
             throw new Error(`Factory hook ${invalidHook.name} is invalid`);
         }
     }
     // ensure input and hook are zero-sum for factories that consumes token
-    if (props.settlement === 'instant') {
+    if (value.settlement === 'instant') {
         if (quota.value <= 0 && Object.keys(quota.tokens).every((x) => quota[x] <= 0)) {
             return true;
         }
-        if ((0, isEmpty_1.default)(props.hooks)) {
+        if ((0, isEmpty_1.default)(value.hooks)) {
             throw new Error('Factory hooks should not be empty for instant settlement');
         }
-        const mintHook = props.hooks.find((x) => x.name === 'mint');
+        const mintHook = value.hooks.find((x) => x.name === 'mint');
         if (!mintHook) {
             throw new Error('Factory hook mint should not be empty for instant settlement that consumes token');
         }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ocap/asset",
   "description": "Utility to work with asset and factory on ArcBlock blockchain",
-  "version": "1.17.11",
+  "version": "1.17.12",
   "author": {
     "name": "wangshijun",
     "email": "shijun@arcblock.io",
@@ -18,14 +18,15 @@
     "wangshijun <shijun@arcblock.io> (https://github.com/wangshijun)"
   ],
   "dependencies": {
-    "@arcblock/did": "1.17.11",
-    "@arcblock/did-util": "1.17.11",
-    "@arcblock/vc": "1.17.11",
-    "@ocap/contract": "1.17.11",
-    "@ocap/mcrypto": "1.17.11",
-    "@ocap/types": "1.17.11",
-    "@ocap/util": "1.17.11",
-    "@ocap/wallet": "1.17.11",
+    "@arcblock/did": "1.17.12",
+    "@arcblock/did-util": "1.17.12",
+    "@arcblock/validator": "1.17.12",
+    "@arcblock/vc": "1.17.12",
+    "@ocap/contract": "1.17.12",
+    "@ocap/mcrypto": "1.17.12",
+    "@ocap/types": "1.17.12",
+    "@ocap/util": "1.17.12",
+    "@ocap/wallet": "1.17.12",
     "debug": "^4.3.4",
     "flat": "^5.0.2",
     "is-absolute-url": "^3.0.3",
@@ -35,7 +36,7 @@
     "type-fest": "^2.18.0"
   },
   "devDependencies": {
-    "@arcblock/eslint-config-ts": "0.2.2",
+    "@arcblock/eslint-config-ts": "0.2.3",
     "@types/flat": "^5.0.2",
     "@types/jest": "^28.1.6",
     "@types/mustache": "^4.2.1",
@@ -73,5 +74,5 @@
     "build": "tsc",
     "build:watch": "npm run build -- -w"
   },
-  "gitHead": "32ee93b1f1026709bb1b00a58b4b3dc5d551f94a"
+  "gitHead": "9209d3e84008ba758810a607b1c6a4b4fd5e7bc0"
 }