Add nits

stratum-mining · Jul 14, 2024 · 2aa46d4 · 2aa46d4
1 parent 8d10d6d
commit 2aa46d4
Show file tree

Hide file tree

Showing 11 changed files with 88 additions and 64 deletions.
diff --git a/.github/workflows/coverage.yaml b/.github/workflows/coverage.yaml
@@ -123,6 +123,9 @@ jobs:
 
       - name: Run translation-proxy-old-share
         run: sh ./test/message-generator/test/translation-proxy-old-share/translation-proxy-old-share.sh
+
+      - name: Run jds-setup-connection-flag-test
+        run: sh ./test/message-generator/test/jds-setup-connection-flag-test/jds-setup-connection-flag-test.sh
 
       - name: Coverage report
         run: sh ./scripts/code-coverage-report.sh

diff --git a/benches/Cargo.lock b/benches/Cargo.lock
diff --git a/protocols/Cargo.lock b/protocols/Cargo.lock
diff --git a/protocols/v2/subprotocols/common-messages/src/setup_connection.rs b/protocols/v2/subprotocols/common-messages/src/setup_connection.rs
@@ -406,11 +406,11 @@ mod test {
     #[test]
     fn test_check_flag() {
         let protocol = crate::Protocol::MiningProtocol;
-        let flag_avaiable = 0b_0000_0000_0000_0000_0000_0000_0000_0000;
+        let flag_available = 0b_0000_0000_0000_0000_0000_0000_0000_0000;
         let flag_required = 0b_0000_0000_0000_0000_0000_0000_0000_0001;
         assert!(SetupConnection::check_flags(
             protocol,
-            flag_avaiable,
+            flag_available,
             flag_required
         ));
 

diff --git a/roles/Cargo.lock b/roles/Cargo.lock
diff --git a/roles/jd-server/src/lib/job_declarator/mod.rs b/roles/jd-server/src/lib/job_declarator/mod.rs
@@ -453,16 +453,15 @@ impl JobDeclarator {
             if let Ok((receiver, sender, _, _)) =
                 Connection::new(stream, HandshakeRole::Responder(responder)).await
             {
-                let address = addr.unwrap();
                 let mut incoming = match receiver.recv().await {
                     Ok(EitherFrame::Sv2(s)) => {
                         debug!("Got sv2 message: {:?}", s);
                         s
                     }
                     Ok(EitherFrame::HandShake(s)) => {
                         error!(
-                            "Got unexpected handshake message from upstream: {:?} at {}",
-                            s, address
+                            "Received unexpected handshake message from upstream: {:?} at {:?}",
+                            s, addr
                         );
                         continue;
                     }
@@ -473,56 +472,58 @@ impl JobDeclarator {
                 };
 
                 let payload = incoming.payload();
-                let flag = payload[5] as u32;
 
-                let is_valid =
-                    SetupConnection::check_flags(Protocol::JobDeclarationProtocol, flag, 1);
+                if let Ok(value) = binary_sv2::from_bytes::<SetupConnection>(payload) {
+                    let flag = value.flags;
+                    let is_valid =
+                        SetupConnection::check_flags(Protocol::JobDeclarationProtocol, flag, 1);
 
-                let sv2_frame: StdFrame = if is_valid {
-                    let success_message = SetupConnectionSuccess {
-                        used_version: 2,
-                        flags: 0b_0000_0000_0000_0000_0000_0000_0000_0001,
-                    };
-                    info!("Sending success message for proxy");
-                    JdsMessages::Common(success_message.into())
-                        .try_into()
-                        .unwrap()
-                } else {
-                    let error_message = SetupConnectionError {
-                        flags: flag,
-                        error_code: "unsupported-feature-flags"
-                            .to_string()
-                            .into_bytes()
+                    let sv2_frame: StdFrame = if is_valid {
+                        let success_message = SetupConnectionSuccess {
+                            used_version: 2,
+                            flags: 0b_0000_0000_0000_0000_0000_0000_0000_0001,
+                        };
+                        info!("Sending success message for proxy");
+                        JdsMessages::Common(success_message.into())
                             .try_into()
-                            .unwrap(),
+                            .expect(
+                            "Failed to convert setup connection response message to standard frame",
+                        )
+                    } else {
+                        let error_message = SetupConnectionError {
+                            flags: flag,
+                            error_code: "unsupported-feature-flags"
+                                .to_string()
+                                .into_bytes()
+                                .try_into()
+                                .unwrap(),
+                        };
+                        info!("Sending error message for proxy");
+                        JdsMessages::Common(error_message.into()).try_into().expect(
+                            "Failed to convert setup connection response message to standard frame",
+                        )
                     };
-                    info!("Sending error message for proxy");
-                    JdsMessages::Common(error_message.into())
-                        .try_into()
-                        .unwrap()
-                };
 
-                let sv2_frame = sv2_frame.into();
-                sender.send(sv2_frame).await.unwrap();
+                    sender.send(sv2_frame.into()).await.unwrap();
 
-                if !is_valid {
-                    continue;
-                }
+                    if !is_valid {
+                        continue;
+                    }
 
-                let jddownstream = Arc::new(Mutex::new(JobDeclaratorDownstream::new(
-                    receiver.clone(),
-                    sender.clone(),
-                    &config,
-                    mempool.clone(),
-                    // each downstream has its own sender (multi producer single consumer)
-                    sender_add_txs_to_mempool.clone(),
-                )));
+                    let jddownstream = Arc::new(Mutex::new(JobDeclaratorDownstream::new(
+                        receiver.clone(),
+                        sender.clone(),
+                        &config,
+                        mempool.clone(),
+                        sender_add_txs_to_mempool.clone(), // each downstream has its own sender (multi producer single consumer)
+                    )));
 
-                JobDeclaratorDownstream::start(
-                    jddownstream,
-                    status_tx.clone(),
-                    new_block_sender.clone(),
-                );
+                    JobDeclaratorDownstream::start(
+                        jddownstream,
+                        status_tx.clone(),
+                        new_block_sender.clone(),
+                    );
+                }
             } else {
                 error!("Can not connect {:?}", addr);
             }

diff --git a/test/config/jds-setup-connection-flag-test/jds-config.toml b/test/config/jds-setup-connection-flag-test/jds-config.toml
@@ -0,0 +1,20 @@
+# SRI Pool config
+authority_public_key = "9auqWEzQDVyd2oe1JVGFLMLHZtCo2FFqZwtKA5gd9xbuEu7PH72"
+authority_secret_key = "mkDLTBBRxdBv998612qipDYoTK3YUrqLe8uWw7gu3iXbSrn2n"
+cert_validity_sec = 3600
+
+# list of compressed or uncompressed pubkeys for coinbase payout (only supports 1 item in the array at this point)
+coinbase_outputs = [
+   { output_script_type = "P2WPKH", output_script_value = "036adc3bdf21e6f9a0f0fb0066bf517e5b7909ed1563d6958a10993849a7554075" },
+]
+
+listen_jd_address = "127.0.0.1:34264"
+
+core_rpc_url =  ""
+core_rpc_port = 18332
+core_rpc_user =  ""
+core_rpc_pass =  ""
+# Time interval used for JDS mempool update 
+[mempool_update_interval]
+unit = "secs"
+value = 1
diff --git a/...ock/job-declarator-mock-invalid-flag.json → ...s-setup-connection-mock-invalid-flag.json b/...ock/job-declarator-mock-invalid-flag.json → ...s-setup-connection-mock-invalid-flag.json
@@ -2,7 +2,7 @@
     "version": "2",
     "doc": [
         "This test does",
-        "Soft mock of JD",
+        "Soft mock of JDC",
         "Connect to JDS",
         "Receive Setup Connection Error as incorrect bits are set"
     ],

diff --git a/...r-flag-test/job-declarator-flag-test.json → ...-test/jds-setup-connection-flag-test.json b/...r-flag-test/job-declarator-flag-test.json → ...-test/jds-setup-connection-flag-test.json
@@ -19,7 +19,7 @@
                         "jd_server",
                         "--",
                         "-c",
-                        "../test/config/jds-do-not-fail-on-wrong-txdatasucc/jds-config.toml"
+                        "../test/config/jds-setup-connection-flag-test/jds-config.toml"
             ],
             "conditions": {
                 "WithConditions": {
@@ -40,7 +40,7 @@
             "command": "cargo",
             "args": [
                         "run",
-                        "../../test/message-generator/mock/job-declarator-mock-invalid-flag.json"
+                        "../../test/message-generator/mock/jdc-mock-jds-setup-connection-mock-invalid-flag.json"
             ],
             "conditions": {
                 "WithConditions": {

diff --git a/test/message-generator/test/jds-setup-connection-flag-test/jds-setup-connection-flag-test.sh b/test/message-generator/test/jds-setup-connection-flag-test/jds-setup-connection-flag-test.sh
@@ -0,0 +1,9 @@
+cd roles
+cargo llvm-cov --no-report -p pool_sv2
+
+cd ../utils/message-generator/
+cargo build
+
+RUST_LOG=debug cargo run ../../test/message-generator/test/jds-setup-connection-flag-test/jds-setup-connection-flag-test.json || { echo 'mg test failed' ; exit 1; }
+
+sleep 10
diff --git a/test/message-generator/test/job-declarator-flag-test/job-declarator-flag-test.sh b/test/message-generator/test/job-declarator-flag-test/job-declarator-flag-test.sh