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

Rust docs for protocols::v2::const-sv2 #1160

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

GitGab19
Copy link
Collaborator

@GitGab19 GitGab19 commented Sep 6, 2024

This PR adds rust docs to const_sv2 crate.
For now it contains a set of comments, which will be resolved after discussions at #1159

Closes #1016

@GitGab19 GitGab19 marked this pull request as draft September 6, 2024 00:14
Copy link
Contributor

github-actions bot commented Sep 6, 2024

🐰Bencher

ReportFri, September 6, 2024 at 00:21:09 UTC
ProjectStratum V2 (SRI)
Branch1160/merge
Testbedsv1
Click to view all benchmark results
BenchmarkLatencyLatency Results
nanoseconds (ns) | (Δ%)
Latency Upper Boundary
nanoseconds (ns) | (%)
client-submit-serialize✅ (view plot)6,845.70 (+0.27%)7,570.35 (90.43%)
client-submit-serialize-deserialize✅ (view plot)7,859.60 (+0.29%)8,782.69 (89.49%)
client-submit-serialize-deserialize-handle/client-submit-serialize-deserialize-handle✅ (view plot)8,453.00 (+0.46%)9,242.01 (91.46%)
client-sv1-authorize-serialize-deserialize-handle/client-sv1-authorize-serialize-deserialize-handle✅ (view plot)941.66 (+2.88%)982.90 (95.80%)
client-sv1-authorize-serialize-deserialize/client-sv1-authorize-serialize-deserialize✅ (view plot)730.39 (+2.03%)765.88 (95.37%)
client-sv1-authorize-serialize/client-sv1-authorize-serialize✅ (view plot)244.03 (-2.24%)260.69 (93.61%)
client-sv1-get-authorize/client-sv1-get-authorize✅ (view plot)156.26 (-0.92%)166.01 (94.13%)
client-sv1-get-submit✅ (view plot)6,674.30 (+0.97%)7,301.00 (91.42%)
client-sv1-get-subscribe/client-sv1-get-subscribe✅ (view plot)274.34 (-0.56%)300.46 (91.31%)
client-sv1-subscribe-serialize-deserialize-handle/client-sv1-subscribe-serialize-deserialize-handle✅ (view plot)784.90 (+2.26%)831.96 (94.34%)
client-sv1-subscribe-serialize-deserialize/client-sv1-subscribe-serialize-deserialize✅ (view plot)631.04 (+0.52%)683.15 (92.37%)
client-sv1-subscribe-serialize/client-sv1-subscribe-serialize✅ (view plot)204.06 (-2.20%)226.86 (89.95%)

Bencher - Continuous Benchmarking
View Public Perf Page
Docs | Repo | Chat | Help

Copy link
Contributor

github-actions bot commented Sep 6, 2024

🐰Bencher

ReportFri, September 6, 2024 at 00:21:09 UTC
ProjectStratum V2 (SRI)
Branchadd-rust-docs-const-sv2
Testbedsv2
Click to view all benchmark results
BenchmarkLatencyLatency Results
nanoseconds (ns) | (Δ%)
Latency Upper Boundary
nanoseconds (ns) | (%)
client_sv2_handle_message_common✅ (view plot)44.72 (+0.03%)46.72 (95.72%)
client_sv2_handle_message_mining✅ (view plot)88.67 (+17.76%)93.19 (95.15%)
client_sv2_mining_message_submit_standard✅ (view plot)14.65 (-0.16%)14.81 (98.90%)
client_sv2_mining_message_submit_standard_serialize✅ (view plot)270.79 (+0.96%)291.68 (92.84%)
client_sv2_mining_message_submit_standard_serialize_deserialize✅ (view plot)616.41 (+3.90%)652.41 (94.48%)
client_sv2_open_channel✅ (view plot)168.76 (+1.73%)177.53 (95.06%)
client_sv2_open_channel_serialize✅ (view plot)274.23 (-1.06%)307.39 (89.21%)
client_sv2_open_channel_serialize_deserialize✅ (view plot)371.15 (-1.57%)458.14 (81.01%)
client_sv2_setup_connection✅ (view plot)162.59 (+0.32%)186.06 (87.39%)
client_sv2_setup_connection_serialize✅ (view plot)455.90 (-0.20%)568.20 (80.24%)
client_sv2_setup_connection_serialize_deserialize✅ (view plot)962.27 (-3.57%)1,163.21 (82.73%)

