Overview
Typed TypeScript access to Breeze reads and transaction execution
@solana/breeze-sdk is the typed TypeScript client for Breeze. Use it to read
strategy, balance, and yield data or to build deposit, withdrawal, and
close-account flows.
The high-level BreezeSDK class covers the public API, while ApiClient and the
individual endpoint functions remain available for advanced use. The root
package has no runtime dependencies, ships ESM and CommonJS builds, and
normalizes request failures as BreezeApiError.
For transaction execution on a trusted backend, the optional
@solana/breeze-sdk/kit entry exposes a composable breeze() Solana Kit plugin.
It derives identity and payer addresses from server-managed signers, fetches and
validates Breeze instructions, and delegates planning and execution to the
installed Kit capabilities. Deposit and withdrawal planning resolves the required
address lookup table and builds a version-0 transaction. Close-account planning
skips lookup-table resolution and uses the planner's selected transaction version.
The Kit plugin authenticates directly with your Breeze API key. Install it only in a trusted server or custody environment where both the key and signer are protected. For a browser-connected wallet, create the serialized transaction on your backend and return only that transaction to the browser for review and signing.