4.0.2 release #332

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

Merged

SurfingNerd merged 38 commits into main from 4.0

Dec 12, 2025

CHANGELOG.md

-Original file line number
+Diff line change
@@ -1,6 +1,26 @@
+    ## Diamond Node Software 4.0.2
+    ### New behavior for validator nodes
+    - [Autoshutdown if a Node becomes a regular Node](https://github.com/DMDcoin/diamond-node/issues/322)
+    - [Remove empty blocks during key gen phases behaviour](https://github.com/DMDcoin/diamond-node/issues/327)
+    - [Service Transaction cleanup (garbage collect)](https://github.com/DMDcoin/diamond-node/issues/172)
+    ### RPC
+    - [Gas price from contracts](https://github.com/DMDcoin/diamond-node/issues/159)
+    ### Further improvements
+    - [FIXED: received transactions are getting pooled, if announced by another peer](https://github.com/DMDcoin/diamond-node/issues/304)
+    - [FIXED: dropped transactions are getting pooled](https://github.com/DMDcoin/diamond-node/issues/303)
+    - [FIXED: key generation can panic if faulty validators write malicious parts](https://github.com/DMDcoin/diamond-node/issues/100)
+    - [FIXED: already included transactions are refretched from peers](https://github.com/DMDcoin/diamond-node/issues/196)
+    - [FIXED:not staked nodes write log entries about service transactions](https://github.com/DMDcoin/diamond-node/issues/323)
+    - [Gracefull Node Shutdown: increase to 15 seconds](https://github.com/DMDcoin/diamond-node/issues/321)
     ## Diamond Node Software 4.0.1
-    First hotfix
+    OPTIONAL: First hotfix
     Mitigates the transaction spam caused by flaws in the transaction management of report disconnectivity transactions.
     - [Reduce Intervals for connectivity checks](https://github.com/DMDcoin/diamond-node/issues/313)
@@ Expand Down @@

Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Cargo.toml

-Original file line number
+Diff line change
@@ Expand Up / @@ -2,7 +2,7 @@ @@
     description = "Diamond Node"
     name = "diamond-node"
     # NOTE Make sure to update util/version/Cargo.toml as well
-    version = "4.0.1"
+    version = "4.0.2"
     license = "GPL-3.0"
     authors = [
     	"bit.diamonds developers",
@@ Expand Down @@

bin/oe/run.rs

-Original file line number
+Diff line change
@@ Expand Up / @@ -723,7 +723,7 @@ impl RunningClient { @@
                         .name("diamond-node-force-quit".to_string())
                         .spawn(move || {
-                            let duration_soft = 5;
+                            let duration_soft = 15;
                             // we make a force quit if after 90 seconds, if this shutdown routine
                             std::thread::sleep(Duration::from_secs(duration_soft));
                             warn!(target: "shutdown", "shutdown not happened within {duration_soft} seconds, starting force exiting the process.");
@@ Expand Down @@

crates/concensus/miner/src/pool/queue.rs

-Original file line number
+Diff line change
@@ Expand Up / @@ -41,6 +41,8 @@ use crate::pool::{ @@
         verifier, PendingOrdering, PendingSettings, PrioritizationStrategy,
     };
+    use super::VerifiedTransaction;
     type Listener = (
         LocalTransactionsList,
         (listener::Notifier, listener::Logger),
@@ Expand Down Expand Up / @@ -413,6 +415,17 @@ impl TransactionQueue { @@
                 .collect()
         }
+        /// Performs garbage collection on the pool of this `TransactionQueue` for free service transactions.
+        /// Removes transactions that are not valid anymore.
+        /// The process executes listener calls.
+        pub fn garbage_collect<F: Fn(&VerifiedTransaction) -> bool>(
+            &self,
+            service_transaction_check: F,
+        ) {
+            let mut pool = self.pool.write();
+            pool.garbage_collect(service_transaction_check);
+        }
         /// Computes unordered set of pending hashes.
         ///
         /// Since strict nonce-checking is not required, you may get some false positive future transactions as well.
@@ Expand Down @@

crates/ethcore/service/src/service.rs

-Original file line number
+Diff line change
@@ Expand Up / @@ -233,7 +233,9 @@ impl IoHandler<ClientIoMessage> for ClientIoHandler { @@
                 ClientIoMessage::Execute(ref exec) => {
                     (*exec.0)(&self.client);
                 }
-                _ => {} // ignore other messages
+                ClientIoMessage::NewChainHead => {
+                    self.client.garbage_collect_in_queue();
+                }
             }
         }
     }
@@ Expand Down @@

crates/ethcore/src/client/client.rs

-Original file line number
+Diff line change
@@ Expand Up / @@ -306,6 +306,10 @@ pub struct Client { @@
         shutdown: Arc<ShutdownManager>,
+        /// block number and block hash of latest gc.
+        /// this information is used to avoid double garbage collection.
+        garbage_collect_latest_block: Mutex<(u64, H256)>,
         statistics: ClientStatistics,
     }
@@ Expand Down Expand Up / @@ -842,6 +846,8 @@ impl Importer { @@
                 warn!("Failed to prune ancient state data: {}", e);
             }
+            client.schedule_garbage_collect_in_queue();
             route
         }
@@ Expand Down Expand Up / @@ -1107,6 +1113,7 @@ impl Client { @@
                 importer,
                 config,
                 shutdown,
+                garbage_collect_latest_block: Mutex::new((0, H256::zero())),
                 statistics,
             });
@@ Expand Down Expand Up / @@ -1540,6 +1547,52 @@ impl Client { @@
             }
         }
+        /// Schedule garbage collection of invalid service transactions from the transaction queue based on the given block hash.
+        pub fn schedule_garbage_collect_in_queue(&self) {
+            let m = ClientIoMessage::execute(|c| c.garbage_collect_in_queue());
+            if let Err(e) = self.io_channel.read().send(m) {
+                error!(target: "client", "Failed to schedule garbage collection in transaction queue for block {:?}", e);
+            }
+        }
+        /// Garbage collect invalid service transactions from the transaction queue based on the given block header.
+        pub fn garbage_collect_in_queue(&self) {
+            let machine = self.engine().machine();
+            match &self.block_header_decoded(BlockId::Latest) {
+                Some(block_header) => {
+                    {
+                        // scope for mutex.
+                        let mut last_gc = self.garbage_collect_latest_block.lock();
+                        if block_header.number() == last_gc.0 && block_header.hash() == last_gc.1 {
+                            // already gced for this block, or gc is ongoing.
+                            // we can return here.
+                            return;
+                        }
+                        // we treat ongoing gc as DONE, to avoid blocking of the message channel
+                        last_gc.0 = block_header.number();
+                        last_gc.1 = block_header.hash();
+                    }
+                    // here hides an accepted race condition.
+                    // latest block could change during long ongoing GCs.
+                    // this could be avoided developing a more complex GC logic.
+                    // but the GC blocks the tx queue, so it has to be blazing fast.
+                    self.importer.miner.collect_garbage(|tx|
+                        match machine.verify_transaction(tx.signed(), block_header, self) {
+                            Ok(_) => true,
+                            Err(e) => {
+                                trace!(target: "client", "collected garbage transaction from {:?}: {:?} reason: {:?}", tx.signed().sender(), tx.signed().hash, e);
+                                false
+                            },
+                        });
+                }
+                None => {}
+            }
+        }
         fn check_garbage(&self) {
             self.chain.read().collect_garbage();
             self.importer.block_queue.collect_garbage();
@@ Expand Down @@

crates/ethcore/src/engines/hbbft/contracts/keygen_history.rs

-Original file line number
+Diff line change
@@ Expand Up / @@ -156,12 +156,25 @@ pub fn acks_of_address( @@
             if serialized_ack.is_empty() {
                 return Err(CallError::ReturnValueInvalid);
             }
-            let deserialized_ack: Ack = bincode::deserialize(&serialized_ack).unwrap();
-            let outcome = skg
-                .handle_ack(vmap.get(&address).unwrap(), deserialized_ack)
-                .unwrap();
+            let deserialized_ack: Ack = match bincode::deserialize(&serialized_ack) {
+                Ok(ack) => ack,
+                Err(e) => {
+                    error!(target: "engine", "Failed to deserialize Ack #{} for address {}: {:?}", n, address, e);
+                    return Err(CallError::ReturnValueInvalid);
+                }
+            };
+            let outcome = match skg.handle_ack(vmap.get(&address).unwrap(), deserialized_ack) {
+                Ok(s) => s,
+                Err(e) => {
+                    error!(target: "engine", "Failed to handle Ack #{} for address {}: {:?}", n, address, e);
+                    return Err(CallError::ReturnValueInvalid);
+                }
+            };
             if let AckOutcome::Invalid(fault) = outcome {
-                panic!("Expected Ack Outcome to be valid. {:?}", fault);
+                error!(target: "engine", "Invalid Ack Outcome for #{} for address {}: {:?}", n, address, fault);
+                return Err(CallError::ReturnValueInvalid);
             }
         }
@@ Expand Down @@

crates/ethcore/src/engines/hbbft/contracts/staking.rs

-Original file line number
+Diff line change
@@ Expand Up / @@ -35,11 +35,6 @@ pub fn get_posdao_epoch_start( @@
         call_const_staking!(c, staking_epoch_start_block)
     }
-    pub fn start_time_of_next_phase_transition(client: &dyn EngineClient) -> Result<U256, CallError> {
-        let c = BoundContract::bind(client, BlockId::Latest, *STAKING_CONTRACT_ADDRESS);
-        call_const_staking!(c, start_time_of_next_phase_transition)
-    }
     pub fn candidate_min_stake(client: &dyn EngineClient) -> Result<U256, CallError> {
         let c = BoundContract::bind(client, BlockId::Latest, *STAKING_CONTRACT_ADDRESS);
         call_const_staking!(c, candidate_min_stake)
@@ Expand Down @@

crates/ethcore/src/engines/hbbft/hbbft_early_epoch_end_manager.rs

-Original file line number
+Diff line change
@@ Expand Up / @@ -112,7 +112,7 @@ impl HbbftEarlyEpochEndManager { @@
                 signing_address: signing_address.clone(),
             };
-            info!(target: "engine", "early-epoch-end: HbbftEarlyEpochEndManager created. start_time {now:?}, start_block: {epoch_start_block}");
+            trace!(target: "engine", "early-epoch-end: HbbftEarlyEpochEndManager created. start_time {now:?}, start_block: {epoch_start_block}");
             return Some(result);
         }
@@ Expand Down @@

crates/ethcore/src/engines/hbbft/hbbft_engine.rs

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -51,7 +51,6 @@ use super::{
  
        NodeId,

        contracts::{

            keygen_history::{all_parts_acks_available, initialize_synckeygen},

            staking::start_time_of_next_phase_transition,

            validator_set::{ValidatorType, get_pending_validators, is_pending_validator},

        },

        contribution::{unix_now_millis, unix_now_secs},

    @@ -329,9 +328,6 @@ impl TransitionHandler {
  
            // If the minimum block time has passed we are ready to trigger new blocks.

            if timer_duration == Duration::from_secs(0) {

                // Always create blocks if we are in the keygen phase.

                self.engine.start_hbbft_epoch_if_next_phase();

                // If the maximum block time has been reached we trigger a new block in any case.

                if self.max_block_time_remaining(client.clone()) == Duration::from_secs(0) {

                    self.engine.start_hbbft_epoch(client);

    @@ -1104,27 +1100,6 @@ impl HoneyBadgerBFT {
  
            self.client.read().as_ref().and_then(Weak::upgrade)

        }

        fn start_hbbft_epoch_if_next_phase(&self) {

            // experimental deactivation of empty blocks.

            // see: https://github.com/DMDcoin/diamond-node/issues/160

            match self.client_arc() {

                None => return,

                Some(client) => {

                    // Get the next phase start time

                    let genesis_transition_time = match start_time_of_next_phase_transition(&*client) {

                        Ok(time) => time,

                        Err(_) => return,

                    };

                    // If current time larger than phase start time, start a new block.

                    if genesis_transition_time.as_u64() < unix_now_secs() {

                        self.start_hbbft_epoch(client);

                    }

                }

            }

        }

        fn replay_cached_messages(&self) -> Option<()> {

            let client = self.client_arc()?;

    @@ -1236,12 +1211,12 @@ impl HoneyBadgerBFT {
  
                        return Ok(());

                    }

                    self.hbbft_peers_service

                        .channel()

                        .send(HbbftConnectToPeersMessage::AnnounceAvailability)?;

                    self.hbbft_peers_service

                        .send_message(HbbftConnectToPeersMessage::AnnounceOwnInternetAddress)?;

                    if self.is_staked() {

                        self.hbbft_peers_service

                            .send_message(HbbftConnectToPeersMessage::AnnounceAvailability)?;

                        self.hbbft_peers_service

                            .send_message(HbbftConnectToPeersMessage::AnnounceOwnInternetAddress)?;

                    }

                    if self.should_connect_to_validator_set() {

                        // we just keep those variables here, because we need them in the early_epoch_end_manager.

crates/ethcore/src/engines/hbbft/hbbft_state.rs

-Original file line number
+Diff line change
@@ Expand Up / @@ -209,10 +209,7 @@ impl HbbftState { @@
             // apply DAO updates here.
             // update the current minimum gas price.
-            match get_minimum_gas_from_permission_contract(
-                client.as_ref(),
-                BlockId::Number(self.current_posdao_epoch_start_block),
-            ) {
+            match get_minimum_gas_from_permission_contract(client.as_ref(), BlockId::Latest) {
                 Ok(min_gas) => {
                     *current_minimum_gas_price.lock() = Some(min_gas);
                 }
@@ Expand All / @@ -222,10 +219,29 @@ impl HbbftState { @@
             }
             if sks.is_none() {
-                info!(target: "engine", "We are not part of the HoneyBadger validator set - running as regular node.");
+                info!(target: "engine", "We are not part of the HoneyBadger validator set - Running as regular node.");
                 peers_service
                     .send_message(HbbftConnectToPeersMessage::DisconnectAllValidators)
                     .ok()?;
+                if self.is_validator() {
+                    let is_syncing = if let Some(full) = client.as_full_client() {
+                        full.is_major_syncing()
+                    } else {
+                        info!(target: "engine", "Node was a validator: cannot be determinated, because client is not a full client. (https://github.com/DMDcoin/diamond-node/issues/322.)");
+                        return Some(());
+                    };
+                    if is_syncing {
+                        debug!(target: "engine", "Node was a validator, and became regular node, but we are syncing, not shutting down Node as defined in https://github.com/DMDcoin/diamond-node/issues/322.");
+                    } else {
+                        info!(target: "engine", "Node was a validator, and became regular node. shutting down Node as defined in https://github.com/DMDcoin/diamond-node/issues/322.");
+                        // for unit tests no problem, demand shutddown won't to anything if its a unit test.
+                        // e2e tests needs adaptation.
+                        // this gracefully shuts down a node, if it was a validator before, but now it is not anymore.
+                        client.demand_shutdown();
+                    }
+                }
                 return Some(());
             }
@@ Expand Down @@

crates/ethcore/src/engines/hbbft/test/mod.rs

-Original file line number
+Diff line change
@@ -1,12 +1,11 @@
     use super::{
         contracts::{
             staking::{
-                get_posdao_epoch, start_time_of_next_phase_transition,
+                get_posdao_epoch,
                 tests::{create_staker, is_pool_active},
             },
             validator_set::{is_pending_validator, mining_by_staking_address},
         },
-        contribution::unix_now_secs,
         test::hbbft_test_client::{HbbftTestClient, create_hbbft_client, create_hbbft_clients},
     };
     use crate::{client::traits::BlockInfo, types::ids::BlockId};
@@ Expand Down Expand Up / @@ -129,12 +128,6 @@ fn test_epoch_transition() { @@
         // To avoid performing external transactions with the MoC we create and fund a random address.
         let transactor: KeyPair = Random.generate();
-        let genesis_transition_time = start_time_of_next_phase_transition(moc.client.as_ref())
-            .expect("start_time_of_next_phase_transition call must succeed");
-        // Genesis block is at time 0, current unix time must be much larger.
-        assert!(genesis_transition_time.as_u64() < unix_now_secs());
         // We should not be in the pending validator set at the genesis block.
         assert!(
             !is_pending_validator(moc.client.as_ref(), &moc.address())
@@ Expand Down @@

crates/ethcore/src/miner/miner.rs

-Original file line number
+Diff line change
@@ Expand Up / @@ -420,6 +420,17 @@ impl Miner { @@
             self.service_transaction_checker.clone()
         }
+        /// Performs garbage collection of the pool for free service transactions.
+        /// Removes transactions that are not valid anymore.
+        /// The process executes listener calls.
+        pub fn collect_garbage<F: Fn(&VerifiedTransaction) -> bool>(
+            &self,
+            service_transaction_filter: F,
+        ) {
+            self.transaction_queue
+                .garbage_collect(service_transaction_filter);
+        }
         /// Retrieves an existing pending block iff it's not older than given block number.
         ///
         /// NOTE: This will not prepare a new pending block if it's not existing.
@@ Expand Down @@

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

4.0.2 release #332

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

Uh oh!