rpc: Missing doc updates for bumpfee psbt update

MarcoFalke commented at 9:30 am on March 29, 2021: member

Stuff missed in #20891. Also merge release notes, so that it doesn’t have to be done later.

fanquake added the label RPC/REST/ZMQ on Mar 29, 2021

MarcoFalke commented at 9:36 am on March 29, 2021: member

Rendered diff:

 0--- a/bumpfee
 1+++ b/bumpfee
 2@@ -1,56 +1,56 @@
 3 bumpfee "txid" ( options )
 4 
 5 Bumps the fee of an opt-in-RBF transaction T, replacing it with a new transaction B.
 6 An opt-in RBF transaction with the given txid must be in the wallet.
 7 The command will pay the additional fee by reducing change outputs or adding inputs when necessary.
 8 It may add a new change output if one does not already exist.
 9 All inputs in the original transaction will be included in the replacement transaction.
10 The command will fail if the wallet or mempool contains a transaction that spends one of T's outputs.
11 By default, the new fee will be calculated automatically using the estimatesmartfee RPC.
12 The user can specify a confirmation target for estimatesmartfee.
13 Alternatively, the user can specify a fee rate in sat/vB for the new transaction.
14 At a minimum, the new fee rate must be high enough to pay an additional new relay fee (incrementalfee
15 returned by getnetworkinfo) to enter the node's mempool.
16 * WARNING: before version 0.21, fee_rate was in BTC/kvB. As of 0.21, fee_rate is in sat/vB. *
17 
18 Arguments:
19 1. txid                           (string, required) The txid to be bumped
20 2. options                        (json object, optional)
21      {
22        "conf_target": n,          (numeric, optional, default=wallet -txconfirmtarget) Confirmation target in blocks
23                                   
24        "fee_rate": amount,        (numeric or string, optional, default=not set, fall back to wallet fee estimation) 
25                                   Specify a fee rate in sat/vB instead of relying on the built-in fee estimator.
26                                   Must be at least 1.000 sat/vB higher than the current transaction fee rate.
27                                   WARNING: before version 0.21, fee_rate was in BTC/kvB. As of 0.21, fee_rate is in sat/vB.
28                                   
29        "replaceable": bool,       (boolean, optional, default=true) Whether the new transaction should still be
30                                   marked bip-125 replaceable. If true, the sequence numbers in the transaction will
31                                   be left unchanged from the original. If false, any input sequence numbers in the
32                                   original transaction that were less than 0xfffffffe will be increased to 0xfffffffe
33                                   so the new transaction will not be explicitly bip-125 replaceable (though it may
34                                   still be replaceable in practice, for example if it has unconfirmed ancestors which
35                                   are replaceable).
36                                   
37        "estimate_mode": "str",    (string, optional, default=unset) The fee estimate mode, must be one of (case insensitive):
38                                   "unset"
39                                   "economical"
40                                   "conservative"
41      }
42 
43 Result:
44 {                    (json object)
45-  "psbt" : "str",    (string) The base64-encoded unsigned PSBT of the new transaction. Only returned when wallet private keys are disabled. (DEPRECATED)
46+  "psbt" : "str",    (string) The base64-encoded unsigned PSBT of the new transaction.
47   "txid" : "hex",    (string) The id of the new transaction. Only returned when wallet private keys are enabled.
48   "origfee" : n,     (numeric) The fee of the replaced transaction.
49   "fee" : n,         (numeric) The fee of the new transaction.
50   "errors" : [       (json array) Errors encountered during processing (may be empty).
51     "str",           (string)
52     ...
53   ]
54 }
55 
56 Examples:
57 
58 Bump the fee, get the new transaction'stxid
59 > bitcoin-cli bumpfee <txid>

DrahtBot commented at 1:02 pm on March 29, 2021: member

The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

Conflicts

Reviewers, this pull request conflicts with the following ones:

#21359 (rpc: include_unsafe option for fundrawtransaction by t-bast)
#21284 (rpc: add the add_inputs option to bumpfee/psbtbumpfee by danben)

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.

rpc: Missing doc updates for bumpfee psbt update

Adds updates that have been missed in commit
ea0a7ec949f0f7e212f0d8819f7a54cad2258bdd:

* RPC help doc update
* Release notes update
* Remove "mutable" keyword from lambda

faeba9819d

doc: Merge release notes 1111896eb7

MarcoFalke force-pushed on Mar 29, 2021

fanquake approved

fanquake commented at 7:00 am on March 31, 2021: member

ACK 1111896eb7865a7bc474ee2aa338c97c22a66c14

fanquake merged this on Apr 1, 2021

fanquake closed this on Apr 1, 2021

MarcoFalke deleted the branch on Apr 1, 2021

sidhujag referenced this in commit cbc02c265f on Apr 1, 2021

MarcoFalke referenced this in commit db1aca01d5 on May 25, 2021

sidhujag referenced this in commit ddb28d1120 on May 25, 2021

DrahtBot locked this on Aug 16, 2022

rpc: Missing doc updates for bumpfee psbt update #21544

Conflicts