1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

// Copyright (c) The Diem Core Contributors
// SPDX-License-Identifier: Apache-2.0

// Copyright 2021 Conflux Foundation. All rights reserved.
// Conflux is free software and distributed under GNU General Public License.
// See http://www.gnu.org/licenses/

use consensus_types::{block::Block, common::Round};
use diem_crypto::HashValue;
use diem_types::{
    block_info::PivotBlockDecision, transaction::TransactionPayload,
};
use std::sync::mpsc;

pub mod config_subscription;
#[cfg(any(test, feature = "fuzzing"))]
pub mod mock_time_service;
pub mod time_service;

/// Test command sent by RPCs to construct attack cases.
#[derive(Debug)]
pub enum TestCommand {
    /// Make the node vote for the given proposal regardless of its consensus
    /// state. It will not vote if the proposal was not received.
    ForceVoteProposal(HashValue),
    /// Make the node propose a block with given round, parent, and payload.
    /// It will not propose if the parent does not have a valid QC.
    ForcePropose {
        /// Proposed block round.
        round: Round,
        /// Proposed block parent. A valid QC will be retrieved to match this
        /// parent.
        parent_id: HashValue,
        /// Payload for the proposed block. The PoW internal contract events
        /// will not be appended automatically.
        payload: Vec<TransactionPayload>,
    },
    /// Trigger propose_timeout
    ProposalTimeOut,
    /// Trigger local_timeout
    LocalTimeout,
    /// Trigger new_round_timeout
    NewRoundTimeout,
    /// Sign and broadcast a pivot decision transaction
    BroadcastPivotDecision(PivotBlockDecision),
    /// Sign and broadcast an election transaction with a target term
    BroadcastElection(u64),
    /// Stop broadcasting elections to prepare for a restart
    /// Return the round when the node is safe to be stopped without retiring.
    StopElection(mpsc::SyncSender<Option<Round>>),
    /// Start voting and return errors if it fails.
    /// The first parameter is true means the node will start voting with its
    /// local safety data.
    StartVoting((bool, mpsc::SyncSender<anyhow::Result<()>>)),
    /// Stop voting and return errors if it fails.
    StopVoting(mpsc::SyncSender<anyhow::Result<()>>),
    /// Return if the node is voting.
    GetVotingStatus(mpsc::SyncSender<bool>),

    /// Read-only command
    /// Get the chosen to-vote proposal
    GetChosenProposal(mpsc::SyncSender<Option<Block>>),
}