refactor(sdk-api): replace bluebird with native promises

Ticket: DX-1130

TICKET: DX-1130

Author: Kevin Daniel

modules/sdk-api/package.json

@@ -47,7 +47,6 @@
     "@bitgo/utxo-lib": "^11.2.4",
     "@types/superagent": "4.1.15",
     "bitcoinjs-message": "npm:@bitgo-forks/[email protected]",
-    "bluebird": "^3.5.3",
     "debug": "3.1.0",
     "eol": "^0.5.0",
     "lodash": "^4.17.15",

modules/sdk-api/src/util.ts

@@ -5,3 +5,23 @@ export function getNetwork(network?: V1Network): utxolib.Network {
   network = network || common.getNetwork();
   return utxolib.networks[network];
 }
+
+/**
+ * A native Promise-based replacement for Bluebird.try
+ *
+ * This function executes the provided function and returns a Promise.
+ * If the function throws synchronously, the exception is caught and returned as a rejected Promise.
+ * If the function returns a Promise, that Promise is returned.
+ * If the function returns any other value, a resolved Promise with that value is returned.
+ *
+ * @param {Function} fn - The function to execute
+ * @returns {Promise<T>} A promise that resolves with the return value of fn or rejects with any error thrown
+ */
+export function tryPromise<T>(fn: () => T | Promise<T>): Promise<T> {
+  try {
+    const result = fn();
+    return Promise.resolve(result);
+  } catch (error) {
+    return Promise.reject(error);
+  }
+}

modules/sdk-api/src/v1/blockchain.ts

@@ -12,7 +12,6 @@
 // Copyright 2014, BitGo, Inc.  All Rights Reserved.
 //
 
-import Bluebird from 'bluebird';
 import _ from 'lodash';
 
 import { common } from '@bitgo/sdk-core';
@@ -37,7 +36,9 @@ Blockchain.prototype.getAddress = function (params, callback) {
   params = params || {};
   common.validateParams(params, ['address'], [], callback);
 
-  return Bluebird.resolve(this.bitgo.get(this.bitgo.url('/address/' + params.address)).result()).nodeify(callback);
+  return Promise.resolve(this.bitgo.get(this.bitgo.url('/address/' + params.address)).result())
+    .then(callback)
+    .catch(callback);
 };
 
 //
@@ -51,9 +52,9 @@ Blockchain.prototype.getAddressTransactions = function (params, callback) {
   common.validateParams(params, ['address'], [], callback);
 
   // TODO: support start and limit params
-  return Bluebird.resolve(this.bitgo.get(this.bitgo.url('/address/' + params.address + '/tx')).result()).nodeify(
-    callback
-  );
+  return Promise.resolve(this.bitgo.get(this.bitgo.url('/address/' + params.address + '/tx')).result())
+    .then(callback)
+    .catch(callback);
 };
 
 //
@@ -75,11 +76,12 @@ Blockchain.prototype.getAddressUnspents = function (params, callback) {
     url += '?limit=' + params.limit * 1e8;
   }
 
-  return Bluebird.resolve(this.bitgo.get(url).result())
+  return Promise.resolve(this.bitgo.get(url).result())
     .then(function (body) {
       return body.unspents;
     })
-    .nodeify(callback);
+    .then(callback)
+    .catch(callback);
 };
 
 //
@@ -93,7 +95,9 @@ Blockchain.prototype.getTransaction = function (params, callback) {
   params = params || {};
   common.validateParams(params, ['id'], [], callback);
 
-  return Bluebird.resolve(this.bitgo.get(this.bitgo.url('/tx/' + params.id)).result()).nodeify(callback);
+  return Promise.resolve(this.bitgo.get(this.bitgo.url('/tx/' + params.id)).result())
+    .then(callback)
+    .catch(callback);
 };
 
 //
@@ -110,9 +114,9 @@ Blockchain.prototype.getTransactionByInput = function (params, callback) {
   if (!_.isInteger(params.vout)) {
     throw new Error('invalid vout - number expected');
   }
-  return Bluebird.resolve(
-    this.bitgo.get(this.bitgo.url('/tx/input/' + params.txid + '/' + params.vout)).result()
-  ).nodeify(callback);
+  return Promise.resolve(this.bitgo.get(this.bitgo.url('/tx/input/' + params.txid + '/' + params.vout)).result())
+    .then(callback)
+    .catch(callback);
 };
 
 //
@@ -126,7 +130,9 @@ Blockchain.prototype.getBlock = function (params, callback) {
   params = params || {};
   common.validateParams(params, ['id'], [], callback);
 
-  return Bluebird.resolve(this.bitgo.get(this.bitgo.url('/block/' + params.id)).result()).nodeify(callback);
+  return Promise.resolve(this.bitgo.get(this.bitgo.url('/block/' + params.id)).result())
+    .then(callback)
+    .catch(callback);
 };
 
 module.exports = Blockchain;

modules/sdk-api/src/v1/keychains.ts

