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

docs roles_logic_sv2 #1263

Merged
merged 18 commits into from
Jan 16, 2025
Merged

Conversation

plebhash
Copy link
Collaborator

close #1014

Copy link
Contributor

github-actions bot commented Nov 22, 2024

🐰 Bencher Report

Branchroles-logic-sv2-docs
Testbedsv2

🚨 1 Alert

BenchmarkMeasure
Units
ViewBenchmark Result
(Result Δ%)
Upper Boundary
(Limit %)
client_sv2_mining_message_submit_standardLatency
nanoseconds (ns)
📈 plot
🚨 alert (🔔)
🚷 threshold
16.37
(+11.10%)
16.20
(101.06%)
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.80
(-0.95%)
59.59
(75.19%)
client_sv2_handle_message_mining📈 view plot
🚷 view threshold
86.00
(+10.66%)
107.99
(79.63%)
client_sv2_mining_message_submit_standard📈 view plot
🚨 view alert (🔔)
🚷 view threshold
16.37
(+11.10%)
16.20
(101.06%)
client_sv2_mining_message_submit_standard_serialize📈 view plot
🚷 view threshold
267.74
(+1.34%)
288.41
(92.83%)
client_sv2_mining_message_submit_standard_serialize_deserialize📈 view plot
🚷 view threshold
622.13
(+0.69%)
679.97
(91.49%)
client_sv2_open_channel📈 view plot
🚷 view threshold
167.56
(+0.95%)
179.20
(93.51%)
client_sv2_open_channel_serialize📈 view plot
🚷 view threshold
297.03
(+3.65%)
316.25
(93.92%)
client_sv2_open_channel_serialize_deserialize📈 view plot
🚷 view threshold
401.77
(+4.74%)
408.86
(98.27%)
client_sv2_setup_connection📈 view plot
🚷 view threshold
165.58
(+3.33%)
172.32
(96.09%)
client_sv2_setup_connection_serialize📈 view plot
🚷 view threshold
469.68
(+0.03%)
553.76
(84.82%)
client_sv2_setup_connection_serialize_deserialize📈 view plot
🚷 view threshold
1,103.90
(+8.96%)
1,237.22
(89.22%)
🐰 View full continuous benchmarking report in Bencher

Copy link
Contributor

github-actions bot commented Nov 22, 2024

🐰 Bencher Report

