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

doc: Document Seq064K #1046

Closed

Conversation

average-gary
Copy link
Contributor

Takes specific of bytes, types and sizes from the specification. Lists some use cases for this struct.

Work toward: #1011

Copy link
Contributor

github-actions bot commented Jul 9, 2024

🐰Bencher

ReportWed, September 4, 2024 at 14:10:10 UTC
ProjectStratum V2 (SRI)
Branchdocstring-sequences
Testbedsv1
Click to view all benchmark results
BenchmarkEstimated CyclesEstimated Cycles Results
estimated cycles | (Δ%)
Estimated Cycles Lower Boundary
estimated cycles | (%)
Estimated Cycles Upper Boundary
estimated cycles | (%)
InstructionsInstructions Results
instructions | (Δ%)
Instructions Lower Boundary
instructions | (%)
Instructions Upper Boundary
instructions | (%)
L1 AccessesL1 Accesses Results
accesses | (Δ%)
L1 Accesses Lower Boundary
accesses | (%)
L1 Accesses Upper Boundary
accesses | (%)
L2 AccessesL2 Accesses Results
accesses | (Δ%)
L2 Accesses Lower Boundary
accesses | (%)
L2 Accesses Upper Boundary
accesses | (%)
RAM AccessesRAM Accesses Results
accesses | (Δ%)
RAM Accesses Lower Boundary
accesses | (%)
RAM Accesses Upper Boundary
accesses | (%)
get_authorize✅ (view plot)8,428.00 (-0.26%)8,305.47 (98.55%)8,594.33 (98.06%)✅ (view plot)3,746.00 (-0.20%)3,724.71 (99.43%)3,782.02 (99.05%)✅ (view plot)5,253.00 (-0.20%)5,215.89 (99.29%)5,310.91 (98.91%)✅ (view plot)5.00 (-26.83%)4.81 (96.29%)8.85 (56.48%)✅ (view plot)90.00 (-0.07%)86.96 (96.62%)93.18 (96.59%)
get_submit✅ (view plot)95,341.00 (-0.03%)95,268.55 (99.92%)95,466.85 (99.87%)✅ (view plot)59,439.00 (-0.04%)59,371.15 (99.89%)59,551.98 (99.81%)✅ (view plot)85,371.00 (-0.04%)85,258.31 (99.87%)85,559.09 (99.78%)✅ (view plot)41.00 (-1.44%)34.79 (84.87%)48.41 (84.70%)✅ (view plot)279.00 (+0.14%)275.45 (98.73%)281.75 (99.02%)
get_subscribe✅ (view plot)8,021.00 (-0.14%)7,976.93 (99.45%)8,087.00 (99.18%)✅ (view plot)2,841.00 (-0.08%)2,834.28 (99.76%)2,852.32 (99.60%)✅ (view plot)3,971.00 (-0.12%)3,958.93 (99.70%)3,993.01 (99.45%)✅ (view plot)12.00 (+15.38%)7.97 (66.43%)12.83 (93.54%)✅ (view plot)114.00 (-0.35%)112.77 (98.92%)116.03 (98.25%)
serialize_authorize✅ (view plot)12,279.00 (-0.02%)12,192.76 (99.30%)12,369.31 (99.27%)✅ (view plot)5,317.00 (-0.14%)5,295.71 (99.60%)5,353.02 (99.33%)✅ (view plot)7,414.00 (-0.15%)7,376.84 (99.50%)7,473.89 (99.20%)✅ (view plot)7.00 (-16.67%)6.43 (91.86%)10.37 (67.50%)✅ (view plot)138.00 (+0.34%)135.65 (98.30%)139.41 (98.99%)
serialize_deserialize_authorize✅ (view plot)24,701.00 (-0.22%)24,500.50 (99.19%)25,011.97 (98.76%)✅ (view plot)9,868.00 (-0.14%)9,825.56 (99.57%)9,939.04 (99.29%)✅ (view plot)13,931.00 (-0.15%)13,856.33 (99.46%)14,047.80 (99.17%)✅ (view plot)33.00 (-7.39%)31.64 (95.88%)39.63 (83.27%)✅ (view plot)303.00 (-0.20%)298.57 (98.54%)308.63 (98.18%)
serialize_deserialize_handle_authorize✅ (view plot)30,356.00 (-0.10%)30,284.83 (99.77%)30,490.04 (99.56%)✅ (view plot)12,071.00 (-0.06%)12,049.71 (99.82%)12,107.02 (99.70%)✅ (view plot)17,096.00 (-0.07%)17,054.26 (99.76%)17,161.28 (99.62%)✅ (view plot)55.00 (+0.06%)46.81 (85.12%)63.12 (87.14%)✅ (view plot)371.00 (-0.15%)368.89 (99.43%)374.24 (99.13%)
serialize_deserialize_handle_submit✅ (view plot)126,460.00 (-0.02%)126,456.07 (100.00%)126,514.47 (99.96%)✅ (view plot)73,280.00 (-0.03%)73,211.77 (99.91%)73,392.50 (99.85%)✅ (view plot)105,060.00 (-0.04%)104,944.55 (99.89%)105,249.32 (99.82%)✅ (view plot)101.00 (-1.14%)93.27 (92.34%)111.07 (90.94%)✅ (view plot)597.00 (+0.08%)591.23 (99.03%)601.77 (99.21%)
serialize_deserialize_handle_subscribe✅ (view plot)27,974.00 (-0.07%)27,921.32 (99.81%)28,063.68 (99.68%)✅ (view plot)9,659.00 (-0.02%)9,652.28 (99.93%)9,670.32 (99.88%)✅ (view plot)13,664.00 (-0.02%)13,645.87 (99.87%)13,687.79 (99.83%)✅ (view plot)62.00 (-0.91%)55.19 (89.01%)69.94 (88.64%)✅ (view plot)400.00 (-0.09%)398.21 (99.55%)402.52 (99.37%)
serialize_deserialize_submit✅ (view plot)115,211.00 (-0.03%)114,962.01 (99.78%)115,536.52 (99.72%)✅ (view plot)68,057.00 (-0.07%)67,920.53 (99.80%)68,282.00 (99.67%)✅ (view plot)97,656.00 (-0.08%)97,429.13 (99.77%)98,034.73 (99.61%)✅ (view plot)60.00 (-0.66%)54.12 (90.20%)66.68 (89.98%)✅ (view plot)493.00 (+0.23%)490.34 (99.46%)493.39 (99.92%)
serialize_deserialize_subscribe✅ (view plot)23,409.00 (+0.01%)23,308.14 (99.57%)23,505.66 (99.59%)✅ (view plot)8,211.00 (-0.05%)8,199.22 (99.86%)8,231.11 (99.76%)✅ (view plot)11,564.00 (-0.07%)11,544.08 (99.83%)11,600.05 (99.69%)✅ (view plot)38.00 (+1.69%)35.21 (92.66%)39.52 (96.15%)✅ (view plot)333.00 (+0.06%)330.47 (99.24%)335.13 (99.37%)
serialize_submit✅ (view plot)99,798.00 (-0.02%)99,763.24 (99.97%)99,866.42 (99.93%)✅ (view plot)61,483.00 (-0.04%)61,415.15 (99.89%)61,595.98 (99.82%)✅ (view plot)88,213.00 (-0.04%)88,094.99 (99.87%)88,403.34 (99.78%)✅ (view plot)42.00 (-5.97%)38.40 (91.42%)50.94 (82.45%)✅ (view plot)325.00 (+0.29%)318.90 (98.12%)329.23 (98.72%)
serialize_subscribe✅ (view plot)11,418.00 (+0.01%)11,353.02 (99.43%)11,479.84 (99.46%)✅ (view plot)4,188.00 (-0.05%)4,181.28 (99.84%)4,199.32 (99.73%)✅ (view plot)5,828.00 (-0.07%)5,815.23 (99.78%)5,848.97 (99.64%)✅ (view plot)12.00 (+1.69%)9.85 (82.09%)13.75 (87.28%)✅ (view plot)158.00 (+0.08%)155.60 (98.48%)160.14 (98.67%)

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

