Get started
Installation
Local Installation
Package can be locally installed by following this steps:- Clone this repository to your local machine.
cdinto repository folder location.- Execute
pnpm installcommand in your CLI to install dependencies. - Execute
pnpm run buildto build the packages. - In your app repository
package.jsonfile, define dependency named"@sodax/sdk"under"dependencies". Instead of version define absolute path to your SDK repository"file:<sdk-repository-path>"(e.g."file:/Users/dev/.../operation-liquidity-layer/packages/sdk"). Full example:"@sodax/sdk": "file:/Users/dev/operation-liquidity-layer/sdk-new/packages/sdk".
Local Development
How to setup local development- Clone repository.
- Make sure you have Node.js v18+ and corresponding npm installed on your system.
- Execute
pnpm installcommand (from root of the project) in your CLI to install dependencies. - Make code changes.
- Do not forget to export TS files in same folder
index.ts. - Always import files using
.jspostfix.
- Do not forget to export TS files in same folder
Functional Modules inside the SDK
Swaps (Solver) - Cross-chain intent-based swaps- EVM (Sonic, Ethereum, Arbitrum, Avalanche, Base, BSC, Optimism, Polygon, HyperEVM, Lightlink, Redbelly, Kaia, Hedera) ✅
- Sui ✅
- Stellar ✅
- ICON ✅
- Solana ✅
- Injective ✅
- NEAR ✅
- Stacks ✅
- Bitcoin ✅
- EVM (Sonic, Ethereum, Arbitrum, Avalanche, Base, BSC, Optimism, Polygon, HyperEVM, Lightlink, Redbelly, Kaia, Hedera) ✅
- Sui ✅
- Stellar ✅
- ICON ✅ (bnUSD only)
- Solana ✅
- Injective ✅
- NEAR ✅
- Stacks ✅
- Bitcoin ✅ (BTC only)
- EVM (Sonic, Ethereum, Arbitrum, Avalanche, Base, BSC, Optimism, Polygon, HyperEVM, Lightlink, Redbelly, Kaia, Hedera) ✅
- Sui ✅
- Stellar ✅
- ICON ✅
- Solana ✅
- Injective ✅
- NEAR ✅
- Stacks ✅
- Bitcoin ✅
- ICX / wICX → SODA: source chain ICON only
- BALN → SODA: source chain ICON only
- bnUSD: between legacy chains (ICON, Sui, Stellar) and the new bnUSD on any other supported chain
- EVM (Sonic, Ethereum, Arbitrum, Avalanche, Base, BSC, Optimism, Polygon, HyperEVM, Lightlink, Redbelly, Kaia, Hedera) ✅
- Sui ✅
- Stellar ✅
- Solana ✅
- Injective ✅
- NEAR ✅
- Stacks ✅
Tooling Modules inside the SDK
Backend API- Solver API endpoint documentation Intent Relay API- Relayer API endpoint documentationAI agent docs
AI-readable docs for@sodax/sdk (and the other @sodax/* packages) are shipped via @sodax/skills — a separate npm package bundling Claude-Code SKILL.md files and a long-form knowledge tree.
Recommended: skills CLI — from your project root:
AGENTS.md pointer (fallback for web chats, or when you prefer a devDependency over the CLI):
node_modules/@sodax/skills/AGENTS.md. See docs/ai-integration-guide.md for all install modes and per-tool wiring.