@bitpay-labs/bitcore-wallet-service 11.10.9 → 11.10.11

package/README.md

@@ -23,7 +23,7 @@ More about BWS at https://blog.bitpay.com/announcing-the-bitcore-wallet-suite/
 ```sh
 git clone https://github.com/bitpay/bitcore.git
 cd bitcore
-npm install
+npm ci
 npm run bws
 ```
 
@@ -86,9 +86,6 @@ There are plenty examples of creating and sending proposals in the `/test/integr
 - copay running on port: 8100
 - bitcoin-core running on regtest mode (blue icon logo)
 
-> mongo topology crashes sometimes due to notifications being incompatible in a web browser
-> **bitcore-wallet-service/lib/notificationbroadcaster.js**
-> Note: If testing on a PC browser, comment out notificationbroadcaster.js to disable notifications.
 
 ### Steps:
 

package/package.json

@@ -2,7 +2,7 @@
   "name": "@bitpay-labs/bitcore-wallet-service",
   "description": "A service for Mutisig HD Bitcoin Wallets",
   "author": "BitPay Inc",
-  "version": "11.10.9",
+  "version": "11.10.11",
   "license": "MIT",
   "main": "ts_build/src/index.js",
   "types": "./ts_build/src/index.d.ts",
@@ -42,8 +42,8 @@
   },
   "dependencies": {
     "@bitpay-labs/bitcore-logging": "^11.10.9",
-    "@bitpay-labs/bitcore-tss": "^11.10.9",
-    "@bitpay-labs/crypto-wallet-core": "^11.10.9",
+    "@bitpay-labs/bitcore-tss": "^11.10.11",
+    "@bitpay-labs/crypto-wallet-core": "^11.10.11",
     "@sendgrid/mail": "6.5.4",
     "abi-decoder": "2.4.0",
     "async": "0.9.2",
@@ -107,5 +107,5 @@
       "email": "kjoseph@bitpay.com"
     }
   ],
-  "gitHead": "9fa63bb66aeab5024220c14c428345f8ae946f7c"
+  "gitHead": "10bcfcf7cc6953e2af65d707b35d3e65e1254583"
 }

package/src/externalservices/simplex.ts

@@ -32,6 +32,18 @@ export class SimplexService {
     return keys;
   }
 
+  private simplexGetUserIp(req): string {
+    const isWebContext = req.body?.context === 'web';
+    let userIp = (isWebContext && req.body.deviceIp) || Utils.getIpFromReq(req);
+    delete req.body.deviceIp;
+    if (userIp) {
+      // Canonicalize IPv4-mapped IPv6 (dual-stack sockets report IPv4 clients as
+      // ::ffff:1.2.3.4) so Simplex sees a plain IPv4 address.
+      userIp = String(userIp).trim().replace(/^::ffff:/i, '');
+    }
+    return userIp || '';
+  }
+
   simplexGetCurrencies(req): Promise<any> {
     return new Promise((resolve, reject) => {
       const keys = this.simplexGetKeys(req);
@@ -63,11 +75,11 @@ export class SimplexService {
 
   simplexGetQuote(req): Promise<any> {
     return new Promise((resolve, reject) => {
+      const ip = this.simplexGetUserIp(req);
       const keys = this.simplexGetKeys(req);
 
       const API = keys.API;
       const API_KEY = keys.API_KEY;
-      const ip = Utils.getIpFromReq(req);
 
       req.body.client_ip = ip;
       req.body.wallet_id = keys.APP_PROVIDER_ID;
@@ -147,6 +159,7 @@ export class SimplexService {
 
   simplexPaymentRequest(req): Promise<any> {
     return new Promise((resolve, reject) => {
+      const ip = this.simplexGetUserIp(req);
       const keys = this.simplexGetKeys(req);
 
       const API = keys.API;
@@ -155,7 +168,6 @@ export class SimplexService {
       const paymentId = Uuid.v4();
       const orderId = Uuid.v4();
       const apiHost = keys.API;
-      const ip = Utils.getIpFromReq(req);
 
       if (
         !checkRequired(req.body, ['account_details', 'transaction_details']) &&
@@ -278,4 +290,4 @@ export class SimplexService {
       );
     });
   }
-}
+}

package/src/lib/blockchainexplorers/v8/client.ts

@@ -61,6 +61,20 @@ export class Client {
     });
   }
 
+  async getBalanceAtTime(params) {
+    const { payload, pubKey, time, tokenAddress } = params;
+    let url = `${this.baseUrl}/wallet/${pubKey}/balance/${encodeURIComponent(time)}`;
+    if (tokenAddress) {
+      url += `?tokenAddress=${encodeURIComponent(tokenAddress)}`;
+    }
+    const signature = this.sign({ method: 'GET', url, payload });
+    return request.get(url, {
+      headers: { 'x-signature': signature },
+      body: payload,
+      json: true
+    });
+  }
+
   async getCheckData(params) {
     const { payload, pubKey } = params;
     const url = `${this.baseUrl}/wallet/${pubKey}/check`;

package/src/lib/blockchainexplorers/v8.ts

@@ -178,6 +178,17 @@ export class V8 {
       .catch(cb);
   }
 
+  async getBalanceAtTime(wallet: WalletWithOpts, time: string, cb) {
+    const client = this._getAuthClient(wallet);
+    const { tokenAddress } = wallet;
+    client
+      .getBalanceAtTime({ pubKey: wallet.beAuthPublicKey2, payload: {}, time, tokenAddress })
+      .then(ret => {
+        return cb(null, ret);
+      })
+      .catch(cb);
+  }
+
   getConnectionInfo() {
     return 'V8 (' + this.chain + '/' + this.v8network + ') @ ' + this.host;
   }
@@ -788,4 +799,4 @@ export class V8 {
 
 const getPerformanceKey = (name: string) => {
   return name + '-' + crypto.randomBytes(5).toString('hex');
-};
+};

package/src/lib/messagebroker.ts

@@ -2,10 +2,12 @@ import { EventEmitter } from 'events';
 import * as io from 'socket.io-client';
 import 'source-map-support/register';
 import logger from './logger';
+import type { Notification } from './model/notification';
 
 export class MessageBroker extends EventEmitter {
-  remote: boolean;
+  remote: boolean = false;
   mq: io.Socket;
+
   constructor(opts) {
     super();
 
@@ -28,7 +30,7 @@ export class MessageBroker extends EventEmitter {
     }
   }
 
-  send(data) {
+  send(data: Notification) {
     if (this.remote) {
       this.mq.emit('msg', data);
     } else {
@@ -36,7 +38,11 @@ export class MessageBroker extends EventEmitter {
     }
   }
 
-  onMessage(handler) {
+  onMessage(handler: (data: Notification) => void) {
     this.on('msg', handler);
   }
+
+  offMessage(handler: (data: Notification) => void) {
+    this.off('msg', handler);
+  }
 }

package/src/lib/model/notification.ts

@@ -24,7 +24,7 @@
 export interface INotification {
   version: string;
   createdOn: number;
-  id: number;
+  id: string | number;
   type: string;
   data: any;
   walletId: string;
@@ -32,7 +32,7 @@ export interface INotification {
   isCreator: boolean;
 }
 
-export class Notification {
+export class Notification implements INotification {
   version: string;
   createdOn: number;
   id: string | number;

package/src/lib/routes/helpers/error.ts

@@ -13,6 +13,7 @@ export class ApiErrorHelper {
   returnError(err: any, res: express.Response, req: express.Request): void {
     // make sure headers have not been sent as this leads to an uncaught error
     if (res.headersSent) {
+      res.end();
       return;
     }
     if (err instanceof ClientError) {

package/src/lib/routes/tss.ts

@@ -37,17 +37,40 @@ export class TssRouter {
     });
 
     router.get('/v1/tss/keygen/:id/:round', authTssRequest(), async function(req, res) {
+      let interval: NodeJS.Timeout;
       try {
+        const abort = new AbortController();
+        res.on('close', () => { clearInterval(interval); abort.abort(); });
+
         const { id, round } = req.params as { [key: string]: string };
+        const { maxWaitTime } = req.query as { [key: string]: string };
         const copayerId = req.headers['x-identity'];
         if (round === 'secret') {
           const secret = await TssKeyGen.getBwsJoinSecret({ id, copayerId });
           return res.json({ secret });
         }
-        const { messages, publicKey } = await TssKeyGen.getMessagesForParty({ id, round: parseInt(round), copayerId });
-        return res.json({ messages, publicKey });
+
+        // Validate access and fetch session before committing to a streaming response, so that errors like
+        //   "session not found" or "not a participant" can still be returned with a proper
+        //   HTTP status instead of silently becoming an empty 200 (see below).
+        const session = await TssKeyGen.getSessionForCopayer({ id, copayerId });
+
+        if (abort.signal.aborted || res.closed) {
+          return; // Connection closed by client, stop processing
+        }
+
+        // Keep the connection alive while waiting for the change stream to return a result.
+        // Headers must be finalized before writing the first heartbeat byte.
+        // Flush ensures the heartbeat is sent immediately to keep the connection alive.
+        res.writeHead(200, { 'Content-Type': 'application/json' });
+        interval = setInterval(() => { res.write('\n'); res.flush(); }, 1000);
+
+        const { messages, publicKey } = await TssKeyGen.getMessagesForParty({ session, round: parseInt(round), copayerId, maxWaitTimeSec: parseInt(maxWaitTime), abortSignal: abort.signal });
+        return res.end(JSON.stringify({ messages, publicKey }));
       } catch (err) {
         return returnError(err ?? 'unknown', res, req);
+      } finally {
+        clearInterval(interval);
       }
     });
 
@@ -104,13 +127,37 @@ export class TssRouter {
     });
 
     router.get('/v1/tss/sign/:id/:round', authTssRequest(), async function(req, res) {
+      let interval: NodeJS.Timeout;
       try {
+        const abort = new AbortController();
+        res.on('close', () => { clearInterval(interval); abort.abort(); });
+
         const { id, round } = req.params as { [key: string]: string };
+        const { maxWaitTime } = req.query as { [key: string]: string };
         const copayerId = req.headers['x-identity'];
-        const { messages, signature, participants } = await TssSign.getMessagesForParty({ id, round: parseInt(round), copayerId });
-        return res.json({ messages, signature, participants });
+
+        // Validate access and fetch session before committing to a streaming response, so that errors like
+        //   "session not found" or "not a participant" can still be returned with a proper
+        //   HTTP status instead of silently becoming an empty 200 (see below).
+        const session = await TssSign.getSessionForCopayer({ id, copayerId });
+        
+        if (abort.signal.aborted || res.closed) {
+          return; // Connection closed by client, stop processing
+        }
+
+        // Keep the connection alive while waiting for the change stream to return a result.
+        // Headers must be finalized before writing the first heartbeat byte.
+        // Flush ensures the heartbeat is sent immediately to keep the connection alive.
+        res.writeHead(200, { 'Content-Type': 'application/json' });
+        interval = setInterval(() => { res.write('\n'); res.flush(); }, 1000);
+
+        const { messages, signature, participants } = await TssSign.getMessagesForParty({ session, round: parseInt(round), copayerId, maxWaitTimeSec: parseInt(maxWaitTime), abortSignal: abort.signal });
+        clearInterval(interval);
+        return res.end(JSON.stringify({ messages, signature, participants }));
       } catch (err) {
         return returnError(err ?? 'unknown', res, req);
+      } finally {
+        clearInterval(interval);
       }
     });
 

package/src/lib/routes/walletdata.ts

@@ -108,6 +108,17 @@ export function registerWalletDataRoutes(router: express.Router, context: RouteC
     });
   });
 
+  router.get('/v1/balance/:time/', (req, res) => {
+    getServerWithAuth(req, res, server => {
+      const opts: { time: string; tokenAddress?: string } = { time: req.params.time };
+      if (req.query.tokenAddress) opts.tokenAddress = req.query.tokenAddress as string;
+      server.getBalanceAtTime(opts, (err, balance) => {
+        if (err) return returnError(err, res, req);
+        res.json(balance);
+      });
+    });
+  });
+
   router.get('/v1/sendmaxinfo/', (req, res) => {
     getServerWithAuth(req, res, server => {
       const query = req.query;

package/src/lib/server.ts

@@ -326,12 +326,9 @@ export class WalletService implements IWalletService {
     );
   }
 
-  static handleIncomingNotifications(notification, cb) {
-    cb = cb || function() { };
-
+  static handleIncomingNotifications(_notification: INotification) {
     // do nothing here....
     // bc height cache is cleared on bcmonitor
-    return cb();
   }
 
   static shutDown(cb) {
@@ -474,6 +471,13 @@ export class WalletService implements IWalletService {
     return storage;
   }
 
+  static getMessageBroker() {
+    if (!initialized) {
+      throw new Error('Message broker requested before server was initialized');
+    }
+    return messageBroker;
+  }
+
   _runLocked(cb, task, waitTime?: number) {
     $.checkState(this.walletId, 'Failed state: this.walletId undefined at <_runLocked()>');
     this.lock.runLocked(this.walletId, { waitTime }, cb, task);
@@ -1152,7 +1156,7 @@ export class WalletService implements IWalletService {
         try {
           const isValid = this._verifyRequestPubKey(opts.requestPubKey, opts.signature, target.xPubKey);
           if (!isValid) return cb(Errors.NOT_AUTHORIZED);
-        } catch (e) {
+        } catch {
           return cb(Errors.NOT_AUTHORIZED);
         }
 
@@ -2088,6 +2092,44 @@ export class WalletService implements IWalletService {
     });
   }
 
+  /**
+   * Get wallet balance at a specific time.
+   * @param {Object} opts
+   * @param {string} opts.time - Date or time accepted by the bitcore-node API.
+   * @returns {Object} balance - The chain-state provider balance at the requested time.
+   */
+  getBalanceAtTime(opts, cb) {
+    opts = opts || {};
+    if (!opts.time) {
+      return cb(new ClientError('time is required in getBalanceAtTime'));
+    }
+    let wallet = opts.wallet;
+
+    const setWallet = cb1 => {
+      if (wallet) return cb1();
+      this.getWallet({}, (err, ret) => {
+        if (err) return cb(err);
+        wallet = ret;
+        return cb1(null, wallet);
+      });
+    };
+
+    setWallet(() => {
+      if (!wallet.isComplete()) {
+        return cb(null, { confirmed: 0, unconfirmed: 0, balance: 0 });
+      }
+
+      this.syncWallet(wallet, err => {
+        if (err) return cb(err);
+        const bc = this._getBlockchainExplorer(wallet.chain, wallet.network);
+        if (!bc) {
+          return cb(new Error('Could not get blockchain explorer instance'));
+        }
+        return bc.getBalanceAtTime({ ...wallet, tokenAddress: opts.tokenAddress }, opts.time, cb);
+      });
+    });
+  }
+
   /**
    * Return info needed to send all funds in the wallet
    * @param {Object} opts
@@ -3857,7 +3899,7 @@ export class WalletService implements IWalletService {
           const notifications = res
             .flat()
             .map((n: INotification) => ({ ...n, walletId: this.walletId }))
-            .sort((a, b) => a.id - b.id);
+            .sort((a, b) => a.id?.toString()?.localeCompare(b.id?.toString()));
 
           return cb(null, notifications);
         }

package/src/lib/storage.ts

@@ -1,6 +1,5 @@
 import * as async from 'async';
 import _ from 'lodash';
-import { Db } from 'mongodb';
 import * as mongodb from 'mongodb';
 import preconditions from 'preconditions';
 import { BCHAddressTranslator } from './bchaddresstranslator'; // only for migration
@@ -19,8 +18,11 @@ import {
   TxProposal,
   Wallet
 } from './model';
-import { ITssKeyMessageObject, TssKeyGenModel } from './model/tsskeygen';
-import { ITssSigMessageObject, TssSigGenModel } from './model/tsssign';
+import { TssKeyGenModel } from './model/tsskeygen';
+import { TssSigGenModel } from './model/tsssign';
+import type { ITssKeyMessageObject } from './model/tsskeygen';
+import type { ITssSigMessageObject } from './model/tsssign';
+import type { Db } from 'mongodb';
 
 const $ = preconditions.singleton();