@metamask/snaps-jest 8.4.0 → 8.6.0

package/dist/types/types.d.mts

@@ -1,393 +0,0 @@
-import type { NotificationType, EnumToUnion } from "@metamask/snaps-sdk";
-import type { JSXElement } from "@metamask/snaps-sdk/jsx";
-import type { SignatureOptionsStruct, SnapOptionsStruct, SnapResponseStruct, TransactionOptionsStruct } from "@metamask/snaps-simulation";
-import type { InferMatching } from "@metamask/snaps-utils";
-import type { Infer } from "@metamask/superstruct";
-import type { Json, JsonRpcId, JsonRpcParams } from "@metamask/utils";
-export type RequestOptions = {
-    /**
-     * The JSON-RPC request ID.
-     */
-    id?: JsonRpcId;
-    /**
-     * The JSON-RPC method.
-     */
-    method: string;
-    /**
-     * The JSON-RPC params.
-     */
-    params?: JsonRpcParams;
-    /**
-     * The origin to send the request from.
-     */
-    origin?: string;
-};
-/**
- * The `runCronjob` options. This is the same as {@link RequestOptions}, except
- * that it does not have an `origin` property.
- */
-export type CronjobOptions = Omit<RequestOptions, 'origin'>;
-/**
- * The options to use for transaction requests.
- *
- * @property chainId - The CAIP-2 chain ID to send the transaction on. Defaults
- * to `eip155:1`.
- * @property origin - The origin to send the transaction from. Defaults to
- * `metamask.io`.
- * @property from - The address to send the transaction from. Defaults to a
- * randomly generated address.
- * @property to - The address to send the transaction to. Defaults to a randomly
- * generated address.
- * @property value - The value to send with the transaction. Defaults to `0`.
- * @property data - The data to send with the transaction. Defaults to `0x`.
- * @property gasLimit - The gas limit to use for the transaction. Defaults to
- * `21_000`.
- * @property maxFeePerGas - The maximum fee per gas to use for the transaction.
- * Defaults to `1`.
- * @property maxPriorityFeePerGas - The maximum priority fee per gas to use for
- * the transaction. Defaults to `1`.
- * @property nonce - The nonce to use for the transaction. Defaults to `0`.
- */
-export type TransactionOptions = Infer<typeof TransactionOptionsStruct>;
-/**
- * The options to use for signature requests.
- *
- * @property origin - The origin to send the signature request from. Defaults to
- * `metamask.io`.
- * @property from - The address to send the signature from. Defaults to a
- * randomly generated address.
- * @property data - The data to sign. Defaults to `0x`.
- * @property signatureMethod - The signature method.
- */
-export type SignatureOptions = Infer<typeof SignatureOptionsStruct>;
-/**
- * The options to use for requests to the snap.
- *
- * @property timeout - The timeout in milliseconds to use. Defaults to `1000`.
- */
-export type SnapOptions = Infer<typeof SnapOptionsStruct>;
-/**
- * Options for uploading a file.
- *
- * @property fileName - The name of the file. By default, this is inferred from
- * the file path if it's a path, and defaults to an empty string if it's a
- * `Uint8Array`.
- * @property contentType - The content type of the file. By default, this is
- * inferred from the file name if it's a path, and defaults to
- * `application/octet-stream` if it's a `Uint8Array` or the content type cannot
- * be inferred from the file name.
- */
-export type FileOptions = {
-    fileName?: string;
-    contentType?: string;
-};
-export type SnapInterfaceActions = {
-    /**
-     * Click on an interface element.
-     *
-     * @param name - The element name to click.
-     */
-    clickElement(name: string): Promise<void>;
-    /**
-     * Type a value in a interface field.
-     *
-     * @param name - The element name to type in.
-     * @param value - The value to type.
-     */
-    typeInField(name: string, value: string): Promise<void>;
-    /**
-     * Select an option with a value in a dropdown.
-     *
-     * @param name - The element name to type in.
-     * @param value - The value to type.
-     */
-    selectInDropdown(name: string, value: string): Promise<void>;
-    /**
-     * Choose an option with a value from radio group.
-     *
-     * @param name - The element name to type in.
-     * @param value - The value to type.
-     */
-    selectFromRadioGroup(name: string, value: string): Promise<void>;
-    /**
-     * Choose an option with a value from Selector component.
-     *
-     * @param name - The element name to type in.
-     * @param value - The value to type.
-     */
-    selectFromSelector(name: string, value: string): Promise<void>;
-    /**
-     * Upload a file.
-     *
-     * @param name - The element name to upload the file to.
-     * @param file - The file to upload. This can be a path to a file or a
-     * `Uint8Array` containing the file contents. If this is a path, the file is
-     * resolved relative to the current working directory.
-     * @param options - The file options.
-     * @param options.fileName - The name of the file. By default, this is
-     * inferred from the file path if it's a path, and defaults to an empty string
-     * if it's a `Uint8Array`.
-     * @param options.contentType - The content type of the file. By default, this
-     * is inferred from the file name if it's a path, and defaults to
-     * `application/octet-stream` if it's a `Uint8Array` or the content type
-     * cannot be inferred from the file name.
-     */
-    uploadFile(name: string, file: string | Uint8Array, options?: FileOptions): Promise<void>;
-};
-/**
- * A `snap_dialog` alert interface.
- */
-export type SnapAlertInterface = {
-    /**
-     * The type of the interface. This is always `alert`.
-     */
-    type: 'alert';
-    /**
-     * The content to show in the alert.
-     */
-    content: JSXElement;
-    /**
-     * Close the alert.
-     */
-    ok(): Promise<void>;
-};
-/**
- * A `snap_dialog` confirmation interface.
- */
-export type SnapConfirmationInterface = {
-    /**
-     * The type of the interface. This is always `confirmation`.
-     */
-    type: 'confirmation';
-    /**
-     * The content to show in the confirmation.
-     */
-    content: JSXElement;
-    /**
-     * Close the confirmation.
-     */
-    ok(): Promise<void>;
-    /**
-     * Cancel the confirmation.
-     */
-    cancel(): Promise<void>;
-};
-/**
- * A `snap_dialog` prompt interface.
- */
-export type SnapPromptInterface = {
-    /**
-     * The type of the interface. This is always `prompt`.
-     */
-    type: 'prompt';
-    /**
-     * The content to show in the prompt.
-     */
-    content: JSXElement;
-    /**
-     * Close the prompt.
-     *
-     * @param value - The value to close the prompt with.
-     */
-    ok(value?: string): Promise<void>;
-    /**
-     * Cancel the prompt.
-     */
-    cancel(): Promise<void>;
-};
-/**
- * A `snap_dialog` default interface that has a Footer with two buttons defined.
- * The approval of this confirmation is handled by the snap.
- */
-export type DefaultSnapInterfaceWithFooter = {
-    /**
-     * The content to show in the interface.
-     */
-    content: JSXElement;
-};
-/**
- * A `snap_dialog` default interface that has a Footer with one button defined.
- * A cancel button is automatically applied to the interface in this case.
- */
-export type DefaultSnapInterfaceWithPartialFooter = DefaultSnapInterfaceWithFooter & {
-    /**
-     * Cancel the dialog.
-     */
-    cancel(): Promise<void>;
-};
-/**
- * A `snap_dialog` default interface that has no Footer defined.
- * A cancel and ok button is automatically applied to the interface in this case.
- */
-export type DefaultSnapInterfaceWithoutFooter = DefaultSnapInterfaceWithPartialFooter & {
-    /**
-     * Close the dialog.
-     *
-     */
-    ok(): Promise<void>;
-};
-export type DefaultSnapInterface = DefaultSnapInterfaceWithFooter | DefaultSnapInterfaceWithPartialFooter | DefaultSnapInterfaceWithoutFooter;
-export type SnapInterface = (SnapAlertInterface | SnapConfirmationInterface | SnapPromptInterface | DefaultSnapInterface) & SnapInterfaceActions;
-export type SnapRequestObject = {
-    /**
-     * Get a user interface object from a snap. This will throw an error if the
-     * snap does not show a user interface within the timeout.
-     *
-     * @param options - The options to use.
-     * @param options.timeout - The timeout in milliseconds to use. Defaults to
-     * `1000`.
-     * @returns The user interface object.
-     */
-    getInterface(options?: SnapOptions): Promise<SnapInterface>;
-};
-/**
- * A pending request object. This is a promise with extra
- * {@link SnapRequestObject} fields.
- */
-export type SnapRequest = Promise<SnapResponse> & SnapRequestObject;
-/**
- * The options to use for mocking a JSON-RPC request.
- */
-export type JsonRpcMockOptions = {
-    /**
-     * The JSON-RPC request method.
-     */
-    method: string;
-    /**
-     * The JSON-RPC response, which will be returned when a request with the
-     * specified method is sent.
-     */
-    result: Json;
-};
-/**
- * This is the main entry point to interact with the snap. It is returned by
- * {@link installSnap}, and has methods to send requests to the snap.
- *
- * @example
- * import { installSnap } from '@metamask/snaps-jest';
- *
- * const snap = await installSnap();
- * const response = await snap.request({ method: 'hello' });
- *
- * expect(response).toRespondWith('Hello, world!');
- */
-export type Snap = {
-    /**
-     * Send a JSON-RPC request to the snap.
-     *
-     * @param request - The request. This is similar to a JSON-RPC request, but
-     * has an extra `origin` field.
-     * @returns The response promise, with extra {@link SnapRequestObject} fields.
-     */
-    request(request: RequestOptions): SnapRequest;
-    /**
-     * Send a transaction to the snap.
-     *
-     * @param transaction - The transaction. This is similar to an Ethereum
-     * transaction object, but has an extra `origin` field. Any missing fields
-     * will be filled in with default values.
-     * @returns The response.
-     */
-    onTransaction(transaction?: Partial<TransactionOptions>): Promise<SnapResponseWithInterface>;
-    /**
-     * Send a transaction to the snap.
-     *
-     * @param transaction - The transaction. This is similar to an Ethereum
-     * transaction object, but has an extra `origin` field. Any missing fields
-     * will be filled in with default values.
-     * @returns The response.
-     * @deprecated Use {@link onTransaction} instead.
-     */
-    sendTransaction(transaction?: Partial<TransactionOptions>): Promise<SnapResponseWithInterface>;
-    /**
-     * Send a signature request to the snap.
-     *
-     * @param signature - The signature request object. Contains the params from
-     * the various signature methods, but has an extra `origin` and `signatureMethod` field.
-     * Any missing fields will be filled in with default values.
-     * @returns The response.
-     */
-    onSignature(signature?: Partial<SignatureOptions>): Promise<SnapResponseWithInterface>;
-    /**
-     * Run a cronjob in the snap. This is similar to {@link request}, but the
-     * request will be sent to the `onCronjob` method of the snap.
-     *
-     * @param cronjob - The cronjob request. This is similar to a JSON-RPC
-     * request, and is normally specified in the snap manifest, under the
-     * `endowment:cronjob` permission.
-     * @returns The response promise, with extra {@link SnapRequestObject} fields.
-     */
-    onCronjob(cronjob?: Partial<CronjobOptions>): SnapRequest;
-    /**
-     * Run a cronjob in the snap. This is similar to {@link request}, but the
-     * request will be sent to the `onCronjob` method of the snap.
-     *
-     * @param cronjob - The cronjob request. This is similar to a JSON-RPC
-     * request, and is normally specified in the snap manifest, under the
-     * `endowment:cronjob` permission.
-     * @returns The response promise, with extra {@link SnapRequestObject} fields.
-     * @deprecated Use {@link onCronjob} instead.
-     */
-    runCronjob(cronjob: CronjobOptions): SnapRequest;
-    /**
-     * Get the response from the snap's `onHomePage` method.
-     *
-     * @returns The response.
-     */
-    onHomePage(): Promise<SnapResponseWithInterface>;
-    /**
-     * Mock a JSON-RPC request. This will cause the snap to respond with the
-     * specified response when a request with the specified method is sent.
-     *
-     * @param mock - The mock options.
-     * @param mock.method - The JSON-RPC request method.
-     * @param mock.result - The JSON-RPC response, which will be returned when a
-     * request with the specified method is sent.
-     * @example
-     * import { installSnap } from '@metamask/snaps-jest';
-     *
-     * // In the test
-     * const snap = await installSnap();
-     * snap.mockJsonRpc({ method: 'eth_accounts', result: ['0x1234'] });
-     *
-     * // In the Snap
-     * const response =
-     *   await ethereum.request({ method: 'eth_accounts' }); // ['0x1234']
-     */
-    mockJsonRpc(mock: JsonRpcMockOptions): {
-        /**
-         * Remove the mock.
-         */
-        unmock(): void;
-    };
-    /**
-     * Close the page running the snap. This is mainly useful for cleaning up
-     * the test environment, and calling it is not strictly necessary.
-     *
-     * @returns A promise that resolves when the page is closed.
-     * @deprecated Snaps are now automatically closed when the test ends. This
-     * method will be removed in a future release.
-     */
-    close(): Promise<void>;
-};
-export type SnapHandlerInterface = {
-    content: JSXElement;
-} & SnapInterfaceActions;
-export type SnapResponseWithInterface = {
-    id: string;
-    response: {
-        result: Json;
-    } | {
-        error: Json;
-    };
-    notifications: {
-        id: string;
-        message: string;
-        type: EnumToUnion<NotificationType>;
-    }[];
-    getInterface(): SnapHandlerInterface;
-};
-export type SnapResponseWithoutInterface = Omit<SnapResponseWithInterface, 'getInterface'>;
-export type SnapResponseType = SnapResponseWithoutInterface | SnapResponseWithInterface;
-export type SnapResponse = InferMatching<typeof SnapResponseStruct, SnapResponseType>;
-//# sourceMappingURL=types.d.mts.map

