Capacitor plugin

Embed zerohash's Fund (deposit) flow into a Capacitor app. The plugin wraps the native zerohash iOS and Android SDKs and presents their Fund UI over your app, so teams building on Capacitor can use the native SDKs without writing platform-specific bridge code.

The native Swift and Kotlin SDKs remain the source of truth; this plugin is a thin translation layer that exposes them to Capacitor. It currently supports the Fund (deposit) flow.

Prerequisites

Before you start, make sure you have:

• A Capacitor app targeting iOS, Android, or both.
• iOS 15 or later, and Android minSdkVersion 24 or later.
• A backend that mints a short-lived Fund session JWT from the zerohash API. You pass this token to the plugin when you present the flow.

Install

npm install @zerohash-sdk/capacitor
npx cap sync

Platform setup

Android

The plugin's Android side pulls in the native zerohash Android SDK (com.github.zerohash-ext:zerohash-android), which is hosted on JitPack. Add JitPack to your app's Gradle repositories so it can be resolved:

allprojects {
    repositories {
        google()
        mavenCentral()
        maven { url = uri("https://jitpack.io") }
    }
}

If your project uses dependencyResolutionManagement, add the same maven { ... } line to that block in settings.gradle instead.

iOS

No extra steps are required. npx cap sync wires in the native SDK automatically through Swift Package Manager.

Present the Fund flow

Register your event listeners before presenting the flow, then call presentFund with the JWT your backend minted.

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

// Register listeners before presenting.
await Zerohash.addListener('fundCompleted', (event) => {
  console.log('Deposit complete', event);
});
await Zerohash.addListener('close', () => console.log('Flow closed'));
await Zerohash.addListener('error', (e) => console.error(e.code, e.message));

// Present the Fund flow. The JWT is a short-lived Fund session token that
// your backend mints from the zerohash API.
await Zerohash.presentFund({
  jwt: '<fund-session-jwt>',
  environment: 'production', // or 'sandbox'
  theme: 'system',           // 'light' | 'dark' | 'system'
});

To manage the session, call Zerohash.cancel() to dismiss the flow programmatically, Zerohash.isActive() to check whether it's currently presented, and Zerohash.removeAllListeners() when tearing down.

The error, event, and fundCompleted listeners return the same data described in Front-end callbacks.

API reference

Methods

PresentFundOptions

Events

Register these with addListener.

Event payloads

ZerohashErrorEvent

GenericEvent

FundCompletedEvent — any field the flow doesn't provide is null.

Type aliases