Skip to content

docs(express): update descriptions coinsigntx #8528

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rishikeshdadam136 merged 1 commit into from
Apr 17, 2026
Merged

docs(express): update descriptions coinsigntx #8528

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 6 additions & 30 deletions modules/express/src/typedRoutes/api/v2/coinSignTx.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { BitgoExpressError } from '../../schemas/error';
* Request parameters for signing a transaction
*/
export const CoinSignTxParams = {
/** The coin type */
/** A cryptocurrency or token ticker symbol */
coin: t.string,
} as const;

Expand Down Expand Up @@ -254,11 +254,11 @@ export const TransactionPrebuild = t.partial({
* Reference: modules/abstract-eth/src/abstractEthLikeNewCoins.ts:168-177 (EVM fields)
*/
export const CoinSignTxBody = {
/** Private key for signing (universal field) */
/** User private key */
prv: optional(t.string),
/** Transaction prebuild data (universal field) */
txPrebuild: optional(TransactionPrebuild),
/** Whether this is the last signature in a multi-sig tx */
/** Should be set to true if you are signing the second time, attaching the final signature. Default to false */
isLastSignature: optional(t.boolean),

// EVM-specific fields
Expand All @@ -284,7 +284,7 @@ export const CoinSignTxBody = {
walletContractAddress: optional(t.string),

// UTXO-specific fields
/** Public keys for multi-signature transactions (xpub triple: user, backup, bitgo) */
/** Public Keys (user, backup, bitgo) for the wallet (UTXO coins only) */
pubs: optional(t.array(t.string)),
/** Cosigner public key (defaults to bitgo) */
cosignerPub: optional(t.string),
Expand Down Expand Up @@ -394,34 +394,10 @@ export const CoinSignTxResponse = {
};

/**
* Sign a transaction for a specific coin
* This route is for users who would like to maintain their own keys, or otherwise would not like BitGo to decrypt their key, and instead provide it in the clear themselves
*
* This endpoint signs a transaction for a specific coin type.
* The request body is passed directly to coin.signTransaction() and varies by coin.
*
* Universal fields:
* - txPrebuild: Contains transaction data like txHex or txBase64
* - prv: Private key for signing
* - isLastSignature: Whether this is the last signature in a multi-sig tx
*
* EVM-specific fields (Ethereum, Polygon, etc.):
* - gasLimit: Gas limit for transactions
* - gasPrice: Gas price for transactions
* - expireTime: Transaction expiration time
* - sequenceId: Sequence ID for replay protection
* - recipients: Transaction recipients
* - custodianTransactionId: Custodian transaction ID
* - walletVersion: Wallet version
* - isEvmBasedCrossChainRecovery: For cross-chain recovery
*
* UTXO-specific fields (Bitcoin, Litecoin, etc.):
* - pubs: Public keys array (xpub triple: user, backup, bitgo)
* - cosignerPub: Cosigner's public key (defaults to bitgo)
* - signingStep: MuSig2 signing step
* - allowNonSegwitSigningWithoutPrevTx: Legacy parameter
*
* @tag express
* @operationId express.v2.coin.signtx
* @tag Express
*/
export const PostCoinSignTx = httpRoute({
path: '/api/v2/{coin}/signtx',
Expand Down
Loading