ClientEmitter | Crypto Bot API

Main class for work with API for Node.js

Library for Node.js default export this class

Hierarchy

Client
- ClientEmitter

Methods

call

call(method: string, options?: object): Promise<any>

Inherited from Client.call
- Defined in src/classes/Client.ts:215
Call backend API method directly (types unsafe)

Use it if backend API update (add new methods, change request or response fileds), but library is not

throws
Error - If there is an error sending request to backend API or parsing response

Parameters
- method: string
  
  Backend API method name
- options: object = {}
  
  Backend API options object
Returns Promise<any>
Promise, what resolved to backend API response result field value

closeServer

closeServer(): Promise<void>

- Defined in src/classes/ClientEmitter.ts:144
Close created handling webhooks server

throws
Error - If server not was started or closing error

Returns Promise<void>
Promise, what resolved void

createInvoice

createInvoice(options: CreateInvoiceOptions): Promise<Invoice>

Inherited from Client.createInvoice
- Defined in src/classes/Client.ts:153
Create invoice

Use toInvoice backend API result convert function and prepare backend API parameters prepareCreateInvoiceOptions function

throws
Error - If there is an error sending request to backend API, parsing response error or options object is invalid

Parameters
- options: CreateInvoiceOptions
  
  New invoice options
Returns Promise<Invoice>
Promise, what resolved to created invoice information object

createServer

createServer(serverOptions: ServerOptions, secretPath?: string, listenOptions?: ListenOptions): Promise<void>

- Defined in src/classes/ClientEmitter.ts:101
Create handling webhooks server

Important: at the time of publication of version 0.2.0 (Dec 9, 2021), API servers do not accept self-signed certificates

throws
Error - If create server error

Parameters
- serverOptions: ServerOptions
  
  Node.js built-in server options
- secretPath: string = '/'
  
  Webhooks secret path, processing webhooks takes place only on it
- listenOptions: ListenOptions = ...
  
  Node.js built-in server listen options
Returns Promise<void>
Promise, what resolved void

getBalance

getBalance(currencyCode: string, isReturnInNanos?: boolean, isForce?: boolean): Promise<string>

Inherited from Client.getBalance
- Defined in src/classes/Client.ts:84
Get API app balance value for passed currency

Call Client.getBalances method to fetch balances information

throws
Error - If there is an error sending request to backend API or parsing response

Parameters
- currencyCode: string
  
  Currency code
- isReturnInNanos: boolean = false
  
  If true, return raw balances in nanos, else return converted to coins balances
- isForce: boolean = false
  
  If true, return fresh data from backend API, not from cache
Returns Promise<string>
Promise, what resolved to API app balance value for passed currency

getBalances

getBalances(isReturnInNanos?: boolean, isForce?: boolean): Promise<Balances>

Inherited from Client.getBalances
- Defined in src/classes/Client.ts:62
Get API app balances infomation

Use toBalances backend API result convert function

Call Store.getCurrencies method to fetch exchange rates information

throws
Error - If there is an error sending request to backend API or parsing response

Parameters
- isReturnInNanos: boolean = false
  
  If true, return raw balances in nanos, else return converted to coins balances
- isForce: boolean = false
  
  If true, return fresh data from backend API, not from cache
Returns Promise<Balances>
Promise, what resolved to API app balances infomation object

getCurrencies

getCurrencies(isForce?: boolean): Promise<Currencies>

Inherited from Client.getCurrencies
- Defined in src/classes/Store.ts:127
Get API supported currencies infomation

Use toCurrencies backend API result convert function

throws
Error - If there is an error sending request to backend API or parsing response

Parameters
- Optional isForce: boolean
  
  If true, return fresh data from backend API, not from cache
Returns Promise<Currencies>
Promise, what resolved to API supported currencies infomation object

getCurrency

getCurrency(currencyCode: string, isForce?: boolean): Promise<Currency>

Inherited from Client.getCurrency
- Defined in src/classes/Client.ts:107
Get currency with passed code infomation

Call Store.getCurrencies method to fetch currencies information

throws
Error - If there is an error sending request to backend API or parsing response

