> For AI agents: the documentation index is at https://sdk.nimbusprivacy.xyz/llms.txt, and every page is available as Markdown at its URL with .md appended. # The example app (/resources/example-app) `apps/nimbus-example` is a small Next.js App Router app built on the SDK. It runs on mainnet with real funds. It covers what every app needs: connect, register, deposit, Private Send, withdraw, balances, history and recovery. Each file is short and maps onto a page of these docs. Read them side by side. ## Run it The app lives in the Nimbus monorepo and uses the SDK from source. Build the SDK's WebAssembly and files first, then start the app. ### Build the SDK and its files From the repository root, install, then build the three WebAssembly modules the SDK ships: ```bash pnpm install just build-nimbus-primitives-wasm just build-umbra-prover-wasm just build-witness-graph-wasm ``` Then build the SDK, and gather its files into its `assets/` folder: ```bash pnpm --filter "@umbra/nimbus-example^..." run build pnpm --filter @umbra/nimbus-solana-web run build:assets ``` ### Set the environment Copy `.env.example` to `.env.local` in `apps/nimbus-example`. Both settings are optional: | Variable | What it does | | ---------------------------------- | ------------------------------------------------------------------------------------------------------------------ | | `NEXT_PUBLIC_NIMBUS_RPC` | A Solana RPC to use in place of the preset's public one. | | `NEXT_PUBLIC_NIMBUS_GATEWAY_TOKEN` | The gateway token every session sends. Without it, accounts open and read, and every payment fails `unauthorized`. | Next.js writes both into the page, so every visitor can read the token. To get a token, email [dev@umbraprivacy.com](mailto:dev@umbraprivacy.com) or reach out to any Umbra team member. ### Copy the files and start ```bash cd apps/nimbus-example pnpm assets pnpm dev ``` `pnpm assets` runs `nimbus-solana-web copy-assets public/nimbus`. `next.config.mjs` sends the two cross-origin isolation headers with every route. Its other scripts are `pnpm build` and `pnpm start` for a production build, and `pnpm typecheck`. `pnpm tokens` rewrites the token list, as the table below explains. ## Where each feature lives | Feature | Files | Docs | | ------------------------------------------------------ | --------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | | Loading the SDK once, in the browser | `components/app-provider.tsx`, `lib/nimbus/load.ts` | [Use it with React](https://sdk.nimbusprivacy.xyz/getting-started/react) | | Listing wallets and connecting one | `components/connect-card.tsx` | [Wallets](https://sdk.nimbusprivacy.xyz/helpers/wallets) | | Opening a session, and where its sign-in is kept | `lib/nimbus/session.ts`, `components/connect-card.tsx` | [Sessions](https://sdk.nimbusprivacy.xyz/helpers/sessions) | | Registering before the first deposit | `components/account-gate.tsx`, `components/register-card.tsx`, `lib/nimbus/register.ts` | [Registration](https://sdk.nimbusprivacy.xyz/registration) | | Deposit, withdraw and Private Send on one card | `components/action-card.tsx`, `components/flow-form.tsx` | [Deposit](https://sdk.nimbusprivacy.xyz/deposit), [Withdraw](https://sdk.nimbusprivacy.xyz/withdraw), [Transfer](https://sdk.nimbusprivacy.xyz/transfer) | | Each payment, in one small function | `lib/nimbus/deposit.ts`, `lib/nimbus/withdraw.ts`, `lib/nimbus/private-send.ts` | [The function template](https://sdk.nimbusprivacy.xyz/api-design/function-template) | | One description of a withdrawal or Private Send result | `lib/nimbus/spend.ts` | [Results and errors](https://sdk.nimbusprivacy.xyz/api-design/results-and-errors) | | A message for each progress stage | `lib/progress.ts`, `components/keep-tab-open.tsx` | [Show progress](https://sdk.nimbusprivacy.xyz/api-design/progress) | | Syncing, and balances grouped per token | `components/use-account.ts`, `lib/nimbus/account.ts` | [Balances](https://sdk.nimbusprivacy.xyz/helpers/balances), [Sync](https://sdk.nimbusprivacy.xyz/helpers/sync) | | Reserved funds with a Release button | `components/balances-panel.tsx`, `lib/nimbus/account.ts` | [Reserved funds](https://sdk.nimbusprivacy.xyz/helpers/reserved-funds) | | History, ten entries a page | `components/activity-list.tsx`, `lib/nimbus/history.ts`, `lib/activity.ts` | [History](https://sdk.nimbusprivacy.xyz/helpers/history) | | A pending deposit, and a refund of a stuck one | `components/recovery-card.tsx`, `lib/nimbus/recovery.ts` | [If the deposit is still pending](https://sdk.nimbusprivacy.xyz/deposit/pending) | | Token names and logos | `lib/tokens.ts`, `scripts/fetch-tokens.ts` | [Tokens](https://sdk.nimbusprivacy.xyz/helpers/tokens) | The token logos are saved under `public/tokens/`, because a cross-origin isolated page shows images from another site only when that site allows it. `pnpm tokens` fetches them again when the preset's tokens change. ## What it leaves out The example keeps to the basics. It runs only on mainnet, and asks each service directly rather than through the coordinator. It does not sync in the background. [Use it with React](https://sdk.nimbusprivacy.xyz/getting-started/react#sync-in-the-background) shows how to add that. ## Next - [Use it with React](https://sdk.nimbusprivacy.xyz/getting-started/react): The patterns the example is built from. - [Quickstart](https://sdk.nimbusprivacy.xyz/getting-started/quickstart): The same journey, in one file. Last updated 21 October 2026