package/dist/types/types.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.mts","sourceRoot":"","sources":["../../src/types/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,WAAW,EAAE,4BAA4B;AACzE,OAAO,KAAK,EAAE,UAAU,EAAE,gCAAgC;AAC1D,OAAO,KAAK,EACV,sBAAsB,EACtB,iBAAiB,EACjB,kBAAkB,EAClB,wBAAwB,EACzB,mCAAmC;AACpC,OAAO,KAAK,EAAE,aAAa,EAAE,8BAA8B;AAC3D,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AACnD,OAAO,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,aAAa,EAAE,wBAAwB;AAEtE,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,EAAE,CAAC,EAAE,SAAS,CAAC;IAEf;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,aAAa,CAAC;IAEvB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;AAE5D;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,MAAM,kBAAkB,GAAG,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAExE;;;;;;;;;GASG;AACH,MAAM,MAAM,gBAAgB,GAAG,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEpE;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE1D;;;;;;;;;;GAUG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC;;;;OAIG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1C;;;;;OAKG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExD;;;;;OAKG;IACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7D;;;;;OAKG;IACH,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjE;;;;;OAKG;IACH,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/D;;;;;;;;;;;;;;;OAeG;IACH,UAAU,CACR,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,GAAG,UAAU,EACzB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,IAAI,CAAC,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,OAAO,EAAE,UAAU,CAAC;IAEpB;;OAEG;IACH,EAAE,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;OAEG;IACH,OAAO,EAAE,UAAU,CAAC;IAEpB;;OAEG;IACH,EAAE,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpB;;OAEG;IACH,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACzB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,UAAU,CAAC;IAEpB;;;;OAIG;IACH,EAAE,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAElC;;OAEG;IACH,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACzB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,8BAA8B,GAAG;IAC3C;;OAEG;IACH,OAAO,EAAE,UAAU,CAAC;CACrB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,qCAAqC,GAC/C,8BAA8B,GAAG;IAC/B;;OAEG;IACH,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACzB,CAAC;AAEJ;;;GAGG;AACH,MAAM,MAAM,iCAAiC,GAC3C,qCAAqC,GAAG;IACtC;;;OAGG;IACH,EAAE,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACrB,CAAC;AAEJ,MAAM,MAAM,oBAAoB,GAC5B,8BAA8B,GAC9B,qCAAqC,GACrC,iCAAiC,CAAC;AAEtC,MAAM,MAAM,aAAa,GAAG,CACxB,kBAAkB,GAClB,yBAAyB,GACzB,mBAAmB,GACnB,oBAAoB,CACvB,GACC,oBAAoB,CAAC;AAEvB,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;;;;;;;OAQG;IACH,YAAY,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;CAC7D,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC,YAAY,CAAC,GAAG,iBAAiB,CAAC;AAEpE;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,MAAM,EAAE,IAAI,CAAC;CACd,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,IAAI,GAAG;IACjB;;;;;;OAMG;IACH,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,WAAW,CAAC;IAE9C;;;;;;;OAOG;IACH,aAAa,CACX,WAAW,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,GACxC,OAAO,CAAC,yBAAyB,CAAC,CAAC;IAEtC;;;;;;;;OAQG;IACH,eAAe,CACb,WAAW,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,GACxC,OAAO,CAAC,yBAAyB,CAAC,CAAC;IAEtC;;;;;;;OAOG;IACH,WAAW,CACT,SAAS,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC,GACpC,OAAO,CAAC,yBAAyB,CAAC,CAAC;IAEtC;;;;;;;;OAQG;IACH,SAAS,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,GAAG,WAAW,CAAC;IAE1D;;;;;;;;;OASG;IACH,UAAU,CAAC,OAAO,EAAE,cAAc,GAAG,WAAW,CAAC;IAEjD;;;;OAIG;IACH,UAAU,IAAI,OAAO,CAAC,yBAAyB,CAAC,CAAC;IAEjD;;;;;;;;;;;;;;;;;;OAkBG;IACH,WAAW,CAAC,IAAI,EAAE,kBAAkB,GAAG;QACrC;;WAEG;QACH,MAAM,IAAI,IAAI,CAAC;KAChB,CAAC;IAEF;;;;;;;OAOG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,OAAO,EAAE,UAAU,CAAC;CACrB,GAAG,oBAAoB,CAAC;AAEzB,MAAM,MAAM,yBAAyB,GAAG;IACtC,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE;QAAE,MAAM,EAAE,IAAI,CAAA;KAAE,GAAG;QAAE,KAAK,EAAE,IAAI,CAAA;KAAE,CAAC;IAC7C,aAAa,EAAE;QACb,EAAE,EAAE,MAAM,CAAC;QACX,OAAO,EAAE,MAAM,CAAC;QAChB,IAAI,EAAE,WAAW,CAAC,gBAAgB,CAAC,CAAC;KACrC,EAAE,CAAC;IACJ,YAAY,IAAI,oBAAoB,CAAC;CACtC,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG,IAAI,CAC7C,yBAAyB,EACzB,cAAc,CACf,CAAC;AAEF,MAAM,MAAM,gBAAgB,GACxB,4BAA4B,GAC5B,yBAAyB,CAAC;AAE9B,MAAM,MAAM,YAAY,GAAG,aAAa,CACtC,OAAO,kBAAkB,EACzB,gBAAgB,CACjB,CAAC"}

