@metamask/snaps-execution-environments 3.0.0 → 3.1.0
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 +8 -1
- package/dist/browserify/iframe/bundle.js +5 -5
- package/dist/browserify/node-process/bundle.js +4 -4
- package/dist/browserify/node-thread/bundle.js +4 -4
- package/dist/browserify/offscreen/bundle.js +4 -4
- package/dist/browserify/worker-executor/bundle.js +5 -5
- package/dist/browserify/worker-pool/bundle.js +4 -4
- package/dist/cjs/common/BaseSnapExecutor.js +37 -27
- package/dist/cjs/common/BaseSnapExecutor.js.map +1 -1
- package/dist/cjs/common/endowments/index.js +2 -1
- package/dist/cjs/common/endowments/index.js.map +1 -1
- package/dist/cjs/common/endowments/interval.js +2 -1
- package/dist/cjs/common/endowments/interval.js.map +1 -1
- package/dist/cjs/common/endowments/timeout.js +2 -1
- package/dist/cjs/common/endowments/timeout.js.map +1 -1
- package/dist/cjs/common/globalEvents.js +2 -1
- package/dist/cjs/common/globalEvents.js.map +1 -1
- package/dist/cjs/common/globalObject.js.map +1 -1
- package/dist/cjs/common/utils.js +7 -21
- package/dist/cjs/common/utils.js.map +1 -1
- package/dist/cjs/common/validation.js +3 -2
- package/dist/cjs/common/validation.js.map +1 -1
- package/dist/esm/common/BaseSnapExecutor.js +37 -27
- package/dist/esm/common/BaseSnapExecutor.js.map +1 -1
- package/dist/esm/common/endowments/index.js +2 -1
- package/dist/esm/common/endowments/index.js.map +1 -1
- package/dist/esm/common/endowments/interval.js +2 -1
- package/dist/esm/common/endowments/interval.js.map +1 -1
- package/dist/esm/common/endowments/timeout.js +2 -1
- package/dist/esm/common/endowments/timeout.js.map +1 -1
- package/dist/esm/common/globalEvents.js +2 -1
- package/dist/esm/common/globalEvents.js.map +1 -1
- package/dist/esm/common/globalObject.js.map +1 -1
- package/dist/esm/common/utils.js +7 -25
- package/dist/esm/common/utils.js.map +1 -1
- package/dist/esm/common/validation.js +3 -2
- package/dist/esm/common/validation.js.map +1 -1
- package/dist/types/common/endowments/index.d.ts +1 -1
- package/dist/types/common/utils.d.ts +0 -9
- package/package.json +18 -19
package/dist/esm/common/utils.js
CHANGED
|
@@ -1,24 +1,6 @@
|
|
|
1
|
+
import { rpcErrors } from '@metamask/rpc-errors';
|
|
1
2
|
import { assert, assertStruct, getSafeJson, JsonStruct } from '@metamask/utils';
|
|
2
|
-
import { ethErrors } from 'eth-rpc-errors';
|
|
3
3
|
import { log } from '../logging';
|
|
4
|
-
/**
|
|
5
|
-
* Takes an error that was thrown, determines if it is
|
|
6
|
-
* an error object. If it is then it will return that. Otherwise,
|
|
7
|
-
* an error object is created with the original error message.
|
|
8
|
-
*
|
|
9
|
-
* @param originalError - The error that was originally thrown.
|
|
10
|
-
* @returns An error object.
|
|
11
|
-
*/ export function constructError(originalError) {
|
|
12
|
-
let _originalError;
|
|
13
|
-
if (originalError instanceof Error) {
|
|
14
|
-
_originalError = originalError;
|
|
15
|
-
} else if (typeof originalError === 'string') {
|
|
16
|
-
_originalError = new Error(originalError);
|
|
17
|
-
// The stack is useless in this case.
|
|
18
|
-
delete _originalError.stack;
|
|
19
|
-
}
|
|
20
|
-
return _originalError;
|
|
21
|
-
}
|
|
22
4
|
/**
|
|
23
5
|
* Make proxy for Promise and handle the teardown process properly.
|
|
24
6
|
* If the teardown is called in the meanwhile, Promise result will not be
|
|
@@ -104,13 +86,13 @@ export const BLOCKED_RPC_METHODS = Object.freeze([
|
|
|
104
86
|
* @param args - The arguments to validate.
|
|
105
87
|
*/ export function assertSnapOutboundRequest(args) {
|
|
106
88
|
// Disallow any non `wallet_` or `snap_` methods for separation of concerns.
|
|
107
|
-
assert(String.prototype.startsWith.call(args.method, 'wallet_') || String.prototype.startsWith.call(args.method, 'snap_'), 'The global Snap API only allows RPC methods starting with `wallet_*` and `snap_*`.');
|
|
108
|
-
assert(!BLOCKED_RPC_METHODS.includes(args.method),
|
|
89
|
+
assert(String.prototype.startsWith.call(args.method, 'wallet_') || String.prototype.startsWith.call(args.method, 'snap_'), 'The global Snap API only allows RPC methods starting with `wallet_*` and `snap_*`.', rpcErrors.methodNotSupported);
|
|
90
|
+
assert(!BLOCKED_RPC_METHODS.includes(args.method), rpcErrors.methodNotFound({
|
|
109
91
|
data: {
|
|
110
92
|
method: args.method
|
|
111
93
|
}
|
|
112
94
|
}));
|
|
113
|
-
assertStruct(args, JsonStruct, 'Provided value is not JSON-RPC compatible');
|
|
95
|
+
assertStruct(args, JsonStruct, 'Provided value is not JSON-RPC compatible', rpcErrors.invalidParams);
|
|
114
96
|
}
|
|
115
97
|
/**
|
|
116
98
|
* Asserts the validity of request arguments for an ethereum outbound request using the `ethereum.request` API.
|
|
@@ -118,17 +100,17 @@ export const BLOCKED_RPC_METHODS = Object.freeze([
|
|
|
118
100
|
* @param args - The arguments to validate.
|
|
119
101
|
*/ export function assertEthereumOutboundRequest(args) {
|
|
120
102
|
// Disallow snaps methods for separation of concerns.
|
|
121
|
-
assert(!String.prototype.startsWith.call(args.method, 'snap_'),
|
|
103
|
+
assert(!String.prototype.startsWith.call(args.method, 'snap_'), rpcErrors.methodNotFound({
|
|
122
104
|
data: {
|
|
123
105
|
method: args.method
|
|
124
106
|
}
|
|
125
107
|
}));
|
|
126
|
-
assert(!BLOCKED_RPC_METHODS.includes(args.method),
|
|
108
|
+
assert(!BLOCKED_RPC_METHODS.includes(args.method), rpcErrors.methodNotFound({
|
|
127
109
|
data: {
|
|
128
110
|
method: args.method
|
|
129
111
|
}
|
|
130
112
|
}));
|
|
131
|
-
assertStruct(args, JsonStruct, 'Provided value is not JSON-RPC compatible');
|
|
113
|
+
assertStruct(args, JsonStruct, 'Provided value is not JSON-RPC compatible', rpcErrors.invalidParams);
|
|
132
114
|
}
|
|
133
115
|
/**
|
|
134
116
|
* Gets a sanitized value to be used for passing to the underlying MetaMask provider.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../src/common/utils.ts"],"sourcesContent":["import type { StreamProvider } from '@metamask/providers';\nimport type { RequestArguments } from '@metamask/providers/dist/BaseProvider';\nimport {
|
|
1
|
+
{"version":3,"sources":["../../../src/common/utils.ts"],"sourcesContent":["import type { StreamProvider } from '@metamask/providers';\nimport type { RequestArguments } from '@metamask/providers/dist/BaseProvider';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport { assert, assertStruct, getSafeJson, JsonStruct } from '@metamask/utils';\n\nimport { log } from '../logging';\n/**\n * Make proxy for Promise and handle the teardown process properly.\n * If the teardown is called in the meanwhile, Promise result will not be\n * exposed to the snap anymore and warning will be logged to the console.\n *\n * @param originalPromise - Original promise.\n * @param teardownRef - Reference containing teardown count.\n * @param teardownRef.lastTeardown - Number of the last teardown.\n * @returns New proxy promise.\n */\nexport async function withTeardown<Type>(\n originalPromise: Promise<Type>,\n teardownRef: { lastTeardown: number },\n): Promise<Type> {\n const myTeardown = teardownRef.lastTeardown;\n return new Promise<Type>((resolve, reject) => {\n originalPromise\n .then((value) => {\n if (teardownRef.lastTeardown === myTeardown) {\n resolve(value);\n } else {\n log(\n 'Late promise received after Snap finished execution. Promise will be dropped.',\n );\n }\n })\n .catch((reason) => {\n if (teardownRef.lastTeardown === myTeardown) {\n reject(reason);\n } else {\n log(\n 'Late promise received after Snap finished execution. Promise will be dropped.',\n );\n }\n });\n });\n}\n\n/**\n * Returns a Proxy that narrows down (attenuates) the fields available on\n * the StreamProvider and replaces the request implementation.\n *\n * @param provider - Instance of a StreamProvider to be limited.\n * @param request - Custom attenuated request object.\n * @returns Proxy to the StreamProvider instance.\n */\nexport function proxyStreamProvider(\n provider: StreamProvider,\n request: unknown,\n): StreamProvider {\n // Proxy target is intentionally set to be an empty object, to ensure\n // that access to the prototype chain is not possible.\n const proxy = new Proxy(\n {},\n {\n has(_target: object, prop: string | symbol) {\n return (\n typeof prop === 'string' &&\n ['request', 'on', 'removeListener'].includes(prop)\n );\n },\n get(_target, prop: keyof StreamProvider) {\n if (prop === 'request') {\n return request;\n } else if (['on', 'removeListener'].includes(prop)) {\n return provider[prop];\n }\n\n return undefined;\n },\n },\n );\n\n return proxy as StreamProvider;\n}\n\n// We're blocking these RPC methods for v1, will revisit later.\nexport const BLOCKED_RPC_METHODS = Object.freeze([\n 'wallet_requestSnaps',\n 'wallet_requestPermissions',\n // We disallow all of these confirmations for now, since the screens are not ready for Snaps.\n 'eth_sendRawTransaction',\n 'eth_sendTransaction',\n 'eth_sign',\n 'eth_signTypedData',\n 'eth_signTypedData_v1',\n 'eth_signTypedData_v3',\n 'eth_signTypedData_v4',\n 'eth_decrypt',\n 'eth_getEncryptionPublicKey',\n 'wallet_addEthereumChain',\n 'wallet_switchEthereumChain',\n 'wallet_watchAsset',\n 'wallet_registerOnboarding',\n 'wallet_scanQRCode',\n]);\n\n/**\n * Asserts the validity of request arguments for a snap outbound request using the `snap.request` API.\n *\n * @param args - The arguments to validate.\n */\nexport function assertSnapOutboundRequest(args: RequestArguments) {\n // Disallow any non `wallet_` or `snap_` methods for separation of concerns.\n assert(\n String.prototype.startsWith.call(args.method, 'wallet_') ||\n String.prototype.startsWith.call(args.method, 'snap_'),\n 'The global Snap API only allows RPC methods starting with `wallet_*` and `snap_*`.',\n rpcErrors.methodNotSupported,\n );\n assert(\n !BLOCKED_RPC_METHODS.includes(args.method),\n rpcErrors.methodNotFound({\n data: {\n method: args.method,\n },\n }),\n );\n assertStruct(\n args,\n JsonStruct,\n 'Provided value is not JSON-RPC compatible',\n rpcErrors.invalidParams,\n );\n}\n\n/**\n * Asserts the validity of request arguments for an ethereum outbound request using the `ethereum.request` API.\n *\n * @param args - The arguments to validate.\n */\nexport function assertEthereumOutboundRequest(args: RequestArguments) {\n // Disallow snaps methods for separation of concerns.\n assert(\n !String.prototype.startsWith.call(args.method, 'snap_'),\n rpcErrors.methodNotFound({\n data: {\n method: args.method,\n },\n }),\n );\n assert(\n !BLOCKED_RPC_METHODS.includes(args.method),\n rpcErrors.methodNotFound({\n data: {\n method: args.method,\n },\n }),\n );\n assertStruct(\n args,\n JsonStruct,\n 'Provided value is not JSON-RPC compatible',\n rpcErrors.invalidParams,\n );\n}\n\n/**\n * Gets a sanitized value to be used for passing to the underlying MetaMask provider.\n *\n * @param value - An unsanitized value from a snap.\n * @returns A sanitized value ready to be passed to a MetaMask provider.\n */\nexport function sanitizeRequestArguments(value: unknown): RequestArguments {\n // Before passing to getSafeJson we run the value through JSON serialization.\n // This lets request arguments contain undefined which is normally disallowed.\n const json = JSON.parse(JSON.stringify(value));\n return getSafeJson(json) as RequestArguments;\n}\n"],"names":["rpcErrors","assert","assertStruct","getSafeJson","JsonStruct","log","withTeardown","originalPromise","teardownRef","myTeardown","lastTeardown","Promise","resolve","reject","then","value","catch","reason","proxyStreamProvider","provider","request","proxy","Proxy","has","_target","prop","includes","get","undefined","BLOCKED_RPC_METHODS","Object","freeze","assertSnapOutboundRequest","args","String","prototype","startsWith","call","method","methodNotSupported","methodNotFound","data","invalidParams","assertEthereumOutboundRequest","sanitizeRequestArguments","json","JSON","parse","stringify"],"mappings":"AAEA,SAASA,SAAS,QAAQ,uBAAuB;AACjD,SAASC,MAAM,EAAEC,YAAY,EAAEC,WAAW,EAAEC,UAAU,QAAQ,kBAAkB;AAEhF,SAASC,GAAG,QAAQ,aAAa;AACjC;;;;;;;;;CASC,GACD,OAAO,eAAeC,aACpBC,eAA8B,EAC9BC,WAAqC;IAErC,MAAMC,aAAaD,YAAYE,YAAY;IAC3C,OAAO,IAAIC,QAAc,CAACC,SAASC;QACjCN,gBACGO,IAAI,CAAC,CAACC;YACL,IAAIP,YAAYE,YAAY,KAAKD,YAAY;gBAC3CG,QAAQG;YACV,OAAO;gBACLV,IACE;YAEJ;QACF,GACCW,KAAK,CAAC,CAACC;YACN,IAAIT,YAAYE,YAAY,KAAKD,YAAY;gBAC3CI,OAAOI;YACT,OAAO;gBACLZ,IACE;YAEJ;QACF;IACJ;AACF;AAEA;;;;;;;CAOC,GACD,OAAO,SAASa,oBACdC,QAAwB,EACxBC,OAAgB;IAEhB,qEAAqE;IACrE,sDAAsD;IACtD,MAAMC,QAAQ,IAAIC,MAChB,CAAC,GACD;QACEC,KAAIC,OAAe,EAAEC,IAAqB;YACxC,OACE,OAAOA,SAAS,YAChB;gBAAC;gBAAW;gBAAM;aAAiB,CAACC,QAAQ,CAACD;QAEjD;QACAE,KAAIH,OAAO,EAAEC,IAA0B;YACrC,IAAIA,SAAS,WAAW;gBACtB,OAAOL;YACT,OAAO,IAAI;gBAAC;gBAAM;aAAiB,CAACM,QAAQ,CAACD,OAAO;gBAClD,OAAON,QAAQ,CAACM,KAAK;YACvB;YAEA,OAAOG;QACT;IACF;IAGF,OAAOP;AACT;AAEA,+DAA+D;AAC/D,OAAO,MAAMQ,sBAAsBC,OAAOC,MAAM,CAAC;IAC/C;IACA;IACA,6FAA6F;IAC7F;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;CACD,EAAE;AAEH;;;;CAIC,GACD,OAAO,SAASC,0BAA0BC,IAAsB;IAC9D,4EAA4E;IAC5EhC,OACEiC,OAAOC,SAAS,CAACC,UAAU,CAACC,IAAI,CAACJ,KAAKK,MAAM,EAAE,cAC5CJ,OAAOC,SAAS,CAACC,UAAU,CAACC,IAAI,CAACJ,KAAKK,MAAM,EAAE,UAChD,sFACAtC,UAAUuC,kBAAkB;IAE9BtC,OACE,CAAC4B,oBAAoBH,QAAQ,CAACO,KAAKK,MAAM,GACzCtC,UAAUwC,cAAc,CAAC;QACvBC,MAAM;YACJH,QAAQL,KAAKK,MAAM;QACrB;IACF;IAEFpC,aACE+B,MACA7B,YACA,6CACAJ,UAAU0C,aAAa;AAE3B;AAEA;;;;CAIC,GACD,OAAO,SAASC,8BAA8BV,IAAsB;IAClE,qDAAqD;IACrDhC,OACE,CAACiC,OAAOC,SAAS,CAACC,UAAU,CAACC,IAAI,CAACJ,KAAKK,MAAM,EAAE,UAC/CtC,UAAUwC,cAAc,CAAC;QACvBC,MAAM;YACJH,QAAQL,KAAKK,MAAM;QACrB;IACF;IAEFrC,OACE,CAAC4B,oBAAoBH,QAAQ,CAACO,KAAKK,MAAM,GACzCtC,UAAUwC,cAAc,CAAC;QACvBC,MAAM;YACJH,QAAQL,KAAKK,MAAM;QACrB;IACF;IAEFpC,aACE+B,MACA7B,YACA,6CACAJ,UAAU0C,aAAa;AAE3B;AAEA;;;;;CAKC,GACD,OAAO,SAASE,yBAAyB7B,KAAc;IACrD,6EAA6E;IAC7E,8EAA8E;IAC9E,MAAM8B,OAAOC,KAAKC,KAAK,CAACD,KAAKE,SAAS,CAACjC;IACvC,OAAOZ,YAAY0C;AACrB"}
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { rpcErrors } from '@metamask/rpc-errors';
|
|
1
2
|
import { ChainIdStruct, HandlerType } from '@metamask/snaps-utils';
|
|
2
3
|
import { assertStruct, JsonRpcIdStruct, JsonRpcRequestStruct, JsonRpcSuccessStruct, JsonStruct } from '@metamask/utils';
|
|
3
4
|
import { array, assign, enums, is, literal, nullable, object, omit, optional, record, string, tuple, union } from 'superstruct';
|
|
@@ -59,7 +60,7 @@ export const OnTransactionRequestArgumentsStruct = object({
|
|
|
59
60
|
* @throws If the value is not a valid {@link OnTransactionRequestArguments}
|
|
60
61
|
* object.
|
|
61
62
|
*/ export function assertIsOnTransactionRequestArguments(value) {
|
|
62
|
-
assertStruct(value, OnTransactionRequestArgumentsStruct, 'Invalid request params');
|
|
63
|
+
assertStruct(value, OnTransactionRequestArgumentsStruct, 'Invalid request params', rpcErrors.invalidParams);
|
|
63
64
|
}
|
|
64
65
|
const baseNameLookupArgs = {
|
|
65
66
|
chainId: ChainIdStruct
|
|
@@ -84,7 +85,7 @@ export const OnNameLookupRequestArgumentsStruct = union([
|
|
|
84
85
|
* @throws If the value is not a valid {@link OnNameLookupRequestArguments}
|
|
85
86
|
* object.
|
|
86
87
|
*/ export function assertIsOnNameLookupRequestArguments(value) {
|
|
87
|
-
assertStruct(value, OnNameLookupRequestArgumentsStruct, 'Invalid request params');
|
|
88
|
+
assertStruct(value, OnNameLookupRequestArgumentsStruct, 'Invalid request params', rpcErrors.invalidParams);
|
|
88
89
|
}
|
|
89
90
|
const OkResponseStruct = assign(JsonRpcSuccessStruct, object({
|
|
90
91
|
result: OkStruct
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../src/common/validation.ts"],"sourcesContent":["import { ChainIdStruct, HandlerType } from '@metamask/snaps-utils';\nimport type { Json, JsonRpcSuccess } from '@metamask/utils';\nimport {\n assertStruct,\n JsonRpcIdStruct,\n JsonRpcRequestStruct,\n JsonRpcSuccessStruct,\n JsonStruct,\n} from '@metamask/utils';\nimport type { Infer } from 'superstruct';\nimport {\n array,\n assign,\n enums,\n is,\n literal,\n nullable,\n object,\n omit,\n optional,\n record,\n string,\n tuple,\n union,\n} from 'superstruct';\n\nexport const JsonRpcRequestWithoutIdStruct = assign(\n omit(JsonRpcRequestStruct, ['id']),\n object({\n id: optional(JsonRpcIdStruct),\n }),\n);\n\nexport type JsonRpcRequestWithoutId = Infer<\n typeof JsonRpcRequestWithoutIdStruct\n>;\n\nexport const EndowmentStruct = string();\nexport type Endowment = Infer<typeof EndowmentStruct>;\n\n/**\n * Check if the given value is an endowment.\n *\n * @param value - The value to check.\n * @returns Whether the value is an endowment.\n */\nexport function isEndowment(value: unknown): value is Endowment {\n return is(value, EndowmentStruct);\n}\n\n/**\n * Check if the given value is an array of endowments.\n *\n * @param value - The value to check.\n * @returns Whether the value is an array of endowments.\n */\nexport function isEndowmentsArray(value: unknown): value is Endowment[] {\n return Array.isArray(value) && value.every(isEndowment);\n}\n\nconst OkStruct = literal('OK');\n\nexport const PingRequestArgumentsStruct = optional(\n union([literal(undefined), array()]),\n);\n\nexport const TerminateRequestArgumentsStruct = union([\n literal(undefined),\n array(),\n]);\n\nexport const ExecuteSnapRequestArgumentsStruct = tuple([\n string(),\n string(),\n optional(array(EndowmentStruct)),\n]);\n\nexport const SnapRpcRequestArgumentsStruct = tuple([\n string(),\n enums(Object.values(HandlerType)),\n string(),\n assign(\n JsonRpcRequestWithoutIdStruct,\n object({\n params: optional(record(string(), JsonStruct)),\n }),\n ),\n]);\n\nexport type PingRequestArguments = Infer<typeof PingRequestArgumentsStruct>;\nexport type TerminateRequestArguments = Infer<\n typeof TerminateRequestArgumentsStruct\n>;\n\nexport type ExecuteSnapRequestArguments = Infer<\n typeof ExecuteSnapRequestArgumentsStruct\n>;\n\nexport type SnapRpcRequestArguments = Infer<\n typeof SnapRpcRequestArgumentsStruct\n>;\n\nexport type RequestArguments =\n | PingRequestArguments\n | TerminateRequestArguments\n | ExecuteSnapRequestArguments\n | SnapRpcRequestArguments;\n\nexport const OnTransactionRequestArgumentsStruct = object({\n // TODO: Improve `transaction` type.\n transaction: record(string(), JsonStruct),\n chainId: ChainIdStruct,\n transactionOrigin: nullable(string()),\n});\n\nexport type OnTransactionRequestArguments = Infer<\n typeof OnTransactionRequestArgumentsStruct\n>;\n\n/**\n * Asserts that the given value is a valid {@link OnTransactionRequestArguments}\n * object.\n *\n * @param value - The value to validate.\n * @throws If the value is not a valid {@link OnTransactionRequestArguments}\n * object.\n */\nexport function assertIsOnTransactionRequestArguments(\n value: unknown,\n): asserts value is OnTransactionRequestArguments {\n assertStruct(\n value,\n OnTransactionRequestArgumentsStruct,\n 'Invalid request params',\n );\n}\n\nconst baseNameLookupArgs = { chainId: ChainIdStruct };\nconst domainRequestStruct = object({\n ...baseNameLookupArgs,\n address: string(),\n});\nconst addressRequestStruct = object({\n ...baseNameLookupArgs,\n domain: string(),\n});\n\nexport const OnNameLookupRequestArgumentsStruct = union([\n domainRequestStruct,\n addressRequestStruct,\n]);\n\nexport type OnNameLookupRequestArguments = Infer<\n typeof OnNameLookupRequestArgumentsStruct\n>;\n\nexport type PossibleLookupRequestArgs = typeof baseNameLookupArgs & {\n address?: string;\n domain?: string;\n};\n\n/**\n * Asserts that the given value is a valid {@link OnNameLookupRequestArguments}\n * object.\n *\n * @param value - The value to validate.\n * @throws If the value is not a valid {@link OnNameLookupRequestArguments}\n * object.\n */\nexport function assertIsOnNameLookupRequestArguments(\n value: unknown,\n): asserts value is OnNameLookupRequestArguments {\n assertStruct(\n value,\n OnNameLookupRequestArgumentsStruct,\n 'Invalid request params',\n );\n}\n\nconst OkResponseStruct = assign(\n JsonRpcSuccessStruct,\n object({\n result: OkStruct,\n }),\n);\n\nconst SnapRpcResponse = JsonRpcSuccessStruct;\n\nexport type OkResponse = Infer<typeof OkResponseStruct>;\nexport type SnapRpcResponse = Infer<typeof SnapRpcResponse>;\n\nexport type Response = OkResponse | SnapRpcResponse;\n\ntype RequestParams<Params extends unknown[] | undefined> =\n Params extends undefined ? [] : Params;\n\ntype RequestFunction<\n Args extends RequestArguments,\n ResponseType extends JsonRpcSuccess<Json>,\n> = (...args: RequestParams<Args>) => Promise<ResponseType['result']>;\n\nexport type Ping = RequestFunction<PingRequestArguments, OkResponse>;\nexport type Terminate = RequestFunction<TerminateRequestArguments, OkResponse>;\nexport type ExecuteSnap = RequestFunction<\n ExecuteSnapRequestArguments,\n OkResponse\n>;\nexport type SnapRpc = RequestFunction<SnapRpcRequestArguments, SnapRpcResponse>;\n"],"names":["ChainIdStruct","HandlerType","assertStruct","JsonRpcIdStruct","JsonRpcRequestStruct","JsonRpcSuccessStruct","JsonStruct","array","assign","enums","is","literal","nullable","object","omit","optional","record","string","tuple","union","JsonRpcRequestWithoutIdStruct","id","EndowmentStruct","isEndowment","value","isEndowmentsArray","Array","isArray","every","OkStruct","PingRequestArgumentsStruct","undefined","TerminateRequestArgumentsStruct","ExecuteSnapRequestArgumentsStruct","SnapRpcRequestArgumentsStruct","Object","values","params","OnTransactionRequestArgumentsStruct","transaction","chainId","transactionOrigin","assertIsOnTransactionRequestArguments","baseNameLookupArgs","domainRequestStruct","address","addressRequestStruct","domain","OnNameLookupRequestArgumentsStruct","assertIsOnNameLookupRequestArguments","OkResponseStruct","result","SnapRpcResponse"],"mappings":"AAAA,SAASA,aAAa,EAAEC,WAAW,QAAQ,wBAAwB;AAEnE,SACEC,YAAY,EACZC,eAAe,EACfC,oBAAoB,EACpBC,oBAAoB,EACpBC,UAAU,QACL,kBAAkB;AAEzB,SACEC,KAAK,EACLC,MAAM,EACNC,KAAK,EACLC,EAAE,EACFC,OAAO,EACPC,QAAQ,EACRC,MAAM,EACNC,IAAI,EACJC,QAAQ,EACRC,MAAM,EACNC,MAAM,EACNC,KAAK,EACLC,KAAK,QACA,cAAc;AAErB,OAAO,MAAMC,gCAAgCZ,OAC3CM,KAAKV,sBAAsB;IAAC;CAAK,GACjCS,OAAO;IACLQ,IAAIN,SAASZ;AACf,IACA;AAMF,OAAO,MAAMmB,kBAAkBL,SAAS;AAGxC;;;;;CAKC,GACD,OAAO,SAASM,YAAYC,KAAc;IACxC,OAAOd,GAAGc,OAAOF;AACnB;AAEA;;;;;CAKC,GACD,OAAO,SAASG,kBAAkBD,KAAc;IAC9C,OAAOE,MAAMC,OAAO,CAACH,UAAUA,MAAMI,KAAK,CAACL;AAC7C;AAEA,MAAMM,WAAWlB,QAAQ;AAEzB,OAAO,MAAMmB,6BAA6Bf,SACxCI,MAAM;IAACR,QAAQoB;IAAYxB;CAAQ,GACnC;AAEF,OAAO,MAAMyB,kCAAkCb,MAAM;IACnDR,QAAQoB;IACRxB;CACD,EAAE;AAEH,OAAO,MAAM0B,oCAAoCf,MAAM;IACrDD;IACAA;IACAF,SAASR,MAAMe;CAChB,EAAE;AAEH,OAAO,MAAMY,gCAAgChB,MAAM;IACjDD;IACAR,MAAM0B,OAAOC,MAAM,CAACnC;IACpBgB;IACAT,OACEY,+BACAP,OAAO;QACLwB,QAAQtB,SAASC,OAAOC,UAAUX;IACpC;CAEH,EAAE;AAqBH,OAAO,MAAMgC,sCAAsCzB,OAAO;IACxD,oCAAoC;IACpC0B,aAAavB,OAAOC,UAAUX;IAC9BkC,SAASxC;IACTyC,mBAAmB7B,SAASK;AAC9B,GAAG;AAMH;;;;;;;CAOC,GACD,OAAO,SAASyB,sCACdlB,KAAc;IAEdtB,aACEsB,OACAc,qCACA;
|
|
1
|
+
{"version":3,"sources":["../../../src/common/validation.ts"],"sourcesContent":["import { rpcErrors } from '@metamask/rpc-errors';\nimport { ChainIdStruct, HandlerType } from '@metamask/snaps-utils';\nimport type { Json, JsonRpcSuccess } from '@metamask/utils';\nimport {\n assertStruct,\n JsonRpcIdStruct,\n JsonRpcRequestStruct,\n JsonRpcSuccessStruct,\n JsonStruct,\n} from '@metamask/utils';\nimport type { Infer } from 'superstruct';\nimport {\n array,\n assign,\n enums,\n is,\n literal,\n nullable,\n object,\n omit,\n optional,\n record,\n string,\n tuple,\n union,\n} from 'superstruct';\n\nexport const JsonRpcRequestWithoutIdStruct = assign(\n omit(JsonRpcRequestStruct, ['id']),\n object({\n id: optional(JsonRpcIdStruct),\n }),\n);\n\nexport type JsonRpcRequestWithoutId = Infer<\n typeof JsonRpcRequestWithoutIdStruct\n>;\n\nexport const EndowmentStruct = string();\nexport type Endowment = Infer<typeof EndowmentStruct>;\n\n/**\n * Check if the given value is an endowment.\n *\n * @param value - The value to check.\n * @returns Whether the value is an endowment.\n */\nexport function isEndowment(value: unknown): value is Endowment {\n return is(value, EndowmentStruct);\n}\n\n/**\n * Check if the given value is an array of endowments.\n *\n * @param value - The value to check.\n * @returns Whether the value is an array of endowments.\n */\nexport function isEndowmentsArray(value: unknown): value is Endowment[] {\n return Array.isArray(value) && value.every(isEndowment);\n}\n\nconst OkStruct = literal('OK');\n\nexport const PingRequestArgumentsStruct = optional(\n union([literal(undefined), array()]),\n);\n\nexport const TerminateRequestArgumentsStruct = union([\n literal(undefined),\n array(),\n]);\n\nexport const ExecuteSnapRequestArgumentsStruct = tuple([\n string(),\n string(),\n optional(array(EndowmentStruct)),\n]);\n\nexport const SnapRpcRequestArgumentsStruct = tuple([\n string(),\n enums(Object.values(HandlerType)),\n string(),\n assign(\n JsonRpcRequestWithoutIdStruct,\n object({\n params: optional(record(string(), JsonStruct)),\n }),\n ),\n]);\n\nexport type PingRequestArguments = Infer<typeof PingRequestArgumentsStruct>;\nexport type TerminateRequestArguments = Infer<\n typeof TerminateRequestArgumentsStruct\n>;\n\nexport type ExecuteSnapRequestArguments = Infer<\n typeof ExecuteSnapRequestArgumentsStruct\n>;\n\nexport type SnapRpcRequestArguments = Infer<\n typeof SnapRpcRequestArgumentsStruct\n>;\n\nexport type RequestArguments =\n | PingRequestArguments\n | TerminateRequestArguments\n | ExecuteSnapRequestArguments\n | SnapRpcRequestArguments;\n\nexport const OnTransactionRequestArgumentsStruct = object({\n // TODO: Improve `transaction` type.\n transaction: record(string(), JsonStruct),\n chainId: ChainIdStruct,\n transactionOrigin: nullable(string()),\n});\n\nexport type OnTransactionRequestArguments = Infer<\n typeof OnTransactionRequestArgumentsStruct\n>;\n\n/**\n * Asserts that the given value is a valid {@link OnTransactionRequestArguments}\n * object.\n *\n * @param value - The value to validate.\n * @throws If the value is not a valid {@link OnTransactionRequestArguments}\n * object.\n */\nexport function assertIsOnTransactionRequestArguments(\n value: unknown,\n): asserts value is OnTransactionRequestArguments {\n assertStruct(\n value,\n OnTransactionRequestArgumentsStruct,\n 'Invalid request params',\n rpcErrors.invalidParams,\n );\n}\n\nconst baseNameLookupArgs = { chainId: ChainIdStruct };\nconst domainRequestStruct = object({\n ...baseNameLookupArgs,\n address: string(),\n});\nconst addressRequestStruct = object({\n ...baseNameLookupArgs,\n domain: string(),\n});\n\nexport const OnNameLookupRequestArgumentsStruct = union([\n domainRequestStruct,\n addressRequestStruct,\n]);\n\nexport type OnNameLookupRequestArguments = Infer<\n typeof OnNameLookupRequestArgumentsStruct\n>;\n\nexport type PossibleLookupRequestArgs = typeof baseNameLookupArgs & {\n address?: string;\n domain?: string;\n};\n\n/**\n * Asserts that the given value is a valid {@link OnNameLookupRequestArguments}\n * object.\n *\n * @param value - The value to validate.\n * @throws If the value is not a valid {@link OnNameLookupRequestArguments}\n * object.\n */\nexport function assertIsOnNameLookupRequestArguments(\n value: unknown,\n): asserts value is OnNameLookupRequestArguments {\n assertStruct(\n value,\n OnNameLookupRequestArgumentsStruct,\n 'Invalid request params',\n rpcErrors.invalidParams,\n );\n}\n\nconst OkResponseStruct = assign(\n JsonRpcSuccessStruct,\n object({\n result: OkStruct,\n }),\n);\n\nconst SnapRpcResponse = JsonRpcSuccessStruct;\n\nexport type OkResponse = Infer<typeof OkResponseStruct>;\nexport type SnapRpcResponse = Infer<typeof SnapRpcResponse>;\n\nexport type Response = OkResponse | SnapRpcResponse;\n\ntype RequestParams<Params extends unknown[] | undefined> =\n Params extends undefined ? [] : Params;\n\ntype RequestFunction<\n Args extends RequestArguments,\n ResponseType extends JsonRpcSuccess<Json>,\n> = (...args: RequestParams<Args>) => Promise<ResponseType['result']>;\n\nexport type Ping = RequestFunction<PingRequestArguments, OkResponse>;\nexport type Terminate = RequestFunction<TerminateRequestArguments, OkResponse>;\nexport type ExecuteSnap = RequestFunction<\n ExecuteSnapRequestArguments,\n OkResponse\n>;\nexport type SnapRpc = RequestFunction<SnapRpcRequestArguments, SnapRpcResponse>;\n"],"names":["rpcErrors","ChainIdStruct","HandlerType","assertStruct","JsonRpcIdStruct","JsonRpcRequestStruct","JsonRpcSuccessStruct","JsonStruct","array","assign","enums","is","literal","nullable","object","omit","optional","record","string","tuple","union","JsonRpcRequestWithoutIdStruct","id","EndowmentStruct","isEndowment","value","isEndowmentsArray","Array","isArray","every","OkStruct","PingRequestArgumentsStruct","undefined","TerminateRequestArgumentsStruct","ExecuteSnapRequestArgumentsStruct","SnapRpcRequestArgumentsStruct","Object","values","params","OnTransactionRequestArgumentsStruct","transaction","chainId","transactionOrigin","assertIsOnTransactionRequestArguments","invalidParams","baseNameLookupArgs","domainRequestStruct","address","addressRequestStruct","domain","OnNameLookupRequestArgumentsStruct","assertIsOnNameLookupRequestArguments","OkResponseStruct","result","SnapRpcResponse"],"mappings":"AAAA,SAASA,SAAS,QAAQ,uBAAuB;AACjD,SAASC,aAAa,EAAEC,WAAW,QAAQ,wBAAwB;AAEnE,SACEC,YAAY,EACZC,eAAe,EACfC,oBAAoB,EACpBC,oBAAoB,EACpBC,UAAU,QACL,kBAAkB;AAEzB,SACEC,KAAK,EACLC,MAAM,EACNC,KAAK,EACLC,EAAE,EACFC,OAAO,EACPC,QAAQ,EACRC,MAAM,EACNC,IAAI,EACJC,QAAQ,EACRC,MAAM,EACNC,MAAM,EACNC,KAAK,EACLC,KAAK,QACA,cAAc;AAErB,OAAO,MAAMC,gCAAgCZ,OAC3CM,KAAKV,sBAAsB;IAAC;CAAK,GACjCS,OAAO;IACLQ,IAAIN,SAASZ;AACf,IACA;AAMF,OAAO,MAAMmB,kBAAkBL,SAAS;AAGxC;;;;;CAKC,GACD,OAAO,SAASM,YAAYC,KAAc;IACxC,OAAOd,GAAGc,OAAOF;AACnB;AAEA;;;;;CAKC,GACD,OAAO,SAASG,kBAAkBD,KAAc;IAC9C,OAAOE,MAAMC,OAAO,CAACH,UAAUA,MAAMI,KAAK,CAACL;AAC7C;AAEA,MAAMM,WAAWlB,QAAQ;AAEzB,OAAO,MAAMmB,6BAA6Bf,SACxCI,MAAM;IAACR,QAAQoB;IAAYxB;CAAQ,GACnC;AAEF,OAAO,MAAMyB,kCAAkCb,MAAM;IACnDR,QAAQoB;IACRxB;CACD,EAAE;AAEH,OAAO,MAAM0B,oCAAoCf,MAAM;IACrDD;IACAA;IACAF,SAASR,MAAMe;CAChB,EAAE;AAEH,OAAO,MAAMY,gCAAgChB,MAAM;IACjDD;IACAR,MAAM0B,OAAOC,MAAM,CAACnC;IACpBgB;IACAT,OACEY,+BACAP,OAAO;QACLwB,QAAQtB,SAASC,OAAOC,UAAUX;IACpC;CAEH,EAAE;AAqBH,OAAO,MAAMgC,sCAAsCzB,OAAO;IACxD,oCAAoC;IACpC0B,aAAavB,OAAOC,UAAUX;IAC9BkC,SAASxC;IACTyC,mBAAmB7B,SAASK;AAC9B,GAAG;AAMH;;;;;;;CAOC,GACD,OAAO,SAASyB,sCACdlB,KAAc;IAEdtB,aACEsB,OACAc,qCACA,0BACAvC,UAAU4C,aAAa;AAE3B;AAEA,MAAMC,qBAAqB;IAAEJ,SAASxC;AAAc;AACpD,MAAM6C,sBAAsBhC,OAAO;IACjC,GAAG+B,kBAAkB;IACrBE,SAAS7B;AACX;AACA,MAAM8B,uBAAuBlC,OAAO;IAClC,GAAG+B,kBAAkB;IACrBI,QAAQ/B;AACV;AAEA,OAAO,MAAMgC,qCAAqC9B,MAAM;IACtD0B;IACAE;CACD,EAAE;AAWH;;;;;;;CAOC,GACD,OAAO,SAASG,qCACd1B,KAAc;IAEdtB,aACEsB,OACAyB,oCACA,0BACAlD,UAAU4C,aAAa;AAE3B;AAEA,MAAMQ,mBAAmB3C,OACvBH,sBACAQ,OAAO;IACLuC,QAAQvB;AACV;AAGF,MAAMwB,kBAAkBhD"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { StreamProvider } from '@metamask/providers';
|
|
2
|
-
import type { SnapsGlobalObject } from '@metamask/rpc-methods';
|
|
2
|
+
import type { SnapsGlobalObject } from '@metamask/snaps-rpc-methods';
|
|
3
3
|
import type { SnapId } from '@metamask/snaps-utils';
|
|
4
4
|
/**
|
|
5
5
|
* Gets the endowments for a particular Snap. Some endowments, like `setTimeout`
|
|
@@ -1,14 +1,5 @@
|
|
|
1
1
|
import type { StreamProvider } from '@metamask/providers';
|
|
2
2
|
import type { RequestArguments } from '@metamask/providers/dist/BaseProvider';
|
|
3
|
-
/**
|
|
4
|
-
* Takes an error that was thrown, determines if it is
|
|
5
|
-
* an error object. If it is then it will return that. Otherwise,
|
|
6
|
-
* an error object is created with the original error message.
|
|
7
|
-
*
|
|
8
|
-
* @param originalError - The error that was originally thrown.
|
|
9
|
-
* @returns An error object.
|
|
10
|
-
*/
|
|
11
|
-
export declare function constructError(originalError: unknown): Error | undefined;
|
|
12
3
|
/**
|
|
13
4
|
* Make proxy for Promise and handle the teardown process properly.
|
|
14
5
|
* If the teardown is called in the meanwhile, Promise result will not be
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@metamask/snaps-execution-environments",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.1.0",
|
|
4
4
|
"description": "Snap sandbox environments for executing SES javascript",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -38,28 +38,27 @@
|
|
|
38
38
|
"build:lavamoat": "lavamoat scripts/build.js --policy lavamoat/build-system/policy.json --policyOverride lavamoat/build-system/policy-override.json",
|
|
39
39
|
"build:lavamoat:policy": "yarn build:lavamoat --writeAutoPolicy && node scripts/build.js --writeAutoPolicy",
|
|
40
40
|
"auto-changelog-init": "auto-changelog init",
|
|
41
|
-
"prepare-manifest:preview": "../../scripts/prepare-preview-manifest.sh",
|
|
42
41
|
"publish:preview": "yarn npm publish --tag preview",
|
|
43
42
|
"lint:ci": "yarn lint",
|
|
44
43
|
"start": "node scripts/start.js",
|
|
45
44
|
"lint:dependencies": "depcheck"
|
|
46
45
|
},
|
|
47
46
|
"dependencies": {
|
|
47
|
+
"@metamask/json-rpc-engine": "^7.1.1",
|
|
48
48
|
"@metamask/object-multiplex": "^1.2.0",
|
|
49
49
|
"@metamask/post-message-stream": "^7.0.0",
|
|
50
|
-
"@metamask/providers": "^
|
|
51
|
-
"@metamask/rpc-
|
|
52
|
-
"@metamask/snaps-
|
|
50
|
+
"@metamask/providers": "^13.0.0",
|
|
51
|
+
"@metamask/rpc-errors": "^6.1.0",
|
|
52
|
+
"@metamask/snaps-rpc-methods": "^3.1.0",
|
|
53
|
+
"@metamask/snaps-utils": "^3.1.0",
|
|
53
54
|
"@metamask/utils": "^8.1.0",
|
|
54
|
-
"eth-rpc-errors": "^4.0.3",
|
|
55
|
-
"json-rpc-engine": "^6.1.0",
|
|
56
55
|
"nanoid": "^3.1.31",
|
|
57
56
|
"superstruct": "^1.0.3"
|
|
58
57
|
},
|
|
59
58
|
"devDependencies": {
|
|
60
|
-
"@babel/core": "^7.
|
|
61
|
-
"@babel/preset-env": "^7.
|
|
62
|
-
"@babel/preset-typescript": "^7.
|
|
59
|
+
"@babel/core": "^7.23.2",
|
|
60
|
+
"@babel/preset-env": "^7.23.2",
|
|
61
|
+
"@babel/preset-typescript": "^7.23.2",
|
|
63
62
|
"@esbuild-plugins/node-globals-polyfill": "^0.2.3",
|
|
64
63
|
"@esbuild-plugins/node-modules-polyfill": "^0.2.2",
|
|
65
64
|
"@lavamoat/allow-scripts": "^2.5.1",
|
|
@@ -78,17 +77,17 @@
|
|
|
78
77
|
"@types/node": "18.14.2",
|
|
79
78
|
"@typescript-eslint/eslint-plugin": "^5.42.1",
|
|
80
79
|
"@typescript-eslint/parser": "^5.42.1",
|
|
81
|
-
"@wdio/browser-runner": "^8.
|
|
82
|
-
"@wdio/cli": "^8.
|
|
83
|
-
"@wdio/globals": "^8.
|
|
84
|
-
"@wdio/mocha-framework": "^8.
|
|
85
|
-
"@wdio/spec-reporter": "^8.
|
|
86
|
-
"@wdio/static-server-service": "^8.
|
|
80
|
+
"@wdio/browser-runner": "^8.19.0",
|
|
81
|
+
"@wdio/cli": "^8.19.0",
|
|
82
|
+
"@wdio/globals": "^8.19.0",
|
|
83
|
+
"@wdio/mocha-framework": "^8.19.0",
|
|
84
|
+
"@wdio/spec-reporter": "^8.19.0",
|
|
85
|
+
"@wdio/static-server-service": "^8.19.0",
|
|
87
86
|
"babel-plugin-tsconfig-paths-module-resolver": "^1.0.4",
|
|
88
87
|
"babelify": "^10.0.0",
|
|
89
88
|
"browserify": "^17.0.0",
|
|
90
89
|
"deepmerge": "^4.2.2",
|
|
91
|
-
"depcheck": "^1.4.
|
|
90
|
+
"depcheck": "^1.4.7",
|
|
92
91
|
"esbuild": "^0.18.10",
|
|
93
92
|
"eslint": "^8.27.0",
|
|
94
93
|
"eslint-config-prettier": "^8.5.0",
|
|
@@ -98,7 +97,7 @@
|
|
|
98
97
|
"eslint-plugin-n": "^15.7.0",
|
|
99
98
|
"eslint-plugin-prettier": "^4.2.1",
|
|
100
99
|
"eslint-plugin-promise": "^6.1.1",
|
|
101
|
-
"expect-webdriverio": "^4.1
|
|
100
|
+
"expect-webdriverio": "^4.4.1",
|
|
102
101
|
"istanbul-lib-coverage": "^3.2.0",
|
|
103
102
|
"istanbul-lib-report": "^3.0.0",
|
|
104
103
|
"istanbul-reports": "^3.1.5",
|
|
@@ -119,7 +118,7 @@
|
|
|
119
118
|
"vite-tsconfig-paths": "^4.0.5",
|
|
120
119
|
"wdio-chromedriver-service": "^8.1.1",
|
|
121
120
|
"wdio-geckodriver-service": "^5.0.2",
|
|
122
|
-
"webdriverio": "^8.
|
|
121
|
+
"webdriverio": "^8.19.0",
|
|
123
122
|
"yargs": "^17.7.1"
|
|
124
123
|
},
|
|
125
124
|
"engines": {
|