Skip to content

update rustfmt.toml#1246

Merged
rrybarczyk merged 2 commits into
stratum-mining:mainfrom
Shourya742:2024-11-update-rustfmt
Nov 13, 2024
Merged

update rustfmt.toml#1246
rrybarczyk merged 2 commits into
stratum-mining:mainfrom
Shourya742:2024-11-update-rustfmt

Conversation

@Shourya742

@Shourya742 Shourya742 commented Nov 13, 2024 •
edited
Loading

Copy link
Copy Markdown
Member

The reason for this change is to strictly enforce a 100-character limit on documentation comments. This results in several changes to our current files, but none of them are critical—just documentation updates with the correct alignment.

@codecov

codecov Bot commented Nov 13, 2024 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 25.13%. Comparing base (9e3f43d) to head (e378d19).
Report is 3 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #1246      +/-   ##
==========================================
+ Coverage   19.36%   25.13%   +5.76%     
==========================================
  Files         164       20     -144     
  Lines       10811     1134    -9677     
==========================================
- Hits         2094      285    -1809     
+ Misses       8717      849    -7868
Flag Coverage Δ
binary_codec_sv2-coverage ?
binary_serde_sv2-coverage ?
binary_sv2-coverage ?
bip32_derivation-coverage ?
buffer_sv2-coverage ?
codec_sv2-coverage ?
common_messages_sv2-coverage ?
const_sv2-coverage ?
error_handling-coverage ?
framing_sv2-coverage ?
jd_client-coverage ?
jd_server-coverage ?
job_declaration_sv2-coverage ?
key-utils-coverage ?
mining-coverage ?
mining_device-coverage ?
mining_proxy_sv2-coverage ?
noise_sv2-coverage ?
pool_sv2-coverage ?
protocols ?
roles ?
roles_logic_sv2-coverage ?
sv1-mining-device-coverage ?
sv2_ffi-coverage ?
template_distribution_sv2-coverage ?
translator_sv2-coverage ?
utils 25.13% <ø> (ø)
v1-coverage ?

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.

@github-actions

github-actions Bot commented Nov 13, 2024 •
edited
Loading

Copy link
Copy Markdown
Contributor

🐰 Bencher Report

