docs for job_creator module

plebhash · plebhash · commit 573c62623f46 · 2024-12-11T20:25:24.000+07:00
diff --git a/protocols/v2/roles-logic-sv2/src/job_creator.rs b/protocols/v2/roles-logic-sv2/src/job_creator.rs
@@ -49,6 +49,7 @@ pub fn tx_outputs_to_costum_scripts(tx_outputs: &[u8]) -> Vec<TxOut> {
 }
 
 impl JobsCreators {
+    /// constructor
     pub fn new(extranonce_len: u8) -> Self {
         Self {
             lasts_new_template: Vec::new(),
@@ -60,6 +61,7 @@ impl JobsCreators {
         }
     }
 
+    /// get template id from job
     pub fn get_template_id_from_job(&self, job_id: u32) -> Option<u64> {
         self.job_to_template_id.get(&job_id).map(|x| x - 1)
     }
@@ -135,6 +137,7 @@ impl JobsCreators {
     }
 }
 
+/// convert custom job into extended job
 pub fn extended_job_from_custom_job(
     referenced_job: &mining_sv2::SetCustomMiningJob,
     pool_signature: String,

Original file line number	Diff line number	Diff line change
`@@ -49,6 +49,7 @@ pub fn tx_outputs_to_costum_scripts(tx_outputs: &[u8]) -> Vec<TxOut> {`
`49`	`49`	`}`
`50`	`50`
`51`	`51`	`impl JobsCreators {`
	`52`	`+ /// constructor`
`52`	`53`	`pub fn new(extranonce_len: u8) -> Self {`
`53`	`54`	`Self {`
`54`	`55`	`lasts_new_template: Vec::new(),`
`@@ -60,6 +61,7 @@ impl JobsCreators {`
`60`	`61`	`}`
`61`	`62`	`}`
`62`	`63`
	`64`	`+ /// get template id from job`
`63`	`65`	`pub fn get_template_id_from_job(&self, job_id: u32) -> Option<u64> {`
`64`	`66`	`self.job_to_template_id.get(&job_id).map(\|x\| x - 1)`
`65`	`67`	`}`
`@@ -135,6 +137,7 @@ impl JobsCreators {`
`135`	`137`	`}`
`136`	`138`	`}`
`137`	`139`
	`140`	`+/// convert custom job into extended job`
`138`	`141`	`pub fn extended_job_from_custom_job(`
`139`	`142`	`referenced_job: &mining_sv2::SetCustomMiningJob,`
`140`	`143`	`pool_signature: String,`