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

mining_sv2 docs #1243

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

jbesraa
Copy link
Contributor

@jbesraa jbesraa commented Nov 6, 2024

resolves #1205

Copy link

codecov bot commented Nov 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 19.36%. Comparing base (73f51db) to head (72e9bb2).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1243   +/-   ##
=======================================
  Coverage   19.36%   19.36%           
=======================================
  Files         164      164           
  Lines       10811    10811           
=======================================
  Hits         2094     2094           
  Misses       8717     8717           
Flag Coverage Δ
binary_codec_sv2-coverage 0.00% <ø> (ø)
binary_serde_sv2-coverage 3.65% <ø> (ø)
binary_sv2-coverage 5.46% <ø> (ø)
bip32_derivation-coverage 0.00% <ø> (ø)
buffer_sv2-coverage 25.02% <ø> (ø)
codec_sv2-coverage 0.01% <ø> (ø)
common_messages_sv2-coverage 0.13% <ø> (ø)
const_sv2-coverage 0.00% <ø> (ø)
error_handling-coverage 0.00% <ø> (ø)
framing_sv2-coverage 0.29% <ø> (ø)
jd_client-coverage 0.00% <ø> (ø)
jd_server-coverage 8.13% <ø> (ø)
job_declaration_sv2-coverage 0.00% <ø> (ø)
key-utils-coverage 2.39% <ø> (ø)
mining-coverage 2.51% <ø> (ø)
mining_device-coverage 0.00% <ø> (ø)
mining_proxy_sv2-coverage 0.70% <ø> (ø)
noise_sv2-coverage 4.35% <ø> (ø)
pool_sv2-coverage 1.38% <ø> (ø)
protocols 24.72% <ø> (ø)
roles 6.63% <ø> (ø)
roles_logic_sv2-coverage 8.06% <ø> (ø)
sv1-mining-device-coverage 0.00% <ø> (ø)
sv2_ffi-coverage 0.00% <ø> (ø)
template_distribution_sv2-coverage 0.00% <ø> (ø)
translator_sv2-coverage 9.61% <ø> (ø)
utils 25.13% <ø> (ø)
v1-coverage 2.47% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

Copy link
Contributor

github-actions bot commented Nov 6, 2024

🐰 Bencher Report

Branch1243/merge
Testbedsv1

⚠️ WARNING: The following Measures do not have a Threshold. Without a Threshold, no Alerts will ever be generated!

Click here to create a new Threshold
For more information, see the Threshold documentation.
To only post results if a Threshold exists, set the --ci-only-thresholds CLI flag.

