stellar-payment-watcher

Stellar payment watcher

Stellar payment watcher library for nodejs.

Installation

Install the package with:

npm i stellar-payment-watcher

Usage

Initialization

import PaymentWatcher from 'stellar-payment-watcher';

// optional params
const options = {
  allowHttp: false, // Horizon server param
  appName: null, // Horizon server param
  appVersion: null, // Horizon server param
  horizonServerURL: 'https://horizon.stellar.org',
  limit: 100, // amount of transactions to load from given cursor
  reconnectTimeout: 15 * 1000, // Time in milliseconds before restart the watcher
  useTestNet: false, // only required to parse transaction object
}

const watcher = new PaymentWatcher(options);

Watch all payments

Watch all payments using Horizon payments stream.

// optional params
const options = {
  onmessage: (payment) => console.log(payment),
  onerror: (error) => console.error(error),
}

watcher.start(options);

Watch all payments from cursor

Watch all payments from given cursor and then use Horizon payments stream.

// optional params
const options = {
  cursor: '118556627971530752',
  onmessage: (payment) => console.log(payment),
  onerror: (error) => console.error(error),
}

watcher.start(options);

Watch all payments for given accounts

Watch all payments for given accounts using Horizon payments stream.

// optional params
const options = {
  accounts: ['GCBRK7UAKYJ2MG3NNPGHLW6P7LXM5YHB5G4UZA3YTWJ7PTCH6F4VJDH6', 'GDI47LBSD65TNLLH3R36SKLRTSEM4T7OMCZIHHMN2FEQPVSIBBKUNZMY'],
  onmessage: (payment) => console.log(payment),
  onerror: (error) => console.error(error),
}

watcher.start(options);

Watch all payments for given accounts from cursor

Watch all payments for given accounts using Horizon payments stream.

// optional params
const options = {
  cursor: '118556627971530752',
  accounts: ['GCBRK7UAKYJ2MG3NNPGHLW6P7LXM5YHB5G4UZA3YTWJ7PTCH6F4VJDH6', 'GDI47LBSD65TNLLH3R36SKLRTSEM4T7OMCZIHHMN2FEQPVSIBBKUNZMY'],
  onmessage: (payment) => console.log(payment),
  onerror: (error) => console.error(error),
}

watcher.start(options);

Development

Run all tests:

$ npm i
$ npm test

Run a single test suite:

$ npm run mocha -- test/lib/watcher.spec.js

Run a single test (case sensitive):

$ npm run mocha -- test/lib/watcher.spec.js --grep 'allowHttp'

_{^{Library based on Stellar Notifier}}