@@ -15,8 +15,6 @@ import { bip32 } from '@bitgo/utxo-lib';
 import { randomBytes } from 'crypto';
 import { common, Util, sanitizeLegacyPath } from '@bitgo/sdk-core';
 const _ = require('lodash');
-import Bluebird from 'bluebird';
-const co = Bluebird.coroutine;
 
 //
 // Constructor
@@ -150,7 +148,7 @@ Keychains.prototype.list = function (params, callback) {
   params = params || {};
   common.validateParams(params, [], [], callback);
 
-  return Bluebird.resolve(this.bitgo.get(this.bitgo.url('/keychain')).result('keychains'))
+  return Promise.resolve(this.bitgo.get(this.bitgo.url('/keychain')).result('keychains'))
     .then(function (keychains) {
       keychains.map(function (keychain) {
         if (
@@ -164,7 +162,8 @@ Keychains.prototype.list = function (params, callback) {
       });
       return keychains;
     })
-    .nodeify(callback);
+    .then(callback)
+    .catch(callback);
 };
 
 /**
@@ -182,10 +181,10 @@ Keychains.prototype.list = function (params, callback) {
  *  @returns result.version {Number}
  */
 Keychains.prototype.updatePassword = function (params, callback) {
-  return co(function* coUpdatePassword() {
+  return async function coUpdatePassword() {
     common.validateParams(params, ['oldPassword', 'newPassword'], [], callback);
     // @ts-expect-error - no implicit this
-    const encrypted = yield this.bitgo.post(this.bitgo.url('/user/encrypted')).result();
+    const encrypted = await this.bitgo.post(this.bitgo.url('/user/encrypted')).result();
     const newKeychains = {};
     // @ts-expect-error - no implicit this
     const self = this;
@@ -200,9 +199,10 @@ Keychains.prototype.updatePassword = function (params, callback) {
       }
     });
     return { keychains: newKeychains, version: (encrypted as any).version };
-  })
+  }
     .call(this)
-    .asCallback(callback);
+    .then(callback)
+    .catch(callback);
 };
 
 //
