pezkuwichain
379cb741ed
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.
77 lines
3.0 KiB
Rust
77 lines
3.0 KiB
Rust
// Copyright (C) Parity Technologies (UK) Ltd.
|
|
// This file is part of Bizinikiwi.
|
|
// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0
|
|
|
|
// Bizinikiwi 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.
|
|
|
|
// Bizinikiwi 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 Bizinikiwi. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
//! Block relay protocol related definitions.
|
|
|
|
use futures::channel::oneshot;
|
|
use pezsc_network::{request_responses::RequestFailure, NetworkBackend, ProtocolName};
|
|
use pezsc_network_common::sync::message::{BlockData, BlockRequest};
|
|
use pezsc_network_types::PeerId;
|
|
use pezsp_runtime::traits::Block as BlockT;
|
|
use std::{fmt, sync::Arc};
|
|
|
|
/// The serving side of the block relay protocol. It runs a single instance
|
|
/// of the server task that processes the incoming protocol messages.
|
|
#[async_trait::async_trait]
|
|
pub trait BlockServer<Block: BlockT>: Send {
|
|
/// Starts the protocol processing.
|
|
async fn run(&mut self);
|
|
}
|
|
|
|
/// The client side stub to download blocks from peers. This is a handle
|
|
/// that can be used to initiate concurrent downloads.
|
|
#[async_trait::async_trait]
|
|
pub trait BlockDownloader<Block: BlockT>: fmt::Debug + Send + Sync {
|
|
/// Protocol name used by block downloader.
|
|
fn protocol_name(&self) -> &ProtocolName;
|
|
|
|
/// Performs the protocol specific sequence to fetch the blocks from the peer.
|
|
/// Output: if the download succeeds, the response is a `Vec<u8>` which is
|
|
/// in a format specific to the protocol implementation. The block data
|
|
/// can be extracted from this response using [`BlockDownloader::block_response_into_blocks`].
|
|
async fn download_blocks(
|
|
&self,
|
|
who: PeerId,
|
|
request: BlockRequest<Block>,
|
|
) -> Result<Result<(Vec<u8>, ProtocolName), RequestFailure>, oneshot::Canceled>;
|
|
|
|
/// Parses the protocol specific response to retrieve the block data.
|
|
fn block_response_into_blocks(
|
|
&self,
|
|
request: &BlockRequest<Block>,
|
|
response: Vec<u8>,
|
|
) -> Result<Vec<BlockData<Block>>, BlockResponseError>;
|
|
}
|
|
|
|
/// Errors returned by [`BlockDownloader::block_response_into_blocks`].
|
|
#[derive(Debug)]
|
|
pub enum BlockResponseError {
|
|
/// Failed to decode the response bytes.
|
|
DecodeFailed(String),
|
|
|
|
/// Failed to extract the blocks from the decoded bytes.
|
|
ExtractionFailed(String),
|
|
}
|
|
|
|
/// Block relay specific params for network creation, specified in
|
|
/// ['pezsc_service::BuildNetworkParams'].
|
|
pub struct BlockRelayParams<Block: BlockT, N: NetworkBackend<Block, <Block as BlockT>::Hash>> {
|
|
pub server: Box<dyn BlockServer<Block>>,
|
|
pub downloader: Arc<dyn BlockDownloader<Block>>,
|
|
pub request_response_config: N::RequestResponseProtocolConfig,
|
|
}
|