feat: integrate blueprint manager in tangle node (#982)

Author: shekohex

Cargo.lock

@@ -72,7 +72,7 @@ clap = { version = "4.5.16", features = ["derive"] }
 parity-scale-codec = { version = "3.6.12", default-features = false, features = ["derive", "max-encoded-len"] }
 rlp = { version = "0.5", default-features = false }
 tracing = "0.1.40"
-tokio = { version = "1.39" }
+tokio = { version = "1.44.2" }
 futures = { version = "0.3.30" }
 futures-timer = { version = "3.0.2" }
 rand_core = { version = "0.6", default-features = false }
@@ -398,5 +398,14 @@ subxt = { version = "0.39.0", default-features = false }
 subxt-core = { version = "0.39.0", default-features = false }
 subxt-signer = { version = "0.39.0", default-features = false }
 
+# Blueprint
+blueprint-manager = { default-features = false, git = "https://github.com/tangle-network/blueprint", branch = "polkadot-stable2407" }
+blueprint-runner = { default-features = false, git = "https://github.com/tangle-network/blueprint", branch = "polkadot-stable2407" }
+blueprint-keystore = { default-features = false, git = "https://github.com/tangle-network/blueprint", branch = "polkadot-stable2407" }
+# --
+# blueprint-manager = { default-features = false, path = "../gadget/crates/manager" }
+# blueprint-runner = { default-features = false, path = "../gadget/crates/runner" }
+# blueprint-keystore = { default-features = false, path = "../gadget/crates/keystore" }
+
 [profile.release]
 panic = "unwind"

Cargo.toml

@@ -77,6 +77,7 @@ substrate-prometheus-endpoint = { workspace = true }
 sp-session = { workspace = true }
 frame-system-rpc-runtime-api = { workspace = true }
 sp-io = { workspace = true }
+sc-keystore = { workspace = true }
 
 # RPC related dependencies
 jsonrpsee = { workspace = true }
@@ -120,6 +121,10 @@ tangle-runtime = { workspace = true, features = ["std"] }
 tangle-testnet-runtime = { workspace = true, optional = true }
 futures-timer = { workspace = true }
 
+blueprint-manager = { workspace = true, optional = true }
+blueprint-runner = { workspace = true, optional = true }
+blueprint-keystore = { workspace = true, optional = true }
+
 [dev-dependencies]
 tangle-subxt = { workspace = true }
 sp-tracing = { workspace = true }
@@ -152,4 +157,5 @@ txpool = ["fc-rpc/txpool"]
 fast-runtime = ["tangle-testnet-runtime/fast-runtime", "tangle-runtime/fast-runtime"]
 metadata-hash = ["tangle-testnet-runtime?/metadata-hash", "tangle-runtime/metadata-hash"]
 manual-seal = ["tangle-testnet-runtime/manual-seal"]
+blueprint-manager = ["dep:blueprint-manager", "dep:blueprint-runner", "dep:blueprint-keystore"]
 try-runtime = []

node/Cargo.toml

@@ -0,0 +1,50 @@
+use std::path::Path;
+use std::sync::Arc;
+
+use blueprint_keystore::{Keystore, KeystoreConfig};
+use blueprint_manager::config::BlueprintManagerConfig;
+use blueprint_manager::executor::{BlueprintManagerHandle, run_blueprint_manager_with_keystore};
+use blueprint_runner::config::BlueprintEnvironment;
+use sc_keystore::LocalKeystore;
+use sc_service::error::Error as ServiceError;
+
+/// Runs the blueprint manager service.
+pub fn create_blueprint_manager_service<P: AsRef<Path>>(
+	rpc_port: u16,
+	data_dir: P,
+	local_keystore: Arc<LocalKeystore>,
+) -> Result<BlueprintManagerHandle, ServiceError> {
+	let config = BlueprintManagerConfig {
+		gadget_config: None,
+		keystore_uri: data_dir.as_ref().display().to_string(),
+		data_dir: data_dir.as_ref().to_path_buf(),
+		verbose: 2,
+		pretty: false,
+		instance_id: None,
+		test_mode: false,
+	};
+	let mut env = BlueprintEnvironment::default();
+
+	env.http_rpc_endpoint = format!("http://127.0.0.1:{}", rpc_port);
+	env.ws_rpc_endpoint = format!("ws://127.0.0.1:{}", rpc_port);
+	env.keystore_uri = config.keystore_uri.clone();
+	env.data_dir = Some(config.data_dir.clone());
+	env.protocol_settings = blueprint_runner::config::ProtocolSettings::None;
+	env.test_mode = config.test_mode;
+
+	let keystore = Keystore::new(KeystoreConfig::new().substrate(local_keystore))
+		.map_err(|e| ServiceError::Application(e.into()))?;
+
+	let shutdown_cmd = futures::future::pending();
+	let mut handle = match run_blueprint_manager_with_keystore(config, keystore, env, shutdown_cmd)
+	{
+		Ok(handle) => handle,
+		Err(e) => {
+			log::error!("Failed to start blueprint manager: {}", e);
+			return Err(ServiceError::Application(e.into()));
+		},
+	};
+	handle.start().map_err(|e| ServiceError::Application(e.into()))?;
+	log::info!("Blueprint manager started successfully.");
+	Ok(handle)
+}

node/src/blueprint_service.rs

@@ -1,3 +1,5 @@
+#[cfg(feature = "blueprint-manager")]
+pub mod blueprint_service;
 pub mod chainspec;
 pub mod cli;
 pub mod distributions;

node/src/lib.rs

@@ -7,6 +7,8 @@ mod chainspec;
 mod service;
 #[cfg(feature = "runtime-benchmarks")]
 mod benchmarking;
+#[cfg(feature = "blueprint-manager")]
+mod blueprint_service;
 mod cli;
 mod command;
 mod distributions;

node/src/main.rs

@@ -30,7 +30,7 @@ use sc_consensus_babe::BabeWorkerHandle;
 use sc_consensus_grandpa::SharedVoterState;
 #[allow(deprecated)]
 pub use sc_executor::WasmExecutor;
-use sc_service::{Configuration, TaskManager, error::Error as ServiceError};
+use sc_service::{ChainType, Configuration, TaskManager, error::Error as ServiceError};
 use sc_telemetry::{Telemetry, TelemetryHandle, TelemetryWorker};
 use sc_transaction_pool_api::OffchainTransactionPoolFactory;
 use sp_core::U256;
@@ -98,9 +98,9 @@ where
 		GrandpaBlockImport,
 	) -> Result<(BasicQueue<Block>, BoxBlockImport), ServiceError>,
 {
-	println!("    ++++++++++++++++++++++++                                                                          
-	+++++++++++++++++++++++++++                                                                        
-	+++++++++++++++++++++++++++                                                                        
+	println!("    ++++++++++++++++++++++++
+	+++++++++++++++++++++++++++
+	+++++++++++++++++++++++++++
 	+++        ++++++      +++         @%%%%%%%%%%%                                     %%%
 	++++++      ++++      +++++        %%%%%%%%%%%%                                     %%%@
 	++++++++++++++++++++++++++            %%%%      %%%%@     %%% %%@       @%%%%%%%   %%%@    %%%%@
@@ -109,8 +109,8 @@ where
 	++++++++++++++++++++++++++            %%%%    %%%%%%%%%   %%%   %%%%  %%%   @%%%   %%%@ @%%%%%  %%%%%
 	++++++      ++++      ++++++          %%%%    %%%%%%%%%   %%%   %%%%  %%%%%%%%%%   %%%@  %%%%%%%%%@
 	+++        ++++++        +++          %%%%    %%%%%%%%%   %%%   %%%@   %%%%%%%%%   %%%    %%%%%%%@
-	++++      +++++++++      +++                                           %%%%  %%%%               
-	++++++++++++++++++++++++++++                                           %%%%%%%%%         
+	++++      +++++++++      +++                                           %%%%  %%%%
+	++++++++++++++++++++++++++++                                           %%%%%%%%%
 	  +++++++++++++++++++++++                                                 %%%%% \n");
 
 	let telemetry = config
@@ -337,6 +337,23 @@ pub async fn new_full<Network: sc_network::NetworkBackend<Block, <Block as Block
 			metrics,
 		})?;
 
+	if config.role.is_authority() {
+		if config.chain_spec.chain_type() == ChainType::Development
+			|| config.chain_spec.chain_type() == ChainType::Local
+		{
+			if auto_insert_keys {
+				crate::utils::insert_controller_account_keys_into_keystore(
+					&config,
+					Some(keystore_container.local_keystore()),
+				);
+			} else {
+				crate::utils::insert_dev_controller_account_keys_into_keystore(
+					&config,
+					Some(keystore_container.local_keystore()),
+				);
+			}
+		}
+	}
 	let role = config.role.clone();
 	let force_authoring = config.force_authoring;
 	let name = config.network.node_name.clone();
@@ -506,6 +523,10 @@ pub async fn new_full<Network: sc_network::NetworkBackend<Block, <Block as Block
 	)
 	.await;
 
