Merge branch 'master' into rel/latest

Author: mohammadalfaiyazbitgo

modules/abstract-cosmos/src/cosmosCoin.ts

@@ -360,7 +360,6 @@ export class CosmosCoin<CustomMessage = never> extends BaseCoin {
     }
     const transaction = await this.getBuilder().from(rawTx).build();
     const explainedTx = transaction.explainTransaction();
-
     if (txParams.recipients && txParams.recipients.length > 0) {
       const filteredRecipients = txParams.recipients?.map((recipient) => _.pick(recipient, ['address', 'amount']));
       const filteredOutputs = explainedTx.outputs.map((output) => _.pick(output, ['address', 'amount']));

modules/abstract-eth/src/abstractEthLikeNewCoins.ts

@@ -66,8 +66,10 @@ import {
   calculateForwarderV1Address,
   ERC1155TransferBuilder,
   ERC721TransferBuilder,
+  getBufferedByteCode,
   getCommon,
   getProxyInitcode,
+  getRawDecoded,
   getToken,
   KeyPair as KeyPairLib,
   TransactionBuilder,
@@ -2523,7 +2525,7 @@ export abstract class AbstractEthLikeNewCoins extends AbstractEthLikeCoin {
    * @param {Wallet} params.wallet - Wallet object to obtain keys to verify against
    * @returns {boolean}
    */
-  verifyTssTransaction(params: VerifyEthTransactionOptions): boolean {
+  async verifyTssTransaction(params: VerifyEthTransactionOptions): Promise<boolean> {
     const { txParams, txPrebuild, wallet } = params;
     if (
       !txParams?.recipients &&
@@ -2540,6 +2542,39 @@ export abstract class AbstractEthLikeNewCoins extends AbstractEthLikeCoin {
     if (txParams.hop && txParams.recipients && txParams.recipients.length > 1) {
       throw new Error(`tx cannot be both a batch and hop transaction`);
     }
+
+    if (txParams.type && ['transfer'].includes(txParams.type)) {
+      if (txParams.recipients && txParams.recipients.length === 1) {
+        const recipients = txParams.recipients;
+        const expectedAmount = recipients[0].amount.toString();
+        const expectedDestination = recipients[0].address;
+
+        const txBuilder = this.getTransactionBuilder();
+        txBuilder.from(txPrebuild.txHex);
+        const tx = await txBuilder.build();
+        const txJson = tx.toJson();
+        if (txJson.data === '0x') {
+          if (expectedAmount !== txJson.value) {
+            throw new Error('the transaction amount in txPrebuild does not match the value given by client');
+          }
+          if (expectedDestination !== txJson.to) {
+            throw new Error('destination address does not match with the recipient address');
+          }
+        } else if (txJson.data.startsWith('0xa9059cbb')) {
+          const [recipientAddress, amount] = getRawDecoded(
+            ['address', 'uint256'],
+            getBufferedByteCode('0xa9059cbb', txJson.data)
+          );
+          if (expectedAmount !== amount.toString()) {
+            throw new Error('the transaction amount in txPrebuild does not match the value given by client');
+          }
+          if (expectedDestination !== addHexPrefix(recipientAddress.toString())) {
+            throw new Error('destination address does not match with the recipient address');
+          }
+        }
+      }
+    }
+
     return true;
   }
 

modules/abstract-lightning/package.json

@@ -39,7 +39,7 @@
     ]
   },
   "dependencies": {
-    "@bitgo/public-types": "4.17.0",
+    "@bitgo/public-types": "4.26.0",
     "@bitgo/sdk-core": "^33.0.0",
     "@bitgo/statics": "^52.0.0",
     "@bitgo/utxo-lib": "^11.3.0",

modules/abstract-lightning/src/codecs/api/index.ts

@@ -2,5 +2,6 @@ export * from './backup';
 export * from './balance';
 export * from './invoice';
 export * from './payment';
+export * from './withdraw';
 export * from './transaction';
 export * from './wallet';

modules/abstract-lightning/src/codecs/api/withdraw.ts

@@ -0,0 +1,42 @@
+import * as t from 'io-ts';
+import { LightningOnchainRequest } from '@bitgo/public-types';
+import { PendingApprovalData, TxRequestState } from '@bitgo/sdk-core';
+
+// todo:(current) which to keep here which to take to common types
+export const LightningOnchainWithdrawParams = t.intersection([
+  LightningOnchainRequest,
+  t.type({
+    // todo:(current) add passphrase
+    // passphrase: t.string,
+  }),
+]);
+
+export type LightningOnchainWithdrawParams = t.TypeOf<typeof LightningOnchainWithdrawParams>;
+
+export type LightningOnchainWithdrawResponse = {
+  /**
+   * Unique identifier for withdraw request submitted to BitGo.
+   */
+  txRequestId: string;
+
+  /**
+   * Status of withdraw request submission to BitGo.
+   * - `'delivered'`: Successfully received by BitGo, but may or may not have been sent to the Bitcoin network yet.
+   * - For the actual withdraw status, track `transfer`.
+   */
+  txRequestState: TxRequestState;
+
+  /**
+   * Pending approval details, if applicable.
+   * - If present, withdraw has not been initiated yet.
+   */
+  pendingApproval?: PendingApprovalData;
+
+  /**
+   * Latest transfer details for this withdraw request (if available).
+   * - Provides the current state of the transfer.
+   * - To track the latest withdraw status, monitor `transfer` asynchronously.
+   * This field is absent if approval is required before processing.
+   */
+  transfer?: any;
+};

modules/abstract-lightning/src/wallet/lightning.ts

@@ -24,6 +24,8 @@ import {
   TransactionQuery,
   PaymentInfo,
   PaymentQuery,
+  LightningOnchainWithdrawParams,
+  LightningOnchainWithdrawResponse,
 } from '../codecs';
 import { LightningPaymentIntent, LightningPaymentRequest } from '@bitgo/public-types';
 
@@ -156,6 +158,15 @@ export interface ILightningWallet {
    * @returns {Promise<PayInvoiceResponse>} Payment result containing transaction request details and payment status
    */
   payInvoice(params: SubmitPaymentParams): Promise<PayInvoiceResponse>;
+
+  /**
+   * On chain withdrawal
+   * @param {LightningOnchainWithdrawParams} params - Withdraw parameters
+   * @param {LightningOnchainRecipient[]} params.recipients - The recipients to pay
+   * @param {bigint} [params.satsPerVbyte] - Optional value for sats per virtual byte
+   * @returns {Promise<LightningOnchainWithdrawResponse>} Withdraw result containing transaction request details and status
+   */
+  withdrawOnchain(params: LightningOnchainWithdrawParams): Promise<LightningOnchainWithdrawResponse>;
   /**
    * Get payment details by payment hash
    * @param {string} paymentHash - Payment hash to lookup
@@ -301,6 +312,49 @@ export class LightningWallet implements ILightningWallet {
     };
   }
 
+  async withdrawOnchain(params: LightningOnchainWithdrawParams): Promise<LightningOnchainWithdrawResponse> {
+    const reqId = new RequestTracer();
+    this.wallet.bitgo.setRequestTracer(reqId);
+
+    const paymentIntent: { intent: LightningPaymentIntent } = {
+      intent: {
+        onchainRequest: {
+          recipients: params.recipients,
+          satsPerVbyte: params.satsPerVbyte,
+        },
+        intentType: 'payment',
+      },
+    };
+
+    const transactionRequestCreate = (await this.wallet.bitgo
+      .post(this.wallet.bitgo.url('/wallet/' + this.wallet.id() + '/txrequests', 2))
+      .send(t.type({ intent: LightningPaymentIntent }).encode(paymentIntent))
+      .result()) as TxRequest;
+
+    if (transactionRequestCreate.state === 'pendingApproval') {
+      const pendingApprovals = new PendingApprovals(this.wallet.bitgo, this.wallet.baseCoin);
+      const pendingApproval = await pendingApprovals.get({ id: transactionRequestCreate.pendingApprovalId });
+      return {
+        pendingApproval: pendingApproval.toJSON(),
+        txRequestId: transactionRequestCreate.txRequestId,
+        txRequestState: transactionRequestCreate.state,
+      };
+    }
+
+    const transactionRequestSend = await commonTssMethods.sendTxRequest(
+      this.wallet.bitgo,
+      this.wallet.id(),
+      transactionRequestCreate.txRequestId,
+      RequestType.tx,
+      reqId
+    );
+
+    return {
+      txRequestId: transactionRequestCreate.txRequestId,
+      txRequestState: transactionRequestSend.state,
+    };
+  }
+
   async getPayment(paymentHash: string): Promise<PaymentInfo> {
     const response = await this.wallet.bitgo
       .get(this.wallet.bitgo.url(`/wallet/${this.wallet.id()}/lightning/payment/${paymentHash}`, 2))

modules/bitgo/test/v2/unit/internal/tssUtils/ecdsa.ts

@@ -490,8 +490,11 @@ describe('TSS Ecdsa Utils:', async function () {
       transactions: [
         {
           unsignedTx: {
-            serializedTxHex: 'TOO MANY SECRETS',
-            signableHex: 'TOO MANY SECRETS',
+            // hteth txid: 0xc5a7bfe6b13ceae563da0f9feaa9c4ad1c101a15366a2a488828a5dd27cb9da3
+            serializedTxHex:
+              '02f38242688084448b9b8084448b9b908301637894a1cfb9d51c0af191ff21c5f0f01723e056f7dc12865af3107a400080c0808080',
+            signableHex:
+              '02f08242688084448b9b8084448b9b908301637894a1cfb9d51c0af191ff21c5f0f01723e056f7dc12865af3107a400080c0',
             derivationPath: '', // Needs this when key derivation is supported
           },
           state: 'pendingSignature',
@@ -500,8 +503,11 @@ describe('TSS Ecdsa Utils:', async function () {
       ],
       unsignedTxs: [
         {
-          serializedTxHex: 'TOO MANY SECRETS',
-          signableHex: 'TOO MANY SECRETS',
+          // hteth txid: 0xc5a7bfe6b13ceae563da0f9feaa9c4ad1c101a15366a2a488828a5dd27cb9da3
+          serializedTxHex:
+            '02f38242688084448b9b8084448b9b908301637894a1cfb9d51c0af191ff21c5f0f01723e056f7dc12865af3107a400080c0808080',
+          signableHex:
+            '02f38242688084448b9b8084448b9b908301637894a1cfb9d51c0af191ff21c5f0f01723e056f7dc12865af3107a400080c0808080',
           derivationPath: '', // Needs this when key derivation is supported
         },
       ],
@@ -764,6 +770,68 @@ describe('TSS Ecdsa Utils:', async function () {
       userGpgActual.should.startWith('-----BEGIN PGP PUBLIC KEY BLOCK-----');
     });
 
+    it('signTxRequest should fail with wrong recipient', async function () {
+      await setupSignTxRequestNocks(true, userSignShare, aShare, dShare, enterpriseData);
+      await tssUtils
+        .signTxRequest({
+          txRequest: txRequestId,
+          prv: JSON.stringify({
+            pShare: userKeyShare.pShare,
+            bitgoNShare: bitgoKeyShare.nShares[1],
+            backupNShare: backupKeyShare.nShares[1],
+          }),
+          reqId,
+          txParams: { recipients: [{ address: '0x1234', amount: '100000000000000' }], type: 'transfer' },
+        })
+        .should.be.rejectedWith('destination address does not match with the recipient address');
+    });
+
+    it('signTxRequest should fail with incorrect value', async function () {
+      await setupSignTxRequestNocks(true, userSignShare, aShare, dShare, enterpriseData);
+      await tssUtils
+        .signTxRequest({
+          txRequest: txRequestId,
+          prv: JSON.stringify({
+            pShare: userKeyShare.pShare,
+            bitgoNShare: bitgoKeyShare.nShares[1],
+            backupNShare: backupKeyShare.nShares[1],
+          }),
+          reqId,
+          txParams: {
+            recipients: [{ address: '0xa1cfb9d51c0af191ff21c5f0f01723e056f7dc12', amount: '1' }],
+            type: 'transfer',
+          },
+        })
+        .should.be.rejectedWith('the transaction amount in txPrebuild does not match the value given by client');
+    });
+
+    it('signTxRequest should fail with incorrect value for token txn', async function () {
+      const signableHex =
+        '02f86d8242681083122c9e83122cae8301e04994ebe8b46a42f05072b723b00013ff822b2af1b5cb80b844a9059cbb0000000000000000000000002b0d6cb2f8c388757f4d7ad857fccab18290dbc900000000000000000000000000000000000000000000000000000000000186a0c0';
+      const serializedTxHex =
+        '02f8708242681083122c9e83122cae8301e04994ebe8b46a42f05072b723b00013ff822b2af1b5cb80b844a9059cbb0000000000000000000000002b0d6cb2f8c388757f4d7ad857fccab18290dbc900000000000000000000000000000000000000000000000000000000000186a0c0808080';
+      await setupSignTxRequestNocks(true, userSignShare, aShare, dShare, enterpriseData, {
+        signableHex,
+        serializedTxHex,
+        apiVersion: 'full',
+      });
+      await tssUtils
+        .signTxRequest({
+          txRequest: txRequestId,
+          prv: JSON.stringify({
+            pShare: userKeyShare.pShare,
+            bitgoNShare: bitgoKeyShare.nShares[1],
+            backupNShare: backupKeyShare.nShares[1],
+          }),
+          reqId,
+          txParams: {
+            recipients: [{ address: '0x2b0d6cb2f8c388757f4d7ad857fccab18290dbc9', amount: '707' }],
+            type: 'transfer',
+          },
+        })
+        .should.be.rejectedWith('the transaction amount in txPrebuild does not match the value given by client');
+    });
+
     it('getOfflineSignerPaillierModulus should succeed', async function () {
       const paillierModulus = tssUtils.getOfflineSignerPaillierModulus({
         prv: JSON.stringify({
@@ -932,7 +1000,12 @@ describe('TSS Ecdsa Utils:', async function () {
       userSignShare: ECDSA.SignShareRT,
       aShare: ECDSA.AShare,
       dShare: ECDSA.DShare,
-      enterpriseData?: EnterpriseData
+      enterpriseData: EnterpriseData,
+      {
+        signableHex,
+        serializedTxHex,
+        apiVersion,
+      }: { signableHex?: string; serializedTxHex?: string; apiVersion?: 'full' | 'lite' } = {}
     ) {
       if (enterpriseData) {
         await nockGetEnterprise({ enterpriseId: enterpriseData.id, response: enterpriseData, times: 1 });
@@ -947,12 +1020,13 @@ describe('TSS Ecdsa Utils:', async function () {
               {
                 ...txRequest,
                 unsignedTx: {
-                  signableHex: txRequest.unsignedTxs[0].signableHex,
-                  serializedTxHex: txRequest.unsignedTxs[0].serializedTxHex,
+                  signableHex: signableHex ?? txRequest.unsignedTxs[0].signableHex,
+                  serializedTxHex: serializedTxHex ?? txRequest.unsignedTxs[0].serializedTxHex,
                   derivationPath,
                 },
               },
             ],
+            apiVersion: apiVersion,
           },
         ],
       };
@@ -976,6 +1050,7 @@ describe('TSS Ecdsa Utils:', async function () {
                 },
               },
             ],
+            apiVersion: apiVersion,
           },
         ],
       };
@@ -996,6 +1071,7 @@ describe('TSS Ecdsa Utils:', async function () {
                 },
               },
             ],
+            apiVersion: apiVersion,
           },
         ],
       };

modules/bitgo/test/v2/unit/keychains.ts

@@ -80,6 +80,7 @@ describe('V2 Keychains', function () {
         n.asset !== UnderlyingAsset.WORLD &&
         n.asset !== UnderlyingAsset.STT &&
         n.asset !== UnderlyingAsset.SONEIUM &&
+        n.asset !== UnderlyingAsset.VET &&
         coinFamilyValues.includes(n.name)
     );