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

# SDK reference

The Sailor SDK is the TypeScript library underneath the CLI: a high-level `SailorClient`, the `Agent` interface your strategy implements, EIP-712 signing helpers, kernel-capability detection, the contract ABIs, and the deployment + chain registries. It peer-depends on `viem ^2`.

* [SailorClient](/sailor/sdk/client.md) — the full client and its namespaces (`account`, `mandate`, `dispatch`, `strategy`, `session`, `fees`, `principal`).
* [The Agent interface](/sailor/sdk/agent.md) — `Agent` and `AgentContext`: what you implement and what each `tick()` receives.
* [Exports & helpers](/sailor/sdk/reference.md) — the exported functions, types, and ABIs (signing, capability detection, errors, Safe-address math, fees).

## Install & import

The SDK ships **inside** the `@sail.money/sailor` package and is exposed via a subpath export. In an agent project scaffolded by `sailor init`, it's already a dependency:

```ts
import {
  SailorClient,
  buildDispatchSignature,
  detectKernelCapabilities,
  LocalKeyring,
} from "@sail.money/sailor/sdk";
import type { Agent, AgentContext, Dispatch } from "@sail.money/sailor/sdk";
```

To add it to another project:

```bash
npm install @sail.money/sailor viem
```

The SDK is **only** distributed inside `@sail.money/sailor` — always import it from the `@sail.money/sailor/sdk` subpath. There is no separate `@sail.money/sdk` package; `@sail.money/sailor` is the one package you install.

## How to use it

There are two layers, and you'll usually use both:

1. **`SailorClient`** — a batteries-included client with namespaces for accounts, mandates, dispatch, a swap strategy, sessions, fees, and principal tracking. Read-only methods need only an RPC; state-changing methods take a signer (the manager `LocalKeyring`). Start here. See [SailorClient](/sailor/sdk/client.md).
2. **The `Agent` interface** — when you run under `sailor run`, you implement `Agent.tick(ctx)` and the runner provides an `AgentContext` (with a ready `SailorClient`, a viem `publicClient`, the manager keyring, balance/allowance helpers, and a logger). See [The Agent interface](/sailor/sdk/agent.md).

Below those sit the primitives — `buildDispatchSignature` (self-detecting EIP-712 dispatch signer), `detectKernelCapabilities` (reads the on-chain dispatch model so you never hardcode it), `LocalKeyring` (the encrypted manager key), the kernel/factory/governance ABIs, and the deployment + chain registries. See [Exports & helpers](/sailor/sdk/reference.md).

{% hint style="info" %}
Always sign dispatches with `buildDispatchSignature` and detect the model with `detectKernelCapabilities` — never hand-roll the EIP-712 struct or hardcode conjunctive vs. selective. The builder reads the kernel's on-chain typehash and selects the correct struct, so you cannot sign the wrong model.
{% endhint %}


---

# 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, and the optional `goal` query parameter:

```
GET https://docs.sail.money/sailor/sdk.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.