SDK — navio-sdk¶
TypeScript SDK for wallet management, blockchain sync, and transaction construction. Works in Node.js and in the browser.
- Repository: nav-io/navio-sdk
- Package:
navio-sdkon npm - License: MIT
What it does¶
- HD wallet creation and restore (seed, mnemonic, audit key).
- Password-based wallet encryption (Argon2id + AES-256-GCM).
- Blockchain synchronisation via either Electrum or direct P2P.
- Automatic BLSCT output detection with view-tag optimisation.
- Amount / memo recovery.
- Confidential transaction construction — NAV, tokens, NFTs.
- Transaction aggregation for intra-chain swaps / CoinJoin.
- Cross-platform SQLite storage (sql.js in browsers, better-sqlite3 in Node).
- Reorg detection and recovery.
Documentation¶
| Page | Topic |
|---|---|
| Quickstart | Install, create a wallet, sync, check balance |
| NavioClient | The main entry point — config, lifecycle, accessors |
| Wallet management | KeyManager, sub-addresses, mnemonic, audit key |
| Synchronization | Electrum vs P2P, background sync, progress callbacks, reorgs |
| Balances & UTXOs | NAV and asset balances, unspent output queries |
| Sending transactions | NAV sends, token sends, NFT sends, aggregation |
| Tokens & NFTs | Collection creation, minting, NFT metadata |
| Database & storage | Schema, adapters, migration |
| Encryption | Wallet password protection, encrypted backups |
| Examples | End-to-end snippets |
| API reference | Auto-generated TypeDoc reference |
API reference auto-generation
The api/ tree is regenerated nightly from navio-sdk's source by the docs build pipeline — typedoc --plugin typedoc-plugin-markdown. The handwritten pages above give context and examples; the API reference is the source of truth for types and signatures.