edge-currency-plugins 1.2.2 → 1.2.3

package/lib/common/plugin/makeMetadata.js

@@ -1,4 +1,4 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } else { var newObj = {}; if (obj != null) { for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { newObj[key] = obj[key]; } } } newObj.default = obj; return newObj; } } function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }var _biggystring = require('biggystring'); var bs = _interopRequireWildcard(_biggystring);
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }var _biggystring = require('biggystring');
 
 
 var _memlet = require('memlet');
@@ -6,6 +6,7 @@ var _memlet = require('memlet');
 var _awaitlock = require('../utxobased/engine/await-lock'); var _awaitlock2 = _interopRequireDefault(_awaitlock);
 var _makeEngineEmitter = require('./makeEngineEmitter');
 var _types3 = require('./types');
+var _utils = require('./utils');
 
 const metadataPath = `metadata.json`
 
@@ -19,6 +20,7 @@ const metadataPath = `metadata.json`
 
 
 
+
  const makeMetadata = async (
   config
 ) => {
@@ -27,11 +29,8 @@ const metadataPath = `metadata.json`
   const lock = new (0, _awaitlock2.default)()
 
   const instance = {
-    get balance() {
-      return cache.balance
-    },
-    get lastSeenBlockHeight() {
-      return cache.lastSeenBlockHeight
+    get state() {
+      return cache
     },
     clear: async () => {
       await memlet.delete(metadataPath)
@@ -40,18 +39,37 @@ const metadataPath = `metadata.json`
     }
   }
 
+  const updateWalletBalance = async (currencyCode) => {
+    const cumulativeBalance = Object.values(cache.addressBalances).reduce(
+      (sum, addressBalance) => _biggystring.add.call(void 0, sum, addressBalance),
+      '0'
+    )
+    cache.balance = cumulativeBalance
+    await setMetadata(cache)
+    emitter.emit(
+      _makeEngineEmitter.EngineEvent.WALLET_BALANCE_CHANGED,
+      currencyCode,
+      cumulativeBalance
+    )
+  }
+
   emitter.on(
     _makeEngineEmitter.EngineEvent.ADDRESS_BALANCE_CHANGED,
-    async (currencyCode, balanceDiff) => {
+    async (
+      currencyCode,
+      addressBalanceChanges
+    ) => {
       await lock.acquireAsync()
       try {
-        cache.balance = bs.add(cache.balance, balanceDiff)
-        emitter.emit(
-          _makeEngineEmitter.EngineEvent.WALLET_BALANCE_CHANGED,
-          currencyCode,
-          cache.balance
-        )
-        await setMetadata(cache)
+        addressBalanceChanges.forEach(({ scriptPubkey, balance }) => {
+          if (balance === '0') {
+            _utils.removeItem.call(void 0, cache.addressBalances, scriptPubkey)
+          } else {
+            cache.addressBalances[scriptPubkey] = balance
+          }
+        })
+
+        await updateWalletBalance(currencyCode)
       } catch (err) {
         log.error(err)
       } finally {
@@ -83,6 +101,7 @@ const metadataPath = `metadata.json`
   const resetMetadata = async () => {
     const data = {
       balance: '0',
+      addressBalances: {},
       lastSeenBlockHeight: 0
     }
     await memlet.setJson(metadataPath, data)

package/lib/common/plugin/types.js

@@ -167,5 +167,7 @@ var _cleaners = require('cleaners');
 
  const asLocalWalletMetadata = _cleaners.asObject.call(void 0, {
   balance: _cleaners.asString,
+  // scriptPubkey -> balance
+  addressBalances: _cleaners.asObject.call(void 0, _cleaners.asString),
   lastSeenBlockHeight: _cleaners.asNumber
 }); exports.asLocalWalletMetadata = asLocalWalletMetadata

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

@@ -124,7 +124,7 @@ var _utils = require('./utils');
       emitter.emit(
         _makeEngineEmitter.EngineEvent.WALLET_BALANCE_CHANGED,
         currencyInfo.currencyCode,
-        metadata.balance
+        metadata.state.balance
       )
 
       pluginState.addEngine(engineState)
@@ -139,11 +139,11 @@ var _utils = require('./utils');
     },
 
     getBalance(_opts) {
-      return metadata.balance
+      return metadata.state.balance
     },
 
     getBlockHeight() {
-      return metadata.lastSeenBlockHeight
+      return metadata.state.lastSeenBlockHeight
     },
 
     async addCustomToken(_token) {
@@ -196,6 +196,7 @@ var _utils = require('./utils');
             primaryFormat,
             walletFormats
           },
+          metadataState: metadata.state,
           processorState: await processor.dumpData(),
           pluginState: pluginState.dumpData()
         }
@@ -644,7 +645,7 @@ var _utils = require('./utils');
               throw new Error('Private key has no funds')
             }
             const destAddress = await this.getFreshAddress({})
-            const nativeAmount = tmpMetadata.balance
+            const nativeAmount = tmpMetadata.state.balance
             const options = { utxos: tmpUtxos, subtractFee: true }
             spendInfo.spendTargets = [
               { publicAddress: destAddress.publicAddress, nativeAmount }

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

@@ -258,6 +258,11 @@ var _utils3 = require('./utils');
   // processed by the processor. This happens only once before any call to
   // setLookAhead.
   const initializeAddressSubscriptions = async () => {
+    const addressBalanceChanges
+
+
+ = []
+
     for (const format of walletFormats) {
       const branches = _utils3.getFormatSupportedBranches.call(void 0, format)
       for (const branch of branches) {
@@ -289,6 +294,10 @@ var _utils3 = require('./utils');
             format
           })
           addressesToSubscribe.add(address)
+          addressBalanceChanges.push({
+            scriptPubkey: processorAddress.scriptPubkey,
+            balance: processorAddress.balance
+          })
         }
         addToAddressSubscribeCache(commonArgs.taskCache, addressesToSubscribe, {
           format,
@@ -296,6 +305,15 @@ var _utils3 = require('./utils');
         })
       }
     }
+
+    // Only emit address balance events after processing all initial addresses
+    // because we want to only propagate the wallet balance change event after
+    // initialization is complete.
+    emitter.emit(
+      _makeEngineEmitter.EngineEvent.ADDRESS_BALANCE_CHANGED,
+      pluginInfo.currencyInfo.currencyCode,
+      addressBalanceChanges
+    )
   }
 
   return {
@@ -1416,13 +1434,17 @@ const processProcessorUtxos = async (
   //
 
   // Address balance and emit address balance change event
-  const diff = _biggystring.sub.call(void 0, newBalance, oldBalance)
-  if (diff !== '0') {
-    log('balance changed:', { scriptPubkey, diff })
+  if (newBalance !== oldBalance) {
+    log('address balance changed:', { scriptPubkey, oldBalance, newBalance })
     emitter.emit(
       _makeEngineEmitter.EngineEvent.ADDRESS_BALANCE_CHANGED,
       currencyInfo.currencyCode,
-      diff
+      [
+        {
+          scriptPubkey,
+          balance: newBalance
+        }
+      ]
     )
 
     // Update balances for address that have this scriptPubkey

package/lib/src/common/plugin/makeEngineEmitter.d.ts

@@ -3,8 +3,14 @@ import { EdgeCurrencyEngineCallbacks, EdgeTransaction, EdgeTxidMap } from 'edge-
 import { EventEmitter } from 'events';
 import { SubscribeAddressResponse } from '../utxobased/network/BlockBookAPI';
 export declare interface EngineEmitter {
-    emit: ((event: EngineEvent.TRANSACTIONS_CHANGED, transactions: EdgeTransaction[]) => boolean) & ((event: EngineEvent.ADDRESS_BALANCE_CHANGED, currencyCode: string, nativeDiff: string) => boolean) & ((event: EngineEvent.WALLET_BALANCE_CHANGED, currencyCode: string, nativeBalance: string) => boolean) & ((event: EngineEvent.BLOCK_HEIGHT_CHANGED, uri: string, blockHeight: number) => boolean) & ((event: EngineEvent.NEW_ADDRESS_TRANSACTION, uri: string, newTx: SubscribeAddressResponse) => boolean) & ((event: EngineEvent.ADDRESSES_CHECKED, progressRatio: number) => boolean) & ((event: EngineEvent.TXIDS_CHANGED, txids: EdgeTxidMap) => boolean);
-    on: ((event: EngineEvent.TRANSACTIONS_CHANGED, listener: (transactions: EdgeTransaction[]) => Promise<void> | void) => this) & ((event: EngineEvent.ADDRESS_BALANCE_CHANGED, listener: (currencyCode: string, nativeDiff: string) => Promise<void> | void) => this) & ((event: EngineEvent.WALLET_BALANCE_CHANGED, listener: (currencyCode: string, nativeBalance: string) => Promise<void> | void) => this) & ((event: EngineEvent.BLOCK_HEIGHT_CHANGED, listener: (uri: string, blockHeight: number) => Promise<void> | void) => this) & ((event: EngineEvent.NEW_ADDRESS_TRANSACTION, listener: (uri: string, newTx: SubscribeAddressResponse) => Promise<void> | void) => this) & ((event: EngineEvent.ADDRESSES_CHECKED, listener: (progressRatio: number) => Promise<void> | void) => this) & ((event: EngineEvent.TXIDS_CHANGED, listener: (txids: EdgeTxidMap) => Promise<void> | void) => this);
+    emit: ((event: EngineEvent.TRANSACTIONS_CHANGED, transactions: EdgeTransaction[]) => boolean) & ((event: EngineEvent.ADDRESS_BALANCE_CHANGED, currencyCode: string, addressBalanceChanges: Array<{
+        scriptPubkey: string;
+        balance: string;
+    }>) => boolean) & ((event: EngineEvent.WALLET_BALANCE_CHANGED, currencyCode: string, nativeBalance: string) => boolean) & ((event: EngineEvent.BLOCK_HEIGHT_CHANGED, uri: string, blockHeight: number) => boolean) & ((event: EngineEvent.NEW_ADDRESS_TRANSACTION, uri: string, newTx: SubscribeAddressResponse) => boolean) & ((event: EngineEvent.ADDRESSES_CHECKED, progressRatio: number) => boolean) & ((event: EngineEvent.TXIDS_CHANGED, txids: EdgeTxidMap) => boolean);
+    on: ((event: EngineEvent.TRANSACTIONS_CHANGED, listener: (transactions: EdgeTransaction[]) => Promise<void> | void) => this) & ((event: EngineEvent.ADDRESS_BALANCE_CHANGED, listener: (currencyCode: string, addressBalanceChanges: Array<{
+        scriptPubkey: string;
+        balance: string;
+    }>) => Promise<void> | void) => this) & ((event: EngineEvent.WALLET_BALANCE_CHANGED, listener: (currencyCode: string, nativeBalance: string) => Promise<void> | void) => this) & ((event: EngineEvent.BLOCK_HEIGHT_CHANGED, listener: (uri: string, blockHeight: number) => Promise<void> | void) => this) & ((event: EngineEvent.NEW_ADDRESS_TRANSACTION, listener: (uri: string, newTx: SubscribeAddressResponse) => Promise<void> | void) => this) & ((event: EngineEvent.ADDRESSES_CHECKED, listener: (progressRatio: number) => Promise<void> | void) => this) & ((event: EngineEvent.TXIDS_CHANGED, listener: (txids: EdgeTxidMap) => Promise<void> | void) => this);
 }
 export declare class EngineEmitter extends EventEmitter {
 }

package/lib/src/common/plugin/makeMetadata.d.ts

@@ -7,7 +7,8 @@ interface MetadataConfig {
     emitter: EngineEmitter;
     log: EdgeLog;
 }
-export interface Metadata extends LocalWalletMetadata {
+export interface Metadata {
+    state: LocalWalletMetadata;
     clear: () => Promise<void>;
 }
 export declare const makeMetadata: (config: MetadataConfig) => Promise<Metadata>;

package/lib/src/common/plugin/types.d.ts

@@ -130,6 +130,9 @@ export interface EngineOptions extends EdgeCurrencyEngineOptions {
 export declare type LocalWalletMetadata = ReturnType<typeof asLocalWalletMetadata>;
 export declare const asLocalWalletMetadata: import("cleaners").ObjectCleaner<{
     balance: string;
+    addressBalances: {
+        [keys: string]: string;
+    };
     lastSeenBlockHeight: number;
 }>;
 export {};

package/package.json

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