Skip to content
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

Manual seal mode for dev #870

Merged
merged 13 commits into from
Jan 6, 2023
1 change: 1 addition & 0 deletions Cargo.lock

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

1 change: 1 addition & 0 deletions node/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ sc-cli = { git = 'https://github.com/paritytech/substrate.git', branch = "polkad
sc-client-api = { git = 'https://github.com/paritytech/substrate.git', branch = "polkadot-v0.9.26" }
sc-consensus = { git = 'https://github.com/paritytech/substrate.git', branch = "polkadot-v0.9.26" }
sc-consensus-aura = { git = 'https://github.com/paritytech/substrate.git', branch = "polkadot-v0.9.26" }
sc-consensus-manual-seal = { git = 'https://github.com/paritytech/substrate.git', branch = "polkadot-v0.9.26" }
sc-consensus-slots = { git = 'https://github.com/paritytech/substrate.git', branch = "polkadot-v0.9.26" }
sc-executor = { git = 'https://github.com/paritytech/substrate.git', branch = "polkadot-v0.9.26" }
sc-keystore = { git = 'https://github.com/paritytech/substrate.git', branch = "polkadot-v0.9.26" }
Expand Down
230 changes: 230 additions & 0 deletions node/src/builder.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,230 @@
// Copyright 2020-2022 Manta Network.
// This file is part of Manta.
//
// Manta is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Manta 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Manta. If not, see <http://www.gnu.org/licenses/>.

//! Service builder
#![allow(clippy::too_many_arguments)]

use crate::{
client::{RuntimeApiCommon, RuntimeApiNimbus},
instant_finalize::InstantFinalizeBlockImport,
service::{Client, StateBackend, TransactionPool},
};
use std::future::Future;

pub use manta_primitives::types::{AccountId, Balance, Block, Hash, Header, Index as Nonce};
use polkadot_service::CollatorPair;
use session_key_primitives::AuraId;
use std::sync::Arc;

use sc_consensus::LongestChain;
use sc_network::NetworkService;
use sc_service::{Configuration, Error, KeystoreContainer, TFullBackend, TaskManager};
use sc_telemetry::{TelemetryHandle, TelemetryWorkerHandle};
use sp_api::ConstructRuntimeApi;
use sp_blockchain::HeaderBackend;
use sp_keystore::SyncCryptoStorePtr;
use substrate_prometheus_endpoint::Registry;

use cumulus_client_cli::CollatorOptions;
use cumulus_client_consensus_common::ParachainConsensus;
use cumulus_primitives_core::ParaId;
use cumulus_primitives_parachain_inherent::{
MockValidationDataInherentDataProvider, MockXcmConfig,
};
use cumulus_relay_chain_inprocess_interface::build_inprocess_relay_chain;
use cumulus_relay_chain_interface::{RelayChainInterface, RelayChainResult};
use cumulus_relay_chain_rpc_interface::RelayChainRPCInterface;

use nimbus_consensus::{
BuildNimbusConsensusParams, NimbusConsensus, NimbusManualSealConsensusDataProvider,
};

/// build relaychain interface for parachain mode
pub async fn build_relay_chain_interface(
polkadot_config: Configuration,
parachain_config: &Configuration,
telemetry_worker_handle: Option<TelemetryWorkerHandle>,
task_manager: &mut TaskManager,
collator_options: CollatorOptions,
hwbench: Option<sc_sysinfo::HwBench>,
) -> RelayChainResult<(
Arc<(dyn RelayChainInterface + 'static)>,
Option<CollatorPair>,
)> {
match collator_options.relay_chain_rpc_url {
Some(relay_chain_url) => Ok((
Arc::new(RelayChainRPCInterface::new(relay_chain_url).await?) as Arc<_>,
None,
)),
None => build_inprocess_relay_chain(
polkadot_config,
parachain_config,
telemetry_worker_handle,
task_manager,
hwbench,
),
}
}

/// build parachain nimbus consensus
pub fn build_nimbus_consensus<RuntimeApi>(
id: ParaId,
client: Arc<Client<RuntimeApi>>,
prometheus_registry: Option<&Registry>,
telemetry: Option<TelemetryHandle>,
task_manager: &TaskManager,
relay_chain_interface: Arc<dyn RelayChainInterface>,
transaction_pool: Arc<TransactionPool<RuntimeApi>>,
_sync_oracle: Arc<NetworkService<Block, Hash>>,
keystore: SyncCryptoStorePtr,
force_authoring: bool,
) -> Result<Box<dyn ParachainConsensus<Block>>, Error>
where
RuntimeApi: ConstructRuntimeApi<Block, Client<RuntimeApi>> + Send + Sync + 'static,
RuntimeApi::RuntimeApi: RuntimeApiCommon<StateBackend = StateBackend>
+ RuntimeApiNimbus
+ sp_consensus_aura::AuraApi<Block, AuraId>,
{
let spawn_handle = task_manager.spawn_handle();
let proposer_factory = sc_basic_authorship::ProposerFactory::with_proof_recording(
spawn_handle,
client.clone(),
transaction_pool,
prometheus_registry,
telemetry,
);

// NOTE: In nimbus, author_id is unused as it is the RuntimeAPI that identifies the block author
let provider = move |_, (relay_parent, validation_data, _author_id)| {
let relay_chain_interface = relay_chain_interface.clone();
async move {
let parachain_inherent =
cumulus_primitives_parachain_inherent::ParachainInherentData::create_at(
relay_parent,
&relay_chain_interface,
&validation_data,
id,
)
.await;

let time = sp_timestamp::InherentDataProvider::from_system_time();

let parachain_inherent = parachain_inherent.ok_or_else(|| {
Box::<dyn std::error::Error + Send + Sync>::from(
"Failed to create parachain inherent",
)
})?;

let nimbus_inherent = nimbus_primitives::InherentDataProvider;
Ok((time, parachain_inherent, nimbus_inherent))
}
};

Ok(NimbusConsensus::build(BuildNimbusConsensusParams {
additional_digests_provider: (),
para_id: id,
proposer_factory,
block_import: client.clone(),
parachain_client: client,
keystore,
skip_prediction: force_authoring,
create_inherent_data_providers: provider,
}))
}

/// build standalone mode dev consensus using manual instant seal
pub fn build_dev_nimbus_consensus<RuntimeApi>(
client: Arc<Client<RuntimeApi>>,
transaction_pool: Arc<TransactionPool<RuntimeApi>>,
keystore_container: &KeystoreContainer,
select_chain: LongestChain<TFullBackend<Block>, Block>,
task_manager: &TaskManager,
) -> Result<impl Future<Output = ()> + Send + 'static, Error>
where
RuntimeApi: ConstructRuntimeApi<Block, Client<RuntimeApi>> + Send + Sync + 'static,
RuntimeApi::RuntimeApi: RuntimeApiCommon<StateBackend = StateBackend> + RuntimeApiNimbus,
{
use futures::{Stream, StreamExt};
use sc_consensus_manual_seal::{run_manual_seal, EngineCommand, ManualSealParams};

let proposer_factory = sc_basic_authorship::ProposerFactory::new(
task_manager.spawn_handle(),
client.clone(),
transaction_pool.clone(),
None,
None,
);

let commands_stream: Box<dyn Stream<Item = EngineCommand<Hash>> + Send + Sync + Unpin> =
Box::new(
// This bit cribbed from the implementation of instant seal.
transaction_pool
.pool()
.validated_pool()
.import_notification_stream()
.map(|_| EngineCommand::SealNewBlock {
create_empty: false,
finalize: false,
parent_hash: None,
sender: None,
}),
);

let client_set_aside_for_cidp = client.clone();

let consensus = run_manual_seal(ManualSealParams {
block_import: InstantFinalizeBlockImport::new(client.clone()),
env: proposer_factory,
client: client.clone(),
pool: transaction_pool,
commands_stream,
select_chain,
consensus_data_provider: Some(Box::new(NimbusManualSealConsensusDataProvider {
keystore: keystore_container.sync_keystore(),
client,
additional_digests_provider: (),
})),
create_inherent_data_providers: move |block: Hash, ()| {
let current_para_block = client_set_aside_for_cidp
.number(block)
.expect("Header lookup should succeed")
.expect("Header passed in as parent should be present in backend.");

let client_for_xcm = client_set_aside_for_cidp.clone();
async move {
let time = sp_timestamp::InherentDataProvider::from_system_time();

let mocked_parachain = MockValidationDataInherentDataProvider {
current_para_block,
relay_offset: 1000,
relay_blocks_per_para_block: 2,
xcm_config: MockXcmConfig::new(
&*client_for_xcm,
block,
Default::default(),
Default::default(),
),
raw_downward_messages: vec![],
raw_horizontal_messages: vec![],
};

Ok((time, mocked_parachain))
}
},
});

Ok(consensus)
}
21 changes: 17 additions & 4 deletions node/src/chain_specs/calamari.rs
Original file line number Diff line number Diff line change
Expand Up @@ -86,13 +86,23 @@ pub fn calamari_development_config() -> CalamariChainSpec {
}

/// Returns the Calamari local chainspec.
pub fn calamari_local_config() -> CalamariChainSpec {
pub fn calamari_local_config(localdev: bool) -> CalamariChainSpec {
let id = if localdev {
"calamari_localdev"
} else {
"calamari_local"
};
CalamariChainSpec::from_genesis(
"Calamari Parachain Local",
"calamari_local",
id,
ChainType::Local,
move || {
calamari_dev_genesis(
let invulnerables = if localdev {
vec![(
unchecked_account_id::<sr25519::Public>("Alice"),
SessionKeys::from_seed_unchecked("Alice"),
)]
} else {
vec![
(
unchecked_account_id::<sr25519::Public>("Alice"),
Expand All @@ -114,7 +124,10 @@ pub fn calamari_local_config() -> CalamariChainSpec {
unchecked_account_id::<sr25519::Public>("Eve"),
SessionKeys::from_seed_unchecked("Eve"),
),
],
]
};
calamari_dev_genesis(
invulnerables,
// Delegations
vec![],
vec![
Expand Down
21 changes: 17 additions & 4 deletions node/src/chain_specs/dolphin.rs
Original file line number Diff line number Diff line change
Expand Up @@ -80,13 +80,23 @@ pub fn dolphin_development_config() -> DolphinChainSpec {
}

/// Returns the Dolphin local chainspec.
pub fn dolphin_local_config() -> DolphinChainSpec {
pub fn dolphin_local_config(localdev: bool) -> DolphinChainSpec {
let id = if localdev {
"dolphin_localdev"
} else {
"dolphin_local"
};
DolphinChainSpec::from_genesis(
"Dolphin Parachain Local",
"dolphin_local",
id,
ChainType::Local,
move || {
dolphin_dev_genesis(
let invulnerables = if localdev {
vec![(
unchecked_account_id::<sr25519::Public>("Alice"),
SessionKeys::from_seed_unchecked("Alice"),
)]
} else {
vec![
(
unchecked_account_id::<sr25519::Public>("Alice"),
Expand All @@ -108,7 +118,10 @@ pub fn dolphin_local_config() -> DolphinChainSpec {
unchecked_account_id::<sr25519::Public>("Eve"),
SessionKeys::from_seed_unchecked("Eve"),
),
],
]
};
dolphin_dev_genesis(
invulnerables,
unchecked_account_id::<sr25519::Public>("Alice"),
vec![
unchecked_account_id::<sr25519::Public>("Alice"),
Expand Down
Loading