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

const_sv2 - README update to comply with docs standards #1198

Merged
merged 1 commit into from
Oct 10, 2024

Conversation

GitGab19
Copy link
Collaborator

@GitGab19 GitGab19 commented Oct 9, 2024

This PR adds new badges, complying const_sv2 README.md to docs standards

Copy link
Contributor

github-actions bot commented Oct 9, 2024

🐰 Bencher Report

Branch1198/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,793.80
client-submit-serialize-deserialize📈 view plot
⚠️ NO THRESHOLD
7,761.40
client-submit-serialize-deserialize-handle/client-submit-serialize-deserialize-handle📈 view plot
⚠️ NO THRESHOLD
8,384.10
client-sv1-authorize-serialize-deserialize-handle/client-sv1-authorize-serialize-deserialize-handle📈 view plot
⚠️ NO THRESHOLD
968.03
client-sv1-authorize-serialize-deserialize/client-sv1-authorize-serialize-deserialize📈 view plot
⚠️ NO THRESHOLD
710.51
client-sv1-authorize-serialize/client-sv1-authorize-serialize📈 view plot
⚠️ NO THRESHOLD
246.99
client-sv1-get-authorize/client-sv1-get-authorize📈 view plot
⚠️ NO THRESHOLD
158.41
client-sv1-get-submit📈 view plot
⚠️ NO THRESHOLD
6,491.70
client-sv1-get-subscribe/client-sv1-get-subscribe📈 view plot
⚠️ NO THRESHOLD
279.07
client-sv1-subscribe-serialize-deserialize-handle/client-sv1-subscribe-serialize-deserialize-handle📈 view plot
⚠️ NO THRESHOLD
828.15
client-sv1-subscribe-serialize-deserialize/client-sv1-subscribe-serialize-deserialize📈 view plot
⚠️ NO THRESHOLD
634.74
client-sv1-subscribe-serialize/client-sv1-subscribe-serialize📈 view plot
⚠️ NO THRESHOLD
203.90
🐰 View full continuous benchmarking report in Bencher

Copy link
Contributor

github-actions bot commented Oct 9, 2024

🐰 Bencher Report

Branch1198/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,204.00📈 view plot
⚠️ NO THRESHOLD
2,137.00📈 view plot
⚠️ NO THRESHOLD
3,159.00📈 view plot
⚠️ NO THRESHOLD
36.00📈 view plot
⚠️ NO THRESHOLD
139.00
client_sv2_mining_message_submit_standard📈 view plot
⚠️ NO THRESHOLD
6,297.00📈 view plot
⚠️ NO THRESHOLD
1,750.00📈 view plot
⚠️ NO THRESHOLD
2,547.00📈 view plot
⚠️ NO THRESHOLD
22.00📈 view plot
⚠️ NO THRESHOLD
104.00
client_sv2_mining_message_submit_standard_serialize📈 view plot
⚠️ NO THRESHOLD
14,626.00📈 view plot
⚠️ NO THRESHOLD
4,694.00📈 view plot
⚠️ NO THRESHOLD
6,756.00📈 view plot
⚠️ NO THRESHOLD
48.00📈 view plot
⚠️ NO THRESHOLD
218.00
client_sv2_mining_message_submit_standard_serialize_deserialize📈 view plot
⚠️ NO THRESHOLD
27,450.00📈 view plot
⚠️ NO THRESHOLD
10,585.00📈 view plot
⚠️ NO THRESHOLD
15,400.00📈 view plot
⚠️ NO THRESHOLD
86.00📈 view plot
⚠️ NO THRESHOLD
332.00
client_sv2_open_channel📈 view plot
⚠️ NO THRESHOLD
4,341.00📈 view plot
⚠️ NO THRESHOLD
1,461.00📈 view plot
⚠️ NO THRESHOLD
2,161.00📈 view plot
⚠️ NO THRESHOLD
9.00📈 view plot
⚠️ NO THRESHOLD
61.00
client_sv2_open_channel_serialize📈 view plot
⚠️ NO THRESHOLD
13,914.00📈 view plot
⚠️ NO THRESHOLD
5,064.00📈 view plot
⚠️ NO THRESHOLD
7,329.00📈 view plot
⚠️ NO THRESHOLD
36.00📈 view plot
⚠️ NO THRESHOLD
183.00
client_sv2_open_channel_serialize_deserialize📈 view plot
⚠️ NO THRESHOLD
22,639.00📈 view plot
⚠️ NO THRESHOLD
8,027.00📈 view plot
⚠️ NO THRESHOLD
11,674.00📈 view plot
⚠️ NO THRESHOLD
79.00📈 view plot
⚠️ NO THRESHOLD
302.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,106.00📈 view plot
⚠️ NO THRESHOLD
5,963.00📈 view plot
⚠️ NO THRESHOLD
8,666.00📈 view plot
⚠️ NO THRESHOLD
39.00📈 view plot
⚠️ NO THRESHOLD
207.00
client_sv2_setup_connection_serialize_deserialize📈 view plot
⚠️ NO THRESHOLD
35,446.00📈 view plot
⚠️ NO THRESHOLD
14,855.00📈 view plot
⚠️ NO THRESHOLD
21,826.00📈 view plot
⚠️ NO THRESHOLD
92.00📈 view plot
⚠️ NO THRESHOLD
376.00
🐰 View full continuous benchmarking report in Bencher

