feat(sdk-core): add automatic signature cleanup for Express TSS signing #7256

dpkjnr · 2025-10-15T18:38:56Z

Fixes Express API gap where re-signing partially signed Full TxRequests would fail. The /signtxtss route now automatically detects and cleans up partial signature shares before attempting to sign.

Changes:

Add ensureCleanSigSharesAndSignTransaction() to Wallet class
Update Express handleV2SignTSSWalletTx() to use new method
Add comprehensive unit tests for signature cleanup logic
Check signature shares presence instead of transaction state

Benefits:

Fixes re-signing failures for partially signed transactions
Backward compatible with existing signing flows
No API changes required
Keeps tssUtils properly encapsulated

Ticket: COIN-5989

nvjsr · 2025-10-16T08:22:20Z

@claude review

Copilot

Pull Request Overview

This PR fixes an API gap in the Express TSS signing endpoint where re-signing partially signed Full TxRequests would fail due to stale signature shares. The solution adds automatic signature cleanup before signing operations.

Adds signature share cleanup logic to detect and clean partial signatures before signing
Updates Express TSS signing endpoint to use the new cleanup method
Provides comprehensive test coverage for the signature cleanup scenarios

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File	Description
modules/sdk-core/src/bitgo/wallet/wallet.ts	Adds ensureCleanSigSharesAndSignTransaction method with signature cleanup logic
modules/express/src/clientRoutes.ts	Updates Express TSS signing to use new cleanup method
modules/bitgo/test/v2/unit/wallet.ts	Adds comprehensive unit tests for signature cleanup functionality

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

modules/sdk-core/src/bitgo/wallet/wallet.ts

Copilot · 2025-10-16T08:38:38Z

modules/sdk-core/src/bitgo/wallet/wallet.ts

+          isPartiallySigned = txRequest.transactions.some((tx) => (tx.signatureShares ?? []).length > 0);
+        } else if (txRequest.messages && txRequest.messages.length > 0) {
+          isPartiallySigned = txRequest.messages.some((msg) => (msg.signatureShares ?? []).length > 0);


The partial signature detection logic is duplicated between transactions and messages. Consider extracting this into a helper function to reduce code duplication and improve maintainability.

+1,

can do something like

const signabeResources: { signatureShares: [] } = txRequest.transactions?.length ? txRequest.transactions : txRequest.messages ?? [];

sachinBitgo · 2025-10-16T09:33:57Z

modules/sdk-core/src/bitgo/wallet/wallet.ts

+  ): Promise<SignedTransaction | TxRequest> {
+    const txRequestId = params.txRequestId || params.txPrebuild?.txRequestId;
+
+    if (txRequestId && this.tssUtils && this.multisigType() === 'tss') {


can we also separate the cleaning part in different method. It think it will make the method ensureCleanSigSharesAndSignTransaction more readable.

lokesh-bitgo · 2025-10-22T07:56:03Z

modules/sdk-core/src/bitgo/wallet/wallet.ts

+        let isPartiallySigned = false;
+
+        if (txRequest.transactions && txRequest.transactions.length > 0) {
+          isPartiallySigned = txRequest.transactions.some((tx) => (tx.signatureShares ?? []).length > 0);


Are we not considering any transaction state for this?

I saw something similar in wallet-platform also, would there be any case where sigShares are there but state is postSign or something where we should not delete sig shares?

The state could be readyToCombineShares which means it has been fully signed, but has not been broadcasted yet (the end state of v2.wallet.txrequest.sign is readyToCombineShares, and this is validated in the send api)

modules/express/test/unit/typedRoutes/walletTxSignTSS.ts

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

zahin-mohammad · 2025-10-22T21:15:01Z

modules/sdk-core/src/bitgo/wallet/wallet.ts

+        if (isPartiallySigned) {
+          await this.tssUtils.deleteSignatureShares(txRequestId);
+        }


Can't we always just rebuild/delete sig shares before signing? Or are we avoiding this for latency reasons?

that looks cleaner but we would make additional delete sigshares API call even in case of fresh transaction. If it looks fine to your team then I can make it default for txRequest full

modules/sdk-core/src/bitgo/wallet/wallet.ts

zahin-mohammad · 2025-10-22T21:19:44Z

modules/sdk-core/src/bitgo/wallet/wallet.ts

+        let isPartiallySigned = false;
+
+        if (txRequest.transactions && txRequest.transactions.length > 0) {
+          isPartiallySigned = txRequest.transactions.some((tx) => (tx.signatureShares ?? []).length > 0);


The state could be readyToCombineShares which means it has been fully signed, but has not been broadcasted yet (the end state of v2.wallet.txrequest.sign is readyToCombineShares, and this is validated in the send api)

zahin-mohammad · 2025-10-22T21:20:49Z

modules/sdk-core/src/bitgo/wallet/wallet.ts

+          isPartiallySigned = txRequest.transactions.some((tx) => (tx.signatureShares ?? []).length > 0);
+        } else if (txRequest.messages && txRequest.messages.length > 0) {
+          isPartiallySigned = txRequest.messages.some((msg) => (msg.signatureShares ?? []).length > 0);


+1,

can do something like

const signabeResources: { signatureShares: [] } = txRequest.transactions?.length ? txRequest.transactions : txRequest.messages ?? [];

Fixes Express API gap where re-signing partially signed Full TxRequests would fail. The /signtxtss route now always cleans up signature shares for txRequest full before attempting to sign. Changes: - Add ensureCleanSigSharesAndSignTransaction() to Wallet class - Update Express handleV2SignTSSWalletTx() to use new method - Add comprehensive unit tests for signature cleanup logic Ticket: COIN-5989

kaustubhbitgo · 2025-10-28T03:39:38Z

modules/sdk-core/src/bitgo/wallet/wallet.ts

+    const txRequestId = params.txRequestId || params.txPrebuild?.txRequestId;
+
+    if (txRequestId && this.tssUtils && this.multisigType() === 'tss') {
+      const txRequest = await this.tssUtils.getTxRequest(txRequestId);


Would it make sense to move this whole logic to backend via a params.rebuild flag in signTransaction call? This way we can abstract the logic for multiple wallet types (future requirement) and control the implementation details.

dpkjnr marked this pull request as ready for review October 16, 2025 08:05

dpkjnr requested review from a team as code owners October 16, 2025 08:05

dpkjnr requested review from kaustubhbitgo and lokesh-bitgo October 16, 2025 08:05

nvjsr previously approved these changes Oct 16, 2025

View reviewed changes

dpkjnr requested a review from Copilot October 16, 2025 08:38

Copilot AI reviewed Oct 16, 2025

View reviewed changes

kamleshmugdiya previously approved these changes Oct 16, 2025

View reviewed changes

sachinBitgo reviewed Oct 16, 2025

View reviewed changes

dpkjnr dismissed stale reviews from kamleshmugdiya and nvjsr via 43e90f9 October 17, 2025 07:40

dpkjnr force-pushed the delete-sigshare-on-signTss branch 2 times, most recently from b8a43f0 to ae9c08f Compare October 17, 2025 10:42

dpkjnr marked this pull request as draft October 17, 2025 11:08

dpkjnr force-pushed the delete-sigshare-on-signTss branch from ae9c08f to f8fcd9e Compare October 22, 2025 05:12

dpkjnr marked this pull request as ready for review October 22, 2025 07:34

dpkjnr requested review from kamleshmugdiya, nvjsr and sachinBitgo October 22, 2025 07:43

lokesh-bitgo reviewed Oct 22, 2025

View reviewed changes

modules/express/test/unit/typedRoutes/walletTxSignTSS.ts Show resolved Hide resolved

lokesh-bitgo reviewed Oct 22, 2025

View reviewed changes

modules/bitgo/test/v2/unit/wallet.ts Outdated Show resolved Hide resolved

lokesh-bitgo requested a review from zahin-mohammad October 22, 2025 08:04

dpkjnr force-pushed the delete-sigshare-on-signTss branch from f8fcd9e to 71b889c Compare October 22, 2025 14:58

dpkjnr requested a review from lokesh-bitgo October 22, 2025 16:33

zahin-mohammad reviewed Oct 22, 2025

View reviewed changes

dpkjnr requested a review from zahin-mohammad October 27, 2025 05:15

dpkjnr force-pushed the delete-sigshare-on-signTss branch from b17eb7d to c222e83 Compare October 27, 2025 11:25

kaustubhbitgo reviewed Oct 28, 2025

View reviewed changes

zahin-mohammad removed their request for review October 28, 2025 14:55

Uh oh!

feat(sdk-core): add automatic signature cleanup for Express TSS signing #7256

Are you sure you want to change the base?

feat(sdk-core): add automatic signature cleanup for Express TSS signing #7256

Conversation

dpkjnr commented Oct 15, 2025

Uh oh!

nvjsr commented Oct 16, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Copilot AI Oct 16, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kaustubhbitgo Oct 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

kaustubhbitgo Oct 28, 2025 •

edited

Loading