Click to view all benchmark results
BenchmarkEstimated Cyclesestimated cyclesInstructionsinstructionsL1 AccessesaccessesL2 AccessesaccessesRAM Accessesaccesses
get_authorize📈 view plot
⚠️ NO THRESHOLD
8,451.00📈 view plot
⚠️ NO THRESHOLD
3,689.00📈 view plot
⚠️ NO THRESHOLD
5,156.00📈 view plot
⚠️ NO THRESHOLD
8.00📈 view plot
⚠️ NO THRESHOLD
93.00
get_submit📈 view plot
⚠️ NO THRESHOLD
95,453.00📈 view plot
⚠️ NO THRESHOLD
59,346.00📈 view plot
⚠️ NO THRESHOLD
85,218.00📈 view plot
⚠️ NO THRESHOLD
45.00📈 view plot
⚠️ NO THRESHOLD
286.00
get_subscribe📈 view plot
⚠️ NO THRESHOLD
7,910.00📈 view plot
⚠️ NO THRESHOLD
2,765.00📈 view plot
⚠️ NO THRESHOLD
3,845.00📈 view plot
⚠️ NO THRESHOLD
15.00📈 view plot
⚠️ NO THRESHOLD
114.00
serialize_authorize📈 view plot
⚠️ NO THRESHOLD
12,278.00📈 view plot
⚠️ NO THRESHOLD
5,266.00📈 view plot
⚠️ NO THRESHOLD
7,323.00📈 view plot
⚠️ NO THRESHOLD
11.00📈 view plot
⚠️ NO THRESHOLD
140.00
serialize_deserialize_authorize📈 view plot
⚠️ NO THRESHOLD
24,386.00📈 view plot
⚠️ NO THRESHOLD
9,838.00📈 view plot
⚠️ NO THRESHOLD
13,886.00📈 view plot
⚠️ NO THRESHOLD
35.00📈 view plot
⚠️ NO THRESHOLD
295.00
serialize_deserialize_handle_authorize📈 view plot
⚠️ NO THRESHOLD
30,118.00📈 view plot
⚠️ NO THRESHOLD
12,015.00📈 view plot
⚠️ NO THRESHOLD
16,998.00📈 view plot
⚠️ NO THRESHOLD
62.00📈 view plot
⚠️ NO THRESHOLD
366.00
serialize_deserialize_handle_submit📈 view plot
⚠️ NO THRESHOLD
126,381.00📈 view plot
⚠️ NO THRESHOLD
73,200.00📈 view plot
⚠️ NO THRESHOLD
104,911.00📈 view plot
⚠️ NO THRESHOLD
108.00📈 view plot
⚠️ NO THRESHOLD
598.00
serialize_deserialize_handle_subscribe📈 view plot
⚠️ NO THRESHOLD
27,502.00📈 view plot
⚠️ NO THRESHOLD
9,584.00📈 view plot
⚠️ NO THRESHOLD
13,542.00📈 view plot
⚠️ NO THRESHOLD
69.00📈 view plot
⚠️ NO THRESHOLD
389.00
serialize_deserialize_submit📈 view plot
⚠️ NO THRESHOLD
115,107.00📈 view plot
⚠️ NO THRESHOLD
68,060.00📈 view plot
⚠️ NO THRESHOLD
97,652.00📈 view plot
⚠️ NO THRESHOLD
68.00📈 view plot
⚠️ NO THRESHOLD
489.00
serialize_deserialize_subscribe📈 view plot
⚠️ NO THRESHOLD
22,904.00📈 view plot
⚠️ NO THRESHOLD
8,143.00📈 view plot
⚠️ NO THRESHOLD
11,459.00📈 view plot
⚠️ NO THRESHOLD
42.00📈 view plot
⚠️ NO THRESHOLD
321.00
serialize_submit📈 view plot
⚠️ NO THRESHOLD
99,842.00📈 view plot
⚠️ NO THRESHOLD
61,408.00📈 view plot
⚠️ NO THRESHOLD
88,077.00📈 view plot
⚠️ NO THRESHOLD
50.00📈 view plot
⚠️ NO THRESHOLD
329.00
serialize_subscribe📈 view plot
⚠️ NO THRESHOLD
11,355.00📈 view plot
⚠️ NO THRESHOLD
4,118.00📈 view plot
⚠️ NO THRESHOLD
5,705.00📈 view plot
⚠️ NO THRESHOLD
17.00📈 view plot
⚠️ NO THRESHOLD
159.00
🐰 View full continuous benchmarking report in Bencher

Copy link
Contributor

github-actions bot commented Nov 6, 2024

🐰 Bencher Report

Branch1243/merge
Testbedsv2

⚠️ WARNING: The following Measure does not have a Threshold. Without a Threshold, no Alerts will ever be generated!

Click here to create a new Threshold
For more information, see the Threshold documentation.
To only post results if a Threshold exists, set the --ci-only-thresholds CLI flag.