Branchroles-logic-sv2-docs
Testbedsv1
Click to view all benchmark results
BenchmarkEstimated CyclesBenchmark Result
1e3 x estimated cycles
(Result Δ%)
Upper Boundary
1e3 x estimated cycles
(Limit %)
InstructionsBenchmark Result
1e3 x instructions
(Result Δ%)
Upper Boundary
1e3 x instructions
(Limit %)
L1 AccessesBenchmark Result
1e3 x accesses
(Result Δ%)
Upper Boundary
1e3 x 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.35
(-1.19%)
8.67
(96.31%)
📈 view plot
🚷 view threshold
3.69
(-0.93%)
3.86
(95.53%)
📈 view plot
🚷 view threshold
5.16
(-1.04%)
5.45
(94.70%)
📈 view plot
🚷 view threshold
9.00
(+5.59%)
16.42
(54.80%)
📈 view plot
🚷 view threshold
90.00
(-1.54%)
96.82
(92.95%)
get_submit📈 view plot
🚷 view threshold
95.15
(-0.22%)
95.62
(99.51%)
📈 view plot
🚷 view threshold
59.35
(-0.09%)
59.71
(99.39%)
📈 view plot
🚷 view threshold
85.23
(-0.10%)
85.82
(99.31%)
📈 view plot
🚷 view threshold
46.00
(+2.61%)
60.36
(76.21%)
📈 view plot
🚷 view threshold
277.00
(-1.33%)
291.89
(94.90%)
get_subscribe📈 view plot
🚷 view threshold
7.83
(-1.98%)
8.23
(95.17%)
📈 view plot
🚷 view threshold
2.77
(-1.65%)
2.94
(93.97%)
📈 view plot
🚷 view threshold
3.85
(-1.85%)
4.14
(92.92%)
📈 view plot
🚷 view threshold
13.00
(+3.55%)
20.74
(62.67%)
📈 view plot
🚷 view threshold
112.00
(-2.20%)
117.98
(94.93%)
serialize_authorize📈 view plot
🚷 view threshold
12.07
(-1.49%)
12.51
(96.54%)
📈 view plot
🚷 view threshold
5.27
(-0.59%)
5.43
(97.05%)
📈 view plot
🚷 view threshold
7.33
(-0.65%)
7.60
(96.41%)
📈 view plot
🚷 view threshold
11.00
(+6.99%)
18.90
(58.19%)
📈 view plot
🚷 view threshold
134.00
(-2.86%)
143.39
(93.45%)
serialize_deserialize_authorize📈 view plot
🚷 view threshold
24.57
(-0.57%)
25.19
(97.56%)
📈 view plot
🚷 view threshold
9.84
(-0.19%)
10.01
(98.28%)
📈 view plot
🚷 view threshold
13.88
(-0.22%)
14.18
(97.90%)
📈 view plot
🚷 view threshold
39.00
(+8.40%)
45.97
(84.83%)
📈 view plot
🚷 view threshold
300.00
(-1.19%)
313.69
(95.64%)
serialize_deserialize_handle_authorize📈 view plot
🚷 view threshold
30.03
(-0.95%)
30.73
(97.74%)
📈 view plot
🚷 view threshold
12.02
(-0.28%)
12.19
(98.60%)
📈 view plot
🚷 view threshold
17.00
(-0.31%)
17.30
(98.31%)
📈 view plot
🚷 view threshold
58.00
(+3.82%)
67.47
(85.96%)
📈 view plot
🚷 view threshold
364.00
(-1.88%)
379.58
(95.90%)
serialize_deserialize_handle_submit📈 view plot
🚷 view threshold
126.20
(-0.20%)
126.78
(99.54%)
📈 view plot
🚷 view threshold
73.20
(-0.06%)
73.53
(99.55%)
📈 view plot
🚷 view threshold
104.91
(-0.08%)
105.51
(99.43%)
📈 view plot
🚷 view threshold
113.00
(+5.81%)
125.99
(89.69%)
📈 view plot
🚷 view threshold
592.00
(-0.97%)
610.67
(96.94%)
serialize_deserialize_handle_subscribe📈 view plot
🚷 view threshold
27.63
(-1.00%)
28.39
(97.33%)
📈 view plot
🚷 view threshold
9.58
(-0.47%)
9.76
(98.20%)
📈 view plot
🚷 view threshold
13.54
(-0.53%)
13.84
(97.85%)
📈 view plot
🚷 view threshold
67.00
(+3.73%)
78.01
(85.88%)
📈 view plot
🚷 view threshold
393.00
(-1.56%)
409.86
(95.89%)
serialize_deserialize_submit📈 view plot
🚷 view threshold
115.11
(-0.12%)
115.72
(99.48%)
📈 view plot
🚷 view threshold
68.06
(+0.01%)
68.42
(99.47%)
📈 view plot
🚷 view threshold
97.65
(+0.01%)
98.29
(99.35%)
📈 view plot
🚷 view threshold
69.00
(+5.09%)
87.79
(78.60%)
📈 view plot
🚷 view threshold
489.00
(-0.90%)
505.36
(96.76%)
serialize_deserialize_subscribe📈 view plot
🚷 view threshold
23.11
(-0.92%)
23.82
(97.01%)
📈 view plot
🚷 view threshold
8.14
(-0.51%)
8.32
(97.92%)
📈 view plot
🚷 view threshold
11.45
(-0.58%)
11.75
(97.50%)
📈 view plot
🚷 view threshold
42.00
(+7.52%)
51.17
(82.07%)
📈 view plot
🚷 view threshold
327.00
(-1.40%)
342.50
(95.48%)
serialize_submit📈 view plot
🚷 view threshold
99.54
(-0.25%)
100.10
(99.44%)
📈 view plot
🚷 view threshold
61.41
(-0.07%)
61.73
(99.47%)
📈 view plot
🚷 view threshold
88.09
(-0.08%)
88.65
(99.37%)
📈 view plot
🚷 view threshold
50.00
(+3.66%)
67.07
(74.55%)
📈 view plot
🚷 view threshold
320.00
(-1.66%)
337.67
(94.77%)
serialize_subscribe📈 view plot
🚷 view threshold
11.28
(-1.05%)
11.60
(97.24%)
📈 view plot
🚷 view threshold
4.12
(-1.03%)
4.28
(96.15%)
📈 view plot
🚷 view threshold
5.71
(-1.22%)
6.00
(95.20%)
📈 view plot
🚷 view threshold
15.00
(+7.20%)
24.31
(61.70%)
📈 view plot
🚷 view threshold
157.00
(-0.97%)
164.64
(95.36%)
🐰 View full continuous benchmarking report in Bencher

