edge-currency-plugins 3.2.0 → 3.3.0

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

@@ -25,11 +25,11 @@ var _EngineEmitter = require('../../plugin/EngineEmitter');
 var _Metadata = require('../../plugin/Metadata');
 
 var _upgradeMemos = require('../../upgradeMemos');
+var _DataLayer = require('../db/DataLayer');
 
 
 
-var _ProcessorTransaction = require('../db/Models/ProcessorTransaction');
-var _Processor = require('../db/Processor');
+var _TransactionData = require('../db/Models/TransactionData');
 
 var _utxo = require('../db/util/utxo');
 
@@ -61,7 +61,10 @@ var _getOwnUtxosFromTx = require('./util/getOwnUtxosFromTx');
 
 
 var _utils3 = require('./utils');
-var _UtxoEngineState = require('./UtxoEngineState');
+
+
+
+var _UtxoEngineProcessor = require('./UtxoEngineProcessor');
 var _UtxoWalletTools = require('./UtxoWalletTools');
 
  async function makeUtxoEngine(
@@ -125,14 +128,14 @@ var _UtxoWalletTools = require('./UtxoWalletTools');
     emitter,
     log
   })
-  const processor = await _Processor.makeProcessor.call(void 0, {
+  const dataLayer = await _DataLayer.makeDataLayer.call(void 0, {
     disklet: walletLocalDisklet
   })
-  const engineState = _UtxoEngineState.makeUtxoEngineState.call(void 0, {
+  const engineProcessor = _UtxoEngineProcessor.makeUtxoEngineProcessor.call(void 0, {
     ...config,
     walletTools,
     walletInfo,
-    processor,
+    dataLayer,
     pluginState
   })
 
@@ -145,9 +148,9 @@ var _UtxoWalletTools = require('./UtxoWalletTools');
       if (privateKeyFormat === 'bip32' || privateKeyFormat === 'bip44')
         return null
 
-      // Get the replaced transaction from the processor:
+      // Get the replaced transaction from the DataLayer:
       const replacedTxid = edgeTx.txid
-      const [replacedTx] = await processor.fetchTransactions({
+      const [replacedTx] = await dataLayer.fetchTransactions({
         txId: replacedTxid
       })
 
@@ -165,11 +168,11 @@ var _UtxoWalletTools = require('./UtxoWalletTools');
       const newFeeRate = Math.round((parseInt(replacedTx.fees) / vBytes) * 2)
 
       const replacedTxInputs = replacedTx.inputs
-      // Recreate UTXOs from processor transaction and mark them as unspent:
+      // Recreate UTXOs from DataLayer transaction and mark them as unspent:
       const replacedTxUtxos = await Promise.all(
         replacedTxInputs.map(async (_, index) => {
-          const utxo = await _utxo.utxoFromProcessorTransactionInput.call(void 0, 
-            processor,
+          const utxo = await _utxo.utxoFromTransactionDataInput.call(void 0, 
+            dataLayer,
             replacedTx,
             index
           )
@@ -189,7 +192,7 @@ var _UtxoWalletTools = require('./UtxoWalletTools');
       let foundChangeAddress
       for (const output of replacedTx.outputs) {
         // Fetch address by output's scriptPubkey to determine output ownership
-        const ourAddress = await processor.fetchAddress(output.scriptPubkey)
+        const ourAddress = await dataLayer.fetchAddress(output.scriptPubkey)
 
         // This isn't our output, so include it as a target
         if (ourAddress == null) {
@@ -235,14 +238,14 @@ var _UtxoWalletTools = require('./UtxoWalletTools');
       // Use the found change address or generate a new one:
       const freshAddress =
         foundChangeAddress == null
-          ? await engineState.getFreshAddress({ branch: 1 })
+          ? await engineProcessor.getFreshAddress({ branch: 1 })
           : { publicAddress: foundChangeAddress }
       const freshChangeAddress =
         _nullishCoalesce(freshAddress.segwitAddress, () => ( freshAddress.publicAddress))
 
       // Get all current UTXOs:
       const currentUtxos = _filterUndefined.filterUndefined.call(void 0, 
-        await processor.fetchUtxos({
+        await dataLayer.fetchUtxos({
           utxoIds: []
         })
       )
@@ -305,7 +308,7 @@ var _UtxoWalletTools = require('./UtxoWalletTools');
       let nativeAmount = '0'
       for (const output of newTx.outputs) {
         const scriptPubkey = output.scriptPubkey.toString('hex')
-        const own = await processor.fetchAddress(scriptPubkey)
+        const own = await dataLayer.fetchAddress(scriptPubkey)
         if (own == null) {
           // Not our output
           nativeAmount = bs.sub(nativeAmount, output.value.toString())
@@ -357,15 +360,15 @@ var _UtxoWalletTools = require('./UtxoWalletTools');
         metadata.state.balance
       )
 
-      pluginState.addEngine(engineState)
+      pluginState.addEngine(engineProcessor)
       await fees.start()
-      await engineState.start()
+      await engineProcessor.start()
     },
 
     async killEngine() {
-      await engineState.stop()
+      await engineProcessor.stop()
       fees.stop()
-      pluginState.removeEngine(engineState)
+      pluginState.removeEngine(engineProcessor)
     },
 
     getBalance(_opts) {
@@ -381,7 +384,7 @@ var _UtxoWalletTools = require('./UtxoWalletTools');
     },
 
     async addGapLimitAddresses(addresses) {
-      return await engineState.addGapLimitAddresses(addresses)
+      return await engineProcessor.addGapLimitAddresses(addresses)
     },
 
     async broadcastTx(transaction) {
@@ -401,7 +404,7 @@ var _UtxoWalletTools = require('./UtxoWalletTools');
           )
         }
       }
-      const id = await engineState.broadcastTx(transaction).catch(err => {
+      const id = await engineProcessor.broadcastTx(transaction).catch(err => {
         if (String(err).includes('Error: Blockbook Error: -26: dust')) {
           throw new (0, _edgecorejs.DustSpendError)()
         }
@@ -432,7 +435,7 @@ var _UtxoWalletTools = require('./UtxoWalletTools');
             walletFormats
           },
           metadataState: metadata.state,
-          processorState: await processor.dumpData(),
+          storageState: await dataLayer.dumpData(),
           pluginState: pluginState.dumpData()
         }
       }
@@ -461,11 +464,11 @@ var _UtxoWalletTools = require('./UtxoWalletTools');
       opts
     ) {
       const { forceIndex } = opts
-      return await engineState.getFreshAddress({ forceIndex })
+      return await engineProcessor.getFreshAddress({ forceIndex })
     },
 
     getNumTransactions(_opts) {
-      return processor.numTransactions()
+      return dataLayer.numTransactions()
     },
 
     async getPaymentProtocolInfo(
@@ -482,16 +485,16 @@ var _UtxoWalletTools = require('./UtxoWalletTools');
       options
     ) {
       const txs = _filterUndefined.filterUndefined.call(void 0, 
-        await processor.fetchTransactions({ options })
+        await dataLayer.fetchTransactions({ options })
       )
       return await Promise.all(
         txs.map(
           async (tx) =>
-            await _ProcessorTransaction.toEdgeTransaction.call(void 0, {
+            await _TransactionData.toEdgeTransaction.call(void 0, {
               walletId: walletInfo.id,
               tx,
               walletTools,
-              processor,
+              dataLayer,
               pluginInfo
             })
         )
@@ -500,7 +503,7 @@ var _UtxoWalletTools = require('./UtxoWalletTools');
 
     async isAddressUsed(address) {
       const scriptPubkey = walletTools.addressToScriptPubkey(address)
-      const addressData = await processor.fetchAddress(scriptPubkey)
+      const addressData = await dataLayer.fetchAddress(scriptPubkey)
       if (addressData == null) throw new Error('Address not found in wallet')
       return addressData.used
     },
@@ -534,7 +537,7 @@ var _UtxoWalletTools = require('./UtxoWalletTools');
       const utxos =
         await _asyncNullishCoalesce(txOptions.utxos, async () => (
         _filterUndefined.filterUndefined.call(void 0, 
-          (await processor.fetchUtxos({
+          (await dataLayer.fetchUtxos({
             scriptPubkey: utxoScriptPubkey,
             utxoIds: []
           })) 
@@ -559,7 +562,7 @@ var _UtxoWalletTools = require('./UtxoWalletTools');
           const { script } = target.otherParams
           if (script.type === 'replayProtection') {
             // construct a replay protection p2sh address
-            const { publicAddress } = await engineState.deriveScriptAddress(
+            const { publicAddress } = await engineProcessor.deriveScriptAddress(
               script.type
             )
             targets.push({
@@ -575,7 +578,7 @@ var _UtxoWalletTools = require('./UtxoWalletTools');
             const scriptPubkey = walletTools.addressToScriptPubkey(
               target.publicAddress
             )
-            if ((await processor.fetchAddress(scriptPubkey)) != null) {
+            if ((await dataLayer.fetchAddress(scriptPubkey)) != null) {
               ourReceiveAddresses.push(target.publicAddress)
             }
           }
@@ -593,7 +596,7 @@ var _UtxoWalletTools = require('./UtxoWalletTools');
         throw new Error('Need to provide Spend Targets')
       }
 
-      const freshAddress = await engineState.getFreshAddress({ branch: 1 })
+      const freshAddress = await engineProcessor.getFreshAddress({ branch: 1 })
       const freshChangeAddress =
         _nullishCoalesce(_nullishCoalesce(forceChangeAddress, () => (
         freshAddress.segwitAddress)), () => (
@@ -603,13 +606,13 @@ var _UtxoWalletTools = require('./UtxoWalletTools');
 
       let maxUtxo
       if (txOptions.CPFP != null) {
-        const [childTx] = await processor.fetchTransactions({
+        const [childTx] = await dataLayer.fetchTransactions({
           txId: txOptions.CPFP
         })
         if (childTx == null) throw new Error('transaction not found')
         const utxos = []
         for (const txid of childTx.ourOuts) {
-          const [output] = await processor.fetchUtxos({ utxoIds: [txid] })
+          const [output] = await dataLayer.fetchUtxos({ utxoIds: [txid] })
           if (output != null) utxos.push(output)
         }
         maxUtxo = utxos.reduce((a, b) => (bs.gt(a.value, b.value) ? a : b))
@@ -651,7 +654,7 @@ var _UtxoWalletTools = require('./UtxoWalletTools');
       )
       for (const output of tx.outputs) {
         const scriptPubkey = output.scriptPubkey.toString('hex')
-        const own = await processor.fetchAddress(scriptPubkey)
+        const own = await dataLayer.fetchAddress(scriptPubkey)
         if (own == null) {
           // Not our output
           nativeAmount = bs.sub(nativeAmount, output.value.toString())
@@ -702,7 +705,7 @@ var _UtxoWalletTools = require('./UtxoWalletTools');
       await engine.killEngine()
 
       // Clear cache and state
-      await processor.clearAll()
+      await dataLayer.clearAll()
       await pluginState.clearCache()
       await metadata.clear()
       await fees.clearCache()
@@ -719,32 +722,32 @@ var _UtxoWalletTools = require('./UtxoWalletTools');
       const replacedTxid = _optionalChain([edgeTx, 'access', _9 => _9.otherParams, 'optionalAccess', _10 => _10.replacedTxid])
       if (replacedTxid != null) {
         // Get the replaced transaction using the replacedTxid
-        const [rbfTx] = await processor.fetchTransactions({
+        const [rbfTx] = await dataLayer.fetchTransactions({
           txId: replacedTxid
         })
         if (rbfTx != null) {
           rbfTx.blockHeight = -1
-          await _UtxoEngineState.transactionChanged.call(void 0, {
+          await _UtxoEngineProcessor.transactionChanged.call(void 0, {
             walletId: walletInfo.id,
             tx: rbfTx,
             pluginInfo,
             emitter,
             walletTools,
-            processor
+            dataLayer
           })
         }
       }
 
-      const tx = _ProcessorTransaction.fromEdgeTransaction.call(void 0, edgeTx)
-      await _UtxoEngineState.transactionChanged.call(void 0, {
+      const tx = _TransactionData.fromEdgeTransaction.call(void 0, edgeTx)
+      await _UtxoEngineProcessor.transactionChanged.call(void 0, {
         walletId: walletInfo.id,
         tx,
         pluginInfo,
         emitter,
         walletTools,
-        processor
+        dataLayer
       })
-      await processor.saveTransaction({
+      await dataLayer.saveTransaction({
         tx,
         scriptPubkeys: _optionalChain([edgeTx, 'access', _11 => _11.otherParams, 'optionalAccess', _12 => _12.ourScriptPubkeys])
       })
@@ -752,8 +755,8 @@ var _UtxoWalletTools = require('./UtxoWalletTools');
       /*
       Get the wallet's UTXOs from the new transaction and save them to the processsor.
       */
-      const ownUtxos = await _getOwnUtxosFromTx.getOwnUtxosFromTx.call(void 0, engineInfo, processor, tx)
-      await engineState.processUtxos(ownUtxos)
+      const ownUtxos = await _getOwnUtxosFromTx.getOwnUtxosFromTx.call(void 0, engineInfo, dataLayer, tx)
+      await engineProcessor.processUtxos(ownUtxos)
     },
 
     async signMessage(
@@ -764,9 +767,9 @@ var _UtxoWalletTools = require('./UtxoWalletTools');
       const otherParams = _types7.asUtxoSignMessageOtherParams.call(void 0, opts.otherParams)
       const { publicAddress } = otherParams
       const scriptPubkey = walletTools.addressToScriptPubkey(publicAddress)
-      const processorAddress = await processor.fetchAddress(scriptPubkey)
-      if (_optionalChain([processorAddress, 'optionalAccess', _13 => _13.path]) == null) {
-        throw new Error('Missing address to sign with')
+      const addressData = await dataLayer.fetchAddress(scriptPubkey)
+      if (_optionalChain([addressData, 'optionalAccess', _13 => _13.path]) == null) {
+        throw new Error('Missing data-layer address to sign with')
       }
       const privateKey = asMaybeCurrencyPrivateKey(privateKeys)
 
@@ -781,7 +784,7 @@ var _UtxoWalletTools = require('./UtxoWalletTools');
       })
 
       const signature = await walletTools.signMessageBase64({
-        path: _optionalChain([processorAddress, 'optionalAccess', _14 => _14.path]),
+        path: _optionalChain([addressData, 'optionalAccess', _14 => _14.path]),
         message,
         xprivKeys
       })
@@ -824,7 +827,7 @@ var _UtxoWalletTools = require('./UtxoWalletTools');
             psbt.inputs.map(async ({ hash, index: vout }) => {
               const txId = Buffer.from(hash).reverse().toString('hex')
 
-              const [transaction] = await processor.fetchTransactions({ txId })
+              const [transaction] = await dataLayer.fetchTransactions({ txId })
               if (transaction == null)
                 throw new Error(
                   'Unable to find previous transaction data for input'
@@ -838,7 +841,7 @@ var _UtxoWalletTools = require('./UtxoWalletTools');
 
               // Use the scriptPubkey to find the private key from the address
               // derivation path
-              const address = await processor.fetchAddress(scriptPubkey)
+              const address = await dataLayer.fetchAddress(scriptPubkey)
               if (address == null) {
                 throw new Error(
                   `Address for scriptPubkey '${scriptPubkey}' not found`
@@ -931,7 +934,7 @@ var _UtxoWalletTools = require('./UtxoWalletTools');
         log
       }
       const tmpMetadata = await _Metadata.makeMetadata.call(void 0, tmpConfig)
-      const tmpProcessor = await _Processor.makeProcessor.call(void 0, tmpConfig)
+      const tmpDataLayer = await _DataLayer.makeDataLayer.call(void 0, tmpConfig)
       const tmpWalletTools = _UtxoWalletTools.makeUtxoWalletTools.call(void 0, {
         pluginInfo,
         publicKey: tmpWalletInfo.keys.publicKey
@@ -943,7 +946,7 @@ var _UtxoWalletTools = require('./UtxoWalletTools');
           try {
             await tmpState.stop()
 
-            const tmpUtxos = (await tmpProcessor.fetchUtxos({
+            const tmpUtxos = (await tmpDataLayer.fetchUtxos({
               utxoIds: []
             })) 
             if (tmpUtxos === null || tmpUtxos.length < 1) {
@@ -967,7 +970,7 @@ var _UtxoWalletTools = require('./UtxoWalletTools');
         }
       })
 
-      const tmpState = _UtxoEngineState.makeUtxoEngineState.call(void 0, {
+      const tmpState = _UtxoEngineProcessor.makeUtxoEngineProcessor.call(void 0, {
         ...config,
         options: {
           ...config.options,
@@ -983,7 +986,7 @@ var _UtxoWalletTools = require('./UtxoWalletTools');
             gapLimit: 0
           }
         },
-        processor: tmpProcessor,
+        dataLayer: tmpDataLayer,
         walletTools: tmpWalletTools,
         walletInfo: tmpWalletInfo
       })