Click to view all benchmark results
BenchmarkLatencynanoseconds (ns)
client_sv2_handle_message_common📈 view plot
⚠️ NO THRESHOLD
44.24
client_sv2_handle_message_mining📈 view plot
⚠️ NO THRESHOLD
74.87
client_sv2_mining_message_submit_standard📈 view plot
⚠️ NO THRESHOLD
14.64
client_sv2_mining_message_submit_standard_serialize📈 view plot
⚠️ NO THRESHOLD
268.07
client_sv2_mining_message_submit_standard_serialize_deserialize📈 view plot
⚠️ NO THRESHOLD
592.77
client_sv2_open_channel📈 view plot
⚠️ NO THRESHOLD
146.63
client_sv2_open_channel_serialize📈 view plot
⚠️ NO THRESHOLD
279.63
client_sv2_open_channel_serialize_deserialize📈 view plot
⚠️ NO THRESHOLD
372.80
client_sv2_setup_connection📈 view plot
⚠️ NO THRESHOLD
164.11
client_sv2_setup_connection_serialize📈 view plot
⚠️ NO THRESHOLD
487.29
client_sv2_setup_connection_serialize_deserialize📈 view plot
⚠️ NO THRESHOLD
986.78
🐰 View full continuous benchmarking report in Bencher

Copy link
Contributor

github-actions bot commented Nov 6, 2024

🐰 Bencher Report

Branch1243/merge
Testbedsv1

⚠️ WARNING: The following Measure does not have a Threshold. Without a Threshold, no Alerts will ever be generated!

Click here to create a new Threshold
For more information, see the Threshold documentation.
To only post results if a Threshold exists, set the --ci-only-thresholds CLI flag.

Click to view all benchmark results
BenchmarkLatencynanoseconds (ns)
client-submit-serialize📈 view plot
⚠️ NO THRESHOLD
6,710.70
client-submit-serialize-deserialize📈 view plot
⚠️ NO THRESHOLD
7,583.60
client-submit-serialize-deserialize-handle/client-submit-serialize-deserialize-handle📈 view plot
⚠️ NO THRESHOLD
8,205.20
client-sv1-authorize-serialize-deserialize-handle/client-sv1-authorize-serialize-deserialize-handle📈 view plot
⚠️ NO THRESHOLD
906.46
client-sv1-authorize-serialize-deserialize/client-sv1-authorize-serialize-deserialize📈 view plot
⚠️ NO THRESHOLD
699.95
client-sv1-authorize-serialize/client-sv1-authorize-serialize📈 view plot
⚠️ NO THRESHOLD
246.25
client-sv1-get-authorize/client-sv1-get-authorize📈 view plot
⚠️ NO THRESHOLD
157.88
client-sv1-get-submit📈 view plot
⚠️ NO THRESHOLD
6,487.70
client-sv1-get-subscribe/client-sv1-get-subscribe📈 view plot
⚠️ NO THRESHOLD
278.24
client-sv1-subscribe-serialize-deserialize-handle/client-sv1-subscribe-serialize-deserialize-handle📈 view plot
⚠️ NO THRESHOLD
736.61
client-sv1-subscribe-serialize-deserialize/client-sv1-subscribe-serialize-deserialize📈 view plot
⚠️ NO THRESHOLD
590.96
client-sv1-subscribe-serialize/client-sv1-subscribe-serialize📈 view plot
⚠️ NO THRESHOLD
203.98
🐰 View full continuous benchmarking report in Bencher

Copy link
Contributor

github-actions bot commented Nov 6, 2024

🐰 Bencher Report

Branch1243/merge
Testbedsv2

⚠️ WARNING: The following Measures do not have a Threshold. Without a Threshold, no Alerts will ever be generated!

Click here to create a new Threshold
For more information, see the Threshold documentation.
To only post results if a Threshold exists, set the --ci-only-thresholds CLI flag.

