[REST] add a rest endpoint for estimatesmartfee, docs, and test by joemphilips · Pull Request #11770 · bitcoin/bitcoin

joemphilips · 2017-11-27T14:48:16Z

This could be useful if other clients want to use the core's fee estimation logic via REST.

maflcko · 2017-11-27T15:17:33Z

test/functional/test_framework/rest.py

nit: Instead of moving them to a separate file, you could add convenience wrappers to the test_node class? Thus, it would not be required to pass in host and port all the time.

promag

Light concept ACK. Maybe too much for REST?

At least the the URI could be improved. This looks weird:

/rest/fee/economical/6.json
/rest/fee/unset/3.json

promag · 2017-11-27T15:38:44Z

src/rest.cpp

Unrelated change, please revert.

promag · 2017-11-27T15:38:55Z

src/rest.cpp

Unrelated change, please revert.

Thanks, done. I will make sure will not to include these kinds of changes from next time.

promag · 2017-11-27T15:41:56Z

src/rest.cpp

Remove empty line.

promag · 2017-11-27T15:42:20Z

src/rest.cpp

Remove empty line.

promag · 2017-11-27T15:49:37Z

src/rest.cpp

Sounds weird to "redirect" to RPC handler (redo the mode parse etc). Maybe factor out what is needed from there?

Maybe just call ::feeEstimator.estimateSmartFee() here?

promag · 2017-11-27T15:50:10Z

doc/REST-interface.md

Remove 2nd empty line.

promag · 2017-11-27T15:50:44Z

src/rest.cpp

Missing {}.

promag · 2017-11-27T15:50:52Z

src/rest.cpp

Missing {}.

promag · 2017-11-27T15:54:55Z

doc/REST-interface.md

Returns proper fee estimated by bitcoind, this is bitcoind. 😄

Thanks, done.

joemphilips · 2017-11-27T18:35:44Z

Thanks for reviewing.
I will update according to the review soon.

Maybe too much for REST?

Rationale for this PR is that some light client(or other services) wants to use information about block or mempool for estimating fee. This is pretty close to the motivation of getutxo in terms of it places some trust on the full node. core's fee estimation logic is likely to update to a more sophisticated scheme in the near future so many clients may want to use core's logic directly.

At least the the URI could be improved. This looks weird:

You are right. Can I use &foo=bar style query parameter here? I didn't because other endpoint didn't. in that case, what about
/rest/fee.json?target=<TARGET>&mode=<MODE> and make mode optional? Though I'm not sure how easy this is to implement.

Otherwise all I can think is enabling to omit <MODE> . and query in the form like
/rest/fee/5.json

promag · 2017-11-27T19:03:52Z

My vote goes to GET /rest/fee?target=<TARGET>&mode=<MODE>, with query parameters and without extension. IMO all endpoints should return JSON, unless Accept: headers requests other format.

jonasschnelli · 2017-11-27T20:02:33Z

src/rest.cpp

I think it's not worth passing through the RPC call estimatesmartfee.
Better directly use feeEstimator.estimateFee(nBlocks);.

you mean feeEstimator::estimateSmartFee ?

jonasschnelli · 2017-11-27T20:05:16Z

Concept ACK.
Please no query string.
The in this PR proposed URL scheme seems correct and in align with other calls: https://github.com/bitcoin/bitcoin/blob/master/doc/REST-interface.md#query-utxo-set

jb55 · 2017-11-28T00:54:44Z

test/functional/smartfees.py

nit. why not:

"/rest/fee/unset/{}.json".format((i+1)//2)

laanwj · 2017-11-28T11:28:03Z

Please no query string.
The in this PR proposed URL scheme seems correct and in align with other calls:

Yep, agree.
Concept ACK.

joemphilips

updated according to review by @promag , @jb55 and @MarcoFalke . Ready for next review.

joemphilips · 2017-11-28T07:38:58Z

doc/REST-interface.md

Thanks, done.

joemphilips · 2017-11-28T07:39:06Z

doc/REST-interface.md

joemphilips · 2017-11-28T07:40:12Z

src/rest.cpp

Thanks, done. I will make sure will not to include these kinds of changes from next time.

joemphilips · 2017-11-28T07:40:18Z

src/rest.cpp

joemphilips · 2017-11-28T07:41:43Z

src/rest.cpp

joemphilips · 2017-11-28T08:28:51Z

src/rest.cpp

joemphilips · 2017-11-28T08:29:09Z

src/rest.cpp

joemphilips · 2017-11-29T19:02:29Z

src/rest.cpp

joemphilips · 2017-11-29T19:03:29Z

src/rest.cpp

you mean feeEstimator::estimateSmartFee ?

joemphilips · 2017-11-29T19:29:35Z

test/functional/test_framework/rest.py

promag · 2018-02-03T15:03:45Z

Needs rebase.

joemphilips · 2018-02-05T14:30:39Z

rebased.

joemphilips · 2018-02-15T08:55:54Z

umm... sorry, does "Needs rebase" imply needs for squashing? or just rebasing onto master?
I only did rebasing onto master but it needs squashing before merge.
(Sorry for silly question. Forgive me, this is my first PR.) @promag

fanquake · 2018-02-15T10:40:13Z

@joemphilips You'll need to rebase onto master, as this currently has merge conflicts in test/functional/feature_fee_estimation.py.

At the same time, you can also squash your changes into a single commit. See Squashing Commits. Use a descriptive commit message i.e "rest: add an endpoint for estimatesmartfee".

joemphilips · 2018-02-18T17:09:47Z

rebased (and squashed)

fanquake · 2018-02-19T00:55:20Z

test/functional/test_framework/test_node.py

http.client is already imported above.

Thanks, done.

jgarzik

concept ACK

maflcko · 2018-11-09T16:54:56Z

Still needs rebase.

Could do something like this:

git checkout rest_fee
git fetch bitcoin
git merge bitcoin/master
git reset --soft bitcoin/master
git commit -m '[REST] add a rest endpoint for estimatesmartfee, docs, and test'
git push origin rest_fee -f

joemphilips · 2018-11-09T18:53:55Z

rebased

DrahtBot · 2018-11-09T19:42:49Z

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

Conflicts

No conflicts as of last run.

practicalswift · 2018-11-10T10:27:58Z

src/rest.cpp

Remove e since unused :-)

practicalswift · 2018-11-10T10:29:15Z

src/rest.cpp

Nit: bool conservative = mode != FeeEstimateMode::ECONOMICAL; instead? :-)

practicalswift · 2018-11-10T10:29:56Z

src/rest.cpp

Drop ; :-)

practicalswift · 2018-11-10T10:30:10Z

src/rest.cpp

Drop ; :-)

practicalswift · 2018-11-10T10:30:23Z

src/rest.cpp

Drop ; :-)

test/functional/interface_rest.py

src/rest.cpp

* write REST interface for getting estimated fee * update docs about REST interface for fee estimation * add test

practicalswift · 2019-05-07T16:06:33Z

This PR does not compile when rebased on master. Is it still active or should it be closed? :-)

joemphilips · 2019-05-07T16:11:03Z

This PR does not compile when rebased on master. Is it still active or should it be closed? :-)

I will close. sorry for leaving it here for so long.

joemphilips force-pushed the rest_fee branch from 180cb01 to 5ee1c95 Compare November 27, 2017 14:49

maflcko reviewed Nov 27, 2017

View reviewed changes

joemphilips force-pushed the rest_fee branch from 5ee1c95 to e485e5f Compare November 27, 2017 15:22

promag reviewed Nov 27, 2017

View reviewed changes

jonasschnelli reviewed Nov 27, 2017

View reviewed changes

fanquake added the RPC/REST/ZMQ label Nov 27, 2017

jb55 reviewed Nov 28, 2017

View reviewed changes

joemphilips force-pushed the rest_fee branch 2 times, most recently from 4737cc4 to f865a63 Compare November 30, 2017 11:40

joemphilips commented Nov 30, 2017

View reviewed changes

joemphilips force-pushed the rest_fee branch from f865a63 to 08eba8c Compare February 5, 2018 14:30

bitcoin deleted a comment from WorkShop-Office Feb 15, 2018

joemphilips force-pushed the rest_fee branch 5 times, most recently from 3976774 to 5c548c1 Compare February 18, 2018 17:01

fanquake reviewed Feb 19, 2018

View reviewed changes

bitcoin deleted a comment from Vasyo Feb 19, 2018

joemphilips force-pushed the rest_fee branch from 5c548c1 to 558e3bb Compare February 19, 2018 02:45

joemphilips force-pushed the rest_fee branch from 558e3bb to 935b364 Compare March 9, 2018 11:19

maflcko added the Needs rebase label Jun 6, 2018

maflcko removed the Needs rebase label Nov 8, 2018

DrahtBot added the Needs rebase label Nov 8, 2018

jgarzik approved these changes Nov 9, 2018

View reviewed changes

joemphilips force-pushed the rest_fee branch from 935b364 to cc77e07 Compare November 9, 2018 16:17

joemphilips force-pushed the rest_fee branch 7 times, most recently from a47b155 to 5ed237a Compare November 9, 2018 18:18

DrahtBot removed the Needs rebase label Nov 9, 2018

practicalswift reviewed Nov 10, 2018

View reviewed changes

src/rest.cpp Outdated

Copy link

Contributor

practicalswift Nov 10, 2018

Choose a reason for hiding this comment

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

Remove e since unused :-)

practicalswift suggested changes Nov 10, 2018

View reviewed changes

joemphilips force-pushed the rest_fee branch from 5ed237a to d074e0b Compare November 10, 2018 15:44

DrahtBot added the Needs rebase label Jan 23, 2019

rest: add endpoint for estimatesmartfee

eff1b3e

* write REST interface for getting estimated fee * update docs about REST interface for fee estimation * add test

joemphilips force-pushed the rest_fee branch from d074e0b to eff1b3e Compare January 23, 2019 13:23

DrahtBot removed the Needs rebase label Jan 23, 2019

joemphilips closed this May 7, 2019

bitcoin locked as resolved and limited conversation to collaborators Dec 16, 2021

Conversation

joemphilips commented Nov 27, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

promag left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

joemphilips commented Nov 27, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

promag commented Nov 27, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jonasschnelli commented Nov 27, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

laanwj commented Nov 28, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

joemphilips left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

joemphilips commented Nov 27, 2017 •

edited

Loading

laanwj commented Nov 28, 2017 •

edited

Loading