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,47 @@
|
||||
[package]
|
||||
name = "pezsc-consensus-beefy-rpc"
|
||||
version = "13.0.0"
|
||||
authors.workspace = true
|
||||
edition.workspace = true
|
||||
license = "GPL-3.0-or-later WITH Classpath-exception-2.0"
|
||||
repository.workspace = true
|
||||
description = "RPC for the BEEFY Client gadget for bizinikiwi"
|
||||
homepage.workspace = true
|
||||
|
||||
[lints]
|
||||
workspace = true
|
||||
|
||||
[dependencies]
|
||||
codec = { features = ["derive"], workspace = true, default-features = true }
|
||||
futures = { workspace = true }
|
||||
jsonrpsee = { features = [
|
||||
"client-core",
|
||||
"macros",
|
||||
"server-core",
|
||||
], workspace = true }
|
||||
log = { workspace = true, default-features = true }
|
||||
parking_lot = { workspace = true, default-features = true }
|
||||
pezsc-consensus-beefy = { workspace = true, default-features = true }
|
||||
pezsc-rpc = { workspace = true, default-features = true }
|
||||
serde = { features = ["derive"], workspace = true, default-features = true }
|
||||
pezsp-application-crypto = { workspace = true, default-features = true }
|
||||
pezsp-consensus-beefy = { workspace = true, default-features = true }
|
||||
pezsp-core = { workspace = true, default-features = true }
|
||||
pezsp-runtime = { workspace = true, default-features = true }
|
||||
thiserror = { workspace = true }
|
||||
|
||||
[dev-dependencies]
|
||||
pezsc-rpc = { features = [
|
||||
"test-helpers",
|
||||
], workspace = true, default-features = true }
|
||||
bizinikiwi-test-runtime-client = { workspace = true }
|
||||
tokio = { features = ["macros"], workspace = true, default-features = true }
|
||||
|
||||
[features]
|
||||
runtime-benchmarks = [
|
||||
"pezsc-consensus-beefy/runtime-benchmarks",
|
||||
"pezsc-rpc/runtime-benchmarks",
|
||||
"pezsp-consensus-beefy/runtime-benchmarks",
|
||||
"pezsp-runtime/runtime-benchmarks",
|
||||
"bizinikiwi-test-runtime-client/runtime-benchmarks",
|
||||
]
|
||||
@@ -0,0 +1,305 @@
|
||||
// This file is part of Bizinikiwi.
|
||||
|
||||
// Copyright (C) Parity Technologies (UK) Ltd.
|
||||
// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0
|
||||
|
||||
// This program 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.
|
||||
|
||||
// This program 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 this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
//! RPC API for BEEFY.
|
||||
|
||||
#![warn(missing_docs)]
|
||||
|
||||
use parking_lot::RwLock;
|
||||
use pezsp_consensus_beefy::AuthorityIdBound;
|
||||
use std::sync::Arc;
|
||||
|
||||
use pezsc_rpc::{
|
||||
utils::{BoundedVecDeque, PendingSubscription},
|
||||
SubscriptionTaskExecutor,
|
||||
};
|
||||
use pezsp_application_crypto::RuntimeAppPublic;
|
||||
use pezsp_runtime::traits::Block as BlockT;
|
||||
|
||||
use futures::{task::SpawnError, FutureExt, StreamExt};
|
||||
use jsonrpsee::{
|
||||
core::async_trait,
|
||||
proc_macros::rpc,
|
||||
types::{ErrorObject, ErrorObjectOwned},
|
||||
PendingSubscriptionSink,
|
||||
};
|
||||
use log::warn;
|
||||
|
||||
use pezsc_consensus_beefy::communication::notification::{
|
||||
BeefyBestBlockStream, BeefyVersionedFinalityProofStream,
|
||||
};
|
||||
|
||||
mod notification;
|
||||
|
||||
#[derive(Debug, thiserror::Error)]
|
||||
/// Top-level error type for the RPC handler
|
||||
pub enum Error {
|
||||
/// The BEEFY RPC endpoint is not ready.
|
||||
#[error("BEEFY RPC endpoint not ready")]
|
||||
EndpointNotReady,
|
||||
/// The BEEFY RPC background task failed to spawn.
|
||||
#[error("BEEFY RPC background task failed to spawn")]
|
||||
RpcTaskFailure(#[from] SpawnError),
|
||||
}
|
||||
|
||||
/// The error codes returned by jsonrpc.
|
||||
pub enum ErrorCode {
|
||||
/// Returned when BEEFY RPC endpoint is not ready.
|
||||
NotReady = 1,
|
||||
/// Returned on BEEFY RPC background task failure.
|
||||
TaskFailure = 2,
|
||||
}
|
||||
|
||||
impl From<Error> for ErrorCode {
|
||||
fn from(error: Error) -> Self {
|
||||
match error {
|
||||
Error::EndpointNotReady => ErrorCode::NotReady,
|
||||
Error::RpcTaskFailure(_) => ErrorCode::TaskFailure,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl From<Error> for ErrorObjectOwned {
|
||||
fn from(error: Error) -> Self {
|
||||
let message = error.to_string();
|
||||
let code = ErrorCode::from(error);
|
||||
ErrorObject::owned(code as i32, message, None::<()>)
|
||||
}
|
||||
}
|
||||
|
||||
// Provides RPC methods for interacting with BEEFY.
|
||||
#[rpc(client, server)]
|
||||
pub trait BeefyApi<Notification, Hash> {
|
||||
/// Returns the block most recently finalized by BEEFY, alongside its justification.
|
||||
#[subscription(
|
||||
name = "beefy_subscribeJustifications" => "beefy_justifications",
|
||||
unsubscribe = "beefy_unsubscribeJustifications",
|
||||
item = Notification,
|
||||
)]
|
||||
fn subscribe_justifications(&self);
|
||||
|
||||
/// Returns hash of the latest BEEFY finalized block as seen by this client.
|
||||
///
|
||||
/// The latest BEEFY block might not be available if the BEEFY gadget is not running
|
||||
/// in the network or if the client is still initializing or syncing with the network.
|
||||
/// In such case an error would be returned.
|
||||
#[method(name = "beefy_getFinalizedHead")]
|
||||
async fn latest_finalized(&self) -> Result<Hash, Error>;
|
||||
}
|
||||
|
||||
/// Implements the BeefyApi RPC trait for interacting with BEEFY.
|
||||
pub struct Beefy<Block: BlockT, AuthorityId: AuthorityIdBound> {
|
||||
finality_proof_stream: BeefyVersionedFinalityProofStream<Block, AuthorityId>,
|
||||
beefy_best_block: Arc<RwLock<Option<Block::Hash>>>,
|
||||
executor: SubscriptionTaskExecutor,
|
||||
}
|
||||
|
||||
impl<Block, AuthorityId> Beefy<Block, AuthorityId>
|
||||
where
|
||||
Block: BlockT,
|
||||
AuthorityId: AuthorityIdBound,
|
||||
{
|
||||
/// Creates a new Beefy Rpc handler instance.
|
||||
pub fn new(
|
||||
finality_proof_stream: BeefyVersionedFinalityProofStream<Block, AuthorityId>,
|
||||
best_block_stream: BeefyBestBlockStream<Block>,
|
||||
executor: SubscriptionTaskExecutor,
|
||||
) -> Result<Self, Error> {
|
||||
let beefy_best_block = Arc::new(RwLock::new(None));
|
||||
|
||||
let stream = best_block_stream.subscribe(100_000);
|
||||
let closure_clone = beefy_best_block.clone();
|
||||
let future = stream.for_each(move |best_beefy| {
|
||||
let async_clone = closure_clone.clone();
|
||||
async move { *async_clone.write() = Some(best_beefy) }
|
||||
});
|
||||
|
||||
executor.spawn("bizinikiwi-rpc-subscription", Some("rpc"), future.map(drop).boxed());
|
||||
Ok(Self { finality_proof_stream, beefy_best_block, executor })
|
||||
}
|
||||
}
|
||||
|
||||
#[async_trait]
|
||||
impl<Block, AuthorityId> BeefyApiServer<notification::EncodedVersionedFinalityProof, Block::Hash>
|
||||
for Beefy<Block, AuthorityId>
|
||||
where
|
||||
Block: BlockT,
|
||||
AuthorityId: AuthorityIdBound,
|
||||
<AuthorityId as RuntimeAppPublic>::Signature: Send + Sync,
|
||||
{
|
||||
fn subscribe_justifications(&self, pending: PendingSubscriptionSink) {
|
||||
let stream = self
|
||||
.finality_proof_stream
|
||||
.subscribe(100_000)
|
||||
.map(|vfp| notification::EncodedVersionedFinalityProof::new::<Block, AuthorityId>(vfp));
|
||||
|
||||
pezsc_rpc::utils::spawn_subscription_task(
|
||||
&self.executor,
|
||||
PendingSubscription::from(pending).pipe_from_stream(stream, BoundedVecDeque::default()),
|
||||
);
|
||||
}
|
||||
|
||||
async fn latest_finalized(&self) -> Result<Block::Hash, Error> {
|
||||
self.beefy_best_block.read().as_ref().cloned().ok_or(Error::EndpointNotReady)
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
use codec::{Decode, Encode};
|
||||
use jsonrpsee::{core::EmptyServerParams as EmptyParams, RpcModule};
|
||||
use pezsc_consensus_beefy::{
|
||||
communication::notification::BeefyVersionedFinalityProofSender,
|
||||
justification::BeefyVersionedFinalityProof,
|
||||
};
|
||||
use pezsp_consensus_beefy::{ecdsa_crypto, known_payloads, Payload, SignedCommitment};
|
||||
use pezsp_runtime::traits::{BlakeTwo256, Hash};
|
||||
use bizinikiwi_test_runtime_client::runtime::Block;
|
||||
|
||||
fn setup_io_handler() -> (
|
||||
RpcModule<Beefy<Block, ecdsa_crypto::AuthorityId>>,
|
||||
BeefyVersionedFinalityProofSender<Block, ecdsa_crypto::AuthorityId>,
|
||||
) {
|
||||
let (_, stream) = BeefyBestBlockStream::<Block>::channel();
|
||||
setup_io_handler_with_best_block_stream(stream)
|
||||
}
|
||||
|
||||
fn setup_io_handler_with_best_block_stream(
|
||||
best_block_stream: BeefyBestBlockStream<Block>,
|
||||
) -> (
|
||||
RpcModule<Beefy<Block, ecdsa_crypto::AuthorityId>>,
|
||||
BeefyVersionedFinalityProofSender<Block, ecdsa_crypto::AuthorityId>,
|
||||
) {
|
||||
let (finality_proof_sender, finality_proof_stream) =
|
||||
BeefyVersionedFinalityProofStream::<Block, ecdsa_crypto::AuthorityId>::channel();
|
||||
|
||||
let handler =
|
||||
Beefy::new(finality_proof_stream, best_block_stream, pezsc_rpc::testing::test_executor())
|
||||
.expect("Setting up the BEEFY RPC handler works");
|
||||
|
||||
(handler.into_rpc(), finality_proof_sender)
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn uninitialized_rpc_handler() {
|
||||
let (rpc, _) = setup_io_handler();
|
||||
let request = r#"{"jsonrpc":"2.0","method":"beefy_getFinalizedHead","params":[],"id":1}"#;
|
||||
let expected_response = r#"{"jsonrpc":"2.0","id":1,"error":{"code":1,"message":"BEEFY RPC endpoint not ready"}}"#;
|
||||
let (response, _) = rpc.raw_json_request(&request, 1).await.unwrap();
|
||||
|
||||
assert_eq!(expected_response, response);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn latest_finalized_rpc() {
|
||||
let (sender, stream) = BeefyBestBlockStream::<Block>::channel();
|
||||
let (io, _) = setup_io_handler_with_best_block_stream(stream);
|
||||
|
||||
let hash = BlakeTwo256::hash(b"42");
|
||||
let r: Result<(), ()> = sender.notify(|| Ok(hash));
|
||||
r.unwrap();
|
||||
|
||||
// Verify RPC `beefy_getFinalizedHead` returns expected hash.
|
||||
let request = r#"{"jsonrpc":"2.0","method":"beefy_getFinalizedHead","params":[],"id":1}"#;
|
||||
let expected = "{\
|
||||
\"jsonrpc\":\"2.0\",\
|
||||
\"id\":1,\
|
||||
\"result\":\"0x2f0039e93a27221fcf657fb877a1d4f60307106113e885096cb44a461cd0afbf\"\
|
||||
}";
|
||||
let not_ready: &str = "{\
|
||||
\"jsonrpc\":\"2.0\",\
|
||||
\"id\":1,\
|
||||
\"error\":{\"code\":1,\"message\":\"BEEFY RPC endpoint not ready\"}\
|
||||
}";
|
||||
|
||||
let deadline = std::time::Instant::now() + std::time::Duration::from_secs(2);
|
||||
while std::time::Instant::now() < deadline {
|
||||
let (response, _) = io.raw_json_request(request, 1).await.expect("RPC requests work");
|
||||
if response != not_ready {
|
||||
assert_eq!(response, expected);
|
||||
// Success
|
||||
return;
|
||||
}
|
||||
tokio::time::sleep(std::time::Duration::from_millis(50)).await;
|
||||
}
|
||||
|
||||
panic!(
|
||||
"Deadline reached while waiting for best BEEFY block to update. Perhaps the background task is broken?"
|
||||
);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn subscribe_and_unsubscribe_with_wrong_id() {
|
||||
let (rpc, _) = setup_io_handler();
|
||||
// Subscribe call.
|
||||
let _sub = rpc
|
||||
.subscribe_unbounded("beefy_subscribeJustifications", EmptyParams::new())
|
||||
.await
|
||||
.unwrap();
|
||||
|
||||
// Unsubscribe with wrong ID
|
||||
let (response, _) = rpc
|
||||
.raw_json_request(
|
||||
r#"{"jsonrpc":"2.0","method":"beefy_unsubscribeJustifications","params":["FOO"],"id":1}"#,
|
||||
1,
|
||||
)
|
||||
.await
|
||||
.unwrap();
|
||||
let expected = r#"{"jsonrpc":"2.0","id":1,"result":false}"#;
|
||||
|
||||
assert_eq!(response, expected);
|
||||
}
|
||||
|
||||
fn create_finality_proof() -> BeefyVersionedFinalityProof<Block, ecdsa_crypto::AuthorityId> {
|
||||
let payload =
|
||||
Payload::from_single_entry(known_payloads::MMR_ROOT_ID, "Hello World!".encode());
|
||||
BeefyVersionedFinalityProof::<Block, ecdsa_crypto::AuthorityId>::V1(SignedCommitment {
|
||||
commitment: pezsp_consensus_beefy::Commitment {
|
||||
payload,
|
||||
block_number: 5,
|
||||
validator_set_id: 0,
|
||||
},
|
||||
signatures: vec![],
|
||||
})
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn subscribe_and_listen_to_one_justification() {
|
||||
let (rpc, finality_proof_sender) = setup_io_handler();
|
||||
|
||||
// Subscribe
|
||||
let mut sub = rpc
|
||||
.subscribe_unbounded("beefy_subscribeJustifications", EmptyParams::new())
|
||||
.await
|
||||
.unwrap();
|
||||
|
||||
// Notify with finality_proof
|
||||
let finality_proof = create_finality_proof();
|
||||
let r: Result<(), ()> = finality_proof_sender.notify(|| Ok(finality_proof.clone()));
|
||||
r.unwrap();
|
||||
|
||||
// Inspect what we received
|
||||
let (bytes, recv_sub_id) = sub.next::<pezsp_core::Bytes>().await.unwrap().unwrap();
|
||||
let recv_finality_proof: BeefyVersionedFinalityProof<Block, ecdsa_crypto::AuthorityId> =
|
||||
Decode::decode(&mut &bytes[..]).unwrap();
|
||||
assert_eq!(&recv_sub_id, sub.subscription_id());
|
||||
assert_eq!(recv_finality_proof, finality_proof);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,44 @@
|
||||
// This file is part of Bizinikiwi.
|
||||
|
||||
// Copyright (C) Parity Technologies (UK) Ltd.
|
||||
// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0
|
||||
|
||||
// This program 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.
|
||||
|
||||
// This program 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 this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
use codec::Encode;
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
use pezsp_consensus_beefy::AuthorityIdBound;
|
||||
use pezsp_runtime::traits::Block as BlockT;
|
||||
|
||||
/// An encoded finality proof proving that the given header has been finalized.
|
||||
/// The given bytes should be the SCALE-encoded representation of a
|
||||
/// `pezsp_consensus_beefy::VersionedFinalityProof`.
|
||||
#[derive(Clone, Serialize, Deserialize)]
|
||||
pub struct EncodedVersionedFinalityProof(pezsp_core::Bytes);
|
||||
|
||||
impl EncodedVersionedFinalityProof {
|
||||
pub fn new<Block, AuthorityId>(
|
||||
finality_proof: pezsc_consensus_beefy::justification::BeefyVersionedFinalityProof<
|
||||
Block,
|
||||
AuthorityId,
|
||||
>,
|
||||
) -> Self
|
||||
where
|
||||
Block: BlockT,
|
||||
AuthorityId: AuthorityIdBound,
|
||||
{
|
||||
EncodedVersionedFinalityProof(finality_proof.encode().into())
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user