@metamask/keyring-api 6.1.0 → 6.2.0

package/CHANGELOG.md

@@ -7,6 +7,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [6.2.0]
+
+### Added
+
+- Add `accountNameSuggestion` field to the `AccountCreatedEvent` ([#291](https://github.com/MetaMask/keyring-api/pull/291))
+- Add `displayConfirmation` field to the `AccountCreatedEvent` ([#307](https://github.com/MetaMask/keyring-api/pull/307))
+
+## [6.1.1]
+
+### Changed
+
+- Fix `isEvmAccountType` accountType type to `string` or `InternalAccountType` ([#304](https://github.com/MetaMask/keyring-api/pull/304))
+- Bump @metamask/snaps-sdk from ^4.0.0 to ^4.2.0 ([#305](https://github.com/MetaMask/keyring-api/pull/305))
+
 ## [6.1.0]
 
 ### Added
@@ -276,7 +290,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - SnapController keyring client. It is intended to be used by MetaMask to talk to the snap.
 - Helper functions to create keyring handler in the snap.
 
-[Unreleased]: https://github.com/MetaMask/keyring-api/compare/v6.1.0...HEAD
+[Unreleased]: https://github.com/MetaMask/keyring-api/compare/v6.2.0...HEAD
+[6.2.0]: https://github.com/MetaMask/keyring-api/compare/v6.1.1...v6.2.0
+[6.1.1]: https://github.com/MetaMask/keyring-api/compare/v6.1.0...v6.1.1
 [6.1.0]: https://github.com/MetaMask/keyring-api/compare/v6.0.0...v6.1.0
 [6.0.0]: https://github.com/MetaMask/keyring-api/compare/v5.1.0...v6.0.0
 [5.1.0]: https://github.com/MetaMask/keyring-api/compare/v5.0.0...v5.1.0

package/dist/eth/utils.d.ts

@@ -4,4 +4,4 @@ import type { InternalAccountType } from '../internal';
  * @param type - The type to check.
  * @returns Returns true if the type is an EVM account type, false otherwise.
  */
-export declare function isEvmAccountType(type: InternalAccountType): boolean;
+export declare function isEvmAccountType(type: InternalAccountType | string): boolean;

package/dist/eth/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/eth/utils.ts"],"names":[],"mappings":";;;AACA,mCAAyC;AAEzC;;;;GAIG;AACH,SAAgB,gBAAgB,CAAC,IAAyB;IACxD,OAAO,IAAI,KAAK,sBAAc,CAAC,GAAG,IAAI,IAAI,KAAK,sBAAc,CAAC,OAAO,CAAC;AACxE,CAAC;AAFD,4CAEC","sourcesContent":["import type { InternalAccountType } from '../internal';\nimport { EthAccountType } from './types';\n\n/**\n * Checks if the given type is an EVM account type.\n * @param type - The type to check.\n * @returns Returns true if the type is an EVM account type, false otherwise.\n */\nexport function isEvmAccountType(type: InternalAccountType): boolean {\n  return type === EthAccountType.Eoa || type === EthAccountType.Erc4337;\n}\n"]}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/eth/utils.ts"],"names":[],"mappings":";;;AACA,mCAAyC;AAEzC;;;;GAIG;AACH,SAAgB,gBAAgB,CAAC,IAAkC;IACjE,OAAO,IAAI,KAAK,sBAAc,CAAC,GAAG,IAAI,IAAI,KAAK,sBAAc,CAAC,OAAO,CAAC;AACxE,CAAC;AAFD,4CAEC","sourcesContent":["import type { InternalAccountType } from '../internal';\nimport { EthAccountType } from './types';\n\n/**\n * Checks if the given type is an EVM account type.\n * @param type - The type to check.\n * @returns Returns true if the type is an EVM account type, false otherwise.\n */\nexport function isEvmAccountType(type: InternalAccountType | string): boolean {\n  return type === EthAccountType.Eoa || type === EthAccountType.Erc4337;\n}\n"]}

package/dist/internal/events.d.ts

@@ -20,6 +20,8 @@ export declare const AccountCreatedEventStruct: import("superstruct").Struct<{
             options: Record<string, import("@metamask/utils").Json>;
             methods: ("personal_sign" | "eth_sign" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4" | "eth_prepareUserOperation" | "eth_patchUserOperation" | "eth_signUserOperation")[];
         };
+        accountNameSuggestion: string | import("../superstruct").ExactOptionalTag;
+        displayConfirmation: boolean | import("../superstruct").ExactOptionalTag;
     };
 }, {
     method: import("superstruct").Struct<"notify:accountCreated", "notify:accountCreated">;
@@ -43,6 +45,8 @@ export declare const AccountCreatedEventStruct: import("superstruct").Struct<{
             options: Record<string, import("@metamask/utils").Json>;
             methods: ("personal_sign" | "eth_sign" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4" | "eth_prepareUserOperation" | "eth_patchUserOperation" | "eth_signUserOperation")[];
         };
+        accountNameSuggestion: string | import("../superstruct").ExactOptionalTag;
+        displayConfirmation: boolean | import("../superstruct").ExactOptionalTag;
     }, {
         /**
          * New account object.
@@ -66,6 +70,19 @@ export declare const AccountCreatedEventStruct: import("superstruct").Struct<{
             options: Record<string, import("@metamask/utils").Json>;
             methods: ("personal_sign" | "eth_sign" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4" | "eth_prepareUserOperation" | "eth_patchUserOperation" | "eth_signUserOperation")[];
         }, null>;
+        /**
+         * Account name suggestion provided to the MetaMask client.
+         *
+         * The keyring can suggest a name for the account, but it's up to the
+         * client to decide whether to use it. The keyring won't be informed if the
+         * client decides to use a different name.
+         */
+        accountNameSuggestion: import("superstruct").Struct<string | import("../superstruct").ExactOptionalTag, null>;
+        /**
+         * Instructs MetaMask to display the add account confirmation dialog in the UI.
+         * **Note:** This is not guaranteed to be honored by the MetaMask client.
+         */
+        displayConfirmation: import("superstruct").Struct<boolean | import("../superstruct").ExactOptionalTag, null>;
     }>;
 }>;
 export declare const AccountUpdatedEventStruct: import("superstruct").Struct<{

package/dist/internal/events.js

@@ -5,6 +5,7 @@ const utils_1 = require("@metamask/utils");
 const superstruct_1 = require("superstruct");
 const api_1 = require("../api");
 const events_1 = require("../events");
+const superstruct_2 = require("../superstruct");
 const utils_2 = require("../utils");
 exports.AccountCreatedEventStruct = (0, superstruct_1.object)({
     method: (0, superstruct_1.literal)(`${events_1.KeyringEvent.AccountCreated}`),
@@ -13,6 +14,19 @@ exports.AccountCreatedEventStruct = (0, superstruct_1.object)({
          * New account object.
          */
         account: api_1.KeyringAccountStruct,
+        /**
+         * Account name suggestion provided to the MetaMask client.
+         *
+         * The keyring can suggest a name for the account, but it's up to the
+         * client to decide whether to use it. The keyring won't be informed if the
+         * client decides to use a different name.
+         */
+        accountNameSuggestion: (0, superstruct_2.exactOptional)((0, superstruct_1.string)()),
+        /**
+         * Instructs MetaMask to display the add account confirmation dialog in the UI.
+         * **Note:** This is not guaranteed to be honored by the MetaMask client.
+         */
+        displayConfirmation: (0, superstruct_2.exactOptional)((0, superstruct_1.boolean)()),
     }),
 });
 exports.AccountUpdatedEventStruct = (0, superstruct_1.object)({

package/dist/internal/events.js.map

@@ -1 +1 @@
-{"version":3,"file":"events.js","sourceRoot":"","sources":["../../src/internal/events.ts"],"names":[],"mappings":";;;AAAA,2CAA6C;AAC7C,6CAA8C;AAE9C,gCAA8C;AAC9C,sCAAyC;AACzC,oCAAsC;AAEzB,QAAA,yBAAyB,GAAG,IAAA,oBAAM,EAAC;IAC9C,MAAM,EAAE,IAAA,qBAAO,EAAC,GAAG,qBAAY,CAAC,cAAc,EAAE,CAAC;IACjD,MAAM,EAAE,IAAA,oBAAM,EAAC;QACb;;WAEG;QACH,OAAO,EAAE,0BAAoB;KAC9B,CAAC;CACH,CAAC,CAAC;AAEU,QAAA,yBAAyB,GAAG,IAAA,oBAAM,EAAC;IAC9C,MAAM,EAAE,IAAA,qBAAO,EAAC,GAAG,qBAAY,CAAC,cAAc,EAAE,CAAC;IACjD,MAAM,EAAE,IAAA,oBAAM,EAAC;QACb;;WAEG;QACH,OAAO,EAAE,0BAAoB;KAC9B,CAAC;CACH,CAAC,CAAC;AAEU,QAAA,yBAAyB,GAAG,IAAA,oBAAM,EAAC;IAC9C,MAAM,EAAE,IAAA,qBAAO,EAAC,GAAG,qBAAY,CAAC,cAAc,EAAE,CAAC;IACjD,MAAM,EAAE,IAAA,oBAAM,EAAC;QACb;;WAEG;QACH,EAAE,EAAE,kBAAU;KACf,CAAC;CACH,CAAC,CAAC;AAEU,QAAA,0BAA0B,GAAG,IAAA,oBAAM,EAAC;IAC/C,MAAM,EAAE,IAAA,qBAAO,EAAC,GAAG,qBAAY,CAAC,eAAe,EAAE,CAAC;IAClD,MAAM,EAAE,IAAA,oBAAM,EAAC;QACb;;WAEG;QACH,EAAE,EAAE,kBAAU;QAEd;;WAEG;QACH,MAAM,EAAE,kBAAU;KACnB,CAAC;CACH,CAAC,CAAC;AAEU,QAAA,0BAA0B,GAAG,IAAA,oBAAM,EAAC;IAC/C,MAAM,EAAE,IAAA,qBAAO,EAAC,GAAG,qBAAY,CAAC,eAAe,EAAE,CAAC;IAClD,MAAM,EAAE,IAAA,oBAAM,EAAC;QACb;;WAEG;QACH,EAAE,EAAE,kBAAU;KACf,CAAC;CACH,CAAC,CAAC","sourcesContent":["import { JsonStruct } from '@metamask/utils';\nimport { literal, object } from 'superstruct';\n\nimport { KeyringAccountStruct } from '../api';\nimport { KeyringEvent } from '../events';\nimport { UuidStruct } from '../utils';\n\nexport const AccountCreatedEventStruct = object({\n  method: literal(`${KeyringEvent.AccountCreated}`),\n  params: object({\n    /**\n     * New account object.\n     */\n    account: KeyringAccountStruct,\n  }),\n});\n\nexport const AccountUpdatedEventStruct = object({\n  method: literal(`${KeyringEvent.AccountUpdated}`),\n  params: object({\n    /**\n     * Updated account object.\n     */\n    account: KeyringAccountStruct,\n  }),\n});\n\nexport const AccountDeletedEventStruct = object({\n  method: literal(`${KeyringEvent.AccountDeleted}`),\n  params: object({\n    /**\n     * Deleted account ID.\n     */\n    id: UuidStruct,\n  }),\n});\n\nexport const RequestApprovedEventStruct = object({\n  method: literal(`${KeyringEvent.RequestApproved}`),\n  params: object({\n    /**\n     * Request ID.\n     */\n    id: UuidStruct,\n\n    /**\n     * Request result.\n     */\n    result: JsonStruct,\n  }),\n});\n\nexport const RequestRejectedEventStruct = object({\n  method: literal(`${KeyringEvent.RequestRejected}`),\n  params: object({\n    /**\n     * Request ID.\n     */\n    id: UuidStruct,\n  }),\n});\n"]}
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../../src/internal/events.ts"],"names":[],"mappings":";;;AAAA,2CAA6C;AAC7C,6CAA+D;AAE/D,gCAA8C;AAC9C,sCAAyC;AACzC,gDAA+C;AAC/C,oCAAsC;AAEzB,QAAA,yBAAyB,GAAG,IAAA,oBAAM,EAAC;IAC9C,MAAM,EAAE,IAAA,qBAAO,EAAC,GAAG,qBAAY,CAAC,cAAc,EAAE,CAAC;IACjD,MAAM,EAAE,IAAA,oBAAM,EAAC;QACb;;WAEG;QACH,OAAO,EAAE,0BAAoB;QAE7B;;;;;;WAMG;QACH,qBAAqB,EAAE,IAAA,2BAAa,EAAC,IAAA,oBAAM,GAAE,CAAC;QAE9C;;;WAGG;QACH,mBAAmB,EAAE,IAAA,2BAAa,EAAC,IAAA,qBAAO,GAAE,CAAC;KAC9C,CAAC;CACH,CAAC,CAAC;AAEU,QAAA,yBAAyB,GAAG,IAAA,oBAAM,EAAC;IAC9C,MAAM,EAAE,IAAA,qBAAO,EAAC,GAAG,qBAAY,CAAC,cAAc,EAAE,CAAC;IACjD,MAAM,EAAE,IAAA,oBAAM,EAAC;QACb;;WAEG;QACH,OAAO,EAAE,0BAAoB;KAC9B,CAAC;CACH,CAAC,CAAC;AAEU,QAAA,yBAAyB,GAAG,IAAA,oBAAM,EAAC;IAC9C,MAAM,EAAE,IAAA,qBAAO,EAAC,GAAG,qBAAY,CAAC,cAAc,EAAE,CAAC;IACjD,MAAM,EAAE,IAAA,oBAAM,EAAC;QACb;;WAEG;QACH,EAAE,EAAE,kBAAU;KACf,CAAC;CACH,CAAC,CAAC;AAEU,QAAA,0BAA0B,GAAG,IAAA,oBAAM,EAAC;IAC/C,MAAM,EAAE,IAAA,qBAAO,EAAC,GAAG,qBAAY,CAAC,eAAe,EAAE,CAAC;IAClD,MAAM,EAAE,IAAA,oBAAM,EAAC;QACb;;WAEG;QACH,EAAE,EAAE,kBAAU;QAEd;;WAEG;QACH,MAAM,EAAE,kBAAU;KACnB,CAAC;CACH,CAAC,CAAC;AAEU,QAAA,0BAA0B,GAAG,IAAA,oBAAM,EAAC;IAC/C,MAAM,EAAE,IAAA,qBAAO,EAAC,GAAG,qBAAY,CAAC,eAAe,EAAE,CAAC;IAClD,MAAM,EAAE,IAAA,oBAAM,EAAC;QACb;;WAEG;QACH,EAAE,EAAE,kBAAU;KACf,CAAC;CACH,CAAC,CAAC","sourcesContent":["import { JsonStruct } from '@metamask/utils';\nimport { boolean, literal, object, string } from 'superstruct';\n\nimport { KeyringAccountStruct } from '../api';\nimport { KeyringEvent } from '../events';\nimport { exactOptional } from '../superstruct';\nimport { UuidStruct } from '../utils';\n\nexport const AccountCreatedEventStruct = object({\n  method: literal(`${KeyringEvent.AccountCreated}`),\n  params: object({\n    /**\n     * New account object.\n     */\n    account: KeyringAccountStruct,\n\n    /**\n     * Account name suggestion provided to the MetaMask client.\n     *\n     * The keyring can suggest a name for the account, but it's up to the\n     * client to decide whether to use it. The keyring won't be informed if the\n     * client decides to use a different name.\n     */\n    accountNameSuggestion: exactOptional(string()),\n\n    /**\n     * Instructs MetaMask to display the add account confirmation dialog in the UI.\n     * **Note:** This is not guaranteed to be honored by the MetaMask client.\n     */\n    displayConfirmation: exactOptional(boolean()),\n  }),\n});\n\nexport const AccountUpdatedEventStruct = object({\n  method: literal(`${KeyringEvent.AccountUpdated}`),\n  params: object({\n    /**\n     * Updated account object.\n     */\n    account: KeyringAccountStruct,\n  }),\n});\n\nexport const AccountDeletedEventStruct = object({\n  method: literal(`${KeyringEvent.AccountDeleted}`),\n  params: object({\n    /**\n     * Deleted account ID.\n     */\n    id: UuidStruct,\n  }),\n});\n\nexport const RequestApprovedEventStruct = object({\n  method: literal(`${KeyringEvent.RequestApproved}`),\n  params: object({\n    /**\n     * Request ID.\n     */\n    id: UuidStruct,\n\n    /**\n     * Request result.\n     */\n    result: JsonStruct,\n  }),\n});\n\nexport const RequestRejectedEventStruct = object({\n  method: literal(`${KeyringEvent.RequestRejected}`),\n  params: object({\n    /**\n     * Request ID.\n     */\n    id: UuidStruct,\n  }),\n});\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/keyring-api",
-  "version": "6.1.0",
+  "version": "6.2.0",
   "description": "MetaMask Keyring API",
   "keywords": [
     "metamask",
@@ -38,7 +38,7 @@
     "test:watch": "jest --watch"
   },
   "dependencies": {
-    "@metamask/snaps-sdk": "^4.0.0",
+    "@metamask/snaps-sdk": "^4.2.0",
     "@metamask/utils": "^8.3.0",
     "@types/uuid": "^9.0.1",
     "bech32": "^2.0.0",
@@ -46,7 +46,7 @@
     "uuid": "^9.0.0"
   },
   "devDependencies": {
-    "@lavamoat/allow-scripts": "^2.3.1",
+    "@lavamoat/allow-scripts": "^3.0.4",
     "@lavamoat/preinstall-always-fail": "^1.0.0",
     "@metamask/auto-changelog": "^3.1.0",
     "@metamask/eslint-config": "^12.1.0",