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.

Sign up for GitHub

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

Jump to bottom

Job Declaration Documentation #1265

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Job Declaration Documentation #1265

wants to merge 3 commits into from
+159 −36

Conversation

jbesraa
Copy link
Contributor

@jbesraa jbesraa commented Nov 25, 2024

resolves #1204

@codecov Codecov
Copy link

codecov bot commented Nov 25, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 19.30%. Comparing base (67a3f00) to head (a08eceb).

Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #1265   +/-   ##
=======================================
  Coverage   19.30%   19.30%           
=======================================
  Files         164      164           
  Lines       10849    10849           
=======================================
  Hits         2094     2094           
  Misses       8755     8755
Flag Coverage Δ
binary_codec_sv2-coverage 0.00% <ø> (ø)
binary_serde_sv2-coverage 3.65% <ø> (ø)
binary_sv2-coverage 5.46% <ø> (ø)
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 7.79% <ø> (ø)
job_declaration_sv2-coverage 0.00% <ø> (ø)
key-utils-coverage 2.39% <ø> (ø)
mining-coverage 2.49% <ø> (ø)
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.55% <ø> (ø)
roles_logic_sv2-coverage 8.06% <ø> (ø)
sv2_ffi-coverage 0.00% <ø> (ø)
template_distribution_sv2-coverage 0.00% <ø> (ø)
translator_sv2-coverage 9.60% <ø> (ø)
utils 25.13% <ø> (ø)
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.

@jbesraa jbesraa force-pushed the 2024-11-08-job-declaration-msgs-docs branch 2 times, most recently from cd5afef to 36c6fd4 Compare November 28, 2024 16:50
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 28, 2024 •
edited
Loading

🐰 Bencher Report

Branch2024-11-08-job-declaration-msgs-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,532.80
(-2.91%)		7,212.40
(90.58%)
client-submit-serialize-deserialize📈 view plot
🚷 view threshold		7,463.80
(-2.46%)		8,038.92
(92.85%)
client-submit-serialize-deserialize-handle/client-submit-serialize-deserialize-handle📈 view plot
🚷 view threshold		8,048.10
(-2.01%)		8,603.87
(93.54%)
client-sv1-authorize-serialize-deserialize-handle/client-sv1-authorize-serialize-deserialize-handle📈 view plot
🚷 view threshold		852.16
(-2.18%)		946.85
(90.00%)
client-sv1-authorize-serialize-deserialize/client-sv1-authorize-serialize-deserialize📈 view plot
🚷 view threshold		671.11
(-0.17%)		711.70
(94.30%)
client-sv1-authorize-serialize/client-sv1-authorize-serialize📈 view plot
🚷 view threshold		245.71
(-1.07%)		262.33
(93.66%)
client-sv1-get-authorize/client-sv1-get-authorize📈 view plot
🚷 view threshold		156.06
(-0.80%)		163.83
(95.26%)
client-sv1-get-submit📈 view plot
🚷 view threshold		6,557.10
(-0.04%)		7,210.89
(90.93%)
client-sv1-get-subscribe/client-sv1-get-subscribe📈 view plot
🚷 view threshold		283.04
(+0.74%)		311.77
(90.79%)
client-sv1-subscribe-serialize-deserialize-handle/client-sv1-subscribe-serialize-deserialize-handle📈 view plot
🚷 view threshold		752.86
(+2.43%)		801.32
(93.95%)
client-sv1-subscribe-serialize-deserialize/client-sv1-subscribe-serialize-deserialize📈 view plot
🚷 view threshold		583.21
(-2.11%)		644.59
(90.48%)
client-sv1-subscribe-serialize/client-sv1-subscribe-serialize📈 view plot
🚷 view threshold		206.24
(-0.07%)		220.81
(93.40%)
🐰 View full continuous benchmarking report in Bencher

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 28, 2024 •
edited
Loading

🐰 Bencher Report

Branch2024-11-08-job-declaration-msgs-docs
Testbedsv2

🚨 2 Alerts

