feat(keyring-eth-cash): add cash account keyring based on hd-key-ring by Jwhiles · Pull Request #472 · MetaMask/accounts

Jwhiles · 2026-03-09T13:53:25Z

Implements a new keyring to support MUSD-386

Examples

Note

Medium Risk
Introduces a new public KeyringType.Cash enum value and a new keyring package that derives/signs accounts on a different path; downstream consumers with exhaustive handling of keyring types or assumptions about HD derivation may need updates.

Overview
Adds cash account support by introducing a new @metamask/eth-cash-keyring package that extends @metamask/eth-hd-keyring with a distinct type ("Cash Keyring"), fixed derivation path (m/44'/4392018'/0'/0), and single-account behavior.

Updates the public API to include KeyringType.Cash (with type-level coverage in keyring.test-d.ts), and wires the new package into repo tooling/docs (PR title validation scope, root README module list/dependency graph, TS project references, and yarn.lock).

^{Written by Cursor Bugbot for commit 25e4b24. This will update automatically on new commits. Configure here.}

packages/keyring-eth-cash-account/src/cash-account-keyring.ts

danroc · 2026-03-10T08:07:50Z

Should we remove the ability to add accounts directly? We could override addAccounts to only allow 1 account to be added.

Yes, if this is what the product expects, we should enforce it. Otherwise, we might mistakenly create more than one account and end up dealing with this kind of hard-to-solve bug.

danroc · 2026-03-10T08:11:51Z

Calling it Cash Account for a keyring is a bit confusing because it overlaps with the concept of account. Using just Cash might be clearer.

WDYT @gantunesr, @ccharly ?

packages/keyring-api/src/api/v2/keyring-type.ts

packages/keyring-eth-cash-account/CHANGELOG.md

ccharly · 2026-03-10T08:44:33Z

packages/keyring-eth-cash-account/README.md

+
+- 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 v3](https://yarnpkg.com/getting-started/install)


Not sure this is up-to-date (to be checked @ccharly)

Yep, we use v4 now. That does not change much anyway 😄 but if you could change that too, that'd be nice!

packages/keyring-eth-cash/package.json

packages/keyring-eth-cash-account/src/cash-account-keyring.ts

ccharly · 2026-03-10T09:06:35Z

packages/keyring-eth-cash-account/src/cash-account-keyring.ts

+} from '@metamask/eth-hd-keyring';
+
+const hdPathString = `m/44'/4392018'/0'/0`;
+const type = 'Cash Account Keyring';


I would also export it just in case and maybe rename it to CASH_ACCOUNT_KEYRING_TYPE.