Parameters
- currencyCode: string
  
  Currency code
- isForce: boolean = false
  
  If true, return fresh data from backend API, not from cache
Returns Promise<Currency>
Promise, what resolved to currency with passed code infomation object or null, if currency with passed code not exists

getExchangeRate

getExchangeRate(source: string, target: string, isForce?: boolean): Promise<number>

Inherited from Client.getExchangeRate
- Defined in src/classes/Client.ts:130
Get one exchange rate infomation to passed currencies pair

Call Store.getExchangeRates method to fetch exchange rates information, Store.getCurrencies method to fetch currencies information and use getExchageRate function to get signle exchange rate

throws
Error - If there is an error sending request to backend API or parsing response

Parameters
- source: string
  
  Source currency code
- target: string
  
  Target currency code
- isForce: boolean = false
  
  If true, return fresh data from backend API, not from cache
Returns Promise<number>
Promise, what resolved to exchange rate or zero, if currencies pair not exists

getExchangeRates

getExchangeRates(isForce?: boolean): Promise<ExchangeRates>

Inherited from Client.getExchangeRates
- Defined in src/classes/Store.ts:147
Get API supported currencies exchange rate infomation

Use toExchangeRates backend API result convert function

throws
Error - If there is an error sending request to backend API or parsing response

Parameters
- Optional isForce: boolean
  
  If true, return fresh data from backend API, not from cache
Returns Promise<ExchangeRates>
Promise, what resolved to API supported currencies exchange rate infomation object

getInvoices

getInvoices(options?: GetInvoicesOptions): Promise<Invoices>

Inherited from Client.getInvoices
- Defined in src/classes/Client.ts:170
Get invoices

Use toInvoices backend API result convert function and prepare backend API parameters prepareGetInvoicesOptions function

throws
Error - If there is an error sending request to backend API or parsing response

Parameters
- options: GetInvoicesOptions = {}
  
  Filters options
Returns Promise<Invoices>
Promise, what resolved to invoices information object

getInvoicesPaginate

getInvoicesPaginate(options?: GetInvoicesPaginateOptions): Promise<InvoicesPaginated>

Inherited from Client.getInvoicesPaginate
- Defined in src/classes/Client.ts:192
Get invoices paginated

Fetch invoices with page options parameter, except count and offset

See Client.getPageSize and Client.setPageSize

Use toInvoicesPaginated backend API result convert function and prepare backend API parameters prepareGetInvoicesPaginateOptions function

throws
Error - If there is an error sending request to backend API, parsing response error or options object is invalid

Parameters
- options: GetInvoicesPaginateOptions = {}
  
  Filters options
Returns Promise<InvoicesPaginated>
Promise, what resolved to invoices information object

getMe

getMe(isForce?: boolean): Promise<Me>

Inherited from Client.getMe
- Defined in src/classes/Store.ts:167
Get associated with passed API key app infomation

Use toMe backend API result convert function

throws
Error - If there is an error sending request to backend API or parsing response

Parameters
- isForce: boolean = false
  
  If true, return fresh data from backend API, not from cache
Returns Promise<Me>
Promise, what resolved to associated with passed API key app infomation object

getPageSize

getPageSize(): number

Inherited from Client.getPageSize
- Defined in src/classes/Client.ts:28
Return count invoices per page for Client.getInvoicesPaginate method

Returns number

middleware

middleware(): Middleware

- Defined in src/classes/ClientEmitter.ts:160
Create middleware function for Express.js-like API

Returns Middleware
Middleware function

off

off(event: "paid", listener: (invoice?: Invoice, requestDate?: Date) => any): void

- Defined in src/classes/ClientEmitter.ts:195
Unsubscribes from paid event

Parameters
- event: "paid"
  
  paid event name
- listener: (invoice?: Invoice, requestDate?: Date) => any
  
  Event listener with invoice and requestDate callback parameters
  - - (invoice?: Invoice, requestDate?: Date): any
    - Parameters
      - Optional invoice: Invoice
      - Optional requestDate: Date
      Returns any
Returns void

on

on(event: "paid", listener: (invoice?: Invoice, requestDate?: Date) => any): void

