chore: rename new keyring package to simply cash

Jwhiles · Jwhiles · commit fe35f69e6db3 · 2026-03-10T10:25:31.000Z
diff --git a/.github/workflows/validate-pr-title.yml b/.github/workflows/validate-pr-title.yml
@@ -43,6 +43,7 @@ jobs:
             deps-dev
             keyring-api
             keyring-eth-hd
+            keyring-cash
             keyring-eth-ledger-bridge
             keyring-eth-simple
             keyring-eth-trezor
diff --git a/README.md b/README.md
@@ -13,7 +13,7 @@ This repository contains the following packages [^fn1]:
 <!-- start package list -->
 
 - [`@metamask/account-api`](packages/account-api)
-- [`@metamask/eth-cash-account-keyring`](packages/keyring-eth-cash-account)
+- [`@metamask/eth-cash-keyring`](packages/keyring-eth-cash)
 - [`@metamask/eth-hd-keyring`](packages/keyring-eth-hd)
 - [`@metamask/eth-ledger-bridge-keyring`](packages/keyring-eth-ledger-bridge)
 - [`@metamask/eth-qr-keyring`](packages/keyring-eth-qr)
@@ -41,7 +41,7 @@ linkStyle default opacity:0.5
   account_api(["@metamask/account-api"]);
   hw_wallet_sdk(["@metamask/hw-wallet-sdk"]);
   keyring_api(["@metamask/keyring-api"]);
-  eth_cash_account_keyring(["@metamask/eth-cash-account-keyring"]);
+  eth_cash_keyring(["@metamask/eth-cash-keyring"]);
   eth_hd_keyring(["@metamask/eth-hd-keyring"]);
   eth_ledger_bridge_keyring(["@metamask/eth-ledger-bridge-keyring"]);
   eth_qr_keyring(["@metamask/eth-qr-keyring"]);
@@ -56,7 +56,7 @@ linkStyle default opacity:0.5
   account_api --> keyring_api;
   account_api --> keyring_utils;
   keyring_api --> keyring_utils;
-  eth_cash_account_keyring --> keyring_eth_hd;
+  eth_cash_keyring --> keyring_eth_hd;
   eth_hd_keyring --> keyring_api;
   eth_hd_keyring --> keyring_utils;
   eth_hd_keyring --> account_api;
