ZumoKit | ZumoKit - v4.9.0

ZumoKit entry point. Refer to documentation for usage details.

Hierarchy

ZumoKit

Index

Properties

Methods

Properties

currentUser

currentUser: User | null = null

Currently signed-in user or null.

exchangeRates

exchangeRates: ExchangeRates

Mapping between currency pairs and available exchange rates.

transactionFeeRates

transactionFeeRates: TransactionFeeRates

Mapping between cryptocurrencies and available transaction fee rates.

utils

utils: Utils = new Utils()

Crypto utilities.

version

version: string = RNZumoKit.version

ZumoKit SDK semantic version tag if exists, commit hash otherwise.

Methods

addChangeListener

addChangeListener(listener: () => void): void

- Defined in src/ZumoKit.ts:185
Listen to changes in current user’s sign in state, exchange rates, exchange settings or transaction fee rates.

Parameters
- listener: () => void
  
  interface to listen to changes
  - - (): void
    - Returns void
Returns void

fetchHistoricalExchangeRates

fetchHistoricalExchangeRates(): Promise<HistoricalExchangeRates>

- Defined in src/ZumoKit.ts:175
Fetch historical exchange rates for supported time intervals.

Returns Promise<HistoricalExchangeRates>

historical exchange rates

getExchangeRate

getExchangeRate(fromCurrency: CurrencyCode, toCurrency: CurrencyCode): ExchangeRate | null

- Defined in src/ZumoKit.ts:148
Get exchange rate for selected currency pair.

Parameters
- fromCurrency: CurrencyCode
  
  currency code
- toCurrency: CurrencyCode
  
  currency code
Returns ExchangeRate | null

exchange rate or null

getTransactionFeeRate

getTransactionFeeRate(currency: CurrencyCode): TransactionFeeRate | null

- Defined in src/ZumoKit.ts:164
Get transaction fee rate for selected crypto currency.

Parameters
- currency: CurrencyCode
  
  currency code
Returns TransactionFeeRate | null

transaction fee rate or null

init

init(apiKey: string, apiUrl: string, txServiceUrl: string, cardServiceUrl: string, notificationServiceUrl: string, exchangeServiceUrl: string, custodyServiceUrl: string): void

- Defined in src/ZumoKit.ts:96
Initializes ZumoKit SDK. Should only be called once.

Parameters
- apiKey: string
  
  ZumoKit API key
- apiUrl: string
  
  ZumoKit API URL
- txServiceUrl: string
- cardServiceUrl: string
  
  ZumoKit Card Service URL
- notificationServiceUrl: string
  
  ZumoKit Notification Service URL
- exchangeServiceUrl: string
  
  ZumoKit Exchange Service URL
- custodyServiceUrl: string
  
  ZumoKit Custody Service URL
Returns void

onLog

onLog(listener: (logEntry: { data: any; level: LogLevel; message: string; process: number; thread: number; timestamp: number }) => void, logLevel: LogLevel): void

- Defined in src/ZumoKit.ts:67
Sets log handler for all ZumoKit related logs.

Parameters
- listener: (logEntry: { data: any; level: LogLevel; message: string; process: number; thread: number; timestamp: number }) => void
  
  interface to listen to changes
  - - (logEntry: { data: any; level: LogLevel; message: string; process: number; thread: number; timestamp: number }): void
    - Parameters
      - logEntry: { data: any; level: LogLevel; message: string; process: number; thread: number; timestamp: number }
        
        data: any
        
        level: LogLevel
        
        message: string
        
        process: number
        
        thread: number
        
        timestamp: number
      Returns void
- logLevel: LogLevel
  
  log level, e.g. 'debug' or 'info'
Returns void

removeChangeListener

removeChangeListener(listener: () => void): void

- Defined in src/ZumoKit.ts:194
Remove change listener.

Parameters
- listener: () => void
  
  interface to listen to changes
  - - (): void
    - Returns void
Returns void

setLogLevel

setLogLevel(logLevel: LogLevel): void

- Defined in src/ZumoKit.ts:57
Sets log level for current logger.

Parameters
- logLevel: LogLevel
  
  log level, e.g. 'debug' or 'info'
Returns void

signIn

signIn(userTokenSet: TokenSet): Promise<User>

- Defined in src/ZumoKit.ts:127
Signs in user corresponding to user token set. Sets current user to the newly signed in user. Refer to Server guide for details on how to get user token set.

Parameters
- userTokenSet: TokenSet
Returns Promise<User>

signOut

signOut(): Promise<void>

- Defined in src/ZumoKit.ts:135
Signs out current user.

Returns Promise<void>

Generated using TypeDoc