Copy link
Contributor

github-actions bot commented Nov 22, 2024

🐰 Bencher Report

Branchroles-logic-sv2-docs
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,492.70
(-0.95%)
6,934.49
(93.63%)
client-submit-serialize-deserialize📈 view plot
🚷 view threshold
7,359.10
(-0.65%)
7,843.28
(93.83%)
client-submit-serialize-deserialize-handle/client-submit-serialize-deserialize-handle📈 view plot
🚷 view threshold
8,113.10
(+0.18%)
9,385.32
(86.44%)
client-sv1-authorize-serialize-deserialize-handle/client-sv1-authorize-serialize-deserialize-handle📈 view plot
🚷 view threshold
887.84
(+2.22%)
944.11
(94.04%)
client-sv1-authorize-serialize-deserialize/client-sv1-authorize-serialize-deserialize📈 view plot
🚷 view threshold
692.30
(+2.29%)
725.95
(95.37%)
client-sv1-authorize-serialize/client-sv1-authorize-serialize📈 view plot
🚷 view threshold
247.03
(-1.16%)
273.61
(90.29%)
client-sv1-get-authorize/client-sv1-get-authorize📈 view plot
🚷 view threshold
155.50
(-1.21%)
165.26
(94.09%)
client-sv1-get-submit📈 view plot
🚷 view threshold
6,225.30
(-1.84%)
6,779.97
(91.82%)
client-sv1-get-subscribe/client-sv1-get-subscribe📈 view plot
🚷 view threshold
278.61
(-1.83%)
336.42
(82.82%)
client-sv1-subscribe-serialize-deserialize-handle/client-sv1-subscribe-serialize-deserialize-handle📈 view plot
🚷 view threshold
721.05
(-0.83%)
778.45
(92.63%)
client-sv1-subscribe-serialize-deserialize/client-sv1-subscribe-serialize-deserialize📈 view plot
🚷 view threshold
587.88
(-0.46%)
627.65
(93.66%)
client-sv1-subscribe-serialize/client-sv1-subscribe-serialize📈 view plot
🚷 view threshold
206.18
(-0.12%)
226.07
(91.20%)
🐰 View full continuous benchmarking report in Bencher

Copy link
Contributor

github-actions bot commented Nov 22, 2024

🐰 Bencher Report

