> For the complete documentation index, see [llms.txt](https://docs.osero.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.osero.org/osero-sdk/getting-started/installation.md).

# Installation

## Package manager

Install `@osero/client` and its required peer dependency, `viem`:

{% tabs %}
{% tab title="pnpm (recommended)" %}

```bash
pnpm add @osero/client viem
```

{% endtab %}

{% tab title="npm" %}

```bash
npm install @osero/client viem
```

{% endtab %}

{% tab title="yarn" %}

```bash
yarn add @osero/client viem
```

{% endtab %}
{% endtabs %}

`viem` is a **required** peer dependency. The SDK uses it internally to encode calldata and build public clients, so it must be present even if your application uses the ethers adapter for broadcasting.

## Optional: ethers v6 adapter

If you prefer ethers v6 for signing and broadcasting, install it alongside viem:

```bash
pnpm add ethers
```

The ethers adapter is imported from `@osero/client/ethers` and is completely optional. If your project already uses viem, you do not need ethers at all.

## Optional: Privy server-wallet adapter

If you broadcast through [Privy server wallets](https://docs.privy.io/wallets/overview), install Privy's Node SDK alongside viem:

```bash
pnpm add @privy-io/node
```

The Privy adapter is imported from `@osero/client/privy` and is completely optional. The SDK declares `@privy-io/node` (`^0.19.0`) as an optional peer dependency — install it only if you use this adapter.

## TypeScript configuration

`@osero/client` is authored in strict TypeScript and ships full type declarations. No additional `@types` packages are required.

The package is distributed as ESM. Ensure your `tsconfig.json` is configured for module resolution compatible with ESM packages:

```json
{
  "compilerOptions": {
    "module": "NodeNext",
    "moduleResolution": "NodeNext",
    "target": "ES2022"
  }
}
```

Or with `bundler` resolution (for projects using Vite, esbuild, webpack, etc.):

```json
{
  "compilerOptions": {
    "module": "ESNext",
    "moduleResolution": "bundler"
  }
}
```

## Verifying the installation

Once installed, verify that the SDK resolves correctly by importing the client and checking the list of supported chain IDs:

```typescript
import { SUPPORTED_CHAIN_IDS } from '@osero/client';

console.log(SUPPORTED_CHAIN_IDS);
// [1, 10, 130, 8453, 42161]
```

## Next steps

* [Quick Start](/osero-sdk/getting-started/quick-start.md) — mint your first sUSDS in minutes
* [Configuration](/osero-sdk/reference/configuration.md) — configure custom RPC transports for production


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.osero.org/osero-sdk/getting-started/installation.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.