Installation

Core Package

The core SDK works in any JavaScript environment — Node.js, browsers, serverless, or scripts.

pnpm add @yo-protocol/core viem
npm install @yo-protocol/core viem
yarn add @yo-protocol/core viem
Dependency
Purpose

@yo-protocol/core

Client, vault reads, actions, API client, constants

viem

Low-level EVM interaction (contract calls, encoding, transports)

circle-info

Zod included

@yo-protocol/core bundles zod internally for runtime validation of API responses. You do not need to install it separately.

React Package

For React apps using wagmi and TanStack Query:

pnpm add @yo-protocol/react @yo-protocol/core viem wagmi @tanstack/react-query
npm install @yo-protocol/react @yo-protocol/core viem wagmi @tanstack/react-query
yarn add @yo-protocol/react @yo-protocol/core viem wagmi @tanstack/react-query

Peer Dependencies

Package
Minimum version

react

18.0.0

react-dom

18.0.0

wagmi

2.0.0

viem

2.0.0

@tanstack/react-query

5.0.0

TypeScript

Both packages ship with full TypeScript declarations. TypeScript 5.0+ is recommended but not required — the SDK works fine in plain JavaScript.

Verify Installation

Next Steps