That could allow us to re-inject this constant value in some other enums (like the one in @metamask/keyring-controller (KeyringTypes).

packages/keyring-api/CHANGELOG.md

ccharly · 2026-03-10T09:14:48Z

Calling it Cash Account for a keyring is a bit confusing because it overlaps with the concept of account. Using just Cash might be clearer.

WDYT @gantunesr, @ccharly ?

I think you're right yep!

packages/keyring-eth-cash/CHANGELOG.md

cursor · 2026-03-10T11:40:59Z

README.md

  account_api --> keyring_api;
  account_api --> keyring_utils;
  keyring_api --> keyring_utils;
+  eth_cash_keyring --> keyring_eth_hd;


Mermaid diagram references wrong node variable name

Medium Severity

The new dependency edge eth_cash_keyring --> keyring_eth_hd references an undefined Mermaid node keyring_eth_hd. The correct variable name is eth_hd_keyring, as defined on line 45 and used consistently on lines 60–62. Mermaid will auto-create a separate orphan node instead of linking to the actual @metamask/eth-hd-keyring node, causing the dependency graph to render incorrectly.

gantunesr · 2026-03-10T12:11:09Z

packages/keyring-eth-cash/src/cash-keyring.ts

+export const CASH_DERIVATION_PATH = `m/44'/4392018'/0'/0`;
+const type = 'Cash Keyring';
+
+export class CashKeyring extends HdKeyring {


Double checking if this keyring should support removeAccount

I don't know if we need it. But having it shouldn't cause an issue, right?

I don't think so. Depending on designs, account is going to be largely hidden in the client anyway, so removing it wouldn't really serve any purpose

packages/keyring-eth-cash/src/cash-keyring.ts

cursor

Cursor Bugbot has reviewed your changes and found 3 potential issues.

^{Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.}

packages/keyring-eth-cash/src/index.ts

packages/keyring-eth-cash/src/cash-keyring.ts

.github/workflows/validate-pr-title.yml

Jwhiles · 2026-03-10T16:25:01Z

@metamaskbot publish-preview

github-actions · 2026-03-10T16:27:09Z

Preview builds have been published. See these instructions (from the core monorepo) for more information about preview builds.

Expand for full list of packages and versions.

{
  "@metamask-previews/account-api": "1.0.0-25e4b24",
  "@metamask-previews/hw-wallet-sdk": "0.5.0-25e4b24",
  "@metamask-previews/keyring-api": "21.5.0-25e4b24",
  "@metamask-previews/eth-cash-keyring": "0.0.0-25e4b24",
  "@metamask-previews/eth-hd-keyring": "13.1.0-25e4b24",
  "@metamask-previews/eth-ledger-bridge-keyring": "11.3.0-25e4b24",
  "@metamask-previews/eth-qr-keyring": "1.1.0-25e4b24",
  "@metamask-previews/eth-simple-keyring": "11.0.0-25e4b24",
  "@metamask-previews/eth-trezor-keyring": "9.0.0-25e4b24",
  "@metamask-previews/keyring-internal-api": "10.0.0-25e4b24",
  "@metamask-previews/keyring-internal-snap-client": "9.0.0-25e4b24",
  "@metamask-previews/eth-snap-keyring": "19.0.0-25e4b24",
  "@metamask-previews/keyring-snap-client": "8.2.0-25e4b24",
  "@metamask-previews/keyring-snap-sdk": "7.2.1-25e4b24",
  "@metamask-previews/keyring-utils": "3.2.0-25e4b24"
}

Jwhiles force-pushed the create-cash-account-keyring branch 5 times, most recently from 5f50434 to ca5f3e9 Compare March 9, 2026 19:10

feat: add cash account keyring based on hd-key-ring

01e9b64

Jwhiles force-pushed the create-cash-account-keyring branch from ca5f3e9 to 01e9b64 Compare March 9, 2026 19:19

danroc reviewed Mar 10, 2026

View reviewed changes

packages/keyring-eth-cash-account/src/cash-account-keyring.ts Outdated Show resolved Hide resolved

danroc reviewed Mar 10, 2026

View reviewed changes

packages/keyring-eth-cash-account/src/cash-account-keyring.ts Outdated Show resolved Hide resolved

ccharly reviewed Mar 10, 2026

View reviewed changes

packages/keyring-eth-cash/CHANGELOG.md Show resolved Hide resolved

chore: add comments explaining origin of deriation path

77eaae7

Jwhiles force-pushed the create-cash-account-keyring branch from 81d726d to fe35f69 Compare March 10, 2026 10:25

Jwhiles changed the title ~~feat: add cash account keyring based on hd-key-ring~~ feat(keyring-cash): add cash account keyring based on hd-key-ring Mar 10, 2026

Jwhiles added 6 commits March 10, 2026 10:52

chore: various small non-functional tweaks based on PR feedback

fe2949a

feat: only allow a single account to be added to cash keyring

3de607b

chore: update keyring-api changelog

8fb69f7

feat: limit options that can be passed to deserialize in cash keyring

8ebb609

chore: rename new keyring package to simply cash

5df4e9b

chore: change version of eth-cash to 0.0.0

b26b341

Jwhiles force-pushed the create-cash-account-keyring branch from 5395223 to b26b341 Compare March 10, 2026 10:52

Jwhiles marked this pull request as ready for review March 10, 2026 11:35

Jwhiles requested a review from a team as a code owner March 10, 2026 11:35

Jwhiles requested review from ccharly and danroc March 10, 2026 11:35

cursor bot reviewed Mar 10, 2026

View reviewed changes

gantunesr reviewed Mar 10, 2026

View reviewed changes

Jwhiles added 2 commits March 10, 2026 14:14

fix: only allow one account to be added

980df04

chore: remove un-needed tests

edd76fb

cursor bot reviewed Mar 10, 2026

View reviewed changes

packages/keyring-eth-cash/src/index.ts Outdated Show resolved Hide resolved

packages/keyring-eth-cash/src/cash-keyring.ts Show resolved Hide resolved

.github/workflows/validate-pr-title.yml Outdated Show resolved Hide resolved

chore: fix pr tag

702efff

Jwhiles changed the title ~~feat(keyring-cash): add cash account keyring based on hd-key-ring~~ feat(keyring-eth-cash): add cash account keyring based on hd-key-ring Mar 10, 2026

chore: export the derivation path

25e4b24

Jwhiles requested a review from gantunesr March 10, 2026 15:20

Uh oh!

Conversation

Jwhiles commented Mar 9, 2026 • edited by cursor bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Examples

Uh oh!

Uh oh!

Uh oh!

danroc commented Mar 10, 2026

Uh oh!

danroc commented Mar 10, 2026

Uh oh!

Uh oh!

Uh oh!

ccharly Mar 10, 2026

Choose a reason for hiding this comment

Uh oh!

ccharly Mar 10, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ccharly Mar 10, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ccharly commented Mar 10, 2026

Uh oh!

Uh oh!

cursor bot Mar 10, 2026

Choose a reason for hiding this comment

Mermaid diagram references wrong node variable name

Uh oh!

gantunesr Mar 10, 2026

Choose a reason for hiding this comment

Uh oh!

Jwhiles Mar 10, 2026

Choose a reason for hiding this comment

Uh oh!

shane-t Mar 16, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Jwhiles commented Mar 10, 2026

Uh oh!

github-actions bot commented Mar 10, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Jwhiles commented Mar 9, 2026 •

edited by cursor bot

Loading