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

# Covenant SDK

`@covenant/sdk` is the TypeScript library the Serein app is built on. Everything the website can do, the SDK can do — the site has no private endpoint of its own.

It has its own repository: [dun999/covenant-sdk](https://github.com/dun999/covenant-sdk).

## What it handles

* Creating vaults and reading their state.
* Encrypting rules and building the fingerprint the vault stores.
* Requesting authorization through the on-chain instruction sender, then waiting for the answer.
* Building WebAuthn passkey challenges and packaging the proofs.
* Executing payments, withdrawals, redemptions, and vault closure.
* Lock, unlock, recovery, and the timelocked changes.
* Reading FAssets direct-mint settings and building the memo.

## Setting it up

```ts
import { PrivateVaultClient } from "@covenant/sdk";

const client = new PrivateVaultClient({
  publicClient,           // viem PublicClient on Coston2
  walletClient,           // viem WalletClient
  factory: VAULT_FACTORY_ADDRESS,
  instructionSender: INSTRUCTION_SENDER_ADDRESS,
  proxyUrl: FCC_PROXY_URL,
});
```

## A payment

Authorization and execution are separate calls, so you can show the user what was approved before spending it:

```ts
const authorization = await client.authorizeSpend({
  vault,
  to: recipient,
  amount: parseFxrp("1.5"),
  passkey,                // only when above the step-up threshold
});

const hash = await client.executeSpend({ vault, to: recipient, amount, authorization });
```

`authorizeSpend` sends the on-chain request and waits for the signed answer. `executeSpend` submits it. Between them you hold a permission slip valid for five minutes.

## Reading state

```ts
const state = await client.getState(vault);
// status, balance, nonce, policyVersion, owner, guardian, tee,
// xrplPayout, timelockSeconds, recoveryAt, unlockAt
```

`recoveryAt` and `unlockAt` are Unix seconds, or `0` when nothing is pending — use them to gate the recovery and unlock controls.

## Money out

```ts
await client.withdraw({ vault, amount, passkey });     // to the owner wallet
await client.redeemToXrp({ vault, amount, passkey });  // to the saved XRPL address
await client.destroyVault({ vault, passkey });         // close, return everything
```

Each has `authorize*` and `execute*` halves if you want the two-step flow.

## Lock and recovery

```ts
await client.lock(vault);
await client.scheduleUnlock(vault);
await client.confirmUnlock(vault);      // after the timelock

await client.scheduleRecovery(vault);
await client.cancelRecovery(vault);
await client.executeRecovery(vault);    // after the timelock
```

## Handling errors

Three error types, and they mean different things:

```ts
import { PolicyViolation, FccInfrastructureError, CovenantError } from "@covenant/sdk";
```

* **`PolicyViolation`** — the system worked and said no. `reason` explains which rule. Show it; do not retry unchanged.
* **`FccInfrastructureError`** — the request was accepted on-chain but no decision came back. Carries `instructionTransaction` as evidence. Safe to retry.
* **`CovenantError`** — everything else.

The distinction matters: a refusal is not an outage, and telling users to retry a refusal just wastes their gas.

## Building

```bash
npm install
npm run build
npm test
```


---

# 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.serein.finance/reference/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.