Branch2024-11-update-rustfmt
Testbedsv2
🚨 1 ALERT: Threshold Boundary Limit exceeded!
BenchmarkMeasure
Units		ViewBenchmark Result
(Result Δ%)		Lower Boundary
(Limit %)		Upper Boundary
(Limit %)
client_sv2_open_channel_serialize_deserializeL2 Accesses
accesses		📈 plot
🚨 alert
🚷 threshold		88.00
(+18.71%)		85.00
(103.53%)
Click to view all benchmark results
BenchmarkEstimated CyclesBenchmark Result
estimated cycles
(Result Δ%)		Upper Boundary
estimated cycles
(Limit %)		InstructionsBenchmark Result
instructions
(Result Δ%)		Upper Boundary
instructions
(Limit %)		L1 AccessesBenchmark Result
accesses
(Result Δ%)		Upper Boundary
accesses
(Limit %)		L2 AccessesBenchmark Result
accesses
(Result Δ%)		Upper Boundary
accesses
(Limit %)		RAM AccessesBenchmark Result
accesses
(Result Δ%)		Upper Boundary
accesses
(Limit %)
client_sv2_handle_message_common📈 view plot
🚷 view threshold		2,068.00
(-1.12%)		2,203.97
(93.83%)		📈 view plot
🚷 view threshold		476.00
(+0.54%)		490.84
(96.98%)		📈 view plot
🚷 view threshold		738.00
(+0.26%)		761.02
(96.97%)		📈 view plot
🚷 view threshold		7.00
(+26.73%)		14.31
(48.92%)		📈 view plot
🚷 view threshold		37.00
(-2.47%)		41.06
(90.11%)
client_sv2_handle_message_mining📈 view plot
🚷 view threshold		8,208.00
(+0.01%)		8,295.88
(98.94%)		📈 view plot
🚷 view threshold		2,137.00
(-0.03%)		2,143.08
(99.72%)		📈 view plot
🚷 view threshold		3,158.00
(-0.09%)		3,170.63
(99.60%)		📈 view plot
🚷 view threshold		37.00
(+3.68%)		42.60
(86.86%)		📈 view plot
🚷 view threshold		139.00
(-0.07%)		141.08
(98.52%)
client_sv2_mining_message_submit_standard📈 view plot
🚷 view threshold		6,232.00
(-0.74%)		6,389.36
(97.54%)		📈 view plot
🚷 view threshold		1,753.00
(+0.11%)		1,769.07
(99.09%)		📈 view plot
🚷 view threshold		2,552.00
(-0.08%)		2,579.92
(98.92%)		📈 view plot
🚷 view threshold		22.00
(+29.53%)		24.95
(88.17%)		📈 view plot
🚷 view threshold		102.00
(-1.91%)		107.04
(95.29%)
client_sv2_mining_message_submit_standard_serialize📈 view plot
🚷 view threshold		14,633.00
(-0.70%)		14,989.96
(97.62%)		📈 view plot
🚷 view threshold		4,697.00
(+0.04%)		4,713.07
(99.66%)		📈 view plot
🚷 view threshold		6,758.00
(-0.01%)		6,785.38
(99.60%)		📈 view plot
🚷 view threshold		49.00
(+12.56%)		53.59
(91.44%)		📈 view plot
🚷 view threshold		218.00
(-1.67%)		228.40
(95.45%)
client_sv2_mining_message_submit_standard_serialize_deserialize📈 view plot
🚷 view threshold		27,431.00
(-0.35%)		27,721.73
(98.95%)		📈 view plot
🚷 view threshold		10,588.00
(+0.10%)		10,634.37
(99.56%)		📈 view plot
🚷 view threshold		15,401.00
(+0.07%)		15,478.13
(99.50%)		📈 view plot
🚷 view threshold		89.00
(+9.59%)		89.57
(99.37%)		📈 view plot
🚷 view threshold		331.00
(-1.23%)		341.92
(96.81%)
client_sv2_open_channel📈 view plot
🚷 view threshold		4,310.00
(-2.08%)		4,631.81
(93.05%)		📈 view plot
🚷 view threshold		1,464.00
(+0.17%)		1,478.84
(99.00%)		📈 view plot
🚷 view threshold		2,165.00
(+0.24%)		2,187.61
(98.97%)		📈 view plot
🚷 view threshold		9.00
(-0.52%)		17.91
(50.25%)		📈 view plot
🚷 view threshold		60.00
(-4.39%)		68.88
(87.11%)
client_sv2_open_channel_serialize📈 view plot
🚷 view threshold		13,907.00
(-1.16%)		14,488.60
(95.99%)		📈 view plot
🚷 view threshold		5,067.00
(+0.05%)		5,081.84
(99.71%)		📈 view plot
🚷 view threshold		7,327.00
(+0.02%)		7,355.14
(99.62%)		📈 view plot
🚷 view threshold		42.00
(+19.65%)		43.42
(96.73%)		📈 view plot
🚷 view threshold		182.00
(-3.03%)		199.72
(91.13%)
client_sv2_open_channel_serialize_deserialize📈 view plot
🚷 view threshold		22,644.00
(-0.09%)		22,905.53
(98.86%)		📈 view plot
🚷 view threshold		8,030.00
(+0.14%)		8,074.71
(99.45%)		📈 view plot
🚷 view threshold		11,669.00
(+0.04%)		11,755.85
(99.26%)		📈 view plot
🚨 view alert
🚷 view threshold		88.00
(+18.71%)		85.00
(103.53%)		📈 view plot
🚷 view threshold		301.00
(-0.88%)		312.48
(96.32%)
client_sv2_setup_connection📈 view plot
🚷 view threshold		4,650.00
(-0.74%)		4,778.23
(97.32%)		📈 view plot
🚷 view threshold		1,505.00
(+0.17%)		1,519.84
(99.02%)		📈 view plot
🚷 view threshold		2,280.00
(+0.05%)		2,303.04
(99.00%)		📈 view plot
🚷 view threshold		12.00
(+30.95%)		15.62
(76.83%)		📈 view plot
🚷 view threshold		66.00
(-2.12%)		70.01
(94.28%)
client_sv2_setup_connection_serialize📈 view plot
🚷 view threshold		16,073.00
(-0.65%)		16,488.20
(97.48%)		📈 view plot
🚷 view threshold		5,966.00
(+0.04%)		5,980.84
(99.75%)		📈 view plot
🚷 view threshold		8,663.00
(-0.00%)		8,694.60
(99.64%)		📈 view plot
🚷 view threshold		47.00
(+17.18%)		53.89
(87.21%)		📈 view plot
🚷 view threshold		205.00
(-1.91%)		217.08
(94.43%)
client_sv2_setup_connection_serialize_deserialize📈 view plot
🚷 view threshold		35,451.00
(-0.28%)		35,739.50
(99.19%)		📈 view plot
🚷 view threshold		14,858.00
(+0.08%)		14,903.74
(99.69%)		📈 view plot
🚷 view threshold		21,821.00
(+0.06%)		21,913.50
(99.58%)		📈 view plot
🚷 view threshold		101.00
(+8.47%)		115.06
(87.78%)		📈 view plot
🚷 view threshold		375.00
(-1.14%)		384.90
(97.43%)
🐰 View full continuous benchmarking report in Bencher