+	#[cfg(feature = "blueprint-manager")]
+	let config_data_path = config.data_path.clone();
+	#[cfg(feature = "blueprint-manager")]
+	let rpc_port = config.rpc_port;
 	let params = sc_service::SpawnTasksParams {
 		network: network.clone(),
 		client: client.clone(),
@@ -600,6 +621,27 @@ pub async fn new_full<Network: sc_network::NetworkBackend<Block, <Block as Block
 
 		network_starter.start_network();
 		log::info!("Manual Seal Ready");
+
+		#[cfg(feature = "blueprint-manager")]
+		{
+			log::info!("Blueprint Manager is enabled.");
+			let bp_mngr = crate::blueprint_service::create_blueprint_manager_service(
+				rpc_port,
+				config_data_path.join("blueprints"),
+				keystore_container.local_keystore(),
+			)?;
+
+			task_manager
+				.spawn_essential_handle()
+				.spawn("blueprint-manager", None, async move {
+					match bp_mngr.await {
+						Ok(()) => (),
+						Err(e) => {
+							log::error!("Blueprint manager failed: {}", e);
+						},
+					}
+				});
+		}
 		return Ok(task_manager);
 	}
 
@@ -644,6 +686,27 @@ pub async fn new_full<Network: sc_network::NetworkBackend<Block, <Block as Block
 		);
 	}
 
