# SilentSwap

> Integrate private and public cross-chain swaps with the SilentSwap TypeScript SDK.

## Docs

- [For AI agents](/agents): Use the machine-readable artifacts instead of scraping rendered HTML:
- [Getting started](/getting-started): SilentSwap V3 exposes one small, typed flow: quote, show the user what will happen, place,
and track.
- [How it works](/how-it-works): SilentSwap separates what the user reviews from what the wallet signs.
- [React hooks — coming soon](/react): <code>@silentswap/react</code> 2.x will provide hooks over the SDK's canonical client. It is
not published with the 2.0.0 SDK release.
- [Migrate from SilentSwap V2](/migration/v2): <code>@silentswap/sdk@2.0.0</code> keeps the package name and familiar lifecycle names, but
removes the V2 authentication and authorization ceremony. Existing V2 orders are not
convertible: let them finish under your pinned 0.x integration before cutting over.
- [Complete Simple Bridge example](/public-swap/complete-example)
- [Simple Bridge](/public-swap): Simple Bridge is the non-private mode of the same client. Set <code>privacy: false</code> and
use the same <code>quote → placeOrder → trackOrderViaWebSocket</code> lifecycle. The SDK
normalizes bridge states into <code>FULFILLING</code>, <code>COMPLETED</code>,
<code>FAILED</code>, or <code>UNKNOWN</code>.
- [Simple Bridge usage](/public-swap/usage): Simple Bridge is exact-input and accepts exactly one output. Integrator fees are not currently
available for public routes.
- [Assets and chains](/reference/assets-and-chains): Install the registries directly when an application needs picker or routing metadata without
the full SDK.
- [Client API](/reference/client): The class <code>SilentSwap</code>, factory <code>createSilentSwapClient</code>, and type alias
<code>SilentSwapClient</code> refer to the same canonical client surface.
- [Complete private-swap example](/sdk/complete-example): This example shows the full EVM path. The UI must render the quote before calling
<code>placeOrder</code>.
- [Errors](/sdk/errors): The SDK throws errors. It does not return V2-style <code>\[error, value]</code> tuples.
- [Installation](/sdk/installation): Install the SDK and <code>viem</code> together:
- [Integrator fees](/sdk/integrator-fees): Set <code>integratorFee</code> in USDC base units. A positive fee requires
<code>integratorAddress</code>.
- [Order statuses](/sdk/order-statuses): The main path is:
- [SDK quickstart](/sdk/quickstart): Create a viem wallet client for the active account, then bind SilentSwap to the gateway chain.
- [Quotes](/sdk/quotes): <code>quote</code> accepts an <code>outputs\[]</code> array. Private wallet-funded requests allow
1–20 outputs; address-funded and Simple Bridge requests require exactly one.
- [Refunds](/sdk/refunds): <code>executeRefund</code> is for private EVM-origin orders whose gateway refund window has opened. It
fetches fresh order state, validates preconditions, dry-runs the contract call, broadcasts,
and waits for the receipt.
- [Split payouts](/sdk/splits): Put 1–20 entries in <code>outputs</code>. Each <code>amount</code> is the USDC payout in
base units. The user funds the sum of payouts plus service and integrator fees.
- [Tracking](/sdk/tracking): <code>trackOrderViaWebSocket</code> accepts a serializable reference and emits the current state
plus later status or transaction-hash changes. The compatibility name is stable; private mode
uses browser SSE with a polling backstop, while Simple Bridge uses status polling.
- [Deposits](/sdk/deposits): Inspect the quoted deposit shape before opening a wallet.
- [Solana deposits](/sdk/deposits/solana): A Solana-source quote has <code>txKind: 'svm'</code> and a base64
<code>solanaTx</code>. The API builds the versioned transaction; the active Solana wallet
reviews and signs it.
- [TON and TRON deposits](/sdk/deposits/ton-tron): Account-chain quotes are signed outside viem.
- [Bitcoin and Litecoin deposits](/sdk/deposits/utxo): SilentSwap supports two UTXO deposit shapes.