- Defined in src/classes/ClientEmitter.ts:176
Subscribes to paid event

See ClientEmitter._emit to more about event listener

Parameters
- event: "paid"
  
  paid event name
- listener: (invoice?: Invoice, requestDate?: Date) => any
  
  Event listener with invoice and requestDate callback parameters
  - - (invoice?: Invoice, requestDate?: Date): any
    - Parameters
      - Optional invoice: Invoice
      - Optional requestDate: Date
      Returns any
Returns void

setPageSize

setPageSize(pageSizeParam: number): void

Inherited from Client.setPageSize
- Defined in src/classes/Client.ts:39
Set count invoices per page for Client.getInvoicesPaginate method

throws
Error - If pageSize parameter is invalid

Parameters
- pageSizeParam: number
Returns void

Private _emit

_emit(event: "paid", invoice: Invoice, requestDate: Date): void

- Defined in src/classes/ClientEmitter.ts:220
Emit event to listeners

Parameters
- event: "paid"
  
  paid event name
- invoice: Invoice
  
  Paid invoice information object
- requestDate: Date
  
  Date of occurrence of event, need to filter old event. If server is not available, backend API try resend webhooks by timeout, so when server becomes available again, many old events will be sent from backend API.
Returns void

Private _handleWebhook

_handleWebhook(data: any, req: IncomingMessage, res: ServerResponse): void

- Defined in src/classes/ClientEmitter.ts:243
Handling webhook data, send response and emit events

Parameters
- data: any
  
  Parsed request body
- req: IncomingMessage
  
  Node.js built-in IncomingMessage object
- res: ServerResponse
  
  Node.js built-in ServerResponse object
Returns void

Constructors

constructor

new ClientEmitter(apiKey: string, endpoint?: string): ClientEmitter

Overrides Client.constructor
- Defined in src/classes/ClientEmitter.ts:82
Create class instance

Parameters
- apiKey: string
  
  Crypto Bot API key, looks like '1234:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA'
- endpoint: string = 'mainnet'
  
  API endpoint url or 'mainnet' or 'testnet' for hardcoded in library endpoint urls
Returns ClientEmitter

Properties

Protected _transport

_transport: Transport

Transport class instance

Private _apiKey

_apiKey: string

Api key

Private _events

_events: {} = {}

Event listeners store

Type declaration

[key: string]: ((...args: any) => any)[]

Private _server

_server: Server

Handling webhooks created Node.js built-in server

Hierarchy

Index

Methods

Constructors

Properties

Methods

call

Parameters

method: string

options: object = {}

Returns Promise<any>

closeServer

Returns Promise<void>

createInvoice

Parameters

options: CreateInvoiceOptions

Returns Promise<Invoice>

createServer

Parameters

serverOptions: ServerOptions

secretPath: string = '/'

listenOptions: ListenOptions = ...

Returns Promise<void>

getBalance

Parameters

currencyCode: string

isReturnInNanos: boolean = false

isForce: boolean = false

Returns Promise<string>

getBalances

Parameters

isReturnInNanos: boolean = false

isForce: boolean = false

Returns Promise<Balances>

getCurrencies

Parameters

Optional isForce: boolean

Returns Promise<Currencies>

getCurrency

Parameters

currencyCode: string

isForce: boolean = false

Returns Promise<Currency>

getExchangeRate

Parameters

source: string

target: string

isForce: boolean = false

Returns Promise<number>

getExchangeRates

Parameters

Optional isForce: boolean

Returns Promise<ExchangeRates>

getInvoices

Parameters

options: GetInvoicesOptions = {}

Returns Promise<Invoices>

getInvoicesPaginate

Parameters

options: GetInvoicesPaginateOptions = {}

Returns Promise<InvoicesPaginated>

getMe

Parameters

isForce: boolean = false

Returns Promise<Me>

getPageSize

Returns number

middleware

Returns Middleware

off

Parameters

event: "paid"

listener: (invoice?: Invoice, requestDate?: Date) => any

Parameters

Optional invoice: Invoice

Optional requestDate: Date

Returns any

Returns void

on

Parameters