Skip to content

Commit

Permalink
feat: add new keyring type for oneKey (#5216)
Browse files Browse the repository at this point in the history
## Explanation

This PR adds support for a dedicated OneKey keyring (until now it was
sharing the same keyring instance than Trezor) so it's considered as a
standalone device and could get its own tag inside account list.

There are two others PRs:
- metamask-extension:
MetaMask/metamask-extension#29999
- eth-trezor-keyring: MetaMask/accounts#175

## References

Fixes: MetaMask/accounts-planning#793

## Changelog

<!--
If you're making any consumer-facing changes, list those changes here as
if you were updating a changelog, using the template below as a guide.

(CATEGORY is one of BREAKING, ADDED, CHANGED, DEPRECATED, REMOVED, or
FIXED. For security-related issues, follow the Security Advisory
process.)

Please take care to name the exact pieces of the API you've added or
changed (e.g. types, interfaces, functions, or methods).

If there are any breaking changes, make sure to offer a solution for
consumers to follow once they upgrade to the changes.

Finally, if you're only making changes to development scripts or tests,
you may replace the template below with "None".
-->

### `@metamask/accounts-controller`

- **utils**: add OneKey keyring type
- **tests**: update accounts controller unit test with OneKey keyring
type

### `@metamask/keyring-controller`

- **controller**: add OneKey keyring type

## Checklist

- [x] I've updated the test suite for new or updated code as appropriate
- [ ] I've updated documentation (JSDoc, Markdown, etc.) for new or
updated code as appropriate
- [ ] I've highlighted breaking changes using the "BREAKING" category
above as appropriate
- [x] I've prepared draft pull requests for clients and consumer
packages to resolve any breaking changes
  • Loading branch information
Akaryatrh authored Feb 12, 2025
1 parent 060c729 commit 75230dc
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -1875,6 +1875,7 @@ describe('AccountsController', () => {
KeyringTypes.simple,
KeyringTypes.hd,
KeyringTypes.trezor,
KeyringTypes.oneKey,
KeyringTypes.ledger,
KeyringTypes.lattice,
KeyringTypes.qr,
Expand Down
3 changes: 3 additions & 0 deletions packages/accounts-controller/src/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ export function keyringTypeToName(keyringType: string): string {
case KeyringTypes.trezor: {
return 'Trezor';
}
case KeyringTypes.oneKey: {
return 'OneKey';
}
case KeyringTypes.ledger: {
return 'Ledger';
}
Expand Down
1 change: 1 addition & 0 deletions packages/keyring-controller/src/KeyringController.ts
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ export enum KeyringTypes {
hd = 'HD Key Tree',
qr = 'QR Hardware Wallet Device',
trezor = 'Trezor Hardware',
oneKey = 'OneKey Hardware',
ledger = 'Ledger Hardware',
lattice = 'Lattice Hardware',
snap = 'Snap Keyring',
Expand Down

0 comments on commit 75230dc

Please sign in to comment.