@blocklet/meta 1.15.17 → 1.16.0-beta-8ee536d7

package/lib/validate.js

@@ -1,64 +1,40 @@
-const Ajv = require('ajv').default;
-const cloneDeep = require('lodash/cloneDeep');
-
-const { createBlockletSchema } = require('./schema');
-
-const fixAndValidateService = (meta, serviceMetas) => {
-  const ajv = new Ajv({
-    useDefaults: true,
-    removeAdditional: 'all',
-  });
-
-  if (!meta.interfaces) {
-    return meta;
-  }
-  if (!meta.interfaces.length) {
-    return meta;
-  }
-
-  meta.interfaces.forEach((d) => {
-    if (d.services && d.services.length) {
-      d.services.forEach((s) => {
-        const config = cloneDeep(s.config) || {};
-
-        // validate service.config if serviceMetaList is exist
-        if (serviceMetas) {
-          const serviceMeta = serviceMetas.find((x) => x.name === s.name);
-          if (!serviceMeta) {
-            throw new Error(`Invalid blocklet service: ${s.name} does not exist`);
-          }
-
-          const validate = ajv.compile(serviceMeta.schema.JSONSchema);
-          // this method may have side effect thar will fill default value to config
-          const valid = validate(config);
-
-          if (!valid) {
-            const message = validate.errors.map((x) => `${x.dataPath} ${x.message}`).join(', ');
-            throw new Error(`Invalid blocklet service config: ${message}`);
-          }
-        }
-
-        s.config = config;
-      });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fixAndValidateService = exports.validateMeta = void 0;
+const schema_1 = require("./schema");
+const service_1 = require("./service");
+const fixAndValidateService = (meta) => {
+    if (!meta.interfaces) {
+        return meta;
+    }
+    if (!meta.interfaces.length) {
+        return meta;
     }
-  });
-
-  return meta;
+    meta.interfaces.forEach((d) => {
+        if (d.services && d.services.length) {
+            d.services.forEach((s) => {
+                s.config = (0, service_1.getServiceConfig)(s.name, s.config, { validate: true });
+            });
+        }
+    });
+    return meta;
 };
-
-const validateMeta = (
-  meta,
-  { ensureMain = false, ensureFiles = false, ensureDist = false, schemaOptions = {} } = {}
-) => {
-  const schema = createBlockletSchema(null, { ensureMain, ensureFiles, ensureDist, ...schemaOptions });
-  const { value, error } = schema.validate(meta);
-  if (error) {
-    throw new Error(`Invalid blocklet meta: ${error.details.map((x) => x.message).join(', ')}`);
-  }
-
-  return value;
+exports.fixAndValidateService = fixAndValidateService;
+const validateMeta = (meta, { ensureMain = false, ensureFiles = false, ensureDist = false, ensureComponentStore = true, ensureName = false, skipValidateDidName = false, schemaOptions = {}, } = {}) => {
+    const schema = (0, schema_1.createBlockletSchema)(null, {
+        ensureMain,
+        ensureFiles,
+        ensureDist,
+        ensureComponentStore,
+        ensureName,
+        skipValidateDidName,
+        ...schemaOptions,
+    });
+    const { value, error } = schema.validate(meta);
+    if (error) {
+        throw new Error(`Invalid blocklet meta: ${error.details.map((x) => x.message).join(', ')}`);
+    }
+    return value;
 };
-
-module.exports = validateMeta;
-module.exports.validateMeta = validateMeta;
-module.exports.fixAndValidateService = fixAndValidateService;
+exports.validateMeta = validateMeta;
+exports.default = validateMeta;

package/lib/verify-multi-sig.d.ts

@@ -0,0 +1,3 @@
+import { TBlockletMeta } from './types';
+declare const verifyMultiSig: (blockletMeta: TBlockletMeta) => boolean;
+export = verifyMultiSig;

package/lib/verify-multi-sig.js

@@ -1,63 +1,90 @@
-const debug = require('debug')('@blocklet/meta:verifyMultiSig');
-const stableStringify = require('json-stable-stringify');
-const cloneDeep = require('lodash/cloneDeep');
-const omit = require('lodash/omit');
-const { toTypeInfo } = require('@arcblock/did');
-const { fromPublicKey } = require('@ocap/wallet');
-
-module.exports = (blockletMeta) => {
-  const { signatures: tmpSignatures, ...meta } = blockletMeta;
-  const signatures = cloneDeep(tmpSignatures);
-
-  if (!Array.isArray(signatures)) {
-    throw new Error('Invalid signatures, signatures should be an array');
-  }
-
-  if (signatures.length === 0) {
-    throw new Error('Invalid signatures, found empty');
-  }
-
-  const { length } = signatures;
-  let lastSignature = null;
-
-  for (let i = 0; i < length; i++) {
-    const signature = signatures.shift();
-    const { sig, signer, pk } = signature;
-    delete signature.sig;
-    debug('verify', { signer });
-
-    let toBeVerifiedMeta = { ...meta };
-
-    if (lastSignature && lastSignature.appended) {
-      debug('appended fields', { signer, appended: lastSignature.appended });
-
-      lastSignature.appended.forEach((field) => {
-        toBeVerifiedMeta = omit(toBeVerifiedMeta, field);
-      });
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+/* eslint-disable @typescript-eslint/indent */
+const get_1 = __importDefault(require("lodash/get"));
+const omit_1 = __importDefault(require("lodash/omit"));
+const cloneDeep_1 = __importDefault(require("lodash/cloneDeep"));
+const json_stable_stringify_1 = __importDefault(require("json-stable-stringify"));
+const did_1 = require("@arcblock/did");
+const wallet_1 = require("@ocap/wallet");
+const jwt_1 = require("@arcblock/jwt");
+const util_1 = require("@ocap/util");
+const debug_1 = __importDefault(require("debug"));
+const debug = (0, debug_1.default)('@blocklet/meta:verifyMultiSig');
+function verifyDelegationToken(signature) {
+    if (signature.delegation) {
+        // @ts-ignore
+        const payload = JSON.parse((0, util_1.fromBase64)(signature.delegation.split('.')[1]));
+        if (payload.from !== signature.signer) {
+            debug('verify payload.from failed', { payload, signature });
+            return false;
+        }
+        if (payload.to !== signature.delegatee) {
+            debug('verify payload.to failed', { payload, signature });
+            return false;
+        }
+        if (!(0, get_1.default)(payload, 'permissions', []).includes('publish_blocklet')) {
+            debug('verify payload.permissions failed', payload);
+            return false;
+        }
+        // 验证一下delegation token
+        if (!(0, jwt_1.verify)(signature.delegation, signature.pk)) {
+            debug('verify delegation token failed', signature);
+            return false;
+        }
+    }
+    return true;
+}
+const verifyMultiSig = (blockletMeta) => {
+    const { signatures: tmpSignatures, ...meta } = blockletMeta;
+    const signatures = (0, cloneDeep_1.default)(tmpSignatures);
+    if (!Array.isArray(signatures)) {
+        throw new Error('Invalid signatures, signatures should be an array');
     }
-
-    if (signature.excludes && signature.excludes.length > 0) {
-      debug('excludes fields', { signer, excludes: signature.excludes });
-
-      signature.excludes.forEach((field) => {
-        toBeVerifiedMeta = omit(toBeVerifiedMeta, field);
-      });
+    if (signatures.length === 0) {
+        throw new Error('Invalid signatures, found empty');
     }
-
-    const type = toTypeInfo(signer);
-    const wallet = fromPublicKey(pk, type);
-    const verifyRes = wallet.verify(
-      stableStringify({ ...toBeVerifiedMeta, signatures: [signature, ...signatures] }),
-      sig
-    );
-    if (verifyRes !== true) {
-      debug('verify failed', { signer });
-
-      return verifyRes;
+    const { length } = signatures;
+    let lastSignature = null;
+    for (let i = 0; i < length; i++) {
+        const signature = signatures.shift();
+        // 验证delegation token
+        if (!verifyDelegationToken(signature)) {
+            return false;
+        }
+        const { sig, signer, pk } = signature.delegation
+            ? {
+                sig: signature.sig,
+                signer: signature.delegatee,
+                pk: signature.delegateePk,
+            }
+            : signature;
+        delete signature.sig;
+        debug('verify', { signer });
+        let toBeVerifiedMeta = { ...meta };
+        if (lastSignature && lastSignature.appended) {
+            debug('appended fields', { signer, appended: lastSignature.appended });
+            lastSignature.appended.forEach((field) => {
+                toBeVerifiedMeta = (0, omit_1.default)(toBeVerifiedMeta, field);
+            });
+        }
+        if (signature.excludes && signature.excludes.length > 0) {
+            debug('excludes fields', { signer, excludes: signature.excludes });
+            signature.excludes.forEach((field) => {
+                toBeVerifiedMeta = (0, omit_1.default)(toBeVerifiedMeta, field);
+            });
+        }
+        const type = (0, did_1.toTypeInfo)(signer);
+        const wallet = (0, wallet_1.fromPublicKey)(pk, type);
+        const verifyRes = wallet.verify((0, json_stable_stringify_1.default)({ ...toBeVerifiedMeta, signatures: [signature, ...signatures] }), sig);
+        if (verifyRes !== true) {
+            debug('verify failed', { signer });
+            return verifyRes;
+        }
+        lastSignature = signature;
     }
-
-    lastSignature = signature;
-  }
-
-  return true;
+    return true;
 };
+module.exports = verifyMultiSig;

package/lib/wallet.d.ts

@@ -0,0 +1,9 @@
+import { WalletObject } from '@ocap/wallet';
+import { DIDType } from '@arcblock/did';
+/**
+ * Gen DID from blocklet did and nodeSk
+ *
+ * Spec: https://github.com/ArcBlock/ABT-DID-Protocol#request-did-authentication
+ */
+declare const getApplicationWallet: (blockletDid: string, nodeSk?: string, type?: DIDType | string, index?: number) => WalletObject;
+export = getApplicationWallet;

package/lib/wallet.js

@@ -1,37 +1,26 @@
-const Mcrypto = require('@ocap/mcrypto');
-const { fromSecretKey } = require('@ocap/wallet');
-const { isValid } = require('@arcblock/did');
-const { fromAppDid } = require('@arcblock/did-ext');
-
-const { types } = Mcrypto;
-
+"use strict";
+const mcrypto_1 = require("@ocap/mcrypto");
+const wallet_1 = require("@ocap/wallet");
+const did_1 = require("@arcblock/did");
+const did_ext_1 = require("@arcblock/did-ext");
 /**
  * Gen DID from blocklet did and nodeSk
  *
  * Spec: https://github.com/ArcBlock/ABT-DID-Protocol#request-did-authentication
- *
- * @public
- * @static
- * @param {string} blockletDid - blocklet did
- * @param {string} nodeSk - node sk used to derive blocklet sk
- * @param {object} [type={}]
- * @param {number} [index=0]
- * @returns {object} Wallet instance
  */
-const getBlockletWallet = (blockletDid, nodeSk, type = { role: types.RoleType.ROLE_APPLICATION }, index = 0) => {
-  if (!isValid(blockletDid)) {
-    try {
-      return fromSecretKey(blockletDid, type);
-    } catch (err) {
-      throw new Error(`Cannot get blocklet wallet with invalid blocklet did or custom sk: ${err.message}`);
+const getApplicationWallet = (blockletDid, nodeSk, type, index) => {
+    const t = type || { role: mcrypto_1.types.RoleType.ROLE_APPLICATION };
+    if (!(0, did_1.isValid)(blockletDid)) {
+        try {
+            return (0, wallet_1.fromSecretKey)(blockletDid, t);
+        }
+        catch (err) {
+            throw new Error(`Cannot get blocklet wallet with invalid blocklet did or custom sk: ${err.message}`);
+        }
+    }
+    if (!nodeSk) {
+        throw new Error('Cannot get blocklet wallet with empty node sk');
     }
-  }
-
-  if (!nodeSk) {
-    throw new Error('Cannot get blocklet wallet with empty node sk');
-  }
-
-  return fromAppDid(blockletDid, nodeSk, type, index);
+    return (0, did_ext_1.fromAppDid)(blockletDid, nodeSk, t, index || 0);
 };
-
-module.exports = getBlockletWallet;
+module.exports = getApplicationWallet;

package/package.json

@@ -3,44 +3,83 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.15.17",
+  "version": "1.16.0-beta-8ee536d7",
   "description": "Library to parse/validate/fix blocklet meta",
-  "main": "lib/index.js",
+  "main": "./lib/index.js",
+  "typings": "./lib/index.d.ts",
   "files": [
     "lib"
   ],
   "scripts": {
-    "lint": "eslint tests lib",
-    "lint:fix": "eslint --fix tests lib",
+    "verify": "npm run lint:fix && npm run coverage && npm run build",
+    "lint": "eslint src tests",
+    "lint:fix": "npm run lint -- --fix",
     "test": "node tools/jest.js",
-    "coverage": "npm run test -- --coverage"
+    "coverage": "npm run test -- --coverage",
+    "clean": "rm -fr lib",
+    "types": "ts-node tools/types.js && sed -i.bak 's/unknown/string/g' ./src/types/schema.ts && rm  ./src/types/schema.ts.bak && prettier --write ./src/types/*.ts",
+    "prebuild": "npm run clean && npm run types",
+    "build": "tsc"
   },
   "author": "wangshijun <wangshijun2020@gmail.com> (http://github.com/wangshijun)",
   "license": "MIT",
   "dependencies": {
-    "@arcblock/did": "^1.13.61",
-    "@arcblock/did-ext": "^1.13.61",
-    "@arcblock/did-util": "^1.13.61",
-    "@arcblock/nft": "^1.13.61",
-    "@ocap/asset": "^1.13.61",
-    "@ocap/mcrypto": "^1.13.61",
-    "@ocap/util": "^1.13.61",
-    "@ocap/wallet": "^1.13.61",
-    "ajv": "^7.0.3",
-    "debug": "^4.3.2",
-    "fs-extra": "^10.0.0",
+    "@abtnode/client": "1.16.0-beta-8ee536d7",
+    "@abtnode/constant": "1.16.0-beta-8ee536d7",
+    "@abtnode/util": "1.16.0-beta-8ee536d7",
+    "@arcblock/did": "1.18.62",
+    "@arcblock/did-ext": "1.18.62",
+    "@arcblock/did-util": "1.18.62",
+    "@arcblock/jwt": "1.18.62",
+    "@blocklet/constant": "1.16.0-beta-8ee536d7",
+    "@ocap/asset": "1.18.62",
+    "@ocap/mcrypto": "1.18.62",
+    "@ocap/types": "1.18.62",
+    "@ocap/util": "1.18.62",
+    "@ocap/wallet": "1.18.62",
+    "ajv": "^8.11.0",
+    "axios": "^0.27.2",
+    "cjk-length": "^1.0.0",
+    "debug": "^4.3.4",
+    "fs-extra": "^10.1.0",
     "hosted-git-info": "3.0.8",
+    "is-absolute-url": "^3.0.3",
     "is-glob": "^4.0.3",
-    "joi": "^17.4.0",
+    "is-var-name": "^2.0.0",
+    "joi": "17.7.0",
     "joi-extension-semver": "^5.0.0",
-    "js-yaml": "^3.14.0",
+    "js-yaml": "^4.1.0",
     "json-stable-stringify": "^1.0.1",
     "lodash": "^4.17.21",
+    "p-limit": "^3.1.0",
+    "promise.any": "^2.0.4",
+    "slugify": "^1.6.5",
     "url-join": "^4.0.1",
+    "utility-types": "^3.10.0",
     "validate-npm-package-name": "^3.0.0"
   },
   "devDependencies": {
-    "jest": "^27.3.1"
+    "@abtnode/client": "^1.8.68",
+    "@arcblock/eslint-config-ts": "^0.2.3",
+    "@types/express": "^4.17.14",
+    "@types/jest": "^29.2.2",
+    "@types/joi": "^17.2.3",
+    "@types/js-yaml": "^4.0.5",
+    "@types/validate-npm-package-name": "^4.0.0",
+    "@typescript-eslint/eslint-plugin": "^5.42.0",
+    "@typescript-eslint/parser": "^5.42.0",
+    "body-parser": "^1.20.1",
+    "compression": "^1.7.4",
+    "detect-port": "^1.5.1",
+    "eslint": "^8.27.0",
+    "expand-tilde": "^2.0.2",
+    "express": "^4.18.2",
+    "jest": "^29.3.0",
+    "joi-to-typescript": "^4.0.7",
+    "prettier": "^2.7.1",
+    "ts-jest": "^29.0.3",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.8.4"
   },
-  "gitHead": "22715c3ea74d0230f3413162a17f491614b6735a"
+  "gitHead": "57d0c45be311a5fbc1c0fffa2814b62c1a3ee34c"
 }

package/lib/payment.js

@@ -1,114 +0,0 @@
-/* eslint-disable no-await-in-loop */
-const joinURL = require('url-join');
-const { BN } = require('@ocap/util');
-const { isValidFactory } = require('@ocap/asset');
-const { toFactoryAddress } = require('@arcblock/did-util');
-const { getBlockletPurchaseTemplate } = require('@arcblock/nft/lib/templates');
-
-const isFreeBlocklet = (meta) => {
-  if (!meta.charging) {
-    return true;
-  }
-
-  const primaryPrice = meta.charging.price || 0;
-  const secondaryPrice = (meta.charging.tokens || []).map((x) => x.price || 0);
-  if (primaryPrice <= 0 && secondaryPrice.every((x) => x <= 0)) {
-    return true;
-  }
-
-  return false;
-};
-
-const createShareContract = ({ price, shares, tokens = [] }) => {
-  const zeroBN = new BN(0);
-  const decimals = 1000000; // we only support 6 decimals on share ratio
-  const decimalsBN = new BN(decimals);
-
-  const contract = [];
-  const shareSum = shares.reduce((sum, x) => sum + x.share, 0);
-  if (shareSum > 1) {
-    throw new Error('charging.shares invalid: share sum should not be greater than 1');
-  }
-
-  // split primary token
-  const priceBN = new BN(price);
-  if (priceBN.lt(zeroBN)) {
-    throw new Error('price must be greater than or equal to zero');
-  }
-  if (priceBN.gt(zeroBN)) {
-    shares.forEach(({ address, share }) => {
-      const ratio = new BN(share * decimals);
-      const amount = priceBN.mul(ratio).div(decimalsBN);
-      contract.push(`transfer('${address}','${amount.toString()}')`);
-    });
-  }
-
-  // split secondary token
-  if (Array.isArray(tokens)) {
-    tokens.forEach(({ address: tokenAddress, value }) => {
-      const valueBN = new BN(value);
-      if (valueBN.lt(zeroBN)) {
-        throw new Error('token price must be greater than or equal to zero');
-      }
-      shares.forEach(({ address, share }) => {
-        const ratio = new BN(share * decimals);
-        const amount = valueBN.mul(ratio).div(decimalsBN);
-        contract.push(`transferToken('${tokenAddress}','${address}','${amount.toString()}')`);
-      });
-    });
-  }
-
-  return contract.join(';\n');
-};
-
-// we need to ensure that blocklet purchase factory does not change across changes
-const createNftFactoryItx = ({ meta, price, tokens, shares, issuers, serviceUrl }) => {
-  const factoryOutput = getBlockletPurchaseTemplate(serviceUrl);
-  const itx = {
-    name: meta.title || meta.name,
-    description: `Purchase NFT factory for blocklet ${meta.name}`,
-    settlement: 'instant',
-    limit: 0,
-    trustedIssuers: issuers,
-    input: {
-      value: price,
-      tokens: [...tokens],
-      assets: [],
-      variables: [],
-    },
-    output: {
-      issuer: '{{ctx.issuer.id}}',
-      parent: '{{ctx.factory}}',
-      moniker: 'BlockletPurchaseNFT',
-      readonly: true,
-      transferrable: false,
-      data: factoryOutput,
-    },
-    data: {
-      type: 'json',
-      value: {
-        did: meta.did,
-        url: joinURL(serviceUrl, `/blocklet/${meta.did}`),
-        name: meta.name,
-      },
-    },
-    hooks: [
-      {
-        name: 'mint',
-        type: 'contract',
-        hook: createShareContract({ price, tokens, shares }),
-      },
-    ],
-  };
-
-  isValidFactory(itx, true);
-
-  itx.address = toFactoryAddress(itx);
-  return itx;
-};
-
-module.exports = {
-  isFreeBlocklet,
-  createShareContract,
-  createNftFactoryItx,
-};