Skip to content

Conversation

@maflcko
Copy link
Member

@maflcko maflcko commented Dec 4, 2020

Not sure why this doesn't use the doc helper, probably an oversight?

@maflcko maflcko added Docs and removed Docs labels Dec 4, 2020
@maflcko maflcko changed the title rpc: Use FeeModes doc helper in estimatesmartfee doc: Use FeeModes doc helper in estimatesmartfee Dec 4, 2020
@maflcko maflcko added the Docs label Dec 4, 2020
@maflcko
Copy link
Member Author

maflcko commented Dec 4, 2020

Rendered diff:

diff --git a/estimatesmartfee b/estimatesmartfee
index b424d58..3a3193a 100644
--- a/estimatesmartfee
+++ b/estimatesmartfee
@@ -1,35 +1,35 @@
 estimatesmartfee conf_target ( "estimate_mode" )
 
 Estimates the approximate fee per kilobyte needed for a transaction to begin
 confirmation within conf_target blocks if possible and return the number of blocks
 for which the estimate is valid. Uses virtual transaction size as defined
 in BIP 141 (witness data is discounted).
 
 Arguments:
 1. conf_target      (numeric, required) Confirmation target in blocks (1 - 1008)
-2. estimate_mode    (string, optional, default=CONSERVATIVE) The fee estimate mode.
+2. estimate_mode    (string, optional, default=conservative) The fee estimate mode.
                     Whether to return a more conservative estimate which also satisfies
                     a longer history. A conservative estimate potentially returns a
                     higher feerate and is more likely to be sufficient for the desired
                     target, but is not as responsive to short term drops in the
                     prevailing fee market.  Must be one of:
-                    "UNSET"
-                    "ECONOMICAL"
-                    "CONSERVATIVE"
+                    "unset"
+                    "economical"
+                    "conservative"
 
 Result:
 {                   (json object)
   "feerate" : n,    (numeric, optional) estimate fee rate in BTC/kB (only present if no errors were encountered)
   "errors" : [      (json array, optional) Errors encountered during processing (if there are any)
     "str",          (string) error
     ...
   ],
   "blocks" : n      (numeric) block number where estimate was found
                     The request target will be clamped between 2 and the highest target
                     fee estimation is able to return based on how long it has been running.
                     An error is returned if not enough transactions and blocks
                     have been observed to make an estimate for any number of blocks.
 }
 
 Examples:
 > bitcoin-cli estimatesmartfee 6

Copy link
Member

@luke-jr luke-jr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

utACK

Copy link
Member

@jonatack jonatack left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested ACK fa09513fb609dbb0d

Copy link
Contributor

@kristapsk kristapsk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK fa09513fb609dbb0d7381289505de72257902edc

Can be reviewed with --ignore-all-space
@laanwj
Copy link
Member

laanwj commented Dec 7, 2020

Code review ACK fa8abdc

@laanwj laanwj merged commit 5c4911e into bitcoin:master Dec 7, 2020
@maflcko maflcko deleted the 2012-rpcDocFee branch December 7, 2020 13:17
sidhujag pushed a commit to syscoin/syscoin that referenced this pull request Dec 7, 2020
fa8abdc rpc: Use FeeModes doc helper in estimatesmartfee (MarcoFalke)

Pull request description:

  Not sure why this doesn't use the doc helper, probably an oversight?

ACKs for top commit:
  laanwj:
    Code review ACK fa8abdc

Tree-SHA512: 1f2dc8356e3476ddcf9cafafa7f9865ad95bed1e3067c0edab8e3c483e374bdbdbecc066167554b4a1b479e28f6a52c4ae6a75a70c67ee4e1ff4f3ba36b04001
@bitcoin bitcoin locked as resolved and limited conversation to collaborators Feb 15, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants