Skip to content
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

doc: document the plugin interface to gather Bitcoin data #3620

Merged
merged 1 commit into from
Apr 9, 2020

Conversation

darosior
Copy link
Collaborator

@darosior darosior commented Apr 4, 2020

This finally closes #3354 by making the current API final.

There are still things that can get added to the process (namely, notifications for a more optimized polling) but I don't think we'd need to break the interface again (soon).

I have resigned from using WU for transaction sizes as most of the Bitcoin data source seem to actually prefer round ups, and that would have resulted in boutique transformation in plugins to pass from btc/kWU to btc/kVB..

@fiatjaf
Copy link
Contributor

fiatjaf commented Apr 6, 2020

I very much like the estimatefees call. That means I can decide to accept if a peer for any reason wants to pay a very high or low fee by just returning a very large number in max or min?

What happens if I set all fields to null?

@darosior
Copy link
Collaborator Author

darosior commented Apr 6, 2020

That means I can decide to accept if a peer for any reason wants to pay a very high or low fee by just returning a very large number in max or min?

Indirectly, kind of: you can decide of the flexibility you give to your peer regarding transaction fees, but you should prefer using --ignore-fee-limits for this usecase.

What happens if I set all fields to null?

That means your plugin could not estimate the fees.

doc/PLUGINS.md Outdated Show resolved Hide resolved
Changelog-Added: plugins: the interface to gather data from Bitcoin backend plugins is now final.
@fiatjaf
Copy link
Contributor

fiatjaf commented Apr 8, 2020

What happens if I set all fields to null?

That means your plugin could not estimate the fees.

The link doesn't lead anywhere. What happens when the plugin cannot estimate the fees?

@darosior
Copy link
Collaborator Author

darosior commented Apr 8, 2020

The link doesn't lead anywhere. What happens when the plugin cannot estimate the fees?

Yep, because force push. When the plugin cannot estimate fees the feerate is set to:

  • Floor (253perkw) if mainnet and not in developer mode
  • 0 if testnet and not developer mode
  • 0 if developer mode

Copy link
Contributor

@rustyrussell rustyrussell left a comment

Choose a reason for hiding this comment

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

Ack 8b758de

@rustyrussell rustyrussell merged commit 2540519 into ElementsProject:master Apr 9, 2020
@darosior darosior deleted the bitcoin_backend_doc branch April 13, 2020 18:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bitcoin backend plugins planning
4 participants