@metamask/snaps-utils 0.35.1-flask.1 → 1.0.0-prerelease.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.
- package/CHANGELOG.md +5 -46
- package/dist/{esm/array.js → array.js} +7 -3
- package/dist/array.js.map +1 -0
- package/dist/{types/caveats.d.ts → caveats.d.ts} +4 -0
- package/dist/caveats.js +35 -0
- package/dist/caveats.js.map +1 -0
- package/dist/checksum.js +42 -0
- package/dist/checksum.js.map +1 -0
- package/dist/cronjob.js +71 -0
- package/dist/cronjob.js.map +1 -0
- package/dist/deep-clone.js +9 -0
- package/dist/deep-clone.js.map +1 -0
- package/dist/{esm/default-endowments.js → default-endowments.js} +6 -3
- package/dist/default-endowments.js.map +1 -0
- package/dist/entropy.js +8 -0
- package/dist/entropy.js.map +1 -0
- package/dist/{cjs/eval-worker.js → eval-worker.js} +21 -22
- package/dist/eval-worker.js.map +1 -0
- package/dist/eval.js +27 -0
- package/dist/eval.js.map +1 -0
- package/dist/{esm/fs.js → fs.js} +56 -33
- package/dist/fs.js.map +1 -0
- package/dist/{types/handlers.d.ts → handlers.d.ts} +42 -5
- package/dist/handlers.js +3 -0
- package/dist/handlers.js.map +1 -0
- package/dist/{types/iframe.d.ts → iframe.d.ts} +2 -3
- package/dist/{esm/iframe.js → iframe.js} +18 -16
- package/dist/iframe.js.map +1 -0
- package/dist/iframe.test.browser.js +15 -0
- package/dist/iframe.test.browser.js.map +1 -0
- package/dist/{types/index.browser.d.ts → index.browser.d.ts} +1 -2
- package/dist/index.browser.js +37 -0
- package/dist/index.browser.js.map +1 -0
- package/dist/{types/index.d.ts → index.d.ts} +1 -2
- package/dist/index.executionenv.js +22 -0
- package/dist/index.executionenv.js.map +1 -0
- package/dist/index.js +42 -0
- package/dist/index.js.map +1 -0
- package/dist/json-rpc.js +46 -0
- package/dist/json-rpc.js.map +1 -0
- package/dist/json.d.ts +9 -0
- package/dist/json.js +18 -0
- package/dist/json.js.map +1 -0
- package/dist/{esm/logging.js → logging.js} +14 -6
- package/dist/logging.js.map +1 -0
- package/dist/manifest/index.browser.js +18 -0
- package/dist/manifest/index.browser.js.map +1 -0
- package/dist/manifest/index.js +19 -0
- package/dist/manifest/index.js.map +1 -0
- package/dist/{esm/manifest → manifest}/manifest.js +113 -98
- package/dist/manifest/manifest.js.map +1 -0
- package/dist/{types/manifest → manifest}/validation.d.ts +73 -31
- package/dist/manifest/validation.js +141 -0
- package/dist/manifest/validation.js.map +1 -0
- package/dist/{esm/mock.js → mock.js} +40 -42
- package/dist/mock.js.map +1 -0
- package/dist/namespace.d.ts +275 -0
- package/dist/namespace.js +225 -0
- package/dist/namespace.js.map +1 -0
- package/dist/notification.d.ts +66 -0
- package/dist/notification.js +58 -0
- package/dist/notification.js.map +1 -0
- package/dist/{types/npm.d.ts → npm.d.ts} +2 -0
- package/dist/npm.js +74 -0
- package/dist/npm.js.map +1 -0
- package/dist/path.js +21 -0
- package/dist/path.js.map +1 -0
- package/dist/{esm/post-process.js → post-process.js} +99 -110
- package/dist/post-process.js.map +1 -0
- package/dist/{types/snaps.d.ts → snaps.d.ts} +2 -9
- package/dist/snaps.js +202 -0
- package/dist/snaps.js.map +1 -0
- package/dist/{types/types.d.ts → types.d.ts} +5 -2
- package/dist/types.js +103 -0
- package/dist/types.js.map +1 -0
- package/dist/{esm/versions.js → versions.js} +18 -15
- package/dist/versions.js.map +1 -0
- package/dist/{esm/virtual-file → virtual-file}/VirtualFile.js +33 -47
- package/dist/virtual-file/VirtualFile.js.map +1 -0
- package/dist/virtual-file/index.browser.js +18 -0
- package/dist/virtual-file/index.browser.js.map +1 -0
- package/dist/virtual-file/index.js +19 -0
- package/dist/virtual-file/index.js.map +1 -0
- package/dist/virtual-file/toVirtualFile.js +30 -0
- package/dist/virtual-file/toVirtualFile.js.map +1 -0
- package/package.json +32 -61
- package/dist/cjs/array.js +0 -23
- package/dist/cjs/array.js.map +0 -1
- package/dist/cjs/caveats.js +0 -33
- package/dist/cjs/caveats.js.map +0 -1
- package/dist/cjs/checksum.js +0 -38
- package/dist/cjs/checksum.js.map +0 -1
- package/dist/cjs/cronjob.js +0 -84
- package/dist/cjs/cronjob.js.map +0 -1
- package/dist/cjs/deep-clone.js +0 -22
- package/dist/cjs/deep-clone.js.map +0 -1
- package/dist/cjs/default-endowments.js +0 -49
- package/dist/cjs/default-endowments.js.map +0 -1
- package/dist/cjs/entropy.js +0 -23
- package/dist/cjs/entropy.js.map +0 -1
- package/dist/cjs/enum.js +0 -16
- package/dist/cjs/enum.js.map +0 -1
- package/dist/cjs/eval-worker.js.map +0 -1
- package/dist/cjs/eval.js +0 -29
- package/dist/cjs/eval.js.map +0 -1
- package/dist/cjs/fs.js +0 -126
- package/dist/cjs/fs.js.map +0 -1
- package/dist/cjs/handlers.js +0 -6
- package/dist/cjs/handlers.js.map +0 -1
- package/dist/cjs/icon.js +0 -37
- package/dist/cjs/icon.js.map +0 -1
- package/dist/cjs/iframe.js +0 -59
- package/dist/cjs/iframe.js.map +0 -1
- package/dist/cjs/index.browser.js +0 -40
- package/dist/cjs/index.browser.js.map +0 -1
- package/dist/cjs/index.executionenv.js +0 -24
- package/dist/cjs/index.executionenv.js.map +0 -1
- package/dist/cjs/index.js +0 -45
- package/dist/cjs/index.js.map +0 -1
- package/dist/cjs/json-rpc.js +0 -46
- package/dist/cjs/json-rpc.js.map +0 -1
- package/dist/cjs/json.js +0 -16
- package/dist/cjs/json.js.map +0 -1
- package/dist/cjs/logging.js +0 -40
- package/dist/cjs/logging.js.map +0 -1
- package/dist/cjs/manifest/index.browser.js +0 -20
- package/dist/cjs/manifest/index.browser.js.map +0 -1
- package/dist/cjs/manifest/index.js +0 -21
- package/dist/cjs/manifest/index.js.map +0 -1
- package/dist/cjs/manifest/manifest.js +0 -239
- package/dist/cjs/manifest/manifest.js.map +0 -1
- package/dist/cjs/manifest/validation.js +0 -183
- package/dist/cjs/manifest/validation.js.map +0 -1
- package/dist/cjs/mock.js +0 -128
- package/dist/cjs/mock.js.map +0 -1
- package/dist/cjs/namespace.js +0 -124
- package/dist/cjs/namespace.js.map +0 -1
- package/dist/cjs/npm.js +0 -81
- package/dist/cjs/npm.js.map +0 -1
- package/dist/cjs/path.js +0 -21
- package/dist/cjs/path.js.map +0 -1
- package/dist/cjs/post-process.js +0 -328
- package/dist/cjs/post-process.js.map +0 -1
- package/dist/cjs/snaps.js +0 -230
- package/dist/cjs/snaps.js.map +0 -1
- package/dist/cjs/types.js +0 -117
- package/dist/cjs/types.js.map +0 -1
- package/dist/cjs/validation.js +0 -22
- package/dist/cjs/validation.js.map +0 -1
- package/dist/cjs/versions.js +0 -47
- package/dist/cjs/versions.js.map +0 -1
- package/dist/cjs/virtual-file/VirtualFile.js +0 -85
- package/dist/cjs/virtual-file/VirtualFile.js.map +0 -1
- package/dist/cjs/virtual-file/index.browser.js +0 -20
- package/dist/cjs/virtual-file/index.browser.js.map +0 -1
- package/dist/cjs/virtual-file/index.js +0 -21
- package/dist/cjs/virtual-file/index.js.map +0 -1
- package/dist/cjs/virtual-file/toVirtualFile.js +0 -33
- package/dist/cjs/virtual-file/toVirtualFile.js.map +0 -1
- package/dist/esm/array.js.map +0 -1
- package/dist/esm/caveats.js +0 -23
- package/dist/esm/caveats.js.map +0 -1
- package/dist/esm/checksum.js +0 -36
- package/dist/esm/checksum.js.map +0 -1
- package/dist/esm/cronjob.js +0 -66
- package/dist/esm/cronjob.js.map +0 -1
- package/dist/esm/deep-clone.js +0 -7
- package/dist/esm/deep-clone.js.map +0 -1
- package/dist/esm/default-endowments.js.map +0 -1
- package/dist/esm/entropy.js +0 -6
- package/dist/esm/entropy.js.map +0 -1
- package/dist/esm/enum.js +0 -12
- package/dist/esm/enum.js.map +0 -1
- package/dist/esm/eval-worker.js +0 -47
- package/dist/esm/eval-worker.js.map +0 -1
- package/dist/esm/eval.js +0 -25
- package/dist/esm/eval.js.map +0 -1
- package/dist/esm/fs.js.map +0 -1
- package/dist/esm/handlers.js +0 -3
- package/dist/esm/handlers.js.map +0 -1
- package/dist/esm/icon.js +0 -11
- package/dist/esm/icon.js.map +0 -1
- package/dist/esm/iframe.js.map +0 -1
- package/dist/esm/index.browser.js +0 -23
- package/dist/esm/index.browser.js.map +0 -1
- package/dist/esm/index.executionenv.js +0 -7
- package/dist/esm/index.executionenv.js.map +0 -1
- package/dist/esm/index.js +0 -28
- package/dist/esm/index.js.map +0 -1
- package/dist/esm/json-rpc.js +0 -39
- package/dist/esm/json-rpc.js.map +0 -1
- package/dist/esm/json.js +0 -17
- package/dist/esm/json.js.map +0 -1
- package/dist/esm/logging.js.map +0 -1
- package/dist/esm/manifest/index.browser.js +0 -3
- package/dist/esm/manifest/index.browser.js.map +0 -1
- package/dist/esm/manifest/index.js +0 -4
- package/dist/esm/manifest/index.js.map +0 -1
- package/dist/esm/manifest/manifest.js.map +0 -1
- package/dist/esm/manifest/validation.js +0 -152
- package/dist/esm/manifest/validation.js.map +0 -1
- package/dist/esm/mock.js.map +0 -1
- package/dist/esm/namespace.js +0 -110
- package/dist/esm/namespace.js.map +0 -1
- package/dist/esm/npm.js +0 -70
- package/dist/esm/npm.js.map +0 -1
- package/dist/esm/path.js +0 -17
- package/dist/esm/path.js.map +0 -1
- package/dist/esm/post-process.js.map +0 -1
- package/dist/esm/snaps.js +0 -215
- package/dist/esm/snaps.js.map +0 -1
- package/dist/esm/types.js +0 -85
- package/dist/esm/types.js.map +0 -1
- package/dist/esm/validation.js +0 -17
- package/dist/esm/validation.js.map +0 -1
- package/dist/esm/versions.js.map +0 -1
- package/dist/esm/virtual-file/VirtualFile.js.map +0 -1
- package/dist/esm/virtual-file/index.browser.js +0 -3
- package/dist/esm/virtual-file/index.browser.js.map +0 -1
- package/dist/esm/virtual-file/index.js +0 -4
- package/dist/esm/virtual-file/index.js.map +0 -1
- package/dist/esm/virtual-file/toVirtualFile.js +0 -26
- package/dist/esm/virtual-file/toVirtualFile.js.map +0 -1
- package/dist/types/enum.d.ts +0 -30
- package/dist/types/icon.d.ts +0 -4
- package/dist/types/json.d.ts +0 -13
- package/dist/types/namespace.d.ts +0 -124
- package/dist/types/validation.d.ts +0 -8
- /package/dist/{types/array.d.ts → array.d.ts} +0 -0
- /package/dist/{types/checksum.d.ts → checksum.d.ts} +0 -0
- /package/dist/{types/cronjob.d.ts → cronjob.d.ts} +0 -0
- /package/dist/{types/deep-clone.d.ts → deep-clone.d.ts} +0 -0
- /package/dist/{types/default-endowments.d.ts → default-endowments.d.ts} +0 -0
- /package/dist/{types/entropy.d.ts → entropy.d.ts} +0 -0
- /package/dist/{types/eval-worker.d.ts → eval-worker.d.ts} +0 -0
- /package/dist/{types/eval.d.ts → eval.d.ts} +0 -0
- /package/dist/{types/fs.d.ts → fs.d.ts} +0 -0
- /package/dist/{types/iframe.test.browser.d.ts → iframe.test.browser.d.ts} +0 -0
- /package/dist/{types/index.executionenv.d.ts → index.executionenv.d.ts} +0 -0
- /package/dist/{types/json-rpc.d.ts → json-rpc.d.ts} +0 -0
- /package/dist/{types/logging.d.ts → logging.d.ts} +0 -0
- /package/dist/{types/manifest → manifest}/index.browser.d.ts +0 -0
- /package/dist/{types/manifest → manifest}/index.d.ts +0 -0
- /package/dist/{types/manifest → manifest}/manifest.d.ts +0 -0
- /package/dist/{types/mock.d.ts → mock.d.ts} +0 -0
- /package/dist/{types/path.d.ts → path.d.ts} +0 -0
- /package/dist/{types/post-process.d.ts → post-process.d.ts} +0 -0
- /package/dist/{types/versions.d.ts → versions.d.ts} +0 -0
- /package/dist/{types/virtual-file → virtual-file}/VirtualFile.d.ts +0 -0
- /package/dist/{types/virtual-file → virtual-file}/index.browser.d.ts +0 -0
- /package/dist/{types/virtual-file → virtual-file}/index.d.ts +0 -0
- /package/dist/{types/virtual-file → virtual-file}/toVirtualFile.d.ts +0 -0
package/dist/snaps.js
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.verifyRequestedSnapPermissions = exports.isSnapPermitted = exports.isCaipChainId = exports.assertIsValidSnapId = exports.getSnapPrefix = exports.SnapIdStruct = exports.HttpSnapIdStruct = exports.NpmSnapIdStruct = exports.LocalSnapIdStruct = exports.BaseSnapIdStruct = exports.LOCALHOST_HOSTNAMES = exports.validateSnapShasum = exports.getSnapChecksum = exports.ProgrammaticallyFixableSnapError = exports.SnapStatusEvents = exports.SnapStatus = exports.PROPOSED_NAME_REGEX = void 0;
|
|
7
|
+
const utils_1 = require("@metamask/utils");
|
|
8
|
+
const base_1 = require("@scure/base");
|
|
9
|
+
const fast_json_stable_stringify_1 = __importDefault(require("fast-json-stable-stringify"));
|
|
10
|
+
const superstruct_1 = require("superstruct");
|
|
11
|
+
const validate_npm_package_name_1 = __importDefault(require("validate-npm-package-name"));
|
|
12
|
+
const caveats_1 = require("./caveats");
|
|
13
|
+
const checksum_1 = require("./checksum");
|
|
14
|
+
const types_1 = require("./types");
|
|
15
|
+
// This RegEx matches valid npm package names (with some exceptions) and space-
|
|
16
|
+
// separated alphanumerical words, optionally with dashes and underscores.
|
|
17
|
+
// The RegEx consists of two parts. The first part matches space-separated
|
|
18
|
+
// words. It is based on the following Stackoverflow answer:
|
|
19
|
+
// https://stackoverflow.com/a/34974982
|
|
20
|
+
// The second part, after the pipe operator, is the same RegEx used for the
|
|
21
|
+
// `name` field of the official package.json JSON Schema, except that we allow
|
|
22
|
+
// mixed-case letters. It was originally copied from:
|
|
23
|
+
// https://github.com/SchemaStore/schemastore/blob/81a16897c1dabfd98c72242a5fd62eb080ff76d8/src/schemas/json/package.json#L132-L138
|
|
24
|
+
exports.PROPOSED_NAME_REGEX = /^(?:[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;
|
|
25
|
+
var SnapStatus;
|
|
26
|
+
(function (SnapStatus) {
|
|
27
|
+
SnapStatus["Installing"] = "installing";
|
|
28
|
+
SnapStatus["Updating"] = "updating";
|
|
29
|
+
SnapStatus["Running"] = "running";
|
|
30
|
+
SnapStatus["Stopped"] = "stopped";
|
|
31
|
+
SnapStatus["Crashed"] = "crashed";
|
|
32
|
+
})(SnapStatus = exports.SnapStatus || (exports.SnapStatus = {}));
|
|
33
|
+
var SnapStatusEvents;
|
|
34
|
+
(function (SnapStatusEvents) {
|
|
35
|
+
SnapStatusEvents["Start"] = "START";
|
|
36
|
+
SnapStatusEvents["Stop"] = "STOP";
|
|
37
|
+
SnapStatusEvents["Crash"] = "CRASH";
|
|
38
|
+
SnapStatusEvents["Update"] = "UPDATE";
|
|
39
|
+
})(SnapStatusEvents = exports.SnapStatusEvents || (exports.SnapStatusEvents = {}));
|
|
40
|
+
/**
|
|
41
|
+
* An error indicating that a Snap validation failure is programmatically
|
|
42
|
+
* fixable during development.
|
|
43
|
+
*/
|
|
44
|
+
class ProgrammaticallyFixableSnapError extends Error {
|
|
45
|
+
constructor(message, reason) {
|
|
46
|
+
super(message);
|
|
47
|
+
this.reason = reason;
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
exports.ProgrammaticallyFixableSnapError = ProgrammaticallyFixableSnapError;
|
|
51
|
+
/**
|
|
52
|
+
* Gets a checksummable manifest by removing the shasum property and reserializing the JSON using a deterministic algorithm.
|
|
53
|
+
*
|
|
54
|
+
* @param manifest - The manifest itself.
|
|
55
|
+
* @returns A virtual file containing the checksummable manifest.
|
|
56
|
+
*/
|
|
57
|
+
function getChecksummableManifest(manifest) {
|
|
58
|
+
const manifestCopy = manifest.clone();
|
|
59
|
+
delete manifestCopy.result.source.shasum;
|
|
60
|
+
// We use fast-json-stable-stringify to deterministically serialize the JSON
|
|
61
|
+
// This is required before checksumming so we get reproducible checksums across platforms etc
|
|
62
|
+
manifestCopy.value = (0, fast_json_stable_stringify_1.default)(manifestCopy.result);
|
|
63
|
+
return manifestCopy;
|
|
64
|
+
}
|
|
65
|
+
/**
|
|
66
|
+
* Calculates the Base64-encoded SHA-256 digest of all required Snap files.
|
|
67
|
+
*
|
|
68
|
+
* @param files - All required Snap files to be included in the checksum.
|
|
69
|
+
* @returns The Base64-encoded SHA-256 digest of the source code.
|
|
70
|
+
*/
|
|
71
|
+
function getSnapChecksum(files) {
|
|
72
|
+
const { manifest, sourceCode, svgIcon } = files;
|
|
73
|
+
const all = [getChecksummableManifest(manifest), sourceCode, svgIcon].filter((file) => file !== undefined);
|
|
74
|
+
return base_1.base64.encode((0, checksum_1.checksumFiles)(all));
|
|
75
|
+
}
|
|
76
|
+
exports.getSnapChecksum = getSnapChecksum;
|
|
77
|
+
/**
|
|
78
|
+
* Checks whether the `source.shasum` property of a Snap manifest matches the
|
|
79
|
+
* shasum of the snap.
|
|
80
|
+
*
|
|
81
|
+
* @param files - All required Snap files to be included in the checksum.
|
|
82
|
+
* @param errorMessage - The error message to throw if validation fails.
|
|
83
|
+
*/
|
|
84
|
+
function validateSnapShasum(files, errorMessage = 'Invalid Snap manifest: manifest shasum does not match computed shasum.') {
|
|
85
|
+
if (files.manifest.result.source.shasum !== getSnapChecksum(files)) {
|
|
86
|
+
throw new ProgrammaticallyFixableSnapError(errorMessage, types_1.SnapValidationFailureReason.ShasumMismatch);
|
|
87
|
+
}
|
|
88
|
+
}
|
|
89
|
+
exports.validateSnapShasum = validateSnapShasum;
|
|
90
|
+
exports.LOCALHOST_HOSTNAMES = ['localhost', '127.0.0.1', '[::1]'];
|
|
91
|
+
// Require snap ids to only consist of printable ASCII characters
|
|
92
|
+
exports.BaseSnapIdStruct = (0, superstruct_1.pattern)((0, superstruct_1.string)(), /^[\x21-\x7E]*$/u);
|
|
93
|
+
const LocalSnapIdSubUrlStruct = (0, types_1.uri)({
|
|
94
|
+
protocol: (0, superstruct_1.enums)(['http:', 'https:']),
|
|
95
|
+
hostname: (0, superstruct_1.enums)(exports.LOCALHOST_HOSTNAMES),
|
|
96
|
+
hash: (0, superstruct_1.empty)((0, superstruct_1.string)()),
|
|
97
|
+
search: (0, superstruct_1.empty)((0, superstruct_1.string)()),
|
|
98
|
+
});
|
|
99
|
+
exports.LocalSnapIdStruct = (0, superstruct_1.refine)(exports.BaseSnapIdStruct, 'local Snap Id', (value) => {
|
|
100
|
+
if (!value.startsWith(types_1.SnapIdPrefixes.local)) {
|
|
101
|
+
return `Expected local snap ID, got "${value}".`;
|
|
102
|
+
}
|
|
103
|
+
const [error] = (0, superstruct_1.validate)(value.slice(types_1.SnapIdPrefixes.local.length), LocalSnapIdSubUrlStruct);
|
|
104
|
+
return error ?? true;
|
|
105
|
+
});
|
|
106
|
+
exports.NpmSnapIdStruct = (0, superstruct_1.intersection)([
|
|
107
|
+
exports.BaseSnapIdStruct,
|
|
108
|
+
(0, types_1.uri)({
|
|
109
|
+
protocol: (0, superstruct_1.literal)(types_1.SnapIdPrefixes.npm),
|
|
110
|
+
pathname: (0, superstruct_1.refine)((0, superstruct_1.string)(), 'package name', function* (value) {
|
|
111
|
+
const normalized = value.startsWith('/') ? value.slice(1) : value;
|
|
112
|
+
const { errors, validForNewPackages, warnings } = (0, validate_npm_package_name_1.default)(normalized);
|
|
113
|
+
if (!validForNewPackages) {
|
|
114
|
+
if (errors === undefined) {
|
|
115
|
+
(0, utils_1.assert)(warnings !== undefined);
|
|
116
|
+
yield* warnings;
|
|
117
|
+
}
|
|
118
|
+
else {
|
|
119
|
+
yield* errors;
|
|
120
|
+
}
|
|
121
|
+
}
|
|
122
|
+
return true;
|
|
123
|
+
}),
|
|
124
|
+
search: (0, superstruct_1.empty)((0, superstruct_1.string)()),
|
|
125
|
+
hash: (0, superstruct_1.empty)((0, superstruct_1.string)()),
|
|
126
|
+
}),
|
|
127
|
+
]);
|
|
128
|
+
exports.HttpSnapIdStruct = (0, superstruct_1.intersection)([
|
|
129
|
+
exports.BaseSnapIdStruct,
|
|
130
|
+
(0, types_1.uri)({
|
|
131
|
+
protocol: (0, superstruct_1.enums)(['http:', 'https:']),
|
|
132
|
+
search: (0, superstruct_1.empty)((0, superstruct_1.string)()),
|
|
133
|
+
hash: (0, superstruct_1.empty)((0, superstruct_1.string)()),
|
|
134
|
+
}),
|
|
135
|
+
]);
|
|
136
|
+
exports.SnapIdStruct = (0, superstruct_1.union)([exports.NpmSnapIdStruct, exports.LocalSnapIdStruct]);
|
|
137
|
+
/**
|
|
138
|
+
* Extracts the snap prefix from a snap ID.
|
|
139
|
+
*
|
|
140
|
+
* @param snapId - The snap ID to extract the prefix from.
|
|
141
|
+
* @returns The snap prefix from a snap id, e.g. `npm:`.
|
|
142
|
+
*/
|
|
143
|
+
function getSnapPrefix(snapId) {
|
|
144
|
+
const prefix = Object.values(types_1.SnapIdPrefixes).find((possiblePrefix) => snapId.startsWith(possiblePrefix));
|
|
145
|
+
if (prefix !== undefined) {
|
|
146
|
+
return prefix;
|
|
147
|
+
}
|
|
148
|
+
throw new Error(`Invalid or no prefix found for "${snapId}"`);
|
|
149
|
+
}
|
|
150
|
+
exports.getSnapPrefix = getSnapPrefix;
|
|
151
|
+
/**
|
|
152
|
+
* Assert that the given value is a valid snap ID.
|
|
153
|
+
*
|
|
154
|
+
* @param value - The value to check.
|
|
155
|
+
* @throws If the value is not a valid snap ID.
|
|
156
|
+
*/
|
|
157
|
+
function assertIsValidSnapId(value) {
|
|
158
|
+
(0, utils_1.assertStruct)(value, exports.SnapIdStruct, 'Invalid snap ID');
|
|
159
|
+
}
|
|
160
|
+
exports.assertIsValidSnapId = assertIsValidSnapId;
|
|
161
|
+
/**
|
|
162
|
+
* Typeguard to ensure a chainId follows the CAIP-2 standard.
|
|
163
|
+
*
|
|
164
|
+
* @param chainId - The chainId being tested.
|
|
165
|
+
* @returns `true` if the value is a valid CAIP chain id, and `false` otherwise.
|
|
166
|
+
*/
|
|
167
|
+
function isCaipChainId(chainId) {
|
|
168
|
+
return (typeof chainId === 'string' &&
|
|
169
|
+
/^(?<namespace>[-a-z0-9]{3,8}):(?<reference>[-a-zA-Z0-9]{1,32})$/u.test(chainId));
|
|
170
|
+
}
|
|
171
|
+
exports.isCaipChainId = isCaipChainId;
|
|
172
|
+
/**
|
|
173
|
+
* Utility function to check if an origin has permission (and caveat) for a particular snap.
|
|
174
|
+
*
|
|
175
|
+
* @param permissions - An origin's permissions object.
|
|
176
|
+
* @param snapId - The id of the snap.
|
|
177
|
+
* @returns A boolean based on if an origin has the specified snap.
|
|
178
|
+
*/
|
|
179
|
+
function isSnapPermitted(permissions, snapId) {
|
|
180
|
+
return Boolean((permissions?.wallet_snap?.caveats?.find((caveat) => caveat.type === caveats_1.SnapCaveatType.SnapIds) ?? {}).value?.[snapId]);
|
|
181
|
+
}
|
|
182
|
+
exports.isSnapPermitted = isSnapPermitted;
|
|
183
|
+
/**
|
|
184
|
+
* Checks whether the passed in requestedPermissions is a valid
|
|
185
|
+
* permission request for a `wallet_snap` permission.
|
|
186
|
+
*
|
|
187
|
+
* @param requestedPermissions - The requested permissions.
|
|
188
|
+
* @throws If the criteria is not met.
|
|
189
|
+
*/
|
|
190
|
+
function verifyRequestedSnapPermissions(requestedPermissions) {
|
|
191
|
+
(0, utils_1.assert)((0, utils_1.isObject)(requestedPermissions), 'Requested permissions must be an object.');
|
|
192
|
+
const { wallet_snap: walletSnapPermission } = requestedPermissions;
|
|
193
|
+
(0, utils_1.assert)((0, utils_1.isObject)(walletSnapPermission), 'wallet_snap is missing from the requested permissions.');
|
|
194
|
+
const { caveats } = walletSnapPermission;
|
|
195
|
+
(0, utils_1.assert)(Array.isArray(caveats) && caveats.length === 1, 'wallet_snap must have a caveat property with a single-item array value.');
|
|
196
|
+
const [caveat] = caveats;
|
|
197
|
+
(0, utils_1.assert)((0, utils_1.isObject)(caveat) &&
|
|
198
|
+
caveat.type === caveats_1.SnapCaveatType.SnapIds &&
|
|
199
|
+
(0, utils_1.isObject)(caveat.value), `The requested permissions do not have a valid ${caveats_1.SnapCaveatType.SnapIds} caveat.`);
|
|
200
|
+
}
|
|
201
|
+
exports.verifyRequestedSnapPermissions = verifyRequestedSnapPermissions;
|
|
202
|
+
//# sourceMappingURL=snaps.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"snaps.js","sourceRoot":"","sources":["../src/snaps.ts"],"names":[],"mappings":";;;;;;AAMA,2CAOyB;AACzB,sCAAqC;AAErC,4FAAyD;AACzD,6CAWqB;AACrB,0FAA2D;AAE3D,uCAA2C;AAC3C,yCAA2C;AAE3C,mCAOiB;AAGjB,+EAA+E;AAC/E,0EAA0E;AAC1E,0EAA0E;AAC1E,4DAA4D;AAC5D,uCAAuC;AACvC,2EAA2E;AAC3E,8EAA8E;AAC9E,qDAAqD;AACrD,mIAAmI;AACtH,QAAA,mBAAmB,GAC9B,kHAAkH,CAAC;AAWrH,IAAY,UAMX;AAND,WAAY,UAAU;IACpB,uCAAyB,CAAA;IACzB,mCAAqB,CAAA;IACrB,iCAAmB,CAAA;IACnB,iCAAmB,CAAA;IACnB,iCAAmB,CAAA;AACrB,CAAC,EANW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAMrB;AAED,IAAY,gBAKX;AALD,WAAY,gBAAgB;IAC1B,mCAAe,CAAA;IACf,iCAAa,CAAA;IACb,mCAAe,CAAA;IACf,qCAAiB,CAAA;AACnB,CAAC,EALW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAK3B;AA+FD;;;GAGG;AACH,MAAa,gCAAiC,SAAQ,KAAK;IAGzD,YAAY,OAAe,EAAE,MAAmC;QAC9D,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;CACF;AAPD,4EAOC;AAED;;;;;GAKG;AACH,SAAS,wBAAwB,CAC/B,QAAmC;IAEnC,MAAM,YAAY,GAAG,QAAQ,CAAC,KAAK,EAAsB,CAAC;IAC1D,OAAO,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC;IAEzC,4EAA4E;IAC5E,6FAA6F;IAC7F,YAAY,CAAC,KAAK,GAAG,IAAA,oCAAe,EAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IAC1D,OAAO,YAAY,CAAC;AACtB,CAAC;AAED;;;;;GAKG;AACH,SAAgB,eAAe,CAC7B,KAA6D;IAE7D,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC;IAChD,MAAM,GAAG,GAAG,CAAC,wBAAwB,CAAC,QAAQ,CAAC,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC,MAAM,CAC1E,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,SAAS,CAC7B,CAAC;IACF,OAAO,aAAM,CAAC,MAAM,CAAC,IAAA,wBAAa,EAAC,GAAoB,CAAC,CAAC,CAAC;AAC5D,CAAC;AARD,0CAQC;AAED;;;;;;GAMG;AACH,SAAgB,kBAAkB,CAChC,KAA6D,EAC7D,YAAY,GAAG,wEAAwE;IAEvF,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,KAAK,eAAe,CAAC,KAAK,CAAC,EAAE;QAClE,MAAM,IAAI,gCAAgC,CACxC,YAAY,EACZ,mCAA2B,CAAC,cAAc,CAC3C,CAAC;KACH;AACH,CAAC;AAVD,gDAUC;AAEY,QAAA,mBAAmB,GAAG,CAAC,WAAW,EAAE,WAAW,EAAE,OAAO,CAAU,CAAC;AAEhF,iEAAiE;AACpD,QAAA,gBAAgB,GAAG,IAAA,qBAAO,EAAC,IAAA,oBAAM,GAAE,EAAE,iBAAiB,CAAC,CAAC;AAErE,MAAM,uBAAuB,GAAG,IAAA,WAAG,EAAC;IAClC,QAAQ,EAAE,IAAA,mBAAK,EAAC,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IACpC,QAAQ,EAAE,IAAA,mBAAK,EAAC,2BAAmB,CAAC;IACpC,IAAI,EAAE,IAAA,mBAAK,EAAC,IAAA,oBAAM,GAAE,CAAC;IACrB,MAAM,EAAE,IAAA,mBAAK,EAAC,IAAA,oBAAM,GAAE,CAAC;CACxB,CAAC,CAAC;AACU,QAAA,iBAAiB,GAAG,IAAA,oBAAM,EACrC,wBAAgB,EAChB,eAAe,EACf,CAAC,KAAK,EAAE,EAAE;IACR,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,sBAAc,CAAC,KAAK,CAAC,EAAE;QAC3C,OAAO,gCAAgC,KAAK,IAAI,CAAC;KAClD;IAED,MAAM,CAAC,KAAK,CAAC,GAAG,IAAA,sBAAQ,EACtB,KAAK,CAAC,KAAK,CAAC,sBAAc,CAAC,KAAK,CAAC,MAAM,CAAC,EACxC,uBAAuB,CACxB,CAAC;IACF,OAAO,KAAK,IAAI,IAAI,CAAC;AACvB,CAAC,CACF,CAAC;AACW,QAAA,eAAe,GAAG,IAAA,0BAAY,EAAC;IAC1C,wBAAgB;IAChB,IAAA,WAAG,EAAC;QACF,QAAQ,EAAE,IAAA,qBAAO,EAAC,sBAAc,CAAC,GAAG,CAAC;QACrC,QAAQ,EAAE,IAAA,oBAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,cAAc,EAAE,QAAQ,CAAC,EAAE,KAAK;YACzD,MAAM,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;YAClE,MAAM,EAAE,MAAM,EAAE,mBAAmB,EAAE,QAAQ,EAAE,GAC7C,IAAA,mCAAkB,EAAC,UAAU,CAAC,CAAC;YACjC,IAAI,CAAC,mBAAmB,EAAE;gBACxB,IAAI,MAAM,KAAK,SAAS,EAAE;oBACxB,IAAA,cAAM,EAAC,QAAQ,KAAK,SAAS,CAAC,CAAC;oBAC/B,KAAK,CAAC,CAAC,QAAQ,CAAC;iBACjB;qBAAM;oBACL,KAAK,CAAC,CAAC,MAAM,CAAC;iBACf;aACF;YACD,OAAO,IAAI,CAAC;QACd,CAAC,CAAC;QACF,MAAM,EAAE,IAAA,mBAAK,EAAC,IAAA,oBAAM,GAAE,CAAC;QACvB,IAAI,EAAE,IAAA,mBAAK,EAAC,IAAA,oBAAM,GAAE,CAAC;KACtB,CAAC;CACH,CAAoC,CAAC;AAEzB,QAAA,gBAAgB,GAAG,IAAA,0BAAY,EAAC;IAC3C,wBAAgB;IAChB,IAAA,WAAG,EAAC;QACF,QAAQ,EAAE,IAAA,mBAAK,EAAC,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QACpC,MAAM,EAAE,IAAA,mBAAK,EAAC,IAAA,oBAAM,GAAE,CAAC;QACvB,IAAI,EAAE,IAAA,mBAAK,EAAC,IAAA,oBAAM,GAAE,CAAC;KACtB,CAAC;CACH,CAAoC,CAAC;AAEzB,QAAA,YAAY,GAAG,IAAA,mBAAK,EAAC,CAAC,uBAAe,EAAE,yBAAiB,CAAC,CAAC,CAAC;AAKxE;;;;;GAKG;AACH,SAAgB,aAAa,CAAC,MAAc;IAC1C,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,sBAAc,CAAC,CAAC,IAAI,CAAC,CAAC,cAAc,EAAE,EAAE,CACnE,MAAM,CAAC,UAAU,CAAC,cAAc,CAAC,CAClC,CAAC;IACF,IAAI,MAAM,KAAK,SAAS,EAAE;QACxB,OAAO,MAAM,CAAC;KACf;IACD,MAAM,IAAI,KAAK,CAAC,mCAAmC,MAAM,GAAG,CAAC,CAAC;AAChE,CAAC;AARD,sCAQC;AAED;;;;;GAKG;AACH,SAAgB,mBAAmB,CACjC,KAAc;IAEd,IAAA,oBAAY,EAAC,KAAK,EAAE,oBAAY,EAAE,iBAAiB,CAAC,CAAC;AACvD,CAAC;AAJD,kDAIC;AAED;;;;;GAKG;AACH,SAAgB,aAAa,CAAC,OAAgB;IAC5C,OAAO,CACL,OAAO,OAAO,KAAK,QAAQ;QAC3B,kEAAkE,CAAC,IAAI,CACrE,OAAO,CACR,CACF,CAAC;AACJ,CAAC;AAPD,sCAOC;AAED;;;;;;GAMG;AACH,SAAgB,eAAe,CAC7B,WAAqD,EACrD,MAAc;IAEd,OAAO,OAAO,CAGR,CAAC,WAAW,EAAE,WAAW,EAAE,OAAO,EAAE,IAAI,CACtC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,wBAAc,CAAC,OAAO,CACnD,IAAI,EAAE,CACR,CAAC,KACH,EAAE,CAAC,MAAM,CAAC,CACZ,CAAC;AACJ,CAAC;AAbD,0CAaC;AAED;;;;;;GAMG;AACH,SAAgB,8BAA8B,CAC5C,oBAA6B;IAE7B,IAAA,cAAM,EACJ,IAAA,gBAAQ,EAAC,oBAAoB,CAAC,EAC9B,0CAA0C,CAC3C,CAAC;IAEF,MAAM,EAAE,WAAW,EAAE,oBAAoB,EAAE,GAAG,oBAAoB,CAAC;IAEnE,IAAA,cAAM,EACJ,IAAA,gBAAQ,EAAC,oBAAoB,CAAC,EAC9B,wDAAwD,CACzD,CAAC;IAEF,MAAM,EAAE,OAAO,EAAE,GAAG,oBAAoB,CAAC;IAEzC,IAAA,cAAM,EACJ,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAC9C,yEAAyE,CAC1E,CAAC;IAEF,MAAM,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC;IAEzB,IAAA,cAAM,EACJ,IAAA,gBAAQ,EAAC,MAAM,CAAC;QACd,MAAM,CAAC,IAAI,KAAK,wBAAc,CAAC,OAAO;QACtC,IAAA,gBAAQ,EAAC,MAAM,CAAC,KAAK,CAAC,EACxB,iDAAiD,wBAAc,CAAC,OAAO,UAAU,CAClF,CAAC;AACJ,CAAC;AA9BD,wEA8BC","sourcesContent":["import {\n Caveat,\n SubjectPermissions,\n PermissionConstraint,\n} from '@metamask/permission-controller';\nimport { BlockReason } from '@metamask/snaps-registry';\nimport {\n assert,\n Json,\n SemVerVersion,\n isObject,\n Opaque,\n assertStruct,\n} from '@metamask/utils';\nimport { base64 } from '@scure/base';\nimport { SerializedEthereumRpcError } from 'eth-rpc-errors/dist/classes';\nimport stableStringify from 'fast-json-stable-stringify';\nimport {\n empty,\n enums,\n intersection,\n literal,\n pattern,\n refine,\n string,\n Struct,\n union,\n validate,\n} from 'superstruct';\nimport validateNPMPackage from 'validate-npm-package-name';\n\nimport { SnapCaveatType } from './caveats';\nimport { checksumFiles } from './checksum';\nimport { SnapManifest, SnapPermissions } from './manifest/validation';\nimport {\n SnapFiles,\n SnapId,\n SnapIdPrefixes,\n SnapsPermissionRequest,\n SnapValidationFailureReason,\n uri,\n} from './types';\nimport { VirtualFile } from './virtual-file';\n\n// This RegEx matches valid npm package names (with some exceptions) and space-\n// separated alphanumerical words, optionally with dashes and underscores.\n// The RegEx consists of two parts. The first part matches space-separated\n// words. It is based on the following Stackoverflow answer:\n// https://stackoverflow.com/a/34974982\n// The second part, after the pipe operator, is the same RegEx used for the\n// `name` field of the official package.json JSON Schema, except that we allow\n// mixed-case letters. It was originally copied from:\n// https://github.com/SchemaStore/schemastore/blob/81a16897c1dabfd98c72242a5fd62eb080ff76d8/src/schemas/json/package.json#L132-L138\nexport const PROPOSED_NAME_REGEX =\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/**\n * wallet_enable / wallet_installSnaps permission typing.\n *\n * @deprecated This type is confusing and not descriptive, people confused it with typing initialPermissions, remove when removing wallet_enable.\n */\nexport type RequestedSnapPermissions = {\n [permission: string]: Record<string, Json>;\n};\n\nexport enum SnapStatus {\n Installing = 'installing',\n Updating = 'updating',\n Running = 'running',\n Stopped = 'stopped',\n Crashed = 'crashed',\n}\n\nexport enum SnapStatusEvents {\n Start = 'START',\n Stop = 'STOP',\n Crash = 'CRASH',\n Update = 'UPDATE',\n}\n\nexport type StatusContext = { snapId: string };\nexport type StatusEvents = { type: SnapStatusEvents };\nexport type StatusStates = {\n value: SnapStatus;\n context: StatusContext;\n};\nexport type Status = StatusStates['value'];\n\nexport type VersionHistory = {\n origin: string;\n version: string;\n // Unix timestamp\n date: number;\n};\n\nexport type PersistedSnap = Snap & {\n /**\n * The source code of the Snap.\n */\n sourceCode: string;\n};\n\n/**\n * A Snap as it exists in {@link SnapController} state.\n */\nexport type Snap = {\n /**\n * Whether the Snap is enabled, which determines if it can be started.\n */\n enabled: boolean;\n\n /**\n * The ID of the Snap.\n */\n id: SnapId;\n\n /**\n * The initial permissions of the Snap, which will be requested when it is\n * installed.\n */\n initialPermissions: SnapPermissions;\n\n /**\n * The Snap's manifest file.\n */\n manifest: SnapManifest;\n\n /**\n * Whether the Snap is blocked.\n */\n blocked: boolean;\n\n /**\n * Information detailing why the snap is blocked.\n */\n blockInformation?: BlockReason;\n\n /**\n * The current status of the Snap, e.g. whether it's running or stopped.\n */\n status: Status;\n\n /**\n * The version of the Snap.\n */\n version: SemVerVersion;\n\n /**\n * The version history of the Snap.\n * Can be used to derive when the Snap was installed, when it was updated to a certain version and who requested the change.\n */\n versionHistory: VersionHistory[];\n};\n\nexport type TruncatedSnapFields =\n | 'id'\n | 'initialPermissions'\n | 'version'\n | 'enabled'\n | 'blocked';\n\n/**\n * A {@link Snap} object with the fields that are relevant to an external\n * caller.\n */\nexport type TruncatedSnap = Pick<Snap, TruncatedSnapFields>;\n\nexport type ProcessSnapResult =\n | TruncatedSnap\n | { error: SerializedEthereumRpcError };\n\nexport type InstallSnapsResult = Record<SnapId, ProcessSnapResult>;\n\n/**\n * An error indicating that a Snap validation failure is programmatically\n * fixable during development.\n */\nexport class ProgrammaticallyFixableSnapError extends Error {\n reason: SnapValidationFailureReason;\n\n constructor(message: string, reason: SnapValidationFailureReason) {\n super(message);\n this.reason = reason;\n }\n}\n\n/**\n * Gets a checksummable manifest by removing the shasum property and reserializing the JSON using a deterministic algorithm.\n *\n * @param manifest - The manifest itself.\n * @returns A virtual file containing the checksummable manifest.\n */\nfunction getChecksummableManifest(\n manifest: VirtualFile<SnapManifest>,\n): VirtualFile {\n const manifestCopy = manifest.clone() as VirtualFile<any>;\n delete manifestCopy.result.source.shasum;\n\n // We use fast-json-stable-stringify to deterministically serialize the JSON\n // This is required before checksumming so we get reproducible checksums across platforms etc\n manifestCopy.value = stableStringify(manifestCopy.result);\n return manifestCopy;\n}\n\n/**\n * Calculates the Base64-encoded SHA-256 digest of all required Snap files.\n *\n * @param files - All required Snap files to be included in the checksum.\n * @returns The Base64-encoded SHA-256 digest of the source code.\n */\nexport function getSnapChecksum(\n files: Pick<SnapFiles, 'manifest' | 'sourceCode' | 'svgIcon'>,\n): string {\n const { manifest, sourceCode, svgIcon } = files;\n const all = [getChecksummableManifest(manifest), sourceCode, svgIcon].filter(\n (file) => file !== undefined,\n );\n return base64.encode(checksumFiles(all as VirtualFile[]));\n}\n\n/**\n * Checks whether the `source.shasum` property of a Snap manifest matches the\n * shasum of the snap.\n *\n * @param files - All required Snap files to be included in the checksum.\n * @param errorMessage - The error message to throw if validation fails.\n */\nexport function validateSnapShasum(\n files: Pick<SnapFiles, 'manifest' | 'sourceCode' | 'svgIcon'>,\n errorMessage = 'Invalid Snap manifest: manifest shasum does not match computed shasum.',\n): void {\n if (files.manifest.result.source.shasum !== getSnapChecksum(files)) {\n throw new ProgrammaticallyFixableSnapError(\n errorMessage,\n SnapValidationFailureReason.ShasumMismatch,\n );\n }\n}\n\nexport const LOCALHOST_HOSTNAMES = ['localhost', '127.0.0.1', '[::1]'] as const;\n\n// Require snap ids to only consist of printable ASCII characters\nexport const BaseSnapIdStruct = pattern(string(), /^[\\x21-\\x7E]*$/u);\n\nconst LocalSnapIdSubUrlStruct = uri({\n protocol: enums(['http:', 'https:']),\n hostname: enums(LOCALHOST_HOSTNAMES),\n hash: empty(string()),\n search: empty(string()),\n});\nexport const LocalSnapIdStruct = refine(\n BaseSnapIdStruct,\n 'local Snap Id',\n (value) => {\n if (!value.startsWith(SnapIdPrefixes.local)) {\n return `Expected local snap ID, got \"${value}\".`;\n }\n\n const [error] = validate(\n value.slice(SnapIdPrefixes.local.length),\n LocalSnapIdSubUrlStruct,\n );\n return error ?? true;\n },\n);\nexport const NpmSnapIdStruct = intersection([\n BaseSnapIdStruct,\n uri({\n protocol: literal(SnapIdPrefixes.npm),\n pathname: refine(string(), 'package name', function* (value) {\n const normalized = value.startsWith('/') ? value.slice(1) : value;\n const { errors, validForNewPackages, warnings } =\n validateNPMPackage(normalized);\n if (!validForNewPackages) {\n if (errors === undefined) {\n assert(warnings !== undefined);\n yield* warnings;\n } else {\n yield* errors;\n }\n }\n return true;\n }),\n search: empty(string()),\n hash: empty(string()),\n }),\n]) as unknown as Struct<string, null>;\n\nexport const HttpSnapIdStruct = intersection([\n BaseSnapIdStruct,\n uri({\n protocol: enums(['http:', 'https:']),\n search: empty(string()),\n hash: empty(string()),\n }),\n]) as unknown as Struct<string, null>;\n\nexport const SnapIdStruct = union([NpmSnapIdStruct, LocalSnapIdStruct]);\n\nexport type ValidatedSnapId = Opaque<string, typeof snapIdSymbol>;\ndeclare const snapIdSymbol: unique symbol;\n\n/**\n * Extracts the snap prefix from a snap ID.\n *\n * @param snapId - The snap ID to extract the prefix from.\n * @returns The snap prefix from a snap id, e.g. `npm:`.\n */\nexport function getSnapPrefix(snapId: string): SnapIdPrefixes {\n const prefix = Object.values(SnapIdPrefixes).find((possiblePrefix) =>\n snapId.startsWith(possiblePrefix),\n );\n if (prefix !== undefined) {\n return prefix;\n }\n throw new Error(`Invalid or no prefix found for \"${snapId}\"`);\n}\n\n/**\n * Assert that the given value is a valid snap ID.\n *\n * @param value - The value to check.\n * @throws If the value is not a valid snap ID.\n */\nexport function assertIsValidSnapId(\n value: unknown,\n): asserts value is ValidatedSnapId {\n assertStruct(value, SnapIdStruct, 'Invalid snap ID');\n}\n\n/**\n * Typeguard to ensure a chainId follows the CAIP-2 standard.\n *\n * @param chainId - The chainId being tested.\n * @returns `true` if the value is a valid CAIP chain id, and `false` otherwise.\n */\nexport function isCaipChainId(chainId: unknown): chainId is string {\n return (\n typeof chainId === 'string' &&\n /^(?<namespace>[-a-z0-9]{3,8}):(?<reference>[-a-zA-Z0-9]{1,32})$/u.test(\n chainId,\n )\n );\n}\n\n/**\n * Utility function to check if an origin has permission (and caveat) for a particular snap.\n *\n * @param permissions - An origin's permissions object.\n * @param snapId - The id of the snap.\n * @returns A boolean based on if an origin has the specified snap.\n */\nexport function isSnapPermitted(\n permissions: SubjectPermissions<PermissionConstraint>,\n snapId: SnapId,\n) {\n return Boolean(\n (\n (\n (permissions?.wallet_snap?.caveats?.find(\n (caveat) => caveat.type === SnapCaveatType.SnapIds,\n ) ?? {}) as Caveat<string, Json>\n ).value as Record<string, unknown>\n )?.[snapId],\n );\n}\n\n/**\n * Checks whether the passed in requestedPermissions is a valid\n * permission request for a `wallet_snap` permission.\n *\n * @param requestedPermissions - The requested permissions.\n * @throws If the criteria is not met.\n */\nexport function verifyRequestedSnapPermissions(\n requestedPermissions: unknown,\n): asserts requestedPermissions is SnapsPermissionRequest {\n assert(\n isObject(requestedPermissions),\n 'Requested permissions must be an object.',\n );\n\n const { wallet_snap: walletSnapPermission } = requestedPermissions;\n\n assert(\n isObject(walletSnapPermission),\n 'wallet_snap is missing from the requested permissions.',\n );\n\n const { caveats } = walletSnapPermission;\n\n assert(\n Array.isArray(caveats) && caveats.length === 1,\n 'wallet_snap must have a caveat property with a single-item array value.',\n );\n\n const [caveat] = caveats;\n\n assert(\n isObject(caveat) &&\n caveat.type === SnapCaveatType.SnapIds &&\n isObject(caveat.value),\n `The requested permissions do not have a valid ${SnapCaveatType.SnapIds} caveat.`,\n );\n}\n"]}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Json } from '@metamask/utils';
|
|
2
2
|
import { Infer, Struct } from 'superstruct';
|
|
3
3
|
import { SnapCaveatType } from './caveats';
|
|
4
|
-
import { SnapFunctionExports } from './handlers';
|
|
4
|
+
import { SnapFunctionExports, SnapKeyring as Keyring } from './handlers';
|
|
5
5
|
import { SnapManifest } from './manifest';
|
|
6
6
|
import { VirtualFile } from './virtual-file';
|
|
7
7
|
export declare enum NpmSnapFileNames {
|
|
@@ -88,6 +88,7 @@ export declare enum SNAP_STREAM_NAMES {
|
|
|
88
88
|
export declare enum HandlerType {
|
|
89
89
|
OnRpcRequest = "onRpcRequest",
|
|
90
90
|
OnTransaction = "onTransaction",
|
|
91
|
+
SnapKeyring = "keyring",
|
|
91
92
|
OnCronjob = "onCronjob"
|
|
92
93
|
}
|
|
93
94
|
export declare const SNAP_EXPORT_NAMES: HandlerType[];
|
|
@@ -98,7 +99,9 @@ export declare type SnapRpcHookArgs = {
|
|
|
98
99
|
};
|
|
99
100
|
export declare type SnapRpcHook = (options: SnapRpcHookArgs) => Promise<unknown>;
|
|
100
101
|
declare type ObjectParameters<Type extends Record<string, (...args: any[]) => unknown>> = Parameters<Type[keyof Type]>;
|
|
101
|
-
|
|
102
|
+
declare type KeyringParameter<Fn> = Fn extends (...args: any[]) => unknown ? Parameters<Fn> : never;
|
|
103
|
+
declare type KeyringParameters = KeyringParameter<Keyring[keyof Keyring]>;
|
|
104
|
+
export declare type SnapExportsParameters = ObjectParameters<SnapFunctionExports> | KeyringParameters;
|
|
102
105
|
declare type UriOptions<T extends string> = {
|
|
103
106
|
protocol?: Struct<T>;
|
|
104
107
|
hash?: Struct<T>;
|
package/dist/types.js
ADDED
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.WALLET_SNAP_PERMISSION_KEY = exports.isValidUrl = exports.uri = exports.SNAP_EXPORT_NAMES = exports.HandlerType = exports.SNAP_STREAM_NAMES = exports.SnapValidationFailureReason = exports.SnapIdPrefixes = exports.assertIsNpmSnapPackageJson = exports.isNpmSnapPackageJson = exports.NpmSnapPackageJsonStruct = exports.NameStruct = exports.NpmSnapFileNames = void 0;
|
|
4
|
+
const utils_1 = require("@metamask/utils");
|
|
5
|
+
const superstruct_1 = require("superstruct");
|
|
6
|
+
var NpmSnapFileNames;
|
|
7
|
+
(function (NpmSnapFileNames) {
|
|
8
|
+
NpmSnapFileNames["PackageJson"] = "package.json";
|
|
9
|
+
NpmSnapFileNames["Manifest"] = "snap.manifest.json";
|
|
10
|
+
})(NpmSnapFileNames = exports.NpmSnapFileNames || (exports.NpmSnapFileNames = {}));
|
|
11
|
+
exports.NameStruct = (0, superstruct_1.size)((0, superstruct_1.pattern)((0, superstruct_1.string)(), /^(?:@[a-z0-9-*~][a-z0-9-*._~]*\/)?[a-z0-9-~][a-z0-9-._~]*$/u), 1, 214);
|
|
12
|
+
// Note we use `type` instead of `object` here, because the latter does not
|
|
13
|
+
// allow unknown keys.
|
|
14
|
+
exports.NpmSnapPackageJsonStruct = (0, superstruct_1.type)({
|
|
15
|
+
version: utils_1.VersionStruct,
|
|
16
|
+
name: exports.NameStruct,
|
|
17
|
+
main: (0, superstruct_1.optional)((0, superstruct_1.size)((0, superstruct_1.string)(), 1, Infinity)),
|
|
18
|
+
repository: (0, superstruct_1.optional)((0, superstruct_1.object)({
|
|
19
|
+
type: (0, superstruct_1.size)((0, superstruct_1.string)(), 1, Infinity),
|
|
20
|
+
url: (0, superstruct_1.size)((0, superstruct_1.string)(), 1, Infinity),
|
|
21
|
+
})),
|
|
22
|
+
});
|
|
23
|
+
/**
|
|
24
|
+
* Check if the given value is a valid {@link NpmSnapPackageJson} object.
|
|
25
|
+
*
|
|
26
|
+
* @param value - The value to check.
|
|
27
|
+
* @returns Whether the value is a valid {@link NpmSnapPackageJson} object.
|
|
28
|
+
*/
|
|
29
|
+
function isNpmSnapPackageJson(value) {
|
|
30
|
+
return (0, superstruct_1.is)(value, exports.NpmSnapPackageJsonStruct);
|
|
31
|
+
}
|
|
32
|
+
exports.isNpmSnapPackageJson = isNpmSnapPackageJson;
|
|
33
|
+
/**
|
|
34
|
+
* Asserts that the given value is a valid {@link NpmSnapPackageJson} object.
|
|
35
|
+
*
|
|
36
|
+
* @param value - The value to check.
|
|
37
|
+
* @throws If the value is not a valid {@link NpmSnapPackageJson} object.
|
|
38
|
+
*/
|
|
39
|
+
function assertIsNpmSnapPackageJson(value) {
|
|
40
|
+
(0, utils_1.assertStruct)(value, exports.NpmSnapPackageJsonStruct, `"${NpmSnapFileNames.PackageJson}" is invalid`);
|
|
41
|
+
}
|
|
42
|
+
exports.assertIsNpmSnapPackageJson = assertIsNpmSnapPackageJson;
|
|
43
|
+
/**
|
|
44
|
+
* The possible prefixes for snap ids.
|
|
45
|
+
*/
|
|
46
|
+
/* eslint-disable @typescript-eslint/naming-convention */
|
|
47
|
+
var SnapIdPrefixes;
|
|
48
|
+
(function (SnapIdPrefixes) {
|
|
49
|
+
SnapIdPrefixes["npm"] = "npm:";
|
|
50
|
+
SnapIdPrefixes["local"] = "local:";
|
|
51
|
+
})(SnapIdPrefixes = exports.SnapIdPrefixes || (exports.SnapIdPrefixes = {}));
|
|
52
|
+
/**
|
|
53
|
+
* Snap validation failure reason codes that are programmatically fixable
|
|
54
|
+
* if validation occurs during development.
|
|
55
|
+
*/
|
|
56
|
+
var SnapValidationFailureReason;
|
|
57
|
+
(function (SnapValidationFailureReason) {
|
|
58
|
+
SnapValidationFailureReason["NameMismatch"] = "\"name\" field mismatch";
|
|
59
|
+
SnapValidationFailureReason["VersionMismatch"] = "\"version\" field mismatch";
|
|
60
|
+
SnapValidationFailureReason["RepositoryMismatch"] = "\"repository\" field mismatch";
|
|
61
|
+
SnapValidationFailureReason["ShasumMismatch"] = "\"shasum\" field mismatch";
|
|
62
|
+
})(SnapValidationFailureReason = exports.SnapValidationFailureReason || (exports.SnapValidationFailureReason = {}));
|
|
63
|
+
/* eslint-disable @typescript-eslint/naming-convention */
|
|
64
|
+
var SNAP_STREAM_NAMES;
|
|
65
|
+
(function (SNAP_STREAM_NAMES) {
|
|
66
|
+
SNAP_STREAM_NAMES["JSON_RPC"] = "jsonRpc";
|
|
67
|
+
SNAP_STREAM_NAMES["COMMAND"] = "command";
|
|
68
|
+
})(SNAP_STREAM_NAMES = exports.SNAP_STREAM_NAMES || (exports.SNAP_STREAM_NAMES = {}));
|
|
69
|
+
/* eslint-enable @typescript-eslint/naming-convention */
|
|
70
|
+
var HandlerType;
|
|
71
|
+
(function (HandlerType) {
|
|
72
|
+
HandlerType["OnRpcRequest"] = "onRpcRequest";
|
|
73
|
+
HandlerType["OnTransaction"] = "onTransaction";
|
|
74
|
+
HandlerType["SnapKeyring"] = "keyring";
|
|
75
|
+
HandlerType["OnCronjob"] = "onCronjob";
|
|
76
|
+
})(HandlerType = exports.HandlerType || (exports.HandlerType = {}));
|
|
77
|
+
exports.SNAP_EXPORT_NAMES = Object.values(HandlerType);
|
|
78
|
+
const uri = (opts = {}) => (0, superstruct_1.refine)((0, superstruct_1.union)([(0, superstruct_1.string)(), (0, superstruct_1.instance)(URL)]), 'uri', (value) => {
|
|
79
|
+
try {
|
|
80
|
+
const url = new URL(value);
|
|
81
|
+
const UrlStruct = (0, superstruct_1.type)(opts);
|
|
82
|
+
(0, superstruct_1.assert)(url, UrlStruct);
|
|
83
|
+
return true;
|
|
84
|
+
}
|
|
85
|
+
catch {
|
|
86
|
+
return `Expected URL, got "${value.toString()}".`;
|
|
87
|
+
}
|
|
88
|
+
});
|
|
89
|
+
exports.uri = uri;
|
|
90
|
+
/**
|
|
91
|
+
* Returns whether a given value is a valid URL.
|
|
92
|
+
*
|
|
93
|
+
* @param url - The value to check.
|
|
94
|
+
* @param opts - Optional constraints for url checking.
|
|
95
|
+
* @returns Whether `url` is valid URL or not.
|
|
96
|
+
*/
|
|
97
|
+
function isValidUrl(url, opts = {}) {
|
|
98
|
+
return (0, superstruct_1.is)(url, (0, exports.uri)(opts));
|
|
99
|
+
}
|
|
100
|
+
exports.isValidUrl = isValidUrl;
|
|
101
|
+
// redefining here to avoid circular dependency
|
|
102
|
+
exports.WALLET_SNAP_PERMISSION_KEY = 'wallet_snap';
|
|
103
|
+
//# sourceMappingURL=types.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAAA,2CAAoE;AACpE,6CAcqB;AAOrB,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,gDAA4B,CAAA;IAC5B,mDAA+B,CAAA;AACjC,CAAC,EAHW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAG3B;AAEY,QAAA,UAAU,GAAG,IAAA,kBAAI,EAC5B,IAAA,qBAAO,EACL,IAAA,oBAAM,GAAE,EACR,6DAA6D,CAC9D,EACD,CAAC,EACD,GAAG,CACJ,CAAC;AAEF,2EAA2E;AAC3E,sBAAsB;AACT,QAAA,wBAAwB,GAAG,IAAA,kBAAI,EAAC;IAC3C,OAAO,EAAE,qBAAa;IACtB,IAAI,EAAE,kBAAU;IAChB,IAAI,EAAE,IAAA,sBAAQ,EAAC,IAAA,kBAAI,EAAC,IAAA,oBAAM,GAAE,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC3C,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;CACF,CAAC,CAAC;AAKH;;;;;GAKG;AACH,SAAgB,oBAAoB,CAClC,KAAc;IAEd,OAAO,IAAA,gBAAE,EAAC,KAAK,EAAE,gCAAwB,CAAC,CAAC;AAC7C,CAAC;AAJD,oDAIC;AAED;;;;;GAKG;AACH,SAAgB,0BAA0B,CACxC,KAAc;IAEd,IAAA,oBAAY,EACV,KAAK,EACL,gCAAwB,EACxB,IAAI,gBAAgB,CAAC,WAAW,cAAc,CAC/C,CAAC;AACJ,CAAC;AARD,gEAQC;AAuBD;;GAEG;AACH,yDAAyD;AACzD,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,8BAAY,CAAA;IACZ,kCAAgB,CAAA;AAClB,CAAC,EAHW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAGzB;AAKD;;;GAGG;AACH,IAAY,2BAKX;AALD,WAAY,2BAA2B;IACrC,uEAAsC,CAAA;IACtC,6EAA4C,CAAA;IAC5C,mFAAkD,CAAA;IAClD,2EAA0C,CAAA;AAC5C,CAAC,EALW,2BAA2B,GAA3B,mCAA2B,KAA3B,mCAA2B,QAKtC;AAED,yDAAyD;AACzD,IAAY,iBAGX;AAHD,WAAY,iBAAiB;IAC3B,yCAAoB,CAAA;IACpB,wCAAmB,CAAA;AACrB,CAAC,EAHW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAG5B;AACD,wDAAwD;AAExD,IAAY,WAKX;AALD,WAAY,WAAW;IACrB,4CAA6B,CAAA;IAC7B,8CAA+B,CAAA;IAC/B,sCAAuB,CAAA;IACvB,sCAAuB,CAAA;AACzB,CAAC,EALW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAKtB;AAEY,QAAA,iBAAiB,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;AAiCrD,MAAM,GAAG,GAAG,CAAC,OAAwB,EAAE,EAAE,EAAE,CAChD,IAAA,oBAAM,EAAC,IAAA,mBAAK,EAAC,CAAC,IAAA,oBAAM,GAAE,EAAE,IAAA,sBAAQ,EAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE;IACxD,IAAI;QACF,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC;QAE3B,MAAM,SAAS,GAAG,IAAA,kBAAI,EAAC,IAAI,CAAC,CAAC;QAC7B,IAAA,oBAAiB,EAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QAClC,OAAO,IAAI,CAAC;KACb;IAAC,MAAM;QACN,OAAO,sBAAsB,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC;KACnD;AACH,CAAC,CAAC,CAAC;AAXQ,QAAA,GAAG,OAWX;AAEL;;;;;;GAMG;AACH,SAAgB,UAAU,CACxB,GAAY,EACZ,OAAwB,EAAE;IAE1B,OAAO,IAAA,gBAAE,EAAC,GAAG,EAAE,IAAA,WAAG,EAAC,IAAI,CAAC,CAAC,CAAC;AAC5B,CAAC;AALD,gCAKC;AAED,+CAA+C;AAClC,QAAA,0BAA0B,GAAG,aAAa,CAAC","sourcesContent":["import { assertStruct, Json, VersionStruct } from '@metamask/utils';\nimport {\n Infer,\n instance,\n is,\n object,\n optional,\n pattern,\n refine,\n size,\n string,\n Struct,\n type,\n union,\n assert as assertSuperstruct,\n} from 'superstruct';\n\nimport { SnapCaveatType } from './caveats';\nimport { SnapFunctionExports, SnapKeyring as Keyring } from './handlers';\nimport { SnapManifest } from './manifest';\nimport { VirtualFile } from './virtual-file';\n\nexport enum NpmSnapFileNames {\n PackageJson = 'package.json',\n Manifest = 'snap.manifest.json',\n}\n\nexport const NameStruct = size(\n pattern(\n string(),\n /^(?:@[a-z0-9-*~][a-z0-9-*._~]*\\/)?[a-z0-9-~][a-z0-9-._~]*$/u,\n ),\n 1,\n 214,\n);\n\n// Note we use `type` instead of `object` here, because the latter does not\n// allow unknown keys.\nexport const NpmSnapPackageJsonStruct = type({\n version: VersionStruct,\n name: NameStruct,\n main: optional(size(string(), 1, Infinity)),\n repository: optional(\n object({\n type: size(string(), 1, Infinity),\n url: size(string(), 1, Infinity),\n }),\n ),\n});\n\nexport type NpmSnapPackageJson = Infer<typeof NpmSnapPackageJsonStruct> &\n Record<string, any>;\n\n/**\n * Check if the given value is a valid {@link NpmSnapPackageJson} object.\n *\n * @param value - The value to check.\n * @returns Whether the value is a valid {@link NpmSnapPackageJson} object.\n */\nexport function isNpmSnapPackageJson(\n value: unknown,\n): value is NpmSnapPackageJson {\n return is(value, NpmSnapPackageJsonStruct);\n}\n\n/**\n * Asserts that the given value is a valid {@link NpmSnapPackageJson} object.\n *\n * @param value - The value to check.\n * @throws If the value is not a valid {@link NpmSnapPackageJson} object.\n */\nexport function assertIsNpmSnapPackageJson(\n value: unknown,\n): asserts value is NpmSnapPackageJson {\n assertStruct(\n value,\n NpmSnapPackageJsonStruct,\n `\"${NpmSnapFileNames.PackageJson}\" is invalid`,\n );\n}\n\n/**\n * An object for storing parsed but unvalidated Snap file contents.\n */\nexport type UnvalidatedSnapFiles = {\n manifest?: VirtualFile<Json>;\n packageJson?: VirtualFile<Json>;\n sourceCode?: VirtualFile;\n svgIcon?: VirtualFile;\n};\n\n/**\n * An object for storing the contents of Snap files that have passed JSON\n * Schema validation, or are non-empty if they are strings.\n */\nexport type SnapFiles = {\n manifest: VirtualFile<SnapManifest>;\n packageJson: VirtualFile<NpmSnapPackageJson>;\n sourceCode: VirtualFile;\n svgIcon?: VirtualFile;\n};\n\n/**\n * The possible prefixes for snap ids.\n */\n/* eslint-disable @typescript-eslint/naming-convention */\nexport enum SnapIdPrefixes {\n npm = 'npm:',\n local = 'local:',\n}\n/* eslint-enable @typescript-eslint/naming-convention */\n\nexport type SnapId = string;\n\n/**\n * Snap validation failure reason codes that are programmatically fixable\n * if validation occurs during development.\n */\nexport enum SnapValidationFailureReason {\n NameMismatch = '\"name\" field mismatch',\n VersionMismatch = '\"version\" field mismatch',\n RepositoryMismatch = '\"repository\" field mismatch',\n ShasumMismatch = '\"shasum\" field mismatch',\n}\n\n/* eslint-disable @typescript-eslint/naming-convention */\nexport enum SNAP_STREAM_NAMES {\n JSON_RPC = 'jsonRpc',\n COMMAND = 'command',\n}\n/* eslint-enable @typescript-eslint/naming-convention */\n\nexport enum HandlerType {\n OnRpcRequest = 'onRpcRequest',\n OnTransaction = 'onTransaction',\n SnapKeyring = 'keyring',\n OnCronjob = 'onCronjob',\n}\n\nexport const SNAP_EXPORT_NAMES = Object.values(HandlerType);\n\nexport type SnapRpcHookArgs = {\n origin: string;\n handler: HandlerType;\n request: Record<string, unknown>;\n};\n\n// The snap is the callee\nexport type SnapRpcHook = (options: SnapRpcHookArgs) => Promise<unknown>;\n\ntype ObjectParameters<\n Type extends Record<string, (...args: any[]) => unknown>,\n> = Parameters<Type[keyof Type]>;\n\ntype KeyringParameter<Fn> = Fn extends (...args: any[]) => unknown\n ? Parameters<Fn>\n : never;\n\ntype KeyringParameters = KeyringParameter<Keyring[keyof Keyring]>;\n\nexport type SnapExportsParameters =\n | ObjectParameters<SnapFunctionExports>\n | KeyringParameters;\n\ntype UriOptions<T extends string> = {\n protocol?: Struct<T>;\n hash?: Struct<T>;\n port?: Struct<T>;\n hostname?: Struct<T>;\n pathname?: Struct<T>;\n search?: Struct<T>;\n};\nexport const uri = (opts: UriOptions<any> = {}) =>\n refine(union([string(), instance(URL)]), 'uri', (value) => {\n try {\n const url = new URL(value);\n\n const UrlStruct = type(opts);\n assertSuperstruct(url, UrlStruct);\n return true;\n } catch {\n return `Expected URL, got \"${value.toString()}\".`;\n }\n });\n\n/**\n * Returns whether a given value is a valid URL.\n *\n * @param url - The value to check.\n * @param opts - Optional constraints for url checking.\n * @returns Whether `url` is valid URL or not.\n */\nexport function isValidUrl(\n url: unknown,\n opts: UriOptions<any> = {},\n): url is string | URL {\n return is(url, uri(opts));\n}\n\n// redefining here to avoid circular dependency\nexport const WALLET_SNAP_PERMISSION_KEY = 'wallet_snap';\n\nexport type SnapsPermissionRequest = {\n [WALLET_SNAP_PERMISSION_KEY]: {\n caveats: [\n {\n type: SnapCaveatType.SnapIds;\n value: Record<string, Json>;\n },\n ];\n };\n};\n"]}
|
|
@@ -1,7 +1,10 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.resolveVersionRange = exports.getTargetVersion = exports.DEFAULT_REQUESTED_SNAP_VERSION = void 0;
|
|
4
|
+
const utils_1 = require("@metamask/utils");
|
|
5
|
+
const semver_1 = require("semver");
|
|
6
|
+
const superstruct_1 = require("superstruct");
|
|
7
|
+
exports.DEFAULT_REQUESTED_SNAP_VERSION = '*';
|
|
5
8
|
/**
|
|
6
9
|
* Return the highest version in the list that satisfies the range, or `null` if
|
|
7
10
|
* none of them do. For the satisfaction check, pre-release versions will only
|
|
@@ -11,31 +14,31 @@ export const DEFAULT_REQUESTED_SNAP_VERSION = '*';
|
|
|
11
14
|
* @param versionRange - The SemVer version range to check against.
|
|
12
15
|
* @returns The highest version in the list that satisfies the range,
|
|
13
16
|
* or `null` if none of them do.
|
|
14
|
-
*/
|
|
15
|
-
|
|
17
|
+
*/
|
|
18
|
+
function getTargetVersion(versions, versionRange) {
|
|
19
|
+
const maxSatisfyingNonPreRelease = (0, semver_1.maxSatisfying)(versions, versionRange);
|
|
16
20
|
// By default don't use pre-release versions
|
|
17
21
|
if (maxSatisfyingNonPreRelease) {
|
|
18
22
|
return maxSatisfyingNonPreRelease;
|
|
19
23
|
}
|
|
20
24
|
// If no satisfying release version is found by default, try pre-release versions
|
|
21
|
-
return
|
|
22
|
-
includePrerelease: true
|
|
25
|
+
return (0, semver_1.maxSatisfying)(versions, versionRange, {
|
|
26
|
+
includePrerelease: true,
|
|
23
27
|
});
|
|
24
28
|
}
|
|
29
|
+
exports.getTargetVersion = getTargetVersion;
|
|
25
30
|
/**
|
|
26
31
|
* Parse a version received by some subject attempting to access a snap.
|
|
27
32
|
*
|
|
28
33
|
* @param version - The received version value.
|
|
29
34
|
* @returns `*` if the version is `undefined` or `latest", otherwise returns
|
|
30
35
|
* the specified version.
|
|
31
|
-
*/
|
|
36
|
+
*/
|
|
37
|
+
function resolveVersionRange(version) {
|
|
32
38
|
if (version === undefined || version === 'latest') {
|
|
33
|
-
return [
|
|
34
|
-
undefined,
|
|
35
|
-
DEFAULT_REQUESTED_SNAP_VERSION
|
|
36
|
-
];
|
|
39
|
+
return [undefined, exports.DEFAULT_REQUESTED_SNAP_VERSION];
|
|
37
40
|
}
|
|
38
|
-
return validate(version, VersionRangeStruct);
|
|
41
|
+
return (0, superstruct_1.validate)(version, utils_1.VersionRangeStruct);
|
|
39
42
|
}
|
|
40
|
-
|
|
43
|
+
exports.resolveVersionRange = resolveVersionRange;
|
|
41
44
|
//# sourceMappingURL=versions.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"versions.js","sourceRoot":"","sources":["../src/versions.ts"],"names":[],"mappings":";;;AAAA,2CAKyB;AACzB,mCAA8D;AAC9D,6CAAuC;AAE1B,QAAA,8BAA8B,GAAG,GAAkB,CAAC;AAEjE;;;;;;;;;GASG;AACH,SAAgB,gBAAgB,CAC9B,QAAyB,EACzB,YAAyB;IAEzB,MAAM,0BAA0B,GAAG,IAAA,sBAAmB,EACpD,QAAQ,EACR,YAAY,CACb,CAAC;IAEF,4CAA4C;IAC5C,IAAI,0BAA0B,EAAE;QAC9B,OAAO,0BAA0B,CAAC;KACnC;IAED,iFAAiF;IACjF,OAAO,IAAA,sBAAmB,EAAC,QAAQ,EAAE,YAAY,EAAE;QACjD,iBAAiB,EAAE,IAAI;KACxB,CAAC,CAAC;AACL,CAAC;AAlBD,4CAkBC;AAED;;;;;;GAMG;AACH,SAAgB,mBAAmB,CACjC,OAAc;IAEd,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,KAAK,QAAQ,EAAE;QACjD,OAAO,CAAC,SAAS,EAAE,sCAA8B,CAAC,CAAC;KACpD;IACD,OAAO,IAAA,sBAAQ,EAAC,OAAO,EAAE,0BAAkB,CAAC,CAAC;AAC/C,CAAC;AAPD,kDAOC","sourcesContent":["import {\n Json,\n SemVerVersion,\n SemVerRange,\n VersionRangeStruct,\n} from '@metamask/utils';\nimport { maxSatisfying as maxSatisfyingSemver } from 'semver';\nimport { validate } from 'superstruct';\n\nexport const DEFAULT_REQUESTED_SNAP_VERSION = '*' as SemVerRange;\n\n/**\n * Return the highest version in the list that satisfies the range, or `null` if\n * none of them do. For the satisfaction check, pre-release versions will only\n * be checked if no satisfactory non-prerelease version is found first.\n *\n * @param versions - The list of version to check.\n * @param versionRange - The SemVer version range to check against.\n * @returns The highest version in the list that satisfies the range,\n * or `null` if none of them do.\n */\nexport function getTargetVersion(\n versions: SemVerVersion[],\n versionRange: SemVerRange,\n): SemVerVersion | null {\n const maxSatisfyingNonPreRelease = maxSatisfyingSemver(\n versions,\n versionRange,\n );\n\n // By default don't use pre-release versions\n if (maxSatisfyingNonPreRelease) {\n return maxSatisfyingNonPreRelease;\n }\n\n // If no satisfying release version is found by default, try pre-release versions\n return maxSatisfyingSemver(versions, versionRange, {\n includePrerelease: true,\n });\n}\n\n/**\n * Parse a version received by some subject attempting to access a snap.\n *\n * @param version - The received version value.\n * @returns `*` if the version is `undefined` or `latest\", otherwise returns\n * the specified version.\n */\nexport function resolveVersionRange(\n version?: Json,\n): [error: undefined, range: SemVerRange] | [error: Error, range: undefined] {\n if (version === undefined || version === 'latest') {\n return [undefined, DEFAULT_REQUESTED_SNAP_VERSION];\n }\n return validate(version, VersionRangeStruct);\n}\n"]}
|
|
@@ -1,3 +1,6 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.VirtualFile = void 0;
|
|
1
4
|
// TODO(ritave): Move into separate package @metamask/vfile / @metamask/utils + @metamask/to-vfile when passes code review
|
|
2
5
|
// TODO(ritave): Streaming vfile contents similar to vinyl maybe?
|
|
3
6
|
// TODO(ritave): Move fixing manifest in cli and bundler plugins to write messages to vfile
|
|
@@ -6,54 +9,15 @@
|
|
|
6
9
|
// Using https://github.com/vfile/vfile would be helpful, but they only support ESM and we need to support CommonJS.
|
|
7
10
|
// https://github.com/gulpjs/vinyl is also good, but they normalize paths, which we can't do, because
|
|
8
11
|
// we're calculating checksums based on original path.
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
enumerable: true,
|
|
14
|
-
configurable: true,
|
|
15
|
-
writable: true
|
|
16
|
-
});
|
|
17
|
-
} else {
|
|
18
|
-
obj[key] = value;
|
|
19
|
-
}
|
|
20
|
-
return obj;
|
|
21
|
-
}
|
|
22
|
-
import { assert } from '@metamask/utils';
|
|
23
|
-
import { deepClone } from '../deep-clone';
|
|
24
|
-
export class VirtualFile {
|
|
25
|
-
toString(encoding) {
|
|
26
|
-
if (typeof this.value === 'string') {
|
|
27
|
-
assert(encoding === undefined, 'Tried to encode string.');
|
|
28
|
-
return this.value;
|
|
29
|
-
}
|
|
30
|
-
const decoder = new TextDecoder(encoding);
|
|
31
|
-
return decoder.decode(this.value);
|
|
32
|
-
}
|
|
33
|
-
clone() {
|
|
34
|
-
const vfile = new VirtualFile();
|
|
35
|
-
if (typeof this.value === 'string') {
|
|
36
|
-
vfile.value = this.value;
|
|
37
|
-
} else {
|
|
38
|
-
// deep-clone doesn't clone Buffer properly, even if it's a sub-class of Uint8Array
|
|
39
|
-
vfile.value = this.value.slice(0);
|
|
40
|
-
}
|
|
41
|
-
vfile.result = deepClone(this.result);
|
|
42
|
-
vfile.data = deepClone(this.data);
|
|
43
|
-
vfile.path = this.path;
|
|
44
|
-
return vfile;
|
|
45
|
-
}
|
|
46
|
-
constructor(value){
|
|
47
|
-
_define_property(this, "value", void 0);
|
|
48
|
-
_define_property(this, "result", void 0);
|
|
49
|
-
_define_property(this, "data", void 0);
|
|
50
|
-
_define_property(this, "path", void 0);
|
|
12
|
+
const utils_1 = require("@metamask/utils");
|
|
13
|
+
const deep_clone_1 = require("../deep-clone");
|
|
14
|
+
class VirtualFile {
|
|
15
|
+
constructor(value) {
|
|
51
16
|
let options;
|
|
52
17
|
if (typeof value === 'string' || value instanceof Uint8Array) {
|
|
53
|
-
options = {
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
} else {
|
|
18
|
+
options = { value };
|
|
19
|
+
}
|
|
20
|
+
else {
|
|
57
21
|
options = value;
|
|
58
22
|
}
|
|
59
23
|
this.value = options?.value ?? '';
|
|
@@ -70,6 +34,28 @@ export class VirtualFile {
|
|
|
70
34
|
this.data = options?.data ?? {};
|
|
71
35
|
this.path = options?.path ?? '/';
|
|
72
36
|
}
|
|
37
|
+
toString(encoding) {
|
|
38
|
+
if (typeof this.value === 'string') {
|
|
39
|
+
(0, utils_1.assert)(encoding === undefined, 'Tried to encode string.');
|
|
40
|
+
return this.value;
|
|
41
|
+
}
|
|
42
|
+
const decoder = new TextDecoder(encoding);
|
|
43
|
+
return decoder.decode(this.value);
|
|
44
|
+
}
|
|
45
|
+
clone() {
|
|
46
|
+
const vfile = new VirtualFile();
|
|
47
|
+
if (typeof this.value === 'string') {
|
|
48
|
+
vfile.value = this.value;
|
|
49
|
+
}
|
|
50
|
+
else {
|
|
51
|
+
// deep-clone doesn't clone Buffer properly, even if it's a sub-class of Uint8Array
|
|
52
|
+
vfile.value = this.value.slice(0);
|
|
53
|
+
}
|
|
54
|
+
vfile.result = (0, deep_clone_1.deepClone)(this.result);
|
|
55
|
+
vfile.data = (0, deep_clone_1.deepClone)(this.data);
|
|
56
|
+
vfile.path = this.path;
|
|
57
|
+
return vfile;
|
|
58
|
+
}
|
|
73
59
|
}
|
|
74
|
-
|
|
60
|
+
exports.VirtualFile = VirtualFile;
|
|
75
61
|
//# sourceMappingURL=VirtualFile.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"VirtualFile.js","sourceRoot":"","sources":["../../src/virtual-file/VirtualFile.ts"],"names":[],"mappings":";;;AAAA,0HAA0H;AAC1H,iEAAiE;AACjE,2FAA2F;AAC3F,wFAAwF;AACxF,EAAE;AACF,oHAAoH;AACpH,qGAAqG;AACrG,sDAAsD;AACtD,2CAAyC;AAEzC,8CAA0C;AA+B1C,MAAa,WAAW;IACtB,YAAY,KAA0B;QACpC,IAAI,OAA4B,CAAC;QACjC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,YAAY,UAAU,EAAE;YAC5D,OAAO,GAAG,EAAE,KAAK,EAAE,CAAC;SACrB;aAAM;YACL,OAAO,GAAG,KAAK,CAAC;SACjB;QAED,IAAI,CAAC,KAAK,GAAG,OAAO,EAAE,KAAK,IAAI,EAAE,CAAC;QAClC,wDAAwD;QACxD,gEAAgE;QAChE,4DAA4D;QAC5D,EAAE;QACF,wEAAwE;QACxE,4EAA4E;QAC5E,8EAA8E;QAC9E,EAAE;QACF,iDAAiD;QACjD,IAAI,CAAC,MAAM,GAAG,OAAO,EAAE,MAAM,IAAK,SAAiB,CAAC;QACpD,IAAI,CAAC,IAAI,GAAG,OAAO,EAAE,IAAI,IAAI,EAAE,CAAC;QAChC,IAAI,CAAC,IAAI,GAAG,OAAO,EAAE,IAAI,IAAI,GAAG,CAAC;IACnC,CAAC;IAUD,QAAQ,CAAC,QAAiB;QACxB,IAAI,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,EAAE;YAClC,IAAA,cAAM,EAAC,QAAQ,KAAK,SAAS,EAAE,yBAAyB,CAAC,CAAC;YAC1D,OAAO,IAAI,CAAC,KAAK,CAAC;SACnB;QACD,MAAM,OAAO,GAAG,IAAI,WAAW,CAAC,QAAQ,CAAC,CAAC;QAC1C,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC;IAED,KAAK;QACH,MAAM,KAAK,GAAG,IAAI,WAAW,EAAU,CAAC;QACxC,IAAI,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,EAAE;YAClC,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;SAC1B;aAAM;YACL,mFAAmF;YACnF,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SACnC;QACD,KAAK,CAAC,MAAM,GAAG,IAAA,sBAAS,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACtC,KAAK,CAAC,IAAI,GAAG,IAAA,sBAAS,EAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClC,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACvB,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AAtDD,kCAsDC","sourcesContent":["// TODO(ritave): Move into separate package @metamask/vfile / @metamask/utils + @metamask/to-vfile when passes code review\n// TODO(ritave): Streaming vfile contents similar to vinyl maybe?\n// TODO(ritave): Move fixing manifest in cli and bundler plugins to write messages to vfile\n// similar to unified instead of throwing \"ProgrammaticallyFixableErrors\".\n//\n// Using https://github.com/vfile/vfile would be helpful, but they only support ESM and we need to support CommonJS.\n// https://github.com/gulpjs/vinyl is also good, but they normalize paths, which we can't do, because\n// we're calculating checksums based on original path.\nimport { assert } from '@metamask/utils';\n\nimport { deepClone } from '../deep-clone';\n\n/**\n * This map registers the type of the {@link VirtualFile.data} key of a {@link VirtualFile}.\n *\n * This type can be augmented to register custom `data` types.\n *\n * @example\n * declare module '@metamask/snaps-utils' {\n * interface DataMap {\n * // `file.data.name` is typed as `string`\n * name: string\n * }\n * }\n */\n// eslint-disable-next-line @typescript-eslint/consistent-type-definitions, @typescript-eslint/no-empty-interface\nexport interface DataMap {}\n\nexport type Value = string | Uint8Array;\nexport type Compatible<Result = unknown> =\n | string\n | Uint8Array\n | Options<Result>;\nexport type Data = Record<string, unknown> & Partial<DataMap>;\nexport type Options<Result = unknown> = {\n value: Value;\n path?: string;\n data?: Data;\n result?: Result;\n};\n\nexport class VirtualFile<Result = unknown> {\n constructor(value?: Compatible<Result>) {\n let options: Options | undefined;\n if (typeof value === 'string' || value instanceof Uint8Array) {\n options = { value };\n } else {\n options = value;\n }\n\n this.value = options?.value ?? '';\n // This situations happens when there's no .result used,\n // we expect the file to have default generic in that situation:\n // VirtualFile<unknown> which will handle undefined properly\n //\n // While not 100% type safe, it'll be way less frustrating to work with.\n // The alternative would be to have VirtualFile.result be Result | undefined\n // and that would result in needing to branch out and check in all situations.\n //\n // In short, optimizing for most common use case.\n this.result = options?.result ?? (undefined as any);\n this.data = options?.data ?? {};\n this.path = options?.path ?? '/';\n }\n\n value: Value;\n\n result: Result;\n\n data: Data;\n\n path: string;\n\n toString(encoding?: string) {\n if (typeof this.value === 'string') {\n assert(encoding === undefined, 'Tried to encode string.');\n return this.value;\n }\n const decoder = new TextDecoder(encoding);\n return decoder.decode(this.value);\n }\n\n clone() {\n const vfile = new VirtualFile<Result>();\n if (typeof this.value === 'string') {\n vfile.value = this.value;\n } else {\n // deep-clone doesn't clone Buffer properly, even if it's a sub-class of Uint8Array\n vfile.value = this.value.slice(0);\n }\n vfile.result = deepClone(this.result);\n vfile.data = deepClone(this.data);\n vfile.path = this.path;\n return vfile;\n }\n}\n"]}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./VirtualFile"), exports);
|
|
18
|
+
//# sourceMappingURL=index.browser.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.browser.js","sourceRoot":"","sources":["../../src/virtual-file/index.browser.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gDAA8B","sourcesContent":["export * from './VirtualFile';\n"]}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./toVirtualFile"), exports);
|
|
18
|
+
__exportStar(require("./VirtualFile"), exports);
|
|
19
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/virtual-file/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,kDAAgC;AAChC,gDAA8B","sourcesContent":["export * from './toVirtualFile';\nexport * from './VirtualFile';\n"]}
|