@metamask/snaps-sdk 1.3.1 → 1.4.0

package/CHANGELOG.md

@@ -6,6 +6,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.4.0]
+### Added
+- Add support for signature insights ([#2074](https://github.com/MetaMask/snaps/pull/2074), [#2079](https://github.com/MetaMask/snaps/pull/2079))
+- Add types for `snap_getClientStatus` ([#2051](https://github.com/MetaMask/snaps/pull/2051))
+
+### Changed
+- Bump @metamask/utils from 8.2.1 to 8.3.0 ([#2100](https://github.com/MetaMask/snaps/pull/2100))
+
+## [1.3.2]
+### Fixed
+- Fix missing `sensitive` property in `Copyable` type ([#2070](https://github.com/MetaMask/snaps/pull/2070))
+
 ## [1.3.1]
 ### Fixed
 - Export error wrappers ([#2043](https://github.com/MetaMask/snaps/pull/2043))
@@ -33,7 +45,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Initial release of this package.
 
-[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-sdk@1.3.1...HEAD
+[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-sdk@1.4.0...HEAD
+[1.4.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-sdk@1.3.2...@metamask/snaps-sdk@1.4.0
+[1.3.2]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-sdk@1.3.1...@metamask/snaps-sdk@1.3.2
 [1.3.1]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-sdk@1.3.0...@metamask/snaps-sdk@1.3.1
 [1.3.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-sdk@1.2.0...@metamask/snaps-sdk@1.3.0
 [1.2.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-sdk@1.1.0...@metamask/snaps-sdk@1.2.0

package/dist/cjs/types/handlers/index.js

@@ -9,6 +9,7 @@ _export_star(require("./lifecycle"), exports);
 _export_star(require("./name-lookup"), exports);
 _export_star(require("./rpc-request"), exports);
 _export_star(require("./transaction"), exports);
+_export_star(require("./signature"), exports);
 function _export_star(from, to) {
     Object.keys(from).forEach(function(k) {
         if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {

package/dist/cjs/types/handlers/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../src/types/handlers/index.ts"],"sourcesContent":["export * from './cronjob';\nexport * from './home-page';\nexport * from './keyring';\nexport * from './lifecycle';\nexport * from './name-lookup';\nexport * from './rpc-request';\nexport * from './transaction';\n"],"names":[],"mappings":";;;;qBAAc;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA"}
+{"version":3,"sources":["../../../../src/types/handlers/index.ts"],"sourcesContent":["export * from './cronjob';\nexport * from './home-page';\nexport * from './keyring';\nexport * from './lifecycle';\nexport * from './name-lookup';\nexport * from './rpc-request';\nexport * from './transaction';\nexport * from './signature';\n"],"names":[],"mappings":";;;;qBAAc;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA"}

package/dist/cjs/types/handlers/signature.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+
+//# sourceMappingURL=signature.js.map

package/dist/cjs/types/handlers/signature.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/types/handlers/signature.ts"],"names":[],"mappings":""}

package/dist/cjs/types/methods/get-client-status.js

@@ -0,0 +1,10 @@
+/**
+ * The request parameters for the `snap_getClientStatus` method.
+ *
+ * This method does not accept any parameters.
+ */ "use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+
+//# sourceMappingURL=get-client-status.js.map

package/dist/cjs/types/methods/get-client-status.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/types/methods/get-client-status.ts"],"sourcesContent":["/**\n * The request parameters for the `snap_getClientStatus` method.\n *\n * This method does not accept any parameters.\n */\nexport type GetClientStatusParams = never;\n\n/**\n * The result returned by the `snap_getClientStatus` method.\n *\n * It returns an object containing useful information about the client.\n */\nexport type GetClientStatusResult = { locked: boolean };\n"],"names":[],"mappings":"AAAA;;;;CAIC"}

package/dist/cjs/types/methods/index.js

@@ -6,6 +6,7 @@ _export_star(require("./dialog"), exports);
 _export_star(require("./get-bip32-entropy"), exports);
 _export_star(require("./get-bip32-public-key"), exports);
 _export_star(require("./get-bip44-entropy"), exports);
+_export_star(require("./get-client-status"), exports);
 _export_star(require("./get-entropy"), exports);
 _export_star(require("./get-file"), exports);
 _export_star(require("./get-locale"), exports);

package/dist/cjs/types/methods/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../src/types/methods/index.ts"],"sourcesContent":["export * from './dialog';\nexport * from './get-bip32-entropy';\nexport * from './get-bip32-public-key';\nexport * from './get-bip44-entropy';\nexport * from './get-entropy';\nexport * from './get-file';\nexport * from './get-locale';\nexport * from './get-snaps';\nexport * from './invoke-keyring';\nexport * from './invoke-snap';\nexport * from './manage-accounts';\nexport * from './manage-state';\nexport * from './methods';\nexport * from './notify';\nexport * from './request-snaps';\n"],"names":[],"mappings":";;;;qBAAc;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA"}
+{"version":3,"sources":["../../../../src/types/methods/index.ts"],"sourcesContent":["export * from './dialog';\nexport * from './get-bip32-entropy';\nexport * from './get-bip32-public-key';\nexport * from './get-bip44-entropy';\nexport * from './get-client-status';\nexport * from './get-entropy';\nexport * from './get-file';\nexport * from './get-locale';\nexport * from './get-snaps';\nexport * from './invoke-keyring';\nexport * from './invoke-snap';\nexport * from './manage-accounts';\nexport * from './manage-state';\nexport * from './methods';\nexport * from './notify';\nexport * from './request-snaps';\n"],"names":[],"mappings":";;;;qBAAc;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA"}

package/dist/cjs/ui/components/copyable.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../src/ui/components/copyable.ts"],"sourcesContent":["import {\n  assign,\n  boolean,\n  literal,\n  object,\n  optional,\n  string,\n} from 'superstruct';\n\nimport { createBuilder } from '../builder';\nimport { LiteralStruct, NodeType } from '../nodes';\nimport type { Literal } from '../nodes';\n\n/**\n * Text that can be copied to the clipboard. It can optionally be marked as\n * sensitive, in which case it will only be displayed to the user after clicking\n * on the component.\n *\n * @property type - The type of the node. Must be the string `copyable`.\n * @property value - The text to be copied.\n * @property sensitive - Whether the value is sensitive or not. Sensitive values\n * are only displayed to the user after clicking on the component. Defaults to\n * false.\n */\nexport type Copyable = Literal & {\n  type: NodeType.Copyable;\n  value: string;\n};\n\nexport const CopyableStruct = assign(\n  LiteralStruct,\n  object({\n    type: literal(NodeType.Copyable),\n    value: string(),\n    sensitive: optional(boolean()),\n  }),\n);\n\n/**\n * Create a {@link Copyable} component.\n *\n * @param args - The node arguments. This can either be a string, or an object\n * with the `text` property.\n * @param args.value - The text to be copied.\n * @param args.sensitive - Whether the value is sensitive or not. Sensitive\n * values are only displayed to the user after clicking on the component.\n * Defaults to false.\n * @returns A {@link Copyable} component.\n * @example\n * const node = copyable('Hello, world!');\n * const node = copyable({ value: 'Hello, world!' });\n */\nexport const copyable = createBuilder(NodeType.Copyable, CopyableStruct, [\n  'value',\n  'sensitive',\n]);\n"],"names":["CopyableStruct","copyable","assign","LiteralStruct","object","type","literal","NodeType","Copyable","value","string","sensitive","optional","boolean","createBuilder"],"mappings":";;;;;;;;;;;IA6BaA,cAAc;eAAdA;;IAuBAC,QAAQ;eAARA;;;6BA7CN;yBAEuB;uBACU;AAmBjC,MAAMD,iBAAiBE,IAAAA,mBAAM,EAClCC,oBAAa,EACbC,IAAAA,mBAAM,EAAC;IACLC,MAAMC,IAAAA,oBAAO,EAACC,eAAQ,CAACC,QAAQ;IAC/BC,OAAOC,IAAAA,mBAAM;IACbC,WAAWC,IAAAA,qBAAQ,EAACC,IAAAA,oBAAO;AAC7B;AAiBK,MAAMZ,WAAWa,IAAAA,sBAAa,EAACP,eAAQ,CAACC,QAAQ,EAAER,gBAAgB;IACvE;IACA;CACD"}
+{"version":3,"sources":["../../../../src/ui/components/copyable.ts"],"sourcesContent":["import type { Infer } from 'superstruct';\nimport {\n  assign,\n  boolean,\n  literal,\n  object,\n  optional,\n  string,\n} from 'superstruct';\n\nimport { createBuilder } from '../builder';\nimport { LiteralStruct, NodeType } from '../nodes';\n\nexport const CopyableStruct = assign(\n  LiteralStruct,\n  object({\n    type: literal(NodeType.Copyable),\n    value: string(),\n    sensitive: optional(boolean()),\n  }),\n);\n\n/**\n * Text that can be copied to the clipboard. It can optionally be marked as\n * sensitive, in which case it will only be displayed to the user after clicking\n * on the component.\n *\n * @property type - The type of the node. Must be the string `copyable`.\n * @property value - The text to be copied.\n * @property sensitive - Whether the value is sensitive or not. Sensitive values\n * are only displayed to the user after clicking on the component. Defaults to\n * false.\n */\nexport type Copyable = Infer<typeof CopyableStruct>;\n\n/**\n * Create a {@link Copyable} component.\n *\n * @param args - The node arguments. This can either be a string, or an object\n * with the `text` property.\n * @param args.value - The text to be copied.\n * @param args.sensitive - Whether the value is sensitive or not. Sensitive\n * values are only displayed to the user after clicking on the component.\n * Defaults to false.\n * @returns A {@link Copyable} component.\n * @example\n * const node = copyable('Hello, world!');\n * const node = copyable({ value: 'Hello, world!' });\n */\nexport const copyable = createBuilder(NodeType.Copyable, CopyableStruct, [\n  'value',\n  'sensitive',\n]);\n"],"names":["CopyableStruct","copyable","assign","LiteralStruct","object","type","literal","NodeType","Copyable","value","string","sensitive","optional","boolean","createBuilder"],"mappings":";;;;;;;;;;;IAaaA,cAAc;eAAdA;;IAoCAC,QAAQ;eAARA;;;6BAzCN;yBAEuB;uBACU;AAEjC,MAAMD,iBAAiBE,IAAAA,mBAAM,EAClCC,oBAAa,EACbC,IAAAA,mBAAM,EAAC;IACLC,MAAMC,IAAAA,oBAAO,EAACC,eAAQ,CAACC,QAAQ;IAC/BC,OAAOC,IAAAA,mBAAM;IACbC,WAAWC,IAAAA,qBAAQ,EAACC,IAAAA,oBAAO;AAC7B;AA8BK,MAAMZ,WAAWa,IAAAA,sBAAa,EAACP,eAAQ,CAACC,QAAQ,EAAER,gBAAgB;IACvE;IACA;CACD"}

package/dist/esm/types/handlers/index.js

@@ -5,5 +5,6 @@ export * from './lifecycle';
 export * from './name-lookup';
 export * from './rpc-request';
 export * from './transaction';
+export * from './signature';
 
 //# sourceMappingURL=index.js.map

package/dist/esm/types/handlers/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../src/types/handlers/index.ts"],"sourcesContent":["export * from './cronjob';\nexport * from './home-page';\nexport * from './keyring';\nexport * from './lifecycle';\nexport * from './name-lookup';\nexport * from './rpc-request';\nexport * from './transaction';\n"],"names":[],"mappings":"AAAA,cAAc,YAAY;AAC1B,cAAc,cAAc;AAC5B,cAAc,YAAY;AAC1B,cAAc,cAAc;AAC5B,cAAc,gBAAgB;AAC9B,cAAc,gBAAgB;AAC9B,cAAc,gBAAgB"}
+{"version":3,"sources":["../../../../src/types/handlers/index.ts"],"sourcesContent":["export * from './cronjob';\nexport * from './home-page';\nexport * from './keyring';\nexport * from './lifecycle';\nexport * from './name-lookup';\nexport * from './rpc-request';\nexport * from './transaction';\nexport * from './signature';\n"],"names":[],"mappings":"AAAA,cAAc,YAAY;AAC1B,cAAc,cAAc;AAC5B,cAAc,YAAY;AAC1B,cAAc,cAAc;AAC5B,cAAc,gBAAgB;AAC9B,cAAc,gBAAgB;AAC9B,cAAc,gBAAgB;AAC9B,cAAc,cAAc"}

package/dist/esm/types/handlers/signature.js

@@ -0,0 +1,3 @@
+export { };
+
+//# sourceMappingURL=signature.js.map

package/dist/esm/types/handlers/signature.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/types/handlers/signature.ts"],"sourcesContent":["import type { EnumToUnion } from '../../internals';\nimport type { Component } from '../../ui';\nimport type { SeverityLevel } from './transaction';\n\n/**\n * An eth_sign signature object.\n *\n * @property from - The address the signature is being sent from.\n * @property data - The data (hex string) that is being signed.\n * @property signatureMethod - The signature method, which in this case is eth_sign\n */\nexport type EthSignature = {\n  from: string;\n  data: string;\n  signatureMethod: 'eth_sign';\n};\n\n/**\n * A personal_sign signature object.\n *\n * @property from - The address the signature is being sent from.\n * @property data - The data (hex string) that is being signed.\n * @property signatureMethod - The signature method, which in this case is personal_sign\n */\nexport type PersonalSignature = {\n  from: string;\n  data: string;\n  signatureMethod: 'personal_sign';\n};\n\n/**\n * An eth_signTypedData signature object.\n *\n * @property from - The address the signature is being sent from.\n * @property data - The data that is being signed.\n * @property signatureMethod - The signature method, which in this case is eth_signTypedData\n */\nexport type SignTypedDataSignature = {\n  from: string;\n  data: Record<string, any>[];\n  signatureMethod: 'eth_signTypedData';\n};\n\n/**\n * An eth_signTypedData_v3 signature object.\n *\n * @property from - The address the signature is being sent from.\n * @property data - The data that is being signed.\n * @property signatureMethod - The signature method, which in this case is eth_signTypedData_v3\n */\nexport type SignTypedDataV3Signature = {\n  from: string;\n  data: Record<string, any>;\n  signatureMethod: 'eth_signTypedData_v3';\n};\n\n/**\n * An eth_signTypedData_v4 signature object.\n *\n * @property from - The address the signature is being sent from.\n * @property data - The data that is being signed.\n * @property signatureMethod - The signature method, which in this case is eth_signTypedData_v4\n */\nexport type SignTypedDataV4Signature = {\n  from: string;\n  data: Record<string, any>;\n  signatureMethod: 'eth_signTypedData_v4';\n};\n\n/**\n * A signature object. This can be one of the below signature methods.\n *\n * @see EthSignature\n * @see PersonalSignature\n * @see SignTypedDataSignature\n * @see SignTypedDataV3Signature\n * @see SignTypedDataV4Signature\n */\nexport type Signature =\n  | EthSignature\n  | PersonalSignature\n  | SignTypedDataSignature\n  | SignTypedDataV3Signature\n  | SignTypedDataV4Signature;\n\n/**\n * The `onSignature` handler. This is called whenever a signature is\n * submitted to the snap. It can return insights about the signature, which\n * will be displayed to the user.\n *\n * Note that using this handler requires the `endowment:signature-insight`\n * permission.\n *\n * @param args - The request arguments.\n * @param args.signature - The signature object that contains the from address,\n * data and signature method.\n * @param args.signatureOrigin - The origin of the signature. This is the\n * URL of the website that submitted the signature. This is only available if\n * the Snap has enabled the `allowSignatureOrigin` option in the\n * `endowment:signature-insight` permission.\n * @returns An object containing insights about the signature. See\n * {@link OnSignatureResponse}. Can also return `null` if no insights are\n * available.\n */\nexport type OnSignatureHandler = (args: {\n  signature: Signature;\n  signatureOrigin?: string;\n}) => Promise<OnSignatureResponse | null>;\n\n/**\n * The response from a Snap's `onSignature` handler.\n *\n * @property component - A custom UI component, that will be shown in MetaMask.\n * @property severity - The severity level of the content. Currently only one\n * level is supported: `critical`.\n */\nexport type OnSignatureResponse = {\n  content: Component;\n  severity?: EnumToUnion<SeverityLevel>;\n};\n"],"names":[],"mappings":"AAAA,WAuHE"}

package/dist/esm/types/methods/get-client-status.js

@@ -0,0 +1,7 @@
+/**
+ * The request parameters for the `snap_getClientStatus` method.
+ *
+ * This method does not accept any parameters.
+ */ export { };
+
+//# sourceMappingURL=get-client-status.js.map

package/dist/esm/types/methods/get-client-status.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/types/methods/get-client-status.ts"],"sourcesContent":["/**\n * The request parameters for the `snap_getClientStatus` method.\n *\n * This method does not accept any parameters.\n */\nexport type GetClientStatusParams = never;\n\n/**\n * The result returned by the `snap_getClientStatus` method.\n *\n * It returns an object containing useful information about the client.\n */\nexport type GetClientStatusResult = { locked: boolean };\n"],"names":[],"mappings":"AAAA;;;;CAIC,GACD,WAOwD"}

package/dist/esm/types/methods/index.js

@@ -2,6 +2,7 @@ export * from './dialog';
 export * from './get-bip32-entropy';
 export * from './get-bip32-public-key';
 export * from './get-bip44-entropy';
+export * from './get-client-status';
 export * from './get-entropy';
 export * from './get-file';
 export * from './get-locale';

package/dist/esm/types/methods/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../src/types/methods/index.ts"],"sourcesContent":["export * from './dialog';\nexport * from './get-bip32-entropy';\nexport * from './get-bip32-public-key';\nexport * from './get-bip44-entropy';\nexport * from './get-entropy';\nexport * from './get-file';\nexport * from './get-locale';\nexport * from './get-snaps';\nexport * from './invoke-keyring';\nexport * from './invoke-snap';\nexport * from './manage-accounts';\nexport * from './manage-state';\nexport * from './methods';\nexport * from './notify';\nexport * from './request-snaps';\n"],"names":[],"mappings":"AAAA,cAAc,WAAW;AACzB,cAAc,sBAAsB;AACpC,cAAc,yBAAyB;AACvC,cAAc,sBAAsB;AACpC,cAAc,gBAAgB;AAC9B,cAAc,aAAa;AAC3B,cAAc,eAAe;AAC7B,cAAc,cAAc;AAC5B,cAAc,mBAAmB;AACjC,cAAc,gBAAgB;AAC9B,cAAc,oBAAoB;AAClC,cAAc,iBAAiB;AAC/B,cAAc,YAAY;AAC1B,cAAc,WAAW;AACzB,cAAc,kBAAkB"}
+{"version":3,"sources":["../../../../src/types/methods/index.ts"],"sourcesContent":["export * from './dialog';\nexport * from './get-bip32-entropy';\nexport * from './get-bip32-public-key';\nexport * from './get-bip44-entropy';\nexport * from './get-client-status';\nexport * from './get-entropy';\nexport * from './get-file';\nexport * from './get-locale';\nexport * from './get-snaps';\nexport * from './invoke-keyring';\nexport * from './invoke-snap';\nexport * from './manage-accounts';\nexport * from './manage-state';\nexport * from './methods';\nexport * from './notify';\nexport * from './request-snaps';\n"],"names":[],"mappings":"AAAA,cAAc,WAAW;AACzB,cAAc,sBAAsB;AACpC,cAAc,yBAAyB;AACvC,cAAc,sBAAsB;AACpC,cAAc,sBAAsB;AACpC,cAAc,gBAAgB;AAC9B,cAAc,aAAa;AAC3B,cAAc,eAAe;AAC7B,cAAc,cAAc;AAC5B,cAAc,mBAAmB;AACjC,cAAc,gBAAgB;AAC9B,cAAc,oBAAoB;AAClC,cAAc,iBAAiB;AAC/B,cAAc,YAAY;AAC1B,cAAc,WAAW;AACzB,cAAc,kBAAkB"}

package/dist/esm/types/methods/methods.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../src/types/methods/methods.ts"],"sourcesContent":["import type { Method } from '../../internals';\nimport type { DialogParams, DialogResult } from './dialog';\nimport type {\n  GetBip32EntropyParams,\n  GetBip32EntropyResult,\n} from './get-bip32-entropy';\nimport type {\n  GetBip32PublicKeyParams,\n  GetBip32PublicKeyResult,\n} from './get-bip32-public-key';\nimport type {\n  GetBip44EntropyParams,\n  GetBip44EntropyResult,\n} from './get-bip44-entropy';\nimport type { GetEntropyParams, GetEntropyResult } from './get-entropy';\nimport type { GetFileParams, GetFileResult } from './get-file';\nimport type { GetLocaleParams, GetLocaleResult } from './get-locale';\nimport type { GetSnapsParams, GetSnapsResult } from './get-snaps';\nimport type {\n  InvokeKeyringParams,\n  InvokeKeyringResult,\n} from './invoke-keyring';\nimport type { InvokeSnapParams, InvokeSnapResult } from './invoke-snap';\nimport type {\n  ManageAccountsParams,\n  ManageAccountsResult,\n} from './manage-accounts';\nimport type { ManageStateParams, ManageStateResult } from './manage-state';\nimport type { NotifyParams, NotifyResult } from './notify';\nimport type { RequestSnapsParams, RequestSnapsResult } from './request-snaps';\n\n/**\n * The methods that are available to the Snap. Each method is a tuple of the\n * request parameters and the result returned by the method.\n */\nexport type SnapMethods = {\n  /* eslint-disable @typescript-eslint/naming-convention */\n  snap_dialog: [DialogParams, DialogResult];\n  snap_getBip32Entropy: [GetBip32EntropyParams, GetBip32EntropyResult];\n  snap_getBip32PublicKey: [GetBip32PublicKeyParams, GetBip32PublicKeyResult];\n  snap_getBip44Entropy: [GetBip44EntropyParams, GetBip44EntropyResult];\n  snap_getEntropy: [GetEntropyParams, GetEntropyResult];\n  snap_getFile: [GetFileParams, GetFileResult];\n  snap_getLocale: [GetLocaleParams, GetLocaleResult];\n  snap_manageAccounts: [ManageAccountsParams, ManageAccountsResult];\n  snap_manageState: [ManageStateParams, ManageStateResult];\n  snap_notify: [NotifyParams, NotifyResult];\n  wallet_getSnaps: [GetSnapsParams, GetSnapsResult];\n  wallet_invokeKeyring: [InvokeKeyringParams, InvokeKeyringResult];\n  wallet_invokeSnap: [InvokeSnapParams, InvokeSnapResult];\n  wallet_snap: [InvokeSnapParams, InvokeSnapResult];\n  wallet_requestSnaps: [RequestSnapsParams, RequestSnapsResult];\n  /* eslint-enable @typescript-eslint/naming-convention */\n};\n\n/**\n * The request function that is available to the Snap. It takes a request\n * object and returns a promise that resolves to the result of the request.\n *\n * @param request - The request object.\n * @param request.method - The method to call.\n * @param request.params - The parameters to pass to the method. This is\n * inferred from the method, based on the {@link SnapMethods} type, and may be\n * optional.\n * @returns A promise that resolves to the result of the request. This is\n * inferred from the request method, based on the {@link SnapMethods} type.\n * @example\n * // Get the user's locale\n * const result = await request({\n *   method: 'snap_getLocale',\n * });\n * @example\n * // Get a file\n * const result = await request({\n *   method: 'snap_getFile',\n *   params: {\n *     path: 'foo/bar.txt',\n *   },\n * });\n */\nexport type RequestFunction = <MethodName extends keyof SnapMethods>(\n  request: Method<MethodName, SnapMethods[MethodName][0]>,\n) => Promise<SnapMethods[MethodName][1]>;\n"],"names":[],"mappings":"AAAA,WAkFyC"}
+{"version":3,"sources":["../../../../src/types/methods/methods.ts"],"sourcesContent":["import type { Method } from '../../internals';\nimport type { DialogParams, DialogResult } from './dialog';\nimport type {\n  GetBip32EntropyParams,\n  GetBip32EntropyResult,\n} from './get-bip32-entropy';\nimport type {\n  GetBip32PublicKeyParams,\n  GetBip32PublicKeyResult,\n} from './get-bip32-public-key';\nimport type {\n  GetBip44EntropyParams,\n  GetBip44EntropyResult,\n} from './get-bip44-entropy';\nimport type {\n  GetClientStatusParams,\n  GetClientStatusResult,\n} from './get-client-status';\nimport type { GetEntropyParams, GetEntropyResult } from './get-entropy';\nimport type { GetFileParams, GetFileResult } from './get-file';\nimport type { GetLocaleParams, GetLocaleResult } from './get-locale';\nimport type { GetSnapsParams, GetSnapsResult } from './get-snaps';\nimport type {\n  InvokeKeyringParams,\n  InvokeKeyringResult,\n} from './invoke-keyring';\nimport type { InvokeSnapParams, InvokeSnapResult } from './invoke-snap';\nimport type {\n  ManageAccountsParams,\n  ManageAccountsResult,\n} from './manage-accounts';\nimport type { ManageStateParams, ManageStateResult } from './manage-state';\nimport type { NotifyParams, NotifyResult } from './notify';\nimport type { RequestSnapsParams, RequestSnapsResult } from './request-snaps';\n\n/**\n * The methods that are available to the Snap. Each method is a tuple of the\n * request parameters and the result returned by the method.\n */\nexport type SnapMethods = {\n  /* eslint-disable @typescript-eslint/naming-convention */\n  snap_dialog: [DialogParams, DialogResult];\n  snap_getBip32Entropy: [GetBip32EntropyParams, GetBip32EntropyResult];\n  snap_getBip32PublicKey: [GetBip32PublicKeyParams, GetBip32PublicKeyResult];\n  snap_getBip44Entropy: [GetBip44EntropyParams, GetBip44EntropyResult];\n  snap_getClientStatus: [GetClientStatusParams, GetClientStatusResult];\n  snap_getEntropy: [GetEntropyParams, GetEntropyResult];\n  snap_getFile: [GetFileParams, GetFileResult];\n  snap_getLocale: [GetLocaleParams, GetLocaleResult];\n  snap_manageAccounts: [ManageAccountsParams, ManageAccountsResult];\n  snap_manageState: [ManageStateParams, ManageStateResult];\n  snap_notify: [NotifyParams, NotifyResult];\n  wallet_getSnaps: [GetSnapsParams, GetSnapsResult];\n  wallet_invokeKeyring: [InvokeKeyringParams, InvokeKeyringResult];\n  wallet_invokeSnap: [InvokeSnapParams, InvokeSnapResult];\n  wallet_snap: [InvokeSnapParams, InvokeSnapResult];\n  wallet_requestSnaps: [RequestSnapsParams, RequestSnapsResult];\n  /* eslint-enable @typescript-eslint/naming-convention */\n};\n\n/**\n * The request function that is available to the Snap. It takes a request\n * object and returns a promise that resolves to the result of the request.\n *\n * @param request - The request object.\n * @param request.method - The method to call.\n * @param request.params - The parameters to pass to the method. This is\n * inferred from the method, based on the {@link SnapMethods} type, and may be\n * optional.\n * @returns A promise that resolves to the result of the request. This is\n * inferred from the request method, based on the {@link SnapMethods} type.\n * @example\n * // Get the user's locale\n * const result = await request({\n *   method: 'snap_getLocale',\n * });\n * @example\n * // Get a file\n * const result = await request({\n *   method: 'snap_getFile',\n *   params: {\n *     path: 'foo/bar.txt',\n *   },\n * });\n */\nexport type RequestFunction = <MethodName extends keyof SnapMethods>(\n  request: Method<MethodName, SnapMethods[MethodName][0]>,\n) => Promise<SnapMethods[MethodName][1]>;\n"],"names":[],"mappings":"AAAA,WAuFyC"}

package/dist/esm/types/permissions.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/types/permissions.ts"],"sourcesContent":["import type { JsonRpcRequest } from '@metamask/utils';\n\nimport type { ChainId } from './caip';\n\nexport type EmptyObject = Record<string, never>;\n\nexport type Cronjob = {\n  expression: string;\n  request: Omit<JsonRpcRequest, 'jsonrpc' | 'id'>;\n};\n\nexport type Bip32Entropy = {\n  curve: 'secp256k1' | 'ed25519';\n  path: string[];\n};\n\nexport type Bip44Entropy = {\n  coinType: number;\n};\n\nexport type RequestedSnap = {\n  version?: string;\n};\n\nexport type InitialPermissions = {\n  'endowment:cronjob'?: {\n    jobs: Cronjob[];\n  };\n  'endowment:keyring'?: {\n    allowedOrigins?: string[];\n  };\n  'endowment:name-lookup'?: ChainId[];\n  'endowment:network-access'?: EmptyObject;\n  'endowment:rpc'?: {\n    dapps?: boolean;\n    snaps?: boolean;\n    allowedOrigins?: string[];\n  };\n  'endowment:transaction-insight'?: {\n    allowTransactionOrigin?: boolean;\n  };\n  'endowment:webassembly'?: EmptyObject;\n\n  /* eslint-disable @typescript-eslint/naming-convention */\n  snap_confirm?: EmptyObject;\n  snap_dialog?: EmptyObject;\n  snap_getBip32Entropy?: Bip32Entropy[];\n  snap_getBip32PublicKey?: Bip32Entropy[];\n  snap_getBip44Entropy?: Bip44Entropy[];\n  snap_getEntropy?: EmptyObject;\n  snap_manageAccounts?: EmptyObject;\n  snap_manageState?: EmptyObject;\n  snap_notify?: EmptyObject;\n  wallet_snap?: Record<string, RequestedSnap>;\n  /* eslint-enable @typescript-eslint/naming-convention */\n};\n"],"names":[],"mappings":"AAAA,WAuDE"}
+{"version":3,"sources":["../../../src/types/permissions.ts"],"sourcesContent":["import type { JsonRpcRequest } from '@metamask/utils';\n\nimport type { ChainId } from './caip';\n\nexport type EmptyObject = Record<string, never>;\n\nexport type Cronjob = {\n  expression: string;\n  request: Omit<JsonRpcRequest, 'jsonrpc' | 'id'>;\n};\n\nexport type Bip32Entropy = {\n  curve: 'secp256k1' | 'ed25519';\n  path: string[];\n};\n\nexport type Bip44Entropy = {\n  coinType: number;\n};\n\nexport type RequestedSnap = {\n  version?: string;\n};\n\nexport type InitialPermissions = {\n  'endowment:cronjob'?: {\n    jobs: Cronjob[];\n  };\n  'endowment:keyring'?: {\n    allowedOrigins?: string[];\n  };\n  'endowment:name-lookup'?: ChainId[];\n  'endowment:network-access'?: EmptyObject;\n  'endowment:rpc'?: {\n    dapps?: boolean;\n    snaps?: boolean;\n    allowedOrigins?: string[];\n  };\n  'endowment:signature-insight'?: {\n    allowSignatureOrigin?: boolean;\n  };\n  'endowment:transaction-insight'?: {\n    allowTransactionOrigin?: boolean;\n  };\n  'endowment:webassembly'?: EmptyObject;\n\n  /* eslint-disable @typescript-eslint/naming-convention */\n  snap_confirm?: EmptyObject;\n  snap_dialog?: EmptyObject;\n  snap_getBip32Entropy?: Bip32Entropy[];\n  snap_getBip32PublicKey?: Bip32Entropy[];\n  snap_getBip44Entropy?: Bip44Entropy[];\n  snap_getEntropy?: EmptyObject;\n  snap_manageAccounts?: EmptyObject;\n  snap_manageState?: EmptyObject;\n  snap_notify?: EmptyObject;\n  wallet_snap?: Record<string, RequestedSnap>;\n  /* eslint-enable @typescript-eslint/naming-convention */\n};\n"],"names":[],"mappings":"AAAA,WA0DE"}

package/dist/esm/ui/components/copyable.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../src/ui/components/copyable.ts"],"sourcesContent":["import {\n  assign,\n  boolean,\n  literal,\n  object,\n  optional,\n  string,\n} from 'superstruct';\n\nimport { createBuilder } from '../builder';\nimport { LiteralStruct, NodeType } from '../nodes';\nimport type { Literal } from '../nodes';\n\n/**\n * Text that can be copied to the clipboard. It can optionally be marked as\n * sensitive, in which case it will only be displayed to the user after clicking\n * on the component.\n *\n * @property type - The type of the node. Must be the string `copyable`.\n * @property value - The text to be copied.\n * @property sensitive - Whether the value is sensitive or not. Sensitive values\n * are only displayed to the user after clicking on the component. Defaults to\n * false.\n */\nexport type Copyable = Literal & {\n  type: NodeType.Copyable;\n  value: string;\n};\n\nexport const CopyableStruct = assign(\n  LiteralStruct,\n  object({\n    type: literal(NodeType.Copyable),\n    value: string(),\n    sensitive: optional(boolean()),\n  }),\n);\n\n/**\n * Create a {@link Copyable} component.\n *\n * @param args - The node arguments. This can either be a string, or an object\n * with the `text` property.\n * @param args.value - The text to be copied.\n * @param args.sensitive - Whether the value is sensitive or not. Sensitive\n * values are only displayed to the user after clicking on the component.\n * Defaults to false.\n * @returns A {@link Copyable} component.\n * @example\n * const node = copyable('Hello, world!');\n * const node = copyable({ value: 'Hello, world!' });\n */\nexport const copyable = createBuilder(NodeType.Copyable, CopyableStruct, [\n  'value',\n  'sensitive',\n]);\n"],"names":["assign","boolean","literal","object","optional","string","createBuilder","LiteralStruct","NodeType","CopyableStruct","type","Copyable","value","sensitive","copyable"],"mappings":"AAAA,SACEA,MAAM,EACNC,OAAO,EACPC,OAAO,EACPC,MAAM,EACNC,QAAQ,EACRC,MAAM,QACD,cAAc;AAErB,SAASC,aAAa,QAAQ,aAAa;AAC3C,SAASC,aAAa,EAAEC,QAAQ,QAAQ,WAAW;AAmBnD,OAAO,MAAMC,iBAAiBT,OAC5BO,eACAJ,OAAO;IACLO,MAAMR,QAAQM,SAASG,QAAQ;IAC/BC,OAAOP;IACPQ,WAAWT,SAASH;AACtB,IACA;AAEF;;;;;;;;;;;;;CAaC,GACD,OAAO,MAAMa,WAAWR,cAAcE,SAASG,QAAQ,EAAEF,gBAAgB;IACvE;IACA;CACD,EAAE"}
+{"version":3,"sources":["../../../../src/ui/components/copyable.ts"],"sourcesContent":["import type { Infer } from 'superstruct';\nimport {\n  assign,\n  boolean,\n  literal,\n  object,\n  optional,\n  string,\n} from 'superstruct';\n\nimport { createBuilder } from '../builder';\nimport { LiteralStruct, NodeType } from '../nodes';\n\nexport const CopyableStruct = assign(\n  LiteralStruct,\n  object({\n    type: literal(NodeType.Copyable),\n    value: string(),\n    sensitive: optional(boolean()),\n  }),\n);\n\n/**\n * Text that can be copied to the clipboard. It can optionally be marked as\n * sensitive, in which case it will only be displayed to the user after clicking\n * on the component.\n *\n * @property type - The type of the node. Must be the string `copyable`.\n * @property value - The text to be copied.\n * @property sensitive - Whether the value is sensitive or not. Sensitive values\n * are only displayed to the user after clicking on the component. Defaults to\n * false.\n */\nexport type Copyable = Infer<typeof CopyableStruct>;\n\n/**\n * Create a {@link Copyable} component.\n *\n * @param args - The node arguments. This can either be a string, or an object\n * with the `text` property.\n * @param args.value - The text to be copied.\n * @param args.sensitive - Whether the value is sensitive or not. Sensitive\n * values are only displayed to the user after clicking on the component.\n * Defaults to false.\n * @returns A {@link Copyable} component.\n * @example\n * const node = copyable('Hello, world!');\n * const node = copyable({ value: 'Hello, world!' });\n */\nexport const copyable = createBuilder(NodeType.Copyable, CopyableStruct, [\n  'value',\n  'sensitive',\n]);\n"],"names":["assign","boolean","literal","object","optional","string","createBuilder","LiteralStruct","NodeType","CopyableStruct","type","Copyable","value","sensitive","copyable"],"mappings":"AACA,SACEA,MAAM,EACNC,OAAO,EACPC,OAAO,EACPC,MAAM,EACNC,QAAQ,EACRC,MAAM,QACD,cAAc;AAErB,SAASC,aAAa,QAAQ,aAAa;AAC3C,SAASC,aAAa,EAAEC,QAAQ,QAAQ,WAAW;AAEnD,OAAO,MAAMC,iBAAiBT,OAC5BO,eACAJ,OAAO;IACLO,MAAMR,QAAQM,SAASG,QAAQ;IAC/BC,OAAOP;IACPQ,WAAWT,SAASH;AACtB,IACA;AAeF;;;;;;;;;;;;;CAaC,GACD,OAAO,MAAMa,WAAWR,cAAcE,SAASG,QAAQ,EAAEF,gBAAgB;IACvE;IACA;CACD,EAAE"}

package/dist/types/types/handlers/index.d.ts

@@ -5,3 +5,4 @@ export * from './lifecycle';
 export * from './name-lookup';
 export * from './rpc-request';
 export * from './transaction';
+export * from './signature';

package/dist/types/types/handlers/signature.d.ts

@@ -0,0 +1,107 @@
+import type { EnumToUnion } from '../../internals';
+import type { Component } from '../../ui';
+import type { SeverityLevel } from './transaction';
+/**
+ * An eth_sign signature object.
+ *
+ * @property from - The address the signature is being sent from.
+ * @property data - The data (hex string) that is being signed.
+ * @property signatureMethod - The signature method, which in this case is eth_sign
+ */
+export declare type EthSignature = {
+    from: string;
+    data: string;
+    signatureMethod: 'eth_sign';
+};
+/**
+ * A personal_sign signature object.
+ *
+ * @property from - The address the signature is being sent from.
+ * @property data - The data (hex string) that is being signed.
+ * @property signatureMethod - The signature method, which in this case is personal_sign
+ */
+export declare type PersonalSignature = {
+    from: string;
+    data: string;
+    signatureMethod: 'personal_sign';
+};
+/**
+ * An eth_signTypedData signature object.
+ *
+ * @property from - The address the signature is being sent from.
+ * @property data - The data that is being signed.
+ * @property signatureMethod - The signature method, which in this case is eth_signTypedData
+ */
+export declare type SignTypedDataSignature = {
+    from: string;
+    data: Record<string, any>[];
+    signatureMethod: 'eth_signTypedData';
+};
+/**
+ * An eth_signTypedData_v3 signature object.
+ *
+ * @property from - The address the signature is being sent from.
+ * @property data - The data that is being signed.
+ * @property signatureMethod - The signature method, which in this case is eth_signTypedData_v3
+ */
+export declare type SignTypedDataV3Signature = {
+    from: string;
+    data: Record<string, any>;
+    signatureMethod: 'eth_signTypedData_v3';
+};
+/**
+ * An eth_signTypedData_v4 signature object.
+ *
+ * @property from - The address the signature is being sent from.
+ * @property data - The data that is being signed.
+ * @property signatureMethod - The signature method, which in this case is eth_signTypedData_v4
+ */
+export declare type SignTypedDataV4Signature = {
+    from: string;
+    data: Record<string, any>;
+    signatureMethod: 'eth_signTypedData_v4';
+};
+/**
+ * A signature object. This can be one of the below signature methods.
+ *
+ * @see EthSignature
+ * @see PersonalSignature
+ * @see SignTypedDataSignature
+ * @see SignTypedDataV3Signature
+ * @see SignTypedDataV4Signature
+ */
+export declare type Signature = EthSignature | PersonalSignature | SignTypedDataSignature | SignTypedDataV3Signature | SignTypedDataV4Signature;
+/**
+ * The `onSignature` handler. This is called whenever a signature is
+ * submitted to the snap. It can return insights about the signature, which
+ * will be displayed to the user.
+ *
+ * Note that using this handler requires the `endowment:signature-insight`
+ * permission.
+ *
+ * @param args - The request arguments.
+ * @param args.signature - The signature object that contains the from address,
+ * data and signature method.
+ * @param args.signatureOrigin - The origin of the signature. This is the
+ * URL of the website that submitted the signature. This is only available if
+ * the Snap has enabled the `allowSignatureOrigin` option in the
+ * `endowment:signature-insight` permission.
+ * @returns An object containing insights about the signature. See
+ * {@link OnSignatureResponse}. Can also return `null` if no insights are
+ * available.
+ */
+export declare type OnSignatureHandler = (args: {
+    signature: Signature;
+    signatureOrigin?: string;
+}) => Promise<OnSignatureResponse | null>;
+/**
+ * The response from a Snap's `onSignature` handler.
+ *
+ * @property component - A custom UI component, that will be shown in MetaMask.
+ * @property severity - The severity level of the content. Currently only one
+ * level is supported: `critical`.
+ */
+export declare type OnSignatureResponse = {
+    content: Component;
+    severity?: EnumToUnion<SeverityLevel>;
+};

package/dist/types/types/methods/get-client-status.d.ts

@@ -0,0 +1,14 @@
+/**
+ * The request parameters for the `snap_getClientStatus` method.
+ *
+ * This method does not accept any parameters.
+ */
+export declare type GetClientStatusParams = never;
+/**
+ * The result returned by the `snap_getClientStatus` method.
+ *
+ * It returns an object containing useful information about the client.
+ */
+export declare type GetClientStatusResult = {
+    locked: boolean;
+};

package/dist/types/types/methods/index.d.ts

@@ -2,6 +2,7 @@ export * from './dialog';
 export * from './get-bip32-entropy';
 export * from './get-bip32-public-key';
 export * from './get-bip44-entropy';
+export * from './get-client-status';
 export * from './get-entropy';
 export * from './get-file';
 export * from './get-locale';

package/dist/types/types/methods/methods.d.ts

@@ -3,6 +3,7 @@ import type { DialogParams, DialogResult } from './dialog';
 import type { GetBip32EntropyParams, GetBip32EntropyResult } from './get-bip32-entropy';
 import type { GetBip32PublicKeyParams, GetBip32PublicKeyResult } from './get-bip32-public-key';
 import type { GetBip44EntropyParams, GetBip44EntropyResult } from './get-bip44-entropy';
+import type { GetClientStatusParams, GetClientStatusResult } from './get-client-status';
 import type { GetEntropyParams, GetEntropyResult } from './get-entropy';
 import type { GetFileParams, GetFileResult } from './get-file';
 import type { GetLocaleParams, GetLocaleResult } from './get-locale';
@@ -22,6 +23,7 @@ export declare type SnapMethods = {
     snap_getBip32Entropy: [GetBip32EntropyParams, GetBip32EntropyResult];
     snap_getBip32PublicKey: [GetBip32PublicKeyParams, GetBip32PublicKeyResult];
     snap_getBip44Entropy: [GetBip44EntropyParams, GetBip44EntropyResult];
+    snap_getClientStatus: [GetClientStatusParams, GetClientStatusResult];
     snap_getEntropy: [GetEntropyParams, GetEntropyResult];
     snap_getFile: [GetFileParams, GetFileResult];
     snap_getLocale: [GetLocaleParams, GetLocaleResult];

package/dist/types/types/permissions.d.ts

@@ -29,6 +29,9 @@ export declare type InitialPermissions = {
         snaps?: boolean;
         allowedOrigins?: string[];
     };
+    'endowment:signature-insight'?: {
+        allowSignatureOrigin?: boolean;
+    };
     'endowment:transaction-insight'?: {
         allowTransactionOrigin?: boolean;
     };

package/dist/types/ui/components/copyable.d.ts

@@ -1,5 +1,14 @@
+import type { Infer } from 'superstruct';
 import { NodeType } from '../nodes';
-import type { Literal } from '../nodes';
+export declare const CopyableStruct: import("superstruct").Struct<{
+    value: string;
+    type: NodeType.Copyable;
+    sensitive?: boolean | undefined;
+}, {
+    type: import("superstruct").Struct<NodeType.Copyable, NodeType.Copyable>;
+    value: import("superstruct").Struct<string, null>;
+    sensitive: import("superstruct").Struct<boolean | undefined, null>;
+}>;
 /**
  * Text that can be copied to the clipboard. It can optionally be marked as
  * sensitive, in which case it will only be displayed to the user after clicking
@@ -11,19 +20,7 @@ import type { Literal } from '../nodes';
  * are only displayed to the user after clicking on the component. Defaults to
  * false.
  */
-export declare type Copyable = Literal & {
-    type: NodeType.Copyable;
-    value: string;
-};
-export declare const CopyableStruct: import("superstruct").Struct<{
-    value: string;
-    type: NodeType.Copyable;
-    sensitive?: boolean | undefined;
-}, {
-    type: import("superstruct").Struct<NodeType.Copyable, NodeType.Copyable>;
-    value: import("superstruct").Struct<string, null>;
-    sensitive: import("superstruct").Struct<boolean | undefined, null>;
-}>;
+export declare type Copyable = Infer<typeof CopyableStruct>;
 /**
  * Create a {@link Copyable} component.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/snaps-sdk",
-  "version": "1.3.1",
+  "version": "1.4.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/MetaMask/snaps.git"
@@ -38,13 +38,13 @@
     "@metamask/key-tree": "^9.0.0",
     "@metamask/providers": "^14.0.2",
     "@metamask/rpc-errors": "^6.1.0",
-    "@metamask/utils": "^8.2.1",
+    "@metamask/utils": "^8.3.0",
     "is-svg": "^4.4.0",
     "superstruct": "^1.0.3"
   },
   "devDependencies": {
-    "@lavamoat/allow-scripts": "^2.5.1",
-    "@metamask/auto-changelog": "^3.4.3",
+    "@lavamoat/allow-scripts": "^3.0.0",
+    "@metamask/auto-changelog": "^3.4.4",
     "@metamask/eslint-config": "^12.1.0",
     "@metamask/eslint-config-jest": "^12.1.0",
     "@metamask/eslint-config-nodejs": "^12.1.0",