Skip to content

Commit dd5709c

Browse files
committed
fix: conflicts
1 parent 96a0984 commit dd5709c

2 files changed

Lines changed: 70 additions & 1 deletion

File tree

packages/hw-wallets/README.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,72 @@
11
# @enkryptcom/hw-wallets
22

3+
## v0.0.5
4+
35
## Hardware wallet manager for enkrypt
6+
7+
### Getting started
8+
9+
#### Minimum Node version
10+
11+
`node v20`
12+
13+
#### Installation
14+
15+
NPM: `npm install @enkryptcom/hw-wallets @enkryptcom/types`
16+
Yarn: `yarn add @enkryptcom/hw-wallets @enkryptcom/types`
17+
PNPM `pnpm add @enkryptcom/hw-wallets @enkryptcom/types`
18+
19+
### How to use
20+
21+
1. Create an instance of `HWwalletManager`
22+
23+
```
24+
import HWwalletManager from @enkryptcom/hw-wallets
25+
26+
const hwManager = new HWwalletManager()
27+
```
28+
29+
2. Call methods within class, passing network names and providers. Class automatically handles which wallet to use.
30+
31+
### API
32+
33+
#### `getAddress(options: getAddressRequest): Promise<AddressResponse>`
34+
35+
Returns wallet address based off of the path provided in the `getAddressRequest`.
36+
37+
#### `signPersonalMessage(options: SignMessageRequest): Promise<string>`
38+
39+
Signs personal message.
40+
41+
#### `signTransaction(options: SignTransactionRequest): Promise<string>`
42+
43+
Signs transaction.
44+
45+
#### `getSupportedPaths(options: isConnectedRequest): Promise<PathType[]>`
46+
47+
Returns supported paths based on options provided.
48+
49+
#### `isNetworkSupported(networkName: NetworkNames): boolean`
50+
51+
Checks network name support.
52+
53+
#### `isConnected(options: isConnectedRequest): Promise<boolean>`
54+
55+
Checks connection status.
56+
57+
#### `close(): Promise<void>`
58+
59+
Closes all HW wallet connections
60+
61+
### Types
62+
63+
`NetworkNames`: https://github.com/enkryptcom/enKrypt/blob/main/packages/types/src/networks.ts#L1
64+
`getAddressRequest`: https://github.com/enkryptcom/enKrypt/blob/main/packages/hw-wallets/src/types.ts#L74
65+
`AddressResponse`: https://github.com/enkryptcom/enKrypt/blob/main/packages/hw-wallets/src/types.ts#L31
66+
`SignMessageRequest`: https://github.com/enkryptcom/enKrypt/blob/main/packages/hw-wallets/src/types.ts#L54
67+
`SignTransactionRequest`: https://github.com/enkryptcom/enKrypt/blob/main/packages/hw-wallets/src/types.ts#L65
68+
`isConnectedRequest`: https://github.com/enkryptcom/enKrypt/blob/main/packages/hw-wallets/src/types.ts#L78
69+
70+
### Examples
71+
72+
TO BE ADDED

packages/hw-wallets/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
"test": "vitest run"
2020
},
2121
"engines": {
22-
"node": ">=14.15.0"
22+
"node": ">=20"
2323
},
2424
"devDependencies": {
2525
"@types/node": "^22.15.24",

0 commit comments

Comments
 (0)