darkfi/bin/darkfid/src/tests/sync_forks.rs

/* This file is part of DarkFi (https://dark.fi)
 *
 * Copyright (C) 2020-2024 Dyne.org foundation
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

use std::sync::Arc;

use darkfi::{net::Settings, Result};
use darkfi_contract_test_harness::init_logger;
use darkfi_sdk::num_traits::One;
use num_bigint::BigUint;
use smol::Executor;
use url::Url;

use crate::tests::{generate_node, Harness, HarnessConfig};

async fn sync_forks_real(ex: Arc<Executor<'static>>) -> Result<()> {
    init_logger();

    // Initialize harness in testing mode
    let pow_target = 90;
    let pow_fixed_difficulty = Some(BigUint::one());
    let config = HarnessConfig {
        pow_target,
        pow_fixed_difficulty: pow_fixed_difficulty.clone(),
        finalization_threshold: 6,
        alice_initial: 1000,
        bob_initial: 500,
    };
    let th = Harness::new(config, true, &ex).await?;

    // Retrieve genesis block and generate 3 forks
    let previous = th.alice.validator.blockchain.last_block()?;

    // Generate a fork with 3 blocks
    let block1 = th.generate_next_block(&previous).await?;
    let block2 = th.generate_next_block(&block1).await?;
    let block3 = th.generate_next_block(&block2).await?;
    th.add_blocks(&vec![block1, block2, block3]).await?;

    // Generate a fork with 1 block
    let block4 = th.generate_next_block(&previous).await?;
    th.add_blocks(&vec![block4.clone()]).await?;

    // Generate a fork with 1 block
    let block5 = th.generate_next_block(&previous).await?;
    th.add_blocks(&vec![block5.clone()]).await?;

    // Check nodes have all the forks
    th.validate_fork_chains(3, vec![3, 1, 1]).await;

    // We are going to create a third node and try to sync from Bob
    let mut sync_settings =
        Settings { localnet: true, inbound_connections: 3, ..Default::default() };

    let charlie_url = Url::parse("tcp+tls://127.0.0.1:18342")?;
    sync_settings.inbound_addrs = vec![charlie_url];
    let bob_url = th.bob.sync_p2p.settings().inbound_addrs[0].clone();
    sync_settings.peers = vec![bob_url];
    let charlie =
        generate_node(&th.vks, &th.validator_config, &sync_settings, None, &ex, false).await?;

    // Verify node synced the big(best) fork
    let charlie_forks = charlie.validator.consensus.forks.read().await;
    assert_eq!(charlie_forks.len(), 1);
    assert_eq!(charlie_forks[0].proposals.len(), 3);
    drop(charlie_forks);

    // Extend the small fork sequences and add it to nodes
    let block6 = th.generate_next_block(&block4).await?;
    th.add_blocks(&vec![block6]).await?;

    let block7 = th.generate_next_block(&block5).await?;
    th.add_blocks(&vec![block7]).await?;

    // Check charlie has all the forks
    let charlie_forks = charlie.validator.consensus.forks.read().await;
    assert_eq!(charlie_forks.len(), 3);
    assert_eq!(charlie_forks[0].proposals.len(), 3);
    assert_eq!(charlie_forks[1].proposals.len(), 2);
    assert_eq!(charlie_forks[2].proposals.len(), 2);
    drop(charlie_forks);

    // Thanks for reading
    Ok(())
}

#[test]
#[ignore]
fn sync_forks() -> Result<()> {
    let ex = Arc::new(Executor::new());
    let (signal, shutdown) = smol::channel::unbounded::<()>();

    easy_parallel::Parallel::new().each(0..4, |_| smol::block_on(ex.run(shutdown.recv()))).finish(
        || {
            smol::block_on(async {
                sync_forks_real(ex.clone()).await.unwrap();
                drop(signal);
            })
        },
    );

    Ok(())
}