@metamask/keyring-api 8.0.1 → 8.1.0

package/CHANGELOG.md

@@ -7,6 +7,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [8.1.0]
+
+### Added
+
+- Add optional `nameLastUpdatedAt` metadata field ([#366](https://github.com/MetaMask/keyring-api/pull/366))
+
+### Changed
+
+- Bump @metamask/snaps-sdk from 6.1.0 to 6.2.0 ([#367](https://github.com/MetaMask/keyring-api/pull/367))
+- Bump @metamask/providers from 17.1.1 to 17.1.2 ([#362](https://github.com/MetaMask/keyring-api/pull/362))
+
+## [8.0.2]
+
+### Changed
+
+- Bump `@metamask/snaps-sdk` from `^6.0.0` to `^6.1.0` ([#358](https://github.com/MetaMask/keyring-api/pull/358))
+
 ## [8.0.1]
 
 ### Changed
@@ -373,7 +390,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/v8.0.1...HEAD
+[Unreleased]: https://github.com/MetaMask/keyring-api/compare/v8.1.0...HEAD
+[8.1.0]: https://github.com/MetaMask/keyring-api/compare/v8.0.2...v8.1.0
+[8.0.2]: https://github.com/MetaMask/keyring-api/compare/v8.0.1...v8.0.2
 [8.0.1]: https://github.com/MetaMask/keyring-api/compare/v8.0.0...v8.0.1
 [8.0.0]: https://github.com/MetaMask/keyring-api/compare/v7.0.0...v8.0.0
 [7.0.0]: https://github.com/MetaMask/keyring-api/compare/v6.4.0...v7.0.0

package/dist/internal/types.d.ts

@@ -8,6 +8,7 @@ export declare const InternalAccountMetadataStruct: Struct<{
         keyring: {
             type: string;
         };
+        nameLastUpdatedAt?: number;
         snap?: {
             id: string;
             name: string;
@@ -22,6 +23,7 @@ export declare const InternalAccountMetadataStruct: Struct<{
         keyring: {
             type: string;
         };
+        nameLastUpdatedAt?: number;
         snap?: {
             id: string;
             name: string;
@@ -30,6 +32,7 @@ export declare const InternalAccountMetadataStruct: Struct<{
         lastSelected?: number;
     }, {
         name: Struct<string, null>;
+        nameLastUpdatedAt: Struct<number | import("../superstruct").ExactOptionalTag, null>;
         snap: Struct<import("../superstruct").ExactOptionalTag | {
             id: string;
             name: string;
@@ -60,6 +63,7 @@ export declare const InternalEthEoaAccountStruct: Struct<{
         keyring: {
             type: string;
         };
+        nameLastUpdatedAt?: number;
         snap?: {
             id: string;
             name: string;
@@ -87,6 +91,7 @@ export declare const InternalEthEoaAccountStruct: Struct<{
         keyring: {
             type: string;
         };
+        nameLastUpdatedAt?: number;
         snap?: {
             id: string;
             name: string;
@@ -95,6 +100,7 @@ export declare const InternalEthEoaAccountStruct: Struct<{
         lastSelected?: number;
     }, {
         name: Struct<string, null>;
+        nameLastUpdatedAt: Struct<number | import("../superstruct").ExactOptionalTag, null>;
         snap: Struct<import("../superstruct").ExactOptionalTag | {
             id: string;
             name: string;
@@ -125,6 +131,7 @@ export declare const InternalEthErc4337AccountStruct: Struct<{
         keyring: {
             type: string;
         };
+        nameLastUpdatedAt?: number;
         snap?: {
             id: string;
             name: string;
@@ -154,6 +161,7 @@ export declare const InternalEthErc4337AccountStruct: Struct<{
         keyring: {
             type: string;
         };
+        nameLastUpdatedAt?: number;
         snap?: {
             id: string;
             name: string;
@@ -162,6 +170,7 @@ export declare const InternalEthErc4337AccountStruct: Struct<{
         lastSelected?: number;
     }, {
         name: Struct<string, null>;
+        nameLastUpdatedAt: Struct<number | import("../superstruct").ExactOptionalTag, null>;
         snap: Struct<import("../superstruct").ExactOptionalTag | {
             id: string;
             name: string;
@@ -192,6 +201,7 @@ export declare const InternalBtcP2wpkhAccountStruct: Struct<{
         keyring: {
             type: string;
         };
+        nameLastUpdatedAt?: number;
         snap?: {
             id: string;
             name: string;
@@ -214,6 +224,7 @@ export declare const InternalBtcP2wpkhAccountStruct: Struct<{
         keyring: {
             type: string;
         };
+        nameLastUpdatedAt?: number;
         snap?: {
             id: string;
             name: string;
@@ -222,6 +233,7 @@ export declare const InternalBtcP2wpkhAccountStruct: Struct<{
         lastSelected?: number;
     }, {
         name: Struct<string, null>;
+        nameLastUpdatedAt: Struct<number | import("../superstruct").ExactOptionalTag, null>;
         snap: Struct<import("../superstruct").ExactOptionalTag | {
             id: string;
             name: string;
@@ -257,6 +269,7 @@ export declare const InternalAccountStruct: Struct<{
         keyring: {
             type: string;
         };
+        nameLastUpdatedAt?: number;
         snap?: {
             id: string;
             name: string;
@@ -271,6 +284,7 @@ export declare const InternalAccountStruct: Struct<{
         keyring: {
             type: string;
         };
+        nameLastUpdatedAt?: number;
         snap?: {
             id: string;
             name: string;
@@ -279,6 +293,7 @@ export declare const InternalAccountStruct: Struct<{
         lastSelected?: number;
     }, {
         name: Struct<string, null>;
+        nameLastUpdatedAt: Struct<number | import("../superstruct").ExactOptionalTag, null>;
         snap: Struct<import("../superstruct").ExactOptionalTag | {
             id: string;
             name: string;

package/dist/internal/types.js

@@ -9,6 +9,7 @@ const superstruct_2 = require("../superstruct");
 exports.InternalAccountMetadataStruct = (0, superstruct_2.object)({
     metadata: (0, superstruct_2.object)({
         name: (0, superstruct_1.string)(),
+        nameLastUpdatedAt: (0, superstruct_2.exactOptional)((0, superstruct_1.number)()),
         snap: (0, superstruct_2.exactOptional)((0, superstruct_2.object)({
             id: (0, superstruct_1.string)(),
             enabled: (0, superstruct_1.boolean)(),

package/dist/internal/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/internal/types.ts"],"names":[],"mappings":";;;AACA,uDAAgE;AAEhE,gCAA8E;AAC9E,wCAAsD;AACtD,wCAA4E;AAC5E,gDAAuD;AAI1C,QAAA,6BAA6B,GAAG,IAAA,oBAAM,EAAC;IAClD,QAAQ,EAAE,IAAA,oBAAM,EAAC;QACf,IAAI,EAAE,IAAA,oBAAM,GAAE;QACd,IAAI,EAAE,IAAA,2BAAa,EACjB,IAAA,oBAAM,EAAC;YACL,EAAE,EAAE,IAAA,oBAAM,GAAE;YACZ,OAAO,EAAE,IAAA,qBAAO,GAAE;YAClB,IAAI,EAAE,IAAA,oBAAM,GAAE;SACf,CAAC,CACH;QACD,YAAY,EAAE,IAAA,2BAAa,EAAC,IAAA,oBAAM,GAAE,CAAC;QACrC,UAAU,EAAE,IAAA,oBAAM,GAAE;QACpB,OAAO,EAAE,IAAA,oBAAM,EAAC;YACd,IAAI,EAAE,IAAA,oBAAM,GAAE;SACf,CAAC;KACH,CAAC;CACH,CAAC,CAAC;AAEH;;;;;GAKG;AACH,SAAS,uBAAuB,CAC9B,aAA6C;IAE7C,OAAO,IAAA,oBAAM,EAAC;QACZ,GAAG,aAAa,CAAC,MAAM;QACvB,GAAG,qCAA6B,CAAC,MAAM;KACxC,CAAC,CAAC;AACL,CAAC;AAEY,QAAA,2BAA2B,GACtC,uBAAuB,CAAC,2BAAmB,CAAC,CAAC;AAElC,QAAA,+BAA+B,GAAG,uBAAuB,CACpE,+BAAuB,CACxB,CAAC;AAEW,QAAA,8BAA8B,GAAG,uBAAuB,CACnE,8BAAsB,CACvB,CAAC;AAYW,QAAA,sBAAsB,GAK/B;IACF,CAAC,GAAG,oBAAc,CAAC,GAAG,EAAE,CAAC,EAAE,mCAA2B;IACtD,CAAC,GAAG,oBAAc,CAAC,OAAO,EAAE,CAAC,EAAE,uCAA+B;IAC9D,CAAC,GAAG,oBAAc,CAAC,MAAM,EAAE,CAAC,EAAE,sCAA8B;CAC7D,CAAC;AAOW,QAAA,qBAAqB,GAAG,IAAA,oBAAM,EAAC;IAC1C,GAAG,0BAAoB,CAAC,MAAM;IAC9B,GAAG,qCAA6B,CAAC,MAAM;CACxC,CAAC,CAAC","sourcesContent":["import type { Infer, Struct } from '@metamask/superstruct';\nimport { boolean, string, number } from '@metamask/superstruct';\n\nimport { BtcAccountType, EthAccountType, KeyringAccountStruct } from '../api';\nimport { BtcP2wpkhAccountStruct } from '../btc/types';\nimport { EthEoaAccountStruct, EthErc4337AccountStruct } from '../eth/types';\nimport { exactOptional, object } from '../superstruct';\n\nexport type InternalAccountType = EthAccountType | BtcAccountType;\n\nexport const InternalAccountMetadataStruct = object({\n  metadata: object({\n    name: string(),\n    snap: exactOptional(\n      object({\n        id: string(),\n        enabled: boolean(),\n        name: string(),\n      }),\n    ),\n    lastSelected: exactOptional(number()),\n    importTime: number(),\n    keyring: object({\n      type: string(),\n    }),\n  }),\n});\n\n/**\n * Creates an `InternalAccount` from an existing account `superstruct` object.\n *\n * @param accountStruct - An account `superstruct` object.\n * @returns The `InternalAccount` associated to `accountStruct`.\n */\nfunction asInternalAccountStruct<Account, AccountSchema>(\n  accountStruct: Struct<Account, AccountSchema>,\n) {\n  return object({\n    ...accountStruct.schema,\n    ...InternalAccountMetadataStruct.schema,\n  });\n}\n\nexport const InternalEthEoaAccountStruct =\n  asInternalAccountStruct(EthEoaAccountStruct);\n\nexport const InternalEthErc4337AccountStruct = asInternalAccountStruct(\n  EthErc4337AccountStruct,\n);\n\nexport const InternalBtcP2wpkhAccountStruct = asInternalAccountStruct(\n  BtcP2wpkhAccountStruct,\n);\n\nexport type InternalEthEoaAccount = Infer<typeof InternalEthEoaAccountStruct>;\n\nexport type InternalEthErc4337Account = Infer<\n  typeof InternalEthErc4337AccountStruct\n>;\n\nexport type InternalBtcP2wpkhAccount = Infer<\n  typeof InternalBtcP2wpkhAccountStruct\n>;\n\nexport const InternalAccountStructs: Record<\n  string,\n  | Struct<InternalEthEoaAccount>\n  | Struct<InternalEthErc4337Account>\n  | Struct<InternalBtcP2wpkhAccount>\n> = {\n  [`${EthAccountType.Eoa}`]: InternalEthEoaAccountStruct,\n  [`${EthAccountType.Erc4337}`]: InternalEthErc4337AccountStruct,\n  [`${BtcAccountType.P2wpkh}`]: InternalBtcP2wpkhAccountStruct,\n};\n\nexport type InternalAccountTypes =\n  | InternalEthEoaAccount\n  | InternalEthErc4337Account\n  | InternalBtcP2wpkhAccount;\n\nexport const InternalAccountStruct = object({\n  ...KeyringAccountStruct.schema,\n  ...InternalAccountMetadataStruct.schema,\n});\n\n/**\n * Internal account representation.\n *\n * This type is used internally by MetaMask to add additional metadata to the\n * account object. It's should not be used by external applications.\n */\nexport type InternalAccount = Infer<typeof InternalAccountStruct>;\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/internal/types.ts"],"names":[],"mappings":";;;AACA,uDAAgE;AAEhE,gCAA8E;AAC9E,wCAAsD;AACtD,wCAA4E;AAC5E,gDAAuD;AAI1C,QAAA,6BAA6B,GAAG,IAAA,oBAAM,EAAC;IAClD,QAAQ,EAAE,IAAA,oBAAM,EAAC;QACf,IAAI,EAAE,IAAA,oBAAM,GAAE;QACd,iBAAiB,EAAE,IAAA,2BAAa,EAAC,IAAA,oBAAM,GAAE,CAAC;QAC1C,IAAI,EAAE,IAAA,2BAAa,EACjB,IAAA,oBAAM,EAAC;YACL,EAAE,EAAE,IAAA,oBAAM,GAAE;YACZ,OAAO,EAAE,IAAA,qBAAO,GAAE;YAClB,IAAI,EAAE,IAAA,oBAAM,GAAE;SACf,CAAC,CACH;QACD,YAAY,EAAE,IAAA,2BAAa,EAAC,IAAA,oBAAM,GAAE,CAAC;QACrC,UAAU,EAAE,IAAA,oBAAM,GAAE;QACpB,OAAO,EAAE,IAAA,oBAAM,EAAC;YACd,IAAI,EAAE,IAAA,oBAAM,GAAE;SACf,CAAC;KACH,CAAC;CACH,CAAC,CAAC;AAEH;;;;;GAKG;AACH,SAAS,uBAAuB,CAC9B,aAA6C;IAE7C,OAAO,IAAA,oBAAM,EAAC;QACZ,GAAG,aAAa,CAAC,MAAM;QACvB,GAAG,qCAA6B,CAAC,MAAM;KACxC,CAAC,CAAC;AACL,CAAC;AAEY,QAAA,2BAA2B,GACtC,uBAAuB,CAAC,2BAAmB,CAAC,CAAC;AAElC,QAAA,+BAA+B,GAAG,uBAAuB,CACpE,+BAAuB,CACxB,CAAC;AAEW,QAAA,8BAA8B,GAAG,uBAAuB,CACnE,8BAAsB,CACvB,CAAC;AAYW,QAAA,sBAAsB,GAK/B;IACF,CAAC,GAAG,oBAAc,CAAC,GAAG,EAAE,CAAC,EAAE,mCAA2B;IACtD,CAAC,GAAG,oBAAc,CAAC,OAAO,EAAE,CAAC,EAAE,uCAA+B;IAC9D,CAAC,GAAG,oBAAc,CAAC,MAAM,EAAE,CAAC,EAAE,sCAA8B;CAC7D,CAAC;AAOW,QAAA,qBAAqB,GAAG,IAAA,oBAAM,EAAC;IAC1C,GAAG,0BAAoB,CAAC,MAAM;IAC9B,GAAG,qCAA6B,CAAC,MAAM;CACxC,CAAC,CAAC","sourcesContent":["import type { Infer, Struct } from '@metamask/superstruct';\nimport { boolean, string, number } from '@metamask/superstruct';\n\nimport { BtcAccountType, EthAccountType, KeyringAccountStruct } from '../api';\nimport { BtcP2wpkhAccountStruct } from '../btc/types';\nimport { EthEoaAccountStruct, EthErc4337AccountStruct } from '../eth/types';\nimport { exactOptional, object } from '../superstruct';\n\nexport type InternalAccountType = EthAccountType | BtcAccountType;\n\nexport const InternalAccountMetadataStruct = object({\n  metadata: object({\n    name: string(),\n    nameLastUpdatedAt: exactOptional(number()),\n    snap: exactOptional(\n      object({\n        id: string(),\n        enabled: boolean(),\n        name: string(),\n      }),\n    ),\n    lastSelected: exactOptional(number()),\n    importTime: number(),\n    keyring: object({\n      type: string(),\n    }),\n  }),\n});\n\n/**\n * Creates an `InternalAccount` from an existing account `superstruct` object.\n *\n * @param accountStruct - An account `superstruct` object.\n * @returns The `InternalAccount` associated to `accountStruct`.\n */\nfunction asInternalAccountStruct<Account, AccountSchema>(\n  accountStruct: Struct<Account, AccountSchema>,\n) {\n  return object({\n    ...accountStruct.schema,\n    ...InternalAccountMetadataStruct.schema,\n  });\n}\n\nexport const InternalEthEoaAccountStruct =\n  asInternalAccountStruct(EthEoaAccountStruct);\n\nexport const InternalEthErc4337AccountStruct = asInternalAccountStruct(\n  EthErc4337AccountStruct,\n);\n\nexport const InternalBtcP2wpkhAccountStruct = asInternalAccountStruct(\n  BtcP2wpkhAccountStruct,\n);\n\nexport type InternalEthEoaAccount = Infer<typeof InternalEthEoaAccountStruct>;\n\nexport type InternalEthErc4337Account = Infer<\n  typeof InternalEthErc4337AccountStruct\n>;\n\nexport type InternalBtcP2wpkhAccount = Infer<\n  typeof InternalBtcP2wpkhAccountStruct\n>;\n\nexport const InternalAccountStructs: Record<\n  string,\n  | Struct<InternalEthEoaAccount>\n  | Struct<InternalEthErc4337Account>\n  | Struct<InternalBtcP2wpkhAccount>\n> = {\n  [`${EthAccountType.Eoa}`]: InternalEthEoaAccountStruct,\n  [`${EthAccountType.Erc4337}`]: InternalEthErc4337AccountStruct,\n  [`${BtcAccountType.P2wpkh}`]: InternalBtcP2wpkhAccountStruct,\n};\n\nexport type InternalAccountTypes =\n  | InternalEthEoaAccount\n  | InternalEthErc4337Account\n  | InternalBtcP2wpkhAccount;\n\nexport const InternalAccountStruct = object({\n  ...KeyringAccountStruct.schema,\n  ...InternalAccountMetadataStruct.schema,\n});\n\n/**\n * Internal account representation.\n *\n * This type is used internally by MetaMask to add additional metadata to the\n * account object. It's should not be used by external applications.\n */\nexport type InternalAccount = Infer<typeof InternalAccountStruct>;\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/keyring-api",
-  "version": "8.0.1",
+  "version": "8.1.0",
   "description": "MetaMask Keyring API",
   "keywords": [
     "metamask",
@@ -38,7 +38,7 @@
     "test:watch": "jest --watch"
   },
   "dependencies": {
-    "@metamask/snaps-sdk": "^6.0.0",
+    "@metamask/snaps-sdk": "^6.1.0",
     "@metamask/superstruct": "^3.1.0",
     "@metamask/utils": "^9.1.0",
     "@types/uuid": "^9.0.8",