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

merge CONTRIBUTING.md + README-DEV.md #1140

Merged
merged 2 commits into from
Aug 28, 2024

Conversation

plebhash
Copy link
Collaborator

@plebhash plebhash commented Aug 23, 2024

close #1139

follows #1124 + #1039

@plebhash plebhash requested a review from GitGab19 August 23, 2024 19:17
Copy link
Contributor

github-actions bot commented Aug 23, 2024

🐰Bencher

ReportWed, August 28, 2024 at 15:08:10 UTC
ProjectStratum v2 (SRI)
Branchmerge-contributing-readme-dev
Testbedsv2

🚨 1 ALERT: Threshold Boundary Limit exceeded!
BenchmarkMeasure (units)ViewValueLower BoundaryUpper Boundary
client_sv2_handle_message_commonLatency (nanoseconds (ns))🚨 (view plot | view alert)46.61 (+4.46%)45.57 (102.28%)

Click to view all benchmark results
BenchmarkLatencyLatency Results
nanoseconds (ns) | (Δ%)
Latency Upper Boundary
nanoseconds (ns) | (%)
client_sv2_handle_message_common🚨 (view plot | view alert)46.61 (+4.46%)45.57 (102.28%)
client_sv2_handle_message_mining✅ (view plot)79.68 (+8.86%)81.13 (98.21%)
client_sv2_mining_message_submit_standard✅ (view plot)14.64 (-0.08%)14.69 (99.65%)
client_sv2_mining_message_submit_standard_serialize✅ (view plot)272.99 (+2.98%)284.85 (95.84%)
client_sv2_mining_message_submit_standard_serialize_deserialize✅ (view plot)582.59 (-1.91%)626.76 (92.95%)
client_sv2_open_channel✅ (view plot)166.40 (+0.42%)171.23 (97.18%)
client_sv2_open_channel_serialize✅ (view plot)280.03 (-1.00%)292.91 (95.60%)
client_sv2_open_channel_serialize_deserialize✅ (view plot)373.77 (-1.07%)421.50 (88.68%)
client_sv2_setup_connection✅ (view plot)165.96 (+1.16%)174.72 (94.98%)
client_sv2_setup_connection_serialize✅ (view plot)467.56 (-1.29%)503.70 (92.82%)
client_sv2_setup_connection_serialize_deserialize✅ (view plot)1,033.40 (+6.09%)1,044.73 (98.92%)

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

Copy link
Contributor

github-actions bot commented Aug 23, 2024

🐰Bencher

ReportWed, August 28, 2024 at 15:08:03 UTC
ProjectStratum v2 (SRI)
Branch1140/merge
Testbedsv1

🚨 1 ALERT: Threshold Boundary Limit exceeded!
BenchmarkMeasure (units)ViewValueLower BoundaryUpper Boundary
client-sv1-authorize-serialize/client-sv1-authorize-serializeLatency (nanoseconds (ns))🚨 (view plot | view alert)265.45 (+6.70%)257.88 (102.94%)

Click to view all benchmark results
BenchmarkLatencyLatency Results
nanoseconds (ns) | (Δ%)
Latency Upper Boundary
nanoseconds (ns) | (%)
client-submit-serialize✅ (view plot)6,512.10 (-5.57%)7,363.46 (88.44%)
client-submit-serialize-deserialize✅ (view plot)7,465.30 (-4.48%)8,363.21 (89.26%)
client-submit-serialize-deserialize-handle/client-submit-serialize-deserialize-handle✅ (view plot)7,938.30 (-5.38%)8,857.29 (89.62%)
client-sv1-authorize-serialize-deserialize-handle/client-sv1-authorize-serialize-deserialize-handle✅ (view plot)914.05 (+1.54%)929.01 (98.39%)
client-sv1-authorize-serialize-deserialize/client-sv1-authorize-serialize-deserialize✅ (view plot)711.28 (+1.88%)719.37 (98.88%)
client-sv1-authorize-serialize/client-sv1-authorize-serialize🚨 (view plot | view alert)265.45 (+6.70%)257.88 (102.94%)
client-sv1-get-authorize/client-sv1-get-authorize✅ (view plot)156.50 (-0.44%)162.23 (96.47%)
client-sv1-get-submit✅ (view plot)6,366.80 (-4.53%)7,144.66 (89.11%)
client-sv1-get-subscribe/client-sv1-get-subscribe✅ (view plot)281.00 (+0.83%)290.63 (96.69%)
client-sv1-subscribe-serialize-deserialize-handle/client-sv1-subscribe-serialize-deserialize-handle✅ (view plot)757.56 (+1.25%)777.46 (97.44%)
client-sv1-subscribe-serialize-deserialize/client-sv1-subscribe-serialize-deserialize✅ (view plot)618.20 (+0.56%)637.39 (96.99%)
client-sv1-subscribe-serialize/client-sv1-subscribe-serialize✅ (view plot)207.02 (+0.04%)219.53 (94.30%)

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

