Portal Deposit Addresses

Give a user a reusable, public, exchange-style deposit address. Anyone can fund it with standard ERC-20 transfers, and the funds are credited into the owner’s shielded balance without revealing which account was credited. See Portal Deposit Addresses for the concept and trust model. React Native exposes the supported portal lifecycle as methods on your PrivacyBoost instance. createPortal derives the portal EOA from the account seed and keeps the key inside core.

Lifecycle at a glance

Check support — sdk.portalDelegateAddress().
Create — sdk.createPortal() derives E, gaslessly delegates and registers it, then publishes discovery.
Share — senders fund the returned portal.address with ordinary ERC-20.
Sweep / credit — a keeper normally runs this, or you can call sdk.sweepPortal(...) as a backstop.
Recover — use sdk.reclaimPortalDeposit(...) for uncredited swept deposits, then sdk.withdrawPortal(...) if raw funds are resting at E.

Check support

const delegate = sdk.portalDelegateAddress();
if (!delegate) {
  throw new Error('This server does not support portal deposits.');
}

Create a portal

const portal = await sdk.createPortal(undefined); // or sdk.createPortal(0)

console.log(portal.address); // share this public deposit address
console.log(portal.index);   // seed-derivation index for recovery actions
console.log(portal.bindH);   // public on-chain binding

createPortal is resumable. If the same seed-derived portal is already created, the method returns it as a no-op. Passing an explicit index recreates that deterministic portal; omitting it picks the next free index.

List portals and deposits

Each response contains items and an optional nextCursor. Pass the cursor back unchanged to fetch the next page, stopping when it is absent.

const portals = await sdk.listPortalsPage(undefined, 50);
const deposits = await sdk.listPortalDepositsPage(portal.address, undefined, 50);
const status = await sdk.getPortalStatus(portal.address);

console.log(portals.items.length);

Sweep and reclaim

Sweeping is permissionless, and deployments normally run a keeper. If you need to trigger it yourself:

const txHash = await sdk.sweepPortal(portal.address, tokenId);

If a swept deposit remains uncredited past the cancel delay:

const txHash = await sdk.reclaimPortalDeposit(portalDepositId);

reclaimPortalDeposit returns funds to the portal address E, not to the caller. To move raw funds from E, build a signed transaction and broadcast it yourself:

const rawTx = sdk.withdrawPortal(
  portal.index,
  tokenAddress,
  destination,
  amountWei,
  nonce,
  gasLimit,
  maxFeePerGasWei,
  maxPriorityFeePerGasWei,
);

nonce and gasLimit are bigint values in the React Native binding. E must hold native gas for the withdrawal transaction.

Low-level escape hatches

The package still exports two low-level helpers for custodial integrations that manage their own portal EOA key:

import { generatePortalEoa, encodePortalWithdraw } from '@sunnyside-io/privacy-boost-react-native';

const eoa = generatePortalEoa(); // privateKey is SECRET
const calldata = encodePortalWithdraw(tokenAddress, destination, amountWei);

The seed-derived createPortal flow does not use or expose eoa.privateKey.

Types

interface Portal {
  address: string;
  index: number;
  bindH: string;
}

interface PortalInfo {
  address: string;
  index?: number;
  status: PortalStatus;
}

interface PortalStatus {
  registered: boolean;
  delegated: boolean;
  published: boolean;
}

enum PortalDepositState {
  PendingSweep = 'PendingSweep',
  Credited = 'Credited',
  Cancellable = 'Cancellable',
  Cancelled = 'Cancelled',
  Unknown = 'Unknown',
}

interface PortalDeposit {
  portalDepositId: string;
  portal: string;
  tokenId: number;
  grossAmount: string;
  netAmount: string;
  state: PortalDepositState;
  requestBlock: bigint;
  cancellableAtBlock: bigint;
}

Quickstart

Setup

SDKs

Portal deposits

Portal Deposit Addresses

Lifecycle at a glance

Check support

Create a portal

List portals and deposits

Sweep and reclaim

Low-level escape hatches

Types

​Portal Deposit Addresses

​Lifecycle at a glance

​Check support

​Create a portal

​List portals and deposits

​Sweep and reclaim

​Low-level escape hatches

​Types

Portal Deposit Addresses

Lifecycle at a glance

Check support

Create a portal

List portals and deposits

Sweep and reclaim

Low-level escape hatches

Types