@metamask/snaps-simulation 1.0.0

package/dist/structs.cjs

@@ -0,0 +1,157 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SnapResponseStruct = exports.SnapResponseWithInterfaceStruct = exports.SnapResponseWithoutInterfaceStruct = exports.InterfaceStruct = exports.JsonRpcMockOptionsStruct = exports.SnapOptionsStruct = exports.SignatureOptionsStruct = exports.TransactionOptionsStruct = void 0;
+const snaps_sdk_1 = require("@metamask/snaps-sdk");
+const jsx_1 = require("@metamask/snaps-sdk/jsx");
+const superstruct_1 = require("@metamask/superstruct");
+const utils_1 = require("@metamask/utils");
+const crypto_1 = require("crypto");
+// TODO: Export this from `@metamask/utils` instead.
+const BytesLikeStruct = (0, superstruct_1.union)([
+    (0, superstruct_1.bigint)(),
+    (0, superstruct_1.number)(),
+    (0, superstruct_1.string)(),
+    (0, superstruct_1.instance)(Uint8Array),
+]);
+exports.TransactionOptionsStruct = (0, superstruct_1.object)({
+    /**
+     * The CAIP-2 chain ID to send the transaction on. Defaults to `eip155:1`.
+     */
+    chainId: (0, superstruct_1.defaulted)((0, superstruct_1.string)(), 'eip155:1'),
+    /**
+     * The origin to send the transaction from. Defaults to `metamask.io`.
+     */
+    origin: (0, superstruct_1.defaulted)((0, superstruct_1.string)(), 'metamask.io'),
+    /**
+     * The address to send the transaction from. Defaults to a randomly generated
+     * address.
+     */
+    // TODO: Move this coercer to `@metamask/utils`.
+    from: (0, superstruct_1.coerce)(utils_1.StrictHexStruct, (0, superstruct_1.optional)(BytesLikeStruct), (value) => {
+        if (value) {
+            return (0, utils_1.bytesToHex)((0, utils_1.valueToBytes)(value));
+        }
+        return (0, utils_1.bytesToHex)((0, crypto_1.randomBytes)(20));
+    }),
+    /**
+     * The address to send the transaction to. Defaults to a randomly generated
+     * address.
+     */
+    // TODO: Move this coercer to `@metamask/utils`.
+    to: (0, superstruct_1.coerce)(utils_1.StrictHexStruct, (0, superstruct_1.optional)(BytesLikeStruct), (value) => {
+        if (value) {
+            return (0, utils_1.bytesToHex)((0, utils_1.valueToBytes)(value));
+        }
+        return (0, utils_1.bytesToHex)((0, crypto_1.randomBytes)(20));
+    }),
+    /**
+     * The value to send with the transaction. The value may be specified as a
+     * `number`, `bigint`, `string`, or `Uint8Array`. Defaults to `0`.
+     */
+    value: (0, superstruct_1.defaulted)((0, superstruct_1.coerce)(utils_1.StrictHexStruct, BytesLikeStruct, (value) => (0, utils_1.bytesToHex)((0, utils_1.valueToBytes)(value))), '0x0'),
+    /**
+     * The gas limit to use for the transaction. The gas limit may be specified
+     * as a `number`, `bigint`, `string`, or `Uint8Array`. Defaults to `21_000`.
+     */
+    gasLimit: (0, superstruct_1.defaulted)((0, superstruct_1.coerce)(utils_1.StrictHexStruct, BytesLikeStruct, (value) => (0, utils_1.bytesToHex)((0, utils_1.valueToBytes)(value))), (0, utils_1.valueToBytes)(21000)),
+    /**
+     * The max fee per gas (in Wei) to use for the transaction. The max fee per
+     * gas may be specified as a `number`, `bigint`, `string`, or `Uint8Array`.
+     * Defaults to `1`.
+     */
+    maxFeePerGas: (0, superstruct_1.defaulted)((0, superstruct_1.coerce)(utils_1.StrictHexStruct, BytesLikeStruct, (value) => (0, utils_1.bytesToHex)((0, utils_1.valueToBytes)(value))), (0, utils_1.valueToBytes)(1)),
+    /**
+     * The max priority fee per gas (in Wei) to use for the transaction. The max
+     * priority fee per gas may be specified as a `number`, `bigint`, `string`,
+     * or `Uint8Array`. Defaults to `1`.
+     */
+    maxPriorityFeePerGas: (0, superstruct_1.defaulted)((0, superstruct_1.coerce)(utils_1.StrictHexStruct, BytesLikeStruct, (value) => (0, utils_1.bytesToHex)((0, utils_1.valueToBytes)(value))), (0, utils_1.valueToBytes)(1)),
+    /**
+     * The nonce to use for the transaction. The nonce may be specified as a
+     * `number`, `bigint`, `string`, or `Uint8Array`. Defaults to `0`.
+     */
+    nonce: (0, superstruct_1.defaulted)((0, superstruct_1.coerce)(utils_1.StrictHexStruct, BytesLikeStruct, (value) => (0, utils_1.bytesToHex)((0, utils_1.valueToBytes)(value))), (0, utils_1.valueToBytes)(0)),
+    /**
+     * The data to send with the transaction. The data may be specified as a
+     * `number`, `bigint`, `string`, or `Uint8Array`. Defaults to `0x`.
+     */
+    data: (0, superstruct_1.defaulted)((0, superstruct_1.coerce)((0, superstruct_1.union)([utils_1.StrictHexStruct, (0, superstruct_1.literal)('0x')]), BytesLikeStruct, (value) => (0, utils_1.bytesToHex)((0, utils_1.valueToBytes)(value))), '0x'),
+});
+exports.SignatureOptionsStruct = (0, superstruct_1.object)({
+    /**
+     * The origin making the signature request.
+     */
+    origin: (0, superstruct_1.defaulted)((0, superstruct_1.string)(), 'metamask.io'),
+    /**
+     * The address signing the signature request. Defaults to a randomly generated
+     * address.
+     */
+    from: (0, superstruct_1.coerce)(utils_1.StrictHexStruct, (0, superstruct_1.optional)(BytesLikeStruct), (value) => {
+        if (value) {
+            return (0, utils_1.bytesToHex)((0, utils_1.valueToBytes)(value));
+        }
+        return (0, utils_1.bytesToHex)((0, crypto_1.randomBytes)(20));
+    }),
+    /**
+     * The data to send with the transaction. The data may be specified as a
+     * `string`, an object, or an array of objects. This covers the data types
+     * for the supported signature methods. Defaults to `0x`.
+     */
+    data: (0, superstruct_1.defaulted)((0, superstruct_1.union)([
+        utils_1.StrictHexStruct,
+        (0, superstruct_1.literal)('0x'),
+        (0, superstruct_1.record)((0, superstruct_1.string)(), (0, superstruct_1.any)()),
+        (0, superstruct_1.array)((0, superstruct_1.record)((0, superstruct_1.string)(), (0, superstruct_1.any)())),
+    ]), '0x'),
+    /**
+     * The signature method being used.
+     */
+    signatureMethod: (0, superstruct_1.defaulted)((0, superstruct_1.union)([
+        (0, superstruct_1.literal)('eth_sign'),
+        (0, superstruct_1.literal)('personal_sign'),
+        (0, superstruct_1.literal)('eth_signTypedData'),
+        (0, superstruct_1.literal)('eth_signTypedData_v3'),
+        (0, superstruct_1.literal)('eth_signTypedData_v4'),
+    ]), 'personal_sign'),
+});
+exports.SnapOptionsStruct = (0, superstruct_1.object)({
+    /**
+     * The timeout in milliseconds to use for requests to the snap. Defaults to
+     * `1000`.
+     */
+    timeout: (0, superstruct_1.defaulted)((0, superstruct_1.optional)((0, superstruct_1.number)()), 1000),
+});
+exports.JsonRpcMockOptionsStruct = (0, superstruct_1.object)({
+    method: (0, superstruct_1.string)(),
+    result: utils_1.JsonStruct,
+});
+exports.InterfaceStruct = (0, superstruct_1.type)({
+    content: (0, superstruct_1.optional)(jsx_1.JSXElementStruct),
+});
+exports.SnapResponseWithoutInterfaceStruct = (0, superstruct_1.object)({
+    id: (0, superstruct_1.string)(),
+    response: (0, superstruct_1.union)([
+        (0, superstruct_1.object)({
+            result: utils_1.JsonStruct,
+        }),
+        (0, superstruct_1.object)({
+            error: utils_1.JsonStruct,
+        }),
+    ]),
+    notifications: (0, superstruct_1.array)((0, superstruct_1.object)({
+        id: (0, superstruct_1.string)(),
+        message: (0, superstruct_1.string)(),
+        type: (0, superstruct_1.union)([
+            (0, snaps_sdk_1.enumValue)(snaps_sdk_1.NotificationType.InApp),
+            (0, snaps_sdk_1.enumValue)(snaps_sdk_1.NotificationType.Native),
+        ]),
+    })),
+});
+exports.SnapResponseWithInterfaceStruct = (0, superstruct_1.assign)(exports.SnapResponseWithoutInterfaceStruct, (0, superstruct_1.object)({
+    getInterface: (0, superstruct_1.func)(),
+}));
+exports.SnapResponseStruct = (0, superstruct_1.union)([
+    exports.SnapResponseWithoutInterfaceStruct,
+    exports.SnapResponseWithInterfaceStruct,
+]);
+//# sourceMappingURL=structs.cjs.map