Copy link
Contributor

github-actions bot commented Aug 23, 2024

🐰Bencher

ReportWed, August 28, 2024 at 15:08:16 UTC
ProjectStratum v2 (SRI)
Branchmerge-contributing-readme-dev
Testbedsv2

🚨 8 ALERTS: Threshold Boundary Limits exceeded!
BenchmarkMeasure (units)ViewValueLower BoundaryUpper Boundary
client_sv2_handle_message_commonL2 Accesses (accesses)🚨 (view plot | view alert)12.00 (+66.98%)11.50 (104.33%)
client_sv2_mining_message_submit_standard_serialize_deserializeInstructions (instructions)🚨 (view plot | view alert)10,591.00 (+0.43%)10,578.93 (100.11%)
client_sv2_mining_message_submit_standard_serialize_deserializeL1 Accesses (accesses)🚨 (view plot | view alert)15,406.00 (+0.40%)15,390.18 (100.10%)
client_sv2_open_channel_serialize_deserializeInstructions (instructions)🚨 (view plot | view alert)8,027.00 (+0.50%)8,017.75 (100.12%)
client_sv2_open_channel_serialize_deserializeL1 Accesses (accesses)🚨 (view plot | view alert)11,668.00 (+0.43%)11,659.00 (100.08%)
client_sv2_open_channel_serialize_deserializeL2 Accesses (accesses)🚨 (view plot | view alert)85.00 (+15.13%)83.42 (101.90%)
client_sv2_setup_connection_serialize_deserializeInstructions (instructions)🚨 (view plot | view alert)14,855.00 (+0.28%)14,845.32 (100.07%)
client_sv2_setup_connection_serialize_deserializeL1 Accesses (accesses)🚨 (view plot | view alert)21,814.00 (+0.27%)21,800.40 (100.06%)

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,085.00 (+1.53%)2,135.51 (97.63%)✅ (view plot)473.00 (+0.45%)485.94 (97.34%)✅ (view plot)730.00 (-0.30%)754.28 (96.78%)🚨 (view plot | view alert)12.00 (+66.98%)11.50 (104.33%)✅ (view plot)37.00 (+0.74%)38.73 (95.53%)
client_sv2_handle_message_mining✅ (view plot)8,251.00 (+0.61%)8,337.60 (98.96%)✅ (view plot)2,143.00 (+0.68%)2,171.69 (98.68%)✅ (view plot)3,166.00 (+0.62%)3,216.14 (98.44%)✅ (view plot)37.00 (-3.28%)43.38 (85.29%)✅ (view plot)140.00 (+0.76%)142.01 (98.59%)
client_sv2_mining_message_submit_standard✅ (view plot)6,310.00 (+0.50%)6,391.90 (98.72%)✅ (view plot)1,756.00 (+0.34%)1,763.66 (99.57%)✅ (view plot)2,555.00 (+0.03%)2,575.44 (99.21%)✅ (view plot)23.00 (+30.23%)23.00 (99.99%)✅ (view plot)104.00 (+0.11%)106.90 (97.28%)
client_sv2_mining_message_submit_standard_serialize✅ (view plot)14,809.00 (+0.17%)15,031.59 (98.52%)✅ (view plot)4,700.00 (+0.13%)4,707.66 (99.84%)✅ (view plot)6,759.00 (+0.06%)6,775.12 (99.76%)✅ (view plot)49.00 (+3.84%)51.66 (94.86%)✅ (view plot)223.00 (+0.16%)229.85 (97.02%)
client_sv2_mining_message_submit_standard_serialize_deserialize✅ (view plot)27,591.00 (+0.37%)27,848.01 (99.08%)🚨 (view plot | view alert)10,591.00 (+0.43%)10,578.93 (100.11%)🚨 (view plot | view alert)15,406.00 (+0.40%)15,390.18 (100.10%)✅ (view plot)85.00 (+1.74%)89.03 (95.47%)✅ (view plot)336.00 (+0.28%)345.13 (97.35%)
client_sv2_open_channel✅ (view plot)4,327.00 (-3.47%)4,627.14 (93.51%)✅ (view plot)1,461.00 (+0.05%)1,473.88 (99.13%)✅ (view plot)2,157.00 (+0.19%)2,172.46 (99.29%)✅ (view plot)14.00 (+15.52%)15.36 (91.16%)✅ (view plot)60.00 (-7.45%)68.82 (87.19%)
client_sv2_open_channel_serialize✅ (view plot)14,046.00 (-1.15%)14,456.73 (97.16%)✅ (view plot)5,064.00 (+0.01%)5,076.88 (99.75%)✅ (view plot)7,326.00 (+0.10%)7,339.52 (99.82%)✅ (view plot)35.00 (-5.19%)41.30 (84.75%)✅ (view plot)187.00 (-2.41%)198.70 (94.11%)
client_sv2_open_channel_serialize_deserialize✅ (view plot)22,663.00 (+0.07%)23,014.21 (98.47%)🚨 (view plot | view alert)8,027.00 (+0.50%)8,017.75 (100.12%)🚨 (view plot | view alert)11,668.00 (+0.43%)11,659.00 (100.08%)🚨 (view plot | view alert)85.00 (+15.13%)83.42 (101.90%)✅ (view plot)302.00 (-0.83%)314.53 (96.02%)
client_sv2_setup_connection✅ (view plot)4,655.00 (-0.90%)4,764.66 (97.70%)✅ (view plot)1,502.00 (+0.05%)1,514.88 (99.15%)✅ (view plot)2,275.00 (-0.08%)2,298.67 (98.97%)✅ (view plot)14.00 (+50.18%)14.14 (98.98%)✅ (view plot)66.00 (-2.70%)69.69 (94.70%)
client_sv2_setup_connection_serialize✅ (view plot)16,146.00 (-0.74%)16,481.13 (97.97%)✅ (view plot)5,963.00 (+0.01%)5,975.88 (99.78%)✅ (view plot)8,656.00 (+0.01%)8,676.43 (99.76%)✅ (view plot)49.00 (+9.05%)49.59 (98.81%)✅ (view plot)207.00 (-1.91%)217.20 (95.30%)
client_sv2_setup_connection_serialize_deserialize✅ (view plot)35,554.00 (+0.04%)35,745.88 (99.46%)🚨 (view plot | view alert)14,855.00 (+0.28%)14,845.32 (100.07%)🚨 (view plot | view alert)21,814.00 (+0.27%)21,800.40 (100.06%)✅ (view plot)102.00 (+2.52%)112.15 (90.95%)✅ (view plot)378.00 (-0.44%)384.26 (98.37%)

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

