@blocklet/meta 1.8.34 → 1.8.36

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (58) hide show
  1. package/lib/channel.d.ts +27 -0
  2. package/lib/channel.js +32 -32
  3. package/lib/constants.d.ts +2 -0
  4. package/lib/constants.js +6 -3
  5. package/lib/did.d.ts +10 -0
  6. package/lib/did.js +18 -24
  7. package/lib/engine.d.ts +7 -0
  8. package/lib/engine.js +21 -25
  9. package/lib/entry.d.ts +3 -0
  10. package/lib/entry.js +51 -64
  11. package/lib/extension.d.ts +10 -0
  12. package/lib/extension.js +78 -77
  13. package/lib/file.d.ts +21 -0
  14. package/lib/file.js +44 -39
  15. package/lib/fix.d.ts +33 -0
  16. package/lib/fix.js +218 -208
  17. package/lib/get-component-process-id.d.ts +5 -0
  18. package/lib/get-component-process-id.js +13 -14
  19. package/lib/has-reserved-key.d.ts +3 -0
  20. package/lib/has-reserved-key.js +10 -9
  21. package/lib/index.d.ts +82 -0
  22. package/lib/index.js +51 -34
  23. package/lib/info.d.ts +13 -0
  24. package/lib/info.js +58 -60
  25. package/lib/name.d.ts +5 -0
  26. package/lib/name.js +14 -7
  27. package/lib/nft-templates.d.ts +86 -0
  28. package/lib/nft-templates.js +47 -42
  29. package/lib/parse-navigation.d.ts +3 -0
  30. package/lib/parse-navigation.js +167 -228
  31. package/lib/parse.d.ts +22 -0
  32. package/lib/parse.js +71 -82
  33. package/lib/payment/index.d.ts +254 -0
  34. package/lib/payment/index.js +13 -6
  35. package/lib/payment/v1.d.ts +185 -0
  36. package/lib/payment/v1.js +80 -81
  37. package/lib/payment/v2.d.ts +242 -0
  38. package/lib/payment/v2.js +453 -531
  39. package/lib/schema.d.ts +50 -0
  40. package/lib/schema.js +405 -402
  41. package/lib/service-configs/auth.json +61 -61
  42. package/lib/service.d.ts +26 -0
  43. package/lib/service.js +69 -85
  44. package/lib/types/index.d.ts +1 -0
  45. package/lib/types/index.js +18 -0
  46. package/lib/types/schema.d.ts +241 -0
  47. package/lib/types/schema.js +3 -0
  48. package/lib/util-meta.d.ts +42 -0
  49. package/lib/util-meta.js +138 -158
  50. package/lib/util.d.ts +185 -0
  51. package/lib/util.js +359 -414
  52. package/lib/validate.d.ts +10 -0
  53. package/lib/validate.js +28 -34
  54. package/lib/verify-multi-sig.d.ts +3 -0
  55. package/lib/verify-multi-sig.js +94 -101
  56. package/lib/wallet.d.ts +9 -0
  57. package/lib/wallet.js +17 -27
  58. package/package.json +40 -18
