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.
Refer to ZumoKit SDK developer documentation and reference for usage details.
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>
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
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.
<!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>
import { loadZumoKit } from "zumokit";
const zumokit = await loadZumoKit(API_KEY, API_ROOT, TX_SERVICE_URL);
console.log(zumoKit.version);
This package exports TypeScript declarations for ZumoKit type aliases and interfaces via named exports. For example:
import { CurrencyCode, AccountType, Network } from "zumokit";
The webpack example project demonstrates the expected user flow, including authentication process, wallet creation and transaction submission.
Exchange settings are contained in a mapping between from currency, to currency and exchange settings.
Historical exchange rates are contained in a mapping between time interval, from currency, to currency on third level and exchange rates.
Transaction fee rates are contained in a mapping between crypto currency and tranfaction fee rate.
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.
ZumoKit Api-Key
ZumoKit API url
ZumoKit Transaction Service url
ZumoKit instance
Generated using TypeDoc
Exchange rates are contained in a mapping between from currency, to currency and exchange rates.