Copy link
Contributor

github-actions bot commented Jul 9, 2024

🐰 Bencher Report

Branch1046/merge
Testbedsv1
Click to view all benchmark results
BenchmarkLatencyBenchmark Result
nanoseconds (ns)
(Result Δ%)
Lower Boundary
nanoseconds (ns)
(Limit %)
Upper Boundary
nanoseconds (ns)
(Limit %)
client-submit-serialize📈 view plot
🚷 view threshold
6,812.80
(-0.44%)
6,362.78
(93.39%)
7,323.04
(93.03%)
client-submit-serialize-deserialize📈 view plot
🚷 view threshold
7,704.30
(-1.92%)
7,363.99
(95.58%)
8,346.37
(92.31%)
client-submit-serialize-deserialize-handle/client-submit-serialize-deserialize-handle📈 view plot
🚷 view threshold
8,263.50
(-1.83%)
7,910.28
(95.73%)
8,924.08
(92.60%)
client-sv1-authorize-serialize-deserialize-handle/client-sv1-authorize-serialize-deserialize-handle📈 view plot
🚷 view threshold
883.45
(-4.21%)
857.40
(97.05%)
987.18
(89.49%)
client-sv1-authorize-serialize-deserialize/client-sv1-authorize-serialize-deserialize📈 view plot
🚷 view threshold
671.69
(-6.82%)
655.31
(97.56%)
786.40
(85.41%)
client-sv1-authorize-serialize/client-sv1-authorize-serialize📈 view plot
🚷 view threshold
258.36
(+3.10%)
236.24
(91.44%)
264.93
(97.52%)
client-sv1-get-authorize/client-sv1-get-authorize📈 view plot
🚷 view threshold
156.13
(-1.56%)
152.10
(97.42%)
165.09
(94.57%)
client-sv1-get-submit📈 view plot
🚷 view threshold
6,594.20
(-0.32%)
6,181.03
(93.73%)
7,049.52
(93.54%)
client-sv1-get-subscribe/client-sv1-get-subscribe📈 view plot
🚷 view threshold
280.41
(+0.36%)
264.60
(94.36%)
294.18
(95.32%)
client-sv1-subscribe-serialize-deserialize-handle/client-sv1-subscribe-serialize-deserialize-handle📈 view plot
🚷 view threshold
736.33
(-5.34%)
719.81
(97.76%)
835.91
(88.09%)
client-sv1-subscribe-serialize-deserialize/client-sv1-subscribe-serialize-deserialize📈 view plot
🚷 view threshold
602.57
(-5.52%)
584.70
(97.03%)
690.91
(87.21%)
client-sv1-subscribe-serialize/client-sv1-subscribe-serialize📈 view plot
🚷 view threshold
204.78
(-1.74%)
191.26
(93.40%)
225.56
(90.79%)
🐰 View full continuous benchmarking report in Bencher

Copy link
Contributor

github-actions bot commented Jul 9, 2024

🐰Bencher

ReportWed, September 4, 2024 at 14:09:59 UTC
ProjectStratum V2 (SRI)
Branchdocstring-sequences
Testbedsv2

🚨 3 ALERTS: Threshold Boundary Limits exceeded!
BenchmarkMeasure (units)ViewValueLower BoundaryUpper Boundary
client_sv2_mining_message_submit_standard_serializeL2 Accesses (accesses)🚨 (view plot | view alert)48.00 (+15.20%)35.46 (73.87%)47.87 (100.26%)
client_sv2_open_channel_serialize_deserializeL2 Accesses (accesses)🚨 (view plot | view alert)82.00 (+12.38%)64.72 (78.92%)81.22 (100.96%)
client_sv2_setup_connection_serializeL2 Accesses (accesses)🚨 (view plot | view alert)43.00 (+16.01%)31.79 (73.93%)42.34 (101.55%)