Click to view all benchmark results
BenchmarkEstimated Cyclesestimated cyclesInstructionsinstructionsL1 AccessesaccessesL2 AccessesaccessesRAM Accessesaccesses
client_sv2_handle_message_common📈 view plot
⚠️ NO THRESHOLD
2,103.00📈 view plot
⚠️ NO THRESHOLD
473.00📈 view plot
⚠️ NO THRESHOLD
733.00📈 view plot
⚠️ NO THRESHOLD
8.00📈 view plot
⚠️ NO THRESHOLD
38.00
client_sv2_handle_message_mining📈 view plot
⚠️ NO THRESHOLD
8,192.00📈 view plot
⚠️ NO THRESHOLD
2,137.00📈 view plot
⚠️ NO THRESHOLD
3,162.00📈 view plot
⚠️ NO THRESHOLD
33.00📈 view plot
⚠️ NO THRESHOLD
139.00
client_sv2_mining_message_submit_standard📈 view plot
⚠️ NO THRESHOLD
6,289.00📈 view plot
⚠️ NO THRESHOLD
1,750.00📈 view plot
⚠️ NO THRESHOLD
2,549.00📈 view plot
⚠️ NO THRESHOLD
20.00📈 view plot
⚠️ NO THRESHOLD
104.00
client_sv2_mining_message_submit_standard_serialize📈 view plot
⚠️ NO THRESHOLD
14,644.00📈 view plot
⚠️ NO THRESHOLD
4,694.00📈 view plot
⚠️ NO THRESHOLD
6,759.00📈 view plot
⚠️ NO THRESHOLD
44.00📈 view plot
⚠️ NO THRESHOLD
219.00
client_sv2_mining_message_submit_standard_serialize_deserialize📈 view plot
⚠️ NO THRESHOLD
27,438.00📈 view plot
⚠️ NO THRESHOLD
10,585.00📈 view plot
⚠️ NO THRESHOLD
15,403.00📈 view plot
⚠️ NO THRESHOLD
83.00📈 view plot
⚠️ NO THRESHOLD
332.00
client_sv2_open_channel📈 view plot
⚠️ NO THRESHOLD
4,379.00📈 view plot
⚠️ NO THRESHOLD
1,461.00📈 view plot
⚠️ NO THRESHOLD
2,159.00📈 view plot
⚠️ NO THRESHOLD
10.00📈 view plot
⚠️ NO THRESHOLD
62.00
client_sv2_open_channel_serialize📈 view plot
⚠️ NO THRESHOLD
13,966.00📈 view plot
⚠️ NO THRESHOLD
5,064.00📈 view plot
⚠️ NO THRESHOLD
7,331.00📈 view plot
⚠️ NO THRESHOLD
32.00📈 view plot
⚠️ NO THRESHOLD
185.00
client_sv2_open_channel_serialize_deserialize📈 view plot
⚠️ NO THRESHOLD
22,613.00📈 view plot
⚠️ NO THRESHOLD
8,027.00📈 view plot
⚠️ NO THRESHOLD
11,673.00📈 view plot
⚠️ NO THRESHOLD
81.00📈 view plot
⚠️ NO THRESHOLD
301.00
client_sv2_setup_connection📈 view plot
⚠️ NO THRESHOLD
4,677.00📈 view plot
⚠️ NO THRESHOLD
1,502.00📈 view plot
⚠️ NO THRESHOLD
2,277.00📈 view plot
⚠️ NO THRESHOLD
11.00📈 view plot
⚠️ NO THRESHOLD
67.00
client_sv2_setup_connection_serialize📈 view plot
⚠️ NO THRESHOLD
16,102.00📈 view plot
⚠️ NO THRESHOLD
5,963.00📈 view plot
⚠️ NO THRESHOLD
8,667.00📈 view plot
⚠️ NO THRESHOLD
38.00📈 view plot
⚠️ NO THRESHOLD
207.00
client_sv2_setup_connection_serialize_deserialize📈 view plot
⚠️ NO THRESHOLD
35,450.00📈 view plot
⚠️ NO THRESHOLD
14,855.00📈 view plot
⚠️ NO THRESHOLD
21,825.00📈 view plot
⚠️ NO THRESHOLD
93.00📈 view plot
⚠️ NO THRESHOLD
376.00
🐰 View full continuous benchmarking report in Bencher

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.

Need Rust docs on protocols::v2::subprotocols::mining
1 participant