> ## Documentation Index
> Fetch the complete documentation index at: https://docs.privacyboost.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Portal deposits

# Portal Deposit Addresses

Give a user a reusable, public, exchange-style deposit address that credits into
their shielded balance. See
[Portal Deposit Addresses](/sdk/concepts/portal-deposits) for the concept and
trust model.

<Warning>
  Preview feature — pending external audit, and enabled per deployment. The React
  SDK does **not** yet expose dedicated portal hooks; use the underlying SDK via
  `usePrivacyBoost()`. Dedicated hooks are planned.
</Warning>

## Accessing the portal API

`usePrivacyBoost()` returns the underlying TypeScript SDK instance, which exposes
the high-level `sdk.portal` resource (`create`, `list`, `deposits`, `status`,
`sweep`, `reclaim`, `withdraw`, `delegateAddress`). The full method surface,
types, and launch limitations are documented in the
[TypeScript Portal Deposits guide](/sdk/typescript/guides/portal-deposits).

```tsx theme={null}
import { usePrivacyBoost } from '@sunnyside-io/privacy-boost-react';

function CreatePortalButton() {
  const sdk = usePrivacyBoost();

  const createPortal = async () => {
    if (!sdk) return;
    if (!sdk.portal.delegateAddress()) {
      throw new Error('This server does not support portal deposits.');
    }
    const portal = await sdk.portal.create();
    console.log('Deposit address:', portal.address); // share this publicly
  };

  return <button onClick={createPortal}>Create portal</button>;
}
```

List portals and deposits the same way — `sdk.portal.list()`,
`sdk.portal.deposits(address)`, `sdk.portal.status(address)` — from a hook or
handler. See the [TypeScript guide](/sdk/typescript/guides/portal-deposits) for
every method and the launch limitations.

## Next steps

* [TypeScript Portal Deposits guide](/sdk/typescript/guides/portal-deposits) — full API
* [Portal Deposits concept](/sdk/concepts/portal-deposits)
* [`usePrivacyBoost()`](/sdk/react/api-reference#useprivacyboost) — direct SDK access