BenchmarkMeasure
Units		ViewBenchmark Result
(Result Δ%)		Upper Boundary
(Limit %)
client_sv2_handle_message_miningRAM Accesses
accesses		📈 plot
🚨 alert (🔔)
🚷 threshold		141.00
(+1.44%)		140.89
(100.08%)
client_sv2_mining_message_submit_standard_serialize_deserializeL2 Accesses
accesses		📈 plot
🚨 alert (🔔)
🚷 threshold		91.00
(+11.89%)		89.75
(101.39%)
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,133.00
(+1.80%)		2,209.05
(96.56%)		📈 view plot
🚷 view threshold		473.00
(-0.07%)		488.51
(96.82%)		📈 view plot
🚷 view threshold		733.00
(-0.40%)		757.25
(96.80%)		📈 view plot
🚷 view threshold		7.00
(+31.57%)		13.64
(51.32%)		📈 view plot
🚷 view threshold		39.00
(+2.42%)		41.22
(94.60%)
client_sv2_handle_message_mining📈 view plot
🚷 view threshold		8,280.00
(+0.94%)		8,283.93
(99.95%)		📈 view plot
🚷 view threshold		2,137.00
(-0.03%)		2,143.08
(99.72%)		📈 view plot
🚷 view threshold		3,155.00
(-0.18%)		3,170.63
(99.51%)		📈 view plot
🚷 view threshold		38.00
(+7.11%)		41.84
(90.83%)		📈 view plot
🚨 view alert (🔔)
🚷 view threshold		141.00
(+1.44%)		140.89
(100.08%)
client_sv2_mining_message_submit_standard📈 view plot
🚷 view threshold		6,323.00
(+0.68%)		6,396.40
(98.85%)		📈 view plot
🚷 view threshold		1,750.00
(-0.05%)		1,766.87
(99.05%)		📈 view plot
🚷 view threshold		2,548.00
(-0.22%)		2,575.62
(98.93%)		📈 view plot
🚷 view threshold		20.00
(+18.57%)		24.25
(82.47%)		📈 view plot
🚷 view threshold		105.00
(+0.89%)		107.28
(97.88%)
client_sv2_mining_message_submit_standard_serialize📈 view plot
🚷 view threshold		14,748.00
(+0.14%)		14,948.31
(98.66%)		📈 view plot
🚷 view threshold		4,694.00
(-0.02%)		4,710.87
(99.64%)		📈 view plot
🚷 view threshold		6,748.00
(-0.16%)		6,781.83
(99.50%)		📈 view plot
🚷 view threshold		53.00
(+22.12%)		53.02
(99.96%)		📈 view plot
🚷 view threshold		221.00
(-0.21%)		227.32
(97.22%)
client_sv2_mining_message_submit_standard_serialize_deserialize📈 view plot
🚷 view threshold		27,720.00
(+0.66%)		27,822.49
(99.63%)		📈 view plot
🚷 view threshold		10,645.00
(+0.57%)		10,656.37
(99.89%)		📈 view plot
🚷 view threshold		15,505.00
(+0.67%)		15,519.23
(99.91%)		📈 view plot
🚨 view alert (🔔)
🚷 view threshold		91.00
(+11.89%)		89.75
(101.39%)		📈 view plot
🚷 view threshold		336.00
(+0.28%)		341.69
(98.34%)
client_sv2_open_channel📈 view plot
🚷 view threshold		4,477.00
(+1.90%)		4,592.73
(97.48%)		📈 view plot
🚷 view threshold		1,461.00
(-0.02%)		1,476.51
(98.95%)		📈 view plot
🚷 view threshold		2,157.00
(-0.14%)		2,184.11
(98.76%)		📈 view plot
🚷 view threshold		9.00
(+2.58%)		16.89
(53.29%)		📈 view plot
🚷 view threshold		65.00
(+3.90%)		67.92
(95.70%)
client_sv2_open_channel_serialize📈 view plot
🚷 view threshold		14,066.00
(+0.12%)		14,390.00
(97.75%)		📈 view plot
🚷 view threshold		5,064.00
(-0.01%)		5,079.51
(99.69%)		📈 view plot
🚷 view threshold		7,321.00
(-0.07%)		7,351.46
(99.59%)		📈 view plot
🚷 view threshold		40.00
(+14.21%)		43.05
(92.91%)		📈 view plot
🚷 view threshold		187.00
(-0.04%)		196.93
(94.96%)
client_sv2_open_channel_serialize_deserialize📈 view plot
🚷 view threshold		22,808.00
(+0.64%)		22,911.17
(99.55%)		📈 view plot
🚷 view threshold		8,040.00
(+0.22%)		8,072.97
(99.59%)		📈 view plot
🚷 view threshold		11,693.00
(+0.19%)		11,749.99
(99.52%)		📈 view plot
🚷 view threshold		81.00
(+8.93%)		85.12
(95.16%)		📈 view plot
🚷 view threshold		306.00
(+0.84%)		311.08
(98.37%)
client_sv2_setup_connection📈 view plot
🚷 view threshold		4,707.00
(+0.47%)		4,775.18
(98.57%)		📈 view plot
🚷 view threshold		1,502.00
(-0.02%)		1,517.51
(98.98%)		📈 view plot
🚷 view threshold		2,277.00
(-0.06%)		2,299.21
(99.03%)		📈 view plot
🚷 view threshold		10.00
(+4.75%)		16.60
(60.24%)		📈 view plot
🚷 view threshold		68.00
(+0.90%)		69.80
(97.42%)
client_sv2_setup_connection_serialize📈 view plot
🚷 view threshold		16,202.00
(+0.22%)		16,437.73
(98.57%)		📈 view plot
🚷 view threshold		5,963.00
(-0.01%)		5,978.51
(99.74%)		📈 view plot
🚷 view threshold		8,657.00
(-0.08%)		8,691.26
(99.61%)		📈 view plot
🚷 view threshold		46.00
(+15.70%)		52.67
(87.33%)		📈 view plot
🚷 view threshold		209.00
(+0.15%)		215.77
(96.86%)
client_sv2_setup_connection_serialize_deserialize📈 view plot
🚷 view threshold		35,706.00
(+0.43%)		35,768.24
(99.83%)		📈 view plot
🚷 view threshold		14,888.00
(+0.25%)		14,910.16
(99.85%)		📈 view plot
🚷 view threshold		21,871.00
(+0.24%)		21,923.18
(99.76%)		📈 view plot
🚷 view threshold		107.00
(+16.09%)		111.32
(96.12%)		📈 view plot
🚷 view threshold		380.00
(+0.19%)		384.68
(98.78%)
🐰 View full continuous benchmarking report in Bencher

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 28, 2024 •
edited
Loading

