Bitcoin-Wildlife-Sanctuary / bitcoin-circle-stark

Building blocks of a Circle STARK verifier in Bitcoin script
https://docs.btcwild.life
MIT License
112 stars 23 forks source link

πŸ§‘β€πŸ’» generate bitcoin script performance report during test execution instead of simple print #27

Closed AbdelStark closed 3 months ago

AbdelStark commented 3 months ago

Description

Generate a report to track the performance of the various Bitcoin scripts generated during the execution of tests.

Changes summary

Example of generated file: Screenshot 2024-05-31 at 16 04 39

codecov[bot] commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Files Coverage Ξ”
src/channel/bitcoin_script.rs 95.23% <ΓΈ> (ΓΈ)
src/circle/bitcoin_script.rs 100.00% <ΓΈ> (ΓΈ)
src/constraints/bitcoin_script.rs 100.00% <ΓΈ> (ΓΈ)
src/fri/bitcoin_script.rs 95.65% <ΓΈ> (-4.35%) :arrow_down:
src/lib.rs 60.00% <ΓΈ> (+10.00%) :arrow_up:
src/merkle_tree/bitcoin_script.rs 100.00% <ΓΈ> (ΓΈ)
src/oods/bitcoin_script.rs 100.00% <ΓΈ> (ΓΈ)
src/pow/bitcoin_script.rs 100.00% <ΓΈ> (ΓΈ)
src/tests_utils/report.rs 100.00% <100.00%> (ΓΈ)

... and 4 files with indirect coverage changes

weikengchen commented 3 months ago

Approved. Can merge if it is ready.

weikengchen commented 3 months ago

does it mean that we should replace the performance "table" (it is just a simple list) in the current README with a link to the rendered report?

weikengchen commented 3 months ago

(do not have to be in this PR though)

AbdelStark commented 3 months ago

does it mean that we should replace the performance "table" (it is just a simple list) in the current README with a link to the rendered report?

Yes i believe so

AbdelStark commented 3 months ago

(do not have to be in this PR though)

Ok let's do that in a follow up PR. I will try to come up with something cool. Perhaps auto generate in the doc site.

AbdelStark commented 3 months ago

does it mean that we should replace the performance "table" (it is just a simple list) in the current README with a link to the rendered report?

Maybe we can put a link to the catgolfing ? https://catgolfing.btcwild.life/ It displays the table with the latest report dynamically.