Documentation
NAVI Protocol TypeScript SDK
NAVI Protocol TypeScript SDK is a comprehensive DeFi SDK collection designed for the Sui blockchain. It provides complete decentralized finance functionality including token swapping, cross-chain bridging, lending, flash loans, and more.
🆙 SDK v1 vs v2
The NAVI TypeScript SDKs have moved to the Sui SDK v2 stack. What changed from the v1 (1.x) line:
| v1 (1.x) | v2 (2.x) | |
|---|---|---|
| Sui SDK | @mysten/sui@^1 |
@mysten/sui@^2 |
| Client | SuiClient (JSON-RPC only) |
SuiGrpcClient (recommended), optional SuiGraphQLClient — unified behind the ClientWithCoreApi interface |
| Module format | CommonJS | ESM |
| Runtime | — | Node.js 22+ |
Interfaces are otherwise unchanged — the one required step is constructing a Sui v2 client and passing it in. Upgrading a 1.x integration to 2.x? Read the Sui SDK v2 Migration guide first.
📦 Included Packages
@naviprotocol/astros-aggregator-sdk
DEX Aggregator SDK that aggregates liquidity from multiple decentralized exchanges to provide users with the best token swap rates.
Key Features:
- 🔄 Multi-DEX Aggregation (Aftermath, Bluefin, Cetus, DeepBook, etc.)
- 💰 Optimal Quote Algorithm
- 🚀 High-Performance Transaction Execution
@naviprotocol/astros-bridge-sdk
Cross-chain Bridge SDK that supports token transfers between different blockchain networks.
Key Features:
- 🌉 Cross-chain Bridging (Sui, Ethereum, Solana)
- 💰 Optimal Path Selection
- 📊 Real-time Quote System
@naviprotocol/lending
Lending SDK that provides complete lending functionality.
Key Features:
- 💰 Deposit, Borrow, Repay
- ⚡ Flash Loans
- 📊 Price Oracle Integration
- 🏆 Reward System
@naviprotocol/wallet-client
Comprehensive Wallet Client SDK that provides a unified interface for DeFi operations.
Key Features:
- 🔐 Transaction Signing and Execution
- 💰 Token Swapping
- 🏦 Lending Operations
- 💳 Balance Management
- 🔄 Modular Design
📚 Documentation
Contribution Process
- Fork the project
- Create a feature branch (
git checkout -b feat/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feat/amazing-feature) - Open a Pull Request
📄 License
This project is licensed under the MIT License - see the LICENSE file for details
🆘 Support
- 📖 Documentation: https://sdk.naviprotocol.io
- 🐛 Issues: GitHub Issues
- 📧 Email: [email protected]
📊 Project Status
| Package | Version | Status |
|---|---|---|
| @naviprotocol/astros-aggregator-sdk | 2.x | ✅ Sui SDK v2 |
| @naviprotocol/astros-bridge-sdk | 2.x | ✅ Sui SDK v2 |
| @naviprotocol/astros-dca-sdk | 2.x | ✅ Sui SDK v2 |
| @naviprotocol/lending | 2.x | ✅ Sui SDK v2 |
| @naviprotocol/wallet-client | 2.x | ✅ Sui SDK v2 |
Looking for the previous 1.x releases? They remain available on npm.
NAVI Protocol - Building DeFi Infrastructure for the Sui Ecosystem 🚀