🐰 Bencher Report

Branch2024-11-08-job-declaration-msgs-docs
Testbedsv1

🚨 2 Alerts

BenchmarkMeasure
Units		ViewBenchmark Result
(Result Δ%)		Upper Boundary
(Limit %)
serialize_deserialize_handle_submitRAM Accesses
accesses		📈 plot
🚨 alert (🔔)
🚷 threshold		606.00
(+1.60%)		605.61
(100.06%)
serialize_deserialize_submitRAM Accesses
accesses		📈 plot
🚨 alert (🔔)
🚷 threshold		501.00
(+1.96%)		498.95
(100.41%)
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,410.00
(-0.66%)		8,731.22
(96.32%)		📈 view plot
🚷 view threshold		3,663.00
(-2.30%)		3,857.34
(94.96%)		📈 view plot
🚷 view threshold		5,110.00
(-2.78%)		5,426.74
(94.16%)		📈 view plot
🚷 view threshold		9.00
(+24.27%)		13.22
(68.07%)		📈 view plot
🚷 view threshold		93.00
(+2.58%)		95.20
(97.69%)
get_submit📈 view plot
🚷 view threshold		95,332.00
(-0.11%)		95,892.74
(99.42%)		📈 view plot
🚷 view threshold		59,263.00
(-0.33%)		59,685.04
(99.29%)		📈 view plot
🚷 view threshold		85,072.00
(-0.39%)		85,762.87
(99.19%)		📈 view plot
🚷 view threshold		50.00
(+11.67%)		63.38
(78.89%)		📈 view plot
🚷 view threshold		286.00
(+2.07%)		289.39
(98.83%)
get_subscribe📈 view plot
🚷 view threshold		7,927.00
(-1.19%)		8,275.84
(95.78%)		📈 view plot
🚷 view threshold		2,758.00
(-2.71%)		2,937.77
(93.88%)		📈 view plot
🚷 view threshold		3,832.00
(-3.27%)		4,120.52
(93.00%)		📈 view plot
🚷 view threshold		14.00
(+17.05%)		20.62
(67.91%)		📈 view plot
🚷 view threshold		115.00
(+0.59%)		118.50
(97.04%)
serialize_authorize📈 view plot
🚷 view threshold		12,199.00
(-0.68%)		12,565.56
(97.08%)		📈 view plot
🚷 view threshold		5,240.00
(-1.52%)		5,424.78
(96.59%)		📈 view plot
🚷 view threshold		7,279.00
(-1.89%)		7,584.89
(95.97%)		📈 view plot
🚷 view threshold		11.00
(+20.24%)		16.30
(67.47%)		📈 view plot
🚷 view threshold		139.00
(+0.98%)		142.59
(97.48%)
serialize_deserialize_authorize📈 view plot
🚷 view threshold		24,708.00
(+0.06%)		25,225.62
(97.95%)		📈 view plot
🚷 view threshold		9,786.00
(-1.06%)		10,033.67
(97.53%)		📈 view plot
🚷 view threshold		13,783.00
(-1.29%)		14,186.39
(97.16%)		📈 view plot
🚷 view threshold		36.00
(+3.90%)		43.59
(82.59%)		📈 view plot
🚷 view threshold		307.00
(+1.79%)		315.16
(97.41%)
serialize_deserialize_handle_authorize📈 view plot
🚷 view threshold		30,303.00
(-0.08%)		30,749.11
(98.55%)		📈 view plot
🚷 view threshold		11,989.00
(-0.77%)		12,202.89
(98.25%)		📈 view plot
🚷 view threshold		16,948.00
(-0.94%)		17,292.62
(98.01%)		📈 view plot
🚷 view threshold		60.00
(+7.99%)		67.42
(88.99%)		📈 view plot
🚷 view threshold		373.00
(+0.89%)		381.59
(97.75%)
serialize_deserialize_handle_submit📈 view plot
🚷 view threshold		126,528.00
(+0.04%)		126,896.12
(99.71%)		📈 view plot
🚷 view threshold		73,117.00
(-0.23%)		73,510.81
(99.46%)		📈 view plot
🚷 view threshold		104,758.00
(-0.29%)		105,437.98
(99.36%)		📈 view plot
🚷 view threshold		112.00
(+4.73%)		132.58
(84.48%)		📈 view plot
🚨 view alert (🔔)
🚷 view threshold		606.00
(+1.60%)		605.61
(100.06%)
serialize_deserialize_handle_subscribe📈 view plot
🚷 view threshold		27,931.00
(+0.31%)		28,599.67
(97.66%)		📈 view plot
🚷 view threshold		9,577.00
(-0.75%)		9,751.62
(98.21%)		📈 view plot
🚷 view threshold		13,516.00
(-0.96%)		13,806.49
(97.90%)		📈 view plot
🚷 view threshold		69.00
(+8.66%)		76.06
(90.72%)		📈 view plot
🚷 view threshold		402.00
(+1.38%)		416.75
(96.46%)
serialize_deserialize_submit📈 view plot
🚷 view threshold		115,245.00
(-0.00%)		115,799.51
(99.52%)		📈 view plot
🚷 view threshold		67,894.00
(-0.31%)		68,396.31
(99.27%)		📈 view plot
🚷 view threshold		97,355.00
(-0.39%)		98,225.63
(99.11%)		📈 view plot
🚷 view threshold		71.00
(+13.19%)		78.31
(90.67%)		📈 view plot
🚨 view alert (🔔)
🚷 view threshold		501.00
(+1.96%)		498.95
(100.41%)
serialize_deserialize_subscribe📈 view plot
🚷 view threshold		23,312.00
(+0.21%)		23,986.58
(97.19%)		📈 view plot
🚷 view threshold		8,129.00
(-0.92%)		8,307.32
(97.85%)		📈 view plot
🚷 view threshold		11,422.00
(-1.16%)		11,712.77
(97.52%)		📈 view plot
🚷 view threshold		40.00
(+7.36%)		44.46
(89.97%)		📈 view plot
🚷 view threshold		334.00
(+1.46%)		347.73
(96.05%)
serialize_submit📈 view plot
🚷 view threshold		99,781.00
(-0.07%)		100,300.88
(99.48%)		📈 view plot
🚷 view threshold		61,325.00
(-0.29%)		61,718.15
(99.36%)		📈 view plot
🚷 view threshold		87,931.00
(-0.36%)		88,596.53
(99.25%)		📈 view plot
🚷 view threshold		53.00
(+13.44%)		64.32
(82.40%)		📈 view plot
🚷 view threshold		331.00
(+1.91%)		333.93
(99.12%)
serialize_subscribe📈 view plot
🚷 view threshold		11,410.00
(+0.04%)		11,676.78
(97.72%)		📈 view plot
🚷 view threshold		4,111.00
(-1.71%)		4,280.97
(96.03%)		📈 view plot
🚷 view threshold		5,690.00
(-2.21%)		5,973.52
(95.25%)		📈 view plot
🚷 view threshold		17.00
(+31.96%)		20.84
(81.59%)		📈 view plot
🚷 view threshold		161.00
(+2.05%)		163.23
(98.64%)
🐰 View full continuous benchmarking report in Bencher

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 28, 2024 •
edited
Loading

