edge-currency-monero 1.3.0 → 1.3.2

package/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 # Unreleased
 
+# 1.3.2 (2024-11-19)
+
+- fixed: URI parsing and creation according to the correct format
+
+# 1.3.1 (2024-03-21)
+
+- fixed: Include missing files in the NPM package.
+
 # 1.3.0 (2024-03-21)
 
 - changed: Switch our codebase from Flow to TypeScript.

package/lib/MoneroTools.js

@@ -1,4 +1,4 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }var _biggystring = require('biggystring');
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } }var _biggystring = require('biggystring');
 
 
 
@@ -115,7 +115,10 @@ function getParameterByName(param, url) {
       throw new Error('InvalidPublicAddressError')
     }
 
-    const amountStr = getParameterByName('amount', uri)
+    // Prioritize the correct Monero URI format, while falling back to BIP21
+    // formats.
+    const amountStr =
+      _nullishCoalesce(getParameterByName('tx_amount', uri), () => ( getParameterByName('amount', uri)))
     if (amountStr != null) {
       const denom = getDenomInfo('XMR')
       if (denom == null) {
@@ -126,8 +129,12 @@ function getParameterByName(param, url) {
       currencyCode = 'XMR'
     }
     const uniqueIdentifier = getParameterByName('tx_payment_id', uri)
-    const label = getParameterByName('label', uri)
-    const message = getParameterByName('message', uri)
+    const label =
+      _nullishCoalesce(getParameterByName('recipient_name', uri), () => (
+      getParameterByName('label', uri)))
+    const message =
+      _nullishCoalesce(getParameterByName('tx_description', uri), () => (
+      getParameterByName('message', uri)))
     const category = getParameterByName('category', uri)
 
     const edgeParsedUri = {
@@ -184,13 +191,13 @@ function getParameterByName(param, url) {
         }
         const amount = _biggystring.div.call(void 0, nativeAmount, denom.multiplier, 12)
 
-        queryString += 'amount=' + amount + '&'
+        queryString += 'tx_amount=' + amount + '&'
       }
       if (typeof obj.label === 'string') {
-        queryString += 'label=' + obj.label + '&'
+        queryString += 'recipient_name=' + obj.label + '&'
       }
       if (typeof obj.message === 'string') {
-        queryString += 'message=' + obj.message + '&'
+        queryString += 'tx_description=' + obj.message + '&'
       }
       queryString = queryString.substr(0, queryString.length - 1)
 

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

package/lib/react-native/edge-currency-monero.ts

@@ -3460,6 +3460,8 @@ var MoneroTools = /*#__PURE__*/function () {
     key: "parseUri",
     value: function () {
       var _parseUri = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee3(uri) {
+        var _getParameterByName, _getParameterByName2, _getParameterByName3;
+
         var parsedUri, address, nativeAmount, currencyCode, amountStr, denom, uniqueIdentifier, label, message, category, edgeParsedUri;
         return regeneratorRuntime.wrap(function _callee3$(_context3) {
           while (1) {
@@ -3514,7 +3516,9 @@ var MoneroTools = /*#__PURE__*/function () {
                 throw new Error('InvalidPublicAddressError');
 
               case 21:
-                amountStr = getParameterByName('amount', uri);
+                // Prioritize the correct Monero URI format, while falling back to BIP21
+                // formats.
+                amountStr = (_getParameterByName = getParameterByName('tx_amount', uri)) !== null && _getParameterByName !== void 0 ? _getParameterByName : getParameterByName('amount', uri);
 
                 if (!(amountStr != null)) {
                   _context3.next = 29;
@@ -3537,8 +3541,8 @@ var MoneroTools = /*#__PURE__*/function () {
 
               case 29:
                 uniqueIdentifier = getParameterByName('tx_payment_id', uri);
-                label = getParameterByName('label', uri);
-                message = getParameterByName('message', uri);
+                label = (_getParameterByName2 = getParameterByName('recipient_name', uri)) !== null && _getParameterByName2 !== void 0 ? _getParameterByName2 : getParameterByName('label', uri);
+                message = (_getParameterByName3 = getParameterByName('tx_description', uri)) !== null && _getParameterByName3 !== void 0 ? _getParameterByName3 : getParameterByName('message', uri);
                 category = getParameterByName('category', uri);
                 edgeParsedUri = {
                   publicAddress: address
@@ -3647,15 +3651,15 @@ var MoneroTools = /*#__PURE__*/function () {
 
               case 21:
                 amount = (0,biggystring__WEBPACK_IMPORTED_MODULE_0__.div)(nativeAmount, denom.multiplier, 12);
-                queryString += 'amount=' + amount + '&';
+                queryString += 'tx_amount=' + amount + '&';
 
               case 23:
                 if (typeof obj.label === 'string') {
-                  queryString += 'label=' + obj.label + '&';
+                  queryString += 'recipient_name=' + obj.label + '&';
                 }
 
                 if (typeof obj.message === 'string') {
-                  queryString += 'message=' + obj.message + '&';
+                  queryString += 'tx_description=' + obj.message + '&';
                 }
 
                 queryString = queryString.substr(0, queryString.length - 1);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "edge-currency-monero",
-  "version": "1.3.0",
+  "version": "1.3.2",
   "description": "Edge Monero currency plugin",
   "homepage": "https://edge.app",
   "repository": {
@@ -21,7 +21,7 @@
     "README.md"
   ],
   "scripts": {
-    "build": "rimraf lib && sucrase ./src -q -d ./lib -t typescript,imports && webpack",
+    "build": "rimraf lib && sucrase ./src -d ./lib -q -t typescript,imports && cp src/mymonero-utils/*.js lib/mymonero-utils && webpack",
     "fix": "eslint . --fix && yarn-deduplicate",
     "lint": "eslint .",
     "precommit": "lint-staged && tsc && npm test && npm run build",