Copy link
Contributor

github-actions bot commented Aug 23, 2024

🐰Bencher

ReportWed, August 28, 2024 at 15:08:06 UTC
ProjectStratum v2 (SRI)
Branchmerge-contributing-readme-dev
Testbedsv1

🚨 1 ALERT: Threshold Boundary Limit exceeded!
BenchmarkMeasure (units)ViewValueLower BoundaryUpper Boundary
serialize_deserialize_subscribeRAM Accesses (accesses)🚨 (view plot | view alert)323.00 (+1.31%)322.85 (100.05%)

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,507.00 (+0.88%)8,745.13 (97.28%)✅ (view plot)3,772.00 (+0.85%)3,864.44 (97.61%)✅ (view plot)5,297.00 (+0.97%)5,414.52 (97.83%)✅ (view plot)5.00 (-35.21%)10.56 (47.34%)✅ (view plot)91.00 (+1.17%)94.23 (96.58%)
get_submit✅ (view plot)95,684.00 (+0.14%)96,169.19 (99.50%)✅ (view plot)59,522.00 (+0.08%)59,777.73 (99.57%)✅ (view plot)85,499.00 (+0.10%)85,837.06 (99.61%)✅ (view plot)49.00 (-10.48%)62.59 (78.29%)✅ (view plot)284.00 (+0.72%)288.83 (98.33%)
get_subscribe✅ (view plot)8,068.00 (+1.14%)8,299.70 (97.21%)✅ (view plot)2,848.00 (+0.71%)2,948.23 (96.60%)✅ (view plot)3,983.00 (+0.79%)4,111.09 (96.88%)✅ (view plot)12.00 (-24.45%)20.24 (59.29%)✅ (view plot)115.00 (+2.01%)117.55 (97.83%)
serialize_authorize✅ (view plot)12,358.00 (+1.20%)12,543.85 (98.52%)✅ (view plot)5,343.00 (+0.60%)5,435.44 (98.30%)✅ (view plot)7,458.00 (+0.67%)7,577.38 (98.42%)✅ (view plot)7.00 (-33.54%)13.71 (51.07%)✅ (view plot)139.00 (+2.42%)141.07 (98.53%)
serialize_deserialize_authorize✅ (view plot)24,636.00 (+0.65%)24,743.52 (99.57%)✅ (view plot)9,950.00 (+0.48%)10,036.77 (99.14%)✅ (view plot)14,051.00 (+0.57%)14,167.12 (99.18%)✅ (view plot)31.00 (-14.64%)41.95 (73.91%)✅ (view plot)298.00 (+1.03%)298.31 (99.90%)
serialize_deserialize_handle_authorize✅ (view plot)30,274.00 (+0.43%)30,384.84 (99.64%)✅ (view plot)12,127.00 (+0.26%)12,219.44 (99.24%)✅ (view plot)17,164.00 (+0.27%)17,291.63 (99.26%)✅ (view plot)60.00 (+2.16%)64.48 (93.05%)✅ (view plot)366.00 (+0.61%)367.43 (99.61%)
serialize_deserialize_handle_submit✅ (view plot)126,609.00 (+0.16%)127,082.36 (99.63%)✅ (view plot)73,307.00 (+0.08%)73,622.10 (99.57%)✅ (view plot)105,094.00 (+0.10%)105,517.20 (99.60%)✅ (view plot)110.00 (-7.85%)132.15 (83.24%)✅ (view plot)599.00 (+0.69%)601.07 (99.66%)
serialize_deserialize_handle_subscribe✅ (view plot)27,588.00 (+0.48%)27,662.11 (99.73%)✅ (view plot)9,650.00 (+0.21%)9,750.23 (98.97%)✅ (view plot)13,648.00 (+0.20%)13,785.85 (99.00%)✅ (view plot)65.00 (-1.32%)73.44 (88.50%)✅ (view plot)389.00 (+0.80%)389.49 (99.87%)
serialize_deserialize_submit✅ (view plot)115,367.00 (+0.23%)115,700.79 (99.71%)✅ (view plot)68,167.00 (+0.15%)68,409.04 (99.65%)✅ (view plot)97,842.00 (+0.18%)98,165.83 (99.67%)✅ (view plot)61.00 (-11.55%)76.21 (80.04%)✅ (view plot)492.00 (+0.78%)493.93 (99.61%)
serialize_deserialize_subscribe✅ (view plot)23,054.00 (+0.75%)23,159.04 (99.55%)✅ (view plot)8,209.00 (+0.30%)8,306.18 (98.83%)✅ (view plot)11,564.00 (+0.31%)11,694.20 (98.89%)✅ (view plot)37.00 (-5.93%)43.90 (84.29%)🚨 (view plot | view alert)323.00 (+1.31%)322.85 (100.05%)
serialize_submit✅ (view plot)100,091.00 (+0.19%)100,509.61 (99.58%)✅ (view plot)61,566.00 (+0.08%)61,826.72 (99.58%)✅ (view plot)88,346.00 (+0.10%)88,690.31 (99.61%)✅ (view plot)46.00 (-16.62%)63.37 (72.58%)✅ (view plot)329.00 (+1.29%)331.22 (99.33%)
serialize_subscribe✅ (view plot)11,507.00 (+1.51%)11,658.09 (98.70%)✅ (view plot)4,195.00 (+0.48%)4,295.23 (97.67%)✅ (view plot)5,837.00 (+0.47%)5,969.75 (97.78%)✅ (view plot)14.00 (-13.49%)19.24 (72.77%)✅ (view plot)160.00 (+2.85%)161.09 (99.32%)

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

@plebhash plebhash changed the base branch from dev to main August 28, 2024 12:11
@GitGab19 GitGab19 force-pushed the merge-contributing-readme-dev branch from 2b91563 to 6385aae Compare August 28, 2024 14:44
@plebhash plebhash force-pushed the merge-contributing-readme-dev branch from 6385aae to 2b91563 Compare August 28, 2024 14:45
@plebhash plebhash merged commit 7665958 into stratum-mining:main Aug 28, 2024
33 checks passed
@plebhash plebhash deleted the merge-contributing-readme-dev branch August 28, 2024 16:27
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.

merge CONTRIBUTING and README-DEV files into a single file
3 participants