edge-currency-plugins 1.1.2 → 1.1.3

package/lib/common/plugin/makeCurrencyTools.js

@@ -9,6 +9,7 @@ var _cleaners = require('cleaners');
 
 
 
+
 var _urijs = require('uri-js'); var uri = _interopRequireWildcard(_urijs);
 var _urlparse = require('url-parse'); var _urlparse2 = _interopRequireDefault(_urlparse);
 
@@ -80,6 +81,10 @@ var _utils3 = require('./utils');
       return wasCurrencyPrivateKey(privateKey)
     },
 
+    async validateMemo(memo) {
+      return _utils.validateMemo.call(void 0, memo)
+    },
+
     async derivePublicKey(walletInfo) {
       const numbWalletInfo = asCurrencyNumbWalletInfo(walletInfo)
       return numbWalletInfo.keys.publicKey

package/lib/common/utxobased/engine/makeUtxoEngine.js

@@ -297,7 +297,10 @@ var _utils = require('./utils');
       let targets = []
       const ourReceiveAddresses = []
       for (const target of spendTargets) {
-        if (target.publicAddress == null || target.nativeAmount == null) {
+        if (
+          target.memo == null &&
+          (target.publicAddress == null || target.nativeAmount == null)
+        ) {
           throw new Error('Invalid spend target')
         }
 
@@ -311,19 +314,29 @@ var _utils = require('./utils');
             )
             targets.push({
               address: publicAddress,
-              value: parseInt(target.nativeAmount)
+              value:
+                target.nativeAmount == null
+                  ? undefined
+                  : parseInt(target.nativeAmount),
+              memo: target.memo
             })
           }
         } else {
-          const scriptPubkey = walletTools.addressToScriptPubkey(
-            target.publicAddress
-          )
-          if (processor.fetchAddress(scriptPubkey) != null) {
-            ourReceiveAddresses.push(target.publicAddress)
+          if (target.publicAddress != null) {
+            const scriptPubkey = walletTools.addressToScriptPubkey(
+              target.publicAddress
+            )
+            if (processor.fetchAddress(scriptPubkey) != null) {
+              ourReceiveAddresses.push(target.publicAddress)
+            }
           }
           targets.push({
             address: target.publicAddress,
-            value: parseInt(target.nativeAmount)
+            value:
+              target.nativeAmount == null
+                ? undefined
+                : parseInt(target.nativeAmount),
+            memo: target.memo
           })
         }
       }
@@ -374,7 +387,7 @@ var _utils = require('./utils');
       log.warn(`spend: Using fee rate ${feeRate} sat/B`)
       const subtractFee =
         _optionalChain([options, 'optionalAccess', _12 => _12.subtractFee]) != null ? options.subtractFee : false