Bencher - Continuous Benchmarking
View Public Perf Page
Docs | Repo | Chat | Help

Copy link
Contributor

github-actions bot commented Sep 6, 2024

🐰Bencher

ReportFri, September 6, 2024 at 00:21:10 UTC
ProjectStratum V2 (SRI)
Branchadd-rust-docs-const-sv2
Testbedsv1
Click to view all benchmark results
BenchmarkEstimated CyclesEstimated Cycles Results
estimated cycles | (Δ%)
Estimated Cycles Upper Boundary
estimated cycles | (%)
InstructionsInstructions Results
instructions | (Δ%)
Instructions Upper Boundary
instructions | (%)
L1 AccessesL1 Accesses Results
accesses | (Δ%)
L1 Accesses Upper Boundary
accesses | (%)
L2 AccessesL2 Accesses Results
accesses | (Δ%)
L2 Accesses Upper Boundary
accesses | (%)
RAM AccessesRAM Accesses Results
accesses | (Δ%)
RAM Accesses Upper Boundary
accesses | (%)
get_authorize✅ (view plot)8,503.00 (+0.67%)8,797.23 (96.66%)✅ (view plot)3,772.00 (+0.63%)3,883.14 (97.14%)✅ (view plot)5,298.00 (+0.78%)5,442.48 (97.35%)✅ (view plot)4.00 (-43.18%)11.60 (34.48%)✅ (view plot)91.00 (+0.99%)95.37 (95.42%)
get_submit✅ (view plot)95,476.00 (-0.01%)96,207.82 (99.24%)✅ (view plot)59,522.00 (+0.09%)59,799.97 (99.54%)✅ (view plot)85,506.00 (+0.11%)85,879.95 (99.56%)✅ (view plot)48.00 (-0.03%)71.81 (66.85%)✅ (view plot)278.00 (-0.98%)290.08 (95.84%)
get_subscribe✅ (view plot)8,034.00 (+0.33%)8,361.89 (96.08%)✅ (view plot)2,848.00 (+0.40%)2,965.27 (96.05%)✅ (view plot)3,984.00 (+0.47%)4,137.70 (96.29%)✅ (view plot)12.00 (-7.41%)23.30 (51.50%)✅ (view plot)114.00 (+0.31%)119.62 (95.31%)
serialize_authorize✅ (view plot)12,286.00 (+0.26%)12,637.57 (97.22%)✅ (view plot)5,343.00 (+0.45%)5,454.14 (97.96%)✅ (view plot)7,461.00 (+0.56%)7,604.83 (98.11%)✅ (view plot)6.00 (-35.29%)14.95 (40.12%)✅ (view plot)137.00 (+0.13%)143.67 (95.36%)
serialize_deserialize_authorize✅ (view plot)24,817.00 (+0.86%)25,135.58 (98.73%)✅ (view plot)9,920.00 (+0.24%)10,055.06 (98.66%)✅ (view plot)14,022.00 (+0.39%)14,200.75 (98.74%)✅ (view plot)31.00 (-11.97%)44.49 (69.67%)✅ (view plot)304.00 (+1.70%)312.89 (97.16%)
serialize_deserialize_handle_authorize✅ (view plot)30,325.00 (+0.23%)30,708.56 (98.75%)✅ (view plot)12,097.00 (+0.06%)12,228.79 (98.92%)✅ (view plot)17,145.00 (+0.16%)17,310.73 (99.04%)✅ (view plot)53.00 (-5.80%)68.67 (77.18%)✅ (view plot)369.00 (+0.45%)380.22 (97.05%)
serialize_deserialize_handle_submit✅ (view plot)126,537.00 (+0.06%)127,173.47 (99.50%)✅ (view plot)73,363.00 (+0.12%)73,676.81 (99.57%)✅ (view plot)105,187.00 (+0.14%)105,623.89 (99.59%)✅ (view plot)119.00 (+7.63%)142.76 (83.35%)✅ (view plot)593.00 (-0.50%)604.55 (98.09%)
serialize_deserialize_handle_subscribe✅ (view plot)27,877.00 (+0.64%)28,558.72 (97.61%)✅ (view plot)9,666.00 (+0.21%)9,780.40 (98.83%)✅ (view plot)13,682.00 (+0.28%)13,831.48 (98.92%)✅ (view plot)60.00 (-5.99%)75.90 (79.05%)✅ (view plot)397.00 (+1.15%)415.31 (95.59%)
serialize_deserialize_submit✅ (view plot)115,453.00 (+0.24%)115,897.34 (99.62%)✅ (view plot)68,223.00 (+0.20%)68,478.57 (99.63%)✅ (view plot)97,933.00 (+0.24%)98,292.75 (99.63%)✅ (view plot)67.00 (+4.44%)82.07 (81.64%)✅ (view plot)491.00 (+0.17%)498.83 (98.43%)
serialize_deserialize_subscribe✅ (view plot)23,355.00 (+1.00%)23,974.66 (97.42%)✅ (view plot)8,225.00 (+0.30%)8,336.08 (98.67%)✅ (view plot)11,595.00 (+0.38%)11,738.44 (98.78%)✅ (view plot)35.00 (-7.60%)45.25 (77.35%)✅ (view plot)331.00 (+1.76%)347.18 (95.34%)
serialize_submit✅ (view plot)99,865.00 (-0.01%)100,549.36 (99.32%)✅ (view plot)61,566.00 (+0.08%)61,848.73 (99.54%)✅ (view plot)88,350.00 (+0.10%)88,732.15 (99.57%)✅ (view plot)49.00 (-0.41%)70.84 (69.17%)✅ (view plot)322.00 (-0.91%)333.39 (96.58%)
serialize_subscribe✅ (view plot)11,371.00 (-0.12%)11,761.07 (96.68%)✅ (view plot)4,195.00 (+0.27%)4,312.27 (97.28%)✅ (view plot)5,841.00 (+0.32%)5,994.67 (97.44%)✅ (view plot)14.00 (+1.98%)22.32 (62.74%)✅ (view plot)156.00 (-0.61%)164.50 (94.83%)

