edge-currency-monero 0.4.2 → 0.5.2

package/CHANGELOG.md

@@ -1,12 +1,24 @@
 # edge-currency-monero
 
+# 0.5.2 (2022-08-13)
+
+- fixed: incorrect amounts after spend
+
+# 0.5.1 (2022-08-13)
+
+- fixed: Stop randomly crashing while sending funds.
+
+# 0.5.0 (2022-08-11)
+
+- changed: Upgrade to react-native-mymonero-core v0.2.0, with its new API.
+
 # 0.4.2 (2022-08-03)
 
-- Set `addressesChecked` to `false` on resync
+- fixed: Set `addressesChecked` to `false` on resync
 
 # 0.4.1 (2022-05-11)
 
-- Fix syncing when the user settings are empty
+- fixed: Fix syncing when the user settings are empty
 
 # 0.4.0 (2022-01-11)
 

package/README.md

@@ -1,7 +1,6 @@
 # Edge Monero Currency Plugin
-[![Build Status][travis-image]][travis-url] [![NPM version][npm-image]][npm-url] [![Dependency Status][daviddm-image]][daviddm-url]
 
-[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)
+[![Build Status](https://app.travis-ci.com/EdgeApp/edge-currency-monero.svg?branch=master)](https://app.travis-ci.com/EdgeApp/edge-currency-monero)
 
 Implements Monero send/receive functionality per the spec for crypto currency plugins for [edge-core-js](https://github.com/EdgeApp/edge-core-js)
 

package/lib/MyMoneroApi.js

@@ -0,0 +1,272 @@
+ function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } }
+
+
+
+
+
+
+
+
+
+
+
+
+const parserUtils = require('./mymonero-utils/ResponseParser.js')
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+/**
+ * Brings together the mymonero server, JavaScript utilities,
+ * and native C++ methods into a coherent API.
+ */
+export class MyMoneroApi {
+  // Network options:
+  
+  
+  
+
+  // Dependency injection:
+  
+  
+
+  // Maps from key identifiers (a bunch of concatenated stuff) to key images:
+  
+
+  constructor(cppBridge, options) {
+    this.apiKey = options.apiKey
+    this.apiUrl = options.apiServer
+    this.nettype = _nullishCoalesce(options.nettype, () => ( 'MAINNET'))
+
+    this.fetch = options.fetch
+    this.cppBridge = cppBridge
+
+    this.keyImageCache = {}
+  }
+
+  async decodeAddress(address) {
+    return await this.cppBridge.decodeAddress(address, this.nettype)
+  }
+
+  async generateWallet(language = 'english') {
+    return await this.cppBridge.generateWallet(language, this.nettype)
+  }
+
+  async seedAndKeysFromMnemonic(mnemonic) {
+    return await this.cppBridge.seedAndKeysFromMnemonic(mnemonic, this.nettype)
+  }
+
+  /**
+   * Authenticates with the MyMonero light-wallet server.
+   */
+  async login(keys) {
+    const { address, privateViewKey } = keys
+    const result = await this.fetchPostMyMonero('login', {
+      address: address,
+      api_key: this.apiKey,
+      create_account: true,
+      view_key: privateViewKey
+    })
+    // const asLogin = asObject({
+    //   new_address: asBoolean,
+    //   start_height: asNumber
+    // })
+
+    return result // TODO: Clean this
+  }
+
+  async getTransactions(keys) {
+    const { address, privateSpendKey, privateViewKey, publicSpendKey } = keys
+    const result = await this.fetchPostMyMonero('get_address_txs', {
+      address,
+      api_key: this.apiKey,
+      view_key: privateViewKey
+    })
+    // asGetAddressTxs = asObject({
+    //   blockchain_height: asNumber,
+    //   scanned_block_height: asNumber,
+    //   scanned_height: asNumber,
+    //   start_height: asNumber,
+    //   total_received: asString,
+    //   transaction_height: asNumber,
+    //   transactions: asArray(asObject({
+    //     coinbase: asBoolean,
+    //     hash: asString,
+    //     height: asNumber,
+    //     id: asNumber,
+    //     mempool: asBoolean,
+    //     mixin: asNumber,
+    //     timestamp: asDate,
+    //     total_received: asString,
+    //     total_sent: asString,
+    //     unlock_time: asNumber
+    //   }))
+    // })
+
+    const parsed = await parserUtils.Parsed_AddressTransactions__async(
+      this.keyImageCache,
+      result,
+      address,
+      privateViewKey,
+      publicSpendKey,
+      privateSpendKey,
+      this.cppBridge
+    )
+    return parsed.serialized_transactions
+  }
+
+  async getAddressInfo(keys) {
+    const { address, privateSpendKey, privateViewKey, publicSpendKey } = keys
+    const result = await this.fetchPostMyMonero('get_address_info', {
+      address,
+      api_key: this.apiKey,
+      view_key: privateViewKey
+    })
+    // const asAddressInfo = asObject({
+    //   blockchain_height: asNumber,
+    //   locked_funds: asString,
+    //   rates: asObject(asNumber),
+    //   scanned_block_height: asNumber,
+    //   scanned_height: asNumber,
+    //   spent_outputs: asArray(
+    //     asObject({
+    //       amount: asString,
+    //       key_image: asString,
+    //       mixin: asNumber,
+    //       out_index: asNumber,
+    //       tx_pub_key: asString
+    //     })
+    //   ),
+    //   start_height: asNumber,
+    //   total_received: asString,
+    //   total_sent: asString,
+    //   transaction_height: asNumber
+    // })
+
+    const parsed = await parserUtils.Parsed_AddressInfo__async(
+      this.keyImageCache,
+      result,
+      address,
+      privateViewKey,
+      publicSpendKey,
+      privateSpendKey,
+      this.cppBridge
+    )
+    return {
+      blockHeight: parsed.blockchain_height,
+      totalReceived: parsed.total_received_String,
+      lockedBalance: parsed.locked_balance_String,
+      totalSent: parsed.total_sent_String
+    }
+  }
+
+  async createTransaction(
+    keys,
+    opts
+  ) {
+    const { address, privateSpendKey, privateViewKey, publicSpendKey } = keys
+    const { amount, isSweepTx = false, priority = 1, targetAddress } = opts
+
+    // Grab the UTXO set:
+    const unspentOuts = await this.fetchPostMyMonero('get_unspent_outs', {
+      address,
+      amount: '0',
+      api_key: this.apiKey,
+      dust_threshold: '2000000000',
+      mixin: 10,
+      use_dust: true,
+      view_key: privateViewKey
+    })
+
+    // Grab some random outputs to mix in:
+    const randomOutsCb = async (count) => {
+      const amounts = []
+      for (let i = 0; i < count; ++i) amounts.push('0')
+      return await this.fetchPostMyMonero('get_random_outs', {
+        amounts,
+        api_key: this.apiKey,
+        count: 11
+      })
+    }
+
+    // Make the transaction:
+    return await this.cppBridge.createTransaction({
+      destinations: [
+        {
+          send_amount: amount,
+          to_address: targetAddress
+        }
+      ],
+      priority,
+      address,
+      privateViewKey,
+      publicSpendKey,
+      privateSpendKey,
+      shouldSweep: isSweepTx,
+      nettype: this.nettype,
+      unspentOuts,
+      randomOutsCb
+    })
+  }
+
+  async broadcastTransaction(tx) {
+    await this.fetchPostMyMonero('submit_raw_tx', {
+      api_key: this.apiKey,
+      tx
+    })
+  }
+
+  // Private routines
+  // ----------------
+
+  async fetchPostMyMonero(cmd, params) {
+    const url = `${this.apiUrl}/${cmd}`
+    const response = await this.fetch(url, {
+      body: JSON.stringify(params),
+      headers: {
+        'Content-Type': 'application/json',
+        Accept: 'application/json'
+      },
+      method: 'POST'
+    })
+    if (!response.ok) {
+      throw new Error(
+        `The server returned error code ${response.status} for ${url}`
+      )
+    }
+    return response.json()
+  }
+}

package/lib/mymonero-utils/ResponseParser.js

@@ -0,0 +1,204 @@
+// This has been taken from @mymonero/mymonero-response-parser-utils v2.0.0
+// We have made the "__sync" methods async and deleted the rest.
+
+// Copyright (c) 2014-2019, MyMonero.com
+//
+// All rights reserved.
+//
+// Redistribution and use in source and binary forms, with or without modification, are
+// permitted provided that the following conditions are met:
+//
+// 1. Redistributions of source code must retain the above copyright notice, this list of
+//	conditions and the following disclaimer.
+//
+// 2. Redistributions in binary form must reproduce the above copyright notice, this list
+//	of conditions and the following disclaimer in the documentation and/or other
+//	materials provided with the distribution.
+//
+// 3. Neither the name of the copyright holder nor the names of its contributors may be
+//	used to endorse or promote products derived from this software without specific
+//	prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
+// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
+// THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+// STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
+// THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+//
+'use strict'
+//
+const JSBigInt = require('@mymonero/mymonero-bigint').BigInteger
+const monero_amount_format_utils = require('@mymonero/mymonero-money-format')
+const monero_keyImage_cache_utils = require("./mymonero-keyimage-cache.js")
+//
+async function Parsed_AddressInfo__async (
+  keyImage_cache,
+  data,
+  address,
+  view_key__private,
+  spend_key__public,
+  spend_key__private,
+  coreBridge_instance
+) {
+  // -> returnValuesByKey
+  const total_received = new JSBigInt(data.total_received || 0)
+  const locked_balance = new JSBigInt(data.locked_funds || 0)
+  var total_sent = new JSBigInt(data.total_sent || 0) // will be modified in place
+  //
+  const account_scanned_tx_height = data.scanned_height || 0
+  const account_scanned_block_height = data.scanned_block_height || 0
+  const account_scan_start_height = data.start_height || 0
+  const transaction_height = data.transaction_height || 0
+  const blockchain_height = data.blockchain_height || 0
+  const spent_outputs = data.spent_outputs || []
+  //
+  for (let spent_output of spent_outputs) {
+    var key_image = await monero_keyImage_cache_utils.Lazy_KeyImage(
+      keyImage_cache,
+      spent_output.tx_pub_key,
+      spent_output.out_index,
+      address,
+      view_key__private,
+      spend_key__public,
+      spend_key__private,
+      coreBridge_instance
+    )
+    if (spent_output.key_image !== key_image) {
+      // console.log('💬  Output used as mixin (' + spent_output.key_image + '/' + key_image + ')')
+      total_sent = new JSBigInt(total_sent).subtract(spent_output.amount)
+    }
+  }
+  //
+  const ratesBySymbol = data.rates || {} // jic it's not there
+  //
+  const returnValuesByKey = {
+    total_received_String: total_received
+      ? total_received.toString()
+      : null,
+    locked_balance_String: locked_balance
+      ? locked_balance.toString()
+      : null,
+    total_sent_String: total_sent ? total_sent.toString() : null,
+    // ^serialized JSBigInt
+    spent_outputs: spent_outputs,
+    account_scanned_tx_height: account_scanned_tx_height,
+    account_scanned_block_height: account_scanned_block_height,
+    account_scan_start_height: account_scan_start_height,
+    transaction_height: transaction_height,
+    blockchain_height: blockchain_height,
+    //
+    ratesBySymbol: ratesBySymbol
+  }
+  return returnValuesByKey
+}
+exports.Parsed_AddressInfo__async = Parsed_AddressInfo__async
+//
+async function Parsed_AddressTransactions__async (
+  keyImage_cache,
+  data,
+  address,
+  view_key__private,
+  spend_key__public,
+  spend_key__private,
+  coreBridge_instance
+) {
+  const account_scanned_height = data.scanned_height || 0
+  const account_scanned_block_height = data.scanned_block_height || 0
+  const account_scan_start_height = data.start_height || 0
+  const transaction_height = data.transaction_height || 0
+  const blockchain_height = data.blockchain_height || 0
+  //
+  const transactions = data.transactions || []
+  //
+  // TODO: rewrite this with more clarity if possible
+  for (let i = 0; i < transactions.length; ++i) {
+    if ((transactions[i].spent_outputs || []).length > 0) {
+      for (var j = 0; j < transactions[i].spent_outputs.length; ++j) {
+        var key_image = await monero_keyImage_cache_utils.Lazy_KeyImage(
+          keyImage_cache,
+          transactions[i].spent_outputs[j].tx_pub_key,
+          transactions[i].spent_outputs[j].out_index,
+          address,
+          view_key__private,
+          spend_key__public,
+          spend_key__private,
+          coreBridge_instance
+        )
+        if (transactions[i].spent_outputs[j].key_image !== key_image) {
+          // console.log('Output used as mixin, ignoring (' + transactions[i].spent_outputs[j].key_image + '/' + key_image + ')')
+          transactions[i].total_sent = new JSBigInt(
+            transactions[i].total_sent
+          )
+            .subtract(transactions[i].spent_outputs[j].amount)
+            .toString()
+          transactions[i].spent_outputs.splice(j, 1)
+          j--
+        }
+      }
+    }
+    if (
+      new JSBigInt(transactions[i].total_received || 0)
+        .add(transactions[i].total_sent || 0)
+        .compare(0) <= 0
+    ) {
+      transactions.splice(i, 1)
+      i--
+      continue
+    }
+    transactions[i].amount = new JSBigInt(
+      transactions[i].total_received || 0
+    )
+      .subtract(transactions[i].total_sent || 0)
+      .toString()
+    transactions[i].approx_float_amount = parseFloat(
+      monero_amount_format_utils.formatMoney(transactions[i].amount)
+    )
+    transactions[i].timestamp = transactions[i].timestamp
+    const record__payment_id = transactions[i].payment_id
+    if (typeof record__payment_id !== 'undefined' && record__payment_id) {
+      if (record__payment_id.length == 16) {
+        // short (encrypted) pid
+        if (transactions[i].approx_float_amount < 0) {
+          // outgoing
+          delete transactions[i]['payment_id'] // need to filter these out .. because the server can't filter out short (encrypted) pids on outgoing txs
+        }
+      }
+    }
+  }
+  transactions.sort(function (a, b) {
+    if (a.mempool == true) {
+      if (b.mempool != true) {
+        return -1 // a first
+      }
+      // both mempool - fall back to .id compare
+    } else if (b.mempool == true) {
+      return 1 // b first
+    }
+    return b.id - a.id
+  })
+  // prepare transactions to be serialized
+  for (let transaction of transactions) {
+    transaction.amount = transaction.amount.toString() // JSBigInt -> String
+    if (
+      typeof transaction.total_sent !== 'undefined' &&
+			transaction.total_sent !== null
+    ) {
+      transaction.total_sent = transaction.total_sent.toString()
+    }
+  }
+  // on the other side, we convert transactions timestamp to Date obj
+  const returnValuesByKey = {
+    account_scanned_height: account_scanned_height,
+    account_scanned_block_height: account_scanned_block_height,
+    account_scan_start_height: account_scan_start_height,
+    transaction_height: transaction_height,
+    blockchain_height: blockchain_height,
+    serialized_transactions: transactions
+  }
+  return returnValuesByKey
+}
+exports.Parsed_AddressTransactions__async = Parsed_AddressTransactions__async

package/lib/mymonero-utils/mymonero-keyimage-cache.js

@@ -0,0 +1,37 @@
+// This has been taken from @mymonero/mymonero-keyimage-cache v2.0.0
+// We have made `Lazy_KeyImage` async and deleted the rest.
+// We have also renamed generate_key_image to generateKeyImage.
+
+'use strict'
+
+const Lazy_KeyImage = async function (
+  mutable_keyImagesByCacheKey, // pass a mutable JS dictionary
+  tx_pub_key,
+  out_index,
+  public_address,
+  view_key__private,
+  spend_key__public,
+  spend_key__private,
+  coreBridge_instance // must pass this so this fn can remain synchronous
+) {
+  var cache_index = tx_pub_key + ':' + public_address + ':' + out_index
+  const cached__key_image = mutable_keyImagesByCacheKey[cache_index]
+  if (
+    typeof cached__key_image !== 'undefined' &&
+		cached__key_image !== null
+  ) {
+    return cached__key_image
+  }
+  var key_image = await coreBridge_instance.generateKeyImage(
+    tx_pub_key,
+    view_key__private,
+    spend_key__public,
+    spend_key__private,
+    out_index
+  )
+  // cache:
+  mutable_keyImagesByCacheKey[cache_index] = key_image
+  //
+  return key_image
+}
+exports.Lazy_KeyImage = Lazy_KeyImage