@@ -0,0 +1,10 @@
1
+ import { TBlockletMeta } from './types';
2
+ declare const fixAndValidateService: (meta: TBlockletMeta) => TBlockletMeta;
3
+ declare const validateMeta: (meta: any, { ensureMain, ensureFiles, ensureDist, schemaOptions, }?: {
4
+ ensureMain?: boolean;
5
+ ensureFiles?: boolean;
6
+ ensureDist?: boolean;
7
+ schemaOptions?: any;
8
+ }) => TBlockletMeta;
9
+ export default validateMeta;
10
+ export { validateMeta, fixAndValidateService };
package/lib/validate.js CHANGED
@@ -1,38 +1,32 @@
1
- const { createBlockletSchema } = require('./schema');
2
- const { getServiceConfig } = require('./service');
3
-
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.fixAndValidateService = exports.validateMeta = void 0;
4
+ const schema_1 = require("./schema");
5
+ const service_1 = require("./service");
4
6
  const fixAndValidateService = (meta) => {
5
- if (!meta.interfaces) {
6
- return meta;
7
- }
8
- if (!meta.interfaces.length) {
9
- return meta;
10
- }
11
-
12
- meta.interfaces.forEach((d) => {
13
- if (d.services && d.services.length) {
14
- d.services.forEach((s) => {
15
- s.config = getServiceConfig(s.name, s.config, { validate: true });
16
- });
7
+ if (!meta.interfaces) {
8
+ return meta;
9
+ }
10
+ if (!meta.interfaces.length) {
11
+ return meta;
17
12
  }
18
- });
19
-
20
- return meta;
13
+ meta.interfaces.forEach((d) => {
14
+ if (d.services && d.services.length) {
15
+ d.services.forEach((s) => {
16
+ s.config = (0, service_1.getServiceConfig)(s.name, s.config, { validate: true });
17
+ });
18
+ }
19
+ });
20
+ return meta;
21
21
  };
22
-
23
- const validateMeta = (
24
- meta,
25
- { ensureMain = false, ensureFiles = false, ensureDist = false, schemaOptions = {} } = {}
26
- ) => {
27
- const schema = createBlockletSchema(null, { ensureMain, ensureFiles, ensureDist, ...schemaOptions });
28
- const { value, error } = schema.validate(meta);
29
- if (error) {
30
- throw new Error(`Invalid blocklet meta: ${error.details.map((x) => x.message).join(', ')}`);
31
- }
32
-
33
- return value;
22
+ exports.fixAndValidateService = fixAndValidateService;
23
+ const validateMeta = (meta, { ensureMain = false, ensureFiles = false, ensureDist = false, schemaOptions = {}, } = {}) => {
24
+ const schema = (0, schema_1.createBlockletSchema)(null, Object.assign({ ensureMain, ensureFiles, ensureDist }, schemaOptions));
25
+ const { value, error } = schema.validate(meta);
26
+ if (error) {
27
+ throw new Error(`Invalid blocklet meta: ${error.details.map((x) => x.message).join(', ')}`);
28
+ }
29
+ return value;
34
30
  };
35
-
36
- module.exports = validateMeta;
37
- module.exports.validateMeta = validateMeta;
38
- module.exports.fixAndValidateService = fixAndValidateService;
31
+ exports.validateMeta = validateMeta;
32
+ exports.default = validateMeta;
@@ -0,0 +1,3 @@
1
+ import { TBlockletMeta } from './types';
2
+ declare const verifyMultiSig: (blockletMeta: TBlockletMeta) => boolean;
3
+ export = verifyMultiSig;
@@ -1,108 +1,101 @@
1
- const get = require('lodash/get');
2
- const omit = require('lodash/omit');
3
- const cloneDeep = require('lodash/cloneDeep');
4
- const stableStringify = require('json-stable-stringify');
5
- const { toTypeInfo } = require('@arcblock/did');
6
- const { fromPublicKey } = require('@ocap/wallet');
7
- const { verify } = require('@arcblock/jwt');
8
- const { fromBase64 } = require('@ocap/util');
9
-
10
- const debug = require('debug')('@blocklet/meta:verifyMultiSig');
11
-
1
+ "use strict";
2
+ var __rest = (this && this.__rest) || function (s, e) {
3
+ var t = {};
4
+ for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
5
+ t[p] = s[p];
6
+ if (s != null && typeof Object.getOwnPropertySymbols === "function")
7
+ for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
8
+ if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
9
+ t[p[i]] = s[p[i]];
10
+ }
11
+ return t;
12
+ };
13
+ var __importDefault = (this && this.__importDefault) || function (mod) {
14
+ return (mod && mod.__esModule) ? mod : { "default": mod };
15
+ };
16
+ /* eslint-disable @typescript-eslint/indent */
17
+ const get_1 = __importDefault(require("lodash/get"));
18
+ const omit_1 = __importDefault(require("lodash/omit"));
19
+ const cloneDeep_1 = __importDefault(require("lodash/cloneDeep"));
20
+ const json_stable_stringify_1 = __importDefault(require("json-stable-stringify"));
21
+ const did_1 = require("@arcblock/did");
22
+ const wallet_1 = require("@ocap/wallet");
23
+ const jwt_1 = require("@arcblock/jwt");
24
+ const util_1 = require("@ocap/util");
25
+ const debug_1 = __importDefault(require("debug"));
26
+ const debug = (0, debug_1.default)('@blocklet/meta:verifyMultiSig');
12
27
  function verifyDelegationToken(signature) {
13
- if (signature.delegation) {
14
- const payload = JSON.parse(fromBase64(signature.delegation.split('.')[1]));
15
-
16
- if (payload.from !== signature.signer) {
17
- debug('verify payload.from failed', { payload, signature });
18
- return false;
19
- }
20
-
21
- if (payload.to !== signature.delegatee) {
22
- debug('verify payload.to failed', { payload, signature });
23
- return false;
24
- }
25
-
26
- if (!get(payload, 'permissions', []).includes('publish_blocklet')) {
27
- debug('verify payload.permissions failed', payload);
28
- return false;
29
- }
30
-
31
- // 验证一下delegation token
32
- if (!verify(signature.delegation, signature.pk)) {
33
- debug('verify delegation token failed', signature);
34
- return false;
28
+ if (signature.delegation) {
29
+ // @ts-ignore
30
+ const payload = JSON.parse((0, util_1.fromBase64)(signature.delegation.split('.')[1]));
31
+ if (payload.from !== signature.signer) {
32
+ debug('verify payload.from failed', { payload, signature });
33
+ return false;
34
+ }
35
+ if (payload.to !== signature.delegatee) {
36
+ debug('verify payload.to failed', { payload, signature });
37
+ return false;
38
+ }
39
+ if (!(0, get_1.default)(payload, 'permissions', []).includes('publish_blocklet')) {
40
+ debug('verify payload.permissions failed', payload);
41
+ return false;
42
+ }
43
+ // 验证一下delegation token
44
+ if (!(0, jwt_1.verify)(signature.delegation, signature.pk)) {
45
+ debug('verify delegation token failed', signature);
46
+ return false;
47
+ }
35
48
  }
36
- }
37
-
38
- return true;
49
+ return true;
39
50
  }
40
-
41
- module.exports = (blockletMeta) => {
42
- const { signatures: tmpSignatures, ...meta } = blockletMeta;
43
- const signatures = cloneDeep(tmpSignatures);
44
-
45
- if (!Array.isArray(signatures)) {
46
- throw new Error('Invalid signatures, signatures should be an array');
47
- }
48
-
49
- if (signatures.length === 0) {
50
- throw new Error('Invalid signatures, found empty');
51
- }
52
-
53
- const { length } = signatures;
54
- let lastSignature = null;
55
-
56
- for (let i = 0; i < length; i++) {
57
- const signature = signatures.shift();
58
-
59
- // 验证delegation token
60
- if (!verifyDelegationToken(signature)) {
61
- return false;
62
- }
63
-
64
- const { sig, signer, pk } = signature.delegation
65
- ? {
66
- sig: signature.sig,
67
- signer: signature.delegatee,
68
- pk: signature.delegateePk,
69
- }
70
- : signature;
71
- delete signature.sig;
72
- debug('verify', { signer });
73
-
74
- let toBeVerifiedMeta = { ...meta };
75
-
76
- if (lastSignature && lastSignature.appended) {
77
- debug('appended fields', { signer, appended: lastSignature.appended });
78
-
79
- lastSignature.appended.forEach((field) => {
80
- toBeVerifiedMeta = omit(toBeVerifiedMeta, field);
81
- });
51
+ const verifyMultiSig = (blockletMeta) => {
52
+ const { signatures: tmpSignatures } = blockletMeta, meta = __rest(blockletMeta, ["signatures"]);
53
+ const signatures = (0, cloneDeep_1.default)(tmpSignatures);
54
+ if (!Array.isArray(signatures)) {
55
+ throw new Error('Invalid signatures, signatures should be an array');
82
56
  }
83
-
84
- if (signature.excludes && signature.excludes.length > 0) {
85
- debug('excludes fields', { signer, excludes: signature.excludes });
86
-
87
- signature.excludes.forEach((field) => {
88
- toBeVerifiedMeta = omit(toBeVerifiedMeta, field);
89
- });
57
+ if (signatures.length === 0) {
58
+ throw new Error('Invalid signatures, found empty');
90
59
  }
91
-
92
- const type = toTypeInfo(signer);
93
- const wallet = fromPublicKey(pk, type);
94
- const verifyRes = wallet.verify(
95
- stableStringify({ ...toBeVerifiedMeta, signatures: [signature, ...signatures] }),
96
- sig
97
- );
98
- if (verifyRes !== true) {
99
- debug('verify failed', { signer });
100
-
101
- return verifyRes;
60
+ const { length } = signatures;
61
+ let lastSignature = null;
62
+ for (let i = 0; i < length; i++) {
63
+ const signature = signatures.shift();
64
+ // 验证delegation token
65
+ if (!verifyDelegationToken(signature)) {
66
+ return false;
67
+ }
68
+ const { sig, signer, pk } = signature.delegation
69
+ ? {
70
+ sig: signature.sig,
71
+ signer: signature.delegatee,
72
+ pk: signature.delegateePk,
73
+ }
74
+ : signature;
75
+ delete signature.sig;
76
+ debug('verify', { signer });
77
+ let toBeVerifiedMeta = Object.assign({}, meta);
78
+ if (lastSignature && lastSignature.appended) {
79
+ debug('appended fields', { signer, appended: lastSignature.appended });
80
+ lastSignature.appended.forEach((field) => {
81
+ toBeVerifiedMeta = (0, omit_1.default)(toBeVerifiedMeta, field);
82
+ });
83
+ }
84
+ if (signature.excludes && signature.excludes.length > 0) {
85
+ debug('excludes fields', { signer, excludes: signature.excludes });
86
+ signature.excludes.forEach((field) => {
87
+ toBeVerifiedMeta = (0, omit_1.default)(toBeVerifiedMeta, field);
88
+ });
89
+ }
90
+ const type = (0, did_1.toTypeInfo)(signer);
91
+ const wallet = (0, wallet_1.fromPublicKey)(pk, type);
92
+ const verifyRes = wallet.verify((0, json_stable_stringify_1.default)(Object.assign(Object.assign({}, toBeVerifiedMeta), { signatures: [signature, ...signatures] })), sig);
93
+ if (verifyRes !== true) {
94
+ debug('verify failed', { signer });
95
+ return verifyRes;
96
+ }
97
+ lastSignature = signature;
102
98
  }
103
-
104
- lastSignature = signature;
105
- }
106
-
107
- return true;
99
+ return true;
108
100
  };
101
+ module.exports = verifyMultiSig;
@@ -0,0 +1,9 @@
1
+ import { WalletObject } from '@ocap/wallet';
2
+ import { DIDType } from '@arcblock/did';
3
+ /**
4
+ * Gen DID from blocklet did and nodeSk
5
+ *
6
+ * Spec: https://github.com/ArcBlock/ABT-DID-Protocol#request-did-authentication
7
+ */
8
+ declare const getBlockletWallet: (blockletDid: string, nodeSk?: string, type?: DIDType, index?: number) => WalletObject;
9
+ export = getBlockletWallet;
package/lib/wallet.js CHANGED
@@ -1,35 +1,25 @@
1
- const { types } = require('@ocap/mcrypto');
2
- const { fromSecretKey } = require('@ocap/wallet');
3
- const { isValid } = require('@arcblock/did');
4
- const { fromAppDid } = require('@arcblock/did-ext');
5
-
1
+ "use strict";
2
+ const mcrypto_1 = require("@ocap/mcrypto");
3
+ const wallet_1 = require("@ocap/wallet");
4
+ const did_1 = require("@arcblock/did");
5
+ const did_ext_1 = require("@arcblock/did-ext");
6
6
  /**
7
7
  * Gen DID from blocklet did and nodeSk
8
8
  *
9
9
  * Spec: https://github.com/ArcBlock/ABT-DID-Protocol#request-did-authentication
10
- *
11
- * @public
12
- * @static
13
- * @param {string} blockletDid - blocklet did
14
- * @param {string} nodeSk - node sk used to derive blocklet sk
15
- * @param {object} [type={}]
16
- * @param {number} [index=0]
17
- * @returns {object} Wallet instance
18
10
  */
19
- const getBlockletWallet = (blockletDid, nodeSk, type = { role: types.RoleType.ROLE_APPLICATION }, index = 0) => {
20
- if (!isValid(blockletDid)) {
21
- try {
22
- return fromSecretKey(blockletDid, type);
23
- } catch (err) {
24
- throw new Error(`Cannot get blocklet wallet with invalid blocklet did or custom sk: ${err.message}`);
11
+ const getBlockletWallet = (blockletDid, nodeSk, type = { role: mcrypto_1.types.RoleType.ROLE_APPLICATION }, index = 0) => {
12
+ if (!(0, did_1.isValid)(blockletDid)) {
13
+ try {
14
+ return (0, wallet_1.fromSecretKey)(blockletDid, type);
15
+ }
16
+ catch (err) {
17
+ throw new Error(`Cannot get blocklet wallet with invalid blocklet did or custom sk: ${err.message}`);
18
+ }
19
+ }
20
+ if (!nodeSk) {
21
+ throw new Error('Cannot get blocklet wallet with empty node sk');
25
22
  }
26
- }
27
-
28
- if (!nodeSk) {
29
- throw new Error('Cannot get blocklet wallet with empty node sk');
30
- }
31
-
32
- return fromAppDid(blockletDid, nodeSk, type, index);
23
+ return (0, did_ext_1.fromAppDid)(blockletDid, nodeSk, type, index);
33
24
  };
34
-
35
25
  module.exports = getBlockletWallet;
package/package.json CHANGED
@@ -3,32 +3,40 @@
3
3
  "publishConfig": {
4
4
  "access": "public"
5
5
  },
6
- "version": "1.8.34",
6
+ "version": "1.8.36",
7
7
  "description": "Library to parse/validate/fix blocklet meta",
8
- "main": "lib/index.js",
8
+ "main": "./lib/index.js",
9
+ "typings": "./lib/index.d.ts",
9
10
  "files": [
10
11
  "lib"
11
12
  ],
12
13
  "scripts": {
13
- "lint": "eslint tests lib",
14
- "lint:fix": "eslint --fix tests lib",
14
+ "verify": "npm run lint:fix && npm run coverage && npm run build",
15
+ "lint": "eslint src tests",
16
+ "lint:fix": "npm run lint -- --fix",
15
17
  "test": "node tools/jest.js",
16
- "coverage": "npm run test -- --coverage"
18
+ "coverage": "npm run test -- --coverage",
19
+ "clean": "rm -fr lib",
20
+ "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",
21
+ "prebuild": "npm run clean && npm run types",
22
+ "build": "tsc"
17
23
  },
18
24
  "author": "wangshijun <wangshijun2020@gmail.com> (http://github.com/wangshijun)",
19
25
  "license": "MIT",
20
26
  "dependencies": {
21
- "@abtnode/constant": "1.8.34",
22
- "@abtnode/util": "1.8.34",
23
- "@arcblock/did": "1.18.13",
24
- "@arcblock/did-ext": "1.18.13",
25
- "@arcblock/did-util": "1.18.13",
26
- "@arcblock/jwt": "1.18.13",
27
- "@blocklet/constant": "1.8.34",
28
- "@ocap/asset": "1.18.13",
29
- "@ocap/mcrypto": "1.18.13",
30
- "@ocap/util": "1.18.13",
31
- "@ocap/wallet": "1.18.13",
27
+ "@abtnode/client": "1.8.36",
28
+ "@abtnode/constant": "1.8.36",
29
+ "@abtnode/util": "1.8.36",
30
+ "@arcblock/did": "1.18.15",
31
+ "@arcblock/did-ext": "1.18.15",
32
+ "@arcblock/did-util": "1.18.15",
33
+ "@arcblock/jwt": "1.18.15",
34
+ "@blocklet/constant": "1.8.36",
35
+ "@ocap/asset": "1.18.15",
36
+ "@ocap/mcrypto": "1.18.15",
37
+ "@ocap/types": "1.18.15",
38
+ "@ocap/util": "1.18.15",
39
+ "@ocap/wallet": "1.18.15",
32
40
  "ajv": "^8.11.0",
33
41
  "axios": "^0.27.2",
34
42
  "cjk-length": "^1.0.0",
@@ -44,16 +52,30 @@
44
52
  "promise.any": "^2.0.4",
45
53
  "slugify": "^1.6.5",
46
54
  "url-join": "^4.0.1",
55
+ "utility-types": "^3.10.0",
47
56
  "validate-npm-package-name": "^3.0.0"
48
57
  },
49
58
  "devDependencies": {
59
+ "@abtnode/client": "^1.8.34",
60
+ "@arcblock/eslint-config-ts": "^0.2.3",
61
+ "@types/express": "^4.17.14",
62
+ "@types/jest": "^29.2.2",
50
63
  "@types/joi": "^17.2.3",
64
+ "@types/js-yaml": "^4.0.5",
65
+ "@types/validate-npm-package-name": "^4.0.0",
66
+ "@typescript-eslint/eslint-plugin": "^5.42.0",
67
+ "@typescript-eslint/parser": "^5.42.0",
51
68
  "body-parser": "^1.20.1",
52
69
  "compression": "^1.7.4",
53
70
  "detect-port": "^1.5.1",
71
+ "eslint": "^8.27.0",
54
72
  "expand-tilde": "^2.0.2",
55
73
  "express": "^4.18.2",
56
- "jest": "^27.5.1"
74
+ "jest": "^29.3.0",
75
+ "prettier": "^2.7.1",
76
+ "ts-jest": "^29.0.3",
77
+ "ts-node": "^10.9.1",
78
+ "typescript": "^4.8.4"
57
79
  },
58
- "gitHead": "c5fbb8e57493db62f212217cfde1980c82f00297"
80
+ "gitHead": "507e974ce88bad1aa002c593130b32982207f803"
59
81
  }