Copy link
Contributor

github-actions bot commented Oct 9, 2024

🐰 Bencher Report

Branch1198/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.67
client_sv2_handle_message_mining📈 view plot
⚠️ NO THRESHOLD
72.88
client_sv2_mining_message_submit_standard📈 view plot
⚠️ NO THRESHOLD
14.67
client_sv2_mining_message_submit_standard_serialize📈 view plot
⚠️ NO THRESHOLD
265.89
client_sv2_mining_message_submit_standard_serialize_deserialize📈 view plot
⚠️ NO THRESHOLD
589.38
client_sv2_open_channel📈 view plot
⚠️ NO THRESHOLD
165.76
client_sv2_open_channel_serialize📈 view plot
⚠️ NO THRESHOLD
267.04
client_sv2_open_channel_serialize_deserialize📈 view plot
⚠️ NO THRESHOLD
372.03
client_sv2_setup_connection📈 view plot
⚠️ NO THRESHOLD
158.30
client_sv2_setup_connection_serialize📈 view plot
⚠️ NO THRESHOLD
418.94
client_sv2_setup_connection_serialize_deserialize📈 view plot
⚠️ NO THRESHOLD
993.54
🐰 View full continuous benchmarking report in Bencher

Copy link
Contributor

github-actions bot commented Oct 9, 2024

🐰 Bencher Report