@github-actions

github-actions Bot commented Nov 13, 2024 •
edited
Loading

Copy link
Copy Markdown
Contributor

🐰 Bencher Report

Branch2024-11-update-rustfmt
Testbedsv1
Click to view all benchmark results
BenchmarkLatencyBenchmark Result
nanoseconds (ns)
(Result Δ%)		Upper Boundary
nanoseconds (ns)
(Limit %)
client-submit-serialize📈 view plot
🚷 view threshold		6,726.90
(-0.59%)		8,655.51
(77.72%)
client-submit-serialize-deserialize📈 view plot
🚷 view threshold		7,622.30
(-0.75%)		9,772.79
(78.00%)
client-submit-serialize-deserialize-handle/client-submit-serialize-deserialize-handle📈 view plot
🚷 view threshold		8,214.70
(-0.47%)		10,243.88
(80.19%)
client-sv1-authorize-serialize-deserialize-handle/client-sv1-authorize-serialize-deserialize-handle📈 view plot
🚷 view threshold		885.58
(-0.41%)		1,075.63
(82.33%)
client-sv1-authorize-serialize-deserialize/client-sv1-authorize-serialize-deserialize📈 view plot
🚷 view threshold		684.14
(-0.21%)		906.04
(75.51%)
client-sv1-authorize-serialize/client-sv1-authorize-serialize📈 view plot
🚷 view threshold		249.15
(+0.68%)		272.55
(91.42%)
client-sv1-get-authorize/client-sv1-get-authorize📈 view plot
🚷 view threshold		156.67
(-0.15%)		161.87
(96.79%)
client-sv1-get-submit📈 view plot
🚷 view threshold		6,592.00
(+0.84%)		8,600.28
(76.65%)
client-sv1-get-subscribe/client-sv1-get-subscribe📈 view plot
🚷 view threshold		274.58
(-1.66%)		336.00
(81.72%)
client-sv1-subscribe-serialize-deserialize-handle/client-sv1-subscribe-serialize-deserialize-handle📈 view plot
🚷 view threshold		726.82
(-3.22%)		957.74
(75.89%)
client-sv1-subscribe-serialize-deserialize/client-sv1-subscribe-serialize-deserialize📈 view plot
🚷 view threshold		625.65
(+1.93%)		767.64
(81.50%)
client-sv1-subscribe-serialize/client-sv1-subscribe-serialize📈 view plot
🚷 view threshold		210.06
(+1.31%)		240.56
(87.32%)
🐰 View full continuous benchmarking report in Bencher

@github-actions

github-actions Bot commented Nov 13, 2024 •
edited
Loading

Copy link
Copy Markdown
Contributor

🐰 Bencher Report