Branchroles-logic-sv2-docs
Testbedsv2
Click to view all benchmark results
BenchmarkEstimated CyclesBenchmark Result
1e3 x estimated cycles
(Result Δ%)
Upper Boundary
1e3 x 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.17
(+2.64%)
2.24
(96.97%)
📈 view plot
🚷 view threshold
473.00
(-0.13%)
490.59
(96.41%)
📈 view plot
🚷 view threshold
731.00
(-0.67%)
758.99
(96.31%)
📈 view plot
🚷 view threshold
8.00
(+56.81%)
11.66
(68.58%)
📈 view plot
🚷 view threshold
40.00
(+3.41%)
41.76
(95.79%)
client_sv2_handle_message_mining📈 view plot
🚷 view threshold
8.28
(+0.65%)
8.40
(98.57%)
📈 view plot
🚷 view threshold
2,137.00📈 view plot
🚷 view threshold
3,155.00
(-0.12%)
3,167.41
(99.61%)
📈 view plot
🚷 view threshold
38.00
(+6.76%)
41.56
(91.44%)
📈 view plot
🚷 view threshold
141.00
(+0.92%)
144.56
(97.53%)
client_sv2_mining_message_submit_standard📈 view plot
🚷 view threshold
6.36
(+0.86%)
6.45
(98.56%)
📈 view plot
🚷 view threshold
1,750.00
(-0.03%)
1,767.59
(99.00%)
📈 view plot
🚷 view threshold
2,547.00
(-0.19%)
2,575.46
(98.89%)
📈 view plot
🚷 view threshold
20.00
(+16.52%)
24.08
(83.04%)
📈 view plot
🚷 view threshold
106.00
(+1.22%)
108.80
(97.43%)
client_sv2_mining_message_submit_standard_serialize📈 view plot
🚷 view threshold
14.84
(+0.74%)
14.94
(99.31%)
📈 view plot
🚷 view threshold
4,694.00
(-0.01%)
4,711.59
(99.63%)
📈 view plot
🚷 view threshold
6,741.00
(-0.22%)
6,786.82
(99.32%)
📈 view plot
🚷 view threshold
58.00
(+26.50%)
63.55
(91.27%)
📈 view plot
🚷 view threshold
223.00
(+0.82%)
226.17
(98.60%)
client_sv2_mining_message_submit_standard_serialize_deserialize📈 view plot
🚷 view threshold
27.82
(+0.78%)
28.07
(99.13%)
📈 view plot
🚷 view threshold
10,645.00
(+0.35%)
10,699.43
(99.49%)
📈 view plot
🚷 view threshold
15,502.00
(+0.39%)
15,595.37
(99.40%)
📈 view plot
🚷 view threshold
91.00
(+8.56%)
99.25
(91.69%)
📈 view plot
🚷 view threshold
339.00
(+1.02%)
343.25
(98.76%)
client_sv2_open_channel📈 view plot
🚷 view threshold
4.52
(+2.69%)
4.59
(98.61%)
📈 view plot
🚷 view threshold
1,461.00
(-0.04%)
1,478.59
(98.81%)
📈 view plot
🚷 view threshold
2,153.00
(-0.35%)
2,184.78
(98.55%)
📈 view plot
🚷 view threshold
12.00
(+46.01%)
14.07
(85.30%)
📈 view plot
🚷 view threshold
66.00
(+4.87%)
67.88
(97.24%)
client_sv2_open_channel_serialize📈 view plot
🚷 view threshold
14.15
(+0.95%)
14.21
(99.63%)
📈 view plot
🚷 view threshold
5,064.00
(-0.01%)
5,081.59
(99.65%)
📈 view plot
🚷 view threshold
7,314.00
(-0.16%)
7,352.87
(99.47%)
📈 view plot
🚷 view threshold
45.00
(+22.53%)
48.64
(92.52%)
📈 view plot
🚷 view threshold
189.00
(+1.59%)
190.99
(98.96%)
client_sv2_open_channel_serialize_deserialize📈 view plot
🚷 view threshold
22.99
(+1.24%)
23.08
(99.62%)
📈 view plot
🚷 view threshold
8,040.00
(+0.09%)
8,057.64
(99.78%)
📈 view plot
🚷 view threshold
11,684.00
(-0.01%)
11,713.47
(99.75%)
📈 view plot
🚷 view threshold
85.00
(+12.03%)
90.08
(94.37%)
📈 view plot
🚷 view threshold
311.00
(+2.23%)
313.07
(99.34%)
client_sv2_setup_connection📈 view plot
🚷 view threshold
4.75
(+1.12%)
4.79
(99.00%)
📈 view plot
🚷 view threshold
1,502.00
(-0.04%)
1,519.59
(98.84%)
📈 view plot
🚷 view threshold
2,275.00
(-0.16%)
2,300.98
(98.87%)
📈 view plot
🚷 view threshold
11.00
(+16.65%)
15.28
(72.01%)
📈 view plot
🚷 view threshold
69.00
(+2.05%)
70.18
(98.32%)
client_sv2_setup_connection_serialize📈 view plot
🚷 view threshold
16.30
(+0.89%)
16.33
(99.81%)
📈 view plot
🚷 view threshold
5,963.00
(-0.01%)
5,980.59
(99.71%)
📈 view plot
🚷 view threshold
8,647.00
(-0.19%)
8,692.84
(99.47%)
📈 view plot
🚷 view threshold
54.00
(+32.41%)
56.72
(95.21%)
📈 view plot
🚷 view threshold
211.00
(+1.30%)
212.26
(99.41%)
client_sv2_setup_connection_serialize_deserialize📈 view plot
🚷 view threshold
35.78
(+0.50%)
35.96
(99.51%)
📈 view plot
🚷 view threshold
14,888.00
(+0.14%)
14,919.71
(99.79%)
📈 view plot
🚷 view threshold
21,867.00
(+0.11%)
21,919.10
(99.76%)
📈 view plot
🚷 view threshold
109.00
(+15.16%)
120.11
(90.75%)
📈 view plot
🚷 view threshold
382.00
(+0.62%)
385.79
(99.02%)
🐰 View full continuous benchmarking report in Bencher