Branch1198/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,507.00📈 view plot
⚠️ NO THRESHOLD
3,764.00📈 view plot
⚠️ NO THRESHOLD
5,282.00📈 view plot
⚠️ NO THRESHOLD
8.00📈 view plot
⚠️ NO THRESHOLD
91.00
get_submit📈 view plot
⚠️ NO THRESHOLD
95,392.00📈 view plot
⚠️ NO THRESHOLD
59,514.00📈 view plot
⚠️ NO THRESHOLD
85,497.00📈 view plot
⚠️ NO THRESHOLD
47.00📈 view plot
⚠️ NO THRESHOLD
276.00
get_subscribe📈 view plot
⚠️ NO THRESHOLD
8,030.00📈 view plot
⚠️ NO THRESHOLD
2,840.00📈 view plot
⚠️ NO THRESHOLD
3,970.00📈 view plot
⚠️ NO THRESHOLD
14.00📈 view plot
⚠️ NO THRESHOLD
114.00
serialize_authorize📈 view plot
⚠️ NO THRESHOLD
12,286.00📈 view plot
⚠️ NO THRESHOLD
5,335.00📈 view plot
⚠️ NO THRESHOLD
7,446.00📈 view plot
⚠️ NO THRESHOLD
9.00📈 view plot
⚠️ NO THRESHOLD
137.00
serialize_deserialize_authorize📈 view plot
⚠️ NO THRESHOLD
24,817.00📈 view plot
⚠️ NO THRESHOLD
9,912.00📈 view plot
⚠️ NO THRESHOLD
14,007.00📈 view plot
⚠️ NO THRESHOLD
34.00📈 view plot
⚠️ NO THRESHOLD
304.00
serialize_deserialize_handle_authorize📈 view plot
⚠️ NO THRESHOLD
30,325.00📈 view plot
⚠️ NO THRESHOLD
12,089.00📈 view plot
⚠️ NO THRESHOLD
17,130.00📈 view plot
⚠️ NO THRESHOLD
56.00📈 view plot
⚠️ NO THRESHOLD
369.00
serialize_deserialize_handle_submit📈 view plot
⚠️ NO THRESHOLD
126,441.00📈 view plot
⚠️ NO THRESHOLD
73,363.00📈 view plot
⚠️ NO THRESHOLD
105,196.00📈 view plot
⚠️ NO THRESHOLD
112.00📈 view plot
⚠️ NO THRESHOLD
591.00
serialize_deserialize_handle_subscribe📈 view plot
⚠️ NO THRESHOLD
27,865.00📈 view plot
⚠️ NO THRESHOLD
9,658.00📈 view plot
⚠️ NO THRESHOLD
13,670.00📈 view plot
⚠️ NO THRESHOLD
60.00📈 view plot
⚠️ NO THRESHOLD
397.00
serialize_deserialize_submit📈 view plot
⚠️ NO THRESHOLD
115,415.00📈 view plot
⚠️ NO THRESHOLD
68,223.00📈 view plot
⚠️ NO THRESHOLD
97,935.00📈 view plot
⚠️ NO THRESHOLD
66.00📈 view plot
⚠️ NO THRESHOLD
490.00
serialize_deserialize_subscribe📈 view plot
⚠️ NO THRESHOLD
23,351.00📈 view plot
⚠️ NO THRESHOLD
8,217.00📈 view plot
⚠️ NO THRESHOLD
11,581.00📈 view plot
⚠️ NO THRESHOLD
37.00📈 view plot
⚠️ NO THRESHOLD
331.00
serialize_submit📈 view plot
⚠️ NO THRESHOLD
99,785.00📈 view plot
⚠️ NO THRESHOLD
61,558.00📈 view plot
⚠️ NO THRESHOLD
88,340.00📈 view plot
⚠️ NO THRESHOLD
49.00📈 view plot
⚠️ NO THRESHOLD
320.00
serialize_subscribe📈 view plot
⚠️ NO THRESHOLD
11,359.00📈 view plot
⚠️ NO THRESHOLD
4,187.00📈 view plot
⚠️ NO THRESHOLD
5,829.00📈 view plot
⚠️ NO THRESHOLD
14.00📈 view plot
⚠️ NO THRESHOLD
156.00
🐰 View full continuous benchmarking report in Bencher

Copy link
Contributor

@Shourya742 Shourya742 left a comment

Choose a reason for hiding this comment

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

ACK

protocols/v2/const-sv2/README.md Outdated Show resolved Hide resolved
protocols/v2/const-sv2/Cargo.toml Outdated Show resolved Hide resolved
protocols/v2/const-sv2/README.md Outdated Show resolved Hide resolved
@GitGab19
Copy link
Collaborator Author

GitGab19 commented Oct 9, 2024

@rrybarczyk I requested your review, I just tackled your previous comments

Copy link
Collaborator

@rrybarczyk rrybarczyk left a comment

Choose a reason for hiding this comment

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

The changes you made look good, I just noticed a couple other small things.

protocols/v2/const-sv2/README.md Outdated Show resolved Hide resolved
protocols/v2/const-sv2/README.md Outdated Show resolved Hide resolved
protocols/v2/const-sv2/README.md Outdated Show resolved Hide resolved
@GitGab19
Copy link
Collaborator Author

GitGab19 commented Oct 9, 2024

The changes you made look good, I just noticed a couple other small things.

Done c9b7ca8

Copy link
Contributor

@jbesraa jbesraa left a comment

Choose a reason for hiding this comment

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

Added one small nit

protocols/v2/const-sv2/Cargo.toml Outdated Show resolved Hide resolved
const_sv2 crate description update
@GitGab19 GitGab19 merged commit 94b9ead into stratum-mining:main Oct 10, 2024
34 checks passed
@GitGab19 GitGab19 deleted the update-readme-const-sv2 branch October 10, 2024 11:53
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.

4 participants