Merge pull request #5935 from BitGo/WIN-4884-Unsigned

feat: unsigned sweep for flare and xdc

Author: prithvishet2503

modules/sdk-coin-coredao/src/coredao.ts

@@ -1,6 +1,13 @@
 import { BaseCoin, BitGoBase, common, MPCAlgorithm, MultisigType, multisigTypes } from '@bitgo/sdk-core';
 import { BaseCoin as StaticsBaseCoin, coins } from '@bitgo/statics';
-import { AbstractEthLikeNewCoins, optionalDeps, recoveryBlockchainExplorerQuery } from '@bitgo/abstract-eth';
+import {
+  AbstractEthLikeNewCoins,
+  optionalDeps,
+  recoveryBlockchainExplorerQuery,
+  UnsignedSweepTxMPCv2,
+  RecoverOptions,
+  OfflineVaultTxInfo,
+} from '@bitgo/abstract-eth';
 import { TransactionBuilder } from './lib';
 import BN from 'bn.js';
 
@@ -38,6 +45,10 @@ export class Coredao extends AbstractEthLikeNewCoins {
     return await recoveryBlockchainExplorerQuery(query, explorerUrl as string, apiToken);
   }
 
+  protected async buildUnsignedSweepTxnTSS(params: RecoverOptions): Promise<OfflineVaultTxInfo | UnsignedSweepTxMPCv2> {
+    return this.buildUnsignedSweepTxnMPCv2(params);
+  }
+
   /** @inheritDoc */
   async queryAddressBalance(address: string): Promise<BN> {
     const result = await this.recoveryBlockchainExplorerQuery({

modules/sdk-coin-coredao/src/lib/transactionBuilder.ts

@@ -6,6 +6,7 @@ import { TransferBuilder } from './transferBuilder';
 
 export class TransactionBuilder extends AbstractTransactionBuilder {
   protected _transfer: TransferBuilder;
+  private _signatures: any;
 
   constructor(_coinConfig: Readonly<CoinConfig>) {
     super(_coinConfig);
@@ -24,6 +25,11 @@ export class TransactionBuilder extends AbstractTransactionBuilder {
     return this._transfer;
   }
 
+  addSignature(publicKey, signature) {
+    this._signatures = [];
+    this._signatures.push({ publicKey, signature });
+  }
+
   protected getContractData(addresses: string[]): string {
     throw new Error('Method not implemented.');
   }

modules/sdk-coin-flr/src/flr.ts

@@ -9,7 +9,13 @@
 
 import { BaseCoin, BitGoBase, common, MPCAlgorithm, MultisigType, multisigTypes } from '@bitgo/sdk-core';
 import { BaseCoin as StaticsBaseCoin, coins } from '@bitgo/statics';
-import { AbstractEthLikeNewCoins, recoveryBlockchainExplorerQuery } from '@bitgo/abstract-eth';
+import {
+  AbstractEthLikeNewCoins,
+  recoveryBlockchainExplorerQuery,
+  UnsignedSweepTxMPCv2,
+  RecoverOptions,
+  OfflineVaultTxInfo,
+} from '@bitgo/abstract-eth';
 import { TransactionBuilder } from './lib';
 
 export class Flr extends AbstractEthLikeNewCoins {
@@ -40,6 +46,10 @@ export class Flr extends AbstractEthLikeNewCoins {
     return 'ecdsa';
   }
 
+  protected async buildUnsignedSweepTxnTSS(params: RecoverOptions): Promise<OfflineVaultTxInfo | UnsignedSweepTxMPCv2> {
+    return this.buildUnsignedSweepTxnMPCv2(params);
+  }
+
   async recoveryBlockchainExplorerQuery(query: Record<string, string>): Promise<Record<string, unknown>> {
     const apiToken = common.Environments[this.bitgo.getEnv()].flrExplorerApiToken;
     const explorerUrl = common.Environments[this.bitgo.getEnv()].flrExplorerBaseUrl;

modules/sdk-coin-flr/src/lib/transactionBuilder.ts

@@ -6,6 +6,7 @@ import { TransferBuilder } from './transferBuilder';
 
 export class TransactionBuilder extends AbstractTransactionBuilder {
   protected _transfer: TransferBuilder;
+  private _signatures: any;
 
   constructor(_coinConfig: Readonly<CoinConfig>) {
     super(_coinConfig);
@@ -24,6 +25,11 @@ export class TransactionBuilder extends AbstractTransactionBuilder {
     return this._transfer;
   }
 
+  addSignature(publicKey, signature) {
+    this._signatures = [];
+    this._signatures.push({ publicKey, signature });
+  }
+
   protected getContractData(addresses: string[]): string {
     throw new Error('Method not implemented.');
   }

modules/sdk-coin-flr/test/resources.ts

@@ -0,0 +1,44 @@
+const getTxListRequestUnsignedSweep: Record<string, string> = {
+  module: 'account',
+  action: 'txlist',
+  address: '0x1469e6e519ff8bf398b76b4be0b50701b999f14c',
+};
+
+const getTxListResponseUnsignedSweep: Record<string, unknown> = {
+  status: '1',
+  result: [
+    {
+      hash: '0xede855d43d70ea1bb75db63d4f75113dae0845f0d4bdb0b2d8bda55249c70812',
+      nonce: '23',
+      from: '0x1469e6e519ff8bf398b76b4be0b50701b999f14c',
+    },
+  ],
+  message: 'OK',
+};
+
+const getBalanceRequestUnsignedSweep: Record<string, string> = {
+  module: 'account',
+  action: 'balance',
+  address: '0x1469e6e519ff8bf398b76b4be0b50701b999f14c',
+};
+
+const getBalanceResponseUnsignedSweep: Record<string, unknown> = {
+  status: '1',
+  result: '100000000000000000',
+  message: 'OK',
+};
+
+export const mockDataUnsignedSweep = {
+  userKey:
+    '038412b0e79372ca618978f2bc9fc944c504e828050a55a19fdfeca93cff5ec6562ae94f204a3f99e87334f812be8a54927ff24572bc666c5436887d2e42c0997d',
+  backupKey:
+    '038412b0e79372ca618978f2bc9fc944c504e828050a55a19fdfeca93cff5ec6562ae94f204a3f99e87334f812be8a54927ff24572bc666c5436887d2e42c0997d',
+  derivationPath: 'm/0',
+  derivationSeed: '',
+  walletBaseAddress: '0x1469e6e519ff8bf398b76b4be0b50701b999f14c',
+  recoveryDestination: '0x07efb1aa5e41b70b21facd3d287548ebf632a165',
+  getTxListRequest: getTxListRequestUnsignedSweep,
+  getTxListResponse: getTxListResponseUnsignedSweep,
+  getBalanceRequest: getBalanceRequestUnsignedSweep,
+  getBalanceResponse: getBalanceResponseUnsignedSweep,
+};

modules/sdk-coin-flr/test/unit/flr.ts

@@ -1,9 +1,13 @@
-import 'should';
+import * as should from 'should';
 
 import { TestBitGo, TestBitGoAPI } from '@bitgo/sdk-test';
 import { BitGoAPI } from '@bitgo/sdk-api';
 
 import { Flr, Tflr } from '../../src/index';
+import { UnsignedSweepTxMPCv2 } from '@bitgo/abstract-eth';
+import { mockDataUnsignedSweep } from '../resources';
+import nock from 'nock';
+import { common } from '@bitgo/sdk-core';
 
 const bitgo: TestBitGoAPI = TestBitGo.decorate(BitGoAPI, { env: 'test' });
 
@@ -40,3 +44,59 @@ describe('flr', function () {
     });
   });
 });
+
+describe('Build Unsigned Sweep for Self-Custody Cold Wallets - (MPCv2)', function () {
+  const bitgo = TestBitGo.decorate(BitGoAPI, { env: 'test' });
+  const explorerUrl = common.Environments[bitgo.getEnv()].flrExplorerBaseUrl as string;
+  const maxFeePerGasvalue = 30000000000;
+  const maxPriorityFeePerGasValue = 15000000000;
+  const chain_id = 114;
+  const gasLimitvalue = 500000;
+
+  it('should generate an unsigned sweep without derivation path', async () => {
+    nock(explorerUrl)
+      .get('/api')
+      .twice()
+      .query(mockDataUnsignedSweep.getTxListRequest)
+      .reply(200, mockDataUnsignedSweep.getTxListResponse);
+    nock(explorerUrl)
+      .get('/api')
+      .query(mockDataUnsignedSweep.getBalanceRequest)
+      .reply(200, mockDataUnsignedSweep.getBalanceResponse);
+
+    const baseCoin: any = bitgo.coin('tflr');
+    const transaction = (await baseCoin.recover({
+      userKey: mockDataUnsignedSweep.userKey,
+      backupKey: mockDataUnsignedSweep.backupKey,
+      walletContractAddress: mockDataUnsignedSweep.walletBaseAddress,
+      recoveryDestination: mockDataUnsignedSweep.recoveryDestination,
+      isTss: true,
+      eip1559: { maxFeePerGas: maxFeePerGasvalue, maxPriorityFeePerGas: maxPriorityFeePerGasValue },
+      gasLimit: gasLimitvalue,
+      replayProtectionOptions: {
+        chain: chain_id,
+        hardfork: 'london',
+      },
+    })) as UnsignedSweepTxMPCv2;
+    should.exist(transaction);
+    transaction.should.have.property('txRequests');
+    transaction.txRequests.length.should.equal(1);
+    const txRequest = transaction.txRequests[0];
+    txRequest.should.have.property('walletCoin');
+    txRequest.walletCoin.should.equal('tflr');
+    txRequest.should.have.property('transactions');
+    txRequest.transactions.length.should.equal(1);
+    const tx = txRequest.transactions[0];
+    tx.should.have.property('nonce');
+    tx.should.have.property('unsignedTx');
+    tx.unsignedTx.should.have.property('serializedTxHex');
+    tx.unsignedTx.should.have.property('signableHex');
+    tx.unsignedTx.should.have.property('derivationPath');
+    tx.unsignedTx.should.have.property('feeInfo');
+    tx.unsignedTx.feeInfo?.should.have.property('fee');
+    tx.unsignedTx.feeInfo?.should.have.property('feeString');
+    tx.unsignedTx.should.have.property('parsedTx');
+    tx.unsignedTx.parsedTx?.should.have.property('spendAmount');
+    tx.unsignedTx.parsedTx?.should.have.property('outputs');
+  });
+});

modules/sdk-coin-oas/src/lib/transactionBuilder.ts

@@ -6,6 +6,7 @@ import { TransferBuilder } from './transferBuilder';
 
 export class TransactionBuilder extends AbstractTransactionBuilder {
   protected _transfer: TransferBuilder;
+  private _signatures: any;
 
   constructor(_coinConfig: Readonly<CoinConfig>) {
     super(_coinConfig);
@@ -24,6 +25,11 @@ export class TransactionBuilder extends AbstractTransactionBuilder {
     return this._transfer;
   }
 
+  addSignature(publicKey, signature) {
+    this._signatures = [];
+    this._signatures.push({ publicKey, signature });
+  }
+
   protected getContractData(addresses: string[]): string {
     throw new Error('Method not implemented.');
   }

modules/sdk-coin-oas/src/oas.ts

@@ -7,6 +7,9 @@ import {
   AbstractEthLikeNewCoins,
   recoveryBlockchainExplorerQuery,
   TransactionBuilder as EthLikeTransactionBuilder,
+  UnsignedSweepTxMPCv2,
+  RecoverOptions,
+  OfflineVaultTxInfo,
 } from '@bitgo/abstract-eth';
 import { TransactionBuilder } from './lib';
 
@@ -38,6 +41,10 @@ export class Oas extends AbstractEthLikeNewCoins {
     return 'ecdsa';
   }
 
+  protected async buildUnsignedSweepTxnTSS(params: RecoverOptions): Promise<OfflineVaultTxInfo | UnsignedSweepTxMPCv2> {
+    return this.buildUnsignedSweepTxnMPCv2(params);
+  }
+
   /**
    * Make a query to Oasys chain explorer for information such as balance, token balance, solidity calls
    * @param {Object} query key-value pairs of parameters to append after /api

modules/sdk-coin-oas/test/resources.ts

@@ -0,0 +1,44 @@
+const getTxListRequestUnsignedSweep: Record<string, string> = {
+  module: 'account',
+  action: 'txlist',
+  address: '0x7f3f0386b3e17d24e7d7b6bcfffa3d92b8bf8a68',
+};
+
+const getTxListResponseUnsignedSweep: Record<string, unknown> = {
+  status: '1',
+  result: [
+    {
+      hash: '0xede855d43d70ea1bb75db63d4f75113dae0845f0d4bdb0b2d8bda55249c70812',
+      nonce: '23',
+      from: '0x7f3f0386b3e17d24e7d7b6bcfffa3d92b8bf8a68',
+    },
+  ],
+  message: 'OK',
+};
+
+const getBalanceRequestUnsignedSweep: Record<string, string> = {
+  module: 'account',
+  action: 'balance',
+  address: '0x7f3f0386b3e17d24e7d7b6bcfffa3d92b8bf8a68',
+};
+
+const getBalanceResponseUnsignedSweep: Record<string, unknown> = {
+  status: '1',
+  result: '100000000000000000',
+  message: 'OK',
+};
+
+export const mockDataUnsignedSweep = {
+  userKey:
+    '029dd2bdb90da985dc9c2c2bdf0f805ac21832462db53cd99ddf41d2f2dd2a31f2860c724001470a59b38bf67de19481e2811731d4efcd5b496de2ce3fe9baa18e',
+  backupKey:
+    '029dd2bdb90da985dc9c2c2bdf0f805ac21832462db53cd99ddf41d2f2dd2a31f2860c724001470a59b38bf67de19481e2811731d4efcd5b496de2ce3fe9baa18e',
+  derivationPath: 'm/0',
+  derivationSeed: '',
+  walletBaseAddress: '0x7f3f0386b3e17d24e7d7b6bcfffa3d92b8bf8a68',
+  recoveryDestination: '0xb986fd8081b8ca18cc343881bec0a70757309187',
+  getTxListRequest: getTxListRequestUnsignedSweep,
+  getTxListResponse: getTxListResponseUnsignedSweep,
+  getBalanceRequest: getBalanceRequestUnsignedSweep,
+  getBalanceResponse: getBalanceResponseUnsignedSweep,
+};

modules/sdk-coin-oas/test/unit/oas.ts

@@ -1,9 +1,12 @@
-import 'should';
-
+import * as should from 'should';
 import { TestBitGo, TestBitGoAPI } from '@bitgo/sdk-test';
 import { BitGoAPI } from '@bitgo/sdk-api';
 
 import { Oas, Toas } from '../../src/index';
+import { UnsignedSweepTxMPCv2 } from '@bitgo/abstract-eth';
+import { mockDataUnsignedSweep } from '../resources';
+import nock from 'nock';
+import { common } from '@bitgo/sdk-core';
 
 const bitgo: TestBitGoAPI = TestBitGo.decorate(BitGoAPI, { env: 'test' });
 
@@ -40,3 +43,59 @@ describe('OASYS chain', function () {
     });
   });
 });
+
+describe('Build Unsigned Sweep for Self-Custody Cold Wallets - (MPCv2)', function () {
+  const bitgo = TestBitGo.decorate(BitGoAPI, { env: 'test' });
+  const explorerUrl = common.Environments[bitgo.getEnv()].oasExplorerBaseUrl as string;
+  const maxFeePerGasvalue = 20000000000;
+  const maxPriorityFeePerGasValue = 10000000000;
+  const chain_id = 9372;
+  const gasLimitvalue = 500000;
+
+  it('should generate an unsigned sweep without derivation path', async () => {
+    nock(explorerUrl)
+      .get('/api')
+      .twice()
+      .query(mockDataUnsignedSweep.getTxListRequest)
+      .reply(200, mockDataUnsignedSweep.getTxListResponse);
+    nock(explorerUrl)
+      .get('/api')
+      .query(mockDataUnsignedSweep.getBalanceRequest)
+      .reply(200, mockDataUnsignedSweep.getBalanceResponse);
+
+    const baseCoin: any = bitgo.coin('toas');
+    const transaction = (await baseCoin.recover({
+      userKey: mockDataUnsignedSweep.userKey,
+      backupKey: mockDataUnsignedSweep.backupKey,
+      walletContractAddress: mockDataUnsignedSweep.walletBaseAddress,
+      recoveryDestination: mockDataUnsignedSweep.recoveryDestination,
+      isTss: true,
+      eip1559: { maxFeePerGas: maxFeePerGasvalue, maxPriorityFeePerGas: maxPriorityFeePerGasValue },
+      gasLimit: gasLimitvalue,
+      replayProtectionOptions: {
+        chain: chain_id,
+        hardfork: 'london',
+      },
+    })) as UnsignedSweepTxMPCv2;
+    should.exist(transaction);
+    transaction.should.have.property('txRequests');
+    transaction.txRequests.length.should.equal(1);
+    const txRequest = transaction.txRequests[0];
+    txRequest.should.have.property('walletCoin');
+    txRequest.walletCoin.should.equal('toas');
+    txRequest.should.have.property('transactions');
+    txRequest.transactions.length.should.equal(1);
+    const tx = txRequest.transactions[0];
+    tx.should.have.property('nonce');
+    tx.should.have.property('unsignedTx');
+    tx.unsignedTx.should.have.property('serializedTxHex');
+    tx.unsignedTx.should.have.property('signableHex');
+    tx.unsignedTx.should.have.property('derivationPath');
+    tx.unsignedTx.should.have.property('feeInfo');
+    tx.unsignedTx.feeInfo?.should.have.property('fee');
+    tx.unsignedTx.feeInfo?.should.have.property('feeString');
+    tx.unsignedTx.should.have.property('parsedTx');
+    tx.unsignedTx.parsedTx?.should.have.property('spendAmount');
+    tx.unsignedTx.parsedTx?.should.have.property('outputs');
+  });
+});