feat: add more trezor paths, export path type #710
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,84 @@ | ||
| # @enkryptcom/hw-wallets | ||
|
|
||
| ## v0.0.12 | ||
|
|
||
| ## Hardware wallet manager for enkrypt | ||
|
|
||
| ### Getting started | ||
|
|
||
| #### Minimum Node version | ||
|
|
||
| `node v20` | ||
|
|
||
| #### Installation | ||
|
|
||
| NPM: `npm install @enkryptcom/hw-wallets @enkryptcom/types` | ||
| Yarn: `yarn add @enkryptcom/hw-wallets @enkryptcom/types` | ||
| PNPM `pnpm add @enkryptcom/hw-wallets @enkryptcom/types` | ||
|
|
||
| ### How to use | ||
|
|
||
| 1. Create an instance of `HWwalletManager` | ||
|
|
||
| ``` | ||
| import HWwalletManager from @enkryptcom/hw-wallets | ||
|
|
||
| const hwManager = new HWwalletManager() | ||
| ``` | ||
|
|
||
| 2. Call methods within class, passing network names and providers. Class automatically handles which wallet to use. | ||
|
|
||
| ### API | ||
|
|
||
| #### `getAddress(options: getAddressRequest): Promise<AddressResponse>` | ||
|
|
||
| Returns wallet address based off of the path provided in the `getAddressRequest`. | ||
|
|
||
| #### `signPersonalMessage(options: SignMessageRequest): Promise<string>` | ||
|
|
||
| Signs personal message. | ||
|
|
||
| #### `signTransaction(options: SignTransactionRequest): Promise<string>` | ||
|
|
||
| Returns an RPC sign you can then add to a transaction object. | ||
|
|
||
| #### `getSupportedPaths(options: isConnectedRequest): Promise<PathType[]>` | ||
|
|
||
| Returns supported paths based on options provided. | ||
|
|
||
| #### `isNetworkSupported(networkName: NetworkNames): boolean` | ||
|
|
||
| Checks network name support. | ||
|
|
||
| #### `isConnected(options: isConnectedRequest): Promise<boolean>` | ||
|
|
||
| Checks connection status. | ||
|
|
||
| #### `close(): Promise<void>` | ||
|
|
||
| Closes all HW wallet connections | ||
|
|
||
| ### Types | ||
|
|
||
| `NetworkNames`: https://github.com/enkryptcom/enKrypt/blob/main/packages/types/src/networks.ts#L1 | ||
| `getAddressRequest`: https://github.com/enkryptcom/enKrypt/blob/main/packages/hw-wallets/src/types.ts#L74 | ||
| `AddressResponse`: https://github.com/enkryptcom/enKrypt/blob/main/packages/hw-wallets/src/types.ts#L31 | ||
| `SignMessageRequest`: https://github.com/enkryptcom/enKrypt/blob/main/packages/hw-wallets/src/types.ts#L54 | ||
| `SignTransactionRequest`: https://github.com/enkryptcom/enKrypt/blob/main/packages/hw-wallets/src/types.ts#L65 | ||
| `isConnectedRequest`: https://github.com/enkryptcom/enKrypt/blob/main/packages/hw-wallets/src/types.ts#L78 | ||
|
|
||
| ### Adding more paths | ||
|
|
||
| Navigate to `src/configs.ts` and add your new derivation path at the bottom. | ||
| Make sure to follow the configuration in that file. | ||
| Import path in the corresponding `Trezor` provider `config.ts`. | ||
| See `src/trezor/ethereum/configs.ts` for example. | ||
|
|
||
| ### Notes | ||
|
|
||
| Connection request to hardware wallet actually happens on `getAddress()` request. | ||
| `Ledger` can't have any paths as each paths are defined by the corresponding app. | ||
|
|
||
| #### For Vue devs | ||
|
|
||
| `ref/reactive` will mess with how Vue compiles these classes because of how Vue utilizes proxies. If you want to store an instance into a ref or reactive, use [`makeRaw`](https://vuejs.org/api/reactivity-advanced#markraw). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -94,7 +94,7 @@ class LedgerSolana implements HWWalletProvider { | |||||||||||||||||||
|
|
||||||||||||||||||||
| close(): Promise<void> { | ||||||||||||||||||||
| // eslint-disable-next-line @typescript-eslint/no-empty-function | ||||||||||||||||||||
| return this.transport.close().catch(() => { }); | ||||||||||||||||||||
| } | ||||||||||||||||||||
|
Comment on lines
95
to
98
There was a problem hiding this comment. Handle the no-transport case before calling When initialization never bound a transport (e.g., both BLE and WebUSB unsupported), Add a simple guard: close(): Promise<void> {
- // eslint-disable-next-line @typescript-eslint/no-empty-function
- return this.transport.close().catch(() => { });
+ if (!this.transport) return Promise.resolve();
+ return this.transport.close().catch(() => undefined);
}📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents |
||||||||||||||||||||
|
|
||||||||||||||||||||
| isConnected(networkName: NetworkNames): Promise<boolean> { | ||||||||||||||||||||
|
|
@@ -110,4 +110,4 @@ class LedgerSolana implements HWWalletProvider { | |||||||||||||||||||
| } | ||||||||||||||||||||
| } | ||||||||||||||||||||
|
|
||||||||||||||||||||
| export default LedgerSolana; | ||||||||||||||||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -80,7 +80,7 @@ class LedgerSubstrate implements HWWalletProvider { | |
|
|
||
| close(): Promise<void> { | ||
| // eslint-disable-next-line @typescript-eslint/no-empty-function | ||
| return this.transport.close().catch(() => { }); | ||
| } | ||
|
Comment on lines
81
to
84
There was a problem hiding this comment. Guard
Use a guard (or optional chaining) so close(): Promise<void> {
- // eslint-disable-next-line @typescript-eslint/no-empty-function
- return this.transport.close().catch(() => { });
+ if (!this.transport) return Promise.resolve();
+ return this.transport.close().catch(() => undefined);
}🤖 Prompt for AI Agents |
||
|
|
||
| isConnected(networkName: NetworkNames): Promise<boolean> { | ||
|
|
@@ -128,4 +128,4 @@ class LedgerSubstrate implements HWWalletProvider { | |
| } | ||
| } | ||
|
|
||
| export default LedgerSubstrate; | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.