@metamask-previews/account-api 2.1.1-preview-3d69c27 → 2.2.0-preview-5daa013

package/CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.2.0]
+
+### Added
+
+- Add `MpcAccount<Account>` type helper + `isMpcAccount` helper ([#677](https://github.com/MetaMask/accounts/pull/677))
+
 ### Changed
 
 - Bump `@metamask/keyring-api` from `^24.2.0` to `^24.3.0` ([#674](https://github.com/MetaMask/accounts/pull/674))
@@ -209,7 +215,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Add `AccountGroup` and `AccountWallet` ([#307](https://github.com/MetaMask/accounts/pull/307))
 
-[Unreleased]: https://github.com/MetaMask/accounts/compare/@metamask/account-api@2.1.1...HEAD
+[Unreleased]: https://github.com/MetaMask/accounts/compare/@metamask/account-api@2.2.0...HEAD
+[2.2.0]: https://github.com/MetaMask/accounts/compare/@metamask/account-api@2.1.1...@metamask/account-api@2.2.0
 [2.1.1]: https://github.com/MetaMask/accounts/compare/@metamask/account-api@2.1.0...@metamask/account-api@2.1.1
 [2.1.0]: https://github.com/MetaMask/accounts/compare/@metamask/account-api@2.0.0...@metamask/account-api@2.1.0
 [2.0.0]: https://github.com/MetaMask/accounts/compare/@metamask/account-api@1.1.1...@metamask/account-api@2.0.0

package/dist/api/index.cjs

@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./bip44.cjs"), exports);
 __exportStar(require("./group.cjs"), exports);
+__exportStar(require("./mpc.cjs"), exports);
 __exportStar(require("./wallet.cjs"), exports);
 __exportStar(require("./selector.cjs"), exports);
 __exportStar(require("./multichain/index.cjs"), exports);

package/dist/api/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAAwB;AACxB,8CAAwB;AACxB,+CAAyB;AAEzB,iDAA2B;AAC3B,yDAA6B;AAE7B,+CAA+C","sourcesContent":["export * from './bip44';\nexport * from './group';\nexport * from './wallet';\nexport type * from './provider';\nexport * from './selector';\nexport * from './multichain';\n\n// NOTE: Do not export the `internal` sub-path.\n"]}
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAAwB;AACxB,8CAAwB;AACxB,4CAAsB;AACtB,+CAAyB;AAEzB,iDAA2B;AAC3B,yDAA6B;AAE7B,+CAA+C","sourcesContent":["export * from './bip44';\nexport * from './group';\nexport * from './mpc';\nexport * from './wallet';\nexport type * from './provider';\nexport * from './selector';\nexport * from './multichain';\n\n// NOTE: Do not export the `internal` sub-path.\n"]}

package/dist/api/index.d.cts

@@ -1,5 +1,6 @@
 export * from "./bip44.cjs";
 export * from "./group.cjs";
+export * from "./mpc.cjs";
 export * from "./wallet.cjs";
 export type * from "./provider.cjs";
 export * from "./selector.cjs";

package/dist/api/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA,4BAAwB;AACxB,4BAAwB;AACxB,6BAAyB;AACzB,oCAAgC;AAChC,+BAA2B;AAC3B,uCAA6B"}
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA,4BAAwB;AACxB,4BAAwB;AACxB,0BAAsB;AACtB,6BAAyB;AACzB,oCAAgC;AAChC,+BAA2B;AAC3B,uCAA6B"}

package/dist/api/index.d.mts

@@ -1,5 +1,6 @@
 export * from "./bip44.mjs";
 export * from "./group.mjs";
+export * from "./mpc.mjs";
 export * from "./wallet.mjs";
 export type * from "./provider.mjs";
 export * from "./selector.mjs";

package/dist/api/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA,4BAAwB;AACxB,4BAAwB;AACxB,6BAAyB;AACzB,oCAAgC;AAChC,+BAA2B;AAC3B,uCAA6B"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA,4BAAwB;AACxB,4BAAwB;AACxB,0BAAsB;AACtB,6BAAyB;AACzB,oCAAgC;AAChC,+BAA2B;AAC3B,uCAA6B"}

package/dist/api/index.mjs

@@ -1,5 +1,6 @@
 export * from "./bip44.mjs";
 export * from "./group.mjs";
+export * from "./mpc.mjs";
 export * from "./wallet.mjs";
 export * from "./selector.mjs";
 export * from "./multichain/index.mjs";

package/dist/api/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA,4BAAwB;AACxB,4BAAwB;AACxB,6BAAyB;AAEzB,+BAA2B;AAC3B,uCAA6B;AAE7B,+CAA+C","sourcesContent":["export * from './bip44';\nexport * from './group';\nexport * from './wallet';\nexport type * from './provider';\nexport * from './selector';\nexport * from './multichain';\n\n// NOTE: Do not export the `internal` sub-path.\n"]}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA,4BAAwB;AACxB,4BAAwB;AACxB,0BAAsB;AACtB,6BAAyB;AAEzB,+BAA2B;AAC3B,uCAA6B;AAE7B,+CAA+C","sourcesContent":["export * from './bip44';\nexport * from './group';\nexport * from './mpc';\nexport * from './wallet';\nexport type * from './provider';\nexport * from './selector';\nexport * from './multichain';\n\n// NOTE: Do not export the `internal` sub-path.\n"]}

package/dist/api/mpc.cjs

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertIsMpcAccount = exports.isMpcAccount = void 0;
+const keyring_api_1 = require("@metamask/keyring-api");
+/**
+ * Checks if an account is an MPC account.
+ *
+ * @param account - The account to be tested.
+ * @returns True if the account is an MPC account.
+ */
+function isMpcAccount(account) {
+    // To be MPC compatible, we just check for the entropy type (the
+    // the `entropy` shape will be inferred automatically).
+    return (account.options.entropy?.type === `${keyring_api_1.KeyringAccountEntropyTypeOption.Mpc}`);
+}
+exports.isMpcAccount = isMpcAccount;
+/**
+ * Asserts a keyring account is an MPC account.
+ *
+ * @param account - Keyring account to check.
+ * @throws If the keyring account is not an MPC account.
+ */
+function assertIsMpcAccount(account) {
+    if (!isMpcAccount(account)) {
+        throw new Error('Account is not an MPC account');
+    }
+}
+exports.assertIsMpcAccount = assertIsMpcAccount;
+//# sourceMappingURL=mpc.cjs.map

package/dist/api/mpc.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"mpc.cjs","sourceRoot":"","sources":["../../src/api/mpc.ts"],"names":[],"mappings":";;;AAAA,uDAAwE;AAiBxE;;;;;GAKG;AACH,SAAgB,YAAY,CAC1B,OAAgB;IAEhB,gEAAgE;IAChE,uDAAuD;IACvD,OAAO,CACL,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,KAAK,GAAG,6CAA+B,CAAC,GAAG,EAAE,CAC3E,CAAC;AACJ,CAAC;AARD,oCAQC;AAED;;;;;GAKG;AACH,SAAgB,kBAAkB,CAChC,OAAgB;IAEhB,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC;QAC3B,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;IACnD,CAAC;AACH,CAAC;AAND,gDAMC","sourcesContent":["import { KeyringAccountEntropyTypeOption } from '@metamask/keyring-api';\nimport type {\n  KeyringAccount,\n  KeyringAccountEntropyMpcOptions,\n} from '@metamask/keyring-api';\n\n/**\n * MPC account type.\n */\nexport type MpcAccount<Account extends KeyringAccount> = Account & {\n  // We force the option type for those accounts. (That's how we identify\n  // if an account is MPC compatible).\n  options: {\n    entropy: KeyringAccountEntropyMpcOptions;\n  };\n};\n\n/**\n * Checks if an account is an MPC account.\n *\n * @param account - The account to be tested.\n * @returns True if the account is an MPC account.\n */\nexport function isMpcAccount<Account extends KeyringAccount>(\n  account: Account,\n): account is MpcAccount<Account> {\n  // To be MPC compatible, we just check for the entropy type (the\n  // the `entropy` shape will be inferred automatically).\n  return (\n    account.options.entropy?.type === `${KeyringAccountEntropyTypeOption.Mpc}`\n  );\n}\n\n/**\n * Asserts a keyring account is an MPC account.\n *\n * @param account - Keyring account to check.\n * @throws If the keyring account is not an MPC account.\n */\nexport function assertIsMpcAccount<Account extends KeyringAccount>(\n  account: Account,\n): asserts account is MpcAccount<Account> {\n  if (!isMpcAccount(account)) {\n    throw new Error('Account is not an MPC account');\n  }\n}\n"]}

package/dist/api/mpc.d.cts

@@ -0,0 +1,24 @@
+import type { KeyringAccount, KeyringAccountEntropyMpcOptions } from "@metamask/keyring-api";
+/**
+ * MPC account type.
+ */
+export type MpcAccount<Account extends KeyringAccount> = Account & {
+    options: {
+        entropy: KeyringAccountEntropyMpcOptions;
+    };
+};
+/**
+ * Checks if an account is an MPC account.
+ *
+ * @param account - The account to be tested.
+ * @returns True if the account is an MPC account.
+ */
+export declare function isMpcAccount<Account extends KeyringAccount>(account: Account): account is MpcAccount<Account>;
+/**
+ * Asserts a keyring account is an MPC account.
+ *
+ * @param account - Keyring account to check.
+ * @throws If the keyring account is not an MPC account.
+ */
+export declare function assertIsMpcAccount<Account extends KeyringAccount>(account: Account): asserts account is MpcAccount<Account>;
+//# sourceMappingURL=mpc.d.cts.map

package/dist/api/mpc.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mpc.d.cts","sourceRoot":"","sources":["../../src/api/mpc.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,cAAc,EACd,+BAA+B,EAChC,8BAA8B;AAE/B;;GAEG;AACH,MAAM,MAAM,UAAU,CAAC,OAAO,SAAS,cAAc,IAAI,OAAO,GAAG;IAGjE,OAAO,EAAE;QACP,OAAO,EAAE,+BAA+B,CAAC;KAC1C,CAAC;CACH,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,OAAO,SAAS,cAAc,EACzD,OAAO,EAAE,OAAO,GACf,OAAO,IAAI,UAAU,CAAC,OAAO,CAAC,CAMhC;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,SAAS,cAAc,EAC/D,OAAO,EAAE,OAAO,GACf,OAAO,CAAC,OAAO,IAAI,UAAU,CAAC,OAAO,CAAC,CAIxC"}

package/dist/api/mpc.d.mts

@@ -0,0 +1,24 @@
+import type { KeyringAccount, KeyringAccountEntropyMpcOptions } from "@metamask/keyring-api";
+/**
+ * MPC account type.
+ */
+export type MpcAccount<Account extends KeyringAccount> = Account & {
+    options: {
+        entropy: KeyringAccountEntropyMpcOptions;
+    };
+};
+/**
+ * Checks if an account is an MPC account.
+ *
+ * @param account - The account to be tested.
+ * @returns True if the account is an MPC account.
+ */
+export declare function isMpcAccount<Account extends KeyringAccount>(account: Account): account is MpcAccount<Account>;
+/**
+ * Asserts a keyring account is an MPC account.
+ *
+ * @param account - Keyring account to check.
+ * @throws If the keyring account is not an MPC account.
+ */
+export declare function assertIsMpcAccount<Account extends KeyringAccount>(account: Account): asserts account is MpcAccount<Account>;
+//# sourceMappingURL=mpc.d.mts.map

package/dist/api/mpc.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mpc.d.mts","sourceRoot":"","sources":["../../src/api/mpc.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,cAAc,EACd,+BAA+B,EAChC,8BAA8B;AAE/B;;GAEG;AACH,MAAM,MAAM,UAAU,CAAC,OAAO,SAAS,cAAc,IAAI,OAAO,GAAG;IAGjE,OAAO,EAAE;QACP,OAAO,EAAE,+BAA+B,CAAC;KAC1C,CAAC;CACH,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,OAAO,SAAS,cAAc,EACzD,OAAO,EAAE,OAAO,GACf,OAAO,IAAI,UAAU,CAAC,OAAO,CAAC,CAMhC;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,SAAS,cAAc,EAC/D,OAAO,EAAE,OAAO,GACf,OAAO,CAAC,OAAO,IAAI,UAAU,CAAC,OAAO,CAAC,CAIxC"}

package/dist/api/mpc.mjs

@@ -0,0 +1,24 @@
+import { KeyringAccountEntropyTypeOption } from "@metamask/keyring-api";
+/**
+ * Checks if an account is an MPC account.
+ *
+ * @param account - The account to be tested.
+ * @returns True if the account is an MPC account.
+ */
+export function isMpcAccount(account) {
+    // To be MPC compatible, we just check for the entropy type (the
+    // the `entropy` shape will be inferred automatically).
+    return (account.options.entropy?.type === `${KeyringAccountEntropyTypeOption.Mpc}`);
+}
+/**
+ * Asserts a keyring account is an MPC account.
+ *
+ * @param account - Keyring account to check.
+ * @throws If the keyring account is not an MPC account.
+ */
+export function assertIsMpcAccount(account) {
+    if (!isMpcAccount(account)) {
+        throw new Error('Account is not an MPC account');
+    }
+}
+//# sourceMappingURL=mpc.mjs.map

package/dist/api/mpc.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"mpc.mjs","sourceRoot":"","sources":["../../src/api/mpc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,+BAA+B,EAAE,8BAA8B;AAiBxE;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAC1B,OAAgB;IAEhB,gEAAgE;IAChE,uDAAuD;IACvD,OAAO,CACL,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,KAAK,GAAG,+BAA+B,CAAC,GAAG,EAAE,CAC3E,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAChC,OAAgB;IAEhB,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC;QAC3B,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;IACnD,CAAC;AACH,CAAC","sourcesContent":["import { KeyringAccountEntropyTypeOption } from '@metamask/keyring-api';\nimport type {\n  KeyringAccount,\n  KeyringAccountEntropyMpcOptions,\n} from '@metamask/keyring-api';\n\n/**\n * MPC account type.\n */\nexport type MpcAccount<Account extends KeyringAccount> = Account & {\n  // We force the option type for those accounts. (That's how we identify\n  // if an account is MPC compatible).\n  options: {\n    entropy: KeyringAccountEntropyMpcOptions;\n  };\n};\n\n/**\n * Checks if an account is an MPC account.\n *\n * @param account - The account to be tested.\n * @returns True if the account is an MPC account.\n */\nexport function isMpcAccount<Account extends KeyringAccount>(\n  account: Account,\n): account is MpcAccount<Account> {\n  // To be MPC compatible, we just check for the entropy type (the\n  // the `entropy` shape will be inferred automatically).\n  return (\n    account.options.entropy?.type === `${KeyringAccountEntropyTypeOption.Mpc}`\n  );\n}\n\n/**\n * Asserts a keyring account is an MPC account.\n *\n * @param account - Keyring account to check.\n * @throws If the keyring account is not an MPC account.\n */\nexport function assertIsMpcAccount<Account extends KeyringAccount>(\n  account: Account,\n): asserts account is MpcAccount<Account> {\n  if (!isMpcAccount(account)) {\n    throw new Error('Account is not an MPC account');\n  }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/account-api",
-  "version": "2.1.1-preview-3d69c27",
+  "version": "2.2.0-preview-5daa013",
   "description": "MetaMask Account API",
   "keywords": [
     "account",