package/dist/structs.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"structs.cjs","sourceRoot":"","sources":["../src/structs.ts"],"names":[],"mappings":";;;AAAA,mDAAkE;AAClE,iDAA2D;AAC3D,uDAiB+B;AAC/B,2CAKyB;AACzB,mCAAqC;AAErC,oDAAoD;AACpD,MAAM,eAAe,GAAG,IAAA,mBAAK,EAAC;IAC5B,IAAA,oBAAM,GAAE;IACR,IAAA,oBAAM,GAAE;IACR,IAAA,oBAAM,GAAE;IACR,IAAA,sBAAQ,EAAC,UAAU,CAAC;CACrB,CAAC,CAAC;AAEU,QAAA,wBAAwB,GAAG,IAAA,oBAAM,EAAC;IAC7C;;OAEG;IACH,OAAO,EAAE,IAAA,uBAAS,EAAC,IAAA,oBAAM,GAAE,EAAE,UAAU,CAAC;IAExC;;OAEG;IACH,MAAM,EAAE,IAAA,uBAAS,EAAC,IAAA,oBAAM,GAAE,EAAE,aAAa,CAAC;IAE1C;;;OAGG;IACH,gDAAgD;IAChD,IAAI,EAAE,IAAA,oBAAM,EAAC,uBAAe,EAAE,IAAA,sBAAQ,EAAC,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE;QACjE,IAAI,KAAK,EAAE,CAAC;YACV,OAAO,IAAA,kBAAU,EAAC,IAAA,oBAAY,EAAC,KAAK,CAAC,CAAC,CAAC;QACzC,CAAC;QAED,OAAO,IAAA,kBAAU,EAAC,IAAA,oBAAW,EAAC,EAAE,CAAC,CAAC,CAAC;IACrC,CAAC,CAAC;IAEF;;;OAGG;IACH,gDAAgD;IAChD,EAAE,EAAE,IAAA,oBAAM,EAAC,uBAAe,EAAE,IAAA,sBAAQ,EAAC,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE;QAC/D,IAAI,KAAK,EAAE,CAAC;YACV,OAAO,IAAA,kBAAU,EAAC,IAAA,oBAAY,EAAC,KAAK,CAAC,CAAC,CAAC;QACzC,CAAC;QAED,OAAO,IAAA,kBAAU,EAAC,IAAA,oBAAW,EAAC,EAAE,CAAC,CAAC,CAAC;IACrC,CAAC,CAAC;IAEF;;;OAGG;IACH,KAAK,EAAE,IAAA,uBAAS,EACd,IAAA,oBAAM,EAAC,uBAAe,EAAE,eAAe,EAAE,CAAC,KAAK,EAAE,EAAE,CACjD,IAAA,kBAAU,EAAC,IAAA,oBAAY,EAAC,KAAK,CAAC,CAAC,CAChC,EACD,KAAK,CACN;IAED;;;OAGG;IACH,QAAQ,EAAE,IAAA,uBAAS,EACjB,IAAA,oBAAM,EAAC,uBAAe,EAAE,eAAe,EAAE,CAAC,KAAK,EAAE,EAAE,CACjD,IAAA,kBAAU,EAAC,IAAA,oBAAY,EAAC,KAAK,CAAC,CAAC,CAChC,EACD,IAAA,oBAAY,EAAC,KAAM,CAAC,CACrB;IAED;;;;OAIG;IACH,YAAY,EAAE,IAAA,uBAAS,EACrB,IAAA,oBAAM,EAAC,uBAAe,EAAE,eAAe,EAAE,CAAC,KAAK,EAAE,EAAE,CACjD,IAAA,kBAAU,EAAC,IAAA,oBAAY,EAAC,KAAK,CAAC,CAAC,CAChC,EACD,IAAA,oBAAY,EAAC,CAAC,CAAC,CAChB;IAED;;;;OAIG;IACH,oBAAoB,EAAE,IAAA,uBAAS,EAC7B,IAAA,oBAAM,EAAC,uBAAe,EAAE,eAAe,EAAE,CAAC,KAAK,EAAE,EAAE,CACjD,IAAA,kBAAU,EAAC,IAAA,oBAAY,EAAC,KAAK,CAAC,CAAC,CAChC,EACD,IAAA,oBAAY,EAAC,CAAC,CAAC,CAChB;IAED;;;OAGG;IACH,KAAK,EAAE,IAAA,uBAAS,EACd,IAAA,oBAAM,EAAC,uBAAe,EAAE,eAAe,EAAE,CAAC,KAAK,EAAE,EAAE,CACjD,IAAA,kBAAU,EAAC,IAAA,oBAAY,EAAC,KAAK,CAAC,CAAC,CAChC,EACD,IAAA,oBAAY,EAAC,CAAC,CAAC,CAChB;IAED;;;OAGG;IACH,IAAI,EAAE,IAAA,uBAAS,EACb,IAAA,oBAAM,EAAC,IAAA,mBAAK,EAAC,CAAC,uBAAe,EAAE,IAAA,qBAAO,EAAC,IAAI,CAAC,CAAC,CAAC,EAAE,eAAe,EAAE,CAAC,KAAK,EAAE,EAAE,CACzE,IAAA,kBAAU,EAAC,IAAA,oBAAY,EAAC,KAAK,CAAC,CAAC,CAChC,EACD,IAAI,CACL;CACF,CAAC,CAAC;AAEU,QAAA,sBAAsB,GAAG,IAAA,oBAAM,EAAC;IAC3C;;OAEG;IACH,MAAM,EAAE,IAAA,uBAAS,EAAC,IAAA,oBAAM,GAAE,EAAE,aAAa,CAAC;IAE1C;;;OAGG;IACH,IAAI,EAAE,IAAA,oBAAM,EAAC,uBAAe,EAAE,IAAA,sBAAQ,EAAC,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE;QACjE,IAAI,KAAK,EAAE,CAAC;YACV,OAAO,IAAA,kBAAU,EAAC,IAAA,oBAAY,EAAC,KAAK,CAAC,CAAC,CAAC;QACzC,CAAC;QAED,OAAO,IAAA,kBAAU,EAAC,IAAA,oBAAW,EAAC,EAAE,CAAC,CAAC,CAAC;IACrC,CAAC,CAAC;IAEF;;;;OAIG;IACH,IAAI,EAAE,IAAA,uBAAS,EACb,IAAA,mBAAK,EAAC;QACJ,uBAAe;QACf,IAAA,qBAAO,EAAC,IAAI,CAAC;QACb,IAAA,oBAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,IAAA,iBAAG,GAAE,CAAC;QACvB,IAAA,mBAAK,EAAC,IAAA,oBAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,IAAA,iBAAG,GAAE,CAAC,CAAC;KAC/B,CAAC,EACF,IAAI,CACL;IAED;;OAEG;IACH,eAAe,EAAE,IAAA,uBAAS,EACxB,IAAA,mBAAK,EAAC;QACJ,IAAA,qBAAO,EAAC,UAAU,CAAC;QACnB,IAAA,qBAAO,EAAC,eAAe,CAAC;QACxB,IAAA,qBAAO,EAAC,mBAAmB,CAAC;QAC5B,IAAA,qBAAO,EAAC,sBAAsB,CAAC;QAC/B,IAAA,qBAAO,EAAC,sBAAsB,CAAC;KAChC,CAAC,EACF,eAAe,CAChB;CACF,CAAC,CAAC;AAEU,QAAA,iBAAiB,GAAG,IAAA,oBAAM,EAAC;IACtC;;;OAGG;IACH,OAAO,EAAE,IAAA,uBAAS,EAAC,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC,EAAE,IAAI,CAAC;CAC7C,CAAC,CAAC;AAEU,QAAA,wBAAwB,GAAG,IAAA,oBAAM,EAAC;IAC7C,MAAM,EAAE,IAAA,oBAAM,GAAE;IAChB,MAAM,EAAE,kBAAU;CACnB,CAAC,CAAC;AAEU,QAAA,eAAe,GAAG,IAAA,kBAAI,EAAC;IAClC,OAAO,EAAE,IAAA,sBAAQ,EAAC,sBAAgB,CAAC;CACpC,CAAC,CAAC;AAEU,QAAA,kCAAkC,GAAG,IAAA,oBAAM,EAAC;IACvD,EAAE,EAAE,IAAA,oBAAM,GAAE;IAEZ,QAAQ,EAAE,IAAA,mBAAK,EAAC;QACd,IAAA,oBAAM,EAAC;YACL,MAAM,EAAE,kBAAU;SACnB,CAAC;QACF,IAAA,oBAAM,EAAC;YACL,KAAK,EAAE,kBAAU;SAClB,CAAC;KACH,CAAC;IAEF,aAAa,EAAE,IAAA,mBAAK,EAClB,IAAA,oBAAM,EAAC;QACL,EAAE,EAAE,IAAA,oBAAM,GAAE;QACZ,OAAO,EAAE,IAAA,oBAAM,GAAE;QACjB,IAAI,EAAE,IAAA,mBAAK,EAAC;YACV,IAAA,qBAAS,EAAC,4BAAgB,CAAC,KAAK,CAAC;YACjC,IAAA,qBAAS,EAAC,4BAAgB,CAAC,MAAM,CAAC;SACnC,CAAC;KACH,CAAC,CACH;CACF,CAAC,CAAC;AAEU,QAAA,+BAA+B,GAAG,IAAA,oBAAM,EACnD,0CAAkC,EAClC,IAAA,oBAAM,EAAC;IACL,YAAY,EAAE,IAAA,kBAAI,GAAE;CACrB,CAAC,CACH,CAAC;AAEW,QAAA,kBAAkB,GAAG,IAAA,mBAAK,EAAC;IACtC,0CAAkC;IAClC,uCAA+B;CAChC,CAAC,CAAC","sourcesContent":["import { NotificationType, enumValue } from '@metamask/snaps-sdk';\nimport { JSXElementStruct } from '@metamask/snaps-sdk/jsx';\nimport {\n  array,\n  assign,\n  bigint,\n  coerce,\n  defaulted,\n  instance,\n  literal,\n  number,\n  object,\n  optional,\n  string,\n  union,\n  record,\n  any,\n  func,\n  type,\n} from '@metamask/superstruct';\nimport {\n  bytesToHex,\n  JsonStruct,\n  StrictHexStruct,\n  valueToBytes,\n} from '@metamask/utils';\nimport { randomBytes } from 'crypto';\n\n// TODO: Export this from `@metamask/utils` instead.\nconst BytesLikeStruct = union([\n  bigint(),\n  number(),\n  string(),\n  instance(Uint8Array),\n]);\n\nexport const TransactionOptionsStruct = object({\n  /**\n   * The CAIP-2 chain ID to send the transaction on. Defaults to `eip155:1`.\n   */\n  chainId: defaulted(string(), 'eip155:1'),\n\n  /**\n   * The origin to send the transaction from. Defaults to `metamask.io`.\n   */\n  origin: defaulted(string(), 'metamask.io'),\n\n  /**\n   * The address to send the transaction from. Defaults to a randomly generated\n   * address.\n   */\n  // TODO: Move this coercer to `@metamask/utils`.\n  from: coerce(StrictHexStruct, optional(BytesLikeStruct), (value) => {\n    if (value) {\n      return bytesToHex(valueToBytes(value));\n    }\n\n    return bytesToHex(randomBytes(20));\n  }),\n\n  /**\n   * The address to send the transaction to. Defaults to a randomly generated\n   * address.\n   */\n  // TODO: Move this coercer to `@metamask/utils`.\n  to: coerce(StrictHexStruct, optional(BytesLikeStruct), (value) => {\n    if (value) {\n      return bytesToHex(valueToBytes(value));\n    }\n\n    return bytesToHex(randomBytes(20));\n  }),\n\n  /**\n   * The value to send with the transaction. The value may be specified as a\n   * `number`, `bigint`, `string`, or `Uint8Array`. Defaults to `0`.\n   */\n  value: defaulted(\n    coerce(StrictHexStruct, BytesLikeStruct, (value) =>\n      bytesToHex(valueToBytes(value)),\n    ),\n    '0x0',\n  ),\n\n  /**\n   * The gas limit to use for the transaction. The gas limit may be specified\n   * as a `number`, `bigint`, `string`, or `Uint8Array`. Defaults to `21_000`.\n   */\n  gasLimit: defaulted(\n    coerce(StrictHexStruct, BytesLikeStruct, (value) =>\n      bytesToHex(valueToBytes(value)),\n    ),\n    valueToBytes(21_000),\n  ),\n\n  /**\n   * The max fee per gas (in Wei) to use for the transaction. The max fee per\n   * gas may be specified as a `number`, `bigint`, `string`, or `Uint8Array`.\n   * Defaults to `1`.\n   */\n  maxFeePerGas: defaulted(\n    coerce(StrictHexStruct, BytesLikeStruct, (value) =>\n      bytesToHex(valueToBytes(value)),\n    ),\n    valueToBytes(1),\n  ),\n\n  /**\n   * The max priority fee per gas (in Wei) to use for the transaction. The max\n   * priority fee per gas may be specified as a `number`, `bigint`, `string`,\n   * or `Uint8Array`. Defaults to `1`.\n   */\n  maxPriorityFeePerGas: defaulted(\n    coerce(StrictHexStruct, BytesLikeStruct, (value) =>\n      bytesToHex(valueToBytes(value)),\n    ),\n    valueToBytes(1),\n  ),\n\n  /**\n   * The nonce to use for the transaction. The nonce may be specified as a\n   * `number`, `bigint`, `string`, or `Uint8Array`. Defaults to `0`.\n   */\n  nonce: defaulted(\n    coerce(StrictHexStruct, BytesLikeStruct, (value) =>\n      bytesToHex(valueToBytes(value)),\n    ),\n    valueToBytes(0),\n  ),\n\n  /**\n   * The data to send with the transaction. The data may be specified as a\n   * `number`, `bigint`, `string`, or `Uint8Array`. Defaults to `0x`.\n   */\n  data: defaulted(\n    coerce(union([StrictHexStruct, literal('0x')]), BytesLikeStruct, (value) =>\n      bytesToHex(valueToBytes(value)),\n    ),\n    '0x',\n  ),\n});\n\nexport const SignatureOptionsStruct = object({\n  /**\n   * The origin making the signature request.\n   */\n  origin: defaulted(string(), 'metamask.io'),\n\n  /**\n   * The address signing the signature request. Defaults to a randomly generated\n   * address.\n   */\n  from: coerce(StrictHexStruct, optional(BytesLikeStruct), (value) => {\n    if (value) {\n      return bytesToHex(valueToBytes(value));\n    }\n\n    return bytesToHex(randomBytes(20));\n  }),\n\n  /**\n   * The data to send with the transaction. The data may be specified as a\n   * `string`, an object, or an array of objects. This covers the data types\n   * for the supported signature methods. Defaults to `0x`.\n   */\n  data: defaulted(\n    union([\n      StrictHexStruct,\n      literal('0x'),\n      record(string(), any()),\n      array(record(string(), any())),\n    ]),\n    '0x',\n  ),\n\n  /**\n   * The signature method being used.\n   */\n  signatureMethod: defaulted(\n    union([\n      literal('eth_sign'),\n      literal('personal_sign'),\n      literal('eth_signTypedData'),\n      literal('eth_signTypedData_v3'),\n      literal('eth_signTypedData_v4'),\n    ]),\n    'personal_sign',\n  ),\n});\n\nexport const SnapOptionsStruct = object({\n  /**\n   * The timeout in milliseconds to use for requests to the snap. Defaults to\n   * `1000`.\n   */\n  timeout: defaulted(optional(number()), 1000),\n});\n\nexport const JsonRpcMockOptionsStruct = object({\n  method: string(),\n  result: JsonStruct,\n});\n\nexport const InterfaceStruct = type({\n  content: optional(JSXElementStruct),\n});\n\nexport const SnapResponseWithoutInterfaceStruct = object({\n  id: string(),\n\n  response: union([\n    object({\n      result: JsonStruct,\n    }),\n    object({\n      error: JsonStruct,\n    }),\n  ]),\n\n  notifications: array(\n    object({\n      id: string(),\n      message: string(),\n      type: union([\n        enumValue(NotificationType.InApp),\n        enumValue(NotificationType.Native),\n      ]),\n    }),\n  ),\n});\n\nexport const SnapResponseWithInterfaceStruct = assign(\n  SnapResponseWithoutInterfaceStruct,\n  object({\n    getInterface: func(),\n  }),\n);\n\nexport const SnapResponseStruct = union([\n  SnapResponseWithoutInterfaceStruct,\n  SnapResponseWithInterfaceStruct,\n]);\n"]}

