Options
All
  • Public
  • Public/Protected
  • All
Menu

ZumoKit Web SDK

npm (tag)

ZumoKit is a state of the art wallet architecture underpinning our flagship product Zumo that provides secure transfer and exchange of fiat and cryptocurrency funds.

Docs

Refer to ZumoKit SDK developer documentation and reference for usage details.

Installation

Standalone

Include the ZumoKit script on each page of your site — it should always be loaded directly from https://js.zumo.money, rather than included in a bundle or hosted yourself.

Additionaly, ZumoKit is dependent on decimal.js, which has to be added separately.

<script src="https://js.zumo.money/2.2.4/decimal.js"></script>
<script src="https://js.zumo.money/2.2.4/zumokit.js"></script>

ES6 Module

ZumoKit is distributed through NPM repository and it has a peer dependency on decimal.js, which also has to be installed:

npm install decimal.js@^10.2.0 zumokit

Usage

Entry point to ZumoKit SDK is loadZumoKit function. This function returns a Promise that resolves with a newly created ZumoKit object once ZumoKit SDK has loaded. Behind the scenes, it will load ZumoKit WebAssebly module for you by inserting the zumocore.js script tag. ZumoKit requires browser environment to work as expected and it will not work in in a server environment.

Refer to ZumoKit SDK developer documentation and reference for usage details.

Replace API_KEY, API_ROOT and TX_SERVICE_URL in the examples below with credentials provided to you by your account manager.

HTML + JS

<!DOCTYPE html>
<html>
  <head>
    <meta charset="UTF-8" />
    <title>ZumoKit Example</title>
    <script>
      window.addEventListener("load", async (event) => {
        const zumokit = await loadZumoKit(API_KEY, API_URL, TX_SERVICE_URL);
        zumokit.log(zumoKit.version);
      });
    </script>
  </head>

  <body>
    <p>Check console output!</p>
    <script src="https://js.zumo.money/2.2.4/decimal.js"></script>
    <script src="https://js.zumo.money/2.2.4/zumokit.js"></script>
  </body>
</html>

ES6 Module

import { loadZumoKit } from "zumokit";

const zumokit = await loadZumoKit(API_KEY, API_ROOT, TX_SERVICE_URL);
console.log(zumoKit.version);

TypeScript support

This package exports TypeScript declarations for ZumoKit type aliases and interfaces via named exports. For example:

import { CurrencyCode, AccountType, Network } from "zumokit";

Example

The webpack example project demonstrates the expected user flow, including authentication process, wallet creation and transaction submission.

Index

Type aliases

AccountType

AccountType: "STANDARD" | "COMPATIBILITY" | "SEGWIT"

CurrencyCode

CurrencyCode: "BTC" | "ETH" | "USD" | "GBP" | "EUR"

CurrencyType

CurrencyType: "CRYPTO" | "FIAT"

Dictionary

Dictionary<K, T>: Partial<Record<K, T>>

Type parameters

  • K: string

  • T

ExchangeRates

Exchange rates are contained in a mapping between from currency, to currency and exchange rates.

ExchangeSettings

Exchange settings are contained in a mapping between from currency, to currency and exchange settings.

ExchangeStatus

ExchangeStatus: "PENDING" | "DEPOSITED" | "CONFIRMED" | "FAILED" | "RESUBMITTED" | "CANCELLED" | "PAUSED" | "REJECTED"

HistoricalExchangeRates

Historical exchange rates are contained in a mapping between time interval, from currency, to currency on third level and exchange rates.

Network

Network: "MAINNET" | "TESTNET" | "RINKEBY" | "ROPSTEN" | "GOERLI"

TimeInterval

TimeInterval: "hour" | "day" | "week" | "month" | "quarter" | "year" | "max"

TransactionDirection

TransactionDirection: "INCOMING" | "OUTGOING"

TransactionFeeRates

Transaction fee rates are contained in a mapping between crypto currency and tranfaction fee rate.

TransactionStatus

TransactionStatus: "PENDING" | "CONFIRMED" | "FAILED" | "RESUBMITTED" | "CANCELLED" | "PAUSED" | "REJECTED"

TransactionType

TransactionType: "CRYPTO" | "EXCHANGE" | "FIAT" | "NOMINATED"

Functions

Const loadZumoKit

  • loadZumoKit(apiKey: string, apiUrl: string, txServiceUrl: string): Promise<ZumoKit>
  • Entry point to ZumoKit Web SDK.

    This function returns a Promise that resolves with a newly created ZumoKit object once ZumoKit SDK has loaded. Behind the scenes, it will load ZumoKit WebAssebly module for you by inserting the zumocore.js script tag. ZumoKit requires browser environment to work as expected and it will not work in in a server environment.

    Parameters

    • apiKey: string

      ZumoKit Api-Key

    • apiUrl: string

      ZumoKit API url

    • txServiceUrl: string

      ZumoKit Transaction Service url

    Returns Promise<ZumoKit>

    ZumoKit instance

Legend

  • Property
  • Method
  • Property
  • Inherited property
  • Static property

Generated using TypeDoc