Copy link

codecov bot commented Nov 22, 2024

Codecov Report

Attention: Patch coverage is 12.50000% with 14 lines in your changes missing coverage. Please review.

Project coverage is 19.14%. Comparing base (1f2c5e8) to head (7328cd4).
Report is 32 commits behind head on main.

Files with missing lines Patch % Lines
protocols/v2/roles-logic-sv2/src/routing_logic.rs 0.00% 12 Missing ⚠️
...tocols/v2/roles-logic-sv2/src/common_properties.rs 50.00% 1 Missing ⚠️
protocols/v2/roles-logic-sv2/src/selectors.rs 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1263      +/-   ##
==========================================
- Coverage   19.29%   19.14%   -0.15%     
==========================================
  Files         164      166       +2     
  Lines       10852    10987     +135     
==========================================
+ Hits         2094     2104      +10     
- Misses       8758     8883     +125     
Flag Coverage Δ
binary_codec_sv2-coverage 0.00% <0.00%> (ø)
binary_serde_sv2-coverage 3.65% <0.00%> (ø)
binary_sv2-coverage 5.48% <0.00%> (ø)
bip32_derivation-coverage 0.00% <ø> (ø)
buffer_sv2-coverage 25.02% <ø> (ø)
codec_sv2-coverage 0.01% <0.00%> (ø)
common_messages_sv2-coverage 0.13% <0.00%> (ø)
const_sv2-coverage 0.00% <0.00%> (ø)
error_handling-coverage 0.00% <ø> (ø)
framing_sv2-coverage 0.29% <0.00%> (ø)
jd_client-coverage 0.00% <ø> (ø)
jd_server-coverage 7.79% <ø> (ø)
job_declaration_sv2-coverage 0.00% <0.00%> (ø)
key-utils-coverage 2.39% <ø> (ø)
mining-coverage 2.51% <0.00%> (ø)
mining_device-coverage 0.00% <ø> (ø)
mining_proxy_sv2-coverage 0.70% <ø> (ø)
noise_sv2-coverage 4.35% <0.00%> (ø)
pool_sv2-coverage 2.05% <ø> (+0.66%) ⬆️
protocols 24.74% <12.50%> (+0.01%) ⬆️
roles 6.55% <ø> (+<0.01%) ⬆️
roles_logic_sv2-coverage 8.11% <12.50%> (+0.03%) ⬆️
sv2_ffi-coverage 0.00% <0.00%> (ø)
template_distribution_sv2-coverage 0.00% <0.00%> (ø)
translator_sv2-coverage 9.60% <ø> (ø)
utils ?
v1-coverage 2.47% <0.00%> (ø)

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.

@plebhash plebhash changed the title [WIP] docs roles_logic_sv2 docs roles_logic_sv2 Nov 22, 2024
@plebhash plebhash force-pushed the roles-logic-sv2-docs branch from 9734571 to c3bf010 Compare November 22, 2024 22:02
@plebhash plebhash marked this pull request as ready for review November 22, 2024 22:02
@plebhash plebhash force-pushed the roles-logic-sv2-docs branch 5 times, most recently from c0bbc4f to f9b2125 Compare November 22, 2024 23:34
@plebhash

This comment was marked as outdated.

@plebhash plebhash marked this pull request as draft November 27, 2024 15:17
@plebhash plebhash marked this pull request as ready for review December 2, 2024 06:41
@plebhash plebhash force-pushed the roles-logic-sv2-docs branch from 426e910 to 14649c1 Compare December 2, 2024 07:19
@plebhash plebhash force-pushed the roles-logic-sv2-docs branch 3 times, most recently from e99baf1 to 736b05c Compare December 9, 2024 10:01
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. We're not adding documentation for some structs, enums, and methods right now because they're likely to change in the near future. This crate needs significant refactoring, which will involve architectural changes. While the current documentation isn't complete, it provides enough context to understand the crate. We'll add examples once the refactoring is finished.

@plebhash plebhash force-pushed the roles-logic-sv2-docs branch from 736b05c to 73b0561 Compare December 11, 2024 13:09
@plebhash
Copy link
Collaborator Author