Branch2024-11-update-rustfmt
Testbedsv1
Click to view all benchmark results
BenchmarkEstimated CyclesBenchmark Result
estimated cycles
(Result Δ%)		Upper Boundary
estimated cycles
(Limit %)		InstructionsBenchmark Result
instructions
(Result Δ%)		Upper Boundary
instructions
(Limit %)		L1 AccessesBenchmark Result
accesses
(Result Δ%)		Upper Boundary
accesses
(Limit %)		L2 AccessesBenchmark Result
accesses
(Result Δ%)		Upper Boundary
accesses
(Limit %)		RAM AccessesBenchmark Result
accesses
(Result Δ%)		Upper Boundary
accesses
(Limit %)
get_authorize📈 view plot
🚷 view threshold		8,326.00
(-1.54%)		8,830.42
(94.29%)		📈 view plot
🚷 view threshold		3,692.00
(-1.52%)		3,889.84
(94.91%)		📈 view plot
🚷 view threshold		5,161.00
(-1.84%)		5,455.89
(94.60%)		📈 view plot
🚷 view threshold		10.00
(+41.28%)		12.15
(82.28%)		📈 view plot
🚷 view threshold		89.00
(-1.53%)		96.17
(92.55%)
get_submit📈 view plot
🚷 view threshold		95,388.00
(-0.06%)		96,156.12
(99.20%)		📈 view plot
🚷 view threshold		59,349.00
(-0.21%)		59,813.81
(99.22%)		📈 view plot
🚷 view threshold		85,223.00
(-0.23%)		85,910.45
(99.20%)		📈 view plot
🚷 view threshold		45.00
(-1.37%)		66.18
(67.99%)		📈 view plot
🚷 view threshold		284.00
(+1.49%)		289.18
(98.21%)
get_subscribe📈 view plot
🚷 view threshold		7,807.00
(-2.62%)		8,384.84
(93.11%)		📈 view plot
🚷 view threshold		2,768.00
(-2.38%)		2,969.18
(93.22%)		📈 view plot
🚷 view threshold		3,852.00
(-2.82%)		4,148.10
(92.86%)		📈 view plot
🚷 view threshold		14.00
(+15.99%)		21.02
(66.59%)		📈 view plot
🚷 view threshold		111.00
(-2.69%)		120.18
(92.36%)
serialize_authorize📈 view plot
🚷 view threshold		12,149.00
(-1.01%)		12,651.31
(96.03%)		📈 view plot
🚷 view threshold		5,269.00
(-0.96%)		5,460.20
(96.50%)		📈 view plot
🚷 view threshold		7,329.00
(-1.23%)		7,618.08
(96.21%)		📈 view plot
🚷 view threshold		12.00
(+33.91%)		15.20
(78.93%)		📈 view plot
🚷 view threshold		136.00
(-1.00%)		143.64
(94.68%)
serialize_deserialize_authorize📈 view plot
🚷 view threshold		24,279.00
(-1.63%)		25,288.57
(96.01%)		📈 view plot
🚷 view threshold		9,841.00
(-0.52%)		10,054.19
(97.88%)		📈 view plot
🚷 view threshold		13,894.00
(-0.51%)		14,207.60
(97.79%)		📈 view plot
🚷 view threshold		33.00
(-5.12%)		44.19
(74.68%)		📈 view plot
🚷 view threshold		292.00
(-3.05%)		316.11
(92.37%)
serialize_deserialize_handle_authorize📈 view plot
🚷 view threshold		30,023.00
(-0.96%)		30,800.94
(97.47%)		📈 view plot
🚷 view threshold		12,018.00
(-0.54%)		12,224.29
(98.31%)		📈 view plot
🚷 view threshold		17,003.00
(-0.63%)		17,314.74
(98.20%)		📈 view plot
🚷 view threshold		63.00
(+13.13%)		68.18
(92.40%)		📈 view plot
🚷 view threshold		363.00
(-1.70%)		382.28
(94.96%)
serialize_deserialize_handle_submit📈 view plot
🚷 view threshold		126,471.00
(-0.00%)		127,200.37
(99.43%)		📈 view plot
🚷 view threshold		73,200.00
(-0.12%)		73,698.79
(99.32%)		📈 view plot
🚷 view threshold		104,911.00
(-0.15%)		105,667.30
(99.28%)		📈 view plot
🚷 view threshold		105.00
(-2.52%)		135.64
(77.41%)		📈 view plot
🚷 view threshold		601.00
(+0.82%)		605.32
(99.29%)
serialize_deserialize_handle_subscribe📈 view plot
🚷 view threshold		27,411.00
(-1.47%)		28,657.87
(95.65%)		📈 view plot
🚷 view threshold		9,587.00
(-0.64%)		9,788.79
(97.94%)		📈 view plot
🚷 view threshold		13,546.00
(-0.75%)		13,847.32
(97.82%)		📈 view plot
🚷 view threshold		71.00
(+11.89%)		75.99
(93.44%)		📈 view plot
🚷 view threshold		386.00
(-2.50%)		417.58
(92.44%)
serialize_deserialize_submit📈 view plot
🚷 view threshold		115,163.00
(-0.07%)		115,994.02
(99.28%)		📈 view plot
🚷 view threshold		68,060.00
(-0.07%)		68,513.92
(99.34%)		📈 view plot
🚷 view threshold		97,653.00
(-0.09%)		98,355.97
(99.29%)		📈 view plot
🚷 view threshold		65.00
(+3.15%)		79.16
(82.11%)		📈 view plot
🚷 view threshold		491.00
(+0.01%)		499.70
(98.26%)
serialize_deserialize_subscribe📈 view plot
🚷 view threshold		22,785.00
(-1.96%)		24,085.61
(94.60%)		📈 view plot
🚷 view threshold		8,146.00
(-0.70%)		8,345.57
(97.61%)		📈 view plot
🚷 view threshold		11,470.00
(-0.74%)		11,755.46
(97.57%)		📈 view plot
🚷 view threshold		37.00
(-1.00%)		44.66
(82.85%)		📈 view plot
🚷 view threshold		318.00
(-3.20%)		349.54
(90.98%)
serialize_submit📈 view plot
🚷 view threshold		99,789.00
(-0.07%)		100,524.48
(99.27%)		📈 view plot
🚷 view threshold		61,411.00
(-0.17%)		61,860.39
(99.27%)		📈 view plot
🚷 view threshold		88,079.00
(-0.21%)		88,759.72
(99.23%)		📈 view plot
🚷 view threshold		53.00
(+12.13%)		66.26
(79.99%)		📈 view plot
🚷 view threshold		327.00
(+0.78%)		333.74
(97.98%)
serialize_subscribe📈 view plot
🚷 view threshold		11,252.00
(-1.27%)		11,762.58
(95.66%)		📈 view plot
🚷 view threshold		4,121.00
(-1.47%)		4,315.48
(95.49%)		📈 view plot
🚷 view threshold		5,712.00
(-1.87%)		6,004.33
(95.13%)		📈 view plot
🚷 view threshold		16.00
(+24.12%)		20.81
(76.88%)		📈 view plot
🚷 view threshold		156.00
(-0.93%)		164.10
(95.07%)
🐰 View full continuous benchmarking report in Bencher

