zumokit

ZumoKit is a Wallet as a Service SDK

2.3.0-beta.2
Source
npm

Version published: 4 years ago

Maintainers: 1

Created: 4 years ago

Source

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.3.0-beta.2/decimal.js"></script>
<script src="https://js.zumo.money/2.3.0-beta.2/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_ROOT, TX_SERVICE_URL);
      console.log(zumoKit.version)
    });
  </script>
</head>

<body>
  <p>Check console output!</p>
  <script src="https://js.zumo.money/2.3.0-beta.2/decimal.js"></script>
  <script src="https://js.zumo.money/2.3.0-beta.2/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 includes TypeScript declarations for ZumoKit.

Example

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

Keywords

FAQs

What is zumokit?

Is zumokit well maintained?

Package last updated on 23 Oct 2020

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install