Merge pull request #7024 from BitGo/GNA-2162

fix(express): signPayload API to handle stringified payload as req

Author: parvaparikh-30

modules/express/src/clientRoutes.ts

@@ -62,6 +62,7 @@ import { handleLightningWithdraw } from './lightning/lightningWithdrawRoutes';
 import createExpressRouter from './typedRoutes';
 import { ExpressApiRouteRequest } from './typedRoutes/api';
 import { TypedRequestHandler, WrappedRequest, WrappedResponse } from '@api-ts/typed-express-router';
+import { isJsonString } from './utils';
 
 const { version } = require('bitgo/package.json');
 const pjson = require('../package.json');
@@ -630,7 +631,7 @@ export async function handleV2OFCSignPayload(req: express.Request): Promise<{ pa
 
   const walletPassphrase = bodyWalletPassphrase || getWalletPwFromEnv(wallet.id());
   const tradingAccount = wallet.toTradingAccount();
-  const stringifiedPayload = JSON.stringify(req.body.payload);
+  const stringifiedPayload = isJsonString(req.body.payload) ? req.body.payload : JSON.stringify(req.body.payload);
   const signature = await tradingAccount.signPayload({
     payload: stringifiedPayload,
     walletPassphrase,

modules/express/src/utils.ts

@@ -0,0 +1,8 @@
+export const isJsonString = (str: any): boolean => {
+  try {
+    JSON.parse(str);
+    return true;
+  } catch {
+    return false;
+  }
+};

modules/express/test/unit/clientRoutes/signPayload.ts

@@ -18,6 +18,7 @@ describe('Sign an arbitrary payload with trading account key', function () {
       },
     },
   };
+  const stringifiedPayload = JSON.stringify(payload);
   const signature = 'signedPayload123';
   const walletId = 'myWalletId';
 
@@ -41,11 +42,7 @@ describe('Sign an arbitrary payload with trading account key', function () {
     process.env['WALLET_myWalletId_PASSPHRASE'] = 'mypass';
   });
 
-  it('should return a signed payload', async function () {
-    // TODO(GO-1015): unskip test
-    return;
-
-    // eslint-disable-next-line no-unreachable
+  it('should return a signed payload with type as object', async function () {
     const expectedResponse = {
       payload: JSON.stringify(payload),
       signature,
@@ -60,6 +57,21 @@ describe('Sign an arbitrary payload with trading account key', function () {
     } as unknown as Request;
     await handleV2OFCSignPayload(req).should.be.resolvedWith(expectedResponse);
   });
+  it('should return a signed payload with type as json string', async function () {
+    const expectedResponse = {
+      payload: stringifiedPayload,
+      signature,
+    };
+    const req = {
+      bitgo: bitGoStub,
+      body: {
+        payload: stringifiedPayload,
+        walletId,
+      },
+      query: {},
+    } as unknown as Request;
+    await handleV2OFCSignPayload(req).should.be.resolvedWith(expectedResponse);
+  });
 });
 
 describe('With the handler to sign an arbitrary payload in external signing mode', () => {