For the complete documentation index, see llms.txt. This page is also available as Markdown.

@sodax/sdk

The SODAX SDK provides a comprehensive interface for interacting with the SODAX protocol, enabling cross-chain swaps, money market, cross-chain bridging, migration and staking SODA token.

Get started

Installation

# Using npm
npm install @sodax/sdk

# Using yarn
yarn add @sodax/sdk

# Using pnpm
pnpm add @sodax/sdk

Local Installation

Package can be locally installed by following this steps:

  1. Clone this repository to your local machine.

  2. cd into repository folder location.

  3. Execute pnpm install command in your CLI to install dependencies.

  4. Execute pnpm run build to build the packages.

  5. In your app repository package.json file, 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

  1. Clone repository.

  2. Make sure you have Node.js v18+ and corresponding npm installed on your system.

  3. Execute pnpm install command (from root of the project) in your CLI to install dependencies.

  4. Make code changes.

    1. Do not forget to export TS files in same folder index.ts.

    2. Always import files using .js postfix.

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 ✅

Lend / Borrow (Money Market)- Cross-chain lending and borrowing

  • 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)

Bridge- Cross-chain token bridging

  • EVM (Sonic, Ethereum, Arbitrum, Avalanche, Base, BSC, Optimism, Polygon, HyperEVM, Lightlink, Redbelly, Kaia, Hedera) ✅

  • Sui ✅

  • Stellar ✅

  • ICON ✅

  • Solana ✅

  • Injective ✅

  • NEAR ✅

  • Stacks ✅

  • Bitcoin ✅

Migration- Token migration (ICX, bnUSD, BALN)

  • 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

Staking- SODA token staking

  • 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 documentation

AI 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:

npm + AGENTS.md pointer (fallback for web chats, or when you prefer a devDependency over the CLI):

Then point your agent at node_modules/@sodax/skills/AGENTS.md. See docs/ai-integration-guide.md for all install modes and per-tool wiring.


Contributing

We welcome contributions! Please see our Contributing Guide for details.


Development Commands


License


Support

Last updated