Bencher - Continuous Benchmarking
View Public Perf Page
Docs | Repo | Chat | Help

Copy link
Contributor

github-actions bot commented Sep 6, 2024

🐰Bencher

ReportFri, September 6, 2024 at 00:21:11 UTC
ProjectStratum V2 (SRI)
Branchadd-rust-docs-const-sv2
Testbedsv2
Click to view all benchmark results
BenchmarkEstimated CyclesEstimated Cycles Results
estimated cycles | (Δ%)
Estimated Cycles Upper Boundary
estimated cycles | (%)
InstructionsInstructions Results
instructions | (Δ%)
Instructions Upper Boundary
instructions | (%)
L1 AccessesL1 Accesses Results
accesses | (Δ%)
L1 Accesses Upper Boundary
accesses | (%)
L2 AccessesL2 Accesses Results
accesses | (Δ%)
L2 Accesses Upper Boundary
accesses | (%)
RAM AccessesRAM Accesses Results
accesses | (Δ%)
RAM Accesses Upper Boundary
accesses | (%)
client_sv2_handle_message_common✅ (view plot)2,107.00 (+1.50%)2,206.49 (95.49%)✅ (view plot)473.00 (+0.23%)491.13 (96.31%)✅ (view plot)732.00 (-0.26%)762.33 (96.02%)✅ (view plot)9.00 (+50.21%)14.52 (61.99%)✅ (view plot)38.00 (+1.38%)41.13 (92.39%)
client_sv2_handle_message_mining✅ (view plot)8,212.00 (+0.14%)8,352.90 (98.31%)✅ (view plot)2,137.00 (+0.17%)2,180.76 (97.99%)✅ (view plot)3,157.00 (+0.10%)3,230.48 (97.73%)✅ (view plot)38.00 (+3.48%)45.48 (83.55%)✅ (view plot)139.00 (+0.04%)142.38 (97.63%)
client_sv2_mining_message_submit_standard✅ (view plot)6,297.00 (+0.28%)6,417.42 (98.12%)✅ (view plot)1,750.00 (-0.02%)1,768.53 (98.95%)✅ (view plot)2,547.00 (-0.26%)2,581.43 (98.67%)✅ (view plot)22.00 (+28.73%)25.06 (87.80%)✅ (view plot)104.00 (-0.01%)107.79 (96.48%)
client_sv2_mining_message_submit_standard_serialize✅ (view plot)14,652.00 (-0.64%)15,060.24 (97.29%)✅ (view plot)4,694.00 (-0.01%)4,712.53 (99.61%)✅ (view plot)6,757.00 (-0.00%)6,784.47 (99.60%)✅ (view plot)46.00 (+3.45%)55.33 (83.14%)✅ (view plot)219.00 (-1.31%)230.63 (94.96%)
client_sv2_mining_message_submit_standard_serialize_deserialize✅ (view plot)27,446.00 (-0.20%)27,897.70 (98.38%)✅ (view plot)10,585.00 (+0.18%)10,639.01 (99.49%)✅ (view plot)15,401.00 (+0.17%)15,481.34 (99.48%)✅ (view plot)85.00 (+3.89%)90.57 (93.85%)✅ (view plot)332.00 (-0.83%)346.05 (95.94%)
client_sv2_open_channel✅ (view plot)4,337.00 (-1.94%)4,673.73 (92.80%)✅ (view plot)1,461.00 (+0.03%)1,478.36 (98.83%)✅ (view plot)2,162.00 (+0.23%)2,186.36 (98.89%)✅ (view plot)8.00 (-18.60%)18.57 (43.09%)✅ (view plot)61.00 (-3.68%)69.99 (87.15%)
client_sv2_open_channel_serialize✅ (view plot)13,948.00 (-1.15%)14,534.88 (95.96%)✅ (view plot)5,064.00 (+0.01%)5,081.36 (99.66%)✅ (view plot)7,328.00 (+0.07%)7,354.07 (99.65%)✅ (view plot)36.00 (+1.88%)43.81 (82.18%)✅ (view plot)184.00 (-2.57%)200.94 (91.57%)
client_sv2_open_channel_serialize_deserialize✅ (view plot)22,579.00 (-0.25%)23,036.78 (98.01%)✅ (view plot)8,027.00 (+0.25%)8,079.18 (99.35%)✅ (view plot)11,674.00 (+0.21%)11,755.66 (99.31%)✅ (view plot)81.00 (+9.93%)85.43 (94.81%)✅ (view plot)300.00 (-1.11%)315.01 (95.24%)
client_sv2_setup_connection✅ (view plot)4,673.00 (-0.31%)4,784.52 (97.67%)✅ (view plot)1,502.00 (+0.03%)1,519.36 (98.86%)✅ (view plot)2,278.00 (+0.02%)2,305.41 (98.81%)✅ (view plot)10.00 (+8.64%)15.81 (63.24%)✅ (view plot)67.00 (-0.80%)70.29 (95.32%)
client_sv2_setup_connection_serialize✅ (view plot)16,118.00 (-0.50%)16,517.82 (97.58%)✅ (view plot)5,963.00 (+0.01%)5,980.36 (99.71%)✅ (view plot)8,663.00 (+0.03%)8,692.97 (99.66%)✅ (view plot)42.00 (+1.28%)55.05 (76.30%)✅ (view plot)207.00 (-1.17%)217.96 (94.97%)
client_sv2_setup_connection_serialize_deserialize✅ (view plot)35,538.00 (-0.03%)35,784.26 (99.31%)✅ (view plot)14,855.00 (+0.14%)14,908.23 (99.64%)✅ (view plot)21,818.00 (+0.13%)21,910.87 (99.58%)✅ (view plot)98.00 (+3.72%)116.31 (84.26%)✅ (view plot)378.00 (-0.41%)385.16 (98.14%)

Bencher - Continuous Benchmarking
View Public Perf Page
Docs | Repo | Chat | Help

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::const-sv2
1 participant