@metamask-previews/eth-money-keyring 2.0.0-8ff7ba2

package/CHANGELOG.md

@@ -0,0 +1,44 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [2.0.0]
+
+### Added
+
+- Support custom cryptographic functions ([#491](https://github.com/MetaMask/accounts/pull/491))
+  - Those functions are forwarded to the inner `HdKeyring`.
+
+### Changed
+
+- **BREAKING:** Replace inheritance with composition; `MoneyKeyring` now wraps an inner `HdKeyring` instead of extending it ([#484](https://github.com/MetaMask/accounts/pull/484)), ([#492](https://github.com/MetaMask/accounts/pull/488), [#488](https://github.com/MetaMask/accounts/pull/492))
+  - Constructor now requires a `MoneyKeyringOptions` object with a `getMnemonic` callback. The `entropySource` is set by `deserialize()` from the serialized state.
+  - The inner `HdKeyring` is created on the first signing call (lazily), protected by a mutex to ensure single initialization under concurrency.
+  - Serialized state now stores `entropySource` instead of `mnemonic`; the mnemonic is resolved at deserialization time via the callback.
+  - Serialized state now stores `account` (the derived address) instead of `numberOfAccounts`; the account is restored directly from state without calling `getMnemonic`.
+  - `hdPath` is no longer part of the serialized state; it is always `MONEY_DERIVATION_PATH`.
+  - `signMessage`, `getEncryptionPublicKey`, `decryptMessage`, `exportAccount`, and `getAppKeyAddress` are no longer exposed.
+  - `removeAccount()` has been removed; accounts are permanent once added.
+  - `getAccounts()` is now a cheap synchronous-like read that never triggers `getMnemonic`.
+  - New exports: `GetMnemonicCallback`, `MoneyKeyringOptions` types.
+  - New dependency: `@metamask/keyring-utils` (for `Keyring` interface).
+  - New dependency: `async-mutex`.
+
+## [1.0.0] - 2026-04-01 [DEPRECATED]
+
+### Added
+
+- Add initial implementation of `MoneyKeyring` ([#472](https://github.com/MetaMask/accounts/pull/472), [#474](https://github.com/MetaMask/accounts/pull/474))
+  - Extends `HdKeyring` from `@metamask/eth-hd-keyring`.
+  - Uses keyring type `"Money Keyring"`.
+  - Uses derivation path `"m/44'/4392018'/0'/0"`.
+  - Enforces that at most one Money account can exist.
+
+[Unreleased]: https://github.com/MetaMask/accounts/compare/@metamask/eth-money-keyring@2.0.0...HEAD
+[2.0.0]: https://github.com/MetaMask/accounts/compare/@metamask/eth-money-keyring@1.0.0...@metamask/eth-money-keyring@2.0.0
+[1.0.0]: https://github.com/MetaMask/accounts/releases/tag/@metamask/eth-money-keyring@1.0.0

package/LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2020 MetaMask
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -0,0 +1,38 @@
+# Money Keyring
+
+An Ethereum keyring that extends [`@metamask/eth-hd-keyring`](../keyring-eth-hd) with a distinct keyring type and derivation path for money accounts.
+
+Money accounts use a separate HD derivation path to keep funds isolated from the primary HD keyring, while reusing the same seed phrase and signing infrastructure.
+
+## Installation
+
+`yarn add @metamask/eth-money-keyring`
+
+or
+
+`npm install @metamask/eth-money-keyring`
+
+## Usage
+
+```ts
+import { MoneyKeyring } from '@metamask/eth-money-keyring';
+
+const keyring = new MoneyKeyring();
+```
+
+The `MoneyKeyring` class implements the same `Keyring` interface as `HdKeyring` — see the [HD Keyring README](../keyring-eth-hd/README.md) for full API documentation.
+
+## Contributing
+
+### Setup
+
+- Install [Node.js](https://nodejs.org) version 18
+  - If you are using [nvm](https://github.com/creationix/nvm#installation) (recommended) running `nvm use` will automatically choose the right node version for you.
+- Install [Yarn v4](https://yarnpkg.com/getting-started/install)
+- Run `yarn install` to install dependencies and run any required post-install scripts
+
+### Testing and Linting
+
+Run `yarn test` to run the tests once.
+
+Run `yarn lint` to run the linter, or run `yarn lint:fix` to run the linter and fix any automatically fixable issues.

package/dist/index.cjs

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MONEY_DERIVATION_PATH = exports.MoneyKeyring = void 0;
+var money_keyring_1 = require("./money-keyring.cjs");
+Object.defineProperty(exports, "MoneyKeyring", { enumerable: true, get: function () { return money_keyring_1.MoneyKeyring; } });
+Object.defineProperty(exports, "MONEY_DERIVATION_PATH", { enumerable: true, get: function () { return money_keyring_1.MONEY_DERIVATION_PATH; } });
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,qDAMyB;AALvB,6GAAA,YAAY,OAAA;AACZ,sHAAA,qBAAqB,OAAA","sourcesContent":["export {\n  MoneyKeyring,\n  MONEY_DERIVATION_PATH,\n  type GetMnemonicCallback,\n  type MoneyKeyringOptions,\n  type MoneyKeyringSerializedState,\n} from './money-keyring';\n"]}

package/dist/index.d.cts

@@ -0,0 +1,2 @@
+export { MoneyKeyring, MONEY_DERIVATION_PATH, type GetMnemonicCallback, type MoneyKeyringOptions, type MoneyKeyringSerializedState, } from "./money-keyring.cjs";
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EACZ,qBAAqB,EACrB,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EACxB,KAAK,2BAA2B,GACjC,4BAAwB"}

package/dist/index.d.mts

@@ -0,0 +1,2 @@
+export { MoneyKeyring, MONEY_DERIVATION_PATH, type GetMnemonicCallback, type MoneyKeyringOptions, type MoneyKeyringSerializedState, } from "./money-keyring.mjs";
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EACZ,qBAAqB,EACrB,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EACxB,KAAK,2BAA2B,GACjC,4BAAwB"}

package/dist/index.mjs

@@ -0,0 +1,2 @@
+export { MoneyKeyring, MONEY_DERIVATION_PATH } from "./money-keyring.mjs";
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EACZ,qBAAqB,EAItB,4BAAwB","sourcesContent":["export {\n  MoneyKeyring,\n  MONEY_DERIVATION_PATH,\n  type GetMnemonicCallback,\n  type MoneyKeyringOptions,\n  type MoneyKeyringSerializedState,\n} from './money-keyring';\n"]}

package/dist/money-keyring.cjs

@@ -0,0 +1,178 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _MoneyKeyring_instances, _MoneyKeyring_getMnemonic, _MoneyKeyring_cryptographicFunctions, _MoneyKeyring_entropySource, _MoneyKeyring_account, _MoneyKeyring_inner, _MoneyKeyring_lock, _MoneyKeyring_withLockedInner, _MoneyKeyring_getSigner;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MoneyKeyring = exports.MONEY_KEYRING_TYPE = exports.MONEY_DERIVATION_PATH = void 0;
+const eth_hd_keyring_1 = require("@metamask/eth-hd-keyring");
+const keyring_api_1 = require("@metamask/keyring-api");
+const superstruct_1 = require("@metamask/superstruct");
+const async_mutex_1 = require("async-mutex");
+/**
+ * Based on the SLIP-10 coin type: https://github.com/satoshilabs/slips/pull/1983
+ */
+exports.MONEY_DERIVATION_PATH = `m/44'/4392018'/0'/0`;
+/**
+ * The unique type identifier for the {@link MoneyKeyring}.
+ */
+exports.MONEY_KEYRING_TYPE = 'Money Keyring';
+/**
+ * Struct for validating the serialized state of a {@link MoneyKeyring}.
+ *
+ * @property entropySource - The entropy source identifier.
+ * @property account - The account address, if one has been added.
+ */
+const MoneyKeyringSerializedStateStruct = (0, superstruct_1.object)({
+    entropySource: (0, superstruct_1.string)(),
+    account: (0, superstruct_1.optional)(keyring_api_1.EthAddressStrictStruct),
+});
+/**
+ * Keyring used to create and manage Money Accounts. It wraps an inner {@link HdKeyring}
+ * and enforces a specific HD path and a limit on the number of accounts. The mnemonic
+ * is never stored in the serialized state; instead, it is resolved at deserialization
+ * time via a callback.
+ *
+ * The inner {@link HdKeyring} is instantiated lazily on the first signing operation
+ * (via {@link MoneyKeyring.#getSigner}). A mutex ensures that concurrent callers never
+ * trigger more than one initialization.
+ */
+class MoneyKeyring {
+    constructor({ getMnemonic, cryptographicFunctions }) {
+        _MoneyKeyring_instances.add(this);
+        this.type = exports.MONEY_KEYRING_TYPE;
+        _MoneyKeyring_getMnemonic.set(this, void 0);
+        _MoneyKeyring_cryptographicFunctions.set(this, void 0);
+        _MoneyKeyring_entropySource.set(this, void 0);
+        _MoneyKeyring_account.set(this, void 0);
+        _MoneyKeyring_inner.set(this, void 0);
+        _MoneyKeyring_lock.set(this, new async_mutex_1.Mutex());
+        __classPrivateFieldSet(this, _MoneyKeyring_getMnemonic, getMnemonic, "f");
+        __classPrivateFieldSet(this, _MoneyKeyring_cryptographicFunctions, cryptographicFunctions, "f");
+    }
+    get entropySource() {
+        return __classPrivateFieldGet(this, _MoneyKeyring_entropySource, "f");
+    }
+    async serialize() {
+        const state = {
+            entropySource: __classPrivateFieldGet(this, _MoneyKeyring_entropySource, "f"),
+            account: __classPrivateFieldGet(this, _MoneyKeyring_account, "f"),
+        };
+        (0, superstruct_1.assert)(state, MoneyKeyringSerializedStateStruct);
+        return state;
+    }
+    async deserialize(state) {
+        (0, superstruct_1.assert)(state, MoneyKeyringSerializedStateStruct);
+        if (__classPrivateFieldGet(this, _MoneyKeyring_entropySource, "f") !== undefined) {
+            throw new Error('MoneyKeyring: cannot deserialize after initialization');
+        }
+        __classPrivateFieldSet(this, _MoneyKeyring_entropySource, state.entropySource, "f");
+        __classPrivateFieldSet(this, _MoneyKeyring_account, state.account, "f");
+    }
+    /**
+     * Add the single Money account to this keyring.
+     *
+     * @param numberOfAccounts - Must be 1 (the only supported value).
+     * @returns The address of the newly added account.
+     * @throws If `numberOfAccounts` is not 1 or an account already exists.
+     */
+    async addAccounts(numberOfAccounts = 1) {
+        if (numberOfAccounts !== 1) {
+            throw new Error('MoneyKeyring: supports adding exactly one account');
+        }
+        return await __classPrivateFieldGet(this, _MoneyKeyring_instances, "m", _MoneyKeyring_withLockedInner).call(this, async (inner) => {
+            if (__classPrivateFieldGet(this, _MoneyKeyring_account, "f") !== undefined) {
+                throw new Error('MoneyKeyring: already has an account');
+            }
+            const [account] = await inner.addAccounts(1);
+            if (!account) {
+                throw new Error('MoneyKeyring: failed to add account');
+            }
+            __classPrivateFieldSet(this, _MoneyKeyring_account, account, "f");
+            return [account];
+        });
+    }
+    // -----------------------------------------------------------------------------------
+    // The methods below are pass-throughs to the inner HdKeyring.
+    async getAccounts() {
+        return __classPrivateFieldGet(this, _MoneyKeyring_account, "f") ? [__classPrivateFieldGet(this, _MoneyKeyring_account, "f")] : [];
+    }
+    async signTransaction(...args) {
+        return (await __classPrivateFieldGet(this, _MoneyKeyring_instances, "m", _MoneyKeyring_getSigner).call(this)).signTransaction(...args);
+    }
+    async signPersonalMessage(...args) {
+        return (await __classPrivateFieldGet(this, _MoneyKeyring_instances, "m", _MoneyKeyring_getSigner).call(this)).signPersonalMessage(...args);
+    }
+    async signTypedData(...args) {
+        return (await __classPrivateFieldGet(this, _MoneyKeyring_instances, "m", _MoneyKeyring_getSigner).call(this)).signTypedData(...args);
+    }
+    async signEip7702Authorization(...args) {
+        return (await __classPrivateFieldGet(this, _MoneyKeyring_instances, "m", _MoneyKeyring_getSigner).call(this)).signEip7702Authorization(...args);
+    }
+}
+exports.MoneyKeyring = MoneyKeyring;
+_MoneyKeyring_getMnemonic = new WeakMap(), _MoneyKeyring_cryptographicFunctions = new WeakMap(), _MoneyKeyring_entropySource = new WeakMap(), _MoneyKeyring_account = new WeakMap(), _MoneyKeyring_inner = new WeakMap(), _MoneyKeyring_lock = new WeakMap(), _MoneyKeyring_instances = new WeakSet(), _MoneyKeyring_withLockedInner = 
+/**
+ * Runs a callback with the initialized inner {@link HdKeyring}, always within
+ * the mutex lock. Initializes {@link HdKeyring} on the first call.
+ *
+ * The initialization is deferred until first needed so that the potentially
+ * expensive {@link GetMnemonicCallback} is not invoked during
+ * {@link MoneyKeyring.deserialize} or {@link MoneyKeyring.getAccounts}.
+ *
+ * @param callback - Function to execute with the initialized inner keyring.
+ * @returns The result of the callback.
+ */
+async function _MoneyKeyring_withLockedInner(callback) {
+    const entropySource = __classPrivateFieldGet(this, _MoneyKeyring_entropySource, "f");
+    if (!entropySource) {
+        throw new Error('MoneyKeyring: not yet deserialized');
+    }
+    return __classPrivateFieldGet(this, _MoneyKeyring_lock, "f").runExclusive(async () => {
+        if (!__classPrivateFieldGet(this, _MoneyKeyring_inner, "f")) {
+            const mnemonic = await __classPrivateFieldGet(this, _MoneyKeyring_getMnemonic, "f").call(this, entropySource);
+            const inner = new eth_hd_keyring_1.HdKeyring({
+                cryptographicFunctions: __classPrivateFieldGet(this, _MoneyKeyring_cryptographicFunctions, "f"),
+            });
+            await inner.deserialize({
+                mnemonic,
+                numberOfAccounts: __classPrivateFieldGet(this, _MoneyKeyring_account, "f") ? 1 : 0,
+                hdPath: exports.MONEY_DERIVATION_PATH,
+            });
+            if (__classPrivateFieldGet(this, _MoneyKeyring_account, "f")) {
+                const [derivedAccount] = await inner.getAccounts();
+                if (derivedAccount?.toLowerCase() !== __classPrivateFieldGet(this, _MoneyKeyring_account, "f").toLowerCase()) {
+                    throw new Error('MoneyKeyring: signer account mismatch');
+                }
+            }
+            __classPrivateFieldSet(this, _MoneyKeyring_inner, inner, "f");
+        }
+        return callback(__classPrivateFieldGet(this, _MoneyKeyring_inner, "f"));
+    });
+}, _MoneyKeyring_getSigner = 
+/**
+ * Returns the initialized inner {@link HdKeyring}.
+ *
+ * Uses a fast path if already initialized, otherwise delegates to
+ * {@link MoneyKeyring.#withLockedInner}.
+ *
+ * @returns The EVM signer instance.
+ */
+async function _MoneyKeyring_getSigner() {
+    if (__classPrivateFieldGet(this, _MoneyKeyring_inner, "f")) {
+        return __classPrivateFieldGet(this, _MoneyKeyring_inner, "f");
+    }
+    // We use the mutex-protected method to initialize the inner keyring if needed, but once
+    // initialized, we can return it directly and use it as the signer instance.
+    return await __classPrivateFieldGet(this, _MoneyKeyring_instances, "m", _MoneyKeyring_withLockedInner).call(this, (inner) => inner);
+};
+MoneyKeyring.type = exports.MONEY_KEYRING_TYPE;
+//# sourceMappingURL=money-keyring.cjs.map

package/dist/money-keyring.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"money-keyring.cjs","sourceRoot":"","sources":["../src/money-keyring.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,6DAAqD;AAErD,uDAA+D;AAE/D,uDAM+B;AAE/B,6CAAoC;AAEpC;;GAEG;AACU,QAAA,qBAAqB,GAAG,qBAAqB,CAAC;AAE3D;;GAEG;AACU,QAAA,kBAAkB,GAAG,eAAe,CAAC;AA8BlD;;;;;GAKG;AACH,MAAM,iCAAiC,GAAG,IAAA,oBAAM,EAAC;IAC/C,aAAa,EAAE,IAAA,oBAAY,GAAE;IAC7B,OAAO,EAAE,IAAA,sBAAQ,EAAC,oCAAsB,CAAC;CAC1C,CAAC,CAAC;AASH;;;;;;;;;GASG;AACH,MAAa,YAAY;IAiBvB,YAAY,EAAE,WAAW,EAAE,sBAAsB,EAAuB;;QAd/D,SAAI,GAAW,0BAAkB,CAAC;QAElC,4CAAkC;QAElC,uDAA4D;QAErE,8CAAmC;QAEnC,wCAA0B;QAE1B,sCAA8B;QAErB,6BAAQ,IAAI,mBAAK,EAAE,EAAC;QAG3B,uBAAA,IAAI,6BAAgB,WAAW,MAAA,CAAC;QAChC,uBAAA,IAAI,wCAA2B,sBAAsB,MAAA,CAAC;IACxD,CAAC;IAED,IAAI,aAAa;QACf,OAAO,uBAAA,IAAI,mCAAe,CAAC;IAC7B,CAAC;IAED,KAAK,CAAC,SAAS;QACb,MAAM,KAAK,GAAG;YACZ,aAAa,EAAE,uBAAA,IAAI,mCAAe;YAClC,OAAO,EAAE,uBAAA,IAAI,6BAAS;SACvB,CAAC;QACF,IAAA,oBAAM,EAAC,KAAK,EAAE,iCAAiC,CAAC,CAAC;QAEjD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,KAAkC;QAClD,IAAA,oBAAM,EAAC,KAAK,EAAE,iCAAiC,CAAC,CAAC;QAEjD,IAAI,uBAAA,IAAI,mCAAe,KAAK,SAAS,EAAE,CAAC;YACtC,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;QAC3E,CAAC;QAED,uBAAA,IAAI,+BAAkB,KAAK,CAAC,aAAa,MAAA,CAAC;QAC1C,uBAAA,IAAI,yBAAY,KAAK,CAAC,OAAO,MAAA,CAAC;IAChC,CAAC;IAiED;;;;;;OAMG;IACH,KAAK,CAAC,WAAW,CAAC,gBAAgB,GAAG,CAAC;QACpC,IAAI,gBAAgB,KAAK,CAAC,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;QACvE,CAAC;QAED,OAAO,MAAM,uBAAA,IAAI,8DAAiB,MAArB,IAAI,EAAkB,KAAK,EAAE,KAAK,EAAE,EAAE;YACjD,IAAI,uBAAA,IAAI,6BAAS,KAAK,SAAS,EAAE,CAAC;gBAChC,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;YAC1D,CAAC;YAED,MAAM,CAAC,OAAO,CAAC,GAAG,MAAM,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;YAC7C,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;YACzD,CAAC;YACD,uBAAA,IAAI,yBAAY,OAAO,MAAA,CAAC;YAExB,OAAO,CAAC,OAAO,CAAC,CAAC;QACnB,CAAC,CAAC,CAAC;IACL,CAAC;IAED,sFAAsF;IACtF,8DAA8D;IAE9D,KAAK,CAAC,WAAW;QACf,OAAO,uBAAA,IAAI,6BAAS,CAAC,CAAC,CAAC,CAAC,uBAAA,IAAI,6BAAS,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC9C,CAAC;IAED,KAAK,CAAC,eAAe,CACnB,GAAG,IAA8C;QAEjD,OAAO,CAAC,MAAM,uBAAA,IAAI,wDAAW,MAAf,IAAI,CAAa,CAAC,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,CAAC;IAC5D,CAAC;IAED,KAAK,CAAC,mBAAmB,CACvB,GAAG,IAAkD;QAErD,OAAO,CAAC,MAAM,uBAAA,IAAI,wDAAW,MAAf,IAAI,CAAa,CAAC,CAAC,mBAAmB,CAAC,GAAG,IAAI,CAAC,CAAC;IAChE,CAAC;IAED,KAAK,CAAC,aAAa,CACjB,GAAG,IAA4C;QAE/C,OAAO,CAAC,MAAM,uBAAA,IAAI,wDAAW,MAAf,IAAI,CAAa,CAAC,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,CAAC;IAC1D,CAAC;IAED,KAAK,CAAC,wBAAwB,CAC5B,GAAG,IAAuD;QAE1D,OAAO,CAAC,MAAM,uBAAA,IAAI,wDAAW,MAAf,IAAI,CAAa,CAAC,CAAC,wBAAwB,CAAC,GAAG,IAAI,CAAC,CAAC;IACrE,CAAC;;AAtKH,oCAuKC;;AAxHC;;;;;;;;;;GAUG;AACH,KAAK,wCACH,QAAgE;IAEhE,MAAM,aAAa,GAAG,uBAAA,IAAI,mCAAe,CAAC;IAC1C,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;IACxD,CAAC;IAED,OAAO,uBAAA,IAAI,0BAAM,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;QACxC,IAAI,CAAC,uBAAA,IAAI,2BAAO,EAAE,CAAC;YACjB,MAAM,QAAQ,GAAG,MAAM,uBAAA,IAAI,iCAAa,MAAjB,IAAI,EAAc,aAAa,CAAC,CAAC;YACxD,MAAM,KAAK,GAAG,IAAI,0BAAS,CAAC;gBAC1B,sBAAsB,EAAE,uBAAA,IAAI,4CAAwB;aACrD,CAAC,CAAC;YACH,MAAM,KAAK,CAAC,WAAW,CAAC;gBACtB,QAAQ;gBACR,gBAAgB,EAAE,uBAAA,IAAI,6BAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBACvC,MAAM,EAAE,6BAAqB;aAC9B,CAAC,CAAC;YAEH,IAAI,uBAAA,IAAI,6BAAS,EAAE,CAAC;gBAClB,MAAM,CAAC,cAAc,CAAC,GAAG,MAAM,KAAK,CAAC,WAAW,EAAE,CAAC;gBACnD,IAAI,cAAc,EAAE,WAAW,EAAE,KAAK,uBAAA,IAAI,6BAAS,CAAC,WAAW,EAAE,EAAE,CAAC;oBAClE,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;gBAC3D,CAAC;YACH,CAAC;YAED,uBAAA,IAAI,uBAAU,KAAK,MAAA,CAAC;QACtB,CAAC;QAED,OAAO,QAAQ,CAAC,uBAAA,IAAI,2BAAO,CAAC,CAAC;IAC/B,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;GAOG;AACH,KAAK;IACH,IAAI,uBAAA,IAAI,2BAAO,EAAE,CAAC;QAChB,OAAO,uBAAA,IAAI,2BAAO,CAAC;IACrB,CAAC;IAED,wFAAwF;IACxF,4EAA4E;IAC5E,OAAO,MAAM,uBAAA,IAAI,8DAAiB,MAArB,IAAI,EAAkB,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;AACvD,CAAC;AA3GM,iBAAI,GAAW,0BAAkB,AAA7B,CAA8B","sourcesContent":["import { HdKeyring } from '@metamask/eth-hd-keyring';\nimport { type CryptographicFunctions } from '@metamask/key-tree';\nimport { EthAddressStrictStruct } from '@metamask/keyring-api';\nimport type { Keyring } from '@metamask/keyring-utils';\nimport {\n  assert,\n  type Infer,\n  object,\n  optional,\n  string as stringStruct,\n} from '@metamask/superstruct';\nimport { type Hex } from '@metamask/utils';\nimport { Mutex } from 'async-mutex';\n\n/**\n * Based on the SLIP-10 coin type: https://github.com/satoshilabs/slips/pull/1983\n */\nexport const MONEY_DERIVATION_PATH = `m/44'/4392018'/0'/0`;\n\n/**\n * The unique type identifier for the {@link MoneyKeyring}.\n */\nexport const MONEY_KEYRING_TYPE = 'Money Keyring';\n\n/**\n * Callback used to resolve a mnemonic from an entropy source ID.\n *\n * @param entropySource - The entropy source identifier.\n * @returns The mnemonic as an array of UTF-8 byte values.\n */\nexport type GetMnemonicCallback = (entropySource: string) => Promise<number[]>;\n\n/**\n * EVM signer interface, a subset of {@link HdKeyring} methods.\n */\nexport type EvmSigner = {\n  signTransaction: HdKeyring['signTransaction'];\n  signPersonalMessage: HdKeyring['signPersonalMessage'];\n  signTypedData: HdKeyring['signTypedData'];\n  signEip7702Authorization: HdKeyring['signEip7702Authorization'];\n};\n\n/**\n * Options for constructing a {@link MoneyKeyring}.\n *\n * @property getMnemonic - Callback to resolve the mnemonic from an entropy source ID.\n */\nexport type MoneyKeyringOptions = {\n  getMnemonic: GetMnemonicCallback;\n  cryptographicFunctions?: CryptographicFunctions;\n};\n\n/**\n * Struct for validating the serialized state of a {@link MoneyKeyring}.\n *\n * @property entropySource - The entropy source identifier.\n * @property account - The account address, if one has been added.\n */\nconst MoneyKeyringSerializedStateStruct = object({\n  entropySource: stringStruct(),\n  account: optional(EthAddressStrictStruct),\n});\n\n/**\n * The serialized state of a {@link MoneyKeyring} instance.\n */\nexport type MoneyKeyringSerializedState = Infer<\n  typeof MoneyKeyringSerializedStateStruct\n>;\n\n/**\n * Keyring used to create and manage Money Accounts. It wraps an inner {@link HdKeyring}\n * and enforces a specific HD path and a limit on the number of accounts. The mnemonic\n * is never stored in the serialized state; instead, it is resolved at deserialization\n * time via a callback.\n *\n * The inner {@link HdKeyring} is instantiated lazily on the first signing operation\n * (via {@link MoneyKeyring.#getSigner}). A mutex ensures that concurrent callers never\n * trigger more than one initialization.\n */\nexport class MoneyKeyring implements Keyring {\n  static type: string = MONEY_KEYRING_TYPE;\n\n  readonly type: string = MONEY_KEYRING_TYPE;\n\n  readonly #getMnemonic: GetMnemonicCallback;\n\n  readonly #cryptographicFunctions: CryptographicFunctions | undefined;\n\n  #entropySource: string | undefined;\n\n  #account: Hex | undefined;\n\n  #inner: HdKeyring | undefined;\n\n  readonly #lock = new Mutex();\n\n  constructor({ getMnemonic, cryptographicFunctions }: MoneyKeyringOptions) {\n    this.#getMnemonic = getMnemonic;\n    this.#cryptographicFunctions = cryptographicFunctions;\n  }\n\n  get entropySource(): string | undefined {\n    return this.#entropySource;\n  }\n\n  async serialize(): Promise<MoneyKeyringSerializedState> {\n    const state = {\n      entropySource: this.#entropySource,\n      account: this.#account,\n    };\n    assert(state, MoneyKeyringSerializedStateStruct);\n\n    return state;\n  }\n\n  async deserialize(state: MoneyKeyringSerializedState): Promise<void> {\n    assert(state, MoneyKeyringSerializedStateStruct);\n\n    if (this.#entropySource !== undefined) {\n      throw new Error('MoneyKeyring: cannot deserialize after initialization');\n    }\n\n    this.#entropySource = state.entropySource;\n    this.#account = state.account;\n  }\n\n  /**\n   * Runs a callback with the initialized inner {@link HdKeyring}, always within\n   * the mutex lock. Initializes {@link HdKeyring} on the first call.\n   *\n   * The initialization is deferred until first needed so that the potentially\n   * expensive {@link GetMnemonicCallback} is not invoked during\n   * {@link MoneyKeyring.deserialize} or {@link MoneyKeyring.getAccounts}.\n   *\n   * @param callback - Function to execute with the initialized inner keyring.\n   * @returns The result of the callback.\n   */\n  async #withLockedInner<ReturnType>(\n    callback: (inner: HdKeyring) => Promise<ReturnType> | ReturnType,\n  ): Promise<ReturnType> {\n    const entropySource = this.#entropySource;\n    if (!entropySource) {\n      throw new Error('MoneyKeyring: not yet deserialized');\n    }\n\n    return this.#lock.runExclusive(async () => {\n      if (!this.#inner) {\n        const mnemonic = await this.#getMnemonic(entropySource);\n        const inner = new HdKeyring({\n          cryptographicFunctions: this.#cryptographicFunctions,\n        });\n        await inner.deserialize({\n          mnemonic,\n          numberOfAccounts: this.#account ? 1 : 0,\n          hdPath: MONEY_DERIVATION_PATH,\n        });\n\n        if (this.#account) {\n          const [derivedAccount] = await inner.getAccounts();\n          if (derivedAccount?.toLowerCase() !== this.#account.toLowerCase()) {\n            throw new Error('MoneyKeyring: signer account mismatch');\n          }\n        }\n\n        this.#inner = inner;\n      }\n\n      return callback(this.#inner);\n    });\n  }\n\n  /**\n   * Returns the initialized inner {@link HdKeyring}.\n   *\n   * Uses a fast path if already initialized, otherwise delegates to\n   * {@link MoneyKeyring.#withLockedInner}.\n   *\n   * @returns The EVM signer instance.\n   */\n  async #getSigner(): Promise<EvmSigner> {\n    if (this.#inner) {\n      return this.#inner;\n    }\n\n    // We use the mutex-protected method to initialize the inner keyring if needed, but once\n    // initialized, we can return it directly and use it as the signer instance.\n    return await this.#withLockedInner((inner) => inner);\n  }\n\n  /**\n   * Add the single Money account to this keyring.\n   *\n   * @param numberOfAccounts - Must be 1 (the only supported value).\n   * @returns The address of the newly added account.\n   * @throws If `numberOfAccounts` is not 1 or an account already exists.\n   */\n  async addAccounts(numberOfAccounts = 1): Promise<Hex[]> {\n    if (numberOfAccounts !== 1) {\n      throw new Error('MoneyKeyring: supports adding exactly one account');\n    }\n\n    return await this.#withLockedInner(async (inner) => {\n      if (this.#account !== undefined) {\n        throw new Error('MoneyKeyring: already has an account');\n      }\n\n      const [account] = await inner.addAccounts(1);\n      if (!account) {\n        throw new Error('MoneyKeyring: failed to add account');\n      }\n      this.#account = account;\n\n      return [account];\n    });\n  }\n\n  // -----------------------------------------------------------------------------------\n  // The methods below are pass-throughs to the inner HdKeyring.\n\n  async getAccounts(): Promise<Hex[]> {\n    return this.#account ? [this.#account] : [];\n  }\n\n  async signTransaction(\n    ...args: Parameters<HdKeyring['signTransaction']>\n  ): ReturnType<HdKeyring['signTransaction']> {\n    return (await this.#getSigner()).signTransaction(...args);\n  }\n\n  async signPersonalMessage(\n    ...args: Parameters<HdKeyring['signPersonalMessage']>\n  ): ReturnType<HdKeyring['signPersonalMessage']> {\n    return (await this.#getSigner()).signPersonalMessage(...args);\n  }\n\n  async signTypedData(\n    ...args: Parameters<HdKeyring['signTypedData']>\n  ): ReturnType<HdKeyring['signTypedData']> {\n    return (await this.#getSigner()).signTypedData(...args);\n  }\n\n  async signEip7702Authorization(\n    ...args: Parameters<HdKeyring['signEip7702Authorization']>\n  ): ReturnType<HdKeyring['signEip7702Authorization']> {\n    return (await this.#getSigner()).signEip7702Authorization(...args);\n  }\n}\n"]}

package/dist/money-keyring.d.cts

@@ -0,0 +1,89 @@
+import { HdKeyring } from "@metamask/eth-hd-keyring";
+import { type CryptographicFunctions } from "@metamask/key-tree";
+import type { Keyring } from "@metamask/keyring-utils";
+import { type Infer } from "@metamask/superstruct";
+import { type Hex } from "@metamask/utils";
+/**
+ * Based on the SLIP-10 coin type: https://github.com/satoshilabs/slips/pull/1983
+ */
+export declare const MONEY_DERIVATION_PATH = "m/44'/4392018'/0'/0";
+/**
+ * The unique type identifier for the {@link MoneyKeyring}.
+ */
+export declare const MONEY_KEYRING_TYPE = "Money Keyring";
+/**
+ * Callback used to resolve a mnemonic from an entropy source ID.
+ *
+ * @param entropySource - The entropy source identifier.
+ * @returns The mnemonic as an array of UTF-8 byte values.
+ */
+export type GetMnemonicCallback = (entropySource: string) => Promise<number[]>;
+/**
+ * EVM signer interface, a subset of {@link HdKeyring} methods.
+ */
+export type EvmSigner = {
+    signTransaction: HdKeyring['signTransaction'];
+    signPersonalMessage: HdKeyring['signPersonalMessage'];
+    signTypedData: HdKeyring['signTypedData'];
+    signEip7702Authorization: HdKeyring['signEip7702Authorization'];
+};
+/**
+ * Options for constructing a {@link MoneyKeyring}.
+ *
+ * @property getMnemonic - Callback to resolve the mnemonic from an entropy source ID.
+ */
+export type MoneyKeyringOptions = {
+    getMnemonic: GetMnemonicCallback;
+    cryptographicFunctions?: CryptographicFunctions;
+};
+/**
+ * Struct for validating the serialized state of a {@link MoneyKeyring}.
+ *
+ * @property entropySource - The entropy source identifier.
+ * @property account - The account address, if one has been added.
+ */
+declare const MoneyKeyringSerializedStateStruct: import("@metamask/superstruct").Struct<{
+    entropySource: string;
+    account?: `0x${string}` | undefined;
+}, {
+    entropySource: import("@metamask/superstruct").Struct<string, null>;
+    account: import("@metamask/superstruct").Struct<`0x${string}` | undefined, null>;
+}>;
+/**
+ * The serialized state of a {@link MoneyKeyring} instance.
+ */
+export type MoneyKeyringSerializedState = Infer<typeof MoneyKeyringSerializedStateStruct>;
+/**
+ * Keyring used to create and manage Money Accounts. It wraps an inner {@link HdKeyring}
+ * and enforces a specific HD path and a limit on the number of accounts. The mnemonic
+ * is never stored in the serialized state; instead, it is resolved at deserialization
+ * time via a callback.
+ *
+ * The inner {@link HdKeyring} is instantiated lazily on the first signing operation
+ * (via {@link MoneyKeyring.#getSigner}). A mutex ensures that concurrent callers never
+ * trigger more than one initialization.
+ */
+export declare class MoneyKeyring implements Keyring {
+    #private;
+    static type: string;
+    readonly type: string;
+    constructor({ getMnemonic, cryptographicFunctions }: MoneyKeyringOptions);
+    get entropySource(): string | undefined;
+    serialize(): Promise<MoneyKeyringSerializedState>;
+    deserialize(state: MoneyKeyringSerializedState): Promise<void>;
+    /**
+     * Add the single Money account to this keyring.
+     *
+     * @param numberOfAccounts - Must be 1 (the only supported value).
+     * @returns The address of the newly added account.
+     * @throws If `numberOfAccounts` is not 1 or an account already exists.
+     */
+    addAccounts(numberOfAccounts?: number): Promise<Hex[]>;
+    getAccounts(): Promise<Hex[]>;
+    signTransaction(...args: Parameters<HdKeyring['signTransaction']>): ReturnType<HdKeyring['signTransaction']>;
+    signPersonalMessage(...args: Parameters<HdKeyring['signPersonalMessage']>): ReturnType<HdKeyring['signPersonalMessage']>;
+    signTypedData(...args: Parameters<HdKeyring['signTypedData']>): ReturnType<HdKeyring['signTypedData']>;
+    signEip7702Authorization(...args: Parameters<HdKeyring['signEip7702Authorization']>): ReturnType<HdKeyring['signEip7702Authorization']>;
+}
+export {};
+//# sourceMappingURL=money-keyring.d.cts.map

package/dist/money-keyring.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"money-keyring.d.cts","sourceRoot":"","sources":["../src/money-keyring.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,iCAAiC;AACrD,OAAO,EAAE,KAAK,sBAAsB,EAAE,2BAA2B;AAEjE,OAAO,KAAK,EAAE,OAAO,EAAE,gCAAgC;AACvD,OAAO,EAEL,KAAK,KAAK,EAIX,8BAA8B;AAC/B,OAAO,EAAE,KAAK,GAAG,EAAE,wBAAwB;AAG3C;;GAEG;AACH,eAAO,MAAM,qBAAqB,wBAAwB,CAAC;AAE3D;;GAEG;AACH,eAAO,MAAM,kBAAkB,kBAAkB,CAAC;AAElD;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,aAAa,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;AAE/E;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB,eAAe,EAAE,SAAS,CAAC,iBAAiB,CAAC,CAAC;IAC9C,mBAAmB,EAAE,SAAS,CAAC,qBAAqB,CAAC,CAAC;IACtD,aAAa,EAAE,SAAS,CAAC,eAAe,CAAC,CAAC;IAC1C,wBAAwB,EAAE,SAAS,CAAC,0BAA0B,CAAC,CAAC;CACjE,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,WAAW,EAAE,mBAAmB,CAAC;IACjC,sBAAsB,CAAC,EAAE,sBAAsB,CAAC;CACjD,CAAC;AAEF;;;;;GAKG;AACH,QAAA,MAAM,iCAAiC;;;;;;EAGrC,CAAC;AAEH;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG,KAAK,CAC7C,OAAO,iCAAiC,CACzC,CAAC;AAEF;;;;;;;;;GASG;AACH,qBAAa,YAAa,YAAW,OAAO;;IAC1C,MAAM,CAAC,IAAI,EAAE,MAAM,CAAsB;IAEzC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAsB;gBAc/B,EAAE,WAAW,EAAE,sBAAsB,EAAE,EAAE,mBAAmB;IAKxE,IAAI,aAAa,IAAI,MAAM,GAAG,SAAS,CAEtC;IAEK,SAAS,IAAI,OAAO,CAAC,2BAA2B,CAAC;IAUjD,WAAW,CAAC,KAAK,EAAE,2BAA2B,GAAG,OAAO,CAAC,IAAI,CAAC;IA0EpE;;;;;;OAMG;IACG,WAAW,CAAC,gBAAgB,SAAI,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAuBjD,WAAW,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;IAI7B,eAAe,CACnB,GAAG,IAAI,EAAE,UAAU,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC,GAChD,UAAU,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;IAIrC,mBAAmB,CACvB,GAAG,IAAI,EAAE,UAAU,CAAC,SAAS,CAAC,qBAAqB,CAAC,CAAC,GACpD,UAAU,CAAC,SAAS,CAAC,qBAAqB,CAAC,CAAC;IAIzC,aAAa,CACjB,GAAG,IAAI,EAAE,UAAU,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC,GAC9C,UAAU,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;IAInC,wBAAwB,CAC5B,GAAG,IAAI,EAAE,UAAU,CAAC,SAAS,CAAC,0BAA0B,CAAC,CAAC,GACzD,UAAU,CAAC,SAAS,CAAC,0BAA0B,CAAC,CAAC;CAGrD"}

package/dist/money-keyring.d.mts

@@ -0,0 +1,89 @@
+import { HdKeyring } from "@metamask/eth-hd-keyring";
+import { type CryptographicFunctions } from "@metamask/key-tree";
+import type { Keyring } from "@metamask/keyring-utils";
+import { type Infer } from "@metamask/superstruct";
+import { type Hex } from "@metamask/utils";
+/**
+ * Based on the SLIP-10 coin type: https://github.com/satoshilabs/slips/pull/1983
+ */
+export declare const MONEY_DERIVATION_PATH = "m/44'/4392018'/0'/0";
+/**
+ * The unique type identifier for the {@link MoneyKeyring}.
+ */
+export declare const MONEY_KEYRING_TYPE = "Money Keyring";
+/**
+ * Callback used to resolve a mnemonic from an entropy source ID.
+ *
+ * @param entropySource - The entropy source identifier.
+ * @returns The mnemonic as an array of UTF-8 byte values.
+ */
+export type GetMnemonicCallback = (entropySource: string) => Promise<number[]>;
+/**
+ * EVM signer interface, a subset of {@link HdKeyring} methods.
+ */
+export type EvmSigner = {
+    signTransaction: HdKeyring['signTransaction'];
+    signPersonalMessage: HdKeyring['signPersonalMessage'];
+    signTypedData: HdKeyring['signTypedData'];
+    signEip7702Authorization: HdKeyring['signEip7702Authorization'];
+};
+/**
+ * Options for constructing a {@link MoneyKeyring}.
+ *
+ * @property getMnemonic - Callback to resolve the mnemonic from an entropy source ID.
+ */
+export type MoneyKeyringOptions = {
+    getMnemonic: GetMnemonicCallback;
+    cryptographicFunctions?: CryptographicFunctions;
+};
+/**
+ * Struct for validating the serialized state of a {@link MoneyKeyring}.
+ *
+ * @property entropySource - The entropy source identifier.
+ * @property account - The account address, if one has been added.
+ */
+declare const MoneyKeyringSerializedStateStruct: import("@metamask/superstruct").Struct<{
+    entropySource: string;
+    account?: `0x${string}` | undefined;
+}, {
+    entropySource: import("@metamask/superstruct").Struct<string, null>;
+    account: import("@metamask/superstruct").Struct<`0x${string}` | undefined, null>;
+}>;
+/**
+ * The serialized state of a {@link MoneyKeyring} instance.
+ */
+export type MoneyKeyringSerializedState = Infer<typeof MoneyKeyringSerializedStateStruct>;
+/**
+ * Keyring used to create and manage Money Accounts. It wraps an inner {@link HdKeyring}
+ * and enforces a specific HD path and a limit on the number of accounts. The mnemonic
+ * is never stored in the serialized state; instead, it is resolved at deserialization
+ * time via a callback.
+ *
+ * The inner {@link HdKeyring} is instantiated lazily on the first signing operation
+ * (via {@link MoneyKeyring.#getSigner}). A mutex ensures that concurrent callers never
+ * trigger more than one initialization.
+ */
+export declare class MoneyKeyring implements Keyring {
+    #private;
+    static type: string;
+    readonly type: string;
+    constructor({ getMnemonic, cryptographicFunctions }: MoneyKeyringOptions);
+    get entropySource(): string | undefined;
+    serialize(): Promise<MoneyKeyringSerializedState>;
+    deserialize(state: MoneyKeyringSerializedState): Promise<void>;
+    /**
+     * Add the single Money account to this keyring.
+     *
+     * @param numberOfAccounts - Must be 1 (the only supported value).
+     * @returns The address of the newly added account.
+     * @throws If `numberOfAccounts` is not 1 or an account already exists.
+     */
+    addAccounts(numberOfAccounts?: number): Promise<Hex[]>;
+    getAccounts(): Promise<Hex[]>;
+    signTransaction(...args: Parameters<HdKeyring['signTransaction']>): ReturnType<HdKeyring['signTransaction']>;
+    signPersonalMessage(...args: Parameters<HdKeyring['signPersonalMessage']>): ReturnType<HdKeyring['signPersonalMessage']>;
+    signTypedData(...args: Parameters<HdKeyring['signTypedData']>): ReturnType<HdKeyring['signTypedData']>;
+    signEip7702Authorization(...args: Parameters<HdKeyring['signEip7702Authorization']>): ReturnType<HdKeyring['signEip7702Authorization']>;
+}
+export {};
+//# sourceMappingURL=money-keyring.d.mts.map

package/dist/money-keyring.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"money-keyring.d.mts","sourceRoot":"","sources":["../src/money-keyring.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,iCAAiC;AACrD,OAAO,EAAE,KAAK,sBAAsB,EAAE,2BAA2B;AAEjE,OAAO,KAAK,EAAE,OAAO,EAAE,gCAAgC;AACvD,OAAO,EAEL,KAAK,KAAK,EAIX,8BAA8B;AAC/B,OAAO,EAAE,KAAK,GAAG,EAAE,wBAAwB;AAG3C;;GAEG;AACH,eAAO,MAAM,qBAAqB,wBAAwB,CAAC;AAE3D;;GAEG;AACH,eAAO,MAAM,kBAAkB,kBAAkB,CAAC;AAElD;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,aAAa,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;AAE/E;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB,eAAe,EAAE,SAAS,CAAC,iBAAiB,CAAC,CAAC;IAC9C,mBAAmB,EAAE,SAAS,CAAC,qBAAqB,CAAC,CAAC;IACtD,aAAa,EAAE,SAAS,CAAC,eAAe,CAAC,CAAC;IAC1C,wBAAwB,EAAE,SAAS,CAAC,0BAA0B,CAAC,CAAC;CACjE,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,WAAW,EAAE,mBAAmB,CAAC;IACjC,sBAAsB,CAAC,EAAE,sBAAsB,CAAC;CACjD,CAAC;AAEF;;;;;GAKG;AACH,QAAA,MAAM,iCAAiC;;;;;;EAGrC,CAAC;AAEH;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG,KAAK,CAC7C,OAAO,iCAAiC,CACzC,CAAC;AAEF;;;;;;;;;GASG;AACH,qBAAa,YAAa,YAAW,OAAO;;IAC1C,MAAM,CAAC,IAAI,EAAE,MAAM,CAAsB;IAEzC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAsB;gBAc/B,EAAE,WAAW,EAAE,sBAAsB,EAAE,EAAE,mBAAmB;IAKxE,IAAI,aAAa,IAAI,MAAM,GAAG,SAAS,CAEtC;IAEK,SAAS,IAAI,OAAO,CAAC,2BAA2B,CAAC;IAUjD,WAAW,CAAC,KAAK,EAAE,2BAA2B,GAAG,OAAO,CAAC,IAAI,CAAC;IA0EpE;;;;;;OAMG;IACG,WAAW,CAAC,gBAAgB,SAAI,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAuBjD,WAAW,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;IAI7B,eAAe,CACnB,GAAG,IAAI,EAAE,UAAU,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC,GAChD,UAAU,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;IAIrC,mBAAmB,CACvB,GAAG,IAAI,EAAE,UAAU,CAAC,SAAS,CAAC,qBAAqB,CAAC,CAAC,GACpD,UAAU,CAAC,SAAS,CAAC,qBAAqB,CAAC,CAAC;IAIzC,aAAa,CACjB,GAAG,IAAI,EAAE,UAAU,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC,GAC9C,UAAU,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;IAInC,wBAAwB,CAC5B,GAAG,IAAI,EAAE,UAAU,CAAC,SAAS,CAAC,0BAA0B,CAAC,CAAC,GACzD,UAAU,CAAC,SAAS,CAAC,0BAA0B,CAAC,CAAC;CAGrD"}

package/dist/money-keyring.mjs

@@ -0,0 +1,174 @@
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _MoneyKeyring_instances, _MoneyKeyring_getMnemonic, _MoneyKeyring_cryptographicFunctions, _MoneyKeyring_entropySource, _MoneyKeyring_account, _MoneyKeyring_inner, _MoneyKeyring_lock, _MoneyKeyring_withLockedInner, _MoneyKeyring_getSigner;
+import { HdKeyring } from "@metamask/eth-hd-keyring";
+import { EthAddressStrictStruct } from "@metamask/keyring-api";
+import { assert, object, optional, string as stringStruct } from "@metamask/superstruct";
+import { Mutex } from "async-mutex";
+/**
+ * Based on the SLIP-10 coin type: https://github.com/satoshilabs/slips/pull/1983
+ */
+export const MONEY_DERIVATION_PATH = `m/44'/4392018'/0'/0`;
+/**
+ * The unique type identifier for the {@link MoneyKeyring}.
+ */
+export const MONEY_KEYRING_TYPE = 'Money Keyring';
+/**
+ * Struct for validating the serialized state of a {@link MoneyKeyring}.
+ *
+ * @property entropySource - The entropy source identifier.
+ * @property account - The account address, if one has been added.
+ */
+const MoneyKeyringSerializedStateStruct = object({
+    entropySource: stringStruct(),
+    account: optional(EthAddressStrictStruct),
+});
+/**
+ * Keyring used to create and manage Money Accounts. It wraps an inner {@link HdKeyring}
+ * and enforces a specific HD path and a limit on the number of accounts. The mnemonic
+ * is never stored in the serialized state; instead, it is resolved at deserialization
+ * time via a callback.
+ *
+ * The inner {@link HdKeyring} is instantiated lazily on the first signing operation
+ * (via {@link MoneyKeyring.#getSigner}). A mutex ensures that concurrent callers never
+ * trigger more than one initialization.
+ */
+export class MoneyKeyring {
+    constructor({ getMnemonic, cryptographicFunctions }) {
+        _MoneyKeyring_instances.add(this);
+        this.type = MONEY_KEYRING_TYPE;
+        _MoneyKeyring_getMnemonic.set(this, void 0);
+        _MoneyKeyring_cryptographicFunctions.set(this, void 0);
+        _MoneyKeyring_entropySource.set(this, void 0);
+        _MoneyKeyring_account.set(this, void 0);
+        _MoneyKeyring_inner.set(this, void 0);
+        _MoneyKeyring_lock.set(this, new Mutex());
+        __classPrivateFieldSet(this, _MoneyKeyring_getMnemonic, getMnemonic, "f");
+        __classPrivateFieldSet(this, _MoneyKeyring_cryptographicFunctions, cryptographicFunctions, "f");
+    }
+    get entropySource() {
+        return __classPrivateFieldGet(this, _MoneyKeyring_entropySource, "f");
+    }
+    async serialize() {
+        const state = {
+            entropySource: __classPrivateFieldGet(this, _MoneyKeyring_entropySource, "f"),
+            account: __classPrivateFieldGet(this, _MoneyKeyring_account, "f"),
+        };
+        assert(state, MoneyKeyringSerializedStateStruct);
+        return state;
+    }
+    async deserialize(state) {
+        assert(state, MoneyKeyringSerializedStateStruct);
+        if (__classPrivateFieldGet(this, _MoneyKeyring_entropySource, "f") !== undefined) {
+            throw new Error('MoneyKeyring: cannot deserialize after initialization');
+        }
+        __classPrivateFieldSet(this, _MoneyKeyring_entropySource, state.entropySource, "f");
+        __classPrivateFieldSet(this, _MoneyKeyring_account, state.account, "f");
+    }
+    /**
+     * Add the single Money account to this keyring.
+     *
+     * @param numberOfAccounts - Must be 1 (the only supported value).
+     * @returns The address of the newly added account.
+     * @throws If `numberOfAccounts` is not 1 or an account already exists.
+     */
+    async addAccounts(numberOfAccounts = 1) {
+        if (numberOfAccounts !== 1) {
+            throw new Error('MoneyKeyring: supports adding exactly one account');
+        }
+        return await __classPrivateFieldGet(this, _MoneyKeyring_instances, "m", _MoneyKeyring_withLockedInner).call(this, async (inner) => {
+            if (__classPrivateFieldGet(this, _MoneyKeyring_account, "f") !== undefined) {
+                throw new Error('MoneyKeyring: already has an account');
+            }
+            const [account] = await inner.addAccounts(1);
+            if (!account) {
+                throw new Error('MoneyKeyring: failed to add account');
+            }
+            __classPrivateFieldSet(this, _MoneyKeyring_account, account, "f");
+            return [account];
+        });
+    }
+    // -----------------------------------------------------------------------------------
+    // The methods below are pass-throughs to the inner HdKeyring.
+    async getAccounts() {
+        return __classPrivateFieldGet(this, _MoneyKeyring_account, "f") ? [__classPrivateFieldGet(this, _MoneyKeyring_account, "f")] : [];
+    }
+    async signTransaction(...args) {
+        return (await __classPrivateFieldGet(this, _MoneyKeyring_instances, "m", _MoneyKeyring_getSigner).call(this)).signTransaction(...args);
+    }
+    async signPersonalMessage(...args) {
+        return (await __classPrivateFieldGet(this, _MoneyKeyring_instances, "m", _MoneyKeyring_getSigner).call(this)).signPersonalMessage(...args);
+    }
+    async signTypedData(...args) {
+        return (await __classPrivateFieldGet(this, _MoneyKeyring_instances, "m", _MoneyKeyring_getSigner).call(this)).signTypedData(...args);
+    }
+    async signEip7702Authorization(...args) {
+        return (await __classPrivateFieldGet(this, _MoneyKeyring_instances, "m", _MoneyKeyring_getSigner).call(this)).signEip7702Authorization(...args);
+    }
+}
+_MoneyKeyring_getMnemonic = new WeakMap(), _MoneyKeyring_cryptographicFunctions = new WeakMap(), _MoneyKeyring_entropySource = new WeakMap(), _MoneyKeyring_account = new WeakMap(), _MoneyKeyring_inner = new WeakMap(), _MoneyKeyring_lock = new WeakMap(), _MoneyKeyring_instances = new WeakSet(), _MoneyKeyring_withLockedInner = 
+/**
+ * Runs a callback with the initialized inner {@link HdKeyring}, always within
+ * the mutex lock. Initializes {@link HdKeyring} on the first call.
+ *
+ * The initialization is deferred until first needed so that the potentially
+ * expensive {@link GetMnemonicCallback} is not invoked during
+ * {@link MoneyKeyring.deserialize} or {@link MoneyKeyring.getAccounts}.
+ *
+ * @param callback - Function to execute with the initialized inner keyring.
+ * @returns The result of the callback.
+ */
+async function _MoneyKeyring_withLockedInner(callback) {
+    const entropySource = __classPrivateFieldGet(this, _MoneyKeyring_entropySource, "f");
+    if (!entropySource) {
+        throw new Error('MoneyKeyring: not yet deserialized');
+    }
+    return __classPrivateFieldGet(this, _MoneyKeyring_lock, "f").runExclusive(async () => {
+        if (!__classPrivateFieldGet(this, _MoneyKeyring_inner, "f")) {
+            const mnemonic = await __classPrivateFieldGet(this, _MoneyKeyring_getMnemonic, "f").call(this, entropySource);
+            const inner = new HdKeyring({
+                cryptographicFunctions: __classPrivateFieldGet(this, _MoneyKeyring_cryptographicFunctions, "f"),
+            });
+            await inner.deserialize({
+                mnemonic,
+                numberOfAccounts: __classPrivateFieldGet(this, _MoneyKeyring_account, "f") ? 1 : 0,
+                hdPath: MONEY_DERIVATION_PATH,
+            });
+            if (__classPrivateFieldGet(this, _MoneyKeyring_account, "f")) {
+                const [derivedAccount] = await inner.getAccounts();
+                if (derivedAccount?.toLowerCase() !== __classPrivateFieldGet(this, _MoneyKeyring_account, "f").toLowerCase()) {
+                    throw new Error('MoneyKeyring: signer account mismatch');
+                }
+            }
+            __classPrivateFieldSet(this, _MoneyKeyring_inner, inner, "f");
+        }
+        return callback(__classPrivateFieldGet(this, _MoneyKeyring_inner, "f"));
+    });
+}, _MoneyKeyring_getSigner = 
+/**
+ * Returns the initialized inner {@link HdKeyring}.
+ *
+ * Uses a fast path if already initialized, otherwise delegates to
+ * {@link MoneyKeyring.#withLockedInner}.
+ *
+ * @returns The EVM signer instance.
+ */
+async function _MoneyKeyring_getSigner() {
+    if (__classPrivateFieldGet(this, _MoneyKeyring_inner, "f")) {
+        return __classPrivateFieldGet(this, _MoneyKeyring_inner, "f");
+    }
+    // We use the mutex-protected method to initialize the inner keyring if needed, but once
+    // initialized, we can return it directly and use it as the signer instance.
+    return await __classPrivateFieldGet(this, _MoneyKeyring_instances, "m", _MoneyKeyring_withLockedInner).call(this, (inner) => inner);
+};
+MoneyKeyring.type = MONEY_KEYRING_TYPE;
+//# sourceMappingURL=money-keyring.mjs.map

package/dist/money-keyring.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"money-keyring.mjs","sourceRoot":"","sources":["../src/money-keyring.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EAAE,SAAS,EAAE,iCAAiC;AAErD,OAAO,EAAE,sBAAsB,EAAE,8BAA8B;AAE/D,OAAO,EACL,MAAM,EAEN,MAAM,EACN,QAAQ,EACR,MAAM,IAAI,YAAY,EACvB,8BAA8B;AAE/B,OAAO,EAAE,KAAK,EAAE,oBAAoB;AAEpC;;GAEG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,qBAAqB,CAAC;AAE3D;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,eAAe,CAAC;AA8BlD;;;;;GAKG;AACH,MAAM,iCAAiC,GAAG,MAAM,CAAC;IAC/C,aAAa,EAAE,YAAY,EAAE;IAC7B,OAAO,EAAE,QAAQ,CAAC,sBAAsB,CAAC;CAC1C,CAAC,CAAC;AASH;;;;;;;;;GASG;AACH,MAAM,OAAO,YAAY;IAiBvB,YAAY,EAAE,WAAW,EAAE,sBAAsB,EAAuB;;QAd/D,SAAI,GAAW,kBAAkB,CAAC;QAElC,4CAAkC;QAElC,uDAA4D;QAErE,8CAAmC;QAEnC,wCAA0B;QAE1B,sCAA8B;QAErB,6BAAQ,IAAI,KAAK,EAAE,EAAC;QAG3B,uBAAA,IAAI,6BAAgB,WAAW,MAAA,CAAC;QAChC,uBAAA,IAAI,wCAA2B,sBAAsB,MAAA,CAAC;IACxD,CAAC;IAED,IAAI,aAAa;QACf,OAAO,uBAAA,IAAI,mCAAe,CAAC;IAC7B,CAAC;IAED,KAAK,CAAC,SAAS;QACb,MAAM,KAAK,GAAG;YACZ,aAAa,EAAE,uBAAA,IAAI,mCAAe;YAClC,OAAO,EAAE,uBAAA,IAAI,6BAAS;SACvB,CAAC;QACF,MAAM,CAAC,KAAK,EAAE,iCAAiC,CAAC,CAAC;QAEjD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,KAAkC;QAClD,MAAM,CAAC,KAAK,EAAE,iCAAiC,CAAC,CAAC;QAEjD,IAAI,uBAAA,IAAI,mCAAe,KAAK,SAAS,EAAE,CAAC;YACtC,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;QAC3E,CAAC;QAED,uBAAA,IAAI,+BAAkB,KAAK,CAAC,aAAa,MAAA,CAAC;QAC1C,uBAAA,IAAI,yBAAY,KAAK,CAAC,OAAO,MAAA,CAAC;IAChC,CAAC;IAiED;;;;;;OAMG;IACH,KAAK,CAAC,WAAW,CAAC,gBAAgB,GAAG,CAAC;QACpC,IAAI,gBAAgB,KAAK,CAAC,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;QACvE,CAAC;QAED,OAAO,MAAM,uBAAA,IAAI,8DAAiB,MAArB,IAAI,EAAkB,KAAK,EAAE,KAAK,EAAE,EAAE;YACjD,IAAI,uBAAA,IAAI,6BAAS,KAAK,SAAS,EAAE,CAAC;gBAChC,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;YAC1D,CAAC;YAED,MAAM,CAAC,OAAO,CAAC,GAAG,MAAM,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;YAC7C,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;YACzD,CAAC;YACD,uBAAA,IAAI,yBAAY,OAAO,MAAA,CAAC;YAExB,OAAO,CAAC,OAAO,CAAC,CAAC;QACnB,CAAC,CAAC,CAAC;IACL,CAAC;IAED,sFAAsF;IACtF,8DAA8D;IAE9D,KAAK,CAAC,WAAW;QACf,OAAO,uBAAA,IAAI,6BAAS,CAAC,CAAC,CAAC,CAAC,uBAAA,IAAI,6BAAS,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC9C,CAAC;IAED,KAAK,CAAC,eAAe,CACnB,GAAG,IAA8C;QAEjD,OAAO,CAAC,MAAM,uBAAA,IAAI,wDAAW,MAAf,IAAI,CAAa,CAAC,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,CAAC;IAC5D,CAAC;IAED,KAAK,CAAC,mBAAmB,CACvB,GAAG,IAAkD;QAErD,OAAO,CAAC,MAAM,uBAAA,IAAI,wDAAW,MAAf,IAAI,CAAa,CAAC,CAAC,mBAAmB,CAAC,GAAG,IAAI,CAAC,CAAC;IAChE,CAAC;IAED,KAAK,CAAC,aAAa,CACjB,GAAG,IAA4C;QAE/C,OAAO,CAAC,MAAM,uBAAA,IAAI,wDAAW,MAAf,IAAI,CAAa,CAAC,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,CAAC;IAC1D,CAAC;IAED,KAAK,CAAC,wBAAwB,CAC5B,GAAG,IAAuD;QAE1D,OAAO,CAAC,MAAM,uBAAA,IAAI,wDAAW,MAAf,IAAI,CAAa,CAAC,CAAC,wBAAwB,CAAC,GAAG,IAAI,CAAC,CAAC;IACrE,CAAC;;;AAvHD;;;;;;;;;;GAUG;AACH,KAAK,wCACH,QAAgE;IAEhE,MAAM,aAAa,GAAG,uBAAA,IAAI,mCAAe,CAAC;IAC1C,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;IACxD,CAAC;IAED,OAAO,uBAAA,IAAI,0BAAM,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;QACxC,IAAI,CAAC,uBAAA,IAAI,2BAAO,EAAE,CAAC;YACjB,MAAM,QAAQ,GAAG,MAAM,uBAAA,IAAI,iCAAa,MAAjB,IAAI,EAAc,aAAa,CAAC,CAAC;YACxD,MAAM,KAAK,GAAG,IAAI,SAAS,CAAC;gBAC1B,sBAAsB,EAAE,uBAAA,IAAI,4CAAwB;aACrD,CAAC,CAAC;YACH,MAAM,KAAK,CAAC,WAAW,CAAC;gBACtB,QAAQ;gBACR,gBAAgB,EAAE,uBAAA,IAAI,6BAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBACvC,MAAM,EAAE,qBAAqB;aAC9B,CAAC,CAAC;YAEH,IAAI,uBAAA,IAAI,6BAAS,EAAE,CAAC;gBAClB,MAAM,CAAC,cAAc,CAAC,GAAG,MAAM,KAAK,CAAC,WAAW,EAAE,CAAC;gBACnD,IAAI,cAAc,EAAE,WAAW,EAAE,KAAK,uBAAA,IAAI,6BAAS,CAAC,WAAW,EAAE,EAAE,CAAC;oBAClE,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;gBAC3D,CAAC;YACH,CAAC;YAED,uBAAA,IAAI,uBAAU,KAAK,MAAA,CAAC;QACtB,CAAC;QAED,OAAO,QAAQ,CAAC,uBAAA,IAAI,2BAAO,CAAC,CAAC;IAC/B,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;GAOG;AACH,KAAK;IACH,IAAI,uBAAA,IAAI,2BAAO,EAAE,CAAC;QAChB,OAAO,uBAAA,IAAI,2BAAO,CAAC;IACrB,CAAC;IAED,wFAAwF;IACxF,4EAA4E;IAC5E,OAAO,MAAM,uBAAA,IAAI,8DAAiB,MAArB,IAAI,EAAkB,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;AACvD,CAAC;AA3GM,iBAAI,GAAW,kBAAkB,AAA7B,CAA8B","sourcesContent":["import { HdKeyring } from '@metamask/eth-hd-keyring';\nimport { type CryptographicFunctions } from '@metamask/key-tree';\nimport { EthAddressStrictStruct } from '@metamask/keyring-api';\nimport type { Keyring } from '@metamask/keyring-utils';\nimport {\n  assert,\n  type Infer,\n  object,\n  optional,\n  string as stringStruct,\n} from '@metamask/superstruct';\nimport { type Hex } from '@metamask/utils';\nimport { Mutex } from 'async-mutex';\n\n/**\n * Based on the SLIP-10 coin type: https://github.com/satoshilabs/slips/pull/1983\n */\nexport const MONEY_DERIVATION_PATH = `m/44'/4392018'/0'/0`;\n\n/**\n * The unique type identifier for the {@link MoneyKeyring}.\n */\nexport const MONEY_KEYRING_TYPE = 'Money Keyring';\n\n/**\n * Callback used to resolve a mnemonic from an entropy source ID.\n *\n * @param entropySource - The entropy source identifier.\n * @returns The mnemonic as an array of UTF-8 byte values.\n */\nexport type GetMnemonicCallback = (entropySource: string) => Promise<number[]>;\n\n/**\n * EVM signer interface, a subset of {@link HdKeyring} methods.\n */\nexport type EvmSigner = {\n  signTransaction: HdKeyring['signTransaction'];\n  signPersonalMessage: HdKeyring['signPersonalMessage'];\n  signTypedData: HdKeyring['signTypedData'];\n  signEip7702Authorization: HdKeyring['signEip7702Authorization'];\n};\n\n/**\n * Options for constructing a {@link MoneyKeyring}.\n *\n * @property getMnemonic - Callback to resolve the mnemonic from an entropy source ID.\n */\nexport type MoneyKeyringOptions = {\n  getMnemonic: GetMnemonicCallback;\n  cryptographicFunctions?: CryptographicFunctions;\n};\n\n/**\n * Struct for validating the serialized state of a {@link MoneyKeyring}.\n *\n * @property entropySource - The entropy source identifier.\n * @property account - The account address, if one has been added.\n */\nconst MoneyKeyringSerializedStateStruct = object({\n  entropySource: stringStruct(),\n  account: optional(EthAddressStrictStruct),\n});\n\n/**\n * The serialized state of a {@link MoneyKeyring} instance.\n */\nexport type MoneyKeyringSerializedState = Infer<\n  typeof MoneyKeyringSerializedStateStruct\n>;\n\n/**\n * Keyring used to create and manage Money Accounts. It wraps an inner {@link HdKeyring}\n * and enforces a specific HD path and a limit on the number of accounts. The mnemonic\n * is never stored in the serialized state; instead, it is resolved at deserialization\n * time via a callback.\n *\n * The inner {@link HdKeyring} is instantiated lazily on the first signing operation\n * (via {@link MoneyKeyring.#getSigner}). A mutex ensures that concurrent callers never\n * trigger more than one initialization.\n */\nexport class MoneyKeyring implements Keyring {\n  static type: string = MONEY_KEYRING_TYPE;\n\n  readonly type: string = MONEY_KEYRING_TYPE;\n\n  readonly #getMnemonic: GetMnemonicCallback;\n\n  readonly #cryptographicFunctions: CryptographicFunctions | undefined;\n\n  #entropySource: string | undefined;\n\n  #account: Hex | undefined;\n\n  #inner: HdKeyring | undefined;\n\n  readonly #lock = new Mutex();\n\n  constructor({ getMnemonic, cryptographicFunctions }: MoneyKeyringOptions) {\n    this.#getMnemonic = getMnemonic;\n    this.#cryptographicFunctions = cryptographicFunctions;\n  }\n\n  get entropySource(): string | undefined {\n    return this.#entropySource;\n  }\n\n  async serialize(): Promise<MoneyKeyringSerializedState> {\n    const state = {\n      entropySource: this.#entropySource,\n      account: this.#account,\n    };\n    assert(state, MoneyKeyringSerializedStateStruct);\n\n    return state;\n  }\n\n  async deserialize(state: MoneyKeyringSerializedState): Promise<void> {\n    assert(state, MoneyKeyringSerializedStateStruct);\n\n    if (this.#entropySource !== undefined) {\n      throw new Error('MoneyKeyring: cannot deserialize after initialization');\n    }\n\n    this.#entropySource = state.entropySource;\n    this.#account = state.account;\n  }\n\n  /**\n   * Runs a callback with the initialized inner {@link HdKeyring}, always within\n   * the mutex lock. Initializes {@link HdKeyring} on the first call.\n   *\n   * The initialization is deferred until first needed so that the potentially\n   * expensive {@link GetMnemonicCallback} is not invoked during\n   * {@link MoneyKeyring.deserialize} or {@link MoneyKeyring.getAccounts}.\n   *\n   * @param callback - Function to execute with the initialized inner keyring.\n   * @returns The result of the callback.\n   */\n  async #withLockedInner<ReturnType>(\n    callback: (inner: HdKeyring) => Promise<ReturnType> | ReturnType,\n  ): Promise<ReturnType> {\n    const entropySource = this.#entropySource;\n    if (!entropySource) {\n      throw new Error('MoneyKeyring: not yet deserialized');\n    }\n\n    return this.#lock.runExclusive(async () => {\n      if (!this.#inner) {\n        const mnemonic = await this.#getMnemonic(entropySource);\n        const inner = new HdKeyring({\n          cryptographicFunctions: this.#cryptographicFunctions,\n        });\n        await inner.deserialize({\n          mnemonic,\n          numberOfAccounts: this.#account ? 1 : 0,\n          hdPath: MONEY_DERIVATION_PATH,\n        });\n\n        if (this.#account) {\n          const [derivedAccount] = await inner.getAccounts();\n          if (derivedAccount?.toLowerCase() !== this.#account.toLowerCase()) {\n            throw new Error('MoneyKeyring: signer account mismatch');\n          }\n        }\n\n        this.#inner = inner;\n      }\n\n      return callback(this.#inner);\n    });\n  }\n\n  /**\n   * Returns the initialized inner {@link HdKeyring}.\n   *\n   * Uses a fast path if already initialized, otherwise delegates to\n   * {@link MoneyKeyring.#withLockedInner}.\n   *\n   * @returns The EVM signer instance.\n   */\n  async #getSigner(): Promise<EvmSigner> {\n    if (this.#inner) {\n      return this.#inner;\n    }\n\n    // We use the mutex-protected method to initialize the inner keyring if needed, but once\n    // initialized, we can return it directly and use it as the signer instance.\n    return await this.#withLockedInner((inner) => inner);\n  }\n\n  /**\n   * Add the single Money account to this keyring.\n   *\n   * @param numberOfAccounts - Must be 1 (the only supported value).\n   * @returns The address of the newly added account.\n   * @throws If `numberOfAccounts` is not 1 or an account already exists.\n   */\n  async addAccounts(numberOfAccounts = 1): Promise<Hex[]> {\n    if (numberOfAccounts !== 1) {\n      throw new Error('MoneyKeyring: supports adding exactly one account');\n    }\n\n    return await this.#withLockedInner(async (inner) => {\n      if (this.#account !== undefined) {\n        throw new Error('MoneyKeyring: already has an account');\n      }\n\n      const [account] = await inner.addAccounts(1);\n      if (!account) {\n        throw new Error('MoneyKeyring: failed to add account');\n      }\n      this.#account = account;\n\n      return [account];\n    });\n  }\n\n  // -----------------------------------------------------------------------------------\n  // The methods below are pass-throughs to the inner HdKeyring.\n\n  async getAccounts(): Promise<Hex[]> {\n    return this.#account ? [this.#account] : [];\n  }\n\n  async signTransaction(\n    ...args: Parameters<HdKeyring['signTransaction']>\n  ): ReturnType<HdKeyring['signTransaction']> {\n    return (await this.#getSigner()).signTransaction(...args);\n  }\n\n  async signPersonalMessage(\n    ...args: Parameters<HdKeyring['signPersonalMessage']>\n  ): ReturnType<HdKeyring['signPersonalMessage']> {\n    return (await this.#getSigner()).signPersonalMessage(...args);\n  }\n\n  async signTypedData(\n    ...args: Parameters<HdKeyring['signTypedData']>\n  ): ReturnType<HdKeyring['signTypedData']> {\n    return (await this.#getSigner()).signTypedData(...args);\n  }\n\n  async signEip7702Authorization(\n    ...args: Parameters<HdKeyring['signEip7702Authorization']>\n  ): ReturnType<HdKeyring['signEip7702Authorization']> {\n    return (await this.#getSigner()).signEip7702Authorization(...args);\n  }\n}\n"]}

package/package.json

@@ -0,0 +1,76 @@
+{
+  "name": "@metamask-previews/eth-money-keyring",
+  "version": "2.0.0-8ff7ba2",
+  "description": "A money account keyring that wraps the HD keyring with a different keyring type and derivation path.",
+  "keywords": [
+    "ethereum",
+    "keyring"
+  ],
+  "homepage": "https://github.com/MetaMask/accounts#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/accounts/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MetaMask/accounts.git"
+  },
+  "license": "ISC",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "main": "./dist/index.cjs",
+  "types": "./dist/index.d.cts",
+  "files": [
+    "dist/"
+  ],
+  "scripts": {
+    "build": "ts-bridge --project tsconfig.build.json --no-references",
+    "build:clean": "yarn build --clean",
+    "build:docs": "typedoc",
+    "changelog:update": "../../scripts/update-changelog.sh @metamask/eth-money-keyring",
+    "changelog:validate": "../../scripts/validate-changelog.sh @metamask/eth-money-keyring",
+    "publish:preview": "yarn npm publish --tag preview",
+    "test": "jest",
+    "test:clean": "jest --clearCache"
+  },
+  "dependencies": {
+    "@metamask/eth-hd-keyring": "13.1.0",
+    "@metamask/keyring-api": "22.0.0",
+    "@metamask/keyring-utils": "3.2.0",
+    "@metamask/superstruct": "^3.1.0",
+    "async-mutex": "^0.5.0"
+  },
+  "devDependencies": {
+    "@lavamoat/allow-scripts": "^3.2.1",
+    "@lavamoat/preinstall-always-fail": "^2.1.0",
+    "@metamask/auto-changelog": "^3.4.4",
+    "@metamask/eth-sig-util": "^8.2.0",
+    "@metamask/key-tree": "^10.0.2",
+    "@metamask/utils": "^11.10.0",
+    "@ts-bridge/cli": "^0.6.3",
+    "@types/jest": "^29.5.12",
+    "deepmerge": "^4.2.2",
+    "jest": "^29.5.0"
+  },
+  "engines": {
+    "node": "^18.18 || >=20"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "lavamoat": {
+    "allowScripts": {
+      "@lavamoat/preinstall-always-fail": false
+    }
+  }
+}