ZeroHash Fund SDK

This SDK exposes functionality that allows platforms to integrate with ZeroHash on the web.

Quick setup

npm i zh-fund-sdk

import ZeroHashSDK from "zh-fund-sdk"

// Initialize SDK
const sdk = new ZeroHashFundSDK({
    zeroHashFundURL: "https://fund-app.zerohash.com/"
});

// Set the user fund JWT retrieved for a particular user
// A user fund JWT before the user can proceed with the fund flow.
sdk.openFundModal({
    userFundJWT: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9." +
        "eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ." +
        "SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
});

API

See the ZeroHashSDK class in index.d.ts in /dist.

If you are browsing this repository, you can find the implementation in index.tsx.

Versioning

The pipeline automatically updates the version in package.json after merge to main. It uses conventional commits to determine the type of bump to use:

• BREAKING CHANGE is a major release (1.0.0 to 2.0.0)
• feat is a minor release (1.0.0 to 1.1.0)
• default is a patch release (1.0.0 to 1.0.1)