Click to view all benchmark results
BenchmarkEstimated CyclesEstimated Cycles Results
estimated cycles | (Δ%)
Estimated Cycles Lower Boundary
estimated cycles | (%)
Estimated Cycles Upper Boundary
estimated cycles | (%)
InstructionsInstructions Results
instructions | (Δ%)
Instructions Lower Boundary
instructions | (%)
Instructions Upper Boundary
instructions | (%)
L1 AccessesL1 Accesses Results
accesses | (Δ%)
L1 Accesses Lower Boundary
accesses | (%)
L1 Accesses Upper Boundary
accesses | (%)
L2 AccessesL2 Accesses Results
accesses | (Δ%)
L2 Accesses Lower Boundary
accesses | (%)
L2 Accesses Upper Boundary
accesses | (%)
RAM AccessesRAM Accesses Results
accesses | (Δ%)
RAM Accesses Lower Boundary
accesses | (%)
RAM Accesses Upper Boundary
accesses | (%)
client_sv2_handle_message_common✅ (view plot)2,145.00 (+2.04%)2,022.98 (94.31%)2,181.09 (98.35%)✅ (view plot)473.00 (-0.01%)468.75 (99.10%)477.32 (99.09%)✅ (view plot)730.00 (-0.80%)726.57 (99.53%)745.16 (97.97%)✅ (view plot)10.00 (+114.29%)-2.19 (-21.90%)11.52 (86.78%)✅ (view plot)39.00 (+1.65%)36.41 (93.36%)40.32 (96.72%)
client_sv2_handle_message_mining✅ (view plot)8,216.00 (+0.33%)8,139.66 (99.07%)8,238.07 (99.73%)✅ (view plot)2,137.00✅ (view plot)3,156.00 (-0.14%)3,154.48 (99.95%)3,166.59 (99.67%)✅ (view plot)39.00 (+12.18%)29.09 (74.60%)40.44 (96.44%)✅ (view plot)139.00 (+0.22%)137.57 (98.97%)139.83 (99.41%)
client_sv2_mining_message_submit_standard✅ (view plot)6,335.00 (+0.88%)6,205.48 (97.96%)6,354.45 (99.69%)✅ (view plot)1,750.00 (-0.00%)1,745.75 (99.76%)1,754.32 (99.75%)✅ (view plot)2,545.00 (-0.26%)2,542.11 (99.89%)2,561.16 (99.37%)✅ (view plot)23.00 (+33.72%)10.25 (44.58%)24.15 (95.25%)✅ (view plot)105.00 (+0.90%)102.06 (97.20%)106.07 (98.99%)
client_sv2_mining_message_submit_standard_serialize✅ (view plot)14,728.00 (+0.10%)14,614.39 (99.23%)14,811.14 (99.44%)✅ (view plot)4,694.00 (-0.00%)4,689.75 (99.91%)4,698.32 (99.91%)✅ (view plot)6,753.00 (-0.09%)6,750.08 (99.96%)6,767.79 (99.78%)🚨 (view plot | view alert)48.00 (+15.20%)35.46 (73.87%)47.87 (100.26%)✅ (view plot)221.00 (-0.14%)218.59 (98.91%)224.01 (98.66%)
client_sv2_mining_message_submit_standard_serialize_deserialize✅ (view plot)27,514.00 (-0.04%)27,432.04 (99.70%)27,617.50 (99.63%)✅ (view plot)10,585.00 (-0.00%)10,580.75 (99.96%)10,589.32 (99.96%)✅ (view plot)15,399.00 (-0.03%)15,395.33 (99.98%)15,410.53 (99.93%)✅ (view plot)85.00 (+6.16%)74.98 (88.22%)85.15 (99.82%)✅ (view plot)334.00 (-0.27%)332.25 (99.48%)337.55 (98.95%)
client_sv2_open_channel✅ (view plot)4,371.00 (-0.16%)4,319.41 (98.82%)4,436.52 (98.52%)✅ (view plot)1,461.00 (-0.00%)1,456.75 (99.71%)1,465.32 (99.71%)✅ (view plot)2,161.00 (-0.01%)2,154.75 (99.71%)2,167.51 (99.70%)✅ (view plot)8.00 (+6.67%)4.90 (61.23%)10.10 (79.19%)✅ (view plot)62.00 (-0.43%)60.59 (97.73%)63.94 (96.97%)
client_sv2_open_channel_serialize✅ (view plot)13,986.00 (-0.23%)13,925.69 (99.57%)14,109.44 (99.13%)✅ (view plot)5,064.00 (-0.00%)5,059.75 (99.92%)5,068.32 (99.91%)✅ (view plot)7,326.00 (-0.03%)7,320.83 (99.93%)7,335.64 (99.87%)✅ (view plot)37.00 (+11.11%)28.13 (76.03%)38.47 (96.18%)✅ (view plot)185.00 (-0.73%)183.71 (99.30%)189.02 (97.87%)
client_sv2_open_channel_serialize_deserialize✅ (view plot)22,651.00 (+0.07%)22,543.28 (99.52%)22,727.06 (99.67%)✅ (view plot)8,027.00 (-0.00%)8,022.75 (99.95%)8,031.32 (99.95%)✅ (view plot)11,671.00 (-0.07%)11,669.26 (99.99%)11,689.41 (99.84%)🚨 (view plot | view alert)82.00 (+12.38%)64.72 (78.92%)81.22 (100.96%)✅ (view plot)302.00 (-0.20%)300.17 (99.39%)305.03 (99.01%)
client_sv2_setup_connection✅ (view plot)4,707.00 (+0.52%)4,619.96 (98.15%)4,745.04 (99.20%)✅ (view plot)1,502.00 (-0.00%)1,497.75 (99.72%)1,506.32 (99.71%)✅ (view plot)2,277.00 (-0.07%)2,271.84 (99.77%)2,285.16 (99.64%)✅ (view plot)10.00 (+11.11%)5.82 (58.22%)12.18 (82.11%)✅ (view plot)68.00 (+0.89%)65.65 (96.54%)69.15 (98.33%)
client_sv2_setup_connection_serialize✅ (view plot)16,156.00 (+0.10%)16,072.54 (99.48%)16,207.66 (99.68%)✅ (view plot)5,963.00 (-0.00%)5,958.75 (99.93%)5,967.32 (99.93%)✅ (view plot)8,661.00 (-0.06%)8,658.82 (99.97%)8,674.38 (99.85%)🚨 (view plot | view alert)43.00 (+16.01%)31.79 (73.93%)42.34 (101.55%)✅ (view plot)208.00 (-0.11%)206.36 (99.21%)210.11 (99.00%)
client_sv2_setup_connection_serialize_deserialize✅ (view plot)35,610.00 (+0.11%)35,465.73 (99.59%)35,677.94 (99.81%)✅ (view plot)14,855.00 (-0.00%)14,850.75 (99.97%)14,859.32 (99.97%)✅ (view plot)21,815.00 (-0.04%)21,812.57 (99.99%)21,836.77 (99.90%)✅ (view plot)99.00 (+10.99%)79.08 (79.88%)99.32 (99.68%)✅ (view plot)380.00 (-0.01%)377.53 (99.35%)382.53 (99.34%)

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

Copy link
Contributor

github-actions bot commented Jul 9, 2024

🐰Bencher

ReportWed, September 4, 2024 at 14:09:58 UTC
ProjectStratum V2 (SRI)
Branchdocstring-sequences
Testbedsv2
Click to view all benchmark results
BenchmarkLatencyLatency Results
nanoseconds (ns) | (Δ%)
Latency Lower Boundary
nanoseconds (ns) | (%)
Latency Upper Boundary
nanoseconds (ns) | (%)
client_sv2_handle_message_common✅ (view plot)44.63 (+0.10%)43.18 (96.75%)45.99 (97.03%)
client_sv2_handle_message_mining✅ (view plot)75.16 (-1.43%)62.74 (83.47%)89.76 (83.74%)
client_sv2_mining_message_submit_standard✅ (view plot)14.73 (+0.34%)14.59 (99.03%)14.77 (99.70%)
client_sv2_mining_message_submit_standard_serialize✅ (view plot)272.41 (+1.69%)252.06 (92.53%)283.69 (96.02%)
client_sv2_mining_message_submit_standard_serialize_deserialize✅ (view plot)587.96 (-0.94%)566.99 (96.43%)620.10 (94.82%)
client_sv2_open_channel✅ (view plot)163.19 (-2.39%)159.94 (98.01%)174.41 (93.57%)
client_sv2_open_channel_serialize✅ (view plot)270.84 (-2.46%)255.17 (94.21%)300.15 (90.24%)
client_sv2_open_channel_serialize_deserialize✅ (view plot)374.31 (+0.08%)365.04 (97.52%)382.96 (97.74%)
client_sv2_setup_connection✅ (view plot)159.57 (-2.09%)146.39 (91.74%)179.55 (88.87%)
client_sv2_setup_connection_serialize✅ (view plot)429.23 (-6.18%)364.51 (84.92%)550.49 (77.97%)
client_sv2_setup_connection_serialize_deserialize✅ (view plot)1,029.50 (+3.20%)904.58 (87.87%)1,090.51 (94.41%)

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

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.

Concept ACK. Just one nit

@average-gary average-gary force-pushed the docstring-sequences branch 2 times, most recently from a849ccb to 3c0fa5a Compare July 16, 2024 13:47
@plebhash plebhash changed the base branch from dev to main August 28, 2024 20:17
@rrybarczyk rrybarczyk added documentation Improvements or additions to documentation protocols Lowest level protocol logic labels Sep 4, 2024
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.

