Skip to content

docs(express): constructPendingApprovalTxV1 API definition #7571

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
lokesh-bitgo merged 1 commit into from
Nov 20, 2025
Merged

docs(express): constructPendingApprovalTxV1 API definition #7571

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
26 changes: 16 additions & 10 deletions modules/express/src/typedRoutes/api/v1/constructPendingApprovalTx.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,24 +69,30 @@ export const ConstructPendingApprovalTxResponse = t.type({
/**
* Construct a pending approval transaction
*
* Constructs and signs a transaction for a pending approval without broadcasting it to the network.
* This endpoint allows you to preview and validate the transaction details before final approval.
* Constructs and signs a transaction for a transactionRequest type pending approval without
* broadcasting it to the network. This allows you to preview and validate the transaction
* details before final approval.
*
* **Important:** This endpoint ONLY works for transactionRequest type pending approvals.
* Other approval types (e.g., policy changes, user additions) are not supported.
*
* **Authentication Requirements:**
* - For transactionRequest type approvals, you must provide either walletPassphrase or xprv to sign the transaction
* - You must provide either walletPassphrase or xprv to sign the transaction
* - The user must have permission to approve the pending approval
*
* **Fee Customization:**
* - Use `useOriginalFee: true` to preserve the fee from the original transaction request
* - Alternatively, specify custom fee parameters (fee, feeRate, or feeTxConfirmTarget)
* - Fee parameters cannot be combined with useOriginalFee
* - `useOriginalFee: true` - Preserves the fee from the original transaction request
* - Custom fee parameters - Specify fee, feeRate, or feeTxConfirmTarget
* - Default behavior - If no fee parameters provided, fee is recalculated based on current conditions
* - Note: Fee parameters cannot be combined with useOriginalFee
*
* **Workflow:**
* 1. Retrieves the pending approval by ID
* 2. Constructs the transaction according to the approval parameters
* 3. Signs the transaction (for transactionRequest approvals)
* 4. Returns the signed transaction hex and metadata
* 5. Transaction is NOT broadcast to the network
* 2. Parses the original transaction to extract recipients
* 3. Reconstructs the transaction with specified or original fee
* 4. Signs the transaction with the user's key
* 5. Returns the signed transaction hex and metadata
* 6. Transaction is NOT broadcast to the network
*
* @operationId express.v1.pendingapproval.constructTx
* @tag express
Expand Down