diff --git a/packages/keyring-api/CHANGELOG.md b/packages/keyring-api/CHANGELOG.md
@@ -9,7 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- Add `KeyringType.CashAccount` variant ([#472](https://github.com/MetaMask/accounts/pull/472))
+- Add `KeyringType.Cash` variant ([#472](https://github.com/MetaMask/accounts/pull/472))
 - Add optional `details` field to `Transaction` type ([#445](https://github.com/MetaMask/accounts/pull/445))
   - Add `SecurityAlertResponse` enum with values: `benign`, `warning`, `malicious`
   - Add optional `origin` field (string) to track transaction request source
diff --git a/packages/keyring-api/src/api/v2/keyring-type.ts b/packages/keyring-api/src/api/v2/keyring-type.ts
@@ -47,5 +47,5 @@ export enum KeyringType {
   /**
    * Represents keyring for cash accounts.
    */
-  CashAccount = 'cash-account',
+  Cash = 'cash',
 }
diff --git a/packages/keyring-api/src/api/v2/keyring.test-d.ts b/packages/keyring-api/src/api/v2/keyring.test-d.ts
@@ -22,7 +22,7 @@ import type { ImportPrivateKeyFormat } from './private-key';
 
 // Test KeyringType enum
 expectAssignable<KeyringType>(KeyringType.Hd);
-expectAssignable<KeyringType>(KeyringType.CashAccount);
+expectAssignable<KeyringType>(KeyringType.Cash);
 expectAssignable<KeyringType>(KeyringType.PrivateKey);
 expectAssignable<KeyringType>(KeyringType.Qr);
 expectAssignable<KeyringType>(KeyringType.Snap);
diff --git a/packages/keyring-eth-cash-account/src/index.ts b/packages/keyring-eth-cash-account/src/index.ts
diff --git a/packages/keyring-eth-cash/CHANGELOG.md b/packages/keyring-eth-cash/CHANGELOG.md
@@ -9,9 +9,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- Add initial implementation of `CashAccountKeyring` ([#472](https://github.com/MetaMask/accounts/pull/472))
+- Add initial implementation of `CashKeyring` ([#472](https://github.com/MetaMask/accounts/pull/472))
   - Extends `HdKeyring` from `@metamask/eth-hd-keyring`.
-  - Uses keyring type `"Cash Account Keyring"`.
+  - Uses keyring type `"Cash Keyring"`.
   - Uses derivation path `"m/44'/4392018'/0'/0"`.
 
 [Unreleased]: https://github.com/MetaMask/accounts/
diff --git a/packages/keyring-eth-cash/LICENSE b/packages/keyring-eth-cash/LICENSE
diff --git a/packages/keyring-eth-cash/README.md b/packages/keyring-eth-cash/README.md
@@ -1,26 +1,26 @@
-# Cash Account Keyring
+# Cash Keyring
 
 An Ethereum keyring that extends [`@metamask/eth-hd-keyring`](../keyring-eth-hd) with a distinct keyring type and derivation path for cash accounts.
 
 Cash 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-cash-account-keyring`
+`yarn add @metamask/eth-cash-keyring`
 
 or
 
-`npm install @metamask/eth-cash-account-keyring`
+`npm install @metamask/eth-cash-keyring`
 
 ## Usage
 
 ```ts
-import { CashAccountKeyring } from '@metamask/eth-cash-account-keyring';
+import { CashKeyring } from '@metamask/eth-cash-keyring';
 
-const keyring = new CashAccountKeyring();
+const keyring = new CashKeyring();
 ```
 
-The `CashAccountKeyring` class implements the same `Keyring` interface as `HdKeyring` — see the [HD Keyring README](../keyring-eth-hd/README.md) for full API documentation.
+The `CashKeyring` class implements the same `Keyring` interface as `HdKeyring` — see the [HD Keyring README](../keyring-eth-hd/README.md) for full API documentation.
 
 ## Contributing
 
diff --git a/packages/keyring-eth-cash/jest.config.js b/packages/keyring-eth-cash/jest.config.js
diff --git a/packages/keyring-eth-cash/package.json b/packages/keyring-eth-cash/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "@metamask/eth-cash-account-keyring",
+  "name": "@metamask/eth-cash-keyring",
   "version": "1.0.0",
   "description": "A cash account keyring that extends the HD keyring with a different keyring type and derivation path.",
   "keywords": [
@@ -36,8 +36,8 @@
     "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-cash-account-keyring",
-    "changelog:validate": "../../scripts/validate-changelog.sh @metamask/eth-cash-account-keyring",
+    "changelog:update": "../../scripts/update-changelog.sh @metamask/eth-cash-keyring",
+    "changelog:validate": "../../scripts/validate-changelog.sh @metamask/eth-cash-keyring",
     "publish:preview": "yarn npm publish --tag preview",
     "test": "jest",
     "test:clean": "jest --clearCache"
diff --git a/packages/keyring-eth-cash/src/cash-keyring.test.ts b/packages/keyring-eth-cash/src/cash-keyring.test.ts
@@ -8,59 +8,59 @@ import {
 import { normalize } from '@metamask/eth-sig-util';
 import { assert, type Hex } from '@metamask/utils';
 
-import { CashAccountKeyring } from './cash-account-keyring';
+import { CashKeyring } from './cash-keyring';
 
 const sampleMnemonic =
   'finish oppose decorate face calm tragic certain desk hour urge dinosaur mango';
 
-const cashAccountHdPath = `m/44'/4392018'/0'/0`;
+const cashHdPath = `m/44'/4392018'/0'/0`;
 
 const getAddressAtIndex = async (
-  keyring: CashAccountKeyring,
+  keyring: CashKeyring,
   index: number,
 ): Promise<Hex> => {
   const accounts = await keyring.getAccounts();
   assert(accounts[index], `Account not found at index ${index}`);
   return accounts[index];
 };
 
-describe('CashAccountKeyring', () => {
+describe('CashKeyring', () => {
   describe('static properties', () => {
     it('has the correct type', () => {
-      expect(CashAccountKeyring.type).toBe('Cash Account Keyring');
+      expect(CashKeyring.type).toBe('Cash Keyring');
     });
   });
 
   describe('#type', () => {
     it('returns the correct value', () => {
-      const keyring = new CashAccountKeyring();
-      expect(keyring.type).toBe('Cash Account Keyring');
-      expect(keyring.type).toBe(CashAccountKeyring.type);
+      const keyring = new CashKeyring();
+      expect(keyring.type).toBe('Cash Keyring');
+      expect(keyring.type).toBe(CashKeyring.type);
     });
   });
 
   describe('#hdPath', () => {
     it('uses the cash account derivation path', () => {
-      const keyring = new CashAccountKeyring();
-      expect(keyring.hdPath).toBe(cashAccountHdPath);
+      const keyring = new CashKeyring();
+      expect(keyring.hdPath).toBe(cashHdPath);
     });
   });
 
   describe('#deserialize', () => {
     it('derives accounts using the cash account hd path', async () => {
-      const keyring = new CashAccountKeyring();
+      const keyring = new CashKeyring();
       await keyring.deserialize({
         mnemonic: sampleMnemonic,
       });
 
       const serialized = await keyring.serialize();
-      expect(serialized.hdPath).toBe(cashAccountHdPath);
+      expect(serialized.hdPath).toBe(cashHdPath);
     });
 
     it('derives different addresses than the standard HD keyring path', async () => {
       const { HdKeyring } = await import('@metamask/eth-hd-keyring');
 
-      const cashKeyring = new CashAccountKeyring();
+      const cashKeyring = new CashKeyring();
       await cashKeyring.deserialize({
         mnemonic: sampleMnemonic,
       });
@@ -77,27 +77,27 @@ describe('CashAccountKeyring', () => {
     });
 
     it('uses the cash account hd path when no hdPath option is provided', async () => {
-      const keyring = new CashAccountKeyring();
+      const keyring = new CashKeyring();
       await keyring.deserialize({
         mnemonic: sampleMnemonic,
       });
 
       const serialized = await keyring.serialize();
-      expect(serialized.hdPath).toBe(cashAccountHdPath);
+      expect(serialized.hdPath).toBe(cashHdPath);
     });
 
     it('always uses the cash account hd path', async () => {
-      const keyring = new CashAccountKeyring();
+      const keyring = new CashKeyring();
       await keyring.deserialize({
         mnemonic: sampleMnemonic,
       });
 
       const serialized = await keyring.serialize();
-      expect(serialized.hdPath).toBe(cashAccountHdPath);
+      expect(serialized.hdPath).toBe(cashHdPath);
     });
 
     it('always deserializes exactly one account', async () => {
-      const keyring = new CashAccountKeyring();
+      const keyring = new CashKeyring();
       await keyring.deserialize({
         mnemonic: sampleMnemonic,
       });
@@ -109,7 +109,7 @@ describe('CashAccountKeyring', () => {
 
   describe('#addAccounts', () => {
     it('adds a single account', async () => {
-      const keyring = new CashAccountKeyring();
+      const keyring = new CashKeyring();
       await keyring.deserialize({
         mnemonic: sampleMnemonic,
       });
@@ -120,7 +120,7 @@ describe('CashAccountKeyring', () => {
     });
 
     it('only adds one account per call', async () => {
-      const keyring = new CashAccountKeyring();
+      const keyring = new CashKeyring();
       await keyring.deserialize({
         mnemonic: sampleMnemonic,
       });
@@ -135,7 +135,7 @@ describe('CashAccountKeyring', () => {
 
   describe('#signPersonalMessage', () => {
     it('signs and the signature can be recovered', async () => {
-      const keyring = new CashAccountKeyring();
+      const keyring = new CashKeyring();
       await keyring.deserialize({
         mnemonic: sampleMnemonic,
       });
@@ -154,7 +154,7 @@ describe('CashAccountKeyring', () => {
 
   describe('#signTypedData', () => {
     it('signs V1 typed data and the signature can be recovered', async () => {
-      const keyring = new CashAccountKeyring();
+      const keyring = new CashKeyring();
       await keyring.deserialize({
         mnemonic: sampleMnemonic,
       });
@@ -178,7 +178,7 @@ describe('CashAccountKeyring', () => {
     });
 
     it('signs V3 typed data and the signature can be recovered', async () => {
-      const keyring = new CashAccountKeyring();
+      const keyring = new CashKeyring();
       await keyring.deserialize({
         mnemonic: sampleMnemonic,
       });
@@ -207,7 +207,7 @@ describe('CashAccountKeyring', () => {
 
   describe('#removeAccount', () => {
     it('removes an existing account', async () => {
-      const keyring = new CashAccountKeyring();
+      const keyring = new CashKeyring();
       await keyring.deserialize({
         mnemonic: sampleMnemonic,
       });
@@ -221,7 +221,7 @@ describe('CashAccountKeyring', () => {
     });
 
     it('throws when removing a non-existent account', () => {
-      const keyring = new CashAccountKeyring();
+      const keyring = new CashKeyring();
       const fakeAddress = '0x0000000000000000000000000000000000000000';
       expect(() => keyring.removeAccount(fakeAddress)).toThrow(
         `Address ${fakeAddress} not found in this keyring`,
@@ -231,15 +231,15 @@ describe('CashAccountKeyring', () => {
 
   describe('#serialize / #deserialize round-trip', () => {
     it('serializes what it deserializes', async () => {
-      const keyring = new CashAccountKeyring();
+      const keyring = new CashKeyring();
       await keyring.deserialize({
         mnemonic: sampleMnemonic,
       });
 
       const accounts = await keyring.getAccounts();
       const serialized = await keyring.serialize();
 
-      const restored = new CashAccountKeyring();
+      const restored = new CashKeyring();
       await restored.deserialize({
         mnemonic: serialized.mnemonic,
       });
@@ -248,7 +248,7 @@ describe('CashAccountKeyring', () => {
       expect(restoredAccounts).toStrictEqual(accounts);
 
       const restoredSerialized = await restored.serialize();
-      expect(restoredSerialized.hdPath).toBe(cashAccountHdPath);
+      expect(restoredSerialized.hdPath).toBe(cashHdPath);
       expect(restoredSerialized.numberOfAccounts).toBe(1);
     });
   });
diff --git a/packages/keyring-eth-cash/src/cash-keyring.ts b/packages/keyring-eth-cash/src/cash-keyring.ts
@@ -5,18 +5,18 @@ import {
 import type { Hex } from '@metamask/utils';
 
 // Based on the coin type created in [this PR](https://github.com/satoshilabs/slips/pull/1983)
-export const CASH_ACCOUNT_DERIVATION_PATH = `m/44'/4392018'/0'/0`;
-const type = 'Cash Account Keyring';
+export const CASH_DERIVATION_PATH = `m/44'/4392018'/0'/0`;
+const type = 'Cash Keyring';
 
-export class CashAccountKeyring extends HdKeyring {
+export class CashKeyring extends HdKeyring {
   static override type: string = type;
 
   override readonly type: string = type;
 
-  override readonly hdPath: string = CASH_ACCOUNT_DERIVATION_PATH;
+  override readonly hdPath: string = CASH_DERIVATION_PATH;
 
   // This override is required because the deserialize method in the
-  // CashAccountKeyring falls back to it's own static value if no
+  // CashKeyring falls back to it's own static value if no
   // option is provided.
   override async deserialize(
     opts: Partial<
@@ -26,7 +26,7 @@ export class CashAccountKeyring extends HdKeyring {
     return super.deserialize({
       ...opts,
       numberOfAccounts: 1,
-      hdPath: CASH_ACCOUNT_DERIVATION_PATH,
+      hdPath: CASH_DERIVATION_PATH,
     });
   }
 
diff --git a/packages/keyring-eth-cash/src/index.ts b/packages/keyring-eth-cash/src/index.ts
@@ -0,0 +1 @@
+export { CashKeyring } from './cash-keyring';
diff --git a/packages/keyring-eth-cash/tsconfig.build.json b/packages/keyring-eth-cash/tsconfig.build.json
diff --git a/packages/keyring-eth-cash/tsconfig.json b/packages/keyring-eth-cash/tsconfig.json
diff --git a/tsconfig.build.json b/tsconfig.build.json
@@ -4,7 +4,7 @@
     { "path": "./packages/hw-wallet-sdk/tsconfig.build.json" },
     { "path": "./packages/keyring-api/tsconfig.build.json" },
     { "path": "./packages/keyring-eth-hd/tsconfig.build.json" },
-    { "path": "./packages/keyring-eth-cash-account/tsconfig.build.json" },
+    { "path": "./packages/keyring-eth-cash/tsconfig.build.json" },
     { "path": "./packages/keyring-eth-ledger-bridge/tsconfig.build.json" },
     { "path": "./packages/keyring-eth-qr/tsconfig.build.json" },
     { "path": "./packages/keyring-eth-simple/tsconfig.build.json" },
diff --git a/yarn.lock b/yarn.lock
@@ -1678,9 +1678,9 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@metamask/eth-cash-account-keyring@workspace:packages/keyring-eth-cash-account":
+"@metamask/eth-cash-keyring@workspace:packages/keyring-eth-cash":
   version: 0.0.0-use.local
-  resolution: "@metamask/eth-cash-account-keyring@workspace:packages/keyring-eth-cash-account"
+  resolution: "@metamask/eth-cash-keyring@workspace:packages/keyring-eth-cash"
   dependencies:
     "@lavamoat/allow-scripts": "npm:^3.2.1"
     "@lavamoat/preinstall-always-fail": "npm:^2.1.0"

Original file line number	Diff line number	Diff line change
`@@ -47,5 +47,5 @@ export enum KeyringType {`
`47`	`47`	`/**`
`48`	`48`	`* Represents keyring for cash accounts.`
`49`	`49`	`*/`
`50`		`- CashAccount = 'cash-account',`
	`50`	`+ Cash = 'cash',`
`51`	`51`	`}`