feat: pass custodianTransaction and messageId

Karan · Karan · commit 35b795395d1f · 2022-10-26T15:53:38.000-07:00
Ticket: BG-59497
diff --git a/modules/bitgo/test/v2/unit/wallet.ts b/modules/bitgo/test/v2/unit/wallet.ts
@@ -1921,6 +1921,31 @@ describe('V2 Wallet:', function () {
         intent.isTss!.should.equal(true);
         intent.intentType.should.equal('fillNonce');
       });
+
+      it('should populate intent with custodianTransactionId', async function () {
+        const mpcUtils = new ECDSAUtils.EcdsaUtils(bitgo, bitgo.coin('gteth'));
+        const feeOptions = {
+          maxFeePerGas: 3000000000,
+          maxPriorityFeePerGas: 2000000000,
+        };
+        const nonce = '1';
+
+        const intent = mpcUtils.populateIntent(bitgo.coin('gteth'), {
+          custodianTransactionId: 'unittest',
+          reqId,
+          intentType: 'fillNonce',
+          nonce,
+          feeOptions,
+          isTss: true,
+        });
+
+        intent.custodianTransactionId!.should.equal('unittest');
+        intent.should.have.property('recipients', undefined);
+        intent.feeOptions!.should.deepEqual(feeOptions);
+        intent.nonce!.should.equal(nonce);
+        intent.isTss!.should.equal(true);
+        intent.intentType.should.equal('fillNonce');
+      });
     });
 
     describe('Transaction signing', function () {
@@ -1946,6 +1971,7 @@ describe('V2 Wallet:', function () {
         });
       });
 
