/* 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 .
*/
use std::{collections::HashMap, sync::Arc};
use darkfi::{
blockchain::{BlockInfo, Header},
net::Settings,
rpc::jsonrpc::JsonSubscriber,
system::sleep,
tx::{ContractCallLeaf, TransactionBuilder},
validator::{consensus::Proposal, Validator, ValidatorConfig},
zk::{empty_witnesses, ProvingKey, ZkCircuit},
Result,
};
use darkfi_contract_test_harness::{vks, Holder, TestHarness};
use darkfi_money_contract::{
client::pow_reward_v1::PoWRewardCallBuilder, MoneyFunction, MONEY_CONTRACT_ZKAS_MINT_NS_V1,
};
use darkfi_sdk::{
crypto::{Keypair, MONEY_CONTRACT_ID},
pasta::pallas,
ContractCall,
};
use darkfi_serial::Encodable;
use num_bigint::BigUint;
use rand::rngs::OsRng;
use url::Url;
use crate::{
proto::ProposalMessage,
task::sync::sync_task,
utils::{spawn_miners_p2p, spawn_sync_p2p},
Darkfid,
};
pub struct HarnessConfig {
pub pow_target: usize,
pub pow_fixed_difficulty: Option,
pub alice_initial: u64,
pub bob_initial: u64,
}
pub struct Harness {
pub config: HarnessConfig,
pub vks: Vec<(Vec, String, Vec)>,
pub validator_config: ValidatorConfig,
pub alice: Darkfid,
pub bob: Darkfid,
}
impl Harness {
pub async fn new(
config: HarnessConfig,
verify_fees: bool,
ex: &Arc>,
) -> Result {
// Use test harness to generate genesis transactions
let mut th = TestHarness::new(&[Holder::Bob], verify_fees).await?;
let (genesis_mint_tx, _) =
th.genesis_mint(&Holder::Bob, config.bob_initial, None, None).await?;
// Generate default genesis block
let mut genesis_block = BlockInfo::default();
// Retrieve genesis producer transaction
let producer_tx = genesis_block.txs.pop().unwrap();
// Append genesis transactions
genesis_block.append_txs(vec![genesis_mint_tx, producer_tx])?;
// Generate validators configuration
// NOTE: we are not using consensus constants here so we
// don't get circular dependencies.
let validator_config = ValidatorConfig {
finalization_threshold: 3,
pow_target: config.pow_target,
pow_fixed_difficulty: config.pow_fixed_difficulty.clone(),
genesis_block,
verify_fees,
};
// Generate validators using pregenerated vks
let (_, vks) = vks::get_cached_pks_and_vks()?;
let mut sync_settings =
Settings { localnet: true, inbound_connections: 3, ..Default::default() };
let mut miners_settings =
Settings { localnet: true, inbound_connections: 3, ..Default::default() };
// Alice
let alice_url = Url::parse("tcp+tls://127.0.0.1:18340")?;
sync_settings.inbound_addrs = vec![alice_url.clone()];
let alice_miners_url = Url::parse("tcp+tls://127.0.0.1:18350")?;
miners_settings.inbound_addrs = vec![alice_miners_url.clone()];
let alice = generate_node(
&vks,
&validator_config,
&sync_settings,
Some(&miners_settings),
ex,
true,
)
.await?;
// Bob
let bob_url = Url::parse("tcp+tls://127.0.0.1:18341")?;
sync_settings.inbound_addrs = vec![bob_url];
sync_settings.peers = vec![alice_url];
let bob_miners_url = Url::parse("tcp+tls://127.0.0.1:18351")?;
miners_settings.inbound_addrs = vec![bob_miners_url];
miners_settings.peers = vec![alice_miners_url];
let bob = generate_node(
&vks,
&validator_config,
&sync_settings,
Some(&miners_settings),
ex,
false,
)
.await?;
Ok(Self { config, vks, validator_config, alice, bob })
}
pub async fn validate_chains(&self, total_blocks: usize) -> Result<()> {
let alice = &self.alice.validator;
let bob = &self.bob.validator;
alice
.validate_blockchain(self.config.pow_target, self.config.pow_fixed_difficulty.clone())
.await?;
bob.validate_blockchain(self.config.pow_target, self.config.pow_fixed_difficulty.clone())
.await?;
let alice_blockchain_len = alice.blockchain.len();
assert_eq!(alice_blockchain_len, bob.blockchain.len());
// Last block is not finalized yet
assert_eq!(alice_blockchain_len, total_blocks - 1);
Ok(())
}
pub async fn add_blocks(&self, blocks: &[BlockInfo]) -> Result<()> {
// We append the block as a proposal to Alice,
// and then we broadcast it to rest nodes
for block in blocks {
let proposal = Proposal::new(block.clone())?;
self.alice.validator.consensus.append_proposal(&proposal).await?;
let message = ProposalMessage(proposal);
self.alice.miners_p2p.as_ref().unwrap().broadcast(&message).await;
}
// Sleep a bit so blocks can be propagated and then
// trigger finalization check to Alice and Bob
sleep(1).await;
self.alice.validator.finalization().await?;
self.bob.validator.finalization().await?;
Ok(())
}
pub async fn generate_next_block(&self, previous: &BlockInfo) -> Result {
// Next block info
let block_height = previous.header.height + 1;
let last_nonce = previous.header.nonce;
let fork_previous_hash = previous.header.previous;
// Generate a producer transaction
let keypair = Keypair::default();
let (zkbin, _) = self.alice.validator.blockchain.contracts.get_zkas(
&self.alice.validator.blockchain.sled_db,
&MONEY_CONTRACT_ID,
MONEY_CONTRACT_ZKAS_MINT_NS_V1,
)?;
let circuit = ZkCircuit::new(empty_witnesses(&zkbin)?, &zkbin);
let pk = ProvingKey::build(zkbin.k, &circuit);
// We're just going to be using a zero spend-hook and user-data
let spend_hook = pallas::Base::zero().into();
let user_data = pallas::Base::zero();
// Build the transaction debris
let debris = PoWRewardCallBuilder {
secret: keypair.secret,
recipient: keypair.public,
block_height,
last_nonce,
fork_previous_hash,
spend_hook,
user_data,
mint_zkbin: zkbin.clone(),
mint_pk: pk.clone(),
}
.build()?;
// Generate and sign the actual transaction
let mut data = vec![MoneyFunction::PoWRewardV1 as u8];
debris.params.encode(&mut data)?;
let call = ContractCall { contract_id: *MONEY_CONTRACT_ID, data };
let mut tx_builder =
TransactionBuilder::new(ContractCallLeaf { call, proofs: debris.proofs }, vec![])?;
let mut tx = tx_builder.build()?;
let sigs = tx.create_sigs(&mut OsRng, &[keypair.secret])?;
tx.signatures = vec![sigs];
// We increment timestamp so we don't have to use sleep
let mut timestamp = previous.header.timestamp;
timestamp.add(1);
// Generate header
let header = Header::new(previous.hash()?, block_height, timestamp, last_nonce);
// Generate the block
let mut block = BlockInfo::new_empty(header);
// Add producer transaction to the block
block.append_txs(vec![tx])?;
// Attach signature
block.sign(&keypair.secret)?;
Ok(block)
}
}
// Note: This function should mirror darkfid::main
pub async fn generate_node(
vks: &Vec<(Vec, String, Vec)>,
config: &ValidatorConfig,
sync_settings: &Settings,
miners_settings: Option<&Settings>,
ex: &Arc>,
skip_sync: bool,
) -> Result {
let sled_db = sled::Config::new().temporary(true).open()?;
vks::inject(&sled_db, vks)?;
let validator = Validator::new(&sled_db, config.clone()).await?;
let mut subscribers = HashMap::new();
subscribers.insert("blocks", JsonSubscriber::new("blockchain.subscribe_blocks"));
subscribers.insert("txs", JsonSubscriber::new("blockchain.subscribe_txs"));
subscribers.insert("proposals", JsonSubscriber::new("blockchain.subscribe_proposals"));
let sync_p2p = spawn_sync_p2p(sync_settings, &validator, &subscribers, ex.clone()).await;
let miners_p2p = if let Some(settings) = miners_settings {
Some(spawn_miners_p2p(settings, &validator, &subscribers, ex.clone()).await)
} else {
None
};
let node =
Darkfid::new(sync_p2p.clone(), miners_p2p.clone(), validator, subscribers, None).await;
sync_p2p.clone().start().await?;
if miners_settings.is_some() {
let miners_p2p = miners_p2p.unwrap();
miners_p2p.clone().start().await?;
}
if !skip_sync {
sync_task(&node).await?;
} else {
*node.validator.synced.write().await = true;
}
node.validator.purge_pending_txs().await?;
Ok(node)
}