> For the complete documentation index, see [llms.txt](https://privily.gitbook.io/privily-doc/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://privily.gitbook.io/privily-doc/developer/readme.md).

# README

Privily is a privacy-first payment appchain that connects 20+ blockchains behind a single, self-custodial account. The same operations you use in the Privily app (deposit, trade, send, request, pay) are available programmatically through two integration surfaces:

| Surface            | For                                                                           | Package                                                          |
| ------------------ | ----------------------------------------------------------------------------- | ---------------------------------------------------------------- |
| **TypeScript SDK** | Apps, dApps, and backends that embed Privily operations                       | [`privily-sdk`](https://www.npmjs.com/package/privily-sdk)       |
| **MCP Plugin**     | AI agents (Claude Code and any MCP client) that move money on a user's behalf | [`privily-plugin`](https://www.npmjs.com/package/privily-plugin) |

Both build on the same foundation: a self-custodial, STRK-based smart account on the Privily app-chain, authenticated with the user's own key. Privily never holds your keys or your users' keys.

> **Self-custody notice.** You and your users are fully responsible for storing and backing up key material. Privily never has access to private keys and cannot recover lost credentials or funds.

#### What you can build

* **Cross-chain deposits & withdrawals**: bridge assets in and out of Privily across EVM, Solana, Starknet, and Tron. (Bitcoin is supported for sign-in only, not for moving funds.)
* **Private transfers & payments**: send to any address on any chain. Every transfer is private by default, with an optional anonymity flag for extra counterparty masking.
* **Swaps**: convert one token into another across chains, on eligible non-Privily routes.
* **Disperse**: one-to-many payouts in a single operation (payroll, airdrops, splits).
* **Delayed execution**: schedule an operation to run at a future time.
* **Payment requests**: generate directed or open (public) payment links, and settle them on-chain, cross-chain, with or without a Privily account.
* **Reads**: balances, prices, assets, full paginated history, and saved addresses.

#### Two ways to integrate

**1. TypeScript SDK (`privily-sdk`)**

A fully typed SDK for the browser or Node. Derive a Privily key from a wallet signature, deploy a smart account once, then call operations through an auto-authenticating RPC wrapper.

Start here → **Getting Started**

* **Accounts & Authentication**: keys, deployment, sessions, recovery
* **Operations**: bridge, send, swap, disperse, payment requests, reads
* **API Reference**: every method, type, and constant
* **Recipes**: copy-paste examples for the common flows

**2. MCP Plugin (`privily-plugin`)**

A Model Context Protocol server (and Claude Code Skill) that lets an AI agent operate a Privily account safely: the key never leaves the user's machine, and every action passes a local capability policy and confirmation gates.

→ **MCP Plugin (AI Agents)**

#### Network endpoints

| Purpose                                        | URL                          | Used by                          |
| ---------------------------------------------- | ---------------------------- | -------------------------------- |
| RPC Wrapper (keygen, deploy, auth, operations) | `https://rpc.privily.fi`     | `RPCWrapperV0`                   |
| Units app-chain (on-chain execution)           | `https://privily.karnot.xyz` | `UnitsProvider` / `UnitsAccount` |

#### Supported chains & tokens

EVM (Ethereum, Base, Arbitrum, Optimism, Polygon, BSC, Avalanche, zkSync, Linea, and more), Solana, Starknet, and Tron. Bitcoin (legacy + Taproot) is sign-in only. Movable tokens are **ETH, USDC, and USDT**. See [**Supported Chains & Tokens**](/privily-doc/technology/supported-chains-and-tokens.md).

***

> The SDK is MIT-licensed and open source at [github.com/PrivilyFi/sdk](https://github.com/PrivilyFi/sdk).
