@zerohash-sdk/capacitor

v1.0.6

Published

6 days ago

Capacitor plugin bridging zerohash's native iOS and Android SDKs

0High
0Medium
0Low

zh-sdk-adm

capacitor plugin native

@zerohash-sdk/capacitor

Capacitor plugin for embedding zerohash's Fund (deposit) and crypto-withdrawals flows into your iOS and Android app. It wraps the native zerohash iOS and Android SDKs and presents their UI over your app.

Install

npm install @zerohash-sdk/capacitor
npx cap sync

Requirements

iOS 17+
Android minSdkVersion 24+

Setup

Android

No extra steps — the plugin's Android side pulls in the native zerohash Android SDK (com.zerohash:zerohash-android) from Maven Central, which a standard Gradle setup already resolves.

iOS

No extra steps — npx cap sync wires the native SDK in automatically via Swift Package Manager.

Usage

Both flows work the same way: register your listeners, then present. Each flow has its own completion event, while close, error and event fire for whichever flow is active. Only one flow can be presented at a time — presenting while another is active rejects.

jwt is a short-lived session token your backend mints from the zerohash API. environment defaults to production, theme to system.

Fund (deposit)

import { Zerohash } from '@zerohash-sdk/capacitor';

// Register listeners before presenting.
await Zerohash.addListener('fundCompleted', (event) => {
  console.log('Deposit complete', event.assetSymbol, event.amount);
});
// A terminal failed deposit is a flow outcome, not an error — it arrives here,
// not on 'error'.
await Zerohash.addListener('fundFailed', (event) => {
  console.log('Deposit failed', event.transactionId);
});
await Zerohash.addListener('close', () => console.log('Flow closed'));
await Zerohash.addListener('error', (e) => console.error(e.code, e.message));

await Zerohash.presentFund({
  jwt: '<session-jwt>',
  environment: 'production', // or 'sandbox'
  theme: 'system', // 'light' | 'dark' | 'system'
});

Crypto withdrawals

import { Zerohash } from '@zerohash-sdk/capacitor';

// Register listeners before presenting.
await Zerohash.addListener('withdrawalCompleted', (event) => {
  console.log('Withdrawal submitted', event.withdrawalRequestId);
});
await Zerohash.addListener('withdrawalFailed', (event) => {
  console.log('Withdrawal failed', event.withdrawalRequestId);
});
await Zerohash.addListener('close', () => console.log('Flow closed'));
await Zerohash.addListener('error', (e) => console.error(e.code, e.message));

await Zerohash.presentCryptoWithdrawals({
  jwt: '<session-jwt>',
  environment: 'production', // or 'sandbox'
  theme: 'system', // 'light' | 'dark' | 'system'
});

Dismissing and tearing down

Both flows share these: Zerohash.cancel() dismisses whichever flow is presented, Zerohash.isActive() reports whether one is, and Zerohash.removeAllListeners() unregisters every listener the plugin holds.

API

presentFund(...)

presentFund(options: PresentOptions) => Promise<void>

Present the Fund (deposit) flow. Rejects if a session is already active.

| Param | Type | | ------------- | --------------------------------------------------------- | | options | PresentOptions |

presentCryptoWithdrawals(...)

presentCryptoWithdrawals(options: PresentOptions) => Promise<void>

Present the crypto-withdrawals flow. Rejects if a session is already active.

| Param | Type | | ------------- | --------------------------------------------------------- | | options | PresentOptions |

cancel()

cancel() => Promise<void>

Dismiss the active session, if any.

isActive()

isActive() => Promise<{ isActive: boolean; }>

Whether a session is currently presented.

Returns: Promise<{ isActive: boolean; }>

addListener('close', ...)

addListener(eventName: 'close', listenerFunc: () => void) => Promise<PluginListenerHandle>

The user closed the flow.

| Param | Type | | ------------------ | -------------------------- | | eventName | 'close' | | listenerFunc | () => void |