-
Notifications
You must be signed in to change notification settings - Fork 37.7k
rpc: Missing doc updates for bumpfee psbt update #21544
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.
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
Conversation
Rendered diff: --- a/bumpfee
+++ b/bumpfee
@@ -1,56 +1,56 @@
bumpfee "txid" ( options )
Bumps the fee of an opt-in-RBF transaction T, replacing it with a new transaction B.
An opt-in RBF transaction with the given txid must be in the wallet.
The command will pay the additional fee by reducing change outputs or adding inputs when necessary.
It may add a new change output if one does not already exist.
All inputs in the original transaction will be included in the replacement transaction.
The command will fail if the wallet or mempool contains a transaction that spends one of T's outputs.
By default, the new fee will be calculated automatically using the estimatesmartfee RPC.
The user can specify a confirmation target for estimatesmartfee.
Alternatively, the user can specify a fee rate in sat/vB for the new transaction.
At a minimum, the new fee rate must be high enough to pay an additional new relay fee (incrementalfee
returned by getnetworkinfo) to enter the node's mempool.
* WARNING: before version 0.21, fee_rate was in BTC/kvB. As of 0.21, fee_rate is in sat/vB. *
Arguments:
1. txid (string, required) The txid to be bumped
2. options (json object, optional)
{
"conf_target": n, (numeric, optional, default=wallet -txconfirmtarget) Confirmation target in blocks
"fee_rate": amount, (numeric or string, optional, default=not set, fall back to wallet fee estimation)
Specify a fee rate in sat/vB instead of relying on the built-in fee estimator.
Must be at least 1.000 sat/vB higher than the current transaction fee rate.
WARNING: before version 0.21, fee_rate was in BTC/kvB. As of 0.21, fee_rate is in sat/vB.
"replaceable": bool, (boolean, optional, default=true) Whether the new transaction should still be
marked bip-125 replaceable. If true, the sequence numbers in the transaction will
be left unchanged from the original. If false, any input sequence numbers in the
original transaction that were less than 0xfffffffe will be increased to 0xfffffffe
so the new transaction will not be explicitly bip-125 replaceable (though it may
still be replaceable in practice, for example if it has unconfirmed ancestors which
are replaceable).
"estimate_mode": "str", (string, optional, default=unset) The fee estimate mode, must be one of (case insensitive):
"unset"
"economical"
"conservative"
}
Result:
{ (json object)
- "psbt" : "str", (string) The base64-encoded unsigned PSBT of the new transaction. Only returned when wallet private keys are disabled. (DEPRECATED)
+ "psbt" : "str", (string) The base64-encoded unsigned PSBT of the new transaction.
"txid" : "hex", (string) The id of the new transaction. Only returned when wallet private keys are enabled.
"origfee" : n, (numeric) The fee of the replaced transaction.
"fee" : n, (numeric) The fee of the new transaction.
"errors" : [ (json array) Errors encountered during processing (may be empty).
"str", (string)
...
]
}
Examples:
Bump the fee, get the new transaction'stxid
> bitcoin-cli bumpfee <txid> |
The following sections might be updated with supplementary metadata relevant to reviewers and maintainers. ConflictsReviewers, this pull request conflicts with the following ones:
If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first. |
Adds updates that have been missed in commit ea0a7ec: * RPC help doc update * Release notes update * Remove "mutable" keyword from lambda
fa225af
to
1111896
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ACK 1111896
4f504f8 rpc: fix code comment for bumpfee/psbtbumpfee output (Jon Atack) 5cb7ac2 rpc: fix docs for bumpfee psbt update (Jon Atack) Pull request description: Follow-up to bitcoin#21544 and bitcoin#20891 for the `bumpfee_helper` used for RPCs bumpfee and psbtbumpfee: - "psbt" field is only returned in psbtbumpfee and not bumpfee - bumpfee raises if private keys are disabled, so the txid help "Only returned when wallet private keys are enabled." no longer makes sense; remove it - add missing space in RPC examples ("Bump the fee, get the new transaction'stxid") - update txid/psbt code comments ACKs for top commit: klementtan: ACK [`4f504f8`](bitcoin@4f504f8) Tree-SHA512: 194faf8af52383eb8ac5cd22825265931bcde135dac79d8ecc4f84f698070da9b9373c00eef8623961881bb293157c7c9a0d71d1bcccf481ae3605a2d1444ed8
4f504f8 rpc: fix code comment for bumpfee/psbtbumpfee output (Jon Atack) 5cb7ac2 rpc: fix docs for bumpfee psbt update (Jon Atack) Pull request description: Follow-up to bitcoin#21544 and bitcoin#20891 for the `bumpfee_helper` used for RPCs bumpfee and psbtbumpfee: - "psbt" field is only returned in psbtbumpfee and not bumpfee - bumpfee raises if private keys are disabled, so the txid help "Only returned when wallet private keys are enabled." no longer makes sense; remove it - add missing space in RPC examples ("Bump the fee, get the new transaction'stxid") - update txid/psbt code comments ACKs for top commit: klementtan: ACK [`4f504f8`](bitcoin@4f504f8) Tree-SHA512: 194faf8af52383eb8ac5cd22825265931bcde135dac79d8ecc4f84f698070da9b9373c00eef8623961881bb293157c7c9a0d71d1bcccf481ae3605a2d1444ed8
Stuff missed in #20891. Also merge release notes, so that it doesn't have to be done later.