@metamask/snaps-sdk 10.3.0 → 11.0.0

package/dist/types/methods/get-file.d.mts

@@ -8,17 +8,21 @@ export declare enum AuxiliaryFileEncoding {
     Utf8 = "utf8"
 }
 /**
- * The request parameters for the `snap_getFile` method.
- *
- * @property path - The path to the file to retrieve.
- * @property encoding - The encoding to use when retrieving the file.
+ * An object containing the parameters for the `snap_getFile` method.
  */
 export type GetFileParams = {
+    /**
+     * The path to the file, relative to the Snap's package directory
+     * (that is, one level above `src`).
+     */
     path: string;
+    /**
+     * The encoding to use when retrieving the file. Defaults to `base64`.
+     */
     encoding?: EnumToUnion<AuxiliaryFileEncoding>;
 };
 /**
- * The result returned by the `snap_getFile` method.
+ * The file content as a string in the requested encoding.
  */
 export type GetFileResult = string;
 //# sourceMappingURL=get-file.d.mts.map

package/dist/types/methods/get-file.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"get-file.d.mts","sourceRoot":"","sources":["../../../src/types/methods/get-file.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,kCAAwB;AAEnD;;GAEG;AACH,oBAAY,qBAAqB;IAC/B,MAAM,WAAW;IACjB,GAAG,QAAQ;IACX,IAAI,SAAS;CACd;AAED;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,WAAW,CAAC,qBAAqB,CAAC,CAAC;CAC/C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC"}
+{"version":3,"file":"get-file.d.mts","sourceRoot":"","sources":["../../../src/types/methods/get-file.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,kCAAwB;AAEnD;;GAEG;AACH,oBAAY,qBAAqB;IAC/B,MAAM,WAAW;IACjB,GAAG,QAAQ;IACX,IAAI,SAAS;CACd;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,CAAC,EAAE,WAAW,CAAC,qBAAqB,CAAC,CAAC;CAC/C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC"}

package/dist/types/methods/get-file.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"get-file.mjs","sourceRoot":"","sources":["../../../src/types/methods/get-file.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,CAAN,IAAY,qBAIX;AAJD,WAAY,qBAAqB;IAC/B,0CAAiB,CAAA;IACjB,oCAAW,CAAA;IACX,sCAAa,CAAA;AACf,CAAC,EAJW,qBAAqB,KAArB,qBAAqB,QAIhC","sourcesContent":["import type { EnumToUnion } from '../../internals';\n\n/**\n * The encoding to use when retrieving the file. Defaults to `Base64`.\n */\nexport enum AuxiliaryFileEncoding {\n  Base64 = 'base64',\n  Hex = 'hex',\n  Utf8 = 'utf8',\n}\n\n/**\n * The request parameters for the `snap_getFile` method.\n *\n * @property path - The path to the file to retrieve.\n * @property encoding - The encoding to use when retrieving the file.\n */\nexport type GetFileParams = {\n  path: string;\n  encoding?: EnumToUnion<AuxiliaryFileEncoding>;\n};\n\n/**\n * The result returned by the `snap_getFile` method.\n */\nexport type GetFileResult = string;\n"]}
+{"version":3,"file":"get-file.mjs","sourceRoot":"","sources":["../../../src/types/methods/get-file.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,CAAN,IAAY,qBAIX;AAJD,WAAY,qBAAqB;IAC/B,0CAAiB,CAAA;IACjB,oCAAW,CAAA;IACX,sCAAa,CAAA;AACf,CAAC,EAJW,qBAAqB,KAArB,qBAAqB,QAIhC","sourcesContent":["import type { EnumToUnion } from '../../internals';\n\n/**\n * The encoding to use when retrieving the file. Defaults to `Base64`.\n */\nexport enum AuxiliaryFileEncoding {\n  Base64 = 'base64',\n  Hex = 'hex',\n  Utf8 = 'utf8',\n}\n\n/**\n * An object containing the parameters for the `snap_getFile` method.\n */\nexport type GetFileParams = {\n  /**\n   * The path to the file, relative to the Snap's package directory\n   * (that is, one level above `src`).\n   */\n  path: string;\n\n  /**\n   * The encoding to use when retrieving the file. Defaults to `base64`.\n   */\n  encoding?: EnumToUnion<AuxiliaryFileEncoding>;\n};\n\n/**\n * The file content as a string in the requested encoding.\n */\nexport type GetFileResult = string;\n"]}

package/dist/types/methods/get-interface-context.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"get-interface-context.cjs","sourceRoot":"","sources":["../../../src/types/methods/get-interface-context.ts"],"names":[],"mappings":"","sourcesContent":["import type { InterfaceContext } from '../interface';\n\n/**\n * The request parameters for the `snap_getInterfaceContext` method.\n *\n * @property id - The interface id.\n */\nexport type GetInterfaceContextParams = {\n  id: string;\n};\n\n/**\n * The result returned by the `snap_getInterfaceContext` method, which is the context for a given interface.\n */\nexport type GetInterfaceContextResult = InterfaceContext | null;\n"]}
+{"version":3,"file":"get-interface-context.cjs","sourceRoot":"","sources":["../../../src/types/methods/get-interface-context.ts"],"names":[],"mappings":"","sourcesContent":["import type { InterfaceContext } from '../interface';\n\n/**\n * An object containing the parameters for the `snap_getInterfaceContext`\n * method.\n *\n * @property id - The interface ID.\n */\nexport type GetInterfaceContextParams = {\n  id: string;\n};\n\n/**\n * The context for the given interface. May be `null` if no context was provided\n * when the interface was created.\n */\nexport type GetInterfaceContextResult = InterfaceContext | null;\n"]}

package/dist/types/methods/get-interface-context.d.cts

@@ -1,14 +1,16 @@
 import type { InterfaceContext } from "../interface.cjs";
 /**
- * The request parameters for the `snap_getInterfaceContext` method.
+ * An object containing the parameters for the `snap_getInterfaceContext`
+ * method.
  *
- * @property id - The interface id.
+ * @property id - The interface ID.
  */
 export type GetInterfaceContextParams = {
     id: string;
 };
 /**
- * The result returned by the `snap_getInterfaceContext` method, which is the context for a given interface.
+ * The context for the given interface. May be `null` if no context was provided
+ * when the interface was created.
  */
 export type GetInterfaceContextResult = InterfaceContext | null;
 //# sourceMappingURL=get-interface-context.d.cts.map

package/dist/types/methods/get-interface-context.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"get-interface-context.d.cts","sourceRoot":"","sources":["../../../src/types/methods/get-interface-context.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,yBAAqB;AAErD;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,gBAAgB,GAAG,IAAI,CAAC"}
+{"version":3,"file":"get-interface-context.d.cts","sourceRoot":"","sources":["../../../src/types/methods/get-interface-context.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,yBAAqB;AAErD;;;;;GAKG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,yBAAyB,GAAG,gBAAgB,GAAG,IAAI,CAAC"}

package/dist/types/methods/get-interface-context.d.mts

@@ -1,14 +1,16 @@
 import type { InterfaceContext } from "../interface.mjs";
 /**
- * The request parameters for the `snap_getInterfaceContext` method.
+ * An object containing the parameters for the `snap_getInterfaceContext`
+ * method.
  *
- * @property id - The interface id.
+ * @property id - The interface ID.
  */
 export type GetInterfaceContextParams = {
     id: string;
 };
 /**
- * The result returned by the `snap_getInterfaceContext` method, which is the context for a given interface.
+ * The context for the given interface. May be `null` if no context was provided
+ * when the interface was created.
  */
 export type GetInterfaceContextResult = InterfaceContext | null;
 //# sourceMappingURL=get-interface-context.d.mts.map

package/dist/types/methods/get-interface-context.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"get-interface-context.d.mts","sourceRoot":"","sources":["../../../src/types/methods/get-interface-context.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,yBAAqB;AAErD;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,gBAAgB,GAAG,IAAI,CAAC"}
+{"version":3,"file":"get-interface-context.d.mts","sourceRoot":"","sources":["../../../src/types/methods/get-interface-context.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,yBAAqB;AAErD;;;;;GAKG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,yBAAyB,GAAG,gBAAgB,GAAG,IAAI,CAAC"}

package/dist/types/methods/get-interface-context.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"get-interface-context.mjs","sourceRoot":"","sources":["../../../src/types/methods/get-interface-context.ts"],"names":[],"mappings":"","sourcesContent":["import type { InterfaceContext } from '../interface';\n\n/**\n * The request parameters for the `snap_getInterfaceContext` method.\n *\n * @property id - The interface id.\n */\nexport type GetInterfaceContextParams = {\n  id: string;\n};\n\n/**\n * The result returned by the `snap_getInterfaceContext` method, which is the context for a given interface.\n */\nexport type GetInterfaceContextResult = InterfaceContext | null;\n"]}
+{"version":3,"file":"get-interface-context.mjs","sourceRoot":"","sources":["../../../src/types/methods/get-interface-context.ts"],"names":[],"mappings":"","sourcesContent":["import type { InterfaceContext } from '../interface';\n\n/**\n * An object containing the parameters for the `snap_getInterfaceContext`\n * method.\n *\n * @property id - The interface ID.\n */\nexport type GetInterfaceContextParams = {\n  id: string;\n};\n\n/**\n * The context for the given interface. May be `null` if no context was provided\n * when the interface was created.\n */\nexport type GetInterfaceContextResult = InterfaceContext | null;\n"]}

package/dist/types/methods/get-interface-state.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"get-interface-state.cjs","sourceRoot":"","sources":["../../../src/types/methods/get-interface-state.ts"],"names":[],"mappings":"","sourcesContent":["import type { InterfaceState } from '../interface';\n\n/**\n * The request parameters for the `snap_getInterfaceState` method.\n *\n * @property id - The interface id.\n */\nexport type GetInterfaceStateParams = {\n  id: string;\n};\n\n/**\n * The result returned by the `snap_getInterfaceState` method, which is the state of the interface.\n */\nexport type GetInterfaceStateResult = InterfaceState;\n"]}
+{"version":3,"file":"get-interface-state.cjs","sourceRoot":"","sources":["../../../src/types/methods/get-interface-state.ts"],"names":[],"mappings":"","sourcesContent":["import type { InterfaceState } from '../interface';\n\n/**\n * An object containing the parameters for the `snap_getInterfaceState` method.\n *\n * @property id - The interface ID.\n */\nexport type GetInterfaceStateParams = {\n  id: string;\n};\n\n/**\n * The state of the given interface. This is a `Record` of the form state, where\n * the keys are the `name` properties of the form fields, and the values are the\n * current values of those fields, depending on the type of the field.\n *\n * For example, for a text field, the value would be a `string`, for a checkbox\n * field, the value would be a `boolean`, and for a file upload field, the value\n * would be a `File` object. The exact structure of the state depends on the\n * form fields that were defined when the interface was created.\n */\nexport type GetInterfaceStateResult = InterfaceState;\n"]}

package/dist/types/methods/get-interface-state.d.cts

@@ -1,14 +1,21 @@
 import type { InterfaceState } from "../interface.cjs";
 /**
- * The request parameters for the `snap_getInterfaceState` method.
+ * An object containing the parameters for the `snap_getInterfaceState` method.
  *
- * @property id - The interface id.
+ * @property id - The interface ID.
  */
 export type GetInterfaceStateParams = {
     id: string;
 };
 /**
- * The result returned by the `snap_getInterfaceState` method, which is the state of the interface.
+ * The state of the given interface. This is a `Record` of the form state, where
+ * the keys are the `name` properties of the form fields, and the values are the
+ * current values of those fields, depending on the type of the field.
+ *
+ * For example, for a text field, the value would be a `string`, for a checkbox
+ * field, the value would be a `boolean`, and for a file upload field, the value
+ * would be a `File` object. The exact structure of the state depends on the
+ * form fields that were defined when the interface was created.
  */
 export type GetInterfaceStateResult = InterfaceState;
 //# sourceMappingURL=get-interface-state.d.cts.map

package/dist/types/methods/get-interface-state.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"get-interface-state.d.cts","sourceRoot":"","sources":["../../../src/types/methods/get-interface-state.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,yBAAqB;AAEnD;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,cAAc,CAAC"}
+{"version":3,"file":"get-interface-state.d.cts","sourceRoot":"","sources":["../../../src/types/methods/get-interface-state.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,yBAAqB;AAEnD;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,uBAAuB,GAAG,cAAc,CAAC"}

package/dist/types/methods/get-interface-state.d.mts

@@ -1,14 +1,21 @@
 import type { InterfaceState } from "../interface.mjs";
 /**
- * The request parameters for the `snap_getInterfaceState` method.
+ * An object containing the parameters for the `snap_getInterfaceState` method.
  *
- * @property id - The interface id.
+ * @property id - The interface ID.
  */
 export type GetInterfaceStateParams = {
     id: string;
 };
 /**
- * The result returned by the `snap_getInterfaceState` method, which is the state of the interface.
+ * The state of the given interface. This is a `Record` of the form state, where
+ * the keys are the `name` properties of the form fields, and the values are the
+ * current values of those fields, depending on the type of the field.
+ *
+ * For example, for a text field, the value would be a `string`, for a checkbox
+ * field, the value would be a `boolean`, and for a file upload field, the value
+ * would be a `File` object. The exact structure of the state depends on the
+ * form fields that were defined when the interface was created.
  */
 export type GetInterfaceStateResult = InterfaceState;
 //# sourceMappingURL=get-interface-state.d.mts.map

package/dist/types/methods/get-interface-state.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"get-interface-state.d.mts","sourceRoot":"","sources":["../../../src/types/methods/get-interface-state.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,yBAAqB;AAEnD;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,cAAc,CAAC"}
+{"version":3,"file":"get-interface-state.d.mts","sourceRoot":"","sources":["../../../src/types/methods/get-interface-state.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,yBAAqB;AAEnD;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,uBAAuB,GAAG,cAAc,CAAC"}

package/dist/types/methods/get-interface-state.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"get-interface-state.mjs","sourceRoot":"","sources":["../../../src/types/methods/get-interface-state.ts"],"names":[],"mappings":"","sourcesContent":["import type { InterfaceState } from '../interface';\n\n/**\n * The request parameters for the `snap_getInterfaceState` method.\n *\n * @property id - The interface id.\n */\nexport type GetInterfaceStateParams = {\n  id: string;\n};\n\n/**\n * The result returned by the `snap_getInterfaceState` method, which is the state of the interface.\n */\nexport type GetInterfaceStateResult = InterfaceState;\n"]}
+{"version":3,"file":"get-interface-state.mjs","sourceRoot":"","sources":["../../../src/types/methods/get-interface-state.ts"],"names":[],"mappings":"","sourcesContent":["import type { InterfaceState } from '../interface';\n\n/**\n * An object containing the parameters for the `snap_getInterfaceState` method.\n *\n * @property id - The interface ID.\n */\nexport type GetInterfaceStateParams = {\n  id: string;\n};\n\n/**\n * The state of the given interface. This is a `Record` of the form state, where\n * the keys are the `name` properties of the form fields, and the values are the\n * current values of those fields, depending on the type of the field.\n *\n * For example, for a text field, the value would be a `string`, for a checkbox\n * field, the value would be a `boolean`, and for a file upload field, the value\n * would be a `File` object. The exact structure of the state depends on the\n * form fields that were defined when the interface was created.\n */\nexport type GetInterfaceStateResult = InterfaceState;\n"]}

package/dist/types/methods/get-locale.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"get-locale.cjs","sourceRoot":"","sources":["../../../src/types/methods/get-locale.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * The request parameters for the `snap_getLocale` method.\n *\n * This method does not accept any parameters.\n */\nexport type GetLocaleParams = never;\n\n/**\n * The result returned by the `snap_getLocale` method.\n *\n * It is the locale of the user's MetaMask extension.\n */\nexport type GetLocaleResult = string;\n"]}
+{"version":3,"file":"get-locale.cjs","sourceRoot":"","sources":["../../../src/types/methods/get-locale.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * This method does not accept any parameters.\n */\nexport type GetLocaleParams = never;\n\n/**\n * The user's locale setting as a [language code](https://github.com/MetaMask/metamask-extension/blob/develop/app/_locales/index.json).\n */\nexport type GetLocaleResult = string;\n"]}

package/dist/types/methods/get-locale.d.cts

@@ -1,13 +1,9 @@
 /**
- * The request parameters for the `snap_getLocale` method.
- *
  * This method does not accept any parameters.
  */
 export type GetLocaleParams = never;
 /**
- * The result returned by the `snap_getLocale` method.
- *
- * It is the locale of the user's MetaMask extension.
+ * The user's locale setting as a [language code](https://github.com/MetaMask/metamask-extension/blob/develop/app/_locales/index.json).
  */
 export type GetLocaleResult = string;
 //# sourceMappingURL=get-locale.d.cts.map

package/dist/types/methods/get-locale.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"get-locale.d.cts","sourceRoot":"","sources":["../../../src/types/methods/get-locale.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,KAAK,CAAC;AAEpC;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC"}
+{"version":3,"file":"get-locale.d.cts","sourceRoot":"","sources":["../../../src/types/methods/get-locale.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,KAAK,CAAC;AAEpC;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC"}

package/dist/types/methods/get-locale.d.mts

@@ -1,13 +1,9 @@
 /**
- * The request parameters for the `snap_getLocale` method.
- *
  * This method does not accept any parameters.
  */
 export type GetLocaleParams = never;
 /**
- * The result returned by the `snap_getLocale` method.
- *
- * It is the locale of the user's MetaMask extension.
+ * The user's locale setting as a [language code](https://github.com/MetaMask/metamask-extension/blob/develop/app/_locales/index.json).
  */
 export type GetLocaleResult = string;
 //# sourceMappingURL=get-locale.d.mts.map

package/dist/types/methods/get-locale.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"get-locale.d.mts","sourceRoot":"","sources":["../../../src/types/methods/get-locale.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,KAAK,CAAC;AAEpC;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC"}
+{"version":3,"file":"get-locale.d.mts","sourceRoot":"","sources":["../../../src/types/methods/get-locale.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,KAAK,CAAC;AAEpC;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC"}

package/dist/types/methods/get-locale.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"get-locale.mjs","sourceRoot":"","sources":["../../../src/types/methods/get-locale.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * The request parameters for the `snap_getLocale` method.\n *\n * This method does not accept any parameters.\n */\nexport type GetLocaleParams = never;\n\n/**\n * The result returned by the `snap_getLocale` method.\n *\n * It is the locale of the user's MetaMask extension.\n */\nexport type GetLocaleResult = string;\n"]}
+{"version":3,"file":"get-locale.mjs","sourceRoot":"","sources":["../../../src/types/methods/get-locale.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * This method does not accept any parameters.\n */\nexport type GetLocaleParams = never;\n\n/**\n * The user's locale setting as a [language code](https://github.com/MetaMask/metamask-extension/blob/develop/app/_locales/index.json).\n */\nexport type GetLocaleResult = string;\n"]}

package/dist/types/methods/get-preferences.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"get-preferences.cjs","sourceRoot":"","sources":["../../../src/types/methods/get-preferences.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * The request parameters for the `snap_getPreferences` method.\n *\n * This method does not accept any parameters.\n */\nexport type GetPreferencesParams = never;\n\n/**\n * The result returned by the `snap_getPreferences` method.\n *\n * It is the user selected preferences from the MetaMask client.\n *\n * @property locale - The user's selected locale.\n * @property currency - The user's selected currency.\n * @property hideBalances - Whether the user has chosen to hide balances.\n * @property useSecurityAlerts - Whether to run transactions and signatures through security providers.\n * @property simulateOnChainActions - Whether to simulate transactions and signatures.\n * @property useTokenDetection - Whether to auto-detect tokens.\n * @property batchCheckBalances - Whether to fetch balances in an aggregated manner.\n * @property displayNftMedia - Whether to display NFT media.\n * @property useNftDetection - Whether to auto-detect NFTs.\n * @property useExternalPricingData - Whether to get token price data from an external source.\n * @property showTestnets - Whether to show testnets.\n */\nexport type GetPreferencesResult = {\n  locale: string;\n  currency: string;\n  hideBalances: boolean;\n  useSecurityAlerts: boolean;\n  simulateOnChainActions: boolean;\n  useTokenDetection: boolean;\n  batchCheckBalances: boolean;\n  displayNftMedia: boolean;\n  useNftDetection: boolean;\n  useExternalPricingData: boolean;\n  showTestnets: boolean;\n};\n"]}
+{"version":3,"file":"get-preferences.cjs","sourceRoot":"","sources":["../../../src/types/methods/get-preferences.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * This method does not accept any parameters.\n */\nexport type GetPreferencesParams = never;\n\n/**\n * An object containing the user's MetaMask preferences.\n */\nexport type GetPreferencesResult = {\n  /**\n   * The user's locale setting as a [language\n   * code](https://github.com/MetaMask/metamask-extension/blob/main/app/_locales/index.json).\n   */\n  locale: string;\n\n  /**\n   * The user's preferred fiat currency code (e.g., `\"usd\"`, `\"eur\"`).\n   */\n  currency: string;\n\n  /**\n   * Whether the user has chosen to hide balances in the MetaMask UI.\n   */\n  hideBalances: boolean;\n\n  /**\n   * Whether to run transactions and signatures through security alert\n   * providers before submitting.\n   */\n  useSecurityAlerts: boolean;\n\n  /**\n   * Whether to simulate transactions and signatures to preview their effects\n   * before the user confirms.\n   */\n  simulateOnChainActions: boolean;\n\n  /**\n   * Whether to automatically detect and add ERC-20 tokens to the user's\n   * wallet.\n   */\n  useTokenDetection: boolean;\n\n  /**\n   * Whether to fetch token balances in an aggregated manner for improved\n   * performance.\n   */\n  batchCheckBalances: boolean;\n\n  /**\n   * Whether to display NFT media (images, videos) in the MetaMask UI.\n   */\n  displayNftMedia: boolean;\n\n  /**\n   * Whether to automatically detect and add NFTs to the user's wallet.\n   */\n  useNftDetection: boolean;\n\n  /**\n   * Whether to fetch token price data from an external pricing source.\n   */\n  useExternalPricingData: boolean;\n\n  /**\n   * Whether to show testnet networks in the MetaMask UI.\n   */\n  showTestnets: boolean;\n};\n"]}

package/dist/types/methods/get-preferences.d.cts

@@ -1,37 +1,59 @@
 /**
- * The request parameters for the `snap_getPreferences` method.
- *
  * This method does not accept any parameters.
  */
 export type GetPreferencesParams = never;
 /**
- * The result returned by the `snap_getPreferences` method.
- *
- * It is the user selected preferences from the MetaMask client.
- *
- * @property locale - The user's selected locale.
- * @property currency - The user's selected currency.
- * @property hideBalances - Whether the user has chosen to hide balances.
- * @property useSecurityAlerts - Whether to run transactions and signatures through security providers.
- * @property simulateOnChainActions - Whether to simulate transactions and signatures.
- * @property useTokenDetection - Whether to auto-detect tokens.
- * @property batchCheckBalances - Whether to fetch balances in an aggregated manner.
- * @property displayNftMedia - Whether to display NFT media.
- * @property useNftDetection - Whether to auto-detect NFTs.
- * @property useExternalPricingData - Whether to get token price data from an external source.
- * @property showTestnets - Whether to show testnets.
+ * An object containing the user's MetaMask preferences.
  */
 export type GetPreferencesResult = {
+    /**
+     * The user's locale setting as a [language
+     * code](https://github.com/MetaMask/metamask-extension/blob/main/app/_locales/index.json).
+     */
     locale: string;
+    /**
+     * The user's preferred fiat currency code (e.g., `"usd"`, `"eur"`).
+     */
     currency: string;
+    /**
+     * Whether the user has chosen to hide balances in the MetaMask UI.
+     */
     hideBalances: boolean;
+    /**
+     * Whether to run transactions and signatures through security alert
+     * providers before submitting.
+     */
     useSecurityAlerts: boolean;
+    /**
+     * Whether to simulate transactions and signatures to preview their effects
+     * before the user confirms.
+     */
     simulateOnChainActions: boolean;
+    /**
+     * Whether to automatically detect and add ERC-20 tokens to the user's
+     * wallet.
+     */
     useTokenDetection: boolean;
+    /**
+     * Whether to fetch token balances in an aggregated manner for improved
+     * performance.
+     */
     batchCheckBalances: boolean;
+    /**
+     * Whether to display NFT media (images, videos) in the MetaMask UI.
+     */
     displayNftMedia: boolean;
+    /**
+     * Whether to automatically detect and add NFTs to the user's wallet.
+     */
     useNftDetection: boolean;
+    /**
+     * Whether to fetch token price data from an external pricing source.
+     */
     useExternalPricingData: boolean;
+    /**
+     * Whether to show testnet networks in the MetaMask UI.
+     */
     showTestnets: boolean;
 };
 //# sourceMappingURL=get-preferences.d.cts.map

package/dist/types/methods/get-preferences.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"get-preferences.d.cts","sourceRoot":"","sources":["../../../src/types/methods/get-preferences.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG,KAAK,CAAC;AAEzC;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,OAAO,CAAC;IACtB,iBAAiB,EAAE,OAAO,CAAC;IAC3B,sBAAsB,EAAE,OAAO,CAAC;IAChC,iBAAiB,EAAE,OAAO,CAAC;IAC3B,kBAAkB,EAAE,OAAO,CAAC;IAC5B,eAAe,EAAE,OAAO,CAAC;IACzB,eAAe,EAAE,OAAO,CAAC;IACzB,sBAAsB,EAAE,OAAO,CAAC;IAChC,YAAY,EAAE,OAAO,CAAC;CACvB,CAAC"}
+{"version":3,"file":"get-preferences.d.cts","sourceRoot":"","sources":["../../../src/types/methods/get-preferences.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,KAAK,CAAC;AAEzC;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,YAAY,EAAE,OAAO,CAAC;IAEtB;;;OAGG;IACH,iBAAiB,EAAE,OAAO,CAAC;IAE3B;;;OAGG;IACH,sBAAsB,EAAE,OAAO,CAAC;IAEhC;;;OAGG;IACH,iBAAiB,EAAE,OAAO,CAAC;IAE3B;;;OAGG;IACH,kBAAkB,EAAE,OAAO,CAAC;IAE5B;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,sBAAsB,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,YAAY,EAAE,OAAO,CAAC;CACvB,CAAC"}

package/dist/types/methods/get-preferences.d.mts

@@ -1,37 +1,59 @@
 /**
- * The request parameters for the `snap_getPreferences` method.
- *
  * This method does not accept any parameters.
  */
 export type GetPreferencesParams = never;
 /**
- * The result returned by the `snap_getPreferences` method.
- *
- * It is the user selected preferences from the MetaMask client.
- *
- * @property locale - The user's selected locale.
- * @property currency - The user's selected currency.
- * @property hideBalances - Whether the user has chosen to hide balances.
- * @property useSecurityAlerts - Whether to run transactions and signatures through security providers.
- * @property simulateOnChainActions - Whether to simulate transactions and signatures.
- * @property useTokenDetection - Whether to auto-detect tokens.
- * @property batchCheckBalances - Whether to fetch balances in an aggregated manner.
- * @property displayNftMedia - Whether to display NFT media.
- * @property useNftDetection - Whether to auto-detect NFTs.
- * @property useExternalPricingData - Whether to get token price data from an external source.
- * @property showTestnets - Whether to show testnets.
+ * An object containing the user's MetaMask preferences.
  */
 export type GetPreferencesResult = {
+    /**
+     * The user's locale setting as a [language
+     * code](https://github.com/MetaMask/metamask-extension/blob/main/app/_locales/index.json).
+     */
     locale: string;
+    /**
+     * The user's preferred fiat currency code (e.g., `"usd"`, `"eur"`).
+     */
     currency: string;
+    /**
+     * Whether the user has chosen to hide balances in the MetaMask UI.
+     */
     hideBalances: boolean;
+    /**
+     * Whether to run transactions and signatures through security alert
+     * providers before submitting.
+     */
     useSecurityAlerts: boolean;
+    /**
+     * Whether to simulate transactions and signatures to preview their effects
+     * before the user confirms.
+     */
     simulateOnChainActions: boolean;
+    /**
+     * Whether to automatically detect and add ERC-20 tokens to the user's
+     * wallet.
+     */
     useTokenDetection: boolean;
+    /**
+     * Whether to fetch token balances in an aggregated manner for improved
+     * performance.
+     */
     batchCheckBalances: boolean;
+    /**
+     * Whether to display NFT media (images, videos) in the MetaMask UI.
+     */
     displayNftMedia: boolean;
+    /**
+     * Whether to automatically detect and add NFTs to the user's wallet.
+     */
     useNftDetection: boolean;
+    /**
+     * Whether to fetch token price data from an external pricing source.
+     */
     useExternalPricingData: boolean;
+    /**
+     * Whether to show testnet networks in the MetaMask UI.
+     */
     showTestnets: boolean;
 };
 //# sourceMappingURL=get-preferences.d.mts.map

package/dist/types/methods/get-preferences.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"get-preferences.d.mts","sourceRoot":"","sources":["../../../src/types/methods/get-preferences.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG,KAAK,CAAC;AAEzC;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,OAAO,CAAC;IACtB,iBAAiB,EAAE,OAAO,CAAC;IAC3B,sBAAsB,EAAE,OAAO,CAAC;IAChC,iBAAiB,EAAE,OAAO,CAAC;IAC3B,kBAAkB,EAAE,OAAO,CAAC;IAC5B,eAAe,EAAE,OAAO,CAAC;IACzB,eAAe,EAAE,OAAO,CAAC;IACzB,sBAAsB,EAAE,OAAO,CAAC;IAChC,YAAY,EAAE,OAAO,CAAC;CACvB,CAAC"}
+{"version":3,"file":"get-preferences.d.mts","sourceRoot":"","sources":["../../../src/types/methods/get-preferences.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,KAAK,CAAC;AAEzC;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,YAAY,EAAE,OAAO,CAAC;IAEtB;;;OAGG;IACH,iBAAiB,EAAE,OAAO,CAAC;IAE3B;;;OAGG;IACH,sBAAsB,EAAE,OAAO,CAAC;IAEhC;;;OAGG;IACH,iBAAiB,EAAE,OAAO,CAAC;IAE3B;;;OAGG;IACH,kBAAkB,EAAE,OAAO,CAAC;IAE5B;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,sBAAsB,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,YAAY,EAAE,OAAO,CAAC;CACvB,CAAC"}

package/dist/types/methods/get-preferences.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"get-preferences.mjs","sourceRoot":"","sources":["../../../src/types/methods/get-preferences.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * The request parameters for the `snap_getPreferences` method.\n *\n * This method does not accept any parameters.\n */\nexport type GetPreferencesParams = never;\n\n/**\n * The result returned by the `snap_getPreferences` method.\n *\n * It is the user selected preferences from the MetaMask client.\n *\n * @property locale - The user's selected locale.\n * @property currency - The user's selected currency.\n * @property hideBalances - Whether the user has chosen to hide balances.\n * @property useSecurityAlerts - Whether to run transactions and signatures through security providers.\n * @property simulateOnChainActions - Whether to simulate transactions and signatures.\n * @property useTokenDetection - Whether to auto-detect tokens.\n * @property batchCheckBalances - Whether to fetch balances in an aggregated manner.\n * @property displayNftMedia - Whether to display NFT media.\n * @property useNftDetection - Whether to auto-detect NFTs.\n * @property useExternalPricingData - Whether to get token price data from an external source.\n * @property showTestnets - Whether to show testnets.\n */\nexport type GetPreferencesResult = {\n  locale: string;\n  currency: string;\n  hideBalances: boolean;\n  useSecurityAlerts: boolean;\n  simulateOnChainActions: boolean;\n  useTokenDetection: boolean;\n  batchCheckBalances: boolean;\n  displayNftMedia: boolean;\n  useNftDetection: boolean;\n  useExternalPricingData: boolean;\n  showTestnets: boolean;\n};\n"]}
+{"version":3,"file":"get-preferences.mjs","sourceRoot":"","sources":["../../../src/types/methods/get-preferences.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * This method does not accept any parameters.\n */\nexport type GetPreferencesParams = never;\n\n/**\n * An object containing the user's MetaMask preferences.\n */\nexport type GetPreferencesResult = {\n  /**\n   * The user's locale setting as a [language\n   * code](https://github.com/MetaMask/metamask-extension/blob/main/app/_locales/index.json).\n   */\n  locale: string;\n\n  /**\n   * The user's preferred fiat currency code (e.g., `\"usd\"`, `\"eur\"`).\n   */\n  currency: string;\n\n  /**\n   * Whether the user has chosen to hide balances in the MetaMask UI.\n   */\n  hideBalances: boolean;\n\n  /**\n   * Whether to run transactions and signatures through security alert\n   * providers before submitting.\n   */\n  useSecurityAlerts: boolean;\n\n  /**\n   * Whether to simulate transactions and signatures to preview their effects\n   * before the user confirms.\n   */\n  simulateOnChainActions: boolean;\n\n  /**\n   * Whether to automatically detect and add ERC-20 tokens to the user's\n   * wallet.\n   */\n  useTokenDetection: boolean;\n\n  /**\n   * Whether to fetch token balances in an aggregated manner for improved\n   * performance.\n   */\n  batchCheckBalances: boolean;\n\n  /**\n   * Whether to display NFT media (images, videos) in the MetaMask UI.\n   */\n  displayNftMedia: boolean;\n\n  /**\n   * Whether to automatically detect and add NFTs to the user's wallet.\n   */\n  useNftDetection: boolean;\n\n  /**\n   * Whether to fetch token price data from an external pricing source.\n   */\n  useExternalPricingData: boolean;\n\n  /**\n   * Whether to show testnet networks in the MetaMask UI.\n   */\n  showTestnets: boolean;\n};\n"]}

package/dist/types/methods/get-snaps.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"get-snaps.cjs","sourceRoot":"","sources":["../../../src/types/methods/get-snaps.ts"],"names":[],"mappings":"","sourcesContent":["import type { JsonRpcError } from '@metamask/utils';\n\nimport type { Snap, SnapId } from '../snap';\n\n/**\n * The request parameters for the `wallet_getSnaps` method.\n *\n * This method does not accept any parameters.\n */\nexport type GetSnapsParams = never;\n\n/**\n * The result returned by the `wallet_getSnaps` method.\n *\n * It consists of a map of Snap IDs to either the Snap object or an error.\n */\nexport type GetSnapsResult = Record<SnapId, { error: JsonRpcError } | Snap>;\n"]}
+{"version":3,"file":"get-snaps.cjs","sourceRoot":"","sources":["../../../src/types/methods/get-snaps.ts"],"names":[],"mappings":"","sourcesContent":["import type { JsonRpcError } from '@metamask/utils';\n\nimport type { Snap, SnapId } from '../snap';\n\n/**\n * This method does not accept any parameters.\n */\nexport type GetSnapsParams = never;\n\n/**\n * A map of Snap IDs to either the Snap metadata or an error.\n */\nexport type GetSnapsResult = Record<SnapId, { error: JsonRpcError } | Snap>;\n"]}

package/dist/types/methods/get-snaps.d.cts

@@ -1,15 +1,11 @@
 import type { JsonRpcError } from "@metamask/utils";
 import type { Snap, SnapId } from "../snap.cjs";
 /**
- * The request parameters for the `wallet_getSnaps` method.
- *
  * This method does not accept any parameters.
  */
 export type GetSnapsParams = never;
 /**
- * The result returned by the `wallet_getSnaps` method.
- *
- * It consists of a map of Snap IDs to either the Snap object or an error.
+ * A map of Snap IDs to either the Snap metadata or an error.
  */
 export type GetSnapsResult = Record<SnapId, {
     error: JsonRpcError;

package/dist/types/methods/get-snaps.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"get-snaps.d.cts","sourceRoot":"","sources":["../../../src/types/methods/get-snaps.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,wBAAwB;AAEpD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,oBAAgB;AAE5C;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,KAAK,CAAC;AAEnC;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE;IAAE,KAAK,EAAE,YAAY,CAAA;CAAE,GAAG,IAAI,CAAC,CAAC"}
+{"version":3,"file":"get-snaps.d.cts","sourceRoot":"","sources":["../../../src/types/methods/get-snaps.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,wBAAwB;AAEpD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,oBAAgB;AAE5C;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,KAAK,CAAC;AAEnC;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE;IAAE,KAAK,EAAE,YAAY,CAAA;CAAE,GAAG,IAAI,CAAC,CAAC"}

package/dist/types/methods/get-snaps.d.mts

@@ -1,15 +1,11 @@
 import type { JsonRpcError } from "@metamask/utils";
 import type { Snap, SnapId } from "../snap.mjs";
 /**
- * The request parameters for the `wallet_getSnaps` method.
- *
  * This method does not accept any parameters.
  */
 export type GetSnapsParams = never;
 /**
- * The result returned by the `wallet_getSnaps` method.
- *
- * It consists of a map of Snap IDs to either the Snap object or an error.
+ * A map of Snap IDs to either the Snap metadata or an error.
  */
 export type GetSnapsResult = Record<SnapId, {
     error: JsonRpcError;

package/dist/types/methods/get-snaps.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"get-snaps.d.mts","sourceRoot":"","sources":["../../../src/types/methods/get-snaps.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,wBAAwB;AAEpD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,oBAAgB;AAE5C;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,KAAK,CAAC;AAEnC;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE;IAAE,KAAK,EAAE,YAAY,CAAA;CAAE,GAAG,IAAI,CAAC,CAAC"}
+{"version":3,"file":"get-snaps.d.mts","sourceRoot":"","sources":["../../../src/types/methods/get-snaps.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,wBAAwB;AAEpD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,oBAAgB;AAE5C;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,KAAK,CAAC;AAEnC;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE;IAAE,KAAK,EAAE,YAAY,CAAA;CAAE,GAAG,IAAI,CAAC,CAAC"}

package/dist/types/methods/get-snaps.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"get-snaps.mjs","sourceRoot":"","sources":["../../../src/types/methods/get-snaps.ts"],"names":[],"mappings":"","sourcesContent":["import type { JsonRpcError } from '@metamask/utils';\n\nimport type { Snap, SnapId } from '../snap';\n\n/**\n * The request parameters for the `wallet_getSnaps` method.\n *\n * This method does not accept any parameters.\n */\nexport type GetSnapsParams = never;\n\n/**\n * The result returned by the `wallet_getSnaps` method.\n *\n * It consists of a map of Snap IDs to either the Snap object or an error.\n */\nexport type GetSnapsResult = Record<SnapId, { error: JsonRpcError } | Snap>;\n"]}
+{"version":3,"file":"get-snaps.mjs","sourceRoot":"","sources":["../../../src/types/methods/get-snaps.ts"],"names":[],"mappings":"","sourcesContent":["import type { JsonRpcError } from '@metamask/utils';\n\nimport type { Snap, SnapId } from '../snap';\n\n/**\n * This method does not accept any parameters.\n */\nexport type GetSnapsParams = never;\n\n/**\n * A map of Snap IDs to either the Snap metadata or an error.\n */\nexport type GetSnapsResult = Record<SnapId, { error: JsonRpcError } | Snap>;\n"]}

package/dist/types/methods/get-state.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"get-state.cjs","sourceRoot":"","sources":["../../../src/types/methods/get-state.ts"],"names":[],"mappings":"","sourcesContent":["import type { Json } from '@metamask/utils';\n\n/**\n * The request parameters for the `snap_getState` method.\n *\n * @property key - The key of the state to retrieve. If not provided, the entire\n * state is retrieved. This may contain Lodash-style path syntax, e.g.,\n * `a.b.c`, with the exception of array syntax.\n * @property encrypted - Whether to use the separate encrypted state, or the\n * unencrypted state. Defaults to the encrypted state. Encrypted state can only\n * be used if the client is unlocked, while unencrypted state can be used\n * whether the client is locked or unlocked.\n */\nexport type GetStateParams = {\n  key?: string;\n  encrypted?: boolean;\n};\n\n/**\n * The result returned by the `snap_getState` method.\n */\nexport type GetStateResult = Json;\n"]}
+{"version":3,"file":"get-state.cjs","sourceRoot":"","sources":["../../../src/types/methods/get-state.ts"],"names":[],"mappings":"","sourcesContent":["import type { Json } from '@metamask/utils';\n\n/**\n * An object containing the parameters for the `snap_getState` method.\n *\n * @property key - The key of the state to retrieve. If not provided, the entire\n * state is retrieved. This may contain Lodash-style path syntax, for example,\n * `a.b.c`, with the exception of array syntax.\n * @property encrypted - Whether to use the separate encrypted state, or the\n * unencrypted state. Defaults to the encrypted state. Encrypted state can only\n * be used if the client is unlocked, while unencrypted state can be used\n * whether the client is locked or unlocked.\n *\n * Use the encrypted state for sensitive data (such as private keys or secrets),\n * and the unencrypted state for non-sensitive data that needs to be accessed\n * while the client is locked.\n */\nexport type GetStateParams = {\n  key?: string;\n  encrypted?: boolean;\n};\n\n/**\n * The state of the Snap. If a key was provided in the request parameters, this\n * is the value of that key in the state. Otherwise, this is the entire state.\n */\nexport type GetStateResult = Json;\n"]}

package/dist/types/methods/get-state.d.cts

@@ -1,21 +1,26 @@
 import type { Json } from "@metamask/utils";
 /**
- * The request parameters for the `snap_getState` method.
+ * An object containing the parameters for the `snap_getState` method.
  *
  * @property key - The key of the state to retrieve. If not provided, the entire
- * state is retrieved. This may contain Lodash-style path syntax, e.g.,
+ * state is retrieved. This may contain Lodash-style path syntax, for example,
  * `a.b.c`, with the exception of array syntax.
  * @property encrypted - Whether to use the separate encrypted state, or the
  * unencrypted state. Defaults to the encrypted state. Encrypted state can only
  * be used if the client is unlocked, while unencrypted state can be used
  * whether the client is locked or unlocked.
+ *
+ * Use the encrypted state for sensitive data (such as private keys or secrets),
+ * and the unencrypted state for non-sensitive data that needs to be accessed
+ * while the client is locked.
  */
 export type GetStateParams = {
     key?: string;
     encrypted?: boolean;
 };
 /**
- * The result returned by the `snap_getState` method.
+ * The state of the Snap. If a key was provided in the request parameters, this
+ * is the value of that key in the state. Otherwise, this is the entire state.
  */
 export type GetStateResult = Json;
 //# sourceMappingURL=get-state.d.cts.map

package/dist/types/methods/get-state.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"get-state.d.cts","sourceRoot":"","sources":["../../../src/types/methods/get-state.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAE5C;;;;;;;;;;GAUG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC"}
+{"version":3,"file":"get-state.d.cts","sourceRoot":"","sources":["../../../src/types/methods/get-state.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAE5C;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC"}

package/dist/types/methods/get-state.d.mts

@@ -1,21 +1,26 @@
 import type { Json } from "@metamask/utils";
 /**
- * The request parameters for the `snap_getState` method.
+ * An object containing the parameters for the `snap_getState` method.
  *
  * @property key - The key of the state to retrieve. If not provided, the entire
- * state is retrieved. This may contain Lodash-style path syntax, e.g.,
+ * state is retrieved. This may contain Lodash-style path syntax, for example,
  * `a.b.c`, with the exception of array syntax.
  * @property encrypted - Whether to use the separate encrypted state, or the
  * unencrypted state. Defaults to the encrypted state. Encrypted state can only
  * be used if the client is unlocked, while unencrypted state can be used
  * whether the client is locked or unlocked.
+ *
+ * Use the encrypted state for sensitive data (such as private keys or secrets),
+ * and the unencrypted state for non-sensitive data that needs to be accessed
+ * while the client is locked.
  */
 export type GetStateParams = {
     key?: string;
     encrypted?: boolean;
 };
 /**
- * The result returned by the `snap_getState` method.
+ * The state of the Snap. If a key was provided in the request parameters, this
+ * is the value of that key in the state. Otherwise, this is the entire state.
  */
 export type GetStateResult = Json;
 //# sourceMappingURL=get-state.d.mts.map

package/dist/types/methods/get-state.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"get-state.d.mts","sourceRoot":"","sources":["../../../src/types/methods/get-state.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAE5C;;;;;;;;;;GAUG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC"}
+{"version":3,"file":"get-state.d.mts","sourceRoot":"","sources":["../../../src/types/methods/get-state.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAE5C;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC"}

package/dist/types/methods/get-state.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"get-state.mjs","sourceRoot":"","sources":["../../../src/types/methods/get-state.ts"],"names":[],"mappings":"","sourcesContent":["import type { Json } from '@metamask/utils';\n\n/**\n * The request parameters for the `snap_getState` method.\n *\n * @property key - The key of the state to retrieve. If not provided, the entire\n * state is retrieved. This may contain Lodash-style path syntax, e.g.,\n * `a.b.c`, with the exception of array syntax.\n * @property encrypted - Whether to use the separate encrypted state, or the\n * unencrypted state. Defaults to the encrypted state. Encrypted state can only\n * be used if the client is unlocked, while unencrypted state can be used\n * whether the client is locked or unlocked.\n */\nexport type GetStateParams = {\n  key?: string;\n  encrypted?: boolean;\n};\n\n/**\n * The result returned by the `snap_getState` method.\n */\nexport type GetStateResult = Json;\n"]}
+{"version":3,"file":"get-state.mjs","sourceRoot":"","sources":["../../../src/types/methods/get-state.ts"],"names":[],"mappings":"","sourcesContent":["import type { Json } from '@metamask/utils';\n\n/**\n * An object containing the parameters for the `snap_getState` method.\n *\n * @property key - The key of the state to retrieve. If not provided, the entire\n * state is retrieved. This may contain Lodash-style path syntax, for example,\n * `a.b.c`, with the exception of array syntax.\n * @property encrypted - Whether to use the separate encrypted state, or the\n * unencrypted state. Defaults to the encrypted state. Encrypted state can only\n * be used if the client is unlocked, while unencrypted state can be used\n * whether the client is locked or unlocked.\n *\n * Use the encrypted state for sensitive data (such as private keys or secrets),\n * and the unencrypted state for non-sensitive data that needs to be accessed\n * while the client is locked.\n */\nexport type GetStateParams = {\n  key?: string;\n  encrypted?: boolean;\n};\n\n/**\n * The state of the Snap. If a key was provided in the request parameters, this\n * is the value of that key in the state. Otherwise, this is the entire state.\n */\nexport type GetStateResult = Json;\n"]}

package/dist/types/methods/get-web-sockets.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"get-web-sockets.cjs","sourceRoot":"","sources":["../../../src/types/methods/get-web-sockets.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * The request parameters for the `snap_getWebSockets` method.\n *\n * This method does not accept any parameters.\n */\nexport type GetWebSocketsParams = never;\n\n/**\n * The result returned by the `snap_getWebSockets` method.\n */\nexport type GetWebSocketsResult = {\n  id: string;\n  url: string;\n  protocols: string[];\n}[];\n"]}
+{"version":3,"file":"get-web-sockets.cjs","sourceRoot":"","sources":["../../../src/types/methods/get-web-sockets.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * This method does not accept any parameters.\n */\nexport type GetWebSocketsParams = never;\n\n/**\n * An array of connected WebSockets for the Snap.\n */\nexport type GetWebSocketsResult = {\n  /**\n   * The unique identifier of the WebSocket connection.\n   */\n  id: string;\n\n  /**\n   * The URL of the WebSocket connection.\n   */\n  url: string;\n\n  /**\n   * An array of subprotocols used in the WebSocket connection (if any).\n   */\n  protocols: string[];\n}[];\n"]}