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,60 @@
|
||||
[package]
|
||||
name = "pezsc-consensus-babe-rpc"
|
||||
version = "0.34.0"
|
||||
authors.workspace = true
|
||||
description = "RPC extensions for the BABE consensus algorithm"
|
||||
edition.workspace = true
|
||||
license = "GPL-3.0-or-later WITH Classpath-exception-2.0"
|
||||
homepage.workspace = true
|
||||
repository.workspace = true
|
||||
readme = "README.md"
|
||||
|
||||
[lints]
|
||||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
targets = ["x86_64-unknown-linux-gnu"]
|
||||
|
||||
[dependencies]
|
||||
futures = { workspace = true }
|
||||
jsonrpsee = { features = [
|
||||
"client-core",
|
||||
"macros",
|
||||
"server-core",
|
||||
], workspace = true }
|
||||
pezsc-consensus-babe = { workspace = true, default-features = true }
|
||||
pezsc-consensus-epochs = { workspace = true, default-features = true }
|
||||
pezsc-rpc-api = { workspace = true, default-features = true }
|
||||
serde = { features = ["derive"], workspace = true, default-features = true }
|
||||
pezsp-api = { workspace = true, default-features = true }
|
||||
pezsp-application-crypto = { workspace = true, default-features = true }
|
||||
pezsp-blockchain = { workspace = true, default-features = true }
|
||||
pezsp-consensus = { workspace = true, default-features = true }
|
||||
pezsp-consensus-babe = { workspace = true, default-features = true }
|
||||
pezsp-core = { workspace = true, default-features = true }
|
||||
pezsp-keystore = { workspace = true, default-features = true }
|
||||
pezsp-runtime = { workspace = true, default-features = true }
|
||||
thiserror = { workspace = true }
|
||||
|
||||
[dev-dependencies]
|
||||
pezsc-consensus = { workspace = true, default-features = true }
|
||||
pezsc-transaction-pool-api = { workspace = true, default-features = true }
|
||||
pezsp-keyring = { workspace = true, default-features = true }
|
||||
bizinikiwi-test-runtime-client = { workspace = true }
|
||||
tokio = { workspace = true, default-features = true }
|
||||
|
||||
[features]
|
||||
runtime-benchmarks = [
|
||||
"pezsc-consensus-babe/runtime-benchmarks",
|
||||
"pezsc-consensus-epochs/runtime-benchmarks",
|
||||
"pezsc-consensus/runtime-benchmarks",
|
||||
"pezsc-rpc-api/runtime-benchmarks",
|
||||
"pezsc-transaction-pool-api/runtime-benchmarks",
|
||||
"pezsp-api/runtime-benchmarks",
|
||||
"pezsp-blockchain/runtime-benchmarks",
|
||||
"pezsp-consensus-babe/runtime-benchmarks",
|
||||
"pezsp-consensus/runtime-benchmarks",
|
||||
"pezsp-keyring/runtime-benchmarks",
|
||||
"pezsp-runtime/runtime-benchmarks",
|
||||
"bizinikiwi-test-runtime-client/runtime-benchmarks",
|
||||
]
|
||||
@@ -0,0 +1,3 @@
|
||||
RPC api for babe.
|
||||
|
||||
License: GPL-3.0-or-later WITH Classpath-exception-2.0
|
||||
@@ -0,0 +1,282 @@
|
||||
// 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 babe.
|
||||
|
||||
use std::{collections::HashMap, sync::Arc};
|
||||
|
||||
use futures::TryFutureExt;
|
||||
use jsonrpsee::{
|
||||
core::async_trait,
|
||||
proc_macros::rpc,
|
||||
types::{ErrorObject, ErrorObjectOwned},
|
||||
Extensions,
|
||||
};
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
use pezsc_consensus_babe::{authorship, BabeWorkerHandle};
|
||||
use pezsc_consensus_epochs::Epoch as EpochT;
|
||||
use pezsc_rpc_api::{check_if_safe, UnsafeRpcError};
|
||||
use pezsp_api::ProvideRuntimeApi;
|
||||
use pezsp_application_crypto::AppCrypto;
|
||||
use pezsp_blockchain::{Error as BlockChainError, HeaderBackend, HeaderMetadata};
|
||||
use pezsp_consensus::{Error as ConsensusError, SelectChain};
|
||||
use pezsp_consensus_babe::{digests::PreDigest, AuthorityId, BabeApi as BabeRuntimeApi};
|
||||
use pezsp_core::crypto::ByteArray;
|
||||
use pezsp_keystore::KeystorePtr;
|
||||
use pezsp_runtime::traits::{Block as BlockT, Header as _};
|
||||
|
||||
const BABE_ERROR: i32 = 9000;
|
||||
|
||||
/// Provides rpc methods for interacting with Babe.
|
||||
#[rpc(client, server)]
|
||||
pub trait BabeApi {
|
||||
/// Returns data about which slots (primary or secondary) can be claimed in the current epoch
|
||||
/// with the keys in the keystore.
|
||||
#[method(name = "babe_epochAuthorship", with_extensions)]
|
||||
async fn epoch_authorship(&self) -> Result<HashMap<AuthorityId, EpochAuthorship>, Error>;
|
||||
}
|
||||
|
||||
/// Provides RPC methods for interacting with Babe.
|
||||
pub struct Babe<B: BlockT, C, SC> {
|
||||
/// shared reference to the client.
|
||||
client: Arc<C>,
|
||||
/// A handle to the BABE worker for issuing requests.
|
||||
babe_worker_handle: BabeWorkerHandle<B>,
|
||||
/// shared reference to the Keystore
|
||||
keystore: KeystorePtr,
|
||||
/// The SelectChain strategy
|
||||
select_chain: SC,
|
||||
}
|
||||
|
||||
impl<B: BlockT, C, SC> Babe<B, C, SC> {
|
||||
/// Creates a new instance of the Babe Rpc handler.
|
||||
pub fn new(
|
||||
client: Arc<C>,
|
||||
babe_worker_handle: BabeWorkerHandle<B>,
|
||||
keystore: KeystorePtr,
|
||||
select_chain: SC,
|
||||
) -> Self {
|
||||
Self { client, babe_worker_handle, keystore, select_chain }
|
||||
}
|
||||
}
|
||||
|
||||
#[async_trait]
|
||||
impl<B: BlockT, C, SC> BabeApiServer for Babe<B, C, SC>
|
||||
where
|
||||
B: BlockT,
|
||||
C: ProvideRuntimeApi<B>
|
||||
+ HeaderBackend<B>
|
||||
+ HeaderMetadata<B, Error = BlockChainError>
|
||||
+ 'static,
|
||||
C::Api: BabeRuntimeApi<B>,
|
||||
SC: SelectChain<B> + Clone + 'static,
|
||||
{
|
||||
async fn epoch_authorship(
|
||||
&self,
|
||||
ext: &Extensions,
|
||||
) -> Result<HashMap<AuthorityId, EpochAuthorship>, Error> {
|
||||
check_if_safe(ext)?;
|
||||
|
||||
let best_header = self.select_chain.best_chain().map_err(Error::SelectChain).await?;
|
||||
|
||||
let epoch_start = self
|
||||
.client
|
||||
.runtime_api()
|
||||
.current_epoch_start(best_header.hash())
|
||||
.map_err(|_| Error::FetchEpoch)?;
|
||||
|
||||
let epoch = self
|
||||
.babe_worker_handle
|
||||
.epoch_data_for_child_of(best_header.hash(), *best_header.number(), epoch_start)
|
||||
.await
|
||||
.map_err(|_| Error::FetchEpoch)?;
|
||||
|
||||
let (epoch_start, epoch_end) = (epoch.start_slot(), epoch.end_slot());
|
||||
let mut claims: HashMap<AuthorityId, EpochAuthorship> = HashMap::new();
|
||||
|
||||
let keys = {
|
||||
epoch
|
||||
.authorities
|
||||
.iter()
|
||||
.enumerate()
|
||||
.filter_map(|(i, a)| {
|
||||
if self.keystore.has_keys(&[(a.0.to_raw_vec(), AuthorityId::ID)]) {
|
||||
Some((a.0.clone(), i))
|
||||
} else {
|
||||
None
|
||||
}
|
||||
})
|
||||
.collect::<Vec<_>>()
|
||||
};
|
||||
|
||||
for slot in *epoch_start..*epoch_end {
|
||||
if let Some((claim, key)) =
|
||||
authorship::claim_slot_using_keys(slot.into(), &epoch, &self.keystore, &keys)
|
||||
{
|
||||
match claim {
|
||||
PreDigest::Primary { .. } => {
|
||||
claims.entry(key).or_default().primary.push(slot);
|
||||
},
|
||||
PreDigest::SecondaryPlain { .. } => {
|
||||
claims.entry(key).or_default().secondary.push(slot);
|
||||
},
|
||||
PreDigest::SecondaryVRF { .. } => {
|
||||
claims.entry(key).or_default().secondary_vrf.push(slot.into());
|
||||
},
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
Ok(claims)
|
||||
}
|
||||
}
|
||||
|
||||
/// Holds information about the `slot`'s that can be claimed by a given key.
|
||||
#[derive(Clone, Default, Debug, Deserialize, Serialize)]
|
||||
pub struct EpochAuthorship {
|
||||
/// the array of primary slots that can be claimed
|
||||
primary: Vec<u64>,
|
||||
/// the array of secondary slots that can be claimed
|
||||
secondary: Vec<u64>,
|
||||
/// The array of secondary VRF slots that can be claimed.
|
||||
secondary_vrf: Vec<u64>,
|
||||
}
|
||||
|
||||
/// Top-level error type for the RPC handler.
|
||||
#[derive(Debug, thiserror::Error)]
|
||||
pub enum Error {
|
||||
/// Failed to fetch the current best header.
|
||||
#[error("Failed to fetch the current best header: {0}")]
|
||||
SelectChain(ConsensusError),
|
||||
/// Failed to fetch epoch data.
|
||||
#[error("Failed to fetch epoch data")]
|
||||
FetchEpoch,
|
||||
/// Consensus error
|
||||
#[error(transparent)]
|
||||
Consensus(#[from] ConsensusError),
|
||||
/// Errors that can be formatted as a String
|
||||
#[error("{0}")]
|
||||
StringError(String),
|
||||
/// Call to an unsafe RPC was denied.
|
||||
#[error(transparent)]
|
||||
UnsafeRpcCalled(#[from] UnsafeRpcError),
|
||||
}
|
||||
|
||||
impl From<Error> for ErrorObjectOwned {
|
||||
fn from(error: Error) -> Self {
|
||||
match error {
|
||||
Error::SelectChain(e) => ErrorObject::owned(BABE_ERROR + 1, e.to_string(), None::<()>),
|
||||
Error::FetchEpoch => ErrorObject::owned(BABE_ERROR + 2, error.to_string(), None::<()>),
|
||||
Error::Consensus(e) => ErrorObject::owned(BABE_ERROR + 3, e.to_string(), None::<()>),
|
||||
Error::StringError(e) => ErrorObject::owned(BABE_ERROR + 4, e, None::<()>),
|
||||
Error::UnsafeRpcCalled(e) => e.into(),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use pezsc_consensus_babe::ImportQueueParams;
|
||||
use pezsc_rpc_api::DenyUnsafe;
|
||||
use pezsc_transaction_pool_api::{OffchainTransactionPoolFactory, RejectAllTxPool};
|
||||
use pezsp_consensus_babe::inherents::InherentDataProvider;
|
||||
use pezsp_core::{crypto::key_types::BABE, testing::TaskExecutor};
|
||||
use pezsp_keyring::Sr25519Keyring;
|
||||
use pezsp_keystore::{testing::MemoryKeystore, Keystore};
|
||||
use bizinikiwi_test_runtime_client::{
|
||||
runtime::Block, Backend, DefaultTestClientBuilderExt, TestClient, TestClientBuilder,
|
||||
TestClientBuilderExt,
|
||||
};
|
||||
|
||||
fn create_keystore(authority: Sr25519Keyring) -> KeystorePtr {
|
||||
let keystore = MemoryKeystore::new();
|
||||
keystore
|
||||
.sr25519_generate_new(BABE, Some(&authority.to_seed()))
|
||||
.expect("Creates authority key");
|
||||
keystore.into()
|
||||
}
|
||||
|
||||
fn test_babe_rpc_module() -> Babe<Block, TestClient, pezsc_consensus::LongestChain<Backend, Block>>
|
||||
{
|
||||
let builder = TestClientBuilder::new();
|
||||
let (client, longest_chain) = builder.build_with_longest_chain();
|
||||
let client = Arc::new(client);
|
||||
let task_executor = TaskExecutor::new();
|
||||
let keystore = create_keystore(Sr25519Keyring::Alice);
|
||||
|
||||
let config = pezsc_consensus_babe::configuration(&*client).expect("config available");
|
||||
let slot_duration = config.slot_duration();
|
||||
|
||||
let (block_import, link) = pezsc_consensus_babe::block_import(
|
||||
config.clone(),
|
||||
client.clone(),
|
||||
client.clone(),
|
||||
move |_, _| async move {
|
||||
Ok((InherentDataProvider::from_timestamp_and_slot_duration(
|
||||
0.into(),
|
||||
slot_duration,
|
||||
),))
|
||||
},
|
||||
longest_chain.clone(),
|
||||
OffchainTransactionPoolFactory::new(RejectAllTxPool::default()),
|
||||
)
|
||||
.expect("can initialize block-import");
|
||||
|
||||
let (_, babe_worker_handle) = pezsc_consensus_babe::import_queue(ImportQueueParams {
|
||||
link: link.clone(),
|
||||
block_import: block_import.clone(),
|
||||
justification_import: None,
|
||||
client: client.clone(),
|
||||
slot_duration,
|
||||
spawner: &task_executor,
|
||||
registry: None,
|
||||
telemetry: None,
|
||||
})
|
||||
.unwrap();
|
||||
|
||||
Babe::new(client.clone(), babe_worker_handle, keystore, longest_chain)
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn epoch_authorship_works() {
|
||||
let babe_rpc = test_babe_rpc_module();
|
||||
let mut api = babe_rpc.into_rpc();
|
||||
api.extensions_mut().insert(DenyUnsafe::No);
|
||||
|
||||
let request = r#"{"jsonrpc":"2.0","id":1,"method":"babe_epochAuthorship","params":[]}"#;
|
||||
let (response, _) = api.raw_json_request(request, 1).await.unwrap();
|
||||
let expected = r#"{"jsonrpc":"2.0","id":1,"result":{"5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY":{"primary":[0],"secondary":[],"secondary_vrf":[1,2,4]}}}"#;
|
||||
|
||||
assert_eq!(response, expected);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn epoch_authorship_is_unsafe() {
|
||||
let babe_rpc = test_babe_rpc_module();
|
||||
let mut api = babe_rpc.into_rpc();
|
||||
api.extensions_mut().insert(DenyUnsafe::Yes);
|
||||
|
||||
let request = r#"{"jsonrpc":"2.0","method":"babe_epochAuthorship","params":[],"id":1}"#;
|
||||
let (response, _) = api.raw_json_request(request, 1).await.unwrap();
|
||||
let expected = r#"{"jsonrpc":"2.0","id":1,"error":{"code":-32601,"message":"RPC call is unsafe to be called externally"}}"#;
|
||||
|
||||
assert_eq!(response, expected);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user