package/dist/structs.d.cts

@@ -0,0 +1,205 @@
+export declare const TransactionOptionsStruct: import("@metamask/superstruct").Struct<{
+    data: `0x${string}`;
+    origin: string;
+    value: `0x${string}`;
+    nonce: `0x${string}`;
+    from: `0x${string}`;
+    chainId: string;
+    to: `0x${string}`;
+    gasLimit: `0x${string}`;
+    maxFeePerGas: `0x${string}`;
+    maxPriorityFeePerGas: `0x${string}`;
+}, {
+    /**
+     * The CAIP-2 chain ID to send the transaction on. Defaults to `eip155:1`.
+     */
+    chainId: import("@metamask/superstruct").Struct<string, null>;
+    /**
+     * The origin to send the transaction from. Defaults to `metamask.io`.
+     */
+    origin: import("@metamask/superstruct").Struct<string, null>;
+    /**
+     * The address to send the transaction from. Defaults to a randomly generated
+     * address.
+     */
+    from: import("@metamask/superstruct").Struct<`0x${string}`, null>;
+    /**
+     * The address to send the transaction to. Defaults to a randomly generated
+     * address.
+     */
+    to: import("@metamask/superstruct").Struct<`0x${string}`, null>;
+    /**
+     * The value to send with the transaction. The value may be specified as a
+     * `number`, `bigint`, `string`, or `Uint8Array`. Defaults to `0`.
+     */
+    value: import("@metamask/superstruct").Struct<`0x${string}`, null>;
+    /**
+     * The gas limit to use for the transaction. The gas limit may be specified
+     * as a `number`, `bigint`, `string`, or `Uint8Array`. Defaults to `21_000`.
+     */
+    gasLimit: import("@metamask/superstruct").Struct<`0x${string}`, null>;
+    /**
+     * The max fee per gas (in Wei) to use for the transaction. The max fee per
+     * gas may be specified as a `number`, `bigint`, `string`, or `Uint8Array`.
+     * Defaults to `1`.
+     */
+    maxFeePerGas: import("@metamask/superstruct").Struct<`0x${string}`, null>;
+    /**
+     * The max priority fee per gas (in Wei) to use for the transaction. The max
+     * priority fee per gas may be specified as a `number`, `bigint`, `string`,
+     * or `Uint8Array`. Defaults to `1`.
+     */
+    maxPriorityFeePerGas: import("@metamask/superstruct").Struct<`0x${string}`, null>;
+    /**
+     * The nonce to use for the transaction. The nonce may be specified as a
+     * `number`, `bigint`, `string`, or `Uint8Array`. Defaults to `0`.
+     */
+    nonce: import("@metamask/superstruct").Struct<`0x${string}`, null>;
+    /**
+     * The data to send with the transaction. The data may be specified as a
+     * `number`, `bigint`, `string`, or `Uint8Array`. Defaults to `0x`.
+     */
+    data: import("@metamask/superstruct").Struct<`0x${string}`, null>;
+}>;
+export declare const SignatureOptionsStruct: import("@metamask/superstruct").Struct<{
+    data: `0x${string}` | Record<string, any> | Record<string, any>[];
+    origin: string;
+    from: `0x${string}`;
+    signatureMethod: "eth_signTypedData" | "personal_sign" | "eth_sign" | "eth_signTypedData_v3" | "eth_signTypedData_v4";
+}, {
+    /**
+     * The origin making the signature request.
+     */
+    origin: import("@metamask/superstruct").Struct<string, null>;
+    /**
+     * The address signing the signature request. Defaults to a randomly generated
+     * address.
+     */
+    from: import("@metamask/superstruct").Struct<`0x${string}`, null>;
+    /**
+     * The data to send with the transaction. The data may be specified as a
+     * `string`, an object, or an array of objects. This covers the data types
+     * for the supported signature methods. Defaults to `0x`.
+     */
+    data: import("@metamask/superstruct").Struct<`0x${string}` | Record<string, any> | Record<string, any>[], null>;
+    /**
+     * The signature method being used.
+     */
+    signatureMethod: import("@metamask/superstruct").Struct<"eth_signTypedData" | "personal_sign" | "eth_sign" | "eth_signTypedData_v3" | "eth_signTypedData_v4", null>;
+}>;
+export declare const SnapOptionsStruct: import("@metamask/superstruct").Struct<{
+    timeout?: number | undefined;
+}, {
+    /**
+     * The timeout in milliseconds to use for requests to the snap. Defaults to
+     * `1000`.
+     */
+    timeout: import("@metamask/superstruct").Struct<number | undefined, null>;
+}>;
+export declare const JsonRpcMockOptionsStruct: import("@metamask/superstruct").Struct<{
+    method: string;
+    result: import("@metamask/snaps-sdk").Json;
+}, {
+    method: import("@metamask/superstruct").Struct<string, null>;
+    result: import("@metamask/superstruct").Struct<import("@metamask/snaps-sdk").Json, unknown>;
+}>;
+export declare const InterfaceStruct: import("@metamask/superstruct").Struct<{
+    content?: import("@metamask/snaps-sdk/jsx").JSXElement | undefined;
+}, {
+    content: import("@metamask/superstruct").Struct<import("@metamask/snaps-sdk/jsx").JSXElement | undefined, null>;
+}>;
+export declare const SnapResponseWithoutInterfaceStruct: import("@metamask/superstruct").Struct<{
+    id: string;
+    notifications: {
+        type: "native" | "inApp";
+        message: string;
+        id: string;
+    }[];
+    response: {
+        result: import("@metamask/snaps-sdk").Json;
+    } | {
+        error: import("@metamask/snaps-sdk").Json;
+    };
+}, {
+    id: import("@metamask/superstruct").Struct<string, null>;
+    response: import("@metamask/superstruct").Struct<{
+        result: import("@metamask/snaps-sdk").Json;
+    } | {
+        error: import("@metamask/snaps-sdk").Json;
+    }, null>;
+    notifications: import("@metamask/superstruct").Struct<{
+        type: "native" | "inApp";
+        message: string;
+        id: string;
+    }[], import("@metamask/superstruct").Struct<{
+        type: "native" | "inApp";
+        message: string;
+        id: string;
+    }, {
+        id: import("@metamask/superstruct").Struct<string, null>;
+        message: import("@metamask/superstruct").Struct<string, null>;
+        type: import("@metamask/superstruct").Struct<"native" | "inApp", null>;
+    }>>;
+}>;
+export declare const SnapResponseWithInterfaceStruct: import("@metamask/superstruct").Struct<{
+    id: string;
+    notifications: {
+        type: "native" | "inApp";
+        message: string;
+        id: string;
+    }[];
+    response: {
+        result: import("@metamask/snaps-sdk").Json;
+    } | {
+        error: import("@metamask/snaps-sdk").Json;
+    };
+    getInterface: Function;
+}, {
+    getInterface: import("@metamask/superstruct").Struct<Function, null>;
+    id: import("@metamask/superstruct").Struct<string, null>;
+    notifications: import("@metamask/superstruct").Struct<{
+        type: "native" | "inApp";
+        message: string;
+        id: string;
+    }[], import("@metamask/superstruct").Struct<{
+        type: "native" | "inApp";
+        message: string;
+        id: string;
+    }, {
+        id: import("@metamask/superstruct").Struct<string, null>;
+        message: import("@metamask/superstruct").Struct<string, null>;
+        type: import("@metamask/superstruct").Struct<"native" | "inApp", null>;
+    }>>;
+    response: import("@metamask/superstruct").Struct<{
+        result: import("@metamask/snaps-sdk").Json;
+    } | {
+        error: import("@metamask/snaps-sdk").Json;
+    }, null>;
+}>;
+export declare const SnapResponseStruct: import("@metamask/superstruct").Struct<{
+    id: string;
+    notifications: {
+        type: "native" | "inApp";
+        message: string;
+        id: string;
+    }[];
+    response: {
+        result: import("@metamask/snaps-sdk").Json;
+    } | {
+        error: import("@metamask/snaps-sdk").Json;
+    };
+} | {
+    id: string;
+    notifications: {
+        type: "native" | "inApp";
+        message: string;
+        id: string;
+    }[];
+    response: {
+        result: import("@metamask/snaps-sdk").Json;
+    } | {
+        error: import("@metamask/snaps-sdk").Json;
+    };
+    getInterface: Function;
+}, null>;
+//# sourceMappingURL=structs.d.cts.map