+	#[cfg(feature = "blueprint-manager")]
+	{
+		log::info!("Blueprint Manager is enabled.");
+		let bp_mngr = crate::blueprint_service::create_blueprint_manager_service(
+			rpc_port,
+			config_data_path.join("blueprints"),
+			keystore_container.local_keystore(),
+		)?;
+
+		task_manager
+			.spawn_essential_handle()
+			.spawn("blueprint-manager", None, async move {
+				match bp_mngr.await {
+					Ok(()) => (),
+					Err(e) => {
+						log::error!("Blueprint manager failed: {}", e);
+					},
+				}
+			});
+	}
+
 	network_starter.start_network();
 	Ok(task_manager)
 }

node/src/manual_seal.rs

@@ -526,6 +526,10 @@ pub async fn new_full<Network: sc_network::NetworkBackend<Block, <Block as Block
 	)
 	.await;
 
+	#[cfg(feature = "blueprint-manager")]
+	let config_data_path = config.data_path.clone();
+	#[cfg(feature = "blueprint-manager")]
+	let rpc_port = config.rpc_port;
 	let params = sc_service::SpawnTasksParams {
 		network: network.clone(),
 		client: client.clone(),
@@ -647,6 +651,26 @@ pub async fn new_full<Network: sc_network::NetworkBackend<Block, <Block as Block
 		);
 	}
 