🐰 Bencher Report

Branch2024-11-08-job-declaration-msgs-docs
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.12
(-0.96%)		46.98
(93.91%)
client_sv2_handle_message_mining📈 view plot
🚷 view threshold		76.10
(+1.94%)		80.87
(94.10%)
client_sv2_mining_message_submit_standard📈 view plot
🚷 view threshold		14.65
(-0.08%)		14.82
(98.87%)
client_sv2_mining_message_submit_standard_serialize📈 view plot
🚷 view threshold		266.98
(+0.58%)		319.41
(83.58%)
client_sv2_mining_message_submit_standard_serialize_deserialize📈 view plot
🚷 view threshold		621.93
(+1.24%)		717.28
(86.71%)
client_sv2_open_channel📈 view plot
🚷 view threshold		165.03
(+7.85%)		195.27
(84.52%)
client_sv2_open_channel_serialize📈 view plot
🚷 view threshold		277.86
(-2.50%)		316.72
(87.73%)
client_sv2_open_channel_serialize_deserialize📈 view plot
🚷 view threshold		383.40
(+0.96%)		407.23
(94.15%)
client_sv2_setup_connection📈 view plot
🚷 view threshold		160.72
(-0.03%)		171.71
(93.60%)
client_sv2_setup_connection_serialize📈 view plot
🚷 view threshold		460.30
(-1.40%)		538.27
(85.51%)
client_sv2_setup_connection_serialize_deserialize📈 view plot
🚷 view threshold		1,059.70
(+7.75%)		1,129.15
(93.85%)
🐰 View full continuous benchmarking report in Bencher

@jbesraa jbesraa force-pushed the 2024-11-08-job-declaration-msgs-docs branch 2 times, most recently from f964a23 to 0ec765a Compare December 2, 2024 09:03
@jbesraa jbesraa force-pushed the 2024-11-08-job-declaration-msgs-docs branch from 0ec765a to a08eceb Compare December 2, 2024 09:08
@jbesraa jbesraa marked this pull request as ready for review December 2, 2024 09:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Need Rust docs on protocols::v2::subprotocols::job-declaration
1 participant
@jbesraa