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

Add sidecar scripts for fee estimation and stacks block delay detection #4080

Merged
merged 3 commits into from Nov 28, 2023

Conversation

AshtonStephens
Copy link
Collaborator

@AshtonStephens AshtonStephens commented Nov 21, 2023

Description

This Draft PR contains two python scripts that handle two different needs.

  1. fee-estimate.pyupdates the miner toml value satoshis_per_byte with the current estimate averaged between multiple fee estimation APIs.
  2. stacks-block-delay-event-trigger.py runs a specified binary when the stacks block is created too long after a bitcoin block.
  • Documentation of these can be found within the docstrings of the corresponding files.
  • Reasonable defaults that require user defined values can be found under ./contrib/side-cars/config/ for both scripts/

Applicable issues

  • fixes ongoing issues; will create an issue after this draft is loosely considered to be needed.

Additional info (benefits, drawbacks, caveats)

The user will need to install python and a few dependencies when they run for the first time, but that will be very easy to detect as the scripts will error out immediately with a helpful message.

This script is operating system agnostic assuming there is a reasonable python implementation on said system.

Checklist

  • Test coverage for new or modified code paths
  • Changelog is updated
  • Required documentation changes (e.g., docs/rpc/openapi.yaml and rpc-endpoints.md for v2 endpoints, event-dispatcher.md for new events)
  • New clarity functions have corresponding PR in clarity-benchmarking repo
  • New integration test(s) added to bitcoin-tests.yml

Copy link

codecov bot commented Nov 21, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (fc61021) 0.04% compared to head (34fe70a) 0.04%.
Report is 1 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #4080   +/-   ##
========================================
  Coverage     0.04%    0.04%           
========================================
  Files          401      401           
  Lines       286818   286818           
========================================
  Hits           136      136           
  Misses      286682   286682           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@diwakergupta
Copy link
Member

we have much bigger problems to tackle y'all. let's just put both scripts somewhere (under /contrib perhaps) and move on? </end bike shed alert>

@AshtonStephens
Copy link
Collaborator Author

AshtonStephens commented Nov 22, 2023

we have much bigger problems to tackle y'all. let's just put both scripts somewhere (under /contrib perhaps) and move on? </end bike shed alert>

Agreed, we can put this somewhere other than this repo at all to clear this up. Or @wileyj I can just send this to you in discord

@AshtonStephens AshtonStephens marked this pull request as ready for review November 27, 2023 14:34
@jcnelson jcnelson merged commit a25703d into develop Nov 28, 2023
2 checks passed
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.

None yet

5 participants