+	#[cfg(feature = "blueprint-manager")]
+	{
+		let bp_mngr = crate::blueprint_service::create_blueprint_manager_service(
+			rpc_port,
+			config_data_path.join("blueprints"),
+			keystore_container.local_keystore(),
+		)?;
+
+		task_manager
+			.spawn_essential_handle()
+			.spawn("blueprint-manager", None, async move {
+				match bp_mngr.await {
+					Ok(()) => (),
+					Err(e) => {
+						log::error!("Blueprint manager failed: {}", e);
+					},
+				}
+			});
+	}
+
 	network_starter.start_network();
 	Ok(task_manager)
 }

node/src/service.rs

@@ -1,12 +1,14 @@
 use rand::Rng;
 use sc_service::{ChainType, Configuration};
-use sp_core::{ByteArray, Pair, Public, ed25519, sr25519};
+use sp_core::{ByteArray, Pair, Public, ecdsa, ed25519, sr25519};
 use sp_keystore::{Keystore, KeystorePtr};
 use sp_runtime::{
 	KeyTypeId,
 	key_types::{ACCOUNT, BABE, GRANDPA, IM_ONLINE},
 };
 
+pub const ROLE: KeyTypeId = KeyTypeId(*b"role");
+
 /// Helper function to generate a crypto pair from seed.
 pub fn get_from_seed<TPublic: Public>(seed: &str) -> <TPublic::Pair as Pair>::Public {
 	TPublic::Pair::from_string(&format!("//{seed}"), None)
@@ -38,6 +40,8 @@ pub fn insert_controller_account_keys_into_keystore(
 		key_store.clone(),
 		"ImOnline",
 	);
+	insert_account_keys_into_keystore::<ecdsa::Public>(config, ROLE, key_store.clone(), "role");
+	insert_account_keys_into_keystore::<ed25519::Public>(config, ROLE, key_store.clone(), "role");
 }
 
 /// Inserts keys of specified type into the keystore.
@@ -77,14 +81,19 @@ fn insert_account_keys_into_keystore<TPublic: Public>(
 	if let Some(keystore) = key_store {
 		let _ = Keystore::insert(&*keystore, key_type, &seed_hex, &pub_key);
 	}
-	println!("++++++++++++++++++++++++++++++++++++++++++++++++  
-                AUTO GENERATED KEYS                                                                        
+	println!(
+		"++++++++++++++++++++++++++++++++++++++++++++++++
+                AUTO GENERATED KEYS
                 '{}' key inserted to keystore
                 Seed: {}
                 PublicKey: 0x{}
                 STORE THE KEYS SAFELY, NOT TO BE SHARED WITH ANYONE ELSE.
-    ++++++++++++++++++++++++++++++++++++++++++++++++   							
-            \n", key_name, seed_hex, hex::encode(pub_key));
+    ++++++++++++++++++++++++++++++++++++++++++++++++
+            \n",
+		key_name,
+		seed_hex,
+		hex::encode(pub_key)
+	);
 }
 
 /// Inserts a key of type `ACCOUNT` into the keystore for development/testing.
@@ -96,6 +105,9 @@ pub fn insert_dev_controller_account_keys_into_keystore(
 	key_store: Option<KeystorePtr>,
 ) {
 	insert_dev_account_keys_into_keystore::<sr25519::Public>(config, ACCOUNT, key_store.clone());
+	insert_dev_account_keys_into_keystore::<ed25519::Public>(config, ROLE, key_store.clone());
+
+	insert_dev_account_keys_into_keystore::<ecdsa::Public>(config, ROLE, key_store.clone());
 }
 
 /// Inserts keys of specified type into the keystore for predefined nodes in development mode.