@zerohash-sdk/fund-withdrawals-react

A React SDK for embedding the Zerohash Fund Withdrawals flow into web applications. Lets users withdraw assets from their Fund account to an external destination.

Requirements

• React 18.0.0 or higher
• React DOM 18.0.0 or higher

Installation

npm install @zerohash-sdk/fund-withdrawals-react

Getting Started

1. Import the FundWithdrawals component

import { FundWithdrawals } from '@zerohash-sdk/fund-withdrawals-react';

2. Add it to your app

function App() {
  const jwt = 'your-jwt-token';

  return (
    <FundWithdrawals
      jwt={jwt}
      env="prod"
      theme="auto"
      isPayouts={false}
    />
  );
}

3. Configure event callbacks (optional)

<FundWithdrawals
  jwt={jwt}
  env="prod"
  theme="auto"
  onCompleted={({ externalAccountId, assetSymbol, amount }) => {
    console.log(`Withdrew ${amount} ${assetSymbol} to ${externalAccountId}`);
  }}
  onError={({ errorCode, reason }) => console.error(errorCode, reason)}
  onClose={() => console.log('Widget closed')}
  onEvent={(event) => console.log('Event:', event)}
  onLoaded={() => console.log('Widget ready')}
/>

API Reference

FundWithdrawals Component Props

| Prop | Type | Required | Default | Description | | ------------- | ------------------------------------------------------ | -------- | -------- | ---------------------------------------------------------------------------------- | | jwt | string | Yes | - | JWT token for authentication with Connect | | env | "prod" \| "cert" \| "dev" \| "local" | No | "prod" | Target environment | | theme | "auto" \| "light" \| "dark" | No | "auto" | Theme mode for the interface | | isPayouts | boolean | No | false | When true, renders the Payouts flow instead of the standard Fund Withdrawals flow. | | onCompleted | ({ externalAccountId, assetSymbol, amount }) => void | No | - | Callback when the withdrawal is successfully initiated | | onError | ({ errorCode, reason }) => void | No | - | Callback for error events | | onClose | () => void | No | - | Callback when the widget is closed | | onEvent | (event) => void | No | - | Callback for general events | | onLoaded | () => void | No | - | Callback when the widget is loaded and ready |

onCompleted payload shape: { externalAccountId: string; assetSymbol: string; amount: string }.

More Information & Support

For comprehensive documentation, visit the Zerohash Documentation Page.