> ## Documentation Index > Fetch the complete documentation index at: https://docs.sodax.com/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > SODAX is mainnet-only (no testnet chains or RPC endpoints exist) with a hub-and-spoke architecture; Sonic is the hub. SODAX is non-custodial protocol/software: it routes and settles; independent solvers on the marketplace fill — never say 'our solver', 'the SODAX solver', that SODAX trades, takes custody, or fills orders. For frontend/React integrations, prefer @sodax/dapp-kit hooks over calling @sodax/sdk directly. SDK operations — the methods that build, submit or await a transaction, and the API/quote calls — return Result ({ ok: true, value } or { ok: false, error }): check result.ok, never wrap them in try/catch or branch on error.message; discriminate on the narrow error.code union instead. Synchronous config getters (getPartnerFee, getSupportedSwapTokens, getVault, ...) return their value directly, not a Result. # Workshop: build Leverage Yield with AI > Fork the SODAX Leverage Yield starter, build a vault deposit app with AI in about an hour, and open a PR to show your solution. In about an hour you use AI (Claude Code, Codex, Cursor or similar) to add pooled vault deposits to a React app, make a real deposit into a SODAX vault, then open a pull request to show what you built. Start from the [starter repo](https://github.com/gosodax/sodax-leverage-yield-starter), and compare with the [finished app](https://sodax-leverage-yield-starter-git-solution-icon-foundation.vercel.app) (branch `solution`) at any time. **Real funds.** There is no testnet vault. Use a fresh wallet you funded yourself and small amounts (about \$5 per deposit). ## 1. Set up Takes about 15 minutes. Do it before the session if you can, because the install is large. * **Node.js 22.12 or newer** (`node -v`), with pnpm enabled: `corepack enable`. * **An AI coding assistant**, installed and signed in. * **A fresh EVM wallet** in one browser extension (MetaMask, Rabby or Hana). Not a Safe or other smart-contract wallet. * **At least \$10 of USDC plus about \$2 of ETH for gas on Base** (Arbitrum works too). The fastest option is USDC plus a little S on **Sonic**, which skips the cross-network delivery step. Fork [gosodax/sodax-leverage-yield-starter](https://github.com/gosodax/sodax-leverage-yield-starter/fork) and **untick "Copy the `main` branch only"**, so the checkpoint branches come with your fork. ```bash theme={null} git clone https://github.com//sodax-leverage-yield-starter.git cd sodax-leverage-yield-starter pnpm install pnpm dev ``` Open `http://localhost:5173`, click **Connect wallet**, and check that your address appears top right. **No API key required.** The starter and the `/v1/leverage-yield/*` API are keyless today. You can still use a [SODAX API key](/developers/how-to/api-keys): it attributes your traffic to your organisation, and it will be required once key enforcement is switched on. This is a browser app, so the key belongs behind your own backend proxy, never in the `SodaxProvider` config. See [API key good practices](/developers/how-to/api-key-good-practices). ## 2. Build it with AI The repo gives your AI no SODAX-specific help. The prompts send it to the [AI integration guide](/ai-integration-guide), and the guide tells it the rest. Paste them as-is into any AI. ### All at once (recommended) With a capable model (Claude Opus 5.5, Codex Sol 6 or similar), one prompt builds the whole app: ```text wrap theme={null} Build the SODAX Leverage Yield vault feature with a nice, polished UI: browse the vaults, deposit from any supported network and token, see my shares and withdraw. Use https://docs.sodax.com/ai-integration-guide as your guide. ``` Then check: a live deposit quote, a real \~\$5 deposit that shows your shares, every vault with live APR / TVL, and a withdraw quote. ### Milestone by milestone Use this path with a lighter model, or to watch each step come together. Only M1 points your AI at the guide, so run M2–M4 in the same session, or give a fresh session the guide link again. The app also shows the next prompt at the top of the page, with a Copy button, and links the checkpoint builds still ahead of you, so you can see the target before you build it. | Milestone | What you build | Check | Checkpoint | | - | - | - | - | | **M1** | Deposit form + live quote | 5 USDC → ≈ 4.5 lsodaSUSDS quote | [`checkpoint/m1`](https://sodax-leverage-yield-starter-git-checkpoint-m1-icon-foundation.vercel.app) | | **M2** | Execute a real \~\$5 deposit | Your new shares show | [`checkpoint/m2`](https://sodax-leverage-yield-starter-git-checkpoint-m2-icon-foundation.vercel.app) | | **M3** | Vault browser | A card per vault with live APR / TVL | [`checkpoint/m3`](https://sodax-leverage-yield-starter-git-checkpoint-m3-icon-foundation.vercel.app) | | **M4** | Withdraw | A withdraw quote (optionally, withdraw for real) | [`checkpoint/m4`](https://sodax-leverage-yield-starter-git-checkpoint-m4-icon-foundation.vercel.app) | ```text wrap theme={null} Using https://docs.sodax.com/ai-integration-guide, add a deposit form for the SODAX Leverage Yield vaults: pick a vault, a source network and token, enter an amount, and show a live quote of the vault shares I'd get and the minimum I'd accept. Don't send anything yet. Then tell me how to verify it in the browser. ``` ```text wrap theme={null} Make the deposit work: when I confirm, ask my wallet for approval if needed, submit the deposit, show each step's progress with explorer links, and show my vault shares once it fills. ``` ```text wrap theme={null} Add a vault browser: a card per vault with live APR, TVL, share price, leverage and health, plus my shares in it. Its Deposit button selects that vault in the deposit form. ``` ```text wrap theme={null} Add withdraw: from the shares I hold, quote and withdraw back to a token on a network I choose, with the same progress steps. ``` ```text wrap theme={null} Rebrand this app for using . Only change src/brand/theme.css, src/brand/brand.config.ts and the files in public/brand/. Keep contrast accessible. ``` Compare with the polished [`solution`](https://sodax-leverage-yield-starter-git-solution-icon-foundation.vercel.app) build. **Falling behind?** M2 is the one that matters. Switch to its checkpoint so you can still deposit: ```bash theme={null} git stash -u git switch checkpoint/m2 # or m1 / m3 / m4 / solution ``` If your fork has no checkpoint branches, fetch one from the starter instead: ```bash theme={null} git fetch https://github.com/gosodax/sodax-leverage-yield-starter.git checkpoint/m2 git switch -c m2 FETCH_HEAD ``` ## 3. Show your solution ```bash theme={null} git switch -c my-solution git add -A && git commit -m "feat: my leverage yield vault app" git push -u origin my-solution ``` Open a PR from your branch to [gosodax/sodax-leverage-yield-starter](https://github.com/gosodax/sodax-leverage-yield-starter/pulls). In the description, include a screenshot or short video, your deposit transaction link, the AI you used, and anything you built beyond the milestones. If your build breaks after you deposit, your shares are safe. They belong to your wallet and network, not to the app. Open the [hosted solution](https://sodax-leverage-yield-starter-git-solution-icon-foundation.vercel.app) to see them and withdraw. ## Troubleshooting | Symptom | Fix | | - | - | | `pnpm install` very slow | It is a big dependency tree. Use a phone hotspot, or pair with someone who installed at home. | | Blank page, "No QueryClient set" or two Reacts in the console | Your AI changed `vite.config.ts` or providers, or added a package. Run `git checkout vite.config.ts src/providers.tsx package.json pnpm-lock.yaml && pnpm install`. | | `pnpm check` fails in `check-versions` | Your AI ran `pnpm add @sodax/...`. Restore `package.json` and `pnpm-lock.yaml` from git, then run `pnpm install`. | | Wallet not listed | Install or unlock a browser wallet extension and reload. Only EVM wallets are supported. | | Button says "Switch to Base" | Your wallet is on another network. Click the button and approve in the wallet. | | "No route right now" | Solvers are rebalancing. The app retries automatically, or press Retry after a few seconds. | | "Amount too low" | Deposit at least about \$2. | | "Simulation reverted" | The transaction would fail: not enough balance, gas or shares. Top up gas on the source network. | | Deposit stuck on "Delivering to Sonic" or "Solver fills" | It usually takes under 2 minutes. Keep the dialog open; the transaction link shows it is on-chain. If it is still pending after 5 minutes, check your position on the [hosted solution](https://sodax-leverage-yield-starter-git-solution-icon-foundation.vercel.app) and ask a facilitator. | | "Where are my shares?" | In your SODAX hub wallet on Sonic, per source network, never in MetaMask. The [hosted solution](https://sodax-leverage-yield-starter-git-solution-icon-foundation.vercel.app) lists every vault and network. | | AI built "leverage positions" | Wrong product. Revert, and tell it: "Vaults only, not leverage positions. Read AGENTS.md." | | AI doesn't know the SODAX SDK | Send it to the [AI integration guide](/ai-integration-guide). | The full table is in the repo's [WORKSHOP.md](https://github.com/gosodax/sodax-leverage-yield-starter/blob/main/docs/WORKSHOP.md#5-troubleshooting). ## How it works * **The vaults:** pooled ERC-4626 vaults on Sonic. Each vault holds a liquid staking token, borrows against it and re-stakes up to a target LTV. That multiplies the staking yield, and the risk. * **A deposit:** you sign one intent on your network (plus an approval the first time). SODAX delivers it to Sonic, and a solver fills it by delivering vault shares to your hub wallet. * **The risks:** real funds, and leveraged positions (health factor \~1.2). The APR is variable and can go negative, the share price can fall, and the only exit is withdraw. * **The API option:** everything the SDK does is also available through the keyless REST API at `https://api.sodax.com/v1/leverage-yield/*`. The `solution` branch has a toggle that shows both. ## Go further Everything your AI needs to build with SODAX. Leverage-yield vaults as intent-based swaps. Vault deposit and withdraw over HTTP. `@sodax/sdk` deposit, withdraw, APR and position data.