+
       it('should fail to sign transaction without txRequestId', async function () {
         const txPrebuild = {
           walletId: tssWallet.id(),
@@ -1965,7 +1991,7 @@ describe('V2 Wallet:', function () {
         txRequestId: 'id',
         transactions: [],
         intent: {
-          intentType: 'payment',
+          intentType: 'signMessage',
         },
         date: new Date().toISOString(),
         latest: true,
@@ -2020,6 +2046,23 @@ describe('V2 Wallet:', function () {
           actualArg.messagePrebuild.message.should.equal(`\u0019Ethereum Signed Message:\\n${message.length}${message}`);
         });
 
+        it('should sign message when custodianMessageId is provided', async function () {
+          const signMessageTssSpy = sinon.spy(tssEthWallet, 'signMessageTss' as any);
+          nock(bgUrl)
+            .post(`/api/v2/wallet/${tssEthWallet.id()}/txrequests`)
+            .reply(200, txRequestForMessageSigning);
+
+          const signMessage = await tssEthWallet.signMessage({
+            custodianMessageId: 'unittest',
+            reqId,
+            messagePrebuild: { message },
+            prv: 'secretKey',
+          });
+          signMessage.should.deepEqual({ txRequestId } );
+          const actualArg = signMessageTssSpy.getCalls()[0].args[0];
+          actualArg.messagePrebuild.message.should.equal(`\u0019Ethereum Signed Message:\\n${message.length}${message}`);
+        });
+
         it('should sign message when txRequestId not provided', async function () {
           const signMessageTssSpy = sinon.spy(tssEthWallet, 'signMessageTss' as any);
           nock(bgUrl)
diff --git a/modules/sdk-core/src/bitgo/utils/mpcUtils.ts b/modules/sdk-core/src/bitgo/utils/mpcUtils.ts
@@ -143,6 +143,7 @@ export abstract class MpcUtils {
             hopParams: params.hopParams,
             isTss: params.isTss,
             nonce: params.nonce,
+            custodianTransactionId: params.custodianTransactionId,
           };
         case 'acceleration':
           return {
diff --git a/modules/sdk-core/src/bitgo/utils/tss/baseTypes.ts b/modules/sdk-core/src/bitgo/utils/tss/baseTypes.ts
@@ -63,7 +63,10 @@ export interface IntentOptionsBase {
   isTss?: boolean;
   comment?: string;
   memo?: Memo;
+  custodianTransactionId?: string;
+  custodianMessageId?: string;
 }
+
 export interface PrebuildTransactionWithIntentOptions extends IntentOptionsBase {
   recipients?: {
     address: string;
@@ -107,6 +110,8 @@ export interface PopulatedIntent extends PopulatedIntentBase {
   feeOptions?: FeeOption | EIP1559FeeOptions;
   hopParams?: HopParams;
   txid?: string;
+  custodianTransactionId?: string;
+  custodianMessageId?: string;
 }
 
 export type TxRequestState =
diff --git a/modules/sdk-core/src/bitgo/wallet/iWallet.ts b/modules/sdk-core/src/bitgo/wallet/iWallet.ts
@@ -103,6 +103,7 @@ export interface PrebuildTransactionOptions {
   gasLimit?: number;
   lowFeeTxid?: string;
   isTss?: boolean;
+  custodianTransactionId?: string;
 }
 
 export interface PrebuildAndSignTransactionOptions extends PrebuildTransactionOptions, WalletSignTransactionOptions {
@@ -147,6 +148,7 @@ export interface WalletSignTransactionOptions extends WalletSignBaseOptions {
 
 export interface WalletSignMessageOptions extends WalletSignBaseOptions {
   messagePrebuild?: MessagePrebuild;
+  custodianMessageId?: string;
 }
 
 export interface GetUserPrvOptions {
@@ -441,6 +443,7 @@ export interface SendManyOptions extends PrebuildAndSignTransactionOptions {
   [index: string]: unknown;
   eip1559?: EIP1559;
   gasLimit?: number;
+  custodianTransactionId?: string;
 }
 
 export type WalletType = 'backing' | 'cold' | 'custodial' | 'custodialPaired' | 'hot' | 'trading';
diff --git a/modules/sdk-core/src/bitgo/wallet/wallet.ts b/modules/sdk-core/src/bitgo/wallet/wallet.ts
@@ -1568,7 +1568,7 @@ export class Wallet implements IWallet {
   }
 
   /**
-   *  Sign a message using TSS (not implemented for hot wallets)
+   *  Sign a message using TSS
    * @param params
    * - messagePrebuild
    * - [keychain / key] (object) or prv (string)
@@ -2684,6 +2684,7 @@ export class Wallet implements IWallet {
       assert(params.messagePrebuild);
       if (!params.messagePrebuild.txRequestId) {
         const intentOption: IntentOptionsBase = {
+          custodianMessageId: params.custodianMessageId,
           reqId: params.reqId,
           intentType: 'signmessage',
           isTss: true,

Original file line number	Diff line number	Diff line change
`@@ -103,6 +103,7 @@ export interface PrebuildTransactionOptions {`
`103`	`103`	`gasLimit?: number;`
`104`	`104`	`lowFeeTxid?: string;`
`105`	`105`	`isTss?: boolean;`
	`106`	`+ custodianTransactionId?: string;`
`106`	`107`	`}`
`107`	`108`
`108`	`109`	`export interface PrebuildAndSignTransactionOptions extends PrebuildTransactionOptions, WalletSignTransactionOptions {`
`@@ -147,6 +148,7 @@ export interface WalletSignTransactionOptions extends WalletSignBaseOptions {`
`147`	`148`
`148`	`149`	`export interface WalletSignMessageOptions extends WalletSignBaseOptions {`
`149`	`150`	`messagePrebuild?: MessagePrebuild;`
	`151`	`+ custodianMessageId?: string;`
`150`	`152`	`}`
`151`	`153`
`152`	`154`	`export interface GetUserPrvOptions {`
`@@ -441,6 +443,7 @@ export interface SendManyOptions extends PrebuildAndSignTransactionOptions {`
`441`	`443`	`[index: string]: unknown;`
`442`	`444`	`eip1559?: EIP1559;`
`443`	`445`	`gasLimit?: number;`
	`446`	`+ custodianTransactionId?: string;`
`444`	`447`	`}`
`445`	`448`
`446`	`449`	`export type WalletType = 'backing' \| 'cold' \| 'custodial' \| 'custodialPaired' \| 'hot' \| 'trading';`