> For the complete documentation index, see [llms.txt](https://docs.yo.xyz/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.yo.xyz/integrations/integration-guides/sdk.md).

# SDK

A TypeScript SDK for the Yo yield protocol. Full ERC-4626 vault support with React hooks and multi-chain coverage.

```
npm install @yo-protocol/core viem
```

## Quick Links

* [Installation](/integrations/integration-guides/sdk/getting-started/installation.md) — Get set up with npm, pnpm, or yarn.
* [Quick Start](/integrations/integration-guides/sdk/getting-started/quickstart.md) — Build your first integration in minutes.
* [@yo-protocol/core](/integrations/integration-guides/sdk/core/overview.md) — Framework-agnostic TypeScript client.
* [@yo-protocol/react](/integrations/integration-guides/sdk/react/overview.md) — React hooks with wagmi and TanStack Query.
* [Guides](/integrations/integration-guides/sdk/guides/wagmi-setup.md) — Wagmi setup, Next.js SSR, error handling.
* [Examples](/integrations/integration-guides/sdk/examples.md) — Complete code examples and patterns.

## Features

* **ERC-4626 Vaults** — Deposit, withdraw, and redeem with full tokenized vault support.
* **Multi-Chain** — Native support for Ethereum and Base with unified APIs.
* **Type-Safe** — Zod-validated API responses and end-to-end TypeScript types.
* **Built on viem** — Low-level contract interactions via viem for reliability and performance.
* **React Hooks** — Automatic caching, refetching, and optimistic updates via TanStack Query.
* **Gateway Deposits** — Deposit any supported asset with built-in slippage protection.

## Supported Vaults

| Vault    | Underlying | Chains         |
| -------- | ---------- | -------------- |
| `yoETH`  | WETH       | Ethereum, Base |
| `yoBTC`  | cbBTC      | Base           |
| `yoUSD`  | USDC       | Base           |
| `yoEUR`  | EURC       | Base           |
| `yoGOLD` | XAUt       | Ethereum       |
| `yoUSDT` | USDT       | Ethereum       |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.yo.xyz/integrations/integration-guides/sdk.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
