CLI: Send Message (#886)

* Send Message WiP

* It compiles.

* Add tests.

* Use common macro.

* Nicer balance display.

* Get rid of redundant send_message_call function.

* Fix clippy.

Co-authored-by: Svyatoslav Nikolsky <svyatonik@gmail.com>

bridges/relays/bin-substrate/src/cli/bridge.rs

@@ -51,12 +51,21 @@ macro_rules! select_full_bridge {
 				#[allow(dead_code)]
 				type Target = relay_rialto_client::Rialto;
 
+				// Derive-account
 				#[allow(unused_imports)]
 				use bp_millau::derive_account_from_rialto_id as derive_account;
 
+				// Relay-messages
 				#[allow(unused_imports)]
 				use crate::rialto_millau::millau_messages_to_rialto::run as relay_messages;
 
+				// Send-message
+				#[allow(unused_imports)]
+				use bp_millau::TO_MILLAU_ESTIMATE_MESSAGE_FEE_METHOD as ESTIMATE_MESSAGE_FEE_METHOD;
+				// Send-message
+				#[allow(unused_imports)]
+				use millau_runtime::rialto_account_ownership_digest as account_ownership_digest;
+
 				$generic
 			}
 			FullBridge::RialtoToMillau => {
@@ -64,12 +73,21 @@ macro_rules! select_full_bridge {
 				#[allow(dead_code)]
 				type Target = relay_millau_client::Millau;
 
+				// Derive-account
 				#[allow(unused_imports)]
 				use bp_rialto::derive_account_from_millau_id as derive_account;
 
+				// Relay-messages
 				#[allow(unused_imports)]
 				use crate::rialto_millau::rialto_messages_to_millau::run as relay_messages;
 
+				// Send-message
+				#[allow(unused_imports)]
+				use bp_rialto::TO_RIALTO_ESTIMATE_MESSAGE_FEE_METHOD as ESTIMATE_MESSAGE_FEE_METHOD;
+				// Send-message
+				#[allow(unused_imports)]
+				use rialto_runtime::millau_account_ownership_digest as account_ownership_digest;
+
 				$generic
 			}
 		}

bridges/relays/bin-substrate/src/cli/init_bridge.rs

@@ -108,9 +108,9 @@ impl InitBridge {
 	/// Run the command.
 	pub async fn run(self) -> anyhow::Result<()> {
 		select_bridge!(self.bridge, {
-			let source_client = self.source.into_client::<Source>().await?;
-			let target_client = self.target.into_client::<Target>().await?;
-			let target_sign = self.target_sign.into_keypair::<Target>()?;
+			let source_client = self.source.to_client::<Source>().await?;
+			let target_client = self.target.to_client::<Target>().await?;
+			let target_sign = self.target_sign.to_keypair::<Target>()?;
 
 			crate::headers_initialize::initialize(
 				source_client,

bridges/relays/bin-substrate/src/cli/mod.rs

@@ -33,6 +33,7 @@ mod derive_account;
 mod init_bridge;
 mod relay_headers;
 mod relay_messages;
+mod send_message;
 
 /// Parse relay CLI args.
 pub fn parse_args() -> Command {
@@ -62,7 +63,7 @@ pub enum Command {
 	/// Allows interacting with the bridge by sending messages over `Messages` component.
 	/// The message is being sent to the source chain, delivered to the target chain and dispatched
 	/// there.
-	SendMessage(SendMessage),
+	SendMessage(send_message::SendMessage),
 	/// Generate SCALE-encoded `Call` for choosen network.
 	///
 	/// The call can be used either as message payload or can be wrapped into a transaction
@@ -96,23 +97,6 @@ impl Command {
 	}
 }
 
-/// Send bridge message.
-#[derive(StructOpt)]
-pub enum SendMessage {
-	#[structopt(flatten)]
-	RialtoMillau(rialto_millau::SendMessage),
-}
-
-impl SendMessage {
-	/// Run the command.
-	pub async fn run(self) -> anyhow::Result<()> {
-		match self {
-			Self::RialtoMillau(arg) => arg.run().await?,
-		}
-		Ok(())
-	}
-}
-
 /// Estimate Delivery & Dispatch Fee command.
 #[derive(StructOpt)]
 pub enum EstimateFee {
@@ -143,9 +127,16 @@ arg_enum! {
 }
 
 /// Generic balance type.
-#[derive(Debug)]
+#[derive(Debug, Clone, Copy)]
 pub struct Balance(pub u128);
 
+impl std::fmt::Display for Balance {
+	fn fmt(&self, fmt: &mut std::fmt::Formatter) -> std::fmt::Result {
+		use num_format::{Locale, ToFormattedString};
+		write!(fmt, "{}", self.0.to_formatted_string(&Locale::en))
+	}
+}
+
 impl std::str::FromStr for Balance {
 	type Err = <u128 as std::str::FromStr>::Err;
 
@@ -251,7 +242,7 @@ pub trait CliChain: relay_substrate_client::Chain {
 }
 
 /// Lane id.
-#[derive(Debug)]
+#[derive(Debug, Clone)]
 pub struct HexLaneId(pub LaneId);
 
 impl From<HexLaneId> for LaneId {
@@ -330,7 +321,7 @@ impl From<PrometheusParams> for relay_utils::metrics::MetricsParams {
 }
 
 /// Either explicit or maximal allowed value.
-#[derive(Debug)]
+#[derive(Debug, Clone)]
 pub enum ExplicitOrMaximal<V> {
 	/// User has explicitly specified argument value.
 	Explicit(V),
@@ -388,7 +379,7 @@ macro_rules! declare_chain_options {
 
 			impl [<$chain SigningParams>] {
 				/// Parse signing params into chain-specific KeyPair.
-				pub fn into_keypair<Chain: CliChain>(self) -> anyhow::Result<Chain::KeyPair> {
+				pub fn to_keypair<Chain: CliChain>(&self) -> anyhow::Result<Chain::KeyPair> {
 					use sp_core::crypto::Pair;
 					Chain::KeyPair::from_string(
 						&self.[<$chain_prefix _signer>],
@@ -399,11 +390,11 @@ macro_rules! declare_chain_options {
 
 			impl [<$chain ConnectionParams>] {
 				/// Convert connection params into Substrate client.
-				pub async fn into_client<Chain: CliChain>(
-					self,
+				pub async fn to_client<Chain: CliChain>(
+					&self,
 				) -> anyhow::Result<relay_substrate_client::Client<Chain>> {
 					Ok(relay_substrate_client::Client::new(relay_substrate_client::ConnectionParams {
-						host: self.[<$chain_prefix _host>],
+						host: self.[<$chain_prefix _host>].clone(),
 						port: self.[<$chain_prefix _port>],
 						secure: self.[<$chain_prefix _secure>],
 					})

bridges/relays/bin-substrate/src/cli/relay_headers.rs

@@ -59,12 +59,14 @@ macro_rules! select_bridge {
 				type Source = relay_rialto_client::Rialto;
 				type Target = relay_millau_client::Millau;
 				type Finality = crate::rialto_millau::rialto_headers_to_millau::RialtoFinalityToMillau;
+
 				$generic
 			}
 			RelayHeadersBridge::WestendToMillau => {
 				type Source = relay_westend_client::Westend;
 				type Target = relay_millau_client::Millau;
 				type Finality = crate::rialto_millau::westend_headers_to_millau::WestendFinalityToMillau;
+
 				$generic
 			}
 		}
@@ -75,9 +77,9 @@ impl RelayHeaders {
 	/// Run the command.
 	pub async fn run(self) -> anyhow::Result<()> {
 		select_bridge!(self.bridge, {
-			let source_client = self.source.into_client::<Source>().await?;
-			let target_client = self.target.into_client::<Target>().await?;
-			let target_sign = self.target_sign.into_keypair::<Target>()?;
+			let source_client = self.source.to_client::<Source>().await?;
+			let target_client = self.target.to_client::<Target>().await?;
+			let target_sign = self.target_sign.to_keypair::<Target>()?;
 			let metrics_params = Finality::customize_metrics(self.prometheus_params.into())?;
 
 			crate::finality_pipeline::run(

bridges/relays/bin-substrate/src/cli/relay_messages.rs

@@ -47,10 +47,10 @@ impl RelayMessages {
 	/// Run the command.
 	pub async fn run(self) -> anyhow::Result<()> {
 		select_full_bridge!(self.bridge, {
-			let source_client = self.source.into_client::<Source>().await?;
-			let source_sign = self.source_sign.into_keypair::<Source>()?;
-			let target_client = self.target.into_client::<Target>().await?;
-			let target_sign = self.target_sign.into_keypair::<Target>()?;
+			let source_client = self.source.to_client::<Source>().await?;
+			let source_sign = self.source_sign.to_keypair::<Source>()?;
+			let target_client = self.target.to_client::<Target>().await?;
+			let target_sign = self.target_sign.to_keypair::<Target>()?;
 
 			relay_messages(
 				source_client,

bridges/relays/bin-substrate/src/cli/send_message.rs

@@ -0,0 +1,274 @@
+// Copyright 2019-2021 Parity Technologies (UK) Ltd.
+// This file is part of Parity Bridges Common.
+
+// Parity Bridges Common 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.
+
+// Parity Bridges Common 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 Parity Bridges Common.  If not, see <http://www.gnu.org/licenses/>.
+
+use crate::cli::bridge::FullBridge;
+use crate::cli::encode_call::{self, CliEncodeCall};
+use crate::cli::{
+	Balance, CliChain, ExplicitOrMaximal, HexBytes, HexLaneId, Origins, SourceConnectionParams, SourceSigningParams,
+	TargetSigningParams,
+};
+use codec::Encode;
+use frame_support::{dispatch::GetDispatchInfo, weights::Weight};
+use pallet_bridge_dispatch::{CallOrigin, MessagePayload};
+use relay_substrate_client::{Chain, TransactionSignScheme};
+use sp_core::{Bytes, Pair};
+use sp_runtime::{traits::IdentifyAccount, AccountId32, MultiSignature, MultiSigner};
+use structopt::StructOpt;
+
+/// Send bridge message.
+#[derive(StructOpt)]
+pub struct SendMessage {
+	/// A bridge instance to encode call for.
+	#[structopt(possible_values = &FullBridge::variants(), case_insensitive = true)]
+	bridge: FullBridge,
+	#[structopt(flatten)]
+	source: SourceConnectionParams,
+	#[structopt(flatten)]
+	source_sign: SourceSigningParams,
+	// TODO [#885] Move TargetSign to origins
+	#[structopt(flatten)]
+	target_sign: TargetSigningParams,
+	/// Hex-encoded lane id. Defaults to `00000000`.
+	#[structopt(long, default_value = "00000000")]
+	lane: HexLaneId,
+	/// Dispatch weight of the message. If not passed, determined automatically.
+	#[structopt(long)]
+	dispatch_weight: Option<ExplicitOrMaximal<Weight>>,
+	/// Delivery and dispatch fee in source chain base currency units. If not passed, determined automatically.
+	#[structopt(long)]
+	fee: Option<Balance>,
+	/// Message type.
+	#[structopt(subcommand)]
+	message: crate::cli::encode_call::Call,
+	/// The origin to use when dispatching the message on the target chain. Defaults to
+	/// `SourceAccount`.
+	#[structopt(long, possible_values = &Origins::variants(), default_value = "Source")]
+	origin: Origins,
+}
+
+impl SendMessage {
+	pub fn encode_payload(
+		&mut self,
+	) -> anyhow::Result<MessagePayload<AccountId32, MultiSigner, MultiSignature, Vec<u8>>> {
+		crate::select_full_bridge!(self.bridge, {
+			let SendMessage {
+				source_sign,
+				target_sign,
+				ref mut message,
+				dispatch_weight,
+				origin,
+				bridge,
+				..
+			} = self;
+
+			let source_sign = source_sign.to_keypair::<Source>()?;
+			let target_sign = target_sign.to_keypair::<Target>()?;
+
+			encode_call::preprocess_call::<Source, Target>(message, bridge.bridge_instance_index());
+			let target_call = Target::encode_call(&message)?;
+
+			let payload = {
+				let target_call_weight = prepare_call_dispatch_weight(
+					dispatch_weight,
+					ExplicitOrMaximal::Explicit(target_call.get_dispatch_info().weight),
+					crate::rialto_millau::compute_maximal_message_dispatch_weight(Target::max_extrinsic_weight()),
+				);
+				let source_sender_public: MultiSigner = source_sign.public().into();
+				let source_account_id = source_sender_public.into_account();
+
+				crate::rialto_millau::message_payload(
+					Target::RUNTIME_VERSION.spec_version,
+					target_call_weight,
+					match origin {
+						Origins::Source => CallOrigin::SourceAccount(source_account_id),
+						Origins::Target => {
+							let digest = account_ownership_digest(
+								&target_call,
+								source_account_id.clone(),
+								Target::RUNTIME_VERSION.spec_version,
+							);
+							let target_origin_public = target_sign.public();
+							let digest_signature = target_sign.sign(&digest);
+							CallOrigin::TargetAccount(
+								source_account_id,
+								target_origin_public.into(),
+								digest_signature.into(),
+							)
+						}
+					},
+					&target_call,
+				)
+			};
+			Ok(payload)
+		})
+	}
+
+	/// Run the command.
+	pub async fn run(mut self) -> anyhow::Result<()> {
+		crate::select_full_bridge!(self.bridge, {
+			let payload = self.encode_payload()?;
+
+			let source_client = self.source.to_client::<Source>().await?;
+			let source_sign = self.source_sign.to_keypair::<Source>()?;
+
+			let lane = self.lane.clone().into();
+			let fee = match self.fee {
+				Some(fee) => fee,
+				None => crate::rialto_millau::estimate_message_delivery_and_dispatch_fee::<
+					<Source as relay_substrate_client::ChainWithBalances>::NativeBalance,
+					_,
+					_,
+				>(&source_client, ESTIMATE_MESSAGE_FEE_METHOD, lane, payload.clone())
+				.await?
+				.map(|v| Balance(v as _))
+				.ok_or_else(|| anyhow::format_err!("Failed to estimate message fee. Message is too heavy?"))?,
+			};
+			let dispatch_weight = payload.weight;
+			let send_message_call = Source::encode_call(&encode_call::Call::BridgeSendMessage {
+				bridge_instance_index: self.bridge.bridge_instance_index(),
+				lane: self.lane,
+				payload: HexBytes::encode(&payload),
+				fee,
+			})?;
+
+			source_client
+				.submit_signed_extrinsic(source_sign.public().into(), |transaction_nonce| {
+					let signed_source_call = Source::sign_transaction(
+						*source_client.genesis_hash(),
+						&source_sign,
+						transaction_nonce,
+						send_message_call,
+					)
+					.encode();
+
+					log::info!(
+						target: "bridge",
+						"Sending message to {}. Size: {}. Dispatch weight: {}. Fee: {}",
+						Target::NAME,
+						signed_source_call.len(),
+						dispatch_weight,
+						fee,
+					);
+					log::info!(
+						target: "bridge",
+						"Signed {} Call: {:?}",
+						Source::NAME,
+						HexBytes::encode(&signed_source_call)
+					);
+
+					Bytes(signed_source_call)
+				})
+				.await?;
+		});
+
+		Ok(())
+	}
+}
+
+fn prepare_call_dispatch_weight(
+	user_specified_dispatch_weight: &Option<ExplicitOrMaximal<Weight>>,
+	weight_from_pre_dispatch_call: ExplicitOrMaximal<Weight>,
+	maximal_allowed_weight: Weight,
+) -> Weight {
+	match user_specified_dispatch_weight
+		.clone()
+		.unwrap_or(weight_from_pre_dispatch_call)
+	{
+		ExplicitOrMaximal::Explicit(weight) => weight,
+		ExplicitOrMaximal::Maximal => maximal_allowed_weight,
+	}
+}
+
+#[cfg(test)]
+mod tests {
+	use super::*;
+	use hex_literal::hex;
+
+	#[test]
+	fn send_remark_rialto_to_millau() {
+		// given
+		let mut send_message = SendMessage::from_iter(vec![
+			"send-message",
+			"RialtoToMillau",
+			"--source-port",
+			"1234",
+			"--source-signer",
+			"//Alice",
+			"--target-signer",
+			"//Bob",
+			"remark",
+			"--remark-payload",
+			"1234",
+		]);
+
+		// when
+		let payload = send_message.encode_payload().unwrap();
+
+		// then
+		assert_eq!(
+			payload,
+			MessagePayload {
+				spec_version: relay_millau_client::Millau::RUNTIME_VERSION.spec_version,
+				weight: 1345000,
+				origin: CallOrigin::SourceAccount(sp_keyring::AccountKeyring::Alice.to_account_id()),
+				call: hex!("0401081234").to_vec(),
+			}
+		);
+	}
+
+	#[test]
+	fn send_remark_millau_to_rialto() {
+		// given
+		let mut send_message = SendMessage::from_iter(vec![
+			"send-message",
+			"MillauToRialto",
+			"--source-port",
+			"1234",
+			"--source-signer",
+			"//Alice",
+			"--origin",
+			"Target",
+			"--target-signer",
+			"//Bob",
+			"remark",
+			"--remark-payload",
+			"1234",
+		]);
+
+		// when
+		let payload = send_message.encode_payload().unwrap();
+
+		// then
+		// Since signatures are randomized we extract it from here and only check the rest.
+		let signature = match payload.origin {
+			CallOrigin::TargetAccount(_, _, ref sig) => sig.clone(),
+			_ => panic!("Unexpected `CallOrigin`: {:?}", payload),
+		};
+		assert_eq!(
+			payload,
+			MessagePayload {
+				spec_version: relay_millau_client::Millau::RUNTIME_VERSION.spec_version,
+				weight: 1345000,
+				origin: CallOrigin::TargetAccount(
+					sp_keyring::AccountKeyring::Alice.to_account_id(),
+					sp_keyring::AccountKeyring::Bob.into(),
+					signature,
+				),
+				call: hex!("0701081234").to_vec(),
+			}
+		);
+	}
+}