@metamask-previews/keyring-internal-api 0.0.1-672cc7b

package/dist/internal/types.d.ts

@@ -0,0 +1,330 @@
+import { BtcAccountType, EthAccountType } from '@metamask/keyring-api';
+import type { Infer, Struct } from '@metamask/superstruct';
+export declare type InternalAccountType = EthAccountType | BtcAccountType;
+export declare const InternalAccountMetadataStruct: Struct<{
+    metadata: {
+        name: string;
+        importTime: number;
+        keyring: {
+            type: string;
+        };
+        nameLastUpdatedAt?: number;
+        snap?: {
+            id: string;
+            name: string;
+            enabled: boolean;
+        };
+        lastSelected?: number;
+    };
+}, {
+    metadata: Struct<{
+        name: string;
+        importTime: number;
+        keyring: {
+            type: string;
+        };
+        nameLastUpdatedAt?: number;
+        snap?: {
+            id: string;
+            name: string;
+            enabled: boolean;
+        };
+        lastSelected?: number;
+    }, {
+        name: Struct<string, null>;
+        nameLastUpdatedAt: Struct<number | import("@metamask/keyring-utils").ExactOptionalTag, null>;
+        snap: Struct<import("@metamask/keyring-utils").ExactOptionalTag | {
+            id: string;
+            name: string;
+            enabled: boolean;
+        }, {
+            id: Struct<string, null>;
+            enabled: Struct<boolean, null>;
+            name: Struct<string, null>;
+        }>;
+        lastSelected: Struct<number | import("@metamask/keyring-utils").ExactOptionalTag, null>;
+        importTime: Struct<number, null>;
+        keyring: Struct<{
+            type: string;
+        }, {
+            type: Struct<string, null>;
+        }>;
+    }>;
+}>;
+export declare const InternalEthEoaAccountStruct: Struct<{
+    id: string;
+    options: Record<string, import("@metamask/utils").Json>;
+    address: string;
+    type: "eip155:eoa";
+    methods: ("personal_sign" | "eth_sign" | "eth_signTransaction" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4")[];
+    metadata: {
+        name: string;
+        importTime: number;
+        keyring: {
+            type: string;
+        };
+        nameLastUpdatedAt?: number;
+        snap?: {
+            id: string;
+            name: string;
+            enabled: boolean;
+        };
+        lastSelected?: number;
+    };
+}, {
+    address: Struct<string, null>;
+    type: Struct<"eip155:eoa", "eip155:eoa">;
+    methods: Struct<("personal_sign" | "eth_sign" | "eth_signTransaction" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4")[], Struct<"personal_sign" | "eth_sign" | "eth_signTransaction" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4", {
+        personal_sign: "personal_sign";
+        eth_sign: "eth_sign";
+        eth_signTransaction: "eth_signTransaction";
+        eth_signTypedData_v1: "eth_signTypedData_v1";
+        eth_signTypedData_v3: "eth_signTypedData_v3";
+        eth_signTypedData_v4: "eth_signTypedData_v4";
+    }>>;
+    id: Struct<string, null>;
+    options: Struct<Record<string, import("@metamask/utils").Json>, null>;
+} & {
+    metadata: Struct<{
+        name: string;
+        importTime: number;
+        keyring: {
+            type: string;
+        };
+        nameLastUpdatedAt?: number;
+        snap?: {
+            id: string;
+            name: string;
+            enabled: boolean;
+        };
+        lastSelected?: number;
+    }, {
+        name: Struct<string, null>;
+        nameLastUpdatedAt: Struct<number | import("@metamask/keyring-utils").ExactOptionalTag, null>;
+        snap: Struct<import("@metamask/keyring-utils").ExactOptionalTag | {
+            id: string;
+            name: string;
+            enabled: boolean;
+        }, {
+            id: Struct<string, null>;
+            enabled: Struct<boolean, null>;
+            name: Struct<string, null>;
+        }>;
+        lastSelected: Struct<number | import("@metamask/keyring-utils").ExactOptionalTag, null>;
+        importTime: Struct<number, null>;
+        keyring: Struct<{
+            type: string;
+        }, {
+            type: Struct<string, null>;
+        }>;
+    }>;
+}>;
+export declare const InternalEthErc4337AccountStruct: Struct<{
+    id: string;
+    options: Record<string, import("@metamask/utils").Json>;
+    address: string;
+    type: "eip155:erc4337";
+    methods: ("personal_sign" | "eth_sign" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4" | "eth_prepareUserOperation" | "eth_patchUserOperation" | "eth_signUserOperation")[];
+    metadata: {
+        name: string;
+        importTime: number;
+        keyring: {
+            type: string;
+        };
+        nameLastUpdatedAt?: number;
+        snap?: {
+            id: string;
+            name: string;
+            enabled: boolean;
+        };
+        lastSelected?: number;
+    };
+}, {
+    address: Struct<string, null>;
+    type: Struct<"eip155:erc4337", "eip155:erc4337">;
+    methods: Struct<("personal_sign" | "eth_sign" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4" | "eth_prepareUserOperation" | "eth_patchUserOperation" | "eth_signUserOperation")[], Struct<"personal_sign" | "eth_sign" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4" | "eth_prepareUserOperation" | "eth_patchUserOperation" | "eth_signUserOperation", {
+        personal_sign: "personal_sign";
+        eth_sign: "eth_sign";
+        eth_signTypedData_v1: "eth_signTypedData_v1";
+        eth_signTypedData_v3: "eth_signTypedData_v3";
+        eth_signTypedData_v4: "eth_signTypedData_v4";
+        eth_prepareUserOperation: "eth_prepareUserOperation";
+        eth_patchUserOperation: "eth_patchUserOperation";
+        eth_signUserOperation: "eth_signUserOperation";
+    }>>;
+    id: Struct<string, null>;
+    options: Struct<Record<string, import("@metamask/utils").Json>, null>;
+} & {
+    metadata: Struct<{
+        name: string;
+        importTime: number;
+        keyring: {
+            type: string;
+        };
+        nameLastUpdatedAt?: number;
+        snap?: {
+            id: string;
+            name: string;
+            enabled: boolean;
+        };
+        lastSelected?: number;
+    }, {
+        name: Struct<string, null>;
+        nameLastUpdatedAt: Struct<number | import("@metamask/keyring-utils").ExactOptionalTag, null>;
+        snap: Struct<import("@metamask/keyring-utils").ExactOptionalTag | {
+            id: string;
+            name: string;
+            enabled: boolean;
+        }, {
+            id: Struct<string, null>;
+            enabled: Struct<boolean, null>;
+            name: Struct<string, null>;
+        }>;
+        lastSelected: Struct<number | import("@metamask/keyring-utils").ExactOptionalTag, null>;
+        importTime: Struct<number, null>;
+        keyring: Struct<{
+            type: string;
+        }, {
+            type: Struct<string, null>;
+        }>;
+    }>;
+}>;
+export declare const InternalBtcP2wpkhAccountStruct: Struct<{
+    id: string;
+    options: Record<string, import("@metamask/utils").Json>;
+    address: string;
+    type: "bip122:p2wpkh";
+    methods: "btc_sendmany"[];
+    metadata: {
+        name: string;
+        importTime: number;
+        keyring: {
+            type: string;
+        };
+        nameLastUpdatedAt?: number;
+        snap?: {
+            id: string;
+            name: string;
+            enabled: boolean;
+        };
+        lastSelected?: number;
+    };
+}, {
+    address: Struct<string, null>;
+    type: Struct<"bip122:p2wpkh", "bip122:p2wpkh">;
+    methods: Struct<"btc_sendmany"[], Struct<"btc_sendmany", {
+        btc_sendmany: "btc_sendmany";
+    }>>;
+    id: Struct<string, null>;
+    options: Struct<Record<string, import("@metamask/utils").Json>, null>;
+} & {
+    metadata: Struct<{
+        name: string;
+        importTime: number;
+        keyring: {
+            type: string;
+        };
+        nameLastUpdatedAt?: number;
+        snap?: {
+            id: string;
+            name: string;
+            enabled: boolean;
+        };
+        lastSelected?: number;
+    }, {
+        name: Struct<string, null>;
+        nameLastUpdatedAt: Struct<number | import("@metamask/keyring-utils").ExactOptionalTag, null>;
+        snap: Struct<import("@metamask/keyring-utils").ExactOptionalTag | {
+            id: string;
+            name: string;
+            enabled: boolean;
+        }, {
+            id: Struct<string, null>;
+            enabled: Struct<boolean, null>;
+            name: Struct<string, null>;
+        }>;
+        lastSelected: Struct<number | import("@metamask/keyring-utils").ExactOptionalTag, null>;
+        importTime: Struct<number, null>;
+        keyring: Struct<{
+            type: string;
+        }, {
+            type: Struct<string, null>;
+        }>;
+    }>;
+}>;
+export declare type InternalEthEoaAccount = Infer<typeof InternalEthEoaAccountStruct>;
+export declare type InternalEthErc4337Account = Infer<typeof InternalEthErc4337AccountStruct>;
+export declare type InternalBtcP2wpkhAccount = Infer<typeof InternalBtcP2wpkhAccountStruct>;
+export declare const InternalAccountStructs: Record<string, Struct<InternalEthEoaAccount> | Struct<InternalEthErc4337Account> | Struct<InternalBtcP2wpkhAccount>>;
+export declare type InternalAccountTypes = InternalEthEoaAccount | InternalEthErc4337Account | InternalBtcP2wpkhAccount;
+export declare const InternalAccountStruct: Struct<{
+    id: string;
+    options: Record<string, import("@metamask/utils").Json>;
+    address: string;
+    type: "eip155:eoa" | "eip155:erc4337" | "bip122:p2wpkh";
+    methods: string[];
+    metadata: {
+        name: string;
+        importTime: number;
+        keyring: {
+            type: string;
+        };
+        nameLastUpdatedAt?: number;
+        snap?: {
+            id: string;
+            name: string;
+            enabled: boolean;
+        };
+        lastSelected?: number;
+    };
+}, {
+    metadata: Struct<{
+        name: string;
+        importTime: number;
+        keyring: {
+            type: string;
+        };
+        nameLastUpdatedAt?: number;
+        snap?: {
+            id: string;
+            name: string;
+            enabled: boolean;
+        };
+        lastSelected?: number;
+    }, {
+        name: Struct<string, null>;
+        nameLastUpdatedAt: Struct<number | import("@metamask/keyring-utils").ExactOptionalTag, null>;
+        snap: Struct<import("@metamask/keyring-utils").ExactOptionalTag | {
+            id: string;
+            name: string;
+            enabled: boolean;
+        }, {
+            id: Struct<string, null>;
+            enabled: Struct<boolean, null>;
+            name: Struct<string, null>;
+        }>;
+        lastSelected: Struct<number | import("@metamask/keyring-utils").ExactOptionalTag, null>;
+        importTime: Struct<number, null>;
+        keyring: Struct<{
+            type: string;
+        }, {
+            type: Struct<string, null>;
+        }>;
+    }>;
+    id: Struct<string, null>;
+    type: Struct<"eip155:eoa" | "eip155:erc4337" | "bip122:p2wpkh", {
+        "eip155:eoa": "eip155:eoa";
+        "eip155:erc4337": "eip155:erc4337";
+        "bip122:p2wpkh": "bip122:p2wpkh";
+    }>;
+    address: Struct<string, null>;
+    options: Struct<Record<string, import("@metamask/utils").Json>, null>;
+    methods: Struct<string[], Struct<string, null>>;
+}>;
+/**
+ * Internal account representation.
+ *
+ * This type is used internally by MetaMask to add additional metadata to the
+ * account object. It's should not be used by external applications.
+ */
+export declare type InternalAccount = Infer<typeof InternalAccountStruct>;

package/dist/internal/types.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InternalAccountStruct = exports.InternalAccountStructs = exports.InternalBtcP2wpkhAccountStruct = exports.InternalEthErc4337AccountStruct = exports.InternalEthEoaAccountStruct = exports.InternalAccountMetadataStruct = void 0;
+const keyring_api_1 = require("@metamask/keyring-api");
+const keyring_utils_1 = require("@metamask/keyring-utils");
+const superstruct_1 = require("@metamask/superstruct");
+const types_1 = require("../btc/types");
+const types_2 = require("../eth/types");
+exports.InternalAccountMetadataStruct = (0, keyring_utils_1.object)({
+    metadata: (0, keyring_utils_1.object)({
+        name: (0, superstruct_1.string)(),
+        nameLastUpdatedAt: (0, keyring_utils_1.exactOptional)((0, superstruct_1.number)()),
+        snap: (0, keyring_utils_1.exactOptional)((0, keyring_utils_1.object)({
+            id: (0, superstruct_1.string)(),
+            enabled: (0, superstruct_1.boolean)(),
+            name: (0, superstruct_1.string)(),
+        })),
+        lastSelected: (0, keyring_utils_1.exactOptional)((0, superstruct_1.number)()),
+        importTime: (0, superstruct_1.number)(),
+        keyring: (0, keyring_utils_1.object)({
+            type: (0, superstruct_1.string)(),
+        }),
+    }),
+});
+/**
+ * Creates an `InternalAccount` from an existing account `superstruct` object.
+ *
+ * @param accountStruct - An account `superstruct` object.
+ * @returns The `InternalAccount` associated to `accountStruct`.
+ */
+function asInternalAccountStruct(accountStruct) {
+    return (0, keyring_utils_1.object)({
+        ...accountStruct.schema,
+        ...exports.InternalAccountMetadataStruct.schema,
+    });
+}
+exports.InternalEthEoaAccountStruct = asInternalAccountStruct(types_2.EthEoaAccountStruct);
+exports.InternalEthErc4337AccountStruct = asInternalAccountStruct(types_2.EthErc4337AccountStruct);
+exports.InternalBtcP2wpkhAccountStruct = asInternalAccountStruct(types_1.BtcP2wpkhAccountStruct);
+exports.InternalAccountStructs = {
+    [`${keyring_api_1.EthAccountType.Eoa}`]: exports.InternalEthEoaAccountStruct,
+    [`${keyring_api_1.EthAccountType.Erc4337}`]: exports.InternalEthErc4337AccountStruct,
+    [`${keyring_api_1.BtcAccountType.P2wpkh}`]: exports.InternalBtcP2wpkhAccountStruct,
+};
+exports.InternalAccountStruct = (0, keyring_utils_1.object)({
+    ...keyring_api_1.KeyringAccountStruct.schema,
+    ...exports.InternalAccountMetadataStruct.schema,
+});
+//# sourceMappingURL=types.js.map

package/dist/internal/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/internal/types.ts"],"names":[],"mappings":";;;AAAA,uDAI+B;AAC/B,2DAAgE;AAEhE,uDAAgE;AAEhE,wCAAsD;AACtD,wCAA4E;AAI/D,QAAA,6BAA6B,GAAG,IAAA,sBAAM,EAAC;IAClD,QAAQ,EAAE,IAAA,sBAAM,EAAC;QACf,IAAI,EAAE,IAAA,oBAAM,GAAE;QACd,iBAAiB,EAAE,IAAA,6BAAa,EAAC,IAAA,oBAAM,GAAE,CAAC;QAC1C,IAAI,EAAE,IAAA,6BAAa,EACjB,IAAA,sBAAM,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,6BAAa,EAAC,IAAA,oBAAM,GAAE,CAAC;QACrC,UAAU,EAAE,IAAA,oBAAM,GAAE;QACpB,OAAO,EAAE,IAAA,sBAAM,EAAC;YACd,IAAI,EAAE,IAAA,oBAAM,GAAE;SACf,CAAC;KACH,CAAC;CACH,CAAC,CAAC;AAEH;;;;;GAKG;AACH,SAAS,uBAAuB,CAC9B,aAA6C;IAE7C,OAAO,IAAA,sBAAM,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,4BAAc,CAAC,GAAG,EAAE,CAAC,EAAE,mCAA2B;IACtD,CAAC,GAAG,4BAAc,CAAC,OAAO,EAAE,CAAC,EAAE,uCAA+B;IAC9D,CAAC,GAAG,4BAAc,CAAC,MAAM,EAAE,CAAC,EAAE,sCAA8B;CAC7D,CAAC;AAOW,QAAA,qBAAqB,GAAG,IAAA,sBAAM,EAAC;IAC1C,GAAG,kCAAoB,CAAC,MAAM;IAC9B,GAAG,qCAA6B,CAAC,MAAM;CACxC,CAAC,CAAC","sourcesContent":["import {\n  BtcAccountType,\n  EthAccountType,\n  KeyringAccountStruct,\n} from '@metamask/keyring-api';\nimport { exactOptional, object } from '@metamask/keyring-utils';\nimport type { Infer, Struct } from '@metamask/superstruct';\nimport { boolean, string, number } from '@metamask/superstruct';\n\nimport { BtcP2wpkhAccountStruct } from '../btc/types';\nimport { EthEoaAccountStruct, EthErc4337AccountStruct } from '../eth/types';\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

@@ -0,0 +1,78 @@
+{
+  "name": "@metamask-previews/keyring-internal-api",
+  "version": "0.0.1-672cc7b",
+  "description": "MetaMask Keyring Internal API",
+  "keywords": [
+    "metamask",
+    "keyring"
+  ],
+  "homepage": "https://github.com/MetaMask/accounts/tree/main/packages/keyring-internal-api#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/accounts/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MetaMask/accounts.git"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist/"
+  ],
+  "scripts": {
+    "build": "tsc --build tsconfig.build.json",
+    "build:clean": "rimraf dist && yarn build",
+    "build:docs": "typedoc",
+    "build:force": "tsc --build tsconfig.build.json --force",
+    "changelog:update": "../../scripts/update-changelog.sh @metamask/keyring-internal-api",
+    "changelog:validate": "../../scripts/validate-changelog.sh @metamask/keyring-internal-api",
+    "publish:preview": "yarn npm publish --tag preview",
+    "test": "yarn test:source && yarn test:types",
+    "test:clean": "jest --clearCache",
+    "test:source": "jest && jest-it-up",
+    "test:types": "tsd",
+    "test:verbose": "jest --verbose",
+    "test:watch": "jest --watch"
+  },
+  "dependencies": {
+    "@metamask/keyring-api": "^8.1.0",
+    "@metamask/keyring-utils": "0.0.1",
+    "@metamask/snaps-sdk": "^6.1.0",
+    "@metamask/superstruct": "^3.1.0",
+    "@metamask/utils": "^9.1.0",
+    "bech32": "^2.0.0",
+    "deepmerge": "^4.2.2"
+  },
+  "devDependencies": {
+    "@lavamoat/allow-scripts": "^3.0.4",
+    "@lavamoat/preinstall-always-fail": "^2.0.0",
+    "@metamask/auto-changelog": "^3.4.4",
+    "@metamask/providers": "^17.1.1",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.12.12",
+    "depcheck": "^1.4.7",
+    "jest": "^28.1.3",
+    "jest-it-up": "^3.1.0",
+    "rimraf": "^5.0.7",
+    "ts-jest": "^28.0.8",
+    "ts-node": "^10.9.2",
+    "tsd": "^0.31.0",
+    "typedoc": "^0.25.13",
+    "typescript": "~4.8.4"
+  },
+  "engines": {
+    "node": "^18.18 || >=20"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "lavamoat": {
+    "allowScripts": {
+      "@lavamoat/preinstall-always-fail": false
+    }
+  },
+  "tsd": {
+    "directory": "src"
+  }
+}