refactor(keyring-api): make capabilities boolean fields exact optionals

packages/keyring-api/CHANGELOG.md

@@ -22,6 +22,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+- Make BIP-44 capabilities optional in `KeyringCapabilities` ([#453](https://github.com/MetaMask/accounts/pull/453))
+  - The `derivePath`, `deriveIndex`, `deriveIndexRange`, and `discover` capabilities are now optional.
+  - A capability set to `true` indicates support, while `false` or `undefined` indicates no support.
+  - Keyrings no longer need to explicitly set unsupported capabilities to `false`.
 - Change `KeyringWrapper.capabilities` from a readonly property to a getter ([#447](https://github.com/MetaMask/accounts/pull/447))
   - Allows subclasses to override and return capabilities dynamically based on runtime state.
 - Refine `EthAddressStruct` in order to make it compatible with the `Hex` type from `@metamask/utils` ([#405](https://github.com/MetaMask/accounts/pull/405))

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

@@ -30,19 +30,19 @@ export const KeyringCapabilitiesStruct = object({
       /**
        * Whether the keyring supports deriving accounts from a specific BIP-44 path.
        */
-      derivePath: boolean(),
+      derivePath: exactOptional(boolean()),
       /**
        * Whether the keyring supports deriving accounts from a BIP-44 account index.
        */
-      deriveIndex: boolean(),
+      deriveIndex: exactOptional(boolean()),
       /**
        * Whether the keyring supports deriving accounts from a range of BIP-44 account indices.
        */
-      deriveIndexRange: boolean(),
+      deriveIndexRange: exactOptional(boolean()),
       /**
        * Whether the keyring supports BIP-44 account discovery.
        */
-      discover: boolean(),
+      discover: exactOptional(boolean()),
     }),
   ),
   /**

packages/keyring-eth-hd/CHANGELOG.md

@@ -9,7 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- Add `HdKeyringV2` class implementing `KeyringV2` interface ([#398](https://github.com/MetaMask/accounts/pull/398)), ([#404](https://github.com/MetaMask/accounts/pull/404)), ([#410](https://github.com/MetaMask/accounts/pull/410)), ([#413](https://github.com/MetaMask/accounts/pull/413)), ([#451](https://github.com/MetaMask/accounts/pull/451))
+- Add `HdKeyringV2` class implementing `KeyringV2` interface ([#398](https://github.com/MetaMask/accounts/pull/398)), ([#404](https://github.com/MetaMask/accounts/pull/404)), ([#410](https://github.com/MetaMask/accounts/pull/410)), ([#413](https://github.com/MetaMask/accounts/pull/413)), ([#451](https://github.com/MetaMask/accounts/pull/451)), ([#453](https://github.com/MetaMask/accounts/pull/453))
   - Wraps legacy `HdKeyring` to expose accounts via the unified `KeyringV2` API and the `KeyringAccount` type.
   - Extends `EthKeyringWrapper` for common Ethereum logic.
 

packages/keyring-eth-hd/src/hd-keyring-v2.test.ts

@@ -66,9 +66,9 @@ describe('HdKeyringV2', () => {
       expect(wrapper.type).toBe(KeyringType.Hd);
       expect(wrapper.capabilities.scopes).toStrictEqual([EthScope.Eoa]);
       expect(wrapper.capabilities.bip44?.deriveIndex).toBe(true);
-      expect(wrapper.capabilities.bip44?.derivePath).toBe(false);
-      expect(wrapper.capabilities.bip44?.deriveIndexRange).toBe(false);
-      expect(wrapper.capabilities.bip44?.discover).toBe(false);
+      expect(wrapper.capabilities.bip44?.derivePath).toBeUndefined();
+      expect(wrapper.capabilities.bip44?.deriveIndexRange).toBeUndefined();
+      expect(wrapper.capabilities.bip44?.discover).toBeUndefined();
     });
   });
 

packages/keyring-eth-hd/src/hd-keyring-v2.ts

@@ -42,9 +42,6 @@ const hdKeyringV2Capabilities: KeyringCapabilities = {
   scopes: [EthScope.Eoa],
   bip44: {
     deriveIndex: true,
-    derivePath: false,
-    deriveIndexRange: false,
-    discover: false,
   },
   privateKey: {
     exportFormats: [{ encoding: PrivateKeyEncoding.Hexadecimal }],

packages/keyring-eth-ledger-bridge/CHANGELOG.md

@@ -9,7 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- Add `LedgerKeyringV2` class implementing `KeyringV2` interface ([#416](https://github.com/MetaMask/accounts/pull/416)), ([#451](https://github.com/MetaMask/accounts/pull/451))
+- Add `LedgerKeyringV2` class implementing `KeyringV2` interface ([#416](https://github.com/MetaMask/accounts/pull/416)), ([#451](https://github.com/MetaMask/accounts/pull/451)), ([#453](https://github.com/MetaMask/accounts/pull/453))
   - Wraps legacy `LedgerKeyring` to expose accounts via the unified `KeyringV2` API and the `KeyringAccount` type.
   - Extends `EthKeyringWrapper` for common Ethereum logic.
 

packages/keyring-eth-ledger-bridge/src/ledger-keyring-v2.test.ts

@@ -252,8 +252,6 @@ describe('LedgerKeyringV2', () => {
         bip44: {
           deriveIndex: true,
           derivePath: true,
-          deriveIndexRange: false,
-          discover: false,
         },
       });
     });

packages/keyring-eth-ledger-bridge/src/ledger-keyring-v2.ts

@@ -32,8 +32,6 @@ const ledgerKeyringV2Capabilities: KeyringCapabilities = {
   bip44: {
     deriveIndex: true,
     derivePath: true,
-    deriveIndexRange: false,
-    discover: false,
   },
 };
 

packages/keyring-eth-qr/CHANGELOG.md

@@ -9,7 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- Add `QrKeyringV2` class implementing `KeyringV2` interface ([#411](https://github.com/MetaMask/accounts/pull/411)), ([#447](https://github.com/MetaMask/accounts/pull/447)), ([#451](https://github.com/MetaMask/accounts/pull/451))
+- Add `QrKeyringV2` class implementing `KeyringV2` interface ([#411](https://github.com/MetaMask/accounts/pull/411)), ([#447](https://github.com/MetaMask/accounts/pull/447)), ([#451](https://github.com/MetaMask/accounts/pull/451)), ([#453](https://github.com/MetaMask/accounts/pull/453))
   - Wraps legacy `QrKeyring` to expose accounts via the unified `KeyringV2` API and the `KeyringAccount` type.
   - Extends `EthKeyringWrapper` for common Ethereum logic.
 

packages/keyring-eth-qr/src/qr-keyring-v2.test.ts

@@ -210,9 +210,6 @@ describe('QrKeyringV2', () => {
         scopes: [EthScope.Eoa],
         bip44: {
           deriveIndex: true,
-          derivePath: false,
-          deriveIndexRange: false,
-          discover: false,
         },
       });
     });
@@ -355,9 +352,6 @@ describe('QrKeyringV2', () => {
         scopes: [EthScope.Eoa],
         bip44: {
           deriveIndex: true,
-          derivePath: false,
-          deriveIndexRange: false,
-          discover: false,
         },
       });
     });
@@ -403,9 +397,6 @@ describe('QrKeyringV2', () => {
         scopes: [EthScope.Eoa],
         bip44: {
           deriveIndex: true,
-          derivePath: false,
-          deriveIndexRange: false,
-          discover: false,
         },
       });
     });

packages/keyring-eth-qr/src/qr-keyring-v2.ts

@@ -36,9 +36,6 @@ const HD_MODE_CAPABILITIES: KeyringCapabilities = {
   scopes: [EthScope.Eoa],
   bip44: {
     deriveIndex: true,
-    derivePath: false,
-    deriveIndexRange: false,
-    discover: false,
   },
 };
 

packages/keyring-eth-trezor/CHANGELOG.md

@@ -9,7 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- Add `TrezorKeyringV2` and `OneKeyKeyringV2` classes implementing `KeyringV2` interface ([#412](https://github.com/MetaMask/accounts/pull/412)), ([#451](https://github.com/MetaMask/accounts/pull/451))
+- Add `TrezorKeyringV2` and `OneKeyKeyringV2` classes implementing `KeyringV2` interface ([#412](https://github.com/MetaMask/accounts/pull/412)), ([#451](https://github.com/MetaMask/accounts/pull/451)), ([#453](https://github.com/MetaMask/accounts/pull/453))
   - Wraps legacy `TrezorKeyring` and `OneKeyKeyring` to expose accounts via the unified `KeyringV2` API and the `KeyringAccount` type.
   - Extends `EthKeyringWrapper` for common Ethereum logic.
 

packages/keyring-eth-trezor/src/trezor-keyring-v2.test.ts

@@ -204,8 +204,6 @@ describe('TrezorKeyringV2', () => {
         bip44: {
           deriveIndex: true,
           derivePath: true,
-          deriveIndexRange: false,
-          discover: false,
         },
       });
     });

packages/keyring-eth-trezor/src/trezor-keyring-v2.ts

@@ -33,8 +33,6 @@ const trezorKeyringV2Capabilities: KeyringCapabilities = {
   bip44: {
     deriveIndex: true,
     derivePath: true,
-    deriveIndexRange: false,
-    discover: false,
   },
 };