Merge pull request #5846 from BitGo/COIN-3248-Changes-to-Eth-like-transfer-builder-for-supporting-custodial-hot

feat(abstract-eth): add extra methods in transfer builder

Author: venkateshv1266

modules/abstract-eth/src/lib/transferBuilder.ts

@@ -1,18 +1,20 @@
+import assert from 'assert';
 import * as ethUtil from 'ethereumjs-util';
 import EthereumAbi from 'ethereumjs-abi';
 import BN from 'bn.js';
 import { coins, BaseCoin, ContractAddressDefinedToken, EthereumNetwork as EthLikeNetwork } from '@bitgo/statics';
 import { BuildTransactionError, InvalidParameterValueError } from '@bitgo/sdk-core';
 import { decodeTransferData, sendMultiSigData, sendMultiSigTokenData, isValidEthAddress, isValidAmount } from './utils';
 import { defaultAbiCoder, keccak256 } from 'ethers/lib/utils';
+import { sendMultiSigTokenTypes, sendMultiSigTypes } from './walletUtil';
 
 /** ETH transfer builder */
 export class TransferBuilder {
   private readonly _EMPTY_HEX_VALUE = '0x';
   protected _amount: string;
   protected _toAddress: string;
   protected _sequenceId: number;
-  protected _signKey: string;
+  protected _signKey: string | null;
   protected _expirationTime: number;
   protected _signature: string;
   private _data: string;
@@ -111,6 +113,12 @@ export class TransferBuilder {
     return this;
   }
 
+  setSignature(signature: string): TransferBuilder {
+    this._signKey = null;
+    this._signature = signature;
+    return this;
+  }
+
   signAndBuild(chainId: string, coinUsesNonPackedEncodingForTxData?: boolean): string {
     this._chainId = chainId;
 
@@ -254,6 +262,7 @@ export class TransferBuilder {
 
   protected ethSignMsgHash(): string {
     const data = this.getOperationHash();
+    assert(this._signKey);
     const keyBuffer = Buffer.from(ethUtil.padToEven(this._signKey), 'hex');
     if (keyBuffer.length !== 32) {
       throw new Error('private key length is invalid');
@@ -289,4 +298,17 @@ export class TransferBuilder {
       this._tokenContractAddress = transferData.tokenContractAddress;
     }
   }
+
+  public getSignatureData(): Buffer<ArrayBuffer> {
+    const method = this._tokenContractAddress
+      ? EthereumAbi.methodID('sendMultiSigToken', sendMultiSigTokenTypes)
+      : EthereumAbi.methodID('sendMultiSig', sendMultiSigTypes);
+    const operationData = this.getOperationData();
+    const rawEncodedOperationData = EthereumAbi.rawEncode(...operationData);
+    return Buffer.concat([
+      method,
+      rawEncodedOperationData,
+      Buffer.from([this._coinUsesNonPackedEncodingForTxData ? 1 : 0]),
+    ]);
+  }
 }

modules/sdk-coin-ethlike/test/fixtures/ethlikeCoin.ts

@@ -72,3 +72,22 @@ export const encryptedUserKey =
   ':"ccm","adata":"","cipher":"aes","salt":"p+fkHuLa/8k=","ct":"hYG7pvljLIgCjZ\n' +
   '53PBlCde5KZRmlUKKHLtDMk+HJfuU46hW+x+C9WsIAO4gFPnTCvFVmQ8x7czCtcNFub5AO2otOG\n' +
   'OsX4GE2gXOEmCl1TpWwwNhm7yMUjGJUpgW6ZZgXSXdDitSKi4V/hk78SGSzjFOBSPYRa6I="}\n';
+
+export const custodialHot = {
+  hteth: {
+    signatureData:
+      '0dcd7a6c00000000000000000000000000000000000000000000000000000000000000c0000000000000000000000000b9f62c71d5f6949cfb211a67fb13ccf079cc760b0000000000000000000000000000000000000000000000000000000005f5e100000000000000000000000000e4ab69c077896252fafbd49efd26b5d171a324100000000000000000000000000000000000000000000000000000000067f415e100000000000000000000000000000000000000000000000000000000000000640000000000000000000000000000000000000000000000000000000000000005455243323000000000000000000000000000000000000000000000000000000000',
+    signature:
+      '0xa9c3ead37547fa56b694e4eccc9352225b7458ef08e4e961ca5774d398abd55b5986a7446259374d2098012923583935189739f18dd117c4d15221b2a26f50911c',
+    signedTxHex:
+      '0xf9016a80830186a082520894702cf81e03aa310ec9481d814e3d04a20b04b50580b901440dcd7a6c000000000000000000000000b9f62c71d5f6949cfb211a67fb13ccf079cc760b0000000000000000000000000000000000000000000000000000000005f5e100000000000000000000000000e4ab69c077896252fafbd49efd26b5d171a324100000000000000000000000000000000000000000000000000000000067f415e1000000000000000000000000000000000000000000000000000000000000006400000000000000000000000000000000000000000000000000000000000000c00000000000000000000000000000000000000000000000000000000000000041a9c3ead37547fa56b694e4eccc9352225b7458ef08e4e961ca5774d398abd55b5986a7446259374d2098012923583935189739f18dd117c4d15221b2a26f50911c000000000000000000000000000000000000000000000000000000000000008284f38080',
+  },
+  tarbeth: {
+    signatureData:
+      '0dcd7a6c00000000000000000000000000000000000000000000000000000000000000c0000000000000000000000000b9f62c71d5f6949cfb211a67fb13ccf079cc760b0000000000000000000000000000000000000000000000000000000005f5e100000000000000000000000000e4ab69c077896252fafbd49efd26b5d171a324100000000000000000000000000000000000000000000000000000000067f415e10000000000000000000000000000000000000000000000000000000000000064000000000000000000000000000000000000000000000000000000000000000c3432313631342d4552433230000000000000000000000000000000000000000000',
+    signature:
+      '0xa9c3ead37547fa56b694e4eccc9352225b7458ef08e4e961ca5774d398abd55b5986a7446259374d2098012923583935189739f18dd117c4d15221b2a26f50911c',
+    signedTxHex:
+      '0xf9016b80830186a082520894702cf81e03aa310ec9481d814e3d04a20b04b50580b901440dcd7a6c000000000000000000000000b9f62c71d5f6949cfb211a67fb13ccf079cc760b0000000000000000000000000000000000000000000000000000000005f5e100000000000000000000000000e4ab69c077896252fafbd49efd26b5d171a324100000000000000000000000000000000000000000000000000000000067f415e1000000000000000000000000000000000000000000000000000000000000006400000000000000000000000000000000000000000000000000000000000000c00000000000000000000000000000000000000000000000000000000000000041a9c3ead37547fa56b694e4eccc9352225b7458ef08e4e961ca5774d398abd55b5986a7446259374d2098012923583935189739f18dd117c4d15221b2a26f50911c00000000000000000000000000000000000000000000000000000000000000830cddff8080',
+  },
+};

modules/sdk-coin-ethlike/test/unit/ethlikeCoin.ts

@@ -1,7 +1,7 @@
 import assert from 'assert';
 import { BitGoAPI } from '@bitgo/sdk-api';
 import { common, FullySignedTransaction, HalfSignedTransaction, TransactionType } from '@bitgo/sdk-core';
-import { OfflineVaultTxInfo } from '@bitgo/abstract-eth';
+import { OfflineVaultTxInfo, TransferBuilder } from '@bitgo/abstract-eth';
 import { TestBitGo, TestBitGoAPI } from '@bitgo/sdk-test';
 import { bip32 } from '@bitgo/secp256k1';
 import nock from 'nock';
@@ -93,6 +93,37 @@ describe('EthLike coin tests', function () {
         assert(result.txHex);
         result.txHex.should.equal(mockData.ccr[coin.name].txHex);
       });
+
+      it('should generate signature data for custodial hot wallet and sign using hsm signature', async function () {
+        const baseAddress = '0x702cf81e03aa310ec9481d814e3d04a20b04b505';
+        const destinationAddress = '0xb9f62c71d5f6949cfb211a67fb13ccf079cc760b';
+        const tokenContractAddress = '0xe4ab69c077896252fafbd49efd26b5d171a32410';
+        const txBuilder = getBuilder(coin.name, coin.common) as EthLikeTransactionBuilder;
+
+        txBuilder.contract(baseAddress);
+        txBuilder.contractCounter(0);
+        txBuilder.fee({
+          fee: '100000',
+          gasLimit: '21000',
+        });
+
+        const transferBuilder = txBuilder.transfer() as TransferBuilder;
+        transferBuilder
+          .coin(coin.name)
+          .amount('100000000')
+          .contractSequenceId(100)
+          .expirationTime(1744049633)
+          .to(destinationAddress)
+          .tokenContractAddress(tokenContractAddress);
+        const signatureData = transferBuilder.getSignatureData();
+        assert.strictEqual(signatureData.toString('hex'), mockData.custodialHot[coin.name].signatureData);
+
+        // Set HSM Signature
+        transferBuilder.setSignature(mockData.custodialHot[coin.name].signature);
+        const tx = await txBuilder.build();
+        const txHex = tx.toBroadcastFormat();
+        assert.strictEqual(txHex, mockData.custodialHot[coin.name].signedTxHex);
+      });
     });
   });
 });