2020-06-15 15:41:10 -07:00
|
|
|
//! `start` subcommand - entry point for starting a zebra node
|
2020-06-15 16:16:46 -07:00
|
|
|
//!
|
|
|
|
//! ## Application Structure
|
|
|
|
//!
|
|
|
|
//! A zebra node consists of the following services and tasks:
|
|
|
|
//!
|
|
|
|
//! * Network Service
|
|
|
|
//! * primary interface to the node
|
2020-07-05 03:58:50 -07:00
|
|
|
//! * handles all external network requests for the Zcash protocol
|
2020-06-15 17:07:55 -07:00
|
|
|
//! * via zebra_network::Message and zebra_network::Response
|
2020-06-15 16:16:46 -07:00
|
|
|
//! * provides an interface to the rest of the network for other services and
|
2021-01-29 04:19:06 -08:00
|
|
|
//! tasks running within this node
|
2020-06-15 17:07:55 -07:00
|
|
|
//! * via zebra_network::Request
|
2020-06-15 16:16:46 -07:00
|
|
|
//! * Consensus Service
|
|
|
|
//! * handles all validation logic for the node
|
|
|
|
//! * verifies blocks using zebra-chain and zebra-script, then stores verified
|
2021-01-29 04:19:06 -08:00
|
|
|
//! blocks in zebra-state
|
2020-06-15 16:16:46 -07:00
|
|
|
//! * Sync Task
|
2021-01-29 04:19:06 -08:00
|
|
|
//! * runs in the background and continuously queries the network for
|
|
|
|
//! new blocks to be verified and added to the local state
|
|
|
|
//! * Inbound Service
|
|
|
|
//! * handles requests from peers for network data and chain data
|
|
|
|
//! * performs transaction and block diffusion
|
2021-05-07 04:01:11 -07:00
|
|
|
//! * downloads and verifies gossiped blocks and transactions
|
2020-07-20 21:00:22 -07:00
|
|
|
|
2020-09-18 12:18:22 -07:00
|
|
|
use abscissa_core::{config, Command, FrameworkError, Options, Runnable};
|
|
|
|
use color_eyre::eyre::{eyre, Report};
|
2021-08-24 07:23:53 -07:00
|
|
|
use futures::{select, FutureExt};
|
2020-09-18 12:18:22 -07:00
|
|
|
use tokio::sync::oneshot;
|
|
|
|
use tower::builder::ServiceBuilder;
|
2021-09-08 11:51:17 -07:00
|
|
|
use tower::util::BoxService;
|
2020-09-18 12:18:22 -07:00
|
|
|
|
2020-09-09 12:03:09 -07:00
|
|
|
use crate::{
|
2021-09-08 11:51:17 -07:00
|
|
|
components::{
|
|
|
|
mempool::{self, Mempool},
|
|
|
|
tokio::{RuntimeRun, TokioComponent},
|
|
|
|
ChainSync, Inbound,
|
|
|
|
},
|
|
|
|
config::ZebradConfig,
|
2020-09-09 12:03:09 -07:00
|
|
|
prelude::*,
|
|
|
|
};
|
2020-07-20 21:00:22 -07:00
|
|
|
|
2019-08-29 14:46:54 -07:00
|
|
|
/// `start` subcommand
|
|
|
|
#[derive(Command, Debug, Options)]
|
2020-06-16 11:02:01 -07:00
|
|
|
pub struct StartCmd {
|
2019-09-09 13:05:42 -07:00
|
|
|
/// Filter strings
|
2019-08-29 14:46:54 -07:00
|
|
|
#[options(free)]
|
2019-09-09 13:05:42 -07:00
|
|
|
filters: Vec<String>,
|
2019-08-29 14:46:54 -07:00
|
|
|
}
|
|
|
|
|
2020-06-16 11:02:01 -07:00
|
|
|
impl StartCmd {
|
2020-06-15 17:07:55 -07:00
|
|
|
async fn start(&self) -> Result<(), Report> {
|
2020-09-18 12:18:22 -07:00
|
|
|
let config = app_config().clone();
|
|
|
|
info!(?config);
|
2020-06-15 17:07:55 -07:00
|
|
|
|
2020-09-18 12:18:22 -07:00
|
|
|
info!("initializing node state");
|
2021-09-01 15:31:16 -07:00
|
|
|
// TODO: use ChainTipChange to get tip changes (#2374, #2710, #2711, #2712, #2713, #2714)
|
|
|
|
let (state_service, latest_chain_tip, _chain_tip_change) =
|
Reject connections from outdated peers (#2519)
* Simplify state service initialization in test
Use the test helper function to remove redundant code.
* Create `BestTipHeight` helper type
This type abstracts away the calculation of the best tip height based on
the finalized block height and the best non-finalized chain's tip.
* Add `best_tip_height` field to `StateService`
The receiver endpoint is currently ignored.
* Return receiver endpoint from service constructor
Make it available so that the best tip height can be watched.
* Update finalized height after finalizing blocks
After blocks from the queue are finalized and committed to disk, update
the finalized block height.
* Update best non-finalized height after validation
Update the value of the best non-finalized chain tip block height after
a new block is committed to the non-finalized state.
* Update finalized height after loading from disk
When `FinalizedState` is first created, it loads the state from
persistent storage, and the finalized tip height is updated. Therefore,
the `best_tip_height` must be notified of the initial value.
* Update the finalized height on checkpoint commit
When a checkpointed block is commited, it bypasses the non-finalized
state, so there's an extra place where the finalized height has to be
updated.
* Add `best_tip_height` to `Handshake` service
It can be configured using the `Builder::with_best_tip_height`. It's
currently not used, but it will be used to determine if a connection to
a remote peer should be rejected or not based on that peer's protocol
version.
* Require best tip height to init. `zebra_network`
Without it the handshake service can't properly enforce the minimum
network protocol version from peers. Zebrad obtains the best tip height
endpoint from `zebra_state`, and the test vectors simply use a dummy
endpoint that's fixed at the genesis height.
* Pass `best_tip_height` to proto. ver. negotiation
The protocol version negotiation code will reject connections to peers
if they are using an old protocol version. An old version is determined
based on the current known best chain tip height.
* Handle an optional height in `Version`
Fallback to the genesis height in `None` is specified.
* Reject connections to peers on old proto. versions
Avoid connecting to peers that are on protocol versions that don't
recognize a network update.
* Document why peers on old versions are rejected
Describe why it's a security issue above the check.
* Test if `BestTipHeight` starts with `None`
Check if initially there is no best tip height.
* Test if best tip height is max. of latest values
After applying a list of random updates where each one either sets the
finalized height or the non-finalized height, check that the best tip
height is the maximum of the most recently set finalized height and the
most recently set non-finalized height.
* Add `queue_and_commit_finalized` method
A small refactor to make testing easier. The handling of requests for
committing non-finalized and finalized blocks is now more consistent.
* Add `assert_block_can_be_validated` helper
Refactor to move into a separate method some assertions that are done
before a block is validated. This is to allow moving these assertions
more easily to simplify testing.
* Remove redundant PoW block assertion
It's also checked in
`zebra_state::service::check::block_is_contextually_valid`, and it was
getting in the way of tests that received a gossiped block before
finalizing enough blocks.
* Create a test strategy for test vector chain
Splits a chain loaded from the test vectors in two parts, containing the
blocks to finalize and the blocks to keep in the non-finalized state.
* Test committing blocks update best tip height
Create a mock blockchain state, with a chain of finalized blocks and a
chain of non-finalized blocks. Commit all the blocks appropriately, and
verify that the best tip height is updated.
Co-authored-by: teor <teor@riseup.net>
2021-08-08 16:52:52 -07:00
|
|
|
zebra_state::init(config.state.clone(), config.network.network);
|
|
|
|
let state = ServiceBuilder::new().buffer(20).service(state_service);
|
2020-09-18 12:18:22 -07:00
|
|
|
|
2021-04-21 16:32:47 -07:00
|
|
|
info!("initializing verifiers");
|
2021-08-25 08:07:26 -07:00
|
|
|
// TODO: use the transaction verifier to verify mempool transactions (#2637, #2606)
|
2021-09-01 17:06:20 -07:00
|
|
|
let (chain_verifier, tx_verifier) = zebra_consensus::chain::init(
|
2020-08-19 19:28:21 -07:00
|
|
|
config.consensus.clone(),
|
|
|
|
config.network.network,
|
|
|
|
state.clone(),
|
|
|
|
)
|
|
|
|
.await;
|
2020-07-23 18:47:48 -07:00
|
|
|
|
2021-09-02 06:42:31 -07:00
|
|
|
info!("initializing mempool");
|
2021-09-08 11:51:17 -07:00
|
|
|
let mempool_service = BoxService::new(Mempool::new(config.network.network));
|
|
|
|
let mempool = ServiceBuilder::new().buffer(20).service(mempool_service);
|
2021-09-02 06:42:31 -07:00
|
|
|
|
2020-09-18 12:18:22 -07:00
|
|
|
info!("initializing network");
|
2020-09-18 12:37:01 -07:00
|
|
|
// The service that our node uses to respond to requests by peers. The
|
|
|
|
// load_shed middleware ensures that we reduce the size of the peer set
|
|
|
|
// in response to excess load.
|
2020-09-18 12:18:22 -07:00
|
|
|
let (setup_tx, setup_rx) = oneshot::channel();
|
|
|
|
let inbound = ServiceBuilder::new()
|
|
|
|
.load_shed()
|
|
|
|
.buffer(20)
|
2021-08-25 08:07:26 -07:00
|
|
|
.service(Inbound::new(
|
|
|
|
setup_rx,
|
|
|
|
state.clone(),
|
|
|
|
chain_verifier.clone(),
|
2021-09-01 17:06:20 -07:00
|
|
|
tx_verifier.clone(),
|
2021-09-08 11:51:17 -07:00
|
|
|
mempool.clone(),
|
2021-08-25 08:07:26 -07:00
|
|
|
));
|
2020-09-18 12:18:22 -07:00
|
|
|
|
Reject connections from outdated peers (#2519)
* Simplify state service initialization in test
Use the test helper function to remove redundant code.
* Create `BestTipHeight` helper type
This type abstracts away the calculation of the best tip height based on
the finalized block height and the best non-finalized chain's tip.
* Add `best_tip_height` field to `StateService`
The receiver endpoint is currently ignored.
* Return receiver endpoint from service constructor
Make it available so that the best tip height can be watched.
* Update finalized height after finalizing blocks
After blocks from the queue are finalized and committed to disk, update
the finalized block height.
* Update best non-finalized height after validation
Update the value of the best non-finalized chain tip block height after
a new block is committed to the non-finalized state.
* Update finalized height after loading from disk
When `FinalizedState` is first created, it loads the state from
persistent storage, and the finalized tip height is updated. Therefore,
the `best_tip_height` must be notified of the initial value.
* Update the finalized height on checkpoint commit
When a checkpointed block is commited, it bypasses the non-finalized
state, so there's an extra place where the finalized height has to be
updated.
* Add `best_tip_height` to `Handshake` service
It can be configured using the `Builder::with_best_tip_height`. It's
currently not used, but it will be used to determine if a connection to
a remote peer should be rejected or not based on that peer's protocol
version.
* Require best tip height to init. `zebra_network`
Without it the handshake service can't properly enforce the minimum
network protocol version from peers. Zebrad obtains the best tip height
endpoint from `zebra_state`, and the test vectors simply use a dummy
endpoint that's fixed at the genesis height.
* Pass `best_tip_height` to proto. ver. negotiation
The protocol version negotiation code will reject connections to peers
if they are using an old protocol version. An old version is determined
based on the current known best chain tip height.
* Handle an optional height in `Version`
Fallback to the genesis height in `None` is specified.
* Reject connections to peers on old proto. versions
Avoid connecting to peers that are on protocol versions that don't
recognize a network update.
* Document why peers on old versions are rejected
Describe why it's a security issue above the check.
* Test if `BestTipHeight` starts with `None`
Check if initially there is no best tip height.
* Test if best tip height is max. of latest values
After applying a list of random updates where each one either sets the
finalized height or the non-finalized height, check that the best tip
height is the maximum of the most recently set finalized height and the
most recently set non-finalized height.
* Add `queue_and_commit_finalized` method
A small refactor to make testing easier. The handling of requests for
committing non-finalized and finalized blocks is now more consistent.
* Add `assert_block_can_be_validated` helper
Refactor to move into a separate method some assertions that are done
before a block is validated. This is to allow moving these assertions
more easily to simplify testing.
* Remove redundant PoW block assertion
It's also checked in
`zebra_state::service::check::block_is_contextually_valid`, and it was
getting in the way of tests that received a gossiped block before
finalizing enough blocks.
* Create a test strategy for test vector chain
Splits a chain loaded from the test vectors in two parts, containing the
blocks to finalize and the blocks to keep in the non-finalized state.
* Test committing blocks update best tip height
Create a mock blockchain state, with a chain of finalized blocks and a
chain of non-finalized blocks. Commit all the blocks appropriately, and
verify that the best tip height is updated.
Co-authored-by: teor <teor@riseup.net>
2021-08-08 16:52:52 -07:00
|
|
|
let (peer_set, address_book) =
|
2021-09-01 15:31:16 -07:00
|
|
|
zebra_network::init(config.network.clone(), inbound, latest_chain_tip).await;
|
2020-09-18 12:18:22 -07:00
|
|
|
setup_tx
|
|
|
|
.send((peer_set.clone(), address_book))
|
|
|
|
.map_err(|_| eyre!("could not send setup data to inbound service"))?;
|
2020-06-15 17:07:55 -07:00
|
|
|
|
2020-09-18 12:18:22 -07:00
|
|
|
info!("initializing syncer");
|
2021-08-29 17:01:33 -07:00
|
|
|
// TODO: use sync_status to activate the mempool (#2592)
|
2021-08-31 03:42:25 -07:00
|
|
|
let (syncer, sync_status) =
|
2021-08-25 08:07:26 -07:00
|
|
|
ChainSync::new(&config, peer_set.clone(), state, chain_verifier);
|
2020-06-15 17:07:55 -07:00
|
|
|
|
2021-08-24 07:23:53 -07:00
|
|
|
select! {
|
|
|
|
result = syncer.sync().fuse() => result,
|
2021-08-31 03:42:25 -07:00
|
|
|
_ = mempool::Crawler::spawn(peer_set, sync_status).fuse() => {
|
2021-08-24 07:23:53 -07:00
|
|
|
unreachable!("The mempool crawler only stops if it panics");
|
|
|
|
}
|
|
|
|
}
|
2020-06-15 17:07:55 -07:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-06-16 11:02:01 -07:00
|
|
|
impl Runnable for StartCmd {
|
2019-08-29 14:46:54 -07:00
|
|
|
/// Start the application.
|
|
|
|
fn run(&self) {
|
2020-07-31 23:15:26 -07:00
|
|
|
info!("Starting zebrad");
|
2020-01-13 09:54:27 -08:00
|
|
|
let rt = app_writer()
|
2019-12-13 14:25:14 -08:00
|
|
|
.state_mut()
|
2019-09-09 13:05:42 -07:00
|
|
|
.components
|
2019-12-13 14:25:14 -08:00
|
|
|
.get_downcast_mut::<TokioComponent>()
|
2019-09-09 13:05:42 -07:00
|
|
|
.expect("TokioComponent should be available")
|
|
|
|
.rt
|
2020-01-13 09:54:27 -08:00
|
|
|
.take();
|
|
|
|
|
2020-08-05 16:35:56 -07:00
|
|
|
rt.expect("runtime should not already be taken")
|
|
|
|
.run(self.start());
|
2019-08-29 14:46:54 -07:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-06-16 11:02:01 -07:00
|
|
|
impl config::Override<ZebradConfig> for StartCmd {
|
2019-08-29 14:46:54 -07:00
|
|
|
// Process the given command line options, overriding settings from
|
|
|
|
// a configuration file using explicit flags taken from command-line
|
|
|
|
// arguments.
|
2019-09-09 13:05:42 -07:00
|
|
|
fn override_config(&self, mut config: ZebradConfig) -> Result<ZebradConfig, FrameworkError> {
|
|
|
|
if !self.filters.is_empty() {
|
2020-06-04 19:34:06 -07:00
|
|
|
config.tracing.filter = Some(self.filters.join(","));
|
2019-08-29 14:46:54 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
Ok(config)
|
|
|
|
}
|
|
|
|
}
|