Add support for XRP unsigned transaction explanation

Reviewers: andrew

Reviewed By: andrew

Subscribers: ben

Differential Revision: https://phabricator.bitgo.com/D6241

Author: Arik Sosman

package.json

@@ -1,6 +1,6 @@
 {
   "name": "bitgo",
-  "version": "3.6.0",
+  "version": "3.7.0",
   "description": "BitGo Javascript SDK",
   "main": "./src/index.js",
   "keywords": [

src/v2/coins/xrp.js

@@ -130,7 +130,7 @@ Xrp.prototype.supplementGenerateWallet = function(walletParams, keychains) {
   if (walletParams.rootPrivateKey) {
     const rootPrivateKey = walletParams.rootPrivateKey;
     if (typeof rootPrivateKey !== 'string' || rootPrivateKey.length !== 64) {
-      throw new Error('rootPrivateKey needs to be a hexadecimal private key string')
+      throw new Error('rootPrivateKey needs to be a hexadecimal private key string');
     }
     keyPair = prova.ECPair.fromPrivateKeyBuffer(Buffer.from(walletParams.rootPrivateKey, 'hex'));
   }
@@ -225,7 +225,16 @@ Xrp.prototype.supplementGenerateWallet = function(walletParams, keychains) {
  * @returns {{displayOrder: [string,string,string,string,string], id: *, outputs: Array, changeOutputs: Array}}
  */
 Xrp.prototype.explainTransaction = function(params) {
-  var transaction = rippleBinaryCodec.decode(params.txHex);
+  let transaction;
+  try {
+    transaction = rippleBinaryCodec.decode(params.txHex);
+  } catch (e) {
+    try {
+      transaction = JSON.parse(params.txHex);
+    } catch (e) {
+      throw new Error('txHex needs to be either hex or JSON string for XRP');
+    }
+  }
   var id = rippleHashes.computeBinaryTransactionHash(params.txHex);
   var changeAmount = 0;
   var explanation = {

test/v2/coins/xrp.js

@@ -17,7 +17,7 @@ describe('XRP:', function() {
     return bitgo.authenticateTestUser(bitgo.testUserOTP())
     .then(function() {
       basecoin = bitgo.coin('txrp');
-    })
+    });
   });
 
   it('Should verify addresses', function() {
@@ -73,4 +73,22 @@ describe('XRP:', function() {
     });
   });
 
+  it('Should be able to explain an XRP transaction', function() {
+    const signedExplanation = basecoin.explainTransaction({ txHex: '120000228000000024000000072E00000000201B0018D07161400000000003DE2968400000000000002D73008114726D0D8A26568D5D9680AC80577C912236717191831449EE221CCACC4DD2BF8862B22B0960A84FC771D9F3E010732103AFBB6845826367D738B0D42EA0756C94547E70B064E8FE1260CF21354C898B0B74473045022100CA3A98AA6FC8CCA251C3A2754992E474EA469884EB8D489D2B180EB644AC7695022037EB886DCF57928E5844DB73C2E86DE553FB59DCFC9408F3FD5D802ADB69DFCC8114F0DBA9D34C77B6769F6142AB7C9D0AF67D113EBCE1F1' });
+    const unsignedExplanation = basecoin.explainTransaction({ txHex: '{"TransactionType":"Payment","Account":"rBSpCz8PafXTJHppDcNnex7dYnbe3tSuFG","Destination":"rfjub8A4dpSD5nnszUFTsLprxu1W398jwc","DestinationTag":0,"Amount":"253481","Flags":2147483648,"LastLedgerSequence":1626225,"Fee":"45","Sequence":7}' });
+    unsignedExplanation.id.should.equal('CA528085F95335027A8D8555E685500C5B3E325AAB22AA0BCB56605CDF97B1C8');
+    signedExplanation.id.should.equal('D52681436CC5B94E9D00BC8172047B1A6F3C028D2D0A5CDFB81680039C48ADFD');
+    unsignedExplanation.outputAmount.should.equal('253481');
+    signedExplanation.outputAmount.should.equal('253481');
+  });
+
+  it('Should be unable to explain bogus XRP transaction', function() {
+    try {
+      basecoin.explainTransaction({ txHex: 'abcdefgH' });
+      throw new Error('this is the wrong error!');
+    } catch (e) {
+      e.message.should.equal('txHex needs to be either hex or JSON string for XRP');
+    }
+  });
+
 });