feat: Rebrand Polkadot/Substrate references to PezkuwiChain
This commit systematically rebrands various references from Parity Technologies' Polkadot/Substrate ecosystem to PezkuwiChain within the kurdistan-sdk. Key changes include: - Updated external repository URLs (zombienet-sdk, parity-db, parity-scale-codec, wasm-instrument) to point to pezkuwichain forks. - Modified internal documentation and code comments to reflect PezkuwiChain naming and structure. - Replaced direct references to with or specific paths within the for XCM, Pezkuwi, and other modules. - Cleaned up deprecated issue and PR references in various and files, particularly in and modules. - Adjusted image and logo URLs in documentation to point to PezkuwiChain assets. - Removed or rephrased comments related to external Polkadot/Substrate PRs and issues. This is a significant step towards fully customizing the SDK for the PezkuwiChain ecosystem.
This commit is contained in:
@@ -0,0 +1,235 @@
|
||||
// Copyright (C) Parity Technologies (UK) Ltd.
|
||||
// This file is part of Pezcumulus.
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
//! Client side code for generating the teyrchain inherent.
|
||||
|
||||
mod mock;
|
||||
|
||||
use codec::Decode;
|
||||
use cumulus_primitives_core::{
|
||||
relay_chain::{
|
||||
self, ApprovedPeerId, Block as RelayBlock, Hash as PHash, Header as RelayHeader,
|
||||
HrmpChannelId,
|
||||
},
|
||||
ParaId, PersistedValidationData,
|
||||
};
|
||||
pub use cumulus_primitives_teyrchain_inherent::{TeyrchainInherentData, INHERENT_IDENTIFIER};
|
||||
use cumulus_relay_chain_interface::RelayChainInterface;
|
||||
pub use mock::{MockValidationDataInherentDataProvider, MockXcmConfig};
|
||||
use pezsc_network_types::PeerId;
|
||||
|
||||
const LOG_TARGET: &str = "teyrchain-inherent";
|
||||
|
||||
/// Collect the relevant relay chain state in form of a proof for putting it into the validation
|
||||
/// data inherent.
|
||||
async fn collect_relay_storage_proof(
|
||||
relay_chain_interface: &impl RelayChainInterface,
|
||||
para_id: ParaId,
|
||||
relay_parent: PHash,
|
||||
include_authorities: bool,
|
||||
include_next_authorities: bool,
|
||||
additional_relay_state_keys: Vec<Vec<u8>>,
|
||||
) -> Option<pezsp_state_machine::StorageProof> {
|
||||
use relay_chain::well_known_keys as relay_well_known_keys;
|
||||
|
||||
let ingress_channels = relay_chain_interface
|
||||
.get_storage_by_key(
|
||||
relay_parent,
|
||||
&relay_well_known_keys::hrmp_ingress_channel_index(para_id),
|
||||
)
|
||||
.await
|
||||
.map_err(|e| {
|
||||
tracing::error!(
|
||||
target: LOG_TARGET,
|
||||
relay_parent = ?relay_parent,
|
||||
error = ?e,
|
||||
"Cannot obtain the hrmp ingress channel."
|
||||
)
|
||||
})
|
||||
.ok()?;
|
||||
|
||||
let ingress_channels = ingress_channels
|
||||
.map(|raw| <Vec<ParaId>>::decode(&mut &raw[..]))
|
||||
.transpose()
|
||||
.map_err(|e| {
|
||||
tracing::error!(
|
||||
target: LOG_TARGET,
|
||||
error = ?e,
|
||||
"Cannot decode the hrmp ingress channel index.",
|
||||
)
|
||||
})
|
||||
.ok()?
|
||||
.unwrap_or_default();
|
||||
|
||||
let egress_channels = relay_chain_interface
|
||||
.get_storage_by_key(
|
||||
relay_parent,
|
||||
&relay_well_known_keys::hrmp_egress_channel_index(para_id),
|
||||
)
|
||||
.await
|
||||
.map_err(|e| {
|
||||
tracing::error!(
|
||||
target: LOG_TARGET,
|
||||
error = ?e,
|
||||
"Cannot obtain the hrmp egress channel.",
|
||||
)
|
||||
})
|
||||
.ok()?;
|
||||
|
||||
let egress_channels = egress_channels
|
||||
.map(|raw| <Vec<ParaId>>::decode(&mut &raw[..]))
|
||||
.transpose()
|
||||
.map_err(|e| {
|
||||
tracing::error!(
|
||||
target: LOG_TARGET,
|
||||
error = ?e,
|
||||
"Cannot decode the hrmp egress channel index.",
|
||||
)
|
||||
})
|
||||
.ok()?
|
||||
.unwrap_or_default();
|
||||
|
||||
let mut relevant_keys = vec![
|
||||
relay_well_known_keys::CURRENT_BLOCK_RANDOMNESS.to_vec(),
|
||||
relay_well_known_keys::ONE_EPOCH_AGO_RANDOMNESS.to_vec(),
|
||||
relay_well_known_keys::TWO_EPOCHS_AGO_RANDOMNESS.to_vec(),
|
||||
relay_well_known_keys::CURRENT_SLOT.to_vec(),
|
||||
relay_well_known_keys::ACTIVE_CONFIG.to_vec(),
|
||||
relay_well_known_keys::dmq_mqc_head(para_id),
|
||||
// TODO paritytech/pezkuwi#6283: Remove all usages of `relay_dispatch_queue_size`
|
||||
// We need to keep this here until all teyrchains have migrated to
|
||||
// `relay_dispatch_queue_remaining_capacity`.
|
||||
#[allow(deprecated)]
|
||||
relay_well_known_keys::relay_dispatch_queue_size(para_id),
|
||||
relay_well_known_keys::relay_dispatch_queue_remaining_capacity(para_id).key,
|
||||
relay_well_known_keys::hrmp_ingress_channel_index(para_id),
|
||||
relay_well_known_keys::hrmp_egress_channel_index(para_id),
|
||||
relay_well_known_keys::upgrade_go_ahead_signal(para_id),
|
||||
relay_well_known_keys::upgrade_restriction_signal(para_id),
|
||||
relay_well_known_keys::para_head(para_id),
|
||||
];
|
||||
relevant_keys.extend(ingress_channels.into_iter().map(|sender| {
|
||||
relay_well_known_keys::hrmp_channels(HrmpChannelId { sender, recipient: para_id })
|
||||
}));
|
||||
relevant_keys.extend(egress_channels.into_iter().map(|recipient| {
|
||||
relay_well_known_keys::hrmp_channels(HrmpChannelId { sender: para_id, recipient })
|
||||
}));
|
||||
|
||||
if include_authorities {
|
||||
relevant_keys.push(relay_well_known_keys::AUTHORITIES.to_vec());
|
||||
}
|
||||
|
||||
if include_next_authorities {
|
||||
relevant_keys.push(relay_well_known_keys::NEXT_AUTHORITIES.to_vec());
|
||||
}
|
||||
|
||||
// Add additional relay state keys
|
||||
let unique_keys: Vec<Vec<u8>> = additional_relay_state_keys
|
||||
.into_iter()
|
||||
.filter(|key| !relevant_keys.contains(key))
|
||||
.collect();
|
||||
relevant_keys.extend(unique_keys);
|
||||
|
||||
relay_chain_interface
|
||||
.prove_read(relay_parent, &relevant_keys)
|
||||
.await
|
||||
.map_err(|e| {
|
||||
tracing::error!(
|
||||
target: LOG_TARGET,
|
||||
relay_parent = ?relay_parent,
|
||||
error = ?e,
|
||||
"Cannot obtain read proof from relay chain.",
|
||||
);
|
||||
})
|
||||
.ok()
|
||||
}
|
||||
|
||||
pub struct TeyrchainInherentDataProvider;
|
||||
|
||||
impl TeyrchainInherentDataProvider {
|
||||
/// Create the [`TeyrchainInherentData`] at the given `relay_parent`.
|
||||
///
|
||||
/// Returns `None` if the creation failed.
|
||||
pub async fn create_at(
|
||||
relay_parent: PHash,
|
||||
relay_chain_interface: &impl RelayChainInterface,
|
||||
validation_data: &PersistedValidationData,
|
||||
para_id: ParaId,
|
||||
relay_parent_descendants: Vec<RelayHeader>,
|
||||
additional_relay_state_keys: Vec<Vec<u8>>,
|
||||
collator_peer_id: PeerId,
|
||||
) -> Option<TeyrchainInherentData> {
|
||||
let collator_peer_id = ApprovedPeerId::try_from(collator_peer_id.to_bytes())
|
||||
.inspect_err(|_e| {
|
||||
tracing::warn!(
|
||||
target: LOG_TARGET,
|
||||
"Could not convert collator_peer_id into ApprovedPeerId. The collator_peer_id \
|
||||
should contain a sequence of at most 64 bytes",
|
||||
);
|
||||
})
|
||||
.ok();
|
||||
|
||||
// Only include next epoch authorities when the descendants include an epoch digest.
|
||||
// Skip the first entry because this is the relay parent itself.
|
||||
let include_next_authorities = relay_parent_descendants
|
||||
.iter()
|
||||
.skip(1)
|
||||
.any(pezsc_consensus_babe::contains_epoch_change::<RelayBlock>);
|
||||
let relay_chain_state = collect_relay_storage_proof(
|
||||
relay_chain_interface,
|
||||
para_id,
|
||||
relay_parent,
|
||||
!relay_parent_descendants.is_empty(),
|
||||
include_next_authorities,
|
||||
additional_relay_state_keys,
|
||||
)
|
||||
.await?;
|
||||
|
||||
let downward_messages = relay_chain_interface
|
||||
.retrieve_dmq_contents(para_id, relay_parent)
|
||||
.await
|
||||
.map_err(|e| {
|
||||
tracing::error!(
|
||||
target: LOG_TARGET,
|
||||
relay_parent = ?relay_parent,
|
||||
error = ?e,
|
||||
"An error occurred during requesting the downward messages.",
|
||||
);
|
||||
})
|
||||
.ok()?;
|
||||
let horizontal_messages = relay_chain_interface
|
||||
.retrieve_all_inbound_hrmp_channel_contents(para_id, relay_parent)
|
||||
.await
|
||||
.map_err(|e| {
|
||||
tracing::error!(
|
||||
target: LOG_TARGET,
|
||||
relay_parent = ?relay_parent,
|
||||
error = ?e,
|
||||
"An error occurred during requesting the inbound HRMP messages.",
|
||||
);
|
||||
})
|
||||
.ok()?;
|
||||
|
||||
Some(TeyrchainInherentData {
|
||||
downward_messages,
|
||||
horizontal_messages,
|
||||
validation_data: validation_data.clone(),
|
||||
relay_chain_state,
|
||||
relay_parent_descendants,
|
||||
collator_peer_id,
|
||||
})
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,258 @@
|
||||
// Copyright (C) Parity Technologies (UK) Ltd.
|
||||
// This file is part of Pezcumulus.
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
use crate::TeyrchainInherentData;
|
||||
use codec::Decode;
|
||||
use cumulus_primitives_core::{
|
||||
relay_chain,
|
||||
relay_chain::{Slot, UpgradeGoAhead},
|
||||
InboundDownwardMessage, InboundHrmpMessage, ParaId, PersistedValidationData,
|
||||
};
|
||||
use cumulus_primitives_teyrchain_inherent::MessageQueueChain;
|
||||
use cumulus_test_relay_sproof_builder::RelayStateSproofBuilder;
|
||||
use pezsc_client_api::{Backend, StorageProvider};
|
||||
use pezsp_crypto_hashing::twox_128;
|
||||
use pezsp_inherents::{InherentData, InherentDataProvider};
|
||||
use pezsp_runtime::traits::Block;
|
||||
use std::collections::BTreeMap;
|
||||
|
||||
/// Inherent data provider that supplies mocked validation data.
|
||||
///
|
||||
/// This is useful when running a node that is not actually backed by any relay chain.
|
||||
/// For example when running a local node, or running integration tests.
|
||||
///
|
||||
/// We mock a relay chain block number as follows:
|
||||
/// relay_block_number = offset + relay_blocks_per_para_block * current_para_block
|
||||
/// To simulate a teyrchain that starts in relay block 1000 and gets a block in every other relay
|
||||
/// block, use 1000 and 2
|
||||
///
|
||||
/// Optionally, mock XCM messages can be injected into the runtime. When mocking XCM,
|
||||
/// in addition to the messages themselves, you must provide some information about
|
||||
/// your teyrchain's configuration in order to mock the MQC heads properly.
|
||||
/// See [`MockXcmConfig`] for more information
|
||||
#[derive(Default)]
|
||||
pub struct MockValidationDataInherentDataProvider<R = ()> {
|
||||
/// The current block number of the local block chain (the teyrchain).
|
||||
pub current_para_block: u32,
|
||||
/// The teyrchain ID of the teyrchain for that the inherent data is created.
|
||||
pub para_id: ParaId,
|
||||
/// The current block head data of the local block chain (the teyrchain).
|
||||
pub current_para_block_head: Option<cumulus_primitives_core::relay_chain::HeadData>,
|
||||
/// The relay block in which this teyrchain appeared to start. This will be the relay block
|
||||
/// number in para block #P1.
|
||||
pub relay_offset: u32,
|
||||
/// The number of relay blocks that elapses between each parablock. Probably set this to 1 or 2
|
||||
/// to simulate optimistic or realistic relay chain behavior.
|
||||
pub relay_blocks_per_para_block: u32,
|
||||
/// Number of teyrchain blocks per relay chain epoch
|
||||
/// Mock epoch is computed by dividing `current_para_block` by this value.
|
||||
pub para_blocks_per_relay_epoch: u32,
|
||||
/// Function to mock BABE one epoch ago randomness.
|
||||
pub relay_randomness_config: R,
|
||||
/// XCM messages and associated configuration information.
|
||||
pub xcm_config: MockXcmConfig,
|
||||
/// Inbound downward XCM messages to be injected into the block.
|
||||
pub raw_downward_messages: Vec<Vec<u8>>,
|
||||
/// Inbound Horizontal messages sorted by channel.
|
||||
pub raw_horizontal_messages: Vec<(ParaId, Vec<u8>)>,
|
||||
/// Additional key-value pairs that should be injected.
|
||||
pub additional_key_values: Option<Vec<(Vec<u8>, Vec<u8>)>>,
|
||||
/// Whether upgrade go ahead should be set.
|
||||
pub upgrade_go_ahead: Option<UpgradeGoAhead>,
|
||||
}
|
||||
|
||||
/// Something that can generate randomness.
|
||||
pub trait GenerateRandomness<I> {
|
||||
/// Generate the randomness using the given `input`.
|
||||
fn generate_randomness(&self, input: I) -> relay_chain::Hash;
|
||||
}
|
||||
|
||||
impl GenerateRandomness<u64> for () {
|
||||
/// Default implementation uses relay epoch as randomness value
|
||||
/// A more seemingly random implementation may hash the relay epoch instead
|
||||
fn generate_randomness(&self, input: u64) -> relay_chain::Hash {
|
||||
let mut mock_randomness: [u8; 32] = [0u8; 32];
|
||||
mock_randomness[..8].copy_from_slice(&input.to_be_bytes());
|
||||
mock_randomness.into()
|
||||
}
|
||||
}
|
||||
|
||||
/// Parameters for how the Mock inherent data provider should inject XCM messages.
|
||||
/// In addition to the messages themselves, some information about the teyrchain's
|
||||
/// configuration is also required so that the MQC heads can be read out of the
|
||||
/// teyrchain's storage, and the corresponding relay data mocked.
|
||||
#[derive(Default)]
|
||||
pub struct MockXcmConfig {
|
||||
/// The starting state of the dmq_mqc_head.
|
||||
pub starting_dmq_mqc_head: relay_chain::Hash,
|
||||
/// The starting state of each teyrchain's mqc head
|
||||
pub starting_hrmp_mqc_heads: BTreeMap<ParaId, relay_chain::Hash>,
|
||||
}
|
||||
|
||||
/// The name of the teyrchain system in the runtime.
|
||||
///
|
||||
/// This name is used by frame to prefix storage items and will be required to read data from the
|
||||
/// storage.
|
||||
///
|
||||
/// The `Default` implementation sets the name to `TeyrchainSystem`.
|
||||
pub struct TeyrchainSystemName(pub Vec<u8>);
|
||||
|
||||
impl Default for TeyrchainSystemName {
|
||||
fn default() -> Self {
|
||||
Self(b"TeyrchainSystem".to_vec())
|
||||
}
|
||||
}
|
||||
|
||||
impl MockXcmConfig {
|
||||
/// Create a MockXcmConfig by reading the mqc_heads directly
|
||||
/// from the storage of a previous block.
|
||||
pub fn new<B: Block, BE: Backend<B>, C: StorageProvider<B, BE>>(
|
||||
client: &C,
|
||||
parent_block: B::Hash,
|
||||
teyrchain_system_name: TeyrchainSystemName,
|
||||
) -> Self {
|
||||
let starting_dmq_mqc_head = client
|
||||
.storage(
|
||||
parent_block,
|
||||
&pezsp_storage::StorageKey(
|
||||
[twox_128(&teyrchain_system_name.0), twox_128(b"LastDmqMqcHead")]
|
||||
.concat()
|
||||
.to_vec(),
|
||||
),
|
||||
)
|
||||
.expect("We should be able to read storage from the parent block.")
|
||||
.map(|ref mut raw_data| {
|
||||
Decode::decode(&mut &raw_data.0[..]).expect("Stored data should decode correctly")
|
||||
})
|
||||
.unwrap_or_default();
|
||||
|
||||
let starting_hrmp_mqc_heads = client
|
||||
.storage(
|
||||
parent_block,
|
||||
&pezsp_storage::StorageKey(
|
||||
[twox_128(&teyrchain_system_name.0), twox_128(b"LastHrmpMqcHeads")]
|
||||
.concat()
|
||||
.to_vec(),
|
||||
),
|
||||
)
|
||||
.expect("We should be able to read storage from the parent block.")
|
||||
.map(|ref mut raw_data| {
|
||||
Decode::decode(&mut &raw_data.0[..]).expect("Stored data should decode correctly")
|
||||
})
|
||||
.unwrap_or_default();
|
||||
|
||||
Self { starting_dmq_mqc_head, starting_hrmp_mqc_heads }
|
||||
}
|
||||
}
|
||||
|
||||
#[async_trait::async_trait]
|
||||
impl<R: Send + Sync + GenerateRandomness<u64>> InherentDataProvider
|
||||
for MockValidationDataInherentDataProvider<R>
|
||||
{
|
||||
async fn provide_inherent_data(
|
||||
&self,
|
||||
inherent_data: &mut InherentData,
|
||||
) -> Result<(), pezsp_inherents::Error> {
|
||||
// Use the "sproof" (spoof proof) builder to build valid mock state root and proof.
|
||||
let mut sproof_builder =
|
||||
RelayStateSproofBuilder { para_id: self.para_id, ..Default::default() };
|
||||
|
||||
// Calculate the mocked relay block based on the current para block
|
||||
let relay_parent_number =
|
||||
self.relay_offset + self.relay_blocks_per_para_block * self.current_para_block;
|
||||
sproof_builder.current_slot = Slot::from(relay_parent_number as u64);
|
||||
|
||||
sproof_builder.upgrade_go_ahead = self.upgrade_go_ahead;
|
||||
// Process the downward messages and set up the correct head
|
||||
let mut downward_messages = Vec::new();
|
||||
let mut dmq_mqc = MessageQueueChain::new(self.xcm_config.starting_dmq_mqc_head);
|
||||
for msg in &self.raw_downward_messages {
|
||||
let wrapped = InboundDownwardMessage { sent_at: relay_parent_number, msg: msg.clone() };
|
||||
|
||||
dmq_mqc.extend_downward(&wrapped);
|
||||
downward_messages.push(wrapped);
|
||||
}
|
||||
sproof_builder.dmq_mqc_head = Some(dmq_mqc.head());
|
||||
|
||||
// Process the hrmp messages and set up the correct heads
|
||||
// Begin by collecting them into a Map
|
||||
let mut horizontal_messages = BTreeMap::<ParaId, Vec<InboundHrmpMessage>>::new();
|
||||
for (para_id, msg) in &self.raw_horizontal_messages {
|
||||
let wrapped = InboundHrmpMessage { sent_at: relay_parent_number, data: msg.clone() };
|
||||
|
||||
horizontal_messages.entry(*para_id).or_default().push(wrapped);
|
||||
}
|
||||
|
||||
// Now iterate again, updating the heads as we go
|
||||
for (para_id, messages) in &horizontal_messages {
|
||||
let mut channel_mqc = MessageQueueChain::new(
|
||||
*self
|
||||
.xcm_config
|
||||
.starting_hrmp_mqc_heads
|
||||
.get(para_id)
|
||||
.unwrap_or(&relay_chain::Hash::default()),
|
||||
);
|
||||
for message in messages {
|
||||
channel_mqc.extend_hrmp(message);
|
||||
}
|
||||
sproof_builder.upsert_inbound_channel(*para_id).mqc_head = Some(channel_mqc.head());
|
||||
}
|
||||
|
||||
// Epoch is set equal to current para block / blocks per epoch
|
||||
sproof_builder.current_epoch = if self.para_blocks_per_relay_epoch == 0 {
|
||||
// do not divide by 0 => set epoch to para block number
|
||||
self.current_para_block.into()
|
||||
} else {
|
||||
(self.current_para_block / self.para_blocks_per_relay_epoch).into()
|
||||
};
|
||||
// Randomness is set by randomness generator
|
||||
sproof_builder.randomness =
|
||||
self.relay_randomness_config.generate_randomness(self.current_para_block.into());
|
||||
|
||||
if let Some(key_values) = &self.additional_key_values {
|
||||
sproof_builder.additional_key_values = key_values.clone()
|
||||
}
|
||||
|
||||
// Inject current para block head, if any
|
||||
sproof_builder.included_para_head = self.current_para_block_head.clone();
|
||||
|
||||
let (relay_parent_storage_root, proof) = sproof_builder.into_state_root_and_proof();
|
||||
let teyrchain_inherent_data = TeyrchainInherentData {
|
||||
validation_data: PersistedValidationData {
|
||||
parent_head: Default::default(),
|
||||
relay_parent_storage_root,
|
||||
relay_parent_number,
|
||||
max_pov_size: Default::default(),
|
||||
},
|
||||
downward_messages,
|
||||
horizontal_messages,
|
||||
relay_chain_state: proof,
|
||||
relay_parent_descendants: Default::default(),
|
||||
collator_peer_id: None,
|
||||
};
|
||||
|
||||
teyrchain_inherent_data.provide_inherent_data(inherent_data).await
|
||||
}
|
||||
|
||||
// Copied from the real implementation
|
||||
async fn try_handle_error(
|
||||
&self,
|
||||
_: &pezsp_inherents::InherentIdentifier,
|
||||
_: &[u8],
|
||||
) -> Option<Result<(), pezsp_inherents::Error>> {
|
||||
None
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user