Fine with merging as long as we know that issues #1011 and #1010 will address the full crates and also impose the documentation standards we have discussing in #970.

@average-gary average-gary force-pushed the docstring-sequences branch 2 times, most recently from 7f71069 to 7d3e563 Compare September 4, 2024 14:17
@rrybarczyk
Copy link
Collaborator

@marathon-gary has updated this PR with main, however the CI checks are not running. He said there has been issues with his GitHub account and is contact with their support. Once this is resolved, we can merge.

@@ -95,6 +95,15 @@ impl<'a, T: GetSize> GetSize for Seq0255<'a, T> {
}
}

/// Fixed size data sequence up to a length of 65535
///
/// Byte Length Calculation:
Copy link
Contributor

Choose a reason for hiding this comment

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

what is this referring to? where this byte calculation is happening?

Copy link
Collaborator

@Fi3 Fi3 Sep 6, 2024

Choose a reason for hiding this comment

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

this is how is defined in spec. Actual byte calculation happen in get_size.

Copy link
Collaborator

Choose a reason for hiding this comment

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

/// Return the encoded byte size of an `Encodable` comprehensive of the header, if any
pub trait GetSize {
    fn get_size(&self) -> usize;
}

Copy link
Contributor

Choose a reason for hiding this comment

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

So should this doc live here or in the binary-sv2 and link to it?
another question please, what does L refer to?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Which L ?

Copy link
Collaborator

Choose a reason for hiding this comment

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

a ok the one in docs

Copy link
Collaborator

Choose a reason for hiding this comment

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

so that doc come directly from the spec and L stand for the number of elments in the sequnce
https://github.com/stratum-mining/sv2-spec/blob/main/03-Protocol-Overview.md#31-data-types-mapping

Copy link
Contributor

Choose a reason for hiding this comment

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

yea, its mentioned here twice Decsription: 2-byte length L, unsigned little-endian integer 16-bits, followed by a sequence of L elements of type T. Allowed range of length is 0 to 65535.

Copy link
Collaborator

Choose a reason for hiding this comment

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

btw yes we could link the the GetSize and SizeHint trait in that doc. GetSize is implemented for Encodable and return the total len SizeHint is implemented for Decodable and retutrn total len - header len

/// Decsription: 2-byte length L, unsigned little-endian integer 16-bits, followed by a sequence of L elements of type T. Allowed range of length is 0 to 65535.
///
/// Used for listing channel ids, tx short hashes, tx hashes, list indexes, and full transaction data.
///
/// The liftime is here only for type compatibility with serde-sv2
#[derive(Debug, Clone, Eq, PartialEq)]
pub struct Seq064K<'a, T>(pub(crate) Vec<T>, PhantomData<&'a T>);
Copy link
Contributor

Choose a reason for hiding this comment

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

Its still not clear to me what the Vec<T> and PhantomData represent here tbh

/// - For variable-length T: 2 + seq.map(|x| x.length()).sum()
/// Decsription: 2-byte length L, unsigned little-endian integer 16-bits, followed by a sequence of L elements of type T. Allowed range of length is 0 to 65535.
///
/// Used for listing channel ids, tx short hashes, tx hashes, list indexes, and full transaction data.
Copy link
Contributor

Choose a reason for hiding this comment

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

This is great. Is it possible to also explain why this type is used in the mentioned scenarios?