-      const tx = await _keymanager.makeTx.call(void 0, {
+      const tx = _keymanager.makeTx.call(void 0, {
         utxos,
         forceUseUtxo: maxUtxo != null ? [maxUtxo] : [],
         targets,

package/lib/common/utxobased/engine/utils.js

@@ -35,6 +35,19 @@ var _keymanager = require('../keymanager/keymanager');
   }
 }; exports.getCurrencyFormatFromPurposeType = getCurrencyFormatFromPurposeType
 
+// Expect memo to be a hex string
+ const validateMemo = (memo) => {
+  const result = {
+    passed: true,
+    tooLarge: false
+  }
+  if (Math.ceil(memo.length / 2) > 80) {
+    result.passed = false
+    result.tooLarge = true
+  }
+  return result
+}; exports.validateMemo = validateMemo
+
  const getAddressTypeFromKeys = (
   privateKey
 ) => {

package/lib/common/utxobased/keymanager/keymanager.js

@@ -10,6 +10,7 @@ var _indexAtProtected = require('../../../util/indexAtProtected');
 var _undefinedIfEmptyString = require('../../../util/undefinedIfEmptyString');
 
 
+var _utils = require('../engine/utils');
 
 var _bip69 = require('./bip69');
 
@@ -230,6 +231,7 @@ var VerifyAddressEnum; (function (VerifyAddressEnum) {
 
 
 
+
 
 
  function bip43PurposeNumberToTypeEnum(
@@ -825,7 +827,7 @@ const wifToPrivateKeyInternal = (
     .toString('base64')
 } exports.signMessageBase64 = signMessageBase64;
 
- async function makeTx(args) {
+ function makeTx(args) {
   let sequence = 0xffffffff
   if (args.setRBF) {
     sequence -= 2
@@ -903,16 +905,36 @@ const wifToPrivateKeyInternal = (
     if (!forceUsage) mappedUtxos.push(input)
   }
 
-  const targets = args.targets.map(target => {
-    const script = exports.addressToScriptPubkey.call(void 0, {
-      address: target.address,
-      coin: coin.name
-    })
-    return {
-      script,
-      value: target.value
+  const targets = []
+  for (const target of args.targets) {
+    if (target.address != null && target.value != null) {
+      const script = exports.addressToScriptPubkey.call(void 0, {
+        address: target.address,
+        coin: coin.name
+      })
+      targets.push({
+        script,
+        value: target.value
+      })
     }
-  })
+
+    if (target.memo != null) {
+      const memoHex = Buffer.from(target.memo, 'utf8').toString('hex')
+      // check if hex string is within 80 bytes
+      const validatedMemo = _utils.validateMemo.call(void 0, memoHex)
+      if (!validatedMemo.passed) {
+        throw new Error('Memo size exceeds 80 bytes')
+      }
+      const script = bitcoin.script
+        .compile([bitcoin.opcodes.OP_RETURN, Buffer.from(target.memo, 'utf8')])
+        .toString('hex')
+      targets.push({
+        script,
+        value: 0
+      })
+    }
+  }
+
   const changeScript = exports.addressToScriptPubkey.call(void 0, {
     address: args.freshChangeAddress,
     coin: coin.name

package/lib/src/common/utxobased/engine/utils.d.ts

@@ -1,11 +1,12 @@
 import { Disklet } from 'disklet';
-import { EdgeParsedUri } from 'edge-core-js/types';
+import { EdgeMemoRules, EdgeParsedUri } from 'edge-core-js/types';
 import { CurrencyFormat } from '../../plugin/types';
 import { IUTXO } from '../db/types';
 import { ScriptTemplates } from '../info/scriptTemplates/types';
 import { PrivateKey } from '../keymanager/cleaners';
 import { AddressTypeEnum, BIP43PurposeTypeEnum, ScriptTypeEnum } from '../keymanager/keymanager';
 export declare const getCurrencyFormatFromPurposeType: (purpose: BIP43PurposeTypeEnum) => CurrencyFormat;
+export declare const validateMemo: (memo: string) => EdgeMemoRules;
 export declare const getAddressTypeFromKeys: (privateKey: PrivateKey) => AddressTypeEnum;
 export declare const getAddressTypeFromPurposeType: (purpose: BIP43PurposeTypeEnum) => AddressTypeEnum;
 export declare const getScriptTypeFromPurposeType: (purpose: BIP43PurposeTypeEnum, redeemScript?: string | undefined, scriptTemplates?: ScriptTemplates | undefined) => ScriptTypeEnum;

package/lib/src/common/utxobased/keymanager/keymanager.d.ts

@@ -133,8 +133,9 @@ export interface MakeTxArgs {
     subtractFee?: boolean;
 }
 export interface MakeTxTarget {
-    address: string;
-    value: number;
+    address?: string;
+    value?: number;
+    memo?: string | null;
 }
 interface MakeTxReturn extends Required<utxopicker.UtxoPickerResult> {
     hex: string;
@@ -194,6 +195,6 @@ export declare function privateKeyToWIF(args: PrivateKeyToWIFArgs): string;
 export declare const wifToPrivateKey: (args: WIFToPrivateKeyArgs) => string;
 export declare function privateKeyToPubkey(privateKey: string): string;
 export declare function signMessageBase64(message: string, privateKey: string): string;
-export declare function makeTx(args: MakeTxArgs): Promise<MakeTxReturn>;
+export declare function makeTx(args: MakeTxArgs): MakeTxReturn;
 export declare function signTx(args: SignTxArgs): Promise<SignTxReturn>;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "edge-currency-plugins",
-  "version": "1.1.2",
+  "version": "1.1.3",
   "description": "Edge currency plugins to fetch and process wallet accounts, balances and transactions.",
   "repository": "https://github.com/EdgeApp/edge-currency-plugins",
   "license": "MIT",