package/dist/structs.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"structs.d.cts","sourceRoot":"","sources":["../src/structs.ts"],"names":[],"mappings":"AAoCA,eAAO,MAAM,wBAAwB;;;;;;;;;;;;IACnC;;OAEG;;IAGH;;OAEG;;IAGH;;;OAGG;;IAUH;;;OAGG;;IAUH;;;OAGG;;IAQH;;;OAGG;;IAQH;;;;OAIG;;IAQH;;;;OAIG;;IAQH;;;OAGG;;IAQH;;;OAGG;;EAOH,CAAC;AAEH,eAAO,MAAM,sBAAsB;;;;;;IACjC;;OAEG;;IAGH;;;OAGG;;IASH;;;;OAIG;;IAWH;;OAEG;;EAWH,CAAC;AAEH,eAAO,MAAM,iBAAiB;;;IAC5B;;;OAGG;;EAEH,CAAC;AAEH,eAAO,MAAM,wBAAwB;;;;;;EAGnC,CAAC;AAEH,eAAO,MAAM,eAAe;;;;EAE1B,CAAC;AAEH,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAsB7C,CAAC;AAEH,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAK3C,CAAC;AAEF,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;QAG7B,CAAC"}

package/dist/structs.d.mts

@@ -0,0 +1,205 @@
+export declare const TransactionOptionsStruct: import("@metamask/superstruct").Struct<{
+    data: `0x${string}`;
+    origin: string;
+    value: `0x${string}`;
+    nonce: `0x${string}`;
+    from: `0x${string}`;
+    chainId: string;
+    to: `0x${string}`;
+    gasLimit: `0x${string}`;
+    maxFeePerGas: `0x${string}`;
+    maxPriorityFeePerGas: `0x${string}`;
+}, {
+    /**
+     * The CAIP-2 chain ID to send the transaction on. Defaults to `eip155:1`.
+     */
+    chainId: import("@metamask/superstruct").Struct<string, null>;
+    /**
+     * The origin to send the transaction from. Defaults to `metamask.io`.
+     */
+    origin: import("@metamask/superstruct").Struct<string, null>;
+    /**
+     * The address to send the transaction from. Defaults to a randomly generated
+     * address.
+     */
+    from: import("@metamask/superstruct").Struct<`0x${string}`, null>;
+    /**
+     * The address to send the transaction to. Defaults to a randomly generated
+     * address.
+     */
+    to: import("@metamask/superstruct").Struct<`0x${string}`, null>;
+    /**
+     * The value to send with the transaction. The value may be specified as a
+     * `number`, `bigint`, `string`, or `Uint8Array`. Defaults to `0`.
+     */
+    value: import("@metamask/superstruct").Struct<`0x${string}`, null>;
+    /**
+     * The gas limit to use for the transaction. The gas limit may be specified
+     * as a `number`, `bigint`, `string`, or `Uint8Array`. Defaults to `21_000`.
+     */
+    gasLimit: import("@metamask/superstruct").Struct<`0x${string}`, null>;
+    /**
+     * The max fee per gas (in Wei) to use for the transaction. The max fee per
+     * gas may be specified as a `number`, `bigint`, `string`, or `Uint8Array`.
+     * Defaults to `1`.
+     */
+    maxFeePerGas: import("@metamask/superstruct").Struct<`0x${string}`, null>;
+    /**
+     * The max priority fee per gas (in Wei) to use for the transaction. The max
+     * priority fee per gas may be specified as a `number`, `bigint`, `string`,
+     * or `Uint8Array`. Defaults to `1`.
+     */
+    maxPriorityFeePerGas: import("@metamask/superstruct").Struct<`0x${string}`, null>;
+    /**
+     * The nonce to use for the transaction. The nonce may be specified as a
+     * `number`, `bigint`, `string`, or `Uint8Array`. Defaults to `0`.
+     */
+    nonce: import("@metamask/superstruct").Struct<`0x${string}`, null>;
+    /**
+     * The data to send with the transaction. The data may be specified as a
+     * `number`, `bigint`, `string`, or `Uint8Array`. Defaults to `0x`.
+     */
+    data: import("@metamask/superstruct").Struct<`0x${string}`, null>;
+}>;
+export declare const SignatureOptionsStruct: import("@metamask/superstruct").Struct<{
+    data: `0x${string}` | Record<string, any> | Record<string, any>[];
+    origin: string;
+    from: `0x${string}`;
+    signatureMethod: "eth_signTypedData" | "personal_sign" | "eth_sign" | "eth_signTypedData_v3" | "eth_signTypedData_v4";
+}, {
+    /**
+     * The origin making the signature request.
+     */
+    origin: import("@metamask/superstruct").Struct<string, null>;
+    /**
+     * The address signing the signature request. Defaults to a randomly generated
+     * address.
+     */
+    from: import("@metamask/superstruct").Struct<`0x${string}`, null>;
+    /**
+     * The data to send with the transaction. The data may be specified as a
+     * `string`, an object, or an array of objects. This covers the data types
+     * for the supported signature methods. Defaults to `0x`.
+     */
+    data: import("@metamask/superstruct").Struct<`0x${string}` | Record<string, any> | Record<string, any>[], null>;
+    /**
+     * The signature method being used.
+     */
+    signatureMethod: import("@metamask/superstruct").Struct<"eth_signTypedData" | "personal_sign" | "eth_sign" | "eth_signTypedData_v3" | "eth_signTypedData_v4", null>;
+}>;
+export declare const SnapOptionsStruct: import("@metamask/superstruct").Struct<{
+    timeout?: number | undefined;
+}, {
+    /**
+     * The timeout in milliseconds to use for requests to the snap. Defaults to
+     * `1000`.
+     */
+    timeout: import("@metamask/superstruct").Struct<number | undefined, null>;
+}>;
+export declare const JsonRpcMockOptionsStruct: import("@metamask/superstruct").Struct<{
+    method: string;
+    result: import("@metamask/snaps-sdk").Json;
+}, {
+    method: import("@metamask/superstruct").Struct<string, null>;
+    result: import("@metamask/superstruct").Struct<import("@metamask/snaps-sdk").Json, unknown>;
+}>;
+export declare const InterfaceStruct: import("@metamask/superstruct").Struct<{
+    content?: import("@metamask/snaps-sdk/jsx").JSXElement | undefined;
+}, {
+    content: import("@metamask/superstruct").Struct<import("@metamask/snaps-sdk/jsx").JSXElement | undefined, null>;
+}>;
+export declare const SnapResponseWithoutInterfaceStruct: import("@metamask/superstruct").Struct<{
+    id: string;
+    notifications: {
+        type: "native" | "inApp";
+        message: string;
+        id: string;
+    }[];
+    response: {
+        result: import("@metamask/snaps-sdk").Json;
+    } | {
+        error: import("@metamask/snaps-sdk").Json;
+    };
+}, {
+    id: import("@metamask/superstruct").Struct<string, null>;
+    response: import("@metamask/superstruct").Struct<{
+        result: import("@metamask/snaps-sdk").Json;
+    } | {
+        error: import("@metamask/snaps-sdk").Json;
+    }, null>;
+    notifications: import("@metamask/superstruct").Struct<{
+        type: "native" | "inApp";
+        message: string;
+        id: string;
+    }[], import("@metamask/superstruct").Struct<{
+        type: "native" | "inApp";
+        message: string;
+        id: string;
+    }, {
+        id: import("@metamask/superstruct").Struct<string, null>;
+        message: import("@metamask/superstruct").Struct<string, null>;
+        type: import("@metamask/superstruct").Struct<"native" | "inApp", null>;
+    }>>;
+}>;
+export declare const SnapResponseWithInterfaceStruct: import("@metamask/superstruct").Struct<{
+    id: string;
+    notifications: {
+        type: "native" | "inApp";
+        message: string;
+        id: string;
+    }[];
+    response: {
+        result: import("@metamask/snaps-sdk").Json;
+    } | {
+        error: import("@metamask/snaps-sdk").Json;
+    };
+    getInterface: Function;
+}, {
+    getInterface: import("@metamask/superstruct").Struct<Function, null>;
+    id: import("@metamask/superstruct").Struct<string, null>;
+    notifications: import("@metamask/superstruct").Struct<{
+        type: "native" | "inApp";
+        message: string;
+        id: string;
+    }[], import("@metamask/superstruct").Struct<{
+        type: "native" | "inApp";
+        message: string;
+        id: string;
+    }, {
+        id: import("@metamask/superstruct").Struct<string, null>;
+        message: import("@metamask/superstruct").Struct<string, null>;
+        type: import("@metamask/superstruct").Struct<"native" | "inApp", null>;
+    }>>;
+    response: import("@metamask/superstruct").Struct<{
+        result: import("@metamask/snaps-sdk").Json;
+    } | {
+        error: import("@metamask/snaps-sdk").Json;
+    }, null>;
+}>;
+export declare const SnapResponseStruct: import("@metamask/superstruct").Struct<{
+    id: string;
+    notifications: {
+        type: "native" | "inApp";
+        message: string;
+        id: string;
+    }[];
+    response: {
+        result: import("@metamask/snaps-sdk").Json;
+    } | {
+        error: import("@metamask/snaps-sdk").Json;
+    };
+} | {
+    id: string;
+    notifications: {
+        type: "native" | "inApp";
+        message: string;
+        id: string;
+    }[];
+    response: {
+        result: import("@metamask/snaps-sdk").Json;
+    } | {
+        error: import("@metamask/snaps-sdk").Json;
+    };
+    getInterface: Function;
+}, null>;
+//# sourceMappingURL=structs.d.mts.map

package/dist/structs.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"structs.d.mts","sourceRoot":"","sources":["../src/structs.ts"],"names":[],"mappings":"AAoCA,eAAO,MAAM,wBAAwB;;;;;;;;;;;;IACnC;;OAEG;;IAGH;;OAEG;;IAGH;;;OAGG;;IAUH;;;OAGG;;IAUH;;;OAGG;;IAQH;;;OAGG;;IAQH;;;;OAIG;;IAQH;;;;OAIG;;IAQH;;;OAGG;;IAQH;;;OAGG;;EAOH,CAAC;AAEH,eAAO,MAAM,sBAAsB;;;;;;IACjC;;OAEG;;IAGH;;;OAGG;;IASH;;;;OAIG;;IAWH;;OAEG;;EAWH,CAAC;AAEH,eAAO,MAAM,iBAAiB;;;IAC5B;;;OAGG;;EAEH,CAAC;AAEH,eAAO,MAAM,wBAAwB;;;;;;EAGnC,CAAC;AAEH,eAAO,MAAM,eAAe;;;;EAE1B,CAAC;AAEH,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAsB7C,CAAC;AAEH,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAK3C,CAAC;AAEF,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;QAG7B,CAAC"}