[Do Not Merge until RBH/WBH upgrade] Relayers use new submit_finality_proof_ex call in Rococo <> Westend bridge (#2827)

* use codegen runtime in WBH + update codegen files for RBH + WBH

* use submit_finality_proof_ex for Rococo <> Westend bridge
This commit is contained in:
Svyatoslav Nikolsky
2024-03-01 12:50:20 +03:00
committed by Bastian Köcher
parent afd6eceeac
commit 2c5e845b06
12 changed files with 6358 additions and 263 deletions
@@ -35,8 +35,8 @@ impl MessagesCliBridge for BridgeHubRococoToBridgeHubWestendMessagesCliBridge {
substrate_relay_helper::generate_receive_message_proof_call_builder!(
BridgeHubRococoMessagesToBridgeHubWestendMessageLane,
BridgeHubRococoMessagesToBridgeHubWestendMessageLaneReceiveMessagesProofCallBuilder,
relay_bridge_hub_westend_client::runtime::Call::BridgeRococoMessages,
relay_bridge_hub_westend_client::runtime::BridgeRococoMessagesCall::receive_messages_proof
relay_bridge_hub_westend_client::RuntimeCall::BridgeRococoMessages,
relay_bridge_hub_westend_client::BridgeMessagesCall::receive_messages_proof
);
substrate_relay_helper::generate_receive_message_delivery_proof_call_builder!(
@@ -42,8 +42,8 @@ substrate_relay_helper::generate_receive_message_proof_call_builder!(
substrate_relay_helper::generate_receive_message_delivery_proof_call_builder!(
BridgeHubWestendMessagesToBridgeHubRococoMessageLane,
BridgeHubWestendMessagesToBridgeHubRococoMessageLaneReceiveMessagesDeliveryProofCallBuilder,
relay_bridge_hub_westend_client::runtime::Call::BridgeRococoMessages,
relay_bridge_hub_westend_client::runtime::BridgeRococoMessagesCall::receive_messages_delivery_proof
relay_bridge_hub_westend_client::RuntimeCall::BridgeRococoMessages,
relay_bridge_hub_westend_client::BridgeMessagesCall::receive_messages_delivery_proof
);
/// Description of BridgeHubWestend -> BridgeHubRococo messages bridge.
@@ -31,11 +31,11 @@ use substrate_relay_helper::{
#[derive(Clone, Debug)]
pub struct RococoFinalityToBridgeHubWestend;
substrate_relay_helper::generate_submit_finality_proof_call_builder!(
substrate_relay_helper::generate_submit_finality_proof_ex_call_builder!(
RococoFinalityToBridgeHubWestend,
SubmitFinalityProofCallBuilder,
relay_bridge_hub_westend_client::runtime::Call::BridgeRococoGrandpa,
relay_bridge_hub_westend_client::runtime::BridgeRococoGrandpaCall::submit_finality_proof
relay_bridge_hub_westend_client::RuntimeCall::BridgeRococoGrandpa,
relay_bridge_hub_westend_client::BridgeGrandpaCall::submit_finality_proof_ex
);
substrate_relay_helper::generate_report_equivocation_call_builder!(
@@ -44,8 +44,8 @@ impl SubmitParachainHeadsCallBuilder<BridgeHubRococoToBridgeHubWestend>
parachains: Vec<(ParaId, ParaHash)>,
parachain_heads_proof: ParaHeadsProof,
) -> CallOf<relay_bridge_hub_westend_client::BridgeHubWestend> {
relay_bridge_hub_westend_client::runtime::Call::BridgeRococoParachains(
relay_bridge_hub_westend_client::runtime::BridgeParachainCall::submit_parachain_heads {
relay_bridge_hub_westend_client::RuntimeCall::BridgeRococoParachains(
relay_bridge_hub_westend_client::BridgeParachainCall::submit_parachain_heads {
at_relay_block: (at_relay_block.0, at_relay_block.1),
parachains,
parachain_heads_proof,
@@ -31,11 +31,11 @@ use substrate_relay_helper::{
#[derive(Clone, Debug)]
pub struct WestendFinalityToBridgeHubRococo;
substrate_relay_helper::generate_submit_finality_proof_call_builder!(
substrate_relay_helper::generate_submit_finality_proof_ex_call_builder!(
WestendFinalityToBridgeHubRococo,
SubmitFinalityProofCallBuilder,
relay_bridge_hub_rococo_client::RuntimeCall::BridgeWestendGrandpa,
relay_bridge_hub_rococo_client::BridgeGrandpaCall::submit_finality_proof
relay_bridge_hub_rococo_client::BridgeGrandpaCall::submit_finality_proof_ex
);
substrate_relay_helper::generate_report_equivocation_call_builder!(
@@ -122,10 +122,8 @@ impl BridgeInitializer for RococoToBridgeHubWestendCliBridge {
fn encode_init_bridge(
init_data: <Self::Engine as Engine<Self::Source>>::InitializationData,
) -> <Self::Target as Chain>::Call {
relay_bridge_hub_westend_client::runtime::Call::BridgeRococoGrandpa(
relay_bridge_hub_westend_client::runtime::BridgeRococoGrandpaCall::initialize {
init_data,
},
relay_bridge_hub_westend_client::RuntimeCall::BridgeRococoGrandpa(
relay_bridge_hub_westend_client::BridgeGrandpaCall::initialize { init_data },
)
}
}
File diff suppressed because it is too large Load Diff
@@ -15,9 +15,9 @@ subxt = { version = "0.32.1", default-features = false, features = ["native"] }
# Bridge dependencies
bp-bridge-hub-rococo = { path = "../../primitives/chain-bridge-hub-rococo" }
bp-bridge-hub-westend = { path = "../../primitives/chain-bridge-hub-westend" }
bp-header-chain = { path = "../../primitives/header-chain" }
bp-messages = { path = "../../primitives/messages" }
bp-parachains = { path = "../../primitives/parachains" }
bp-polkadot-core = { path = "../../primitives/polkadot-core" }
bp-rococo = { path = "../../primitives/chain-rococo" }
File diff suppressed because it is too large Load Diff
@@ -16,21 +16,28 @@
//! Types used to connect to the BridgeHub-Westend-Substrate parachain.
use bp_bridge_hub_westend::AVERAGE_BLOCK_INTERVAL;
pub mod codegen_runtime;
use bp_bridge_hub_westend::{SignedExtension, AVERAGE_BLOCK_INTERVAL};
use bp_polkadot_core::SuffixedCommonSignedExtensionExt;
use codec::Encode;
use relay_substrate_client::{
Chain, ChainWithBalances, ChainWithMessages, ChainWithTransactions, ChainWithUtilityPallet,
Error as SubstrateError, MockedRuntimeUtilityPallet, SignParam, UnderlyingChainProvider,
UnsignedTransaction,
calls::UtilityCall as MockUtilityCall, Chain, ChainWithBalances, ChainWithMessages,
ChainWithTransactions, ChainWithUtilityPallet, Error as SubstrateError,
MockedRuntimeUtilityPallet, SignParam, UnderlyingChainProvider, UnsignedTransaction,
};
use sp_core::{storage::StorageKey, Pair};
use sp_runtime::{generic::SignedPayload, traits::IdentifyAccount};
use std::time::Duration;
/// Re-export runtime wrapper
pub mod runtime_wrapper;
pub use runtime_wrapper as runtime;
pub use codegen_runtime::api::runtime_types;
pub type RuntimeCall = runtime_types::bridge_hub_westend_runtime::RuntimeCall;
pub type BridgeMessagesCall = runtime_types::pallet_bridge_messages::pallet::Call;
pub type BridgeGrandpaCall = runtime_types::pallet_bridge_grandpa::pallet::Call;
pub type BridgeParachainCall = runtime_types::pallet_bridge_parachains::pallet::Call;
type UncheckedExtrinsic = bp_bridge_hub_westend::UncheckedExtrinsic<RuntimeCall, SignedExtension>;
type UtilityCall = runtime_types::pallet_utility::pallet::Call;
/// Westend chain definition
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
@@ -47,7 +54,7 @@ impl Chain for BridgeHubWestend {
const AVERAGE_BLOCK_INTERVAL: Duration = AVERAGE_BLOCK_INTERVAL;
type SignedBlock = bp_bridge_hub_westend::SignedBlock;
type Call = runtime::Call;
type Call = RuntimeCall;
}
impl ChainWithBalances for BridgeHubWestend {
@@ -56,13 +63,22 @@ impl ChainWithBalances for BridgeHubWestend {
}
}
impl From<MockUtilityCall<RuntimeCall>> for RuntimeCall {
fn from(value: MockUtilityCall<RuntimeCall>) -> RuntimeCall {
match value {
MockUtilityCall::batch_all(calls) =>
RuntimeCall::Utility(UtilityCall::batch_all { calls }),
}
}
}
impl ChainWithUtilityPallet for BridgeHubWestend {
type UtilityPallet = MockedRuntimeUtilityPallet<runtime::Call>;
type UtilityPallet = MockedRuntimeUtilityPallet<RuntimeCall>;
}
impl ChainWithTransactions for BridgeHubWestend {
type AccountKeyPair = sp_core::sr25519::Pair;
type SignedTransaction = runtime::UncheckedExtrinsic;
type SignedTransaction = UncheckedExtrinsic;
fn sign_transaction(
param: SignParam<Self>,
@@ -70,7 +86,7 @@ impl ChainWithTransactions for BridgeHubWestend {
) -> Result<Self::SignedTransaction, SubstrateError> {
let raw_payload = SignedPayload::new(
unsigned.call,
runtime::SignedExtension::from_params(
SignedExtension::from_params(
param.spec_version,
param.transaction_version,
unsigned.era,
@@ -85,7 +101,7 @@ impl ChainWithTransactions for BridgeHubWestend {
let signer: sp_runtime::MultiSigner = param.signer.public().into();
let (call, extra, _) = raw_payload.deconstruct();
Ok(runtime::UncheckedExtrinsic::new_signed(
Ok(UncheckedExtrinsic::new_signed(
call,
signer.into_account().into(),
signature.into(),
@@ -127,10 +143,12 @@ mod tests {
use super::*;
use relay_substrate_client::TransactionEra;
type SystemCall = runtime_types::frame_system::pallet::Call;
#[test]
fn parse_transaction_works() {
let unsigned = UnsignedTransaction {
call: runtime::Call::System(runtime::SystemCall::remark(b"Hello world!".to_vec()))
call: RuntimeCall::System(SystemCall::remark { remark: b"Hello world!".to_vec() })
.into(),
nonce: 777,
tip: 888,
@@ -1,116 +0,0 @@
// 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/>.
//! Types that are specific to the BridgeHubWestend runtime.
// TODO: regenerate me using `runtime-codegen` tool? (https://github.com/paritytech/parity-bridges-common/issues/1945)
use codec::{Decode, Encode};
use scale_info::TypeInfo;
pub use bp_bridge_hub_westend::SignedExtension;
pub use bp_header_chain::BridgeGrandpaCallOf;
pub use bp_parachains::BridgeParachainCall;
pub use bridge_runtime_common::messages::BridgeMessagesCallOf;
pub use relay_substrate_client::calls::{SystemCall, UtilityCall};
/// Unchecked BridgeHubWestend extrinsic.
pub type UncheckedExtrinsic = bp_bridge_hub_westend::UncheckedExtrinsic<Call, SignedExtension>;
/// The indirect pallet call used to sync `Rococo` GRANDPA finality to `BHWestend`.
pub type BridgeRococoGrandpaCall = BridgeGrandpaCallOf<bp_rococo::Rococo>;
/// The indirect pallet call used to sync `BridgeHubRococo` messages to `BridgeHubWestend`.
pub type BridgeRococoMessagesCall = BridgeMessagesCallOf<bp_bridge_hub_rococo::BridgeHubRococo>;
/// `BridgeHubWestend` Runtime `Call` enum.
///
/// The enum represents a subset of possible `Call`s we can send to `BridgeHubWestend` chain.
/// Ideally this code would be auto-generated from metadata, because we want to
/// avoid depending directly on the ENTIRE runtime just to get the encoding of `Dispatchable`s.
///
/// All entries here (like pretty much in the entire file) must be kept in sync with
/// `BridgeHubWestend` `construct_runtime`, so that we maintain SCALE-compatibility.
#[allow(clippy::large_enum_variant)]
#[derive(Encode, Decode, Debug, PartialEq, Eq, Clone, TypeInfo)]
pub enum Call {
#[cfg(test)]
#[codec(index = 0)]
System(SystemCall),
/// Utility pallet.
#[codec(index = 40)]
Utility(UtilityCall<Call>),
/// Rococo grandpa bridge pallet.
#[codec(index = 42)]
BridgeRococoGrandpa(BridgeRococoGrandpaCall),
/// Rococo parachains bridge pallet.
#[codec(index = 43)]
BridgeRococoParachains(BridgeParachainCall),
/// Rococo messages bridge pallet.
#[codec(index = 44)]
BridgeRococoMessages(BridgeRococoMessagesCall),
}
impl From<UtilityCall<Call>> for Call {
fn from(call: UtilityCall<Call>) -> Call {
Call::Utility(call)
}
}
#[cfg(test)]
mod tests {
use super::*;
use bp_runtime::BasicOperatingMode;
use sp_consensus_grandpa::AuthorityList;
use sp_core::hexdisplay::HexDisplay;
use sp_runtime::traits::Header;
use std::str::FromStr;
pub type RelayBlockNumber = bp_polkadot_core::BlockNumber;
pub type RelayBlockHasher = bp_polkadot_core::Hasher;
pub type RelayBlockHeader = sp_runtime::generic::Header<RelayBlockNumber, RelayBlockHasher>;
#[test]
fn encode_decode_calls() {
let header = RelayBlockHeader::new(
75,
bp_polkadot_core::Hash::from_str(
"0xd2c0afaab32de0cb8f7f0d89217e37c5ea302c1ffb5a7a83e10d20f12c32874d",
)
.expect("invalid value"),
bp_polkadot_core::Hash::from_str(
"0x92b965f0656a4e0e5fc0167da2d4b5ee72b3be2c1583c4c1e5236c8c12aa141b",
)
.expect("invalid value"),
bp_polkadot_core::Hash::from_str(
"0xae4a25acf250d72ed02c149ecc7dd3c9ee976d41a2888fc551de8064521dc01d",
)
.expect("invalid value"),
Default::default(),
);
let init_data = bp_header_chain::InitializationData {
header: Box::new(header),
authority_list: AuthorityList::default(),
set_id: 6,
operating_mode: BasicOperatingMode::Normal,
};
let call = BridgeRococoGrandpaCall::initialize { init_data };
let tx = Call::BridgeRococoGrandpa(call);
// encode call as hex string
let hex_encoded_call = format!("0x{:?}", HexDisplay::from(&Encode::encode(&tx)));
assert_eq!(hex_encoded_call, "0x2a01ae4a25acf250d72ed02c149ecc7dd3c9ee976d41a2888fc551de8064521dc01d2d0192b965f0656a4e0e5fc0167da2d4b5ee72b3be2c1583c4c1e5236c8c12aa141bd2c0afaab32de0cb8f7f0d89217e37c5ea302c1ffb5a7a83e10d20f12c32874d0000060000000000000000");
}
}
@@ -191,6 +191,46 @@ macro_rules! generate_submit_finality_proof_call_builder {
};
}
/// Macro that generates `SubmitFinalityProofCallBuilder` implementation for the case when
/// you only have an access to the mocked version of target chain runtime. In this case you
/// should provide "name" of the call variant for the bridge GRANDPA calls and the "name" of
/// the variant for the `submit_finality_proof_ex` call within that first option.
#[rustfmt::skip]
#[macro_export]
macro_rules! generate_submit_finality_proof_ex_call_builder {
($pipeline:ident, $mocked_builder:ident, $bridge_grandpa:path, $submit_finality_proof:path) => {
pub struct $mocked_builder;
impl $crate::finality::SubmitFinalityProofCallBuilder<$pipeline>
for $mocked_builder
{
fn build_submit_finality_proof_call(
header: relay_substrate_client::SyncHeader<
relay_substrate_client::HeaderOf<
<$pipeline as $crate::finality_base::SubstrateFinalityPipeline>::SourceChain
>
>,
proof: bp_header_chain::justification::GrandpaJustification<
relay_substrate_client::HeaderOf<
<$pipeline as $crate::finality_base::SubstrateFinalityPipeline>::SourceChain
>
>,
context: bp_header_chain::justification::JustificationVerificationContext,
) -> relay_substrate_client::CallOf<
<$pipeline as $crate::finality_base::SubstrateFinalityPipeline>::TargetChain
> {
bp_runtime::paste::item! {
$bridge_grandpa($submit_finality_proof {
finality_target: Box::new(header.into_inner()),
justification: proof,
current_set_id: context.authority_set_id
})
}
}
}
};
}
/// Run Substrate-to-Substrate finality sync loop.
pub async fn run<P: SubstrateFinalitySyncPipeline>(
source_client: Client<P::SourceChain>,