zephyr-ts user guide
This guide explains how to build a Zephyr wallet with zephyr-ts: a web wallet, a desktop wallet with Electron, or a Node.js service. It assumes you know TypeScript; it does not assume you know monero-ts. The README has the status and the supported surface in short, and the API reference lists every exported name.
zephyr-ts is an independent project, not affiliated with or endorsed by ZephyrProtocol. This guide describes version 2.3.0-sec.2-ts.1.
| Chapter | What it covers |
|---|---|
| 1. Getting started | what the library is and is not, requirements, installing from the signed release, a first program in Node.js and in a browser |
| 2. Wallets | creating, restoring and opening wallets, saving their bytes, the password, closing, one worker per wallet, a forced stop |
| 3. Connecting to a daemon | address forms, the transport, trust, CORS and the same-origin proxy, synchronizing, heights |
| 4. Assets, accounts and balances | the four assets, amounts in atomic units, balance maps, accounts and subaddresses, labels |
| 5. History | transactions and transfers per asset, the query, paging, the pool refresh, conversions in the history |
| 6. Sending | building to inspect, preparing and relaying, what to show, fees and priorities, every relay outcome, saving |
| 7. Conversions | the six pairs, the reserve ratio, burnt and minted amounts, the pricing record and its age |
| 8. Errors | the error class, codes and diagnostics, the codes a wallet must handle |
| 9. Deploying a web wallet | the Content-Security-Policy of page and worker, zephyr.wasm, Vite, webpack, Electron, the daemon proxy |
| 10. Coming from monero-ts | what is the same, what was renamed or reshaped, what is not ported |
| 11. Known limitations | a digest of the limitations, what was proven on mainnet and what was not |
| 12. Building and verifying | verifying a release, the signed tag, manifest.json, reproducing the build, the core pins |
| API reference | every exported function, class, method, type and error code |
Statements about the core and the network in this guide come from the repository's documents (docs/LIMITATIONS.md, docs/DEPLOYMENT.md, docs/PLATFORMS.md), from the pinned sources and from test runs against mainnet in 2026-11. Where they state a limit, this guide states it too.
The examples are checked: every TypeScript block is type-checked against the release package under strict, and the blocks that need no daemon are run in Node.js with network access blocked (bin/check_guide.sh). Fragments use wallet, an open full wallet, without creating it.