monero-rpc/lib/wallet.js

> node wrapper for monero daemon and wallet rpc

/*
 * Copyright 2018 Excitable Aardvark <excitableaardvark@tutanota.de>
 *
 * Licensed under the 3-Clause BSD license. See LICENSE in the project root for
 * more information.
 */

const crypto = require('crypto')
const jayson = require('jayson')

/**
 * A default daemon host, if one is not provided.
 *
 * @type {String}
 * @const
 */
const DEFAULT_HOST = 'http://localhost:18082'

class Wallet {
  /**
   * @param {string} host The wallet host
   * @constructor
   */
  constructor (host = DEFAULT_HOST) {
    this.host = host
    this.client = jayson.client.http(host + '/json_rpc')
  }

  /**
   * Get the wallet's address.
   *
   * @param {Function} cb A callback to recieve the result
   * @return {void}
   */
  getAddress (cb) {
    this.client.request('getaddress', [], (err, response) => {
      if (err) return cb(err)
      if (response.error) return cb(response.error.message)

      return cb(null, response.result.address)
    })
  }

  /**
   * Get the wallet's balance.
   *
   * @param {Function} cb A callback to recieve the result
   * @return {void}
   */
  getBalance (cb) {
    this.client.request('getbalance', [], (err, response) => {
      if (err) return cb(err)
      if (response.error) return cb(response.error.message)

      const result = response.result

      return cb(null, {
        total: result.balance,
        spendable: result.unlocked_balance
      })
    })
  }

  /**
   * Send monero.
   *
   * @param {Object} options Options
   * @param {Function} cb A callback to recieve the result
   * @return {void}
   */
  transfer (options, cb) {
    // TODO(aardvark): https://github.com/monero-project/monero/blob/5f09d6c8333b0b0d07252dc157b9e794f6278662/src/wallet/wallet2.cpp#L4959

    if (!Array.isArray(options.destinations) || options.destinations.length === 0) {
      return cb('destinations are required')
    }

    const defaults = {
      mixin: 7,
      priority: 0
    }

    this.client.request('transfer', { ...defaults, ...options }, (err, response) => {
      if (err) return cb(err)
      if (response.error) return cb(response.error.message)

      return cb(null, response.result)
    })
  }

  /**
   * Send monero, and split into multiple transactions if required.
   *
   * @param {Object} options Options
   * @param {Function} cb A callback to recieve the result
   * @return {void}
   */
  splitTransfer (options, cb) {
    if (!Array.isArray(options.destinations) || options.destinations.length === 0) {
      return cb('destinations are required')
    }

    const defaults = {
      mixin: 7,
      priority: 0
    }

    this.client.request('transfer_split', { ...defaults, ...options }, (err, response) => {
      if (err) return cb(err)
      if (response.error) return cb(response.error.message)

      return cb(null, response.result)
    })
  }

  /**
   * Get a list of incoming payments using a given payment id.
   *
   * @param {string} paymentId The Payment ID
   * @param {Function} cb A callback to recieve the result
   * @return {void}
   */
  getPayments (paymentId, cb) {
    this.client.request('get_payments', { payment_id: paymentId }, (err, response) => {
      if (err) return cb(err)
      if (response.error) return cb(response.error.message)

      return cb(null, response.result.payments)
    })
  }

  /**
   * Generate a random payment id.
   *
   * @param {Boolean} integrated If the payment id is for an integrated address
   * @param {Function} cb A callback to recieve the result
   * @return {void}
   */
  getRandomPaymentId (integrated, cb) {
    crypto.randomBytes(integrated ? 8 : 32, (err, buf) => {
      if (err) return cb(err)
      return cb(null, buf.toString('hex'))
    })
  }

  /**
   * Generate a random integrated address.
   *
   * @param {Function} cb A callback to recieve the result
   * @return {void}
   */
  getRandomIntegratedAddress (cb) {
    this.getRandomPaymentId(true, (err, paymentId) => {
      if (err) return cb(err)
      this.client.request('make_integrated_address', { payment_id: paymentId }, (err, response) => {
        if (err) return cb(err)
        if (response.error) return cb(response.error.message)

        return cb(null, { paymentId, address: response.result.integrated_address })
      })
    })
  }

  /**
   * Get a list of payments using a list of payment ids from a given height.
   *
   * @param {Array.string} paymentIds A list of payment ids to check
   * @param {Number} blockHeight The block height to look from
   * @param {Function} cb A callback to recieve the result
   * @return {void}
   */
  getBulkPayments (paymentIds, blockHeight, cb) {
    this.client.request('get_bulk_payments', { payment_ids: paymentIds, min_block_height: blockHeight }, (err, response) => {
      if (err) return cb(err)
      if (response.error) return cb(response.error.message)

      cb(null, response.result.payments)
    })
  }
}

module.exports = Wallet