@metamask/snaps-execution-environments 0.26.0 → 0.26.2
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/dist/common/endowments/index.js +4 -4
- package/dist/common/endowments/index.js.map +1 -1
- package/dist/common/endowments/network.d.ts +11 -11
- package/dist/webpack/iframe/bundle.js +1 -1
- package/dist/webpack/node-process/bundle.js +13 -58
- package/dist/webpack/node-thread/bundle.js +13 -58
- package/package.json +12 -4
|
@@ -70,6 +70,10 @@ function createEndowments(snap, ethereum, endowments = []) {
|
|
|
70
70
|
}
|
|
71
71
|
allEndowments[endowmentName] = attenuatedEndowments[endowmentName];
|
|
72
72
|
}
|
|
73
|
+
else if (endowmentName === 'ethereum') {
|
|
74
|
+
// Special case for adding the EIP-1193 provider.
|
|
75
|
+
allEndowments[endowmentName] = ethereum;
|
|
76
|
+
}
|
|
73
77
|
else if (endowmentName in globalObject_1.rootRealmGlobal) {
|
|
74
78
|
// If the endowment doesn't have a factory, just use whatever is on the
|
|
75
79
|
// global object.
|
|
@@ -79,10 +83,6 @@ function createEndowments(snap, ethereum, endowments = []) {
|
|
|
79
83
|
? globalValue.bind(globalObject_1.rootRealmGlobal)
|
|
80
84
|
: globalValue;
|
|
81
85
|
}
|
|
82
|
-
else if (endowmentName === 'ethereum') {
|
|
83
|
-
// Special case for adding the EIP-1193 provider.
|
|
84
|
-
allEndowments[endowmentName] = ethereum;
|
|
85
|
-
}
|
|
86
86
|
else {
|
|
87
87
|
// If we get to this point, we've been passed an endowment that doesn't
|
|
88
88
|
// exist in our current environment.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/common/endowments/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAEA,2CAA8C;AAE9C,kDAAkD;AAClD,sDAA8B;AAC9B,0DAAkC;AAClC,kDAA0B;AAC1B,wDAAgC;AAChC,wDAAgC;AAehC;;;;GAIG;AACH,MAAM,kBAAkB,GAAG,CAAC,iBAAO,EAAE,kBAAQ,EAAE,iBAAO,EAAE,gBAAM,EAAE,cAAI,CAAC,CAAC,MAAM,CAC1E,CAAC,SAAS,EAAE,OAAO,EAAE,EAAE;IACrB,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QAC7B,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IACH,OAAO,SAAS,CAAC;AACnB,CAAC,EACD,IAAI,GAAG,EAAwC,CAChD,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,SAAgB,gBAAgB,CAC9B,IAAuB,EACvB,QAAwB,EACxB,aAAuB,EAAE;IAEzB,MAAM,oBAAoB,GAA4B,EAAE,CAAC;IAEzD,0EAA0E;IAC1E,yEAAyE;IACzE,2CAA2C;IAC3C,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,CAI9B,CAAC,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,aAAa,EAAE,EAAE;QAC9C,oEAAoE;QACpE,IAAI,kBAAkB,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE;YACzC,IAAI,CAAC,IAAA,mBAAW,EAAC,oBAAoB,EAAE,aAAa,CAAC,EAAE;gBACrD,uEAAuE;gBACvE,gEAAgE;gBAChE,wEAAwE;gBACxE,4CAA4C;gBAC5C,2DAA2D;gBAE3D,mEAAmE;gBACnE,MAAM;gBACJ,oEAAoE;gBACpE,kBAAkB,CAAC,GAAG,CAAC,aAAa,CAAE,EAAE,EAFpC,EAAE,gBAAgB,OAEkB,EAFb,SAAS,cAAhC,oBAAkC,CAEE,CAAC;gBAC3C,MAAM,CAAC,MAAM,CAAC,oBAAoB,EAAE,SAAS,CAAC,CAAC;gBAC/C,IAAI,gBAAgB,EAAE;oBACpB,SAAS,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;iBAClC;aACF;YAED,aAAa,CAAC,aAAa,CAAC,GAAG,oBAAoB,CAAC,aAAa,CAAC,CAAC;SACpE;aAAM,IAAI,aAAa,IAAI,8BAAe,EAAE;YAC3C,uEAAuE;YACvE,iBAAiB;YACjB,MAAM,WAAW,GAAI,8BAA2C,CAC9D,aAAa,CACd,CAAC;YACF,aAAa,CAAC,aAAa,CAAC;gBAC1B,OAAO,WAAW,KAAK,UAAU,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC;oBAC9D,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,8BAAe,CAAC;oBACnC,CAAC,CAAC,WAAW,CAAC;SACnB;aAAM
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/common/endowments/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAEA,2CAA8C;AAE9C,kDAAkD;AAClD,sDAA8B;AAC9B,0DAAkC;AAClC,kDAA0B;AAC1B,wDAAgC;AAChC,wDAAgC;AAehC;;;;GAIG;AACH,MAAM,kBAAkB,GAAG,CAAC,iBAAO,EAAE,kBAAQ,EAAE,iBAAO,EAAE,gBAAM,EAAE,cAAI,CAAC,CAAC,MAAM,CAC1E,CAAC,SAAS,EAAE,OAAO,EAAE,EAAE;IACrB,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QAC7B,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IACH,OAAO,SAAS,CAAC;AACnB,CAAC,EACD,IAAI,GAAG,EAAwC,CAChD,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,SAAgB,gBAAgB,CAC9B,IAAuB,EACvB,QAAwB,EACxB,aAAuB,EAAE;IAEzB,MAAM,oBAAoB,GAA4B,EAAE,CAAC;IAEzD,0EAA0E;IAC1E,yEAAyE;IACzE,2CAA2C;IAC3C,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,CAI9B,CAAC,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,aAAa,EAAE,EAAE;QAC9C,oEAAoE;QACpE,IAAI,kBAAkB,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE;YACzC,IAAI,CAAC,IAAA,mBAAW,EAAC,oBAAoB,EAAE,aAAa,CAAC,EAAE;gBACrD,uEAAuE;gBACvE,gEAAgE;gBAChE,wEAAwE;gBACxE,4CAA4C;gBAC5C,2DAA2D;gBAE3D,mEAAmE;gBACnE,MAAM;gBACJ,oEAAoE;gBACpE,kBAAkB,CAAC,GAAG,CAAC,aAAa,CAAE,EAAE,EAFpC,EAAE,gBAAgB,OAEkB,EAFb,SAAS,cAAhC,oBAAkC,CAEE,CAAC;gBAC3C,MAAM,CAAC,MAAM,CAAC,oBAAoB,EAAE,SAAS,CAAC,CAAC;gBAC/C,IAAI,gBAAgB,EAAE;oBACpB,SAAS,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;iBAClC;aACF;YAED,aAAa,CAAC,aAAa,CAAC,GAAG,oBAAoB,CAAC,aAAa,CAAC,CAAC;SACpE;aAAM,IAAI,aAAa,KAAK,UAAU,EAAE;YACvC,iDAAiD;YACjD,aAAa,CAAC,aAAa,CAAC,GAAG,QAAQ,CAAC;SACzC;aAAM,IAAI,aAAa,IAAI,8BAAe,EAAE;YAC3C,uEAAuE;YACvE,iBAAiB;YACjB,MAAM,WAAW,GAAI,8BAA2C,CAC9D,aAAa,CACd,CAAC;YACF,aAAa,CAAC,aAAa,CAAC;gBAC1B,OAAO,WAAW,KAAK,UAAU,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC;oBAC9D,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,8BAAe,CAAC;oBACnC,CAAC,CAAC,WAAW,CAAC;SACnB;aAAM;YACL,uEAAuE;YACvE,oCAAoC;YACpC,MAAM,IAAI,KAAK,CAAC,uBAAuB,aAAa,IAAI,CAAC,CAAC;SAC3D;QACD,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,CAAC;IACtC,CAAC,EACD;QACE,aAAa,EAAE,EAAE,IAAI,EAAE;QACvB,SAAS,EAAE,EAAE;KACd,CACF,CAAC;IAEF,MAAM,QAAQ,GAAG,KAAK,IAAI,EAAE;QAC1B,MAAM,OAAO,CAAC,GAAG,CACf,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,gBAAgB,EAAE,EAAE,CAAC,gBAAgB,EAAE,CAAC,CAC/D,CAAC;IACJ,CAAC,CAAC;IACF,OAAO,EAAE,UAAU,EAAE,MAAM,CAAC,aAAa,EAAE,QAAQ,EAAE,CAAC;AACxD,CAAC;AAnED,4CAmEC;AAED;;;;;GAKG;AACH,2CAA2C;AAC3C,wDAAwD;AACxD,SAAgB,aAAa,CAAqB,KAAQ;;IACxD,6EAA6E;IAC7E,mEAAmE;IACnE,0EAA0E;IAC1E,4EAA4E;IAC5E,0EAA0E;IAC1E,4BAA4B;IAC5B,0EAA0E;IAC1E,OAAO,OAAO,CAAC,OAAO,CAAA,MAAA,MAAA,KAAK,CAAC,SAAS,0CAAE,WAAW,0CAAE,IAAI,CAAA,KAAK,QAAQ,CAAC,CAAC;AACzE,CAAC;AATD,sCASC","sourcesContent":["import { StreamProvider } from '@metamask/providers';\nimport { SnapsGlobalObject } from '@metamask/snaps-types';\nimport { hasProperty } from '@metamask/utils';\n\nimport { rootRealmGlobal } from '../globalObject';\nimport crypto from './crypto';\nimport interval from './interval';\nimport math from './math';\nimport network from './network';\nimport timeout from './timeout';\n\ntype EndowmentFactoryResult = {\n /**\n * A function that performs any necessary teardown when the snap becomes idle.\n *\n * NOTE:** The endowments are not reconstructed if the snap is re-invoked\n * before being terminated, so the teardown operation must not render the\n * endowments unusable; it should simply restore the endowments to their\n * original state.\n */\n teardownFunction?: () => Promise<void> | void;\n [key: string]: unknown;\n};\n\n/**\n * A map of endowment names to their factory functions. Some endowments share\n * the same factory function, but we only call each factory once for each snap.\n * See {@link createEndowments} for details.\n */\nconst endowmentFactories = [timeout, interval, network, crypto, math].reduce(\n (factories, builder) => {\n builder.names.forEach((name) => {\n factories.set(name, builder.factory);\n });\n return factories;\n },\n new Map<string, () => EndowmentFactoryResult>(),\n);\n\n/**\n * Gets the endowments for a particular Snap. Some endowments, like `setTimeout`\n * and `clearTimeout`, must be attenuated so that they can only affect behavior\n * within the Snap's own realm. Therefore, we use factory functions to create\n * such attenuated / modified endowments. Otherwise, the value that's on the\n * root realm global will be used.\n *\n * @param snap - The Snaps global API object.\n * @param ethereum - The Snap's EIP-1193 provider object.\n * @param endowments - The list of endowments to provide to the snap.\n * @returns An object containing the Snap's endowments.\n */\nexport function createEndowments(\n snap: SnapsGlobalObject,\n ethereum: StreamProvider,\n endowments: string[] = [],\n): { endowments: Record<string, unknown>; teardown: () => Promise<void> } {\n const attenuatedEndowments: Record<string, unknown> = {};\n\n // TODO: All endowments should be hardened to prevent covert communication\n // channels. Hardening the returned objects breaks tests elsewhere in the\n // monorepo, so further research is needed.\n const result = endowments.reduce<{\n allEndowments: Record<string, unknown>;\n teardowns: (() => Promise<void> | void)[];\n }>(\n ({ allEndowments, teardowns }, endowmentName) => {\n // First, check if the endowment has a factory, and default to that.\n if (endowmentFactories.has(endowmentName)) {\n if (!hasProperty(attenuatedEndowments, endowmentName)) {\n // Call the endowment factory for the current endowment. If the factory\n // creates multiple endowments, they will all be assigned to the\n // `attenuatedEndowments` object, but will only be passed on to the snap\n // if explicitly listed among its endowment.\n // This may not have an actual use case, but, safety first.\n\n // We just confirmed that endowmentFactories has the specified key.\n const { teardownFunction, ...endowment } =\n // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n endowmentFactories.get(endowmentName)!();\n Object.assign(attenuatedEndowments, endowment);\n if (teardownFunction) {\n teardowns.push(teardownFunction);\n }\n }\n\n allEndowments[endowmentName] = attenuatedEndowments[endowmentName];\n } else if (endowmentName === 'ethereum') {\n // Special case for adding the EIP-1193 provider.\n allEndowments[endowmentName] = ethereum;\n } else if (endowmentName in rootRealmGlobal) {\n // If the endowment doesn't have a factory, just use whatever is on the\n // global object.\n const globalValue = (rootRealmGlobal as Record<string, unknown>)[\n endowmentName\n ];\n allEndowments[endowmentName] =\n typeof globalValue === 'function' && !isConstructor(globalValue)\n ? globalValue.bind(rootRealmGlobal)\n : globalValue;\n } else {\n // If we get to this point, we've been passed an endowment that doesn't\n // exist in our current environment.\n throw new Error(`Unknown endowment: \"${endowmentName}\".`);\n }\n return { allEndowments, teardowns };\n },\n {\n allEndowments: { snap },\n teardowns: [],\n },\n );\n\n const teardown = async () => {\n await Promise.all(\n result.teardowns.map((teardownFunction) => teardownFunction()),\n );\n };\n return { endowments: result.allEndowments, teardown };\n}\n\n/**\n * Checks whether the specified function is a constructor.\n *\n * @param value - Any function value.\n * @returns Whether the specified function is a constructor.\n */\n// `Function` is exactly what we want here.\n// eslint-disable-next-line @typescript-eslint/ban-types\nexport function isConstructor<T extends Function>(value: T): boolean {\n // In our current usage, the string `prototype.constructor.name` should never\n // be empty, because you can't create a class with no name, and the\n // `prototype.constructor.name` property is configurable but not writable.\n // Nevertheless, that property was the empty string for `Date` in the iframe\n // execution environment during local testing. We have no idea why, but we\n // have to handle that case.\n // TODO: Does the `prototype` object always have a `constructor` property?\n return Boolean(typeof value.prototype?.constructor?.name === 'string');\n}\n"]}
|
|
@@ -26,20 +26,20 @@ declare const endowmentModule: {
|
|
|
26
26
|
removeEventListener<K_1 extends keyof WebSocketEventMap>(type: K_1, listener: (this: WebSocket, ev: WebSocketEventMap[K_1]) => any, options?: boolean | EventListenerOptions): void;
|
|
27
27
|
removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
|
|
28
28
|
dispatchEvent(event: Event): boolean;
|
|
29
|
-
"__#
|
|
30
|
-
"__#
|
|
31
|
-
"__#
|
|
32
|
-
"__#
|
|
33
|
-
"__#
|
|
29
|
+
"__#4@#teardownClose"(): Promise<void>;
|
|
30
|
+
"__#4@#createWrapped"(listener: WebSocketCallback): WebSocketCallback;
|
|
31
|
+
"__#4@#createWrapped"(listener: null): null;
|
|
32
|
+
"__#4@#createWrapped"(listener: WebSocketCallback | null): WebSocketCallback | null;
|
|
33
|
+
"__#4@#socket": WebSocket;
|
|
34
34
|
/**
|
|
35
35
|
* After this is set to true, no new event listeners can be added
|
|
36
36
|
*/
|
|
37
|
-
"__#
|
|
38
|
-
"__#
|
|
39
|
-
"__#
|
|
40
|
-
"__#
|
|
41
|
-
"__#
|
|
42
|
-
"__#
|
|
37
|
+
"__#4@#isTornDown": boolean;
|
|
38
|
+
"__#4@#events": Record<string, Map<WebSocketCallback, WebSocketCallback>>;
|
|
39
|
+
"__#4@#onopenOriginal": WebSocketCallback | null;
|
|
40
|
+
"__#4@#onmessageOriginal": WebSocketCallback | null;
|
|
41
|
+
"__#4@#onerrorOriginal": WebSocketCallback | null;
|
|
42
|
+
"__#4@#oncloseOriginal": WebSocketCallback | null;
|
|
43
43
|
};
|
|
44
44
|
};
|
|
45
45
|
teardownFunction: () => Promise<void>;
|