OverviewFilesCommitsIssuesDocsReleasesPeers

hyper-wallet-lib commits / 190ba0b

README: the repo had none
Written from the tree: index.js re-exports only identity.js and secure-storage.js, while eighteen further .cjs modules ship and are reachable by path alone -- worth saying, because the index makes the package look far smaller than it is. Noted the ESM/CJS split and the two secure-storage files, and that keytar is native so this will not run under Bare. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
190ba0b5e9328e5465f24faa1d802944d940a206
by plankatron <fleeky@gmail.com> · 2026-09-10T15:43:49.000Z

Changed files (1) +56 -0

README.md +56 -0
……@@ -0,0 +1,56 @@
1# hyper-wallet-lib
2
3Shared library for [hyper-wallet](../hyper-wallet) — identity management and secure storage.
4
5Consumed as a local file dependency, not from a registry:
6
7```json
8"hyper-wallet-lib": "file:lib/hyper-wallet-lib"
9```
10
11## What `index.js` exports
12
13Two things:
14
15```js
16import { IdentityKey, storeMnemonic, loadMnemonic, deleteMnemonic, isInitialized }
17 from 'hyper-wallet-lib'
18```
19
20- **`IdentityKey`** (`identity.js`) — keet-identity-key derivation for the wallet.
21- **secure storage** (`secure-storage.js`) — `storeMnemonic`, `loadMnemonic`, `deleteMnemonic`,
22 `isInitialized`, over `keytar` (the OS keychain).
23
24Consumers import by subpath — `hyper-wallet-lib/identity`, `hyper-wallet-lib/secure-storage` —
25as well as from the index.
26
27## The rest of the tree
28
29Eighteen further `.cjs` modules ship here and are **not** re-exported from `index.js`. They are
30reachable only by direct path, and several are substantial:
31
32| | lines |
33|---|---:|
34| `wallet-storage.cjs` | 2270 |
35| `blockchain-providers.cjs` | 502 |
36| `address-validator.cjs` | 269 |
37| `rate-limiter.cjs` | 265 |
38| `config.cjs` | 237 |
39| `input-sanitizer.cjs` · `wdk-integration.cjs` · `pairing-protocol.cjs` | 210–227 |
40| `blockchain-api.cjs` · `encryption.cjs` · `amount-validator.cjs` · `utxo-manager.cjs` | 157–167 |
41| `auth.cjs` · `config-loader.cjs` · `address-manager.cjs` · `secure-storage.cjs` · `create-wallet-server.cjs` · `qr-svg.cjs` | 32–144 |
42
43⚠ Note the split: the package is ESM at the index (`identity.js`, `secure-storage.js`) and CJS
44everywhere else. `secure-storage` exists in **both** forms — `secure-storage.js` is the one the
45index exports.
46
47## Dependencies
48
49`keet-identity-key`, `keytar`.
50
51`keytar` is a native module and binds to the OS keychain, so this package does not run under
52Bare and does not run headless without a keyring.
53
54## License
55
56Not yet declared.