Options
All
  • Public
  • Public/Protected
  • All
Menu

ZumoKit React Native SDK

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

Install the package:

yarn add zumo/zumokit-react-native

Link the library (not required for React Native 0.60 and up):

react-native link react-native-zumo-kit

If your project does not yet support typescript, you will have to enable it:

yarn add --dev typescript @types/jest @types/react @types/react-native @types/react-test-renderer

ZumoKit React Native SDK uses experimental TypeScript decorators, support for which has to be enabled:

yarn add @babel/plugin-proposal-decorators -D

Then, modify compilerOptions in tsconfig.json:

"experimentalDecorators": true

and enable plugin @babel/plugin-proposal-decorators in babel.config.json:

plugins: [["@babel/plugin-proposal-decorators", { "legacy": true }]]

Extra step for iOS

As ZumoKit is not yet distributed via CocoaPods Trunk, you'll need to include the ZumoKit Spec repo in your app's Podfile (usually located in the ios directory). You'll also need to ensure that the minimum iOS target is 10.0 or higher.

platform :ios, '10.0'

source 'https://github.com/CocoaPods/Specs.git'
source 'https://github.com/zumo/zumokit-specs.git'

target 'Demo' do
  # ...

  pod 'RNZumoKit', :path => '../node_modules/react-native-zumo-kit'

end

You will also need to execute pod install manually from the ios directory.

Extra step for Android

Set minSdkVersion to 21 in your android/build.gradle settings.

Usage

Import ZumoKit module from react-native-zumo-kit package:

import ZumoKit from 'react-native-zumo-kit';

ZumoKit module is your entrypoint to ZumoKit SDK. Check your SDK version by calling:

console.log(ZumoKit.version);

Once ZumoKit class is initialized via ZumoKit.init method, ZKUtility class with crypto utility classes can be globally accessed:

import { ZKUtility } from 'react-native-zumo-kit';

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

ExchangeStatus

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

HistoricalExchangeRates

Network

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

TimeInterval

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

TransactionStatus

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

TransactionType

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

Variables

RNZumoKit

RNZumoKit: any

Legend

  • Property
  • Method
  • Private property
  • Private method
  • Property
  • Inherited property
  • Static property

Generated using TypeDoc