package/dist/types/types.mjs

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=types.mjs.map

package/dist/types/types.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.mjs","sourceRoot":"","sources":["../../src/types/types.ts"],"names":[],"mappings":"","sourcesContent":["import type { NotificationType, EnumToUnion } from '@metamask/snaps-sdk';\nimport type { JSXElement } from '@metamask/snaps-sdk/jsx';\nimport type {\n  SignatureOptionsStruct,\n  SnapOptionsStruct,\n  SnapResponseStruct,\n  TransactionOptionsStruct,\n} from '@metamask/snaps-simulation';\nimport type { InferMatching } from '@metamask/snaps-utils';\nimport type { Infer } from '@metamask/superstruct';\nimport type { Json, JsonRpcId, JsonRpcParams } from '@metamask/utils';\n\nexport type RequestOptions = {\n  /**\n   * The JSON-RPC request ID.\n   */\n  id?: JsonRpcId;\n\n  /**\n   * The JSON-RPC method.\n   */\n  method: string;\n\n  /**\n   * The JSON-RPC params.\n   */\n  params?: JsonRpcParams;\n\n  /**\n   * The origin to send the request from.\n   */\n  origin?: string;\n};\n\n/**\n * The `runCronjob` options. This is the same as {@link RequestOptions}, except\n * that it does not have an `origin` property.\n */\nexport type CronjobOptions = Omit<RequestOptions, 'origin'>;\n\n/**\n * The options to use for transaction requests.\n *\n * @property chainId - The CAIP-2 chain ID to send the transaction on. Defaults\n * to `eip155:1`.\n * @property origin - The origin to send the transaction from. Defaults to\n * `metamask.io`.\n * @property from - The address to send the transaction from. Defaults to a\n * randomly generated address.\n * @property to - The address to send the transaction to. Defaults to a randomly\n * generated address.\n * @property value - The value to send with the transaction. Defaults to `0`.\n * @property data - The data to send with the transaction. Defaults to `0x`.\n * @property gasLimit - The gas limit to use for the transaction. Defaults to\n * `21_000`.\n * @property maxFeePerGas - The maximum fee per gas to use for the transaction.\n * Defaults to `1`.\n * @property maxPriorityFeePerGas - The maximum priority fee per gas to use for\n * the transaction. Defaults to `1`.\n * @property nonce - The nonce to use for the transaction. Defaults to `0`.\n */\nexport type TransactionOptions = Infer<typeof TransactionOptionsStruct>;\n\n/**\n * The options to use for signature requests.\n *\n * @property origin - The origin to send the signature request from. Defaults to\n * `metamask.io`.\n * @property from - The address to send the signature from. Defaults to a\n * randomly generated address.\n * @property data - The data to sign. Defaults to `0x`.\n * @property signatureMethod - The signature method.\n */\nexport type SignatureOptions = Infer<typeof SignatureOptionsStruct>;\n\n/**\n * The options to use for requests to the snap.\n *\n * @property timeout - The timeout in milliseconds to use. Defaults to `1000`.\n */\nexport type SnapOptions = Infer<typeof SnapOptionsStruct>;\n\n/**\n * Options for uploading a file.\n *\n * @property fileName - The name of the file. By default, this is inferred from\n * the file path if it's a path, and defaults to an empty string if it's a\n * `Uint8Array`.\n * @property contentType - The content type of the file. By default, this is\n * inferred from the file name if it's a path, and defaults to\n * `application/octet-stream` if it's a `Uint8Array` or the content type cannot\n * be inferred from the file name.\n */\nexport type FileOptions = {\n  fileName?: string;\n  contentType?: string;\n};\n\nexport type SnapInterfaceActions = {\n  /**\n   * Click on an interface element.\n   *\n   * @param name - The element name to click.\n   */\n  clickElement(name: string): Promise<void>;\n\n  /**\n   * Type a value in a interface field.\n   *\n   * @param name - The element name to type in.\n   * @param value - The value to type.\n   */\n  typeInField(name: string, value: string): Promise<void>;\n\n  /**\n   * Select an option with a value in a dropdown.\n   *\n   * @param name - The element name to type in.\n   * @param value - The value to type.\n   */\n  selectInDropdown(name: string, value: string): Promise<void>;\n\n  /**\n   * Choose an option with a value from radio group.\n   *\n   * @param name - The element name to type in.\n   * @param value - The value to type.\n   */\n  selectFromRadioGroup(name: string, value: string): Promise<void>;\n\n  /**\n   * Choose an option with a value from Selector component.\n   *\n   * @param name - The element name to type in.\n   * @param value - The value to type.\n   */\n  selectFromSelector(name: string, value: string): Promise<void>;\n\n  /**\n   * Upload a file.\n   *\n   * @param name - The element name to upload the file to.\n   * @param file - The file to upload. This can be a path to a file or a\n   * `Uint8Array` containing the file contents. If this is a path, the file is\n   * resolved relative to the current working directory.\n   * @param options - The file options.\n   * @param options.fileName - The name of the file. By default, this is\n   * inferred from the file path if it's a path, and defaults to an empty string\n   * if it's a `Uint8Array`.\n   * @param options.contentType - The content type of the file. By default, this\n   * is inferred from the file name if it's a path, and defaults to\n   * `application/octet-stream` if it's a `Uint8Array` or the content type\n   * cannot be inferred from the file name.\n   */\n  uploadFile(\n    name: string,\n    file: string | Uint8Array,\n    options?: FileOptions,\n  ): Promise<void>;\n};\n\n/**\n * A `snap_dialog` alert interface.\n */\nexport type SnapAlertInterface = {\n  /**\n   * The type of the interface. This is always `alert`.\n   */\n  type: 'alert';\n\n  /**\n   * The content to show in the alert.\n   */\n  content: JSXElement;\n\n  /**\n   * Close the alert.\n   */\n  ok(): Promise<void>;\n};\n\n/**\n * A `snap_dialog` confirmation interface.\n */\nexport type SnapConfirmationInterface = {\n  /**\n   * The type of the interface. This is always `confirmation`.\n   */\n  type: 'confirmation';\n\n  /**\n   * The content to show in the confirmation.\n   */\n  content: JSXElement;\n\n  /**\n   * Close the confirmation.\n   */\n  ok(): Promise<void>;\n\n  /**\n   * Cancel the confirmation.\n   */\n  cancel(): Promise<void>;\n};\n\n/**\n * A `snap_dialog` prompt interface.\n */\nexport type SnapPromptInterface = {\n  /**\n   * The type of the interface. This is always `prompt`.\n   */\n  type: 'prompt';\n\n  /**\n   * The content to show in the prompt.\n   */\n  content: JSXElement;\n\n  /**\n   * Close the prompt.\n   *\n   * @param value - The value to close the prompt with.\n   */\n  ok(value?: string): Promise<void>;\n\n  /**\n   * Cancel the prompt.\n   */\n  cancel(): Promise<void>;\n};\n\n/**\n * A `snap_dialog` default interface that has a Footer with two buttons defined.\n * The approval of this confirmation is handled by the snap.\n */\nexport type DefaultSnapInterfaceWithFooter = {\n  /**\n   * The content to show in the interface.\n   */\n  content: JSXElement;\n};\n\n/**\n * A `snap_dialog` default interface that has a Footer with one button defined.\n * A cancel button is automatically applied to the interface in this case.\n */\nexport type DefaultSnapInterfaceWithPartialFooter =\n  DefaultSnapInterfaceWithFooter & {\n    /**\n     * Cancel the dialog.\n     */\n    cancel(): Promise<void>;\n  };\n\n/**\n * A `snap_dialog` default interface that has no Footer defined.\n * A cancel and ok button is automatically applied to the interface in this case.\n */\nexport type DefaultSnapInterfaceWithoutFooter =\n  DefaultSnapInterfaceWithPartialFooter & {\n    /**\n     * Close the dialog.\n     *\n     */\n    ok(): Promise<void>;\n  };\n\nexport type DefaultSnapInterface =\n  | DefaultSnapInterfaceWithFooter\n  | DefaultSnapInterfaceWithPartialFooter\n  | DefaultSnapInterfaceWithoutFooter;\n\nexport type SnapInterface = (\n  | SnapAlertInterface\n  | SnapConfirmationInterface\n  | SnapPromptInterface\n  | DefaultSnapInterface\n) &\n  SnapInterfaceActions;\n\nexport type SnapRequestObject = {\n  /**\n   * Get a user interface object from a snap. This will throw an error if the\n   * snap does not show a user interface within the timeout.\n   *\n   * @param options - The options to use.\n   * @param options.timeout - The timeout in milliseconds to use. Defaults to\n   * `1000`.\n   * @returns The user interface object.\n   */\n  getInterface(options?: SnapOptions): Promise<SnapInterface>;\n};\n\n/**\n * A pending request object. This is a promise with extra\n * {@link SnapRequestObject} fields.\n */\nexport type SnapRequest = Promise<SnapResponse> & SnapRequestObject;\n\n/**\n * The options to use for mocking a JSON-RPC request.\n */\nexport type JsonRpcMockOptions = {\n  /**\n   * The JSON-RPC request method.\n   */\n  method: string;\n\n  /**\n   * The JSON-RPC response, which will be returned when a request with the\n   * specified method is sent.\n   */\n  result: Json;\n};\n\n/**\n * This is the main entry point to interact with the snap. It is returned by\n * {@link installSnap}, and has methods to send requests to the snap.\n *\n * @example\n * import { installSnap } from '@metamask/snaps-jest';\n *\n * const snap = await installSnap();\n * const response = await snap.request({ method: 'hello' });\n *\n * expect(response).toRespondWith('Hello, world!');\n */\nexport type Snap = {\n  /**\n   * Send a JSON-RPC request to the snap.\n   *\n   * @param request - The request. This is similar to a JSON-RPC request, but\n   * has an extra `origin` field.\n   * @returns The response promise, with extra {@link SnapRequestObject} fields.\n   */\n  request(request: RequestOptions): SnapRequest;\n\n  /**\n   * Send a transaction to the snap.\n   *\n   * @param transaction - The transaction. This is similar to an Ethereum\n   * transaction object, but has an extra `origin` field. Any missing fields\n   * will be filled in with default values.\n   * @returns The response.\n   */\n  onTransaction(\n    transaction?: Partial<TransactionOptions>,\n  ): Promise<SnapResponseWithInterface>;\n\n  /**\n   * Send a transaction to the snap.\n   *\n   * @param transaction - The transaction. This is similar to an Ethereum\n   * transaction object, but has an extra `origin` field. Any missing fields\n   * will be filled in with default values.\n   * @returns The response.\n   * @deprecated Use {@link onTransaction} instead.\n   */\n  sendTransaction(\n    transaction?: Partial<TransactionOptions>,\n  ): Promise<SnapResponseWithInterface>;\n\n  /**\n   * Send a signature request to the snap.\n   *\n   * @param signature - The signature request object. Contains the params from\n   * the various signature methods, but has an extra `origin` and `signatureMethod` field.\n   * Any missing fields will be filled in with default values.\n   * @returns The response.\n   */\n  onSignature(\n    signature?: Partial<SignatureOptions>,\n  ): Promise<SnapResponseWithInterface>;\n\n  /**\n   * Run a cronjob in the snap. This is similar to {@link request}, but the\n   * request will be sent to the `onCronjob` method of the snap.\n   *\n   * @param cronjob - The cronjob request. This is similar to a JSON-RPC\n   * request, and is normally specified in the snap manifest, under the\n   * `endowment:cronjob` permission.\n   * @returns The response promise, with extra {@link SnapRequestObject} fields.\n   */\n  onCronjob(cronjob?: Partial<CronjobOptions>): SnapRequest;\n\n  /**\n   * Run a cronjob in the snap. This is similar to {@link request}, but the\n   * request will be sent to the `onCronjob` method of the snap.\n   *\n   * @param cronjob - The cronjob request. This is similar to a JSON-RPC\n   * request, and is normally specified in the snap manifest, under the\n   * `endowment:cronjob` permission.\n   * @returns The response promise, with extra {@link SnapRequestObject} fields.\n   * @deprecated Use {@link onCronjob} instead.\n   */\n  runCronjob(cronjob: CronjobOptions): SnapRequest;\n\n  /**\n   * Get the response from the snap's `onHomePage` method.\n   *\n   * @returns The response.\n   */\n  onHomePage(): Promise<SnapResponseWithInterface>;\n\n  /**\n   * Mock a JSON-RPC request. This will cause the snap to respond with the\n   * specified response when a request with the specified method is sent.\n   *\n   * @param mock - The mock options.\n   * @param mock.method - The JSON-RPC request method.\n   * @param mock.result - The JSON-RPC response, which will be returned when a\n   * request with the specified method is sent.\n   * @example\n   * import { installSnap } from '@metamask/snaps-jest';\n   *\n   * // In the test\n   * const snap = await installSnap();\n   * snap.mockJsonRpc({ method: 'eth_accounts', result: ['0x1234'] });\n   *\n   * // In the Snap\n   * const response =\n   *   await ethereum.request({ method: 'eth_accounts' }); // ['0x1234']\n   */\n  mockJsonRpc(mock: JsonRpcMockOptions): {\n    /**\n     * Remove the mock.\n     */\n    unmock(): void;\n  };\n\n  /**\n   * Close the page running the snap. This is mainly useful for cleaning up\n   * the test environment, and calling it is not strictly necessary.\n   *\n   * @returns A promise that resolves when the page is closed.\n   * @deprecated Snaps are now automatically closed when the test ends. This\n   * method will be removed in a future release.\n   */\n  close(): Promise<void>;\n};\n\nexport type SnapHandlerInterface = {\n  content: JSXElement;\n} & SnapInterfaceActions;\n\nexport type SnapResponseWithInterface = {\n  id: string;\n  response: { result: Json } | { error: Json };\n  notifications: {\n    id: string;\n    message: string;\n    type: EnumToUnion<NotificationType>;\n  }[];\n  getInterface(): SnapHandlerInterface;\n};\n\nexport type SnapResponseWithoutInterface = Omit<\n  SnapResponseWithInterface,\n  'getInterface'\n>;\n\nexport type SnapResponseType =\n  | SnapResponseWithoutInterface\n  | SnapResponseWithInterface;\n\nexport type SnapResponse = InferMatching<\n  typeof SnapResponseStruct,\n  SnapResponseType\n>;\n"]}