@@ -9,6 +9,7 @@ use crate::{
use alloc::vec::Vec;
use serde::{ser, ser::SerializeTuple, Deserialize, Deserializer, Serialize};

/// See `binary_sv2::Seq064k`
Copy link
Contributor

Choose a reason for hiding this comment

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

Would this link to the binary_sv2::Seq064k in docs.rs ?

Copy link
Collaborator

Choose a reason for hiding this comment

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

@jbesraa, good eye/thought process. The answer is no, but check out this comment I left on the #970 discussion.

Let me know your thoughts on making this part of our documentation standard.

@average-gary
Copy link
Contributor Author

Still no update on my GitHub support issue for actions being disabled on my account.
:(

Copy link
Contributor

github-actions bot commented Oct 19, 2024

🐰 Bencher Report

Branch1046/merge
Testbedsv2
🚨 3 ALERTS: Threshold Boundary Limits exceeded!
BenchmarkMeasure
Units
ViewBenchmark Result
(Result Δ%)
Lower Boundary
(Limit %)
Upper Boundary
(Limit %)
client_sv2_handle_message_miningEstimated Cycles
estimated cycles
📈 plot
🚨 alert
🚷 threshold
8,154.00
(-0.51%)
8,160.33
(100.08%)
8,230.87
(99.07%)
client_sv2_handle_message_miningRAM Accesses
accesses
📈 plot
🚨 alert
🚷 threshold
138.00
(-0.62%)
138.03
(100.02%)
139.70
(98.78%)
client_sv2_open_channel_serialize_deserializeL2 Accesses
accesses
📈 plot
🚨 alert
🚷 threshold
81.00
(+10.66%)
66.34
(81.90%)
80.06
(101.18%)
Click to view all benchmark results
BenchmarkEstimated CyclesBenchmark Result
estimated cycles
(Result Δ%)
Lower Boundary
estimated cycles
(Limit %)
Upper Boundary
estimated cycles
(Limit %)
InstructionsBenchmark Result
instructions
(Result Δ%)
Lower Boundary
instructions
(Limit %)
Upper Boundary
instructions
(Limit %)
L1 AccessesBenchmark Result
accesses
(Result Δ%)
Lower Boundary
accesses
(Limit %)
Upper Boundary
accesses
(Limit %)
L2 AccessesBenchmark Result
accesses
(Result Δ%)
Lower Boundary
accesses
(Limit %)
Upper Boundary
accesses
(Limit %)
RAM AccessesBenchmark Result
accesses
(Result Δ%)
Lower Boundary
accesses
(Limit %)
Upper Boundary
accesses
(Limit %)
client_sv2_handle_message_common📈 view plot
🚷 view threshold
2,125.00
(+0.79%)
2,025.53
(95.32%)
2,191.07
(96.98%)
📈 view plot
🚷 view threshold
473.00
(-0.41%)
457.79
(96.78%)
492.15
(96.11%)
📈 view plot
🚷 view threshold
735.00
(-0.49%)
717.02
(97.55%)
760.24
(96.68%)
📈 view plot
🚷 view threshold
5.00
(+7.14%)
-0.19
(-3.77%)
9.52
(52.51%)
📈 view plot
🚷 view threshold
39.00
(+1.39%)
36.59
(93.82%)
40.35
(96.67%)
client_sv2_handle_message_mining📈 view plot
🚨 view alert
🚷 view threshold
8,154.00
(-0.51%)
8,160.33
(100.08%)
8,230.87
(99.07%)
📈 view plot
🚷 view threshold
2,137.00📈 view plot
🚷 view threshold
3,164.00
(+0.12%)
3,155.82
(99.74%)
3,164.38
(99.99%)
📈 view plot
🚷 view threshold
32.00
(-8.66%)
30.99
(96.84%)
39.08
(81.89%)
📈 view plot
🚨 view alert
🚷 view threshold
138.00
(-0.62%)
138.03
(100.02%)
139.70
(98.78%)
client_sv2_mining_message_submit_standard📈 view plot
🚷 view threshold
6,247.00
(-0.64%)
6,212.88
(99.45%)
6,361.59
(98.20%)
📈 view plot
🚷 view threshold
1,750.00
(-0.11%)
1,734.79
(99.13%)
1,769.15
(98.92%)
📈 view plot
🚷 view threshold
2,552.00
(-0.09%)
2,532.53
(99.24%)
2,576.27
(99.06%)
📈 view plot
🚷 view threshold
18.00
(+4.85%)
11.44
(63.57%)
22.89
(78.63%)
📈 view plot
🚷 view threshold
103.00
(-1.15%)
102.15
(99.17%)
106.25
(96.94%)
client_sv2_mining_message_submit_standard_serialize📈 view plot
🚷 view threshold
14,636.00
(-0.30%)
14,565.76
(99.52%)
14,793.38
(98.94%)
📈 view plot
🚷 view threshold
4,694.00
(-0.04%)
4,678.79
(99.68%)
4,713.15
(99.59%)
📈 view plot
🚷 view threshold
6,761.00
(-0.01%)
6,737.70
(99.66%)
6,785.43
(99.64%)
📈 view plot
🚷 view threshold
42.00
(-2.63%)
36.21
(86.21%)
50.06
(83.90%)
📈 view plot
🚷 view threshold
219.00
(-0.48%)
217.02
(99.10%)
223.11
(98.16%)
client_sv2_mining_message_submit_standard_serialize_deserialize📈 view plot
🚷 view threshold
27,468.00
(-0.12%)
27,403.08
(99.76%)
27,597.52
(99.53%)
📈 view plot
🚷 view threshold
10,585.00
(-0.02%)
10,569.79
(99.86%)
10,604.15
(99.82%)
📈 view plot
🚷 view threshold
15,403.00
(-0.02%)
15,383.53
(99.87%)
15,427.74
(99.84%)
📈 view plot
🚷 view threshold
82.00
(+1.03%)
76.49
(93.28%)
85.84
(95.52%)
📈 view plot
🚷 view threshold
333.00
(-0.29%)
331.02
(99.41%)
336.91
(98.84%)
client_sv2_open_channel📈 view plot
🚷 view threshold
4,375.00
(+0.03%)
4,299.58
(98.28%)
4,447.42
(98.37%)
📈 view plot
🚷 view threshold
1,461.00
(-0.13%)
1,445.79
(98.96%)
1,480.15
(98.71%)
📈 view plot
🚷 view threshold
2,160.00
(-0.18%)
2,142.52
(99.19%)
2,185.15
(98.85%)
📈 view plot
🚷 view threshold
9.00
(+13.45%)
3.14
(34.85%)
12.73
(70.70%)
📈 view plot
🚷 view threshold
62.00
(0.00%)
60.09
(96.92%)
63.91
(97.02%)
client_sv2_open_channel_serialize📈 view plot
🚷 view threshold
13,978.00
(-0.01%)
13,881.42
(99.31%)
14,078.11
(99.29%)
📈 view plot
🚷 view threshold
5,064.00
(-0.04%)
5,048.79
(99.70%)
5,083.15
(99.62%)
📈 view plot
🚷 view threshold
7,328.00
(-0.03%)
7,307.69
(99.72%)
7,352.84
(99.66%)
📈 view plot
🚷 view threshold
35.00
(-1.69%)
30.45
(87.00%)
40.75
(85.89%)
📈 view plot
🚷 view threshold
185.00
(+0.05%)
182.10
(98.43%)
187.70
(98.56%)
client_sv2_open_channel_serialize_deserialize📈 view plot
🚷 view threshold
22,681.00
(+0.14%)
22,561.00
(99.47%)
22,739.60
(99.74%)
📈 view plot
🚷 view threshold
8,027.00
(-0.02%)
8,011.79
(99.81%)
8,046.15
(99.76%)
📈 view plot
🚷 view threshold
11,671.00
(-0.09%)
11,660.13
(99.91%)
11,703.14
(99.73%)
📈 view plot
🚨 view alert
🚷 view threshold
81.00
(+10.66%)
66.34
(81.90%)
80.06
(101.18%)
📈 view plot
🚷 view threshold
303.00
(+0.02%)
300.32
(99.11%)
305.55
(99.17%)
client_sv2_setup_connection📈 view plot
🚷 view threshold
4,673.00
(-0.35%)
4,611.99
(98.69%)
4,767.14
(98.03%)
📈 view plot
🚷 view threshold
1,502.00
(-0.13%)
1,486.79
(98.99%)
1,521.15
(98.74%)
📈 view plot
🚷 view threshold
2,278.00
(-0.11%)
2,260.27
(99.22%)
2,300.87
(99.01%)
📈 view plot
🚷 view threshold
10.00
(+2.39%)
5.07
(50.66%)
14.47
(69.12%)
📈 view plot
🚷 view threshold
67.00
(-0.64%)
65.67
(98.02%)
69.20
(96.83%)
client_sv2_setup_connection_serialize📈 view plot
🚷 view threshold
16,110.00
(-0.06%)
16,031.81
(99.51%)
16,207.19
(99.40%)
📈 view plot
🚷 view threshold
5,963.00
(-0.03%)
5,947.79
(99.74%)
5,982.15
(99.68%)
📈 view plot
🚷 view threshold
8,665.00
(-0.05%)
8,648.20
(99.81%)
8,690.47
(99.71%)
📈 view plot
🚷 view threshold
40.00
(+5.26%)
32.53
(81.33%)
43.47
(92.02%)
📈 view plot
🚷 view threshold
207.00
(-0.21%)
205.08
(99.07%)
209.78
(98.67%)
client_sv2_setup_connection_serialize_deserialize📈 view plot
🚷 view threshold
35,476.00
(-0.04%)
35,383.72
(99.74%)
35,593.54
(99.67%)
📈 view plot
🚷 view threshold
14,855.00
(-0.01%)
14,839.79
(99.90%)
14,874.15
(99.87%)
📈 view plot
🚷 view threshold
21,826.00
(-0.02%)
21,808.61
(99.92%)
21,850.99
(99.89%)
📈 view plot
🚷 view threshold
91.00
(+1.68%)
80.74
(88.73%)
98.26
(92.61%)
📈 view plot
🚷 view threshold
377.00
(-0.12%)
374.72
(99.39%)
380.22
(99.15%)
🐰 View full continuous benchmarking report in Bencher

Copy link
Contributor

github-actions bot commented Oct 19, 2024

🐰 Bencher Report

Branch1046/merge
Testbedsv1
🚨 31 ALERTS: Threshold Boundary Limits exceeded!
BenchmarkMeasure
Units
ViewBenchmark Result
(Result Δ%)
Lower Boundary
(Limit %)
Upper Boundary
(Limit %)
get_authorizeInstructions
instructions
📈 plot
🚨 alert
🚷 threshold
3,663.00
(-2.53%)
3,679.18
(100.44%)
3,836.69
(95.47%)
get_authorizeL1 Accesses
accesses
📈 plot
🚨 alert
🚷 threshold
5,112.00
(-2.98%)
5,138.35
(100.52%)
5,399.72
(94.67%)
get_submitInstructions
instructions
📈 plot
🚨 alert
🚷 threshold
59,263.00
(-0.36%)
59,287.09
(100.04%)
59,672.17
(99.31%)
get_submitL1 Accesses
accesses
📈 plot
🚨 alert
🚷 threshold
85,076.00
(-0.42%)
85,116.99
(100.05%)
85,757.01
(99.21%)
get_submitRAM Accesses
accesses
📈 plot
🚨 alert
🚷 threshold
284.00
(+1.94%)
273.37
(96.26%)
283.83
(100.06%)
get_subscribeInstructions
instructions
📈 plot
🚨 alert
🚷 threshold
2,758.00
(-2.90%)
2,776.43
(100.67%)
2,904.11
(94.97%)
get_subscribeL1 Accesses
accesses
📈 plot
🚨 alert
🚷 threshold
3,830.00
(-3.51%)
3,861.53
(100.82%)
4,076.74
(93.95%)
get_subscribeL2 Accesses
accesses
📈 plot
🚨 alert
🚷 threshold
17.00
(+40.50%)
7.20
(42.37%)
17.00
(100.02%)
serialize_authorizeEstimated Cycles
estimated cycles
📈 plot
🚨 alert
🚷 threshold
12,109.00
(-1.60%)
12,114.11
(100.04%)
12,498.49
(96.88%)
serialize_authorizeInstructions
instructions
📈 plot
🚨 alert
🚷 threshold
5,240.00
(-1.68%)
5,254.71
(100.28%)
5,404.36
(96.96%)
serialize_authorizeL1 Accesses
accesses
📈 plot
🚨 alert
🚷 threshold
7,279.00
(-2.07%)
7,304.62
(100.35%)
7,560.98
(96.27%)
serialize_deserialize_authorizeEstimated Cycles
estimated cycles
📈 plot
🚨 alert
🚷 threshold
24,482.00
(-1.42%)
24,486.25
(100.02%)
25,185.08
(97.21%)
serialize_deserialize_authorizeInstructions
instructions
📈 plot
🚨 alert
🚷 threshold
9,786.00
(-1.13%)
9,794.58
(100.09%)
10,000.15
(97.86%)
serialize_deserialize_authorizeL1 Accesses
accesses
📈 plot
🚨 alert
🚷 threshold
13,787.00
(-1.36%)
13,801.81
(100.11%)
14,151.86
(97.42%)
serialize_deserialize_handle_authorizeEstimated Cycles
estimated cycles
📈 plot
🚨 alert
🚷 threshold
30,197.00
(-0.74%)
30,217.64
(100.07%)
30,629.29
(98.59%)
serialize_deserialize_handle_authorizeInstructions
instructions
📈 plot
🚨 alert
🚷 threshold
11,989.00
(-0.78%)
12,004.94
(100.13%)
12,161.13
(98.58%)
serialize_deserialize_handle_authorizeL1 Accesses
accesses
📈 plot
🚨 alert
🚷 threshold
16,952.00
(-0.95%)
16,978.38
(100.16%)
17,250.89
(98.27%)
serialize_deserialize_handle_submitEstimated Cycles
estimated cycles
📈 plot
🚨 alert
🚷 threshold
126,166.00
(-0.26%)
126,208.33
(100.03%)
126,788.61
(99.51%)
serialize_deserialize_handle_submitInstructions
instructions
📈 plot
🚨 alert
🚷 threshold
73,117.00
(-0.28%)
73,132.73
(100.02%)
73,505.33
(99.47%)
serialize_deserialize_handle_submitL1 Accesses
accesses
📈 plot
🚨 alert
🚷 threshold
104,766.00
(-0.34%)
104,796.22
(100.03%)
105,444.05
(99.36%)
serialize_deserialize_handle_subscribeEstimated Cycles
estimated cycles
📈 plot
🚨 alert
🚷 threshold
27,753.00
(-0.87%)
27,789.68
(100.13%)
28,204.05
(98.40%)
serialize_deserialize_handle_subscribeInstructions
instructions
📈 plot
🚨 alert
🚷 threshold
9,577.00
(-0.84%)
9,595.22
(100.19%)
9,721.51
(98.51%)
serialize_deserialize_handle_subscribeL1 Accesses
accesses
📈 plot
🚨 alert
🚷 threshold
13,523.00
(-1.02%)
13,551.44
(100.21%)
13,772.29
(98.19%)
serialize_deserialize_submitEstimated Cycles
estimated cycles
📈 plot
🚨 alert
🚷 threshold
114,821.00
(-0.46%)
114,859.71
(100.03%)
115,834.43
(99.13%)
serialize_deserialize_subscribeEstimated Cycles
estimated cycles
📈 plot
🚨 alert
🚷 threshold
23,082.00
(-1.41%)
23,114.66
(100.14%)
23,708.41
(97.36%)
serialize_deserialize_subscribeInstructions
instructions
📈 plot
🚨 alert
🚷 threshold
8,129.00
(-1.05%)
8,146.83
(100.22%)
8,283.24
(98.14%)
serialize_deserialize_subscribeL1 Accesses
accesses
📈 plot
🚨 alert
🚷 threshold
11,427.00
(-1.26%)
11,456.74
(100.26%)
11,688.32
(97.76%)
serialize_submitInstructions
instructions
📈 plot
🚨 alert
🚷 threshold
61,325.00
(-0.33%)
61,344.53
(100.03%)
61,706.33
(99.38%)
serialize_submitL1 Accesses
accesses
📈 plot
🚨 alert
🚷 threshold
87,938.00
(-0.39%)
87,973.65
(100.04%)
88,589.42
(99.26%)
serialize_subscribeInstructions
instructions
📈 plot
🚨 alert
🚷 threshold
4,111.00
(-1.84%)
4,128.16
(100.42%)
4,247.57
(96.78%)
serialize_subscribeL1 Accesses
accesses
📈 plot
🚨 alert
🚷 threshold
5,695.00
(-2.28%)
5,724.66
(100.52%)
5,931.08
(96.02%)
Click to view all benchmark results
BenchmarkEstimated CyclesBenchmark Result
estimated cycles
(Result Δ%)
Lower Boundary
estimated cycles
(Limit %)
Upper Boundary
estimated cycles
(Limit %)
InstructionsBenchmark Result
instructions
(Result Δ%)
Lower Boundary
instructions
(Limit %)
Upper Boundary
instructions
(Limit %)
L1 AccessesBenchmark Result
accesses
(Result Δ%)
Lower Boundary
accesses
(Limit %)
Upper Boundary
accesses
(Limit %)
L2 AccessesBenchmark Result
accesses
(Result Δ%)
Lower Boundary
accesses
(Limit %)
Upper Boundary
accesses
(Limit %)
RAM AccessesBenchmark Result
accesses
(Result Δ%)
Lower Boundary
accesses
(Limit %)
Upper Boundary
accesses
(Limit %)
get_authorize📈 view plot
🚷 view threshold
8,342.00
(-2.01%)
8,319.70
(99.73%)
8,707.03
(95.81%)
📈 view plot
🚨 view alert
🚷 view threshold
3,663.00
(-2.53%)
3,679.18
(100.44%)
3,836.69
(95.47%)
📈 view plot
🚨 view alert
🚷 view threshold
5,112.00
(-2.98%)
5,138.35
(100.52%)
5,399.72
(94.67%)
📈 view plot
🚷 view threshold
9.00
(+13.92%)
3.57
(39.69%)
12.23
(73.60%)
📈 view plot
🚷 view threshold
91.00
(-0.62%)
88.35
(97.08%)
94.79
(96.00%)
get_submit📈 view plot
🚷 view threshold
95,256.00
(-0.17%)
95,216.89
(99.96%)
95,611.11
(99.63%)
📈 view plot
🚨 view alert
🚷 view threshold
59,263.00
(-0.36%)
59,287.09
(100.04%)
59,672.17
(99.31%)
📈 view plot
🚨 view alert
🚷 view threshold
85,076.00
(-0.42%)
85,116.99
(100.05%)
85,757.01
(99.21%)
📈 view plot
🚷 view threshold
48.00
(+6.19%)
38.34
(79.88%)
52.06
(92.20%)
📈 view plot
🚨 view alert
🚷 view threshold
284.00
(+1.94%)
273.37
(96.26%)
283.83
(100.06%)
get_subscribe📈 view plot
🚷 view threshold
7,905.00
(-1.83%)
7,900.05
(99.94%)
8,204.55
(96.35%)
📈 view plot
🚨 view alert
🚷 view threshold
2,758.00
(-2.90%)
2,776.43
(100.67%)
2,904.11
(94.97%)
📈 view plot
🚨 view alert
🚷 view threshold
3,830.00
(-3.51%)
3,861.53
(100.82%)
4,076.74
(93.95%)
📈 view plot
🚨 view alert
🚷 view threshold
17.00
(+40.50%)
7.20
(42.37%)
17.00
(100.02%)
📈 view plot
🚷 view threshold
114.00
(-0.81%)
112.17
(98.39%)
117.70
(96.86%)
serialize_authorize📈 view plot
🚨 view alert
🚷 view threshold
12,109.00
(-1.60%)
12,114.11
(100.04%)
12,498.49
(96.88%)
📈 view plot
🚨 view alert
🚷 view threshold
5,240.00
(-1.68%)
5,254.71
(100.28%)
5,404.36
(96.96%)
📈 view plot
🚨 view alert
🚷 view threshold
7,279.00
(-2.07%)
7,304.62
(100.35%)
7,560.98
(96.27%)
📈 view plot
🚷 view threshold
14.00
(+48.94%)
3.52
(25.13%)
15.28
(91.61%)
📈 view plot
🚷 view threshold
136.00
(-1.38%)
134.46
(98.86%)
141.34
(96.22%)
serialize_deserialize_authorize📈 view plot
🚨 view alert
🚷 view threshold
24,482.00
(-1.42%)
24,486.25
(100.02%)
25,185.08
(97.21%)
📈 view plot
🚨 view alert
🚷 view threshold
9,786.00
(-1.13%)
9,794.58
(100.09%)
10,000.15
(97.86%)
📈 view plot
🚨 view alert
🚷 view threshold
13,787.00
(-1.36%)
13,801.81
(100.11%)
14,151.86
(97.42%)
📈 view plot
🚷 view threshold
39.00
(+11.75%)
27.90
(71.53%)
41.90
(93.07%)
📈 view plot
🚷 view threshold
300.00
(-1.73%)
299.41
(99.80%)
311.13
(96.42%)
serialize_deserialize_handle_authorize📈 view plot
🚨 view alert
🚷 view threshold
30,197.00
(-0.74%)
30,217.64
(100.07%)
30,629.29
(98.59%)
📈 view plot
🚨 view alert
🚷 view threshold
11,989.00
(-0.78%)
12,004.94
(100.13%)
12,161.13
(98.58%)
📈 view plot
🚨 view alert
🚷 view threshold
16,952.00
(-0.95%)
16,978.38
(100.16%)
17,250.89
(98.27%)
📈 view plot
🚷 view threshold
59.00
(+7.34%)
49.59
(84.05%)
60.34
(97.78%)
📈 view plot
🚷 view threshold
370.00
(-0.64%)
368.40
(99.57%)
376.40
(98.30%)
serialize_deserialize_handle_submit📈 view plot
🚨 view alert
🚷 view threshold
126,166.00
(-0.26%)
126,208.33
(100.03%)
126,788.61
(99.51%)
📈 view plot
🚨 view alert
🚷 view threshold
73,117.00
(-0.28%)
73,132.73
(100.02%)
73,505.33
(99.47%)
📈 view plot
🚨 view alert
🚷 view threshold
104,766.00
(-0.34%)
104,796.22
(100.03%)
105,444.05
(99.36%)
📈 view plot
🚷 view threshold
115.00
(+6.15%)
98.44
(85.60%)
118.23
(97.27%)
📈 view plot
🚷 view threshold
595.00
(-0.06%)
588.84
(98.96%)
601.83
(98.87%)
serialize_deserialize_handle_subscribe📈 view plot
🚨 view alert
🚷 view threshold
27,753.00
(-0.87%)
27,789.68
(100.13%)
28,204.05
(98.40%)
📈 view plot
🚨 view alert
🚷 view threshold
9,577.00
(-0.84%)
9,595.22
(100.19%)
9,721.51
(98.51%)
📈 view plot
🚨 view alert
🚷 view threshold
13,523.00
(-1.02%)
13,551.44
(100.21%)
13,772.29
(98.19%)
📈 view plot
🚷 view threshold
67.00
(+7.49%)
55.45
(82.76%)
69.22
(96.79%)
📈 view plot
🚷 view threshold
397.00
(-0.92%)
396.39
(99.85%)
404.95
(98.04%)
serialize_deserialize_submit📈 view plot
🚨 view alert
🚷 view threshold
114,821.00
(-0.46%)
114,859.71
(100.03%)
115,834.43
(99.13%)
📈 view plot
🚷 view threshold
67,894.00
(-0.38%)
67,880.29
(99.98%)
68,422.44
(99.23%)
📈 view plot
🚷 view threshold
97,371.00
(-0.45%)
97,349.82
(99.98%)
98,275.64
(99.08%)
📈 view plot
🚷 view threshold
67.00
(+4.25%)
57.25
(85.44%)
71.29
(93.99%)
📈 view plot
🚷 view threshold
489.00
(-0.57%)
487.42
(99.68%)
496.18
(98.55%)
serialize_deserialize_subscribe📈 view plot
🚨 view alert
🚷 view threshold
23,082.00
(-1.41%)
23,114.66
(100.14%)
23,708.41
(97.36%)
📈 view plot
🚨 view alert
🚷 view threshold
8,129.00
(-1.05%)
8,146.83
(100.22%)
8,283.24
(98.14%)
📈 view plot
🚨 view alert
🚷 view threshold
11,427.00
(-1.26%)
11,456.74
(100.26%)
11,688.32
(97.76%)
📈 view plot
🚷 view threshold
42.00
(+13.41%)
30.54
(72.70%)
43.53
(96.48%)
📈 view plot
🚷 view threshold
327.00
(-1.79%)
326.69
(99.91%)
339.24
(96.39%)
serialize_submit📈 view plot
🚷 view threshold
99,573.00
(-0.24%)
99,569.35
(100.00%)
100,058.38
(99.51%)
📈 view plot
🚨 view alert
🚷 view threshold
61,325.00
(-0.33%)
61,344.53
(100.03%)
61,706.33
(99.38%)
📈 view plot
🚨 view alert
🚷 view threshold
87,938.00
(-0.39%)
87,973.65
(100.04%)
88,589.42
(99.26%)
📈 view plot
🚷 view threshold
52.00
(+9.86%)
40.57
(78.01%)
54.10
(96.12%)
📈 view plot
🚷 view threshold
325.00
(+0.70%)
317.57
(97.71%)
327.90
(99.12%)
serialize_subscribe📈 view plot
🚷 view threshold
11,240.00
(-1.39%)
11,226.49
(99.88%)
11,570.25
(97.15%)
📈 view plot
🚨 view alert
🚷 view threshold
4,111.00
(-1.84%)
4,128.16
(100.42%)
4,247.57
(96.78%)
📈 view plot
🚨 view alert
🚷 view threshold
5,695.00
(-2.28%)
5,724.66
(100.52%)
5,931.08
(96.02%)
📈 view plot
🚷 view threshold
17.00
(+35.64%)
7.75
(45.56%)
17.32
(98.14%)
📈 view plot
🚷 view threshold
156.00
(-0.87%)
153.63
(98.48%)
161.10
(96.83%)
🐰 View full continuous benchmarking report in Bencher

Copy link
Contributor

github-actions bot commented Oct 19, 2024

🐰 Bencher Report

Branch1046/merge
Testbedsv2
🚨 1 ALERT: Threshold Boundary Limit exceeded!
BenchmarkMeasure
Units
ViewBenchmark Result
(Result Δ%)
Lower Boundary
(Limit %)
Upper Boundary
(Limit %)
client_sv2_setup_connection_serialize_deserializeLatency
nanoseconds (ns)
📈 plot
🚨 alert
🚷 threshold
1,069.20
(+8.55%)
910.70
(85.18%)
1,059.34
(100.93%)
Click to view all benchmark results
BenchmarkLatencyBenchmark Result
nanoseconds (ns)
(Result Δ%)
Lower Boundary
nanoseconds (ns)
(Limit %)
Upper Boundary
nanoseconds (ns)
(Limit %)
client_sv2_handle_message_common📈 view plot
🚷 view threshold
45.32
(+1.58%)
43.54
(96.08%)
45.69
(99.20%)
client_sv2_handle_message_mining📈 view plot
🚷 view threshold
75.30
(-2.97%)
63.79
(84.72%)
91.42
(82.36%)
client_sv2_mining_message_submit_standard📈 view plot
🚷 view threshold
14.82
(+0.76%)
14.42
(97.31%)
15.00
(98.83%)
client_sv2_mining_message_submit_standard_serialize📈 view plot
🚷 view threshold
265.92
(-0.17%)
252.62
(95.00%)
280.15
(94.92%)
client_sv2_mining_message_submit_standard_serialize_deserialize📈 view plot
🚷 view threshold
579.59
(-2.49%)
556.35
(95.99%)
632.41
(91.65%)
client_sv2_open_channel📈 view plot
🚷 view threshold
145.58
(-10.29%)
142.71
(98.03%)
181.85
(80.06%)
client_sv2_open_channel_serialize📈 view plot
🚷 view threshold
288.06
(+4.43%)
256.34
(88.99%)
295.32
(97.54%)
client_sv2_open_channel_serialize_deserialize📈 view plot
🚷 view threshold
369.35
(-2.14%)
356.41
(96.50%)
398.45
(92.70%)
client_sv2_setup_connection📈 view plot
🚷 view threshold
162.48
(+0.64%)
152.38
(93.78%)
170.52
(95.28%)
client_sv2_setup_connection_serialize📈 view plot
🚷 view threshold
464.90
(+3.10%)
406.33
(87.40%)
495.55
(93.81%)
client_sv2_setup_connection_serialize_deserialize📈 view plot
🚨 view alert
🚷 view threshold
1,069.20
(+8.55%)
910.70
(85.18%)
1,059.34
(100.93%)
🐰 View full continuous benchmarking report in Bencher

Copy link

codecov bot commented Oct 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 19.36%. Comparing base (73f51db) to head (f0494c1).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1046   +/-   ##
=======================================
  Coverage   19.36%   19.36%           
=======================================
  Files         164      164           
  Lines       10811    10811           
=======================================
  Hits         2094     2094           
  Misses       8717     8717           
Flag Coverage Δ
binary_codec_sv2-coverage 0.00% <ø> (ø)
binary_serde_sv2-coverage 3.65% <ø> (ø)
binary_sv2-coverage 5.48% <ø> (+0.01%) ⬆️
bip32_derivation-coverage 0.00% <ø> (ø)
buffer_sv2-coverage 25.02% <ø> (ø)
codec_sv2-coverage 0.01% <ø> (ø)
common_messages_sv2-coverage 0.13% <ø> (ø)
const_sv2-coverage 0.00% <ø> (ø)
error_handling-coverage 0.00% <ø> (ø)
framing_sv2-coverage 0.29% <ø> (ø)
jd_client-coverage 0.00% <ø> (ø)
jd_server-coverage 8.13% <ø> (ø)
job_declaration_sv2-coverage 0.00% <ø> (ø)
key-utils-coverage 2.39% <ø> (ø)
mining-coverage 2.51% <ø> (ø)
mining_device-coverage 0.00% <ø> (ø)
mining_proxy_sv2-coverage 0.70% <ø> (ø)
noise_sv2-coverage 4.35% <ø> (ø)
pool_sv2-coverage 1.38% <ø> (ø)
protocols 24.72% <ø> (ø)
roles 6.63% <ø> (ø)
roles_logic_sv2-coverage 8.08% <ø> (+0.01%) ⬆️
sv1-mining-device-coverage 0.00% <ø> (ø)
sv2_ffi-coverage 0.00% <ø> (ø)
template_distribution_sv2-coverage 0.00% <ø> (ø)
translator_sv2-coverage 9.61% <ø> (ø)
utils ?
v1-coverage 2.47% <ø> (ø)

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.

Takes specific of bytes, types and sizes from the specification.
Lists some use cases for this struct.

Work toward: stratum-mining#1011

fix: cargo fmt for docstrings
@rrybarczyk
Copy link
Collaborator

@Shourya742 will cherry pick these commits into their #1231 PR.

@rrybarczyk rrybarczyk closed this Oct 30, 2024
@average-gary average-gary deleted the docstring-sequences branch October 30, 2024 15:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation protocols Lowest level protocol logic
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants