Skip to content

Commit d83c2d4

Browse files
Merge pull request #8524 from BitGo/WCI-49
docs(express): sign mpc tx
2 parents 1c1e630 + 1f53227 commit d83c2d4

1 file changed

Lines changed: 4 additions & 21 deletions

File tree

modules/express/src/typedRoutes/api/v2/walletTxSignTSS.ts

Lines changed: 4 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import { Recipient } from './coinSignTx';
88
* Request path parameters for signing a TSS wallet transaction
99
*/
1010
export const WalletTxSignTSSParams = {
11-
/** The coin type */
11+
/** A cryptocurrency or token ticker symbol */
1212
coin: t.string,
1313
/** The wallet ID */
1414
id: t.string,
@@ -48,7 +48,7 @@ export const WalletTxSignTSSTransactionPrebuild = t.partial({
4848
export const WalletTxSignTSSBody = {
4949
/** Transaction prebuild data */
5050
txPrebuild: optional(WalletTxSignTSSTransactionPrebuild),
51-
/** Transaction request ID for TSS wallets */
51+
/** A unique ID for the TxRequest document across all wallets. The combination of the txRequestId and version will always be unique */
5252
txRequestId: optional(t.string),
5353
/** Wallet passphrase for TSS wallets */
5454
walletPassphrase: optional(t.string),
@@ -139,27 +139,10 @@ export const WalletTxSignTSSResponse = {
139139
};
140140

141141
/**
142-
* Sign a transaction for a specific TSS wallet
143-
*
144-
* This endpoint signs a transaction for a specific TSS wallet identified by coin type and wallet ID.
145-
* The request body is passed to wallet.signTransaction() and varies by coin and wallet type.
146-
*
147-
* Common fields for TSS wallets include:
148-
* - txPrebuild: Contains transaction data like txHex, txBase64, or txRequestId
149-
* - walletPassphrase: Passphrase for TSS wallets (required for TSS signing)
150-
* - txRequestId: Transaction request ID for TSS wallets (can be in body or txPrebuild)
151-
* - apiVersion: 'lite' or 'full' for TSS transaction requests
152-
* - multisigTypeVersion: 'MPCv2' for MPCv2 wallets
153-
* - isLastSignature: Whether this is the last signature in a multi-sig tx
154-
* - pubs: Public keys for multi-signature transactions
155-
* - gasLimit: Gas limit for ETH transactions
156-
* - gasPrice: Gas price for ETH transactions
157-
* - expireTime: Transaction expiration time
158-
* - sequenceId: Sequence ID for transactions
159-
* - isEvmBasedCrossChainRecovery: For EVM cross-chain recovery
142+
* Sign transactions for MPC wallets. If using external-signer mode, you must maintain your keys, in the clear, on a separate Express server - BitGo doesn't decrypt your private MPC key shares.
160143
*
161-
* @tag express
162144
* @operationId express.v2.wallet.signtxtss
145+
* @tag Express
163146
*/
164147
export const PostWalletTxSignTSS: HttpRoute<'post'> = httpRoute({
165148
path: '/api/v2/{coin}/wallet/{id}/signtxtss',

0 commit comments

Comments
 (0)