@metamask/snaps-utils 0.24.0 → 0.24.1

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 (4) hide show
  1. package/dist/manifest/validation.d.ts +24 -30
  2. package/dist/manifest/validation.js +8 -11
  3. package/dist/manifest/validation.js.map +1 -1
  4. package/package.json +2 -2
package/dist/manifest/validation.d.ts CHANGED
@@ -24,6 +24,10 @@ export declare type Base64Opts = {
24
24
  */
25
25
  export declare const base64: <T extends string, S>(struct: Struct<T, S>, opts?: Base64Opts) => Struct<T, S>;
26
26
  export declare const Bip32PathStruct: Struct<string[], Struct<string, null>>;
27
+ export declare const bip32entropy: <T extends {
28
+ path: string[];
29
+ curve: string;
30
+ }, S>(struct: Struct<T, S>) => Struct<T, S>;
27
31
  export declare const Bip32EntropyStruct: Struct<{
28
32
  path: string[];
29
33
  curve: "ed25519" | "secp256k1";
@@ -35,20 +39,20 @@ export declare const Bip32EntropyStruct: Struct<{
35
39
  }>;
36
40
  }>;
37
41
  export declare type Bip32Entropy = Infer<typeof Bip32EntropyStruct>;
38
- export declare const Bip32PublicKeyStruct: Struct<{
42
+ export declare const SnapGetBip32EntropyPermissionsStruct: Struct<{
43
+ path: string[];
44
+ curve: "ed25519" | "secp256k1";
45
+ }[], Struct<{
39
46
  path: string[];
40
- curve: "secp256k1" | "ed225519";
41
- compressed?: boolean | undefined;
47
+ curve: "ed25519" | "secp256k1";
42
48
  }, {
43
49
  path: Struct<string[], Struct<string, null>>;
44
- curve: Struct<"secp256k1" | "ed225519", {
50
+ curve: Struct<"ed25519" | "secp256k1", {
51
+ ed25519: "ed25519";
45
52
  secp256k1: "secp256k1";
46
- ed225519: "ed225519";
47
53
  }>;
48
- compressed: Struct<boolean | undefined, null>;
49
- }>;
50
- export declare type Bip32PublicKey = Infer<typeof Bip32PublicKeyStruct>;
51
- declare const PermissionsStruct: Struct<{
54
+ }>>;
55
+ export declare const PermissionsStruct: Struct<{
52
56
  'endowment:long-running'?: {} | undefined;
53
57
  'endowment:network-access'?: {} | undefined;
54
58
  'endowment:transaction-insight'?: {
@@ -74,8 +78,7 @@ declare const PermissionsStruct: Struct<{
74
78
  }[] | undefined;
75
79
  snap_getBip32PublicKey?: {
76
80
  path: string[];
77
- curve: "secp256k1" | "ed225519";
78
- compressed?: boolean | undefined;
81
+ curve: "ed25519" | "secp256k1";
79
82
  }[] | undefined;
80
83
  snap_getBip44Entropy?: {
81
84
  coinType: number;
@@ -159,19 +162,16 @@ declare const PermissionsStruct: Struct<{
159
162
  }>>;
160
163
  snap_getBip32PublicKey: Struct<{
161
164
  path: string[];
162
- curve: "secp256k1" | "ed225519";
163
- compressed?: boolean | undefined;
165
+ curve: "ed25519" | "secp256k1";
164
166
  }[] | undefined, Struct<{
165
167
  path: string[];
166
- curve: "secp256k1" | "ed225519";
167
- compressed?: boolean | undefined;
168
+ curve: "ed25519" | "secp256k1";
168
169
  }, {
169
170
  path: Struct<string[], Struct<string, null>>;
170
- curve: Struct<"secp256k1" | "ed225519", {
171
+ curve: Struct<"ed25519" | "secp256k1", {
172
+ ed25519: "ed25519";
171
173
  secp256k1: "secp256k1";
172
- ed225519: "ed225519";
173
174
  }>;
174
- compressed: Struct<boolean | undefined, null>;
175
175
  }>>;
176
176
  snap_getBip44Entropy: Struct<{
177
177
  coinType: number;
@@ -243,8 +243,7 @@ export declare const SnapManifestStruct: Struct<{
243
243
  }[] | undefined;
244
244
  snap_getBip32PublicKey?: {
245
245
  path: string[];
246
- curve: "secp256k1" | "ed225519";
247
- compressed?: boolean | undefined;
246
+ curve: "ed25519" | "secp256k1";
248
247
  }[] | undefined;
249
248
  snap_getBip44Entropy?: {
250
249
  coinType: number;
@@ -336,8 +335,7 @@ export declare const SnapManifestStruct: Struct<{
336
335
  }[] | undefined;
337
336
  snap_getBip32PublicKey?: {
338
337
  path: string[];
339
- curve: "secp256k1" | "ed225519";
340
- compressed?: boolean | undefined;
338
+ curve: "ed25519" | "secp256k1";
341
339
  }[] | undefined;
342
340
  snap_getBip44Entropy?: {
343
341
  coinType: number;
@@ -421,19 +419,16 @@ export declare const SnapManifestStruct: Struct<{
421
419
  }>>;
422
420
  snap_getBip32PublicKey: Struct<{
423
421
  path: string[];
424
- curve: "secp256k1" | "ed225519";
425
- compressed?: boolean | undefined;
422
+ curve: "ed25519" | "secp256k1";
426
423
  }[] | undefined, Struct<{
427
424
  path: string[];
428
- curve: "secp256k1" | "ed225519";
429
- compressed?: boolean | undefined;
425
+ curve: "ed25519" | "secp256k1";
430
426
  }, {
431
427
  path: Struct<string[], Struct<string, null>>;
432
- curve: Struct<"secp256k1" | "ed225519", {
428
+ curve: Struct<"ed25519" | "secp256k1", {
429
+ ed25519: "ed25519";
433
430
  secp256k1: "secp256k1";
434
- ed225519: "ed225519";
435
431
  }>;
436
- compressed: Struct<boolean | undefined, null>;
437
432
  }>>;
438
433
  snap_getBip44Entropy: Struct<{
439
434
  coinType: number;
@@ -480,4 +475,3 @@ export declare function isSnapManifest(value: unknown): value is SnapManifest;
480
475
  * @throws If the value is not a valid {@link SnapManifest} object.
481
476
  */
482
477
  export declare function assertIsSnapManifest(value: unknown): asserts value is SnapManifest;
483
- export {};
package/dist/manifest/validation.js CHANGED
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.assertIsSnapManifest = exports.isSnapManifest = exports.SnapManifestStruct = exports.Bip32PublicKeyStruct = exports.Bip32EntropyStruct = exports.Bip32PathStruct = exports.base64 = exports.SIP_6_MAGIC_VALUE = void 0;
3
+ exports.assertIsSnapManifest = exports.isSnapManifest = exports.SnapManifestStruct = exports.PermissionsStruct = exports.SnapGetBip32EntropyPermissionsStruct = exports.Bip32EntropyStruct = exports.bip32entropy = exports.Bip32PathStruct = exports.base64 = exports.SIP_6_MAGIC_VALUE = void 0;
4
4
  const utils_1 = require("@metamask/utils");
5
5
  const superstruct_1 = require("superstruct");
6
6
  const cronjob_1 = require("../cronjob");
@@ -66,17 +66,14 @@ const bip32entropy = (struct) => (0, superstruct_1.refine)(struct, 'BIP-32 entro
66
66
  }
67
67
  return true;
68
68
  });
69
+ exports.bip32entropy = bip32entropy;
69
70
  // Used outside @metamask/snap-utils
70
- exports.Bip32EntropyStruct = bip32entropy((0, superstruct_1.object)({
71
+ exports.Bip32EntropyStruct = (0, exports.bip32entropy)((0, superstruct_1.type)({
71
72
  path: exports.Bip32PathStruct,
72
73
  curve: (0, superstruct_1.enums)(['ed25519', 'secp256k1']),
73
74
  }));
74
- exports.Bip32PublicKeyStruct = bip32entropy((0, superstruct_1.object)({
75
- path: exports.Bip32PathStruct,
76
- curve: (0, superstruct_1.enums)(['ed225519', 'secp256k1']),
77
- compressed: (0, superstruct_1.optional)((0, superstruct_1.boolean)()),
78
- }));
79
- const PermissionsStruct = (0, superstruct_1.type)({
75
+ exports.SnapGetBip32EntropyPermissionsStruct = (0, superstruct_1.size)((0, superstruct_1.array)(exports.Bip32EntropyStruct), 1, Infinity);
76
+ exports.PermissionsStruct = (0, superstruct_1.type)({
80
77
  'endowment:long-running': (0, superstruct_1.optional)((0, superstruct_1.object)({})),
81
78
  'endowment:network-access': (0, superstruct_1.optional)((0, superstruct_1.object)({})),
82
79
  'endowment:transaction-insight': (0, superstruct_1.optional)((0, superstruct_1.object)({
@@ -86,8 +83,8 @@ const PermissionsStruct = (0, superstruct_1.type)({
86
83
  snap_confirm: (0, superstruct_1.optional)((0, superstruct_1.object)({})),
87
84
  snap_manageState: (0, superstruct_1.optional)((0, superstruct_1.object)({})),
88
85
  snap_notify: (0, superstruct_1.optional)((0, superstruct_1.object)({})),
89
- snap_getBip32Entropy: (0, superstruct_1.optional)((0, superstruct_1.size)((0, superstruct_1.array)(exports.Bip32EntropyStruct), 1, Infinity)),
90
- snap_getBip32PublicKey: (0, superstruct_1.optional)((0, superstruct_1.size)((0, superstruct_1.array)(exports.Bip32PublicKeyStruct), 1, Infinity)),
86
+ snap_getBip32Entropy: (0, superstruct_1.optional)(exports.SnapGetBip32EntropyPermissionsStruct),
87
+ snap_getBip32PublicKey: (0, superstruct_1.optional)(exports.SnapGetBip32EntropyPermissionsStruct),
91
88
  snap_getBip44Entropy: (0, superstruct_1.optional)((0, superstruct_1.size)((0, superstruct_1.array)((0, superstruct_1.object)({ coinType: (0, superstruct_1.size)((0, superstruct_1.integer)(), 0, 2 ** 32 - 1) })), 1, Infinity)),
92
89
  snap_getEntropy: (0, superstruct_1.optional)((0, superstruct_1.object)({})),
93
90
  'endowment:keyring': (0, superstruct_1.optional)((0, superstruct_1.object)({
@@ -116,7 +113,7 @@ exports.SnapManifestStruct = (0, superstruct_1.object)({
116
113
  }),
117
114
  }),
118
115
  }),
119
- initialPermissions: PermissionsStruct,
116
+ initialPermissions: exports.PermissionsStruct,
120
117
  manifestVersion: (0, superstruct_1.literal)('0.1'),
121
118
  });
122
119
  /**
package/dist/manifest/validation.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"validation.js","sourceRoot":"","sources":["../../src/manifest/validation.ts"],"names":[],"mappings":";;;AAAA,2CAAuD;AACvD,6CAiBqB;AACrB,wCAA6D;AAC7D,4CAAgD;AAChD,oCAAuE;AAEvE,0BAA0B;AACb,QAAA,iBAAiB,GAAG,aAA6B,CAAC;AAE/D,+EAA+E;AAC/E,gCAAgC;AAChC,MAAM,kBAAkB,GAAa,CAAC,yBAAiB,CAAC,CAAC;AAmBzD;;;;;;GAMG;AACI,MAAM,MAAM,GAAG,CACpB,MAAoB,EACpB,OAAmB,EAAE,EACrB,EAAE;;IACF,MAAM,eAAe,GAAG,MAAA,IAAI,CAAC,eAAe,mCAAI,KAAK,CAAC;IACtD,MAAM,YAAY,GAAG,MAAA,IAAI,CAAC,YAAY,mCAAI,QAAQ,CAAC;IAEnD,IAAI,OAAe,CAAC;IACpB,IAAI,YAAY,KAAK,QAAQ,EAAE;QAC7B,OAAO,GAAG,MAAM,CAAC,GAAG,CAAA,gBAAgB,CAAC;KACtC;SAAM;QACL,IAAA,cAAM,EAAC,YAAY,KAAK,WAAW,CAAC,CAAC;QACrC,OAAO,GAAG,MAAM,CAAC,GAAG,CAAA,eAAe,CAAC;KACrC;IAED,IAAI,EAAU,CAAC;IACf,IAAI,eAAe,EAAE;QACnB,EAAE,GAAG,IAAI,MAAM,CACb,OAAO,OAAO,WAAW,OAAO,QAAQ,OAAO,UAAU,EACzD,GAAG,CACJ,CAAC;KACH;SAAM;QACL,EAAE,GAAG,IAAI,MAAM,CACb,OAAO,OAAO,WAAW,OAAO,SAAS,OAAO,QAAQ,OAAO,UAAU,EACzE,GAAG,CACJ,CAAC;KACH;IAED,OAAO,IAAA,qBAAO,EAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AAC7B,CAAC,CAAC;AA7BW,QAAA,MAAM,UA6BjB;AAEF,MAAM,iBAAiB,GAAG,UAAU,CAAC;AACxB,QAAA,eAAe,GAAG,IAAA,oBAAM,EACnC,IAAA,mBAAK,EAAC,IAAA,oBAAM,GAAE,CAAC,EACf,aAAa,EACb,CAAC,IAAI,EAAE,EAAE;IACP,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;QACrB,OAAO,uDAAuD,CAAC;KAChE;IAED,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE;QACnB,OAAO,2BAA2B,CAAC;KACpC;IAED,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;QACnB,OAAO,6CAA6C,CAAC;KACtD;IAED,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE;QACzD,OAAO,oDAAoD,CAAC;KAC7D;IAED,IAAI,kBAAkB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE;QACxC,OAAO,gBAAgB,IAAI,CAAC,CAAC,CAAC,0CAA0C,CAAC;KAC1E;IAED,OAAO,IAAI,CAAC;AACd,CAAC,CACF,CAAC;AAEF,MAAM,YAAY,GAAG,CACnB,MAAoB,EACpB,EAAE,CACF,IAAA,oBAAM,EAAC,MAAM,EAAE,gBAAgB,EAAE,CAAC,KAAK,EAAE,EAAE;IACzC,IACE,KAAK,CAAC,KAAK,KAAK,SAAS;QACzB,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EACjD;QACA,OAAO,4CAA4C,CAAC;KACrD;IAED,OAAO,IAAI,CAAC;AACd,CAAC,CAAC,CAAC;AAEL,oCAAoC;AACvB,QAAA,kBAAkB,GAAG,YAAY,CAC5C,IAAA,oBAAM,EAAC;IACL,IAAI,EAAE,uBAAe;IACrB,KAAK,EAAE,IAAA,mBAAK,EAAC,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;CACvC,CAAC,CACH,CAAC;AAIW,QAAA,oBAAoB,GAAG,YAAY,CAC9C,IAAA,oBAAM,EAAC;IACL,IAAI,EAAE,uBAAe;IACrB,KAAK,EAAE,IAAA,mBAAK,EAAC,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;IACvC,UAAU,EAAE,IAAA,sBAAQ,EAAC,IAAA,qBAAO,GAAE,CAAC;CAChC,CAAC,CACH,CAAC;AAIF,MAAM,iBAAiB,GAAG,IAAA,kBAAI,EAAC;IAC7B,wBAAwB,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,EAAC,EAAE,CAAC,CAAC;IAC9C,0BAA0B,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,EAAC,EAAE,CAAC,CAAC;IAChD,+BAA+B,EAAE,IAAA,sBAAQ,EACvC,IAAA,oBAAM,EAAC;QACL,sBAAsB,EAAE,IAAA,sBAAQ,EAAC,IAAA,qBAAO,GAAE,CAAC;KAC5C,CAAC,CACH;IACD,mBAAmB,EAAE,IAAA,sBAAQ,EAC3B,IAAA,oBAAM,EAAC,EAAE,IAAI,EAAE,yCAA+B,EAAE,CAAC,CAClD;IACD,YAAY,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,EAAC,EAAE,CAAC,CAAC;IAClC,gBAAgB,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,EAAC,EAAE,CAAC,CAAC;IACtC,WAAW,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,EAAC,EAAE,CAAC,CAAC;IACjC,oBAAoB,EAAE,IAAA,sBAAQ,EAAC,IAAA,kBAAI,EAAC,IAAA,mBAAK,EAAC,0BAAkB,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC5E,sBAAsB,EAAE,IAAA,sBAAQ,EAC9B,IAAA,kBAAI,EAAC,IAAA,mBAAK,EAAC,4BAAoB,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,CAC/C;IACD,oBAAoB,EAAE,IAAA,sBAAQ,EAC5B,IAAA,kBAAI,EACF,IAAA,mBAAK,EAAC,IAAA,oBAAM,EAAC,EAAE,QAAQ,EAAE,IAAA,kBAAI,EAAC,IAAA,qBAAO,GAAE,EAAE,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,EAC5D,CAAC,EACD,QAAQ,CACT,CACF;IACD,eAAe,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,EAAC,EAAE,CAAC,CAAC;IACrC,mBAAmB,EAAE,IAAA,sBAAQ,EAC3B,IAAA,oBAAM,EAAC;QACL,UAAU,EAAE,4BAAgB;KAC7B,CAAC,CACH;CACF,CAAC,CAAC;AAIU,QAAA,kBAAkB,GAAG,IAAA,oBAAM,EAAC;IACvC,OAAO,EAAE,qBAAa;IACtB,WAAW,EAAE,IAAA,kBAAI,EAAC,IAAA,oBAAM,GAAE,EAAE,CAAC,EAAE,GAAG,CAAC;IACnC,YAAY,EAAE,IAAA,kBAAI,EAChB,IAAA,qBAAO,EACL,IAAA,oBAAM,GAAE,EACR,kHAAkH,CACnH,EACD,CAAC,EACD,GAAG,CACJ;IACD,UAAU,EAAE,IAAA,sBAAQ,EAClB,IAAA,oBAAM,EAAC;QACL,IAAI,EAAE,IAAA,kBAAI,EAAC,IAAA,oBAAM,GAAE,EAAE,CAAC,EAAE,QAAQ,CAAC;QACjC,GAAG,EAAE,IAAA,kBAAI,EAAC,IAAA,oBAAM,GAAE,EAAE,CAAC,EAAE,QAAQ,CAAC;KACjC,CAAC,CACH;IACD,MAAM,EAAE,IAAA,oBAAM,EAAC;QACb,MAAM,EAAE,IAAA,kBAAI,EAAC,IAAA,cAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,EAAE,eAAe,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC;QACjE,QAAQ,EAAE,IAAA,oBAAM,EAAC;YACf,GAAG,EAAE,IAAA,oBAAM,EAAC;gBACV,QAAQ,EAAE,IAAA,kBAAI,EAAC,IAAA,oBAAM,GAAE,EAAE,CAAC,EAAE,QAAQ,CAAC;gBACrC,QAAQ,EAAE,IAAA,sBAAQ,EAAC,IAAA,kBAAI,EAAC,IAAA,oBAAM,GAAE,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;gBAC/C,WAAW,EAAE,kBAAU;gBACvB,QAAQ,EAAE,IAAA,mBAAK,EAAC;oBACd,IAAA,qBAAO,EAAC,4BAA4B,CAAC;oBACrC,IAAA,qBAAO,EAAC,6BAA6B,CAAC;iBACvC,CAAC;aACH,CAAC;SACH,CAAC;KACH,CAAC;IACF,kBAAkB,EAAE,iBAAiB;IACrC,eAAe,EAAE,IAAA,qBAAO,EAAC,KAAK,CAAC;CAChC,CAAC,CAAC;AAIH;;;;;GAKG;AACH,SAAgB,cAAc,CAAC,KAAc;IAC3C,OAAO,IAAA,gBAAE,EAAC,KAAK,EAAE,0BAAkB,CAAC,CAAC;AACvC,CAAC;AAFD,wCAEC;AAED;;;;;GAKG;AACH,SAAgB,oBAAoB,CAClC,KAAc;IAEd,IAAA,oBAAY,EACV,KAAK,EACL,0BAAkB,EAClB,IAAI,wBAAgB,CAAC,QAAQ,cAAc,CAC5C,CAAC;AACJ,CAAC;AARD,oDAQC","sourcesContent":["import { assert, assertStruct } from '@metamask/utils';\nimport {\n array,\n boolean,\n enums,\n Infer,\n integer,\n is,\n literal,\n object,\n optional,\n pattern,\n refine,\n size,\n string,\n Struct,\n type,\n union,\n} from 'superstruct';\nimport { CronjobSpecificationArrayStruct } from '../cronjob';\nimport { NamespacesStruct } from '../namespace';\nimport { NameStruct, NpmSnapFileNames, VersionStruct } from '../types';\n\n// 0xd36e6170 - 0x80000000\nexport const SIP_6_MAGIC_VALUE = `1399742832'` as `${number}'`;\n\n// BIP-43 purposes that cannot be used for entropy derivation. These are in the\n// string form, ending with `'`.\nconst FORBIDDEN_PURPOSES: string[] = [SIP_6_MAGIC_VALUE];\n\nexport type Base64Opts = {\n /**\n * Is the `=` padding at the end required or not.\n *\n * @default false\n */\n // Padding is optional in RFC 4648, that's why the default value is false\n paddingRequired?: boolean;\n /**\n * Which character set should be used.\n * The sets are based on {@link https://datatracker.ietf.org/doc/html/rfc4648 RFC 4648}.\n *\n * @default 'base64'\n */\n characterSet?: 'base64' | 'base64url';\n};\n\n/**\n * Ensure that a provided string-based struct is valid base64.\n *\n * @param struct - The string based struct.\n * @param opts - Optional options to specialize base64 validation. See {@link Base64Opts} documentation.\n * @returns A superstruct validating base64.\n */\nexport const base64 = <T extends string, S>(\n struct: Struct<T, S>,\n opts: Base64Opts = {},\n) => {\n const paddingRequired = opts.paddingRequired ?? false;\n const characterSet = opts.characterSet ?? 'base64';\n\n let letters: string;\n if (characterSet === 'base64') {\n letters = String.raw`[A-Za-z0-9+\\/]`;\n } else {\n assert(characterSet === 'base64url');\n letters = String.raw`[-_A-Za-z0-9]`;\n }\n\n let re: RegExp;\n if (paddingRequired) {\n re = new RegExp(\n `^(?:${letters}{4})*(?:${letters}{3}=|${letters}{2}==)?$`,\n 'u',\n );\n } else {\n re = new RegExp(\n `^(?:${letters}{4})*(?:${letters}{2,3}|${letters}{3}=|${letters}{2}==)?$`,\n 'u',\n );\n }\n\n return pattern(struct, re);\n};\n\nconst BIP32_INDEX_REGEX = /^\\d+'?$/u;\nexport const Bip32PathStruct = refine(\n array(string()),\n 'BIP-32 path',\n (path) => {\n if (path.length === 0) {\n return 'Path must be a non-empty BIP-32 derivation path array';\n }\n\n if (path[0] !== 'm') {\n return 'Path must start with \"m\".';\n }\n\n if (path.length < 3) {\n return 'Paths must have a length of at least three.';\n }\n\n if (path.slice(1).some((e) => !BIP32_INDEX_REGEX.test(e))) {\n return 'Path must be a valid BIP-32 derivation path array.';\n }\n\n if (FORBIDDEN_PURPOSES.includes(path[1])) {\n return `The purpose \"${path[1]}\" is not allowed for entropy derivation.`;\n }\n\n return true;\n },\n);\n\nconst bip32entropy = <T extends { path: string[]; curve: string }, S>(\n struct: Struct<T, S>,\n) =>\n refine(struct, 'BIP-32 entropy', (value) => {\n if (\n value.curve === 'ed25519' &&\n value.path.slice(1).some((e) => !e.endsWith(\"'\"))\n ) {\n return 'Ed25519 does not support unhardened paths.';\n }\n\n return true;\n });\n\n// Used outside @metamask/snap-utils\nexport const Bip32EntropyStruct = bip32entropy(\n object({\n path: Bip32PathStruct,\n curve: enums(['ed25519', 'secp256k1']),\n }),\n);\n\nexport type Bip32Entropy = Infer<typeof Bip32EntropyStruct>;\n\nexport const Bip32PublicKeyStruct = bip32entropy(\n object({\n path: Bip32PathStruct,\n curve: enums(['ed225519', 'secp256k1']),\n compressed: optional(boolean()),\n }),\n);\n\nexport type Bip32PublicKey = Infer<typeof Bip32PublicKeyStruct>;\n\nconst PermissionsStruct = type({\n 'endowment:long-running': optional(object({})),\n 'endowment:network-access': optional(object({})),\n 'endowment:transaction-insight': optional(\n object({\n allowTransactionOrigin: optional(boolean()),\n }),\n ),\n 'endowment:cronjob': optional(\n object({ jobs: CronjobSpecificationArrayStruct }),\n ),\n snap_confirm: optional(object({})),\n snap_manageState: optional(object({})),\n snap_notify: optional(object({})),\n snap_getBip32Entropy: optional(size(array(Bip32EntropyStruct), 1, Infinity)),\n snap_getBip32PublicKey: optional(\n size(array(Bip32PublicKeyStruct), 1, Infinity),\n ),\n snap_getBip44Entropy: optional(\n size(\n array(object({ coinType: size(integer(), 0, 2 ** 32 - 1) })),\n 1,\n Infinity,\n ),\n ),\n snap_getEntropy: optional(object({})),\n 'endowment:keyring': optional(\n object({\n namespaces: NamespacesStruct,\n }),\n ),\n});\n\nexport type SnapPermissions = Infer<typeof PermissionsStruct>;\n\nexport const SnapManifestStruct = object({\n version: VersionStruct,\n description: size(string(), 1, 280),\n proposedName: size(\n pattern(\n string(),\n /^(?:[A-Za-z0-9-_]+( [A-Za-z0-9-_]+)*)|(?:(?:@[A-Za-z0-9-*~][A-Za-z0-9-*._~]*\\/)?[A-Za-z0-9-~][A-Za-z0-9-._~]*)$/u,\n ),\n 1,\n 214,\n ),\n repository: optional(\n object({\n type: size(string(), 1, Infinity),\n url: size(string(), 1, Infinity),\n }),\n ),\n source: object({\n shasum: size(base64(string(), { paddingRequired: true }), 44, 44),\n location: object({\n npm: object({\n filePath: size(string(), 1, Infinity),\n iconPath: optional(size(string(), 1, Infinity)),\n packageName: NameStruct,\n registry: union([\n literal('https://registry.npmjs.org'),\n literal('https://registry.npmjs.org/'),\n ]),\n }),\n }),\n }),\n initialPermissions: PermissionsStruct,\n manifestVersion: literal('0.1'),\n});\n\nexport type SnapManifest = Infer<typeof SnapManifestStruct>;\n\n/**\n * Check if the given value is a valid {@link SnapManifest} object.\n *\n * @param value - The value to check.\n * @returns Whether the value is a valid {@link SnapManifest} object.\n */\nexport function isSnapManifest(value: unknown): value is SnapManifest {\n return is(value, SnapManifestStruct);\n}\n\n/**\n * Assert that the given value is a valid {@link SnapManifest} object.\n *\n * @param value - The value to check.\n * @throws If the value is not a valid {@link SnapManifest} object.\n */\nexport function assertIsSnapManifest(\n value: unknown,\n): asserts value is SnapManifest {\n assertStruct(\n value,\n SnapManifestStruct,\n `\"${NpmSnapFileNames.Manifest}\" is invalid`,\n );\n}\n"]}
1
+ {"version":3,"file":"validation.js","sourceRoot":"","sources":["../../src/manifest/validation.ts"],"names":[],"mappings":";;;AAAA,2CAAuD;AACvD,6CAiBqB;AACrB,wCAA6D;AAC7D,4CAAgD;AAChD,oCAAuE;AAEvE,0BAA0B;AACb,QAAA,iBAAiB,GAAG,aAA6B,CAAC;AAE/D,+EAA+E;AAC/E,gCAAgC;AAChC,MAAM,kBAAkB,GAAa,CAAC,yBAAiB,CAAC,CAAC;AAmBzD;;;;;;GAMG;AACI,MAAM,MAAM,GAAG,CACpB,MAAoB,EACpB,OAAmB,EAAE,EACrB,EAAE;;IACF,MAAM,eAAe,GAAG,MAAA,IAAI,CAAC,eAAe,mCAAI,KAAK,CAAC;IACtD,MAAM,YAAY,GAAG,MAAA,IAAI,CAAC,YAAY,mCAAI,QAAQ,CAAC;IAEnD,IAAI,OAAe,CAAC;IACpB,IAAI,YAAY,KAAK,QAAQ,EAAE;QAC7B,OAAO,GAAG,MAAM,CAAC,GAAG,CAAA,gBAAgB,CAAC;KACtC;SAAM;QACL,IAAA,cAAM,EAAC,YAAY,KAAK,WAAW,CAAC,CAAC;QACrC,OAAO,GAAG,MAAM,CAAC,GAAG,CAAA,eAAe,CAAC;KACrC;IAED,IAAI,EAAU,CAAC;IACf,IAAI,eAAe,EAAE;QACnB,EAAE,GAAG,IAAI,MAAM,CACb,OAAO,OAAO,WAAW,OAAO,QAAQ,OAAO,UAAU,EACzD,GAAG,CACJ,CAAC;KACH;SAAM;QACL,EAAE,GAAG,IAAI,MAAM,CACb,OAAO,OAAO,WAAW,OAAO,SAAS,OAAO,QAAQ,OAAO,UAAU,EACzE,GAAG,CACJ,CAAC;KACH;IAED,OAAO,IAAA,qBAAO,EAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AAC7B,CAAC,CAAC;AA7BW,QAAA,MAAM,UA6BjB;AAEF,MAAM,iBAAiB,GAAG,UAAU,CAAC;AACxB,QAAA,eAAe,GAAG,IAAA,oBAAM,EACnC,IAAA,mBAAK,EAAC,IAAA,oBAAM,GAAE,CAAC,EACf,aAAa,EACb,CAAC,IAAI,EAAE,EAAE;IACP,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;QACrB,OAAO,uDAAuD,CAAC;KAChE;IAED,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE;QACnB,OAAO,2BAA2B,CAAC;KACpC;IAED,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;QACnB,OAAO,6CAA6C,CAAC;KACtD;IAED,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE;QACzD,OAAO,oDAAoD,CAAC;KAC7D;IAED,IAAI,kBAAkB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE;QACxC,OAAO,gBAAgB,IAAI,CAAC,CAAC,CAAC,0CAA0C,CAAC;KAC1E;IAED,OAAO,IAAI,CAAC;AACd,CAAC,CACF,CAAC;AAEK,MAAM,YAAY,GAAG,CAC1B,MAAoB,EACpB,EAAE,CACF,IAAA,oBAAM,EAAC,MAAM,EAAE,gBAAgB,EAAE,CAAC,KAAK,EAAE,EAAE;IACzC,IACE,KAAK,CAAC,KAAK,KAAK,SAAS;QACzB,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EACjD;QACA,OAAO,4CAA4C,CAAC;KACrD;IAED,OAAO,IAAI,CAAC;AACd,CAAC,CAAC,CAAC;AAZQ,QAAA,YAAY,gBAYpB;AAEL,oCAAoC;AACvB,QAAA,kBAAkB,GAAG,IAAA,oBAAY,EAC5C,IAAA,kBAAI,EAAC;IACH,IAAI,EAAE,uBAAe;IACrB,KAAK,EAAE,IAAA,mBAAK,EAAC,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;CACvC,CAAC,CACH,CAAC;AAIW,QAAA,oCAAoC,GAAG,IAAA,kBAAI,EACtD,IAAA,mBAAK,EAAC,0BAAkB,CAAC,EACzB,CAAC,EACD,QAAQ,CACT,CAAC;AAEW,QAAA,iBAAiB,GAAG,IAAA,kBAAI,EAAC;IACpC,wBAAwB,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,EAAC,EAAE,CAAC,CAAC;IAC9C,0BAA0B,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,EAAC,EAAE,CAAC,CAAC;IAChD,+BAA+B,EAAE,IAAA,sBAAQ,EACvC,IAAA,oBAAM,EAAC;QACL,sBAAsB,EAAE,IAAA,sBAAQ,EAAC,IAAA,qBAAO,GAAE,CAAC;KAC5C,CAAC,CACH;IACD,mBAAmB,EAAE,IAAA,sBAAQ,EAC3B,IAAA,oBAAM,EAAC,EAAE,IAAI,EAAE,yCAA+B,EAAE,CAAC,CAClD;IACD,YAAY,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,EAAC,EAAE,CAAC,CAAC;IAClC,gBAAgB,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,EAAC,EAAE,CAAC,CAAC;IACtC,WAAW,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,EAAC,EAAE,CAAC,CAAC;IACjC,oBAAoB,EAAE,IAAA,sBAAQ,EAAC,4CAAoC,CAAC;IACpE,sBAAsB,EAAE,IAAA,sBAAQ,EAAC,4CAAoC,CAAC;IACtE,oBAAoB,EAAE,IAAA,sBAAQ,EAC5B,IAAA,kBAAI,EACF,IAAA,mBAAK,EAAC,IAAA,oBAAM,EAAC,EAAE,QAAQ,EAAE,IAAA,kBAAI,EAAC,IAAA,qBAAO,GAAE,EAAE,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,EAC5D,CAAC,EACD,QAAQ,CACT,CACF;IACD,eAAe,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,EAAC,EAAE,CAAC,CAAC;IACrC,mBAAmB,EAAE,IAAA,sBAAQ,EAC3B,IAAA,oBAAM,EAAC;QACL,UAAU,EAAE,4BAAgB;KAC7B,CAAC,CACH;CACF,CAAC,CAAC;AAIU,QAAA,kBAAkB,GAAG,IAAA,oBAAM,EAAC;IACvC,OAAO,EAAE,qBAAa;IACtB,WAAW,EAAE,IAAA,kBAAI,EAAC,IAAA,oBAAM,GAAE,EAAE,CAAC,EAAE,GAAG,CAAC;IACnC,YAAY,EAAE,IAAA,kBAAI,EAChB,IAAA,qBAAO,EACL,IAAA,oBAAM,GAAE,EACR,kHAAkH,CACnH,EACD,CAAC,EACD,GAAG,CACJ;IACD,UAAU,EAAE,IAAA,sBAAQ,EAClB,IAAA,oBAAM,EAAC;QACL,IAAI,EAAE,IAAA,kBAAI,EAAC,IAAA,oBAAM,GAAE,EAAE,CAAC,EAAE,QAAQ,CAAC;QACjC,GAAG,EAAE,IAAA,kBAAI,EAAC,IAAA,oBAAM,GAAE,EAAE,CAAC,EAAE,QAAQ,CAAC;KACjC,CAAC,CACH;IACD,MAAM,EAAE,IAAA,oBAAM,EAAC;QACb,MAAM,EAAE,IAAA,kBAAI,EAAC,IAAA,cAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,EAAE,eAAe,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC;QACjE,QAAQ,EAAE,IAAA,oBAAM,EAAC;YACf,GAAG,EAAE,IAAA,oBAAM,EAAC;gBACV,QAAQ,EAAE,IAAA,kBAAI,EAAC,IAAA,oBAAM,GAAE,EAAE,CAAC,EAAE,QAAQ,CAAC;gBACrC,QAAQ,EAAE,IAAA,sBAAQ,EAAC,IAAA,kBAAI,EAAC,IAAA,oBAAM,GAAE,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;gBAC/C,WAAW,EAAE,kBAAU;gBACvB,QAAQ,EAAE,IAAA,mBAAK,EAAC;oBACd,IAAA,qBAAO,EAAC,4BAA4B,CAAC;oBACrC,IAAA,qBAAO,EAAC,6BAA6B,CAAC;iBACvC,CAAC;aACH,CAAC;SACH,CAAC;KACH,CAAC;IACF,kBAAkB,EAAE,yBAAiB;IACrC,eAAe,EAAE,IAAA,qBAAO,EAAC,KAAK,CAAC;CAChC,CAAC,CAAC;AAIH;;;;;GAKG;AACH,SAAgB,cAAc,CAAC,KAAc;IAC3C,OAAO,IAAA,gBAAE,EAAC,KAAK,EAAE,0BAAkB,CAAC,CAAC;AACvC,CAAC;AAFD,wCAEC;AAED;;;;;GAKG;AACH,SAAgB,oBAAoB,CAClC,KAAc;IAEd,IAAA,oBAAY,EACV,KAAK,EACL,0BAAkB,EAClB,IAAI,wBAAgB,CAAC,QAAQ,cAAc,CAC5C,CAAC;AACJ,CAAC;AARD,oDAQC","sourcesContent":["import { assert, assertStruct } from '@metamask/utils';\nimport {\n array,\n boolean,\n enums,\n Infer,\n integer,\n is,\n literal,\n object,\n optional,\n pattern,\n refine,\n size,\n string,\n Struct,\n type,\n union,\n} from 'superstruct';\nimport { CronjobSpecificationArrayStruct } from '../cronjob';\nimport { NamespacesStruct } from '../namespace';\nimport { NameStruct, NpmSnapFileNames, VersionStruct } from '../types';\n\n// 0xd36e6170 - 0x80000000\nexport const SIP_6_MAGIC_VALUE = `1399742832'` as `${number}'`;\n\n// BIP-43 purposes that cannot be used for entropy derivation. These are in the\n// string form, ending with `'`.\nconst FORBIDDEN_PURPOSES: string[] = [SIP_6_MAGIC_VALUE];\n\nexport type Base64Opts = {\n /**\n * Is the `=` padding at the end required or not.\n *\n * @default false\n */\n // Padding is optional in RFC 4648, that's why the default value is false\n paddingRequired?: boolean;\n /**\n * Which character set should be used.\n * The sets are based on {@link https://datatracker.ietf.org/doc/html/rfc4648 RFC 4648}.\n *\n * @default 'base64'\n */\n characterSet?: 'base64' | 'base64url';\n};\n\n/**\n * Ensure that a provided string-based struct is valid base64.\n *\n * @param struct - The string based struct.\n * @param opts - Optional options to specialize base64 validation. See {@link Base64Opts} documentation.\n * @returns A superstruct validating base64.\n */\nexport const base64 = <T extends string, S>(\n struct: Struct<T, S>,\n opts: Base64Opts = {},\n) => {\n const paddingRequired = opts.paddingRequired ?? false;\n const characterSet = opts.characterSet ?? 'base64';\n\n let letters: string;\n if (characterSet === 'base64') {\n letters = String.raw`[A-Za-z0-9+\\/]`;\n } else {\n assert(characterSet === 'base64url');\n letters = String.raw`[-_A-Za-z0-9]`;\n }\n\n let re: RegExp;\n if (paddingRequired) {\n re = new RegExp(\n `^(?:${letters}{4})*(?:${letters}{3}=|${letters}{2}==)?$`,\n 'u',\n );\n } else {\n re = new RegExp(\n `^(?:${letters}{4})*(?:${letters}{2,3}|${letters}{3}=|${letters}{2}==)?$`,\n 'u',\n );\n }\n\n return pattern(struct, re);\n};\n\nconst BIP32_INDEX_REGEX = /^\\d+'?$/u;\nexport const Bip32PathStruct = refine(\n array(string()),\n 'BIP-32 path',\n (path) => {\n if (path.length === 0) {\n return 'Path must be a non-empty BIP-32 derivation path array';\n }\n\n if (path[0] !== 'm') {\n return 'Path must start with \"m\".';\n }\n\n if (path.length < 3) {\n return 'Paths must have a length of at least three.';\n }\n\n if (path.slice(1).some((e) => !BIP32_INDEX_REGEX.test(e))) {\n return 'Path must be a valid BIP-32 derivation path array.';\n }\n\n if (FORBIDDEN_PURPOSES.includes(path[1])) {\n return `The purpose \"${path[1]}\" is not allowed for entropy derivation.`;\n }\n\n return true;\n },\n);\n\nexport const bip32entropy = <T extends { path: string[]; curve: string }, S>(\n struct: Struct<T, S>,\n) =>\n refine(struct, 'BIP-32 entropy', (value) => {\n if (\n value.curve === 'ed25519' &&\n value.path.slice(1).some((e) => !e.endsWith(\"'\"))\n ) {\n return 'Ed25519 does not support unhardened paths.';\n }\n\n return true;\n });\n\n// Used outside @metamask/snap-utils\nexport const Bip32EntropyStruct = bip32entropy(\n type({\n path: Bip32PathStruct,\n curve: enums(['ed25519', 'secp256k1']),\n }),\n);\n\nexport type Bip32Entropy = Infer<typeof Bip32EntropyStruct>;\n\nexport const SnapGetBip32EntropyPermissionsStruct = size(\n array(Bip32EntropyStruct),\n 1,\n Infinity,\n);\n\nexport const PermissionsStruct = type({\n 'endowment:long-running': optional(object({})),\n 'endowment:network-access': optional(object({})),\n 'endowment:transaction-insight': optional(\n object({\n allowTransactionOrigin: optional(boolean()),\n }),\n ),\n 'endowment:cronjob': optional(\n object({ jobs: CronjobSpecificationArrayStruct }),\n ),\n snap_confirm: optional(object({})),\n snap_manageState: optional(object({})),\n snap_notify: optional(object({})),\n snap_getBip32Entropy: optional(SnapGetBip32EntropyPermissionsStruct),\n snap_getBip32PublicKey: optional(SnapGetBip32EntropyPermissionsStruct),\n snap_getBip44Entropy: optional(\n size(\n array(object({ coinType: size(integer(), 0, 2 ** 32 - 1) })),\n 1,\n Infinity,\n ),\n ),\n snap_getEntropy: optional(object({})),\n 'endowment:keyring': optional(\n object({\n namespaces: NamespacesStruct,\n }),\n ),\n});\n\nexport type SnapPermissions = Infer<typeof PermissionsStruct>;\n\nexport const SnapManifestStruct = object({\n version: VersionStruct,\n description: size(string(), 1, 280),\n proposedName: size(\n pattern(\n string(),\n /^(?:[A-Za-z0-9-_]+( [A-Za-z0-9-_]+)*)|(?:(?:@[A-Za-z0-9-*~][A-Za-z0-9-*._~]*\\/)?[A-Za-z0-9-~][A-Za-z0-9-._~]*)$/u,\n ),\n 1,\n 214,\n ),\n repository: optional(\n object({\n type: size(string(), 1, Infinity),\n url: size(string(), 1, Infinity),\n }),\n ),\n source: object({\n shasum: size(base64(string(), { paddingRequired: true }), 44, 44),\n location: object({\n npm: object({\n filePath: size(string(), 1, Infinity),\n iconPath: optional(size(string(), 1, Infinity)),\n packageName: NameStruct,\n registry: union([\n literal('https://registry.npmjs.org'),\n literal('https://registry.npmjs.org/'),\n ]),\n }),\n }),\n }),\n initialPermissions: PermissionsStruct,\n manifestVersion: literal('0.1'),\n});\n\nexport type SnapManifest = Infer<typeof SnapManifestStruct>;\n\n/**\n * Check if the given value is a valid {@link SnapManifest} object.\n *\n * @param value - The value to check.\n * @returns Whether the value is a valid {@link SnapManifest} object.\n */\nexport function isSnapManifest(value: unknown): value is SnapManifest {\n return is(value, SnapManifestStruct);\n}\n\n/**\n * Assert that the given value is a valid {@link SnapManifest} object.\n *\n * @param value - The value to check.\n * @throws If the value is not a valid {@link SnapManifest} object.\n */\nexport function assertIsSnapManifest(\n value: unknown,\n): asserts value is SnapManifest {\n assertStruct(\n value,\n SnapManifestStruct,\n `\"${NpmSnapFileNames.Manifest}\" is invalid`,\n );\n}\n"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@metamask/snaps-utils",
3
- "version": "0.24.0",
3
+ "version": "0.24.1",
4
4
  "repository": {
5
5
  "type": "git",
6
6
  "url": "https://github.com/MetaMask/snaps-monorepo.git"
@@ -52,7 +52,7 @@
52
52
  "dependencies": {
53
53
  "@babel/core": "^7.18.6",
54
54
  "@babel/types": "^7.18.7",
55
- "@metamask/snaps-types": "^0.24.0",
55
+ "@metamask/snaps-types": "^0.24.1",
56
56
  "@metamask/utils": "^3.3.1",
57
57
  "@noble/hashes": "^1.1.3",
58
58
  "@scure/base": "^1.1.1",