plebhash commented Dec 11, 2024

ACK. We're not adding documentation for some structs, enums, and methods right now because they're likely to change in the near future. This crate needs significant refactoring, which will involve architectural changes. While the current documentation isn't complete, it provides enough context to understand the crate. We'll add examples once the refactoring is finished.

thanks!

I made one last round of modifications (based on #![deny(missing_docs)] 🙈) and I made sure to cover every single pub function/method.

The elements still missing docs are:

  • some pub struct members
  • some pub enum variants

all of them are obvious and meaning is self-evident... writing them would be extremely laborious and chatGPT proved a bit error-prone, so IMO it's fine to leave them like this

@plebhash plebhash force-pushed the roles-logic-sv2-docs branch from 73b0561 to 573c626 Compare December 11, 2024 13:25
@plebhash plebhash added the ready-to-be-merged triggers auto rebase bot label Dec 16, 2024
Comment on lines 33 to 40
/// Enables the selection of which transactions or templates the node will work on. It allows
/// for more autonomy for downstream nodes to define specific version bits to roll, adjust the
/// difficulty target, apply `timestamp` range constraints, etc.
///
/// - `true`: The downstream node can modify or customize the mining job, such as choosing
/// specific transactions to include in a block template.
/// - `false`: The downstream node strictly follows the work provided by the upstream, such as
/// pre-constructed templates from a pool.
Copy link
Collaborator Author

@plebhash plebhash Jan 13, 2025

Choose a reason for hiding this comment

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

this one also should be clarified:

this flag is kind of a "feature gate" for whether SetCustomMiningJob will be allowed to flow within this connection or not (set via REQUIRES_WORK_SELECTION bit flag when the connection is established)

the description is conflating it with version rolling (which is gated by the flag below) and other extra features

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

also re-written and simplified in 63b2c2b

@Fi3
Copy link
Collaborator

Fi3 commented Jan 13, 2025

@plebhash rn roles-logic-sv2 is not even spec complaints I would merge my PRs before documenting it.

@GitGab19
Copy link
Collaborator

@plebhash rn roles-logic-sv2 is not even spec complaints I would merge my PRs before documenting it.

What is not spec-compliant?

This PR is the last step of our efforts in documenting all crates (see #845) before refactoring them. And it's pretty much ready to be merged since a while now. We are just waiting for a final ACK from @rrybarczyk.

@Fi3
Copy link
Collaborator

Fi3 commented Jan 13, 2025

@plebhash rn roles-logic-sv2 is not even spec complaints I would merge my PRs before documenting it.

What is not spec-compliant?

This PR is the last step of our efforts in documenting all crates (see #845) before refactoring them. And it's pretty much ready to be merged since a while now. We are just waiting for a final ACK from @rrybarczyk.

  1. pool signature, rn is not part of the extranonce, this pr solve this.
  2. we removed shortId from the spec, this pr
  3. we (maybe) want to make a message parsable also if have unknown additional fields (like the optional field that we are discussing), is already supported but this pr add tests for it

@plebhash
Copy link
Collaborator Author

plebhash commented Jan 13, 2025

  1. we removed shortId from the spec, this pr

the PR on the link is only changing SRI, we haven't enacted this change in the spec repo yet

I'm about to start working on a PR that will introduce the different JD spec changes (including shortId removal), but ideally we should merge this first: stratum-mining/sv2-spec#104

@plebhash
Copy link
Collaborator Author

plebhash commented Jan 14, 2025

@plebhash rn roles-logic-sv2 is not even spec complaints I would merge my PRs before documenting it.

NACK

spec changes have not yet been enacted on sv2-spec repo

we only have social consensus, so let's not block this PR because of that

@plebhash plebhash mentioned this pull request Jan 15, 2025
3 tasks
@plebhash plebhash added the ready-to-be-merged triggers auto rebase bot label Jan 16, 2025
@pavlenex pavlenex force-pushed the roles-logic-sv2-docs branch from 7328cd4 to db12082 Compare January 16, 2025 15:45
@plebhash plebhash merged commit 568f7df into stratum-mining:main Jan 16, 2025
33 of 35 checks passed
@plebhash plebhash deleted the roles-logic-sv2-docs branch January 16, 2025 16:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready-to-be-merged triggers auto rebase bot
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Need Rust docs on protocols::v2::roles-logic-sv2
5 participants