Overcast SDK

Integrate with an AI agent

Copy prompt

Show the prompt

I want to integrate the Overcast options protocol into my project using the Overcast TypeScript SDK.

Read the docs before writing code — fetch these pages, don't guess the API:
- https://docs.overcast.xyz/ — overview and package map
- https://docs.overcast.xyz/getting-started — install, config, first calls
- https://docs.overcast.xyz/guides/overcast-app — the OvercastApp facade
- https://docs.overcast.xyz/guides/rfq-lifecycle — offers, quotes, options
- https://docs.overcast.xyz/guides/settlement-methods — Physical, Intrinsic, Access
- https://docs.overcast.xyz/guides/rfq-quoter — a complete auto-quoting loop
- https://docs.overcast.xyz/api/core — generated API reference

What Overcast is: a multi-chain options protocol. Makers post collateral offers, takers post settlement offers, and matching the two mints a market option on-chain. Price discovery happens off-chain over a realtime RFQ (request-for-quote) channel; settlement happens on-chain.

How to integrate:

1. Install core plus the client for my chain:
   npm install @overcast-xyz/core @overcast-xyz/solana-client
   (use @overcast-xyz/evm-client instead for EVM chains)

2. An Overcast API key is required, even for read-only use — the backend returns 401 and the RFQ socket refuses to connect without it. Read it from OVERCAST_API_KEY; never hardcode it.

3. Build the single entry point, OvercastApp:

   import { OvercastApp } from "@overcast-xyz/core";
   import { solana } from "@overcast-xyz/solana-client";

   const app = await OvercastApp.create({
     factory: solana.withConfig({
       rpcUrl: process.env.SOLANA_RPC_URL,
       privateKey: process.env.SOLANA_PRIVATE_KEY, // JSON byte array string, or number[]
       apiKey: process.env.OVERCAST_API_KEY,
     }),
   });

4. Everything hangs off that one object: app.chain (on-chain reads and writes), app.api (curated backend REST, paginated), app.rfq (realtime RFQ socket, connects lazily), app.assets() (curated asset metadata), app.owner (my wallet).

Conventions to respect:
- Amounts are bigint in native units. Convert with parseUnits / formatUnits / toNativeAmount / toDisplayAmount from @overcast-xyz/core.
- IDs are Bytes32 — 0x-prefixed lowercase hex. Offers and options are content-addressed via getId(), which is async.
- Token parameters take a canonical Bytes32 slot from (await app.assets()).slot(asset), not a mint or token address.
- All protocol payments flow through my on-chain escrow account, so deposit with app.chain.deposit before trading.
- Two signers exist: the chain signer signs transactions, the protocol signer (Ed25519ProtocolSigner) signs offer IDs for the RFQ flow. Both derive from privateKey by default.
- Node.js >= 20.

Important things to keep in mind:
- First you have to deposit into the escrow before you can do anything with the protocol.
- You have to explicitly always authorize your singing keys with `app.chain.setAuthorizedKey(app.owner)` bevore you can use the RFQ as a taker/maker.

Before you write anything, ask me: which chain, whether I'm quoting as a MAKER or taking as a TAKER, and which settlement method I want. Then implement it against the real SDK — no mock data and no invented methods. If something isn't in the docs, say so instead of guessing.

Overcast is an options protocol that works on multiple chains. Makers post collateral offers, takers post settlement offers, and matching the two mints a market option on-chain. Price discovery happens off-chain over a realtime RFQ (request-for-quote) channel; settlement happens on-chain.

This site documents the TypeScript SDK and the overcast CLI. The design goal of both is simplicity: one facade object (OvercastApp) gives you everything — on-chain reads and writes, the curated backend API, and the RFQ socket — and a working RFQ quoter is a few dozen lines of code.

Packages

Package	Purpose
@overcast-xyz/core	Chain-agnostic domain core: data model, canonical IDs, RFQ client, protocol interfaces.
@overcast-xyz/solana-client	The Solana implementation: factory, writer/reader, indexer, settlement layers.
@overcast-xyz/evm-client	The EVM implementation: factory, writer/reader, indexer, settlement layers.
@overcast-xyz/cli	The overcast CLI: deposits, withdrawals, option lifecycle, and the RFQ engine.
@overcast-xyz/postgres-store	Postgres implementation of the persistent storage interfaces (backend infrastructure).
@overcast-xyz/kms-signer-aws	RawSigner implementation backed by AWS KMS (Ed25519).
@overcast-xyz/kms-signer-gcp	RawSigner implementation backed by GCP Cloud KMS (Ed25519).

Where to start

• Getting started — install the SDK, build an OvercastApp, and make your first calls.
• The RFQ lifecycle — how offers, quotes, and options relate; the concepts behind everything else.
• Settlement Methods — Physical, Intrinsic, and Access capital profiles; how they map to TradFi settlement and on-chain layers.
• Build an RFQ quoter — auto-quote incoming RFQs with the raw SDK, end to end.
• CLI — do all of the above from the terminal, including a built-in Black-Scholes quoter.
• API Reference — generated straight from the source: @overcast-xyz/core, @overcast-xyz/solana-client, and @overcast-xyz/evm-client.

⚠️ Early Development: The SDK and CLI are under heavy development. Packages are published to npm, but interfaces may change without notice.