@@ -213,7 +213,7 @@ Keychains.prototype.add = function (params, callback) {
   params = params || {};
   common.validateParams(params, ['xpub'], ['encryptedXprv', 'type', 'isLedger'], callback);
 
-  return Bluebird.resolve(
+  return Promise.resolve(
     this.bitgo
       .post(this.bitgo.url('/keychain'))
       .send({
@@ -236,7 +236,8 @@ Keychains.prototype.add = function (params, callback) {
       }
       return keychain;
     })
-    .nodeify(callback);
+    .then(callback)
+    .catch(callback);
 };
 
 //
@@ -247,7 +248,7 @@ Keychains.prototype.createBitGo = function (params, callback) {
   params = params || {};
   common.validateParams(params, [], [], callback);
 
-  return Bluebird.resolve(this.bitgo.post(this.bitgo.url('/keychain/bitgo')).send(params).result())
+  return Promise.resolve(this.bitgo.post(this.bitgo.url('/keychain/bitgo')).send(params).result())
     .then(function (keychain) {
       if (
         keychain.xpub &&
@@ -259,7 +260,8 @@ Keychains.prototype.createBitGo = function (params, callback) {
       }
       return keychain;
     })
-    .nodeify(callback);
+    .then(callback)
+    .catch(callback);
 };
 
 //
@@ -270,7 +272,7 @@ Keychains.prototype.createBackup = function (params, callback) {
   params = params || {};
   common.validateParams(params, ['provider'], [], callback);
 
-  return Bluebird.resolve(this.bitgo.post(this.bitgo.url('/keychain/backup')).send(params).result())
+  return Promise.resolve(this.bitgo.post(this.bitgo.url('/keychain/backup')).send(params).result())
     .then(function (keychain) {
       // not all keychains have an xpub
       if (
@@ -283,7 +285,8 @@ Keychains.prototype.createBackup = function (params, callback) {
       }
       return keychain;
     })
-    .nodeify(callback);
+    .then(callback)
+    .catch(callback);
 };
 
 //
@@ -301,7 +304,7 @@ Keychains.prototype.get = function (params, callback) {
   }
 
   const id = params.xpub || params.ethAddress;
-  return Bluebird.resolve(
+  return Promise.resolve(
     this.bitgo
       .post(this.bitgo.url('/keychain/' + encodeURIComponent(id)))
       .send({})
@@ -318,7 +321,8 @@ Keychains.prototype.get = function (params, callback) {
       }
       return keychain;
     })
-    .nodeify(callback);
+    .then(callback)
+    .catch(callback);
 };
 
 //
@@ -331,7 +335,7 @@ Keychains.prototype.update = function (params, callback) {
   params = params || {};
   common.validateParams(params, ['xpub'], ['encryptedXprv'], callback);
 
-  return Bluebird.resolve(
+  return Promise.resolve(
     this.bitgo
       .put(this.bitgo.url('/keychain/' + params.xpub))
       .send({
@@ -350,7 +354,8 @@ Keychains.prototype.update = function (params, callback) {
       }
       return keychain;
     })
-    .nodeify(callback);
+    .then(callback)
+    .catch(callback);
 };
 
 module.exports = Keychains;

modules/sdk-api/src/v1/markets.ts

@@ -11,8 +11,6 @@
 // Copyright 2015, BitGo, Inc.  All Rights Reserved.
 //
 
-import Bluebird from 'bluebird';
-
 import { common } from '@bitgo/sdk-core';
 
 //
@@ -34,7 +32,9 @@ Markets.prototype.latest = function (params, callback) {
   params = params || {};
   common.validateParams(params, [], [], callback);
 
-  return Bluebird.resolve(this.bitgo.get(this.bitgo.url('/market/latest')).result()).nodeify(callback);
+  return Promise.resolve(this.bitgo.get(this.bitgo.url('/market/latest')).result())
+    .then(callback)
+    .catch(callback);
 };
 
 /**
@@ -48,7 +48,9 @@ Markets.prototype.yesterday = function (params, callback) {
   params = params || {};
   common.validateParams(params, [], [], callback);
 
-  return Bluebird.resolve(this.bitgo.get(this.bitgo.url('/market/yesterday')).result()).nodeify(callback);
+  return Promise.resolve(this.bitgo.get(this.bitgo.url('/market/yesterday')).result())
+    .then(callback)
+    .catch(callback);
 };
 
 /**
@@ -67,9 +69,9 @@ Markets.prototype.lastDays = function (params, callback) {
     throw new Error('must use a non-negative number of days');
   }
 
-  return Bluebird.resolve(
-    this.bitgo.get(this.bitgo.url('/market/last/' + days + '/' + params.currencyName)).result()
-  ).nodeify(callback);
+  return Promise.resolve(this.bitgo.get(this.bitgo.url('/market/last/' + days + '/' + params.currencyName)).result())
+    .then(callback)
+    .catch(callback);
 };
 
 module.exports = Markets;

modules/sdk-api/src/v1/pendingapproval.ts

@@ -12,8 +12,8 @@
 import { common } from '@bitgo/sdk-core';
 import * as utxolib from '@bitgo/utxo-lib';
 
-import Bluebird from 'bluebird';
 import _ from 'lodash';
+import { tryPromise } from '../util';
 
 //
 // Constructor
@@ -134,12 +134,13 @@ PendingApproval.prototype.get = function (params, callback) {
   common.validateParams(params, [], [], callback);
 
   const self = this;
-  return Bluebird.resolve(this.bitgo.get(this.url()).result())
+  return Promise.resolve(this.bitgo.get(this.url()).result())
     .then(function (res) {
       self.pendingApproval = res;
       return self;
     })
-    .nodeify(callback);
+    .then(callback)
+    .catch(callback);
 };
 
 //
@@ -184,7 +185,7 @@ PendingApproval.prototype.recreateAndSignTransaction = function (params, callbac
 
   const self = this;
 
-  return Bluebird.try(function () {
+  return tryPromise(function () {
     if (self.info().transactionRequest.recipients) {
       // recipients object found on the pending approvals - use it
       params.recipients = self.info().transactionRequest.recipients;
@@ -240,7 +241,7 @@ PendingApproval.prototype.constructApprovalTx = function (params, callback) {
   }
 
   const self = this;
-  return Bluebird.try(function () {
+  return tryPromise(function () {
     if (self.type() === 'transactionRequest') {
       const extendParams: any = { txHex: self.info().transactionRequest.transaction };
       if (params.useOriginalFee) {
@@ -280,7 +281,7 @@ PendingApproval.prototype.approve = function (params, callback) {
   }
 
   const self = this;
-  return Bluebird.try(function () {
+  return tryPromise(function () {
     if (self.type() === 'transactionRequest') {
       if (params.tx) {
         // the approval tx was reconstructed and explicitly specified - pass it through
@@ -318,7 +319,7 @@ PendingApproval.prototype.approve = function (params, callback) {
       if (transaction) {
         approvalParams.tx = transaction.tx;
       }
-      return Bluebird.resolve(self.bitgo.put(self.url()).send(approvalParams).result()).nodeify(callback);
+      return Promise.resolve(self.bitgo.put(self.url()).send(approvalParams).result()).then(callback).catch(callback);
     })
     .catch(function (error) {
       if (
@@ -351,7 +352,9 @@ PendingApproval.prototype.reject = function (params, callback) {
   params = params || {};
   common.validateParams(params, [], [], callback);
 
-  return Bluebird.resolve(this.bitgo.put(this.url()).send({ state: 'rejected' }).result()).nodeify(callback);
+  return Promise.resolve(this.bitgo.put(this.url()).send({ state: 'rejected' }).result())
+    .then(callback)
+    .catch(callback);
 };
 
 //