@github-actions

github-actions Bot commented Nov 13, 2024 •
edited
Loading

Copy link
Copy Markdown
Contributor

🐰 Bencher Report

Branch2024-11-update-rustfmt
Testbedsv2
Click to view all benchmark results
BenchmarkLatencyBenchmark Result
nanoseconds (ns)
(Result Δ%)		Upper Boundary
nanoseconds (ns)
(Limit %)
client_sv2_handle_message_common📈 view plot
🚷 view threshold		44.05
(-1.51%)		48.42
(90.97%)
client_sv2_handle_message_mining📈 view plot
🚷 view threshold		79.03
(+3.40%)		96.06
(82.27%)
client_sv2_mining_message_submit_standard📈 view plot
🚷 view threshold		14.66
(+0.03%)		14.82
(98.93%)
client_sv2_mining_message_submit_standard_serialize📈 view plot
🚷 view threshold		272.70
(-0.18%)		316.81
(86.08%)
client_sv2_mining_message_submit_standard_serialize_deserialize📈 view plot
🚷 view threshold		578.35
(-1.05%)		722.63
(80.03%)
client_sv2_open_channel📈 view plot
🚷 view threshold		149.91
(+1.72%)		160.22
(93.57%)
client_sv2_open_channel_serialize📈 view plot
🚷 view threshold		277.22
(-2.54%)		336.94
(82.27%)
client_sv2_open_channel_serialize_deserialize📈 view plot
🚷 view threshold		370.82
(-1.44%)		446.45
(83.06%)
client_sv2_setup_connection📈 view plot
🚷 view threshold		166.16
(+1.72%)		198.18
(83.84%)
client_sv2_setup_connection_serialize📈 view plot
🚷 view threshold		450.34
(-2.80%)		646.39
(69.67%)
client_sv2_setup_connection_serialize_deserialize📈 view plot
🚷 view threshold		957.87
(-1.02%)		1,138.61
(84.13%)
🐰 View full continuous benchmarking report in Bencher

@Shourya742 Shourya742 force-pushed the 2024-11-update-rustfmt branch from bbfa0fe to d1c2351 Compare November 13, 2024 12:10
@GitGab19

GitGab19 commented Nov 13, 2024

Copy link
Copy Markdown
Member

What's the goal of this PR? I see 79 files changed

@Fi3

Fi3 commented Nov 13, 2024

Copy link
Copy Markdown
Collaborator

What's the goal of this PR? I see 79 files changed

update the rules that we use to format our files with cargo fmt

@Shourya742

Shourya742 commented Nov 13, 2024

Copy link
Copy Markdown
Member Author

What's the goal of this PR? I see 79 files changed

My apologies for not adding descriptions. The reason for this change is to strictly enforce a 100-character limit on documentation comments. This results in several changes to our current files, but none of them are critical—just documentation updates with the correct alignment.

rrybarczyk
rrybarczyk approved these changes Nov 13, 2024
View reviewed changes

@rrybarczyk rrybarczyk left a comment •
edited
Loading

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Looks good to me. Let's merge in ASAP before other doc PRs are merged to avoid confusion and make sure we bump versions (in the doc PRs, NOT this PR) after this PR is merged.

@rrybarczyk rrybarczyk requested a review from GitGab19 November 13, 2024 15:04
@rrybarczyk rrybarczyk merged commit 66b1807 into stratum-mining:main Nov 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@rrybarczyk rrybarczyk rrybarczyk approved these changes

@GitGab19 GitGab19 GitGab19 approved these changes

Assignees

@Shourya742 Shourya742

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@Shourya742 @GitGab19 @Fi3 @rrybarczyk