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,402 @@
|
||||
// This file is part of Bizinikiwi.
|
||||
|
||||
// Copyright (C) Parity Technologies (UK) Ltd.
|
||||
// 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.
|
||||
|
||||
#![warn(missing_docs)]
|
||||
#![warn(unused_crate_dependencies)]
|
||||
|
||||
//! Node-specific RPC methods for interaction with Merkle Mountain Range pallet.
|
||||
|
||||
use std::{marker::PhantomData, sync::Arc};
|
||||
|
||||
use codec::{Codec, Decode, Encode};
|
||||
use jsonrpsee::{
|
||||
core::{async_trait, RpcResult},
|
||||
proc_macros::rpc,
|
||||
types::{error::ErrorObject, ErrorObjectOwned},
|
||||
};
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
use pezsp_api::{ApiExt, ProvideRuntimeApi};
|
||||
use pezsp_blockchain::HeaderBackend;
|
||||
use pezsp_core::{
|
||||
offchain::{storage::OffchainDb, OffchainDbExt, OffchainStorage},
|
||||
Bytes,
|
||||
};
|
||||
use pezsp_mmr_primitives::{AncestryProof as MmrAncestryProof, Error as MmrError, LeafProof};
|
||||
use pezsp_runtime::traits::{Block as BlockT, NumberFor};
|
||||
|
||||
pub use pezsp_mmr_primitives::MmrApi as MmrRuntimeApi;
|
||||
|
||||
const RUNTIME_ERROR: i32 = 8000;
|
||||
const MMR_ERROR: i32 = 8010;
|
||||
|
||||
/// Retrieved MMR leaves and their proof.
|
||||
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct LeavesProof<BlockHash> {
|
||||
/// Block hash the proof was generated for.
|
||||
pub block_hash: BlockHash,
|
||||
/// SCALE-encoded vector of `LeafData`.
|
||||
pub leaves: Bytes,
|
||||
/// SCALE-encoded proof data. See [pezsp_mmr_primitives::LeafProof].
|
||||
pub proof: Bytes,
|
||||
}
|
||||
|
||||
impl<BlockHash> LeavesProof<BlockHash> {
|
||||
/// Create new `LeavesProof` from a given vector of `Leaf` and a
|
||||
/// [pezsp_mmr_primitives::LeafProof].
|
||||
pub fn new<Leaf, MmrHash>(
|
||||
block_hash: BlockHash,
|
||||
leaves: Vec<Leaf>,
|
||||
proof: LeafProof<MmrHash>,
|
||||
) -> Self
|
||||
where
|
||||
Leaf: Encode,
|
||||
MmrHash: Encode,
|
||||
{
|
||||
Self { block_hash, leaves: Bytes(leaves.encode()), proof: Bytes(proof.encode()) }
|
||||
}
|
||||
}
|
||||
|
||||
/// MMR RPC methods.
|
||||
#[rpc(client, server)]
|
||||
pub trait MmrApi<BlockHash, BlockNumber, MmrHash> {
|
||||
/// Get the MMR root hash for the current best block.
|
||||
#[method(name = "mmr_root")]
|
||||
fn mmr_root(&self, at: Option<BlockHash>) -> RpcResult<MmrHash>;
|
||||
|
||||
/// Generate an MMR proof for the given `block_numbers`.
|
||||
///
|
||||
/// This method calls into a runtime with MMR pallet included and attempts to generate
|
||||
/// an MMR proof for the set of blocks that have the given `block_numbers` with the MMR root at
|
||||
/// `best_known_block_number`. `best_known_block_number` must be larger than all the
|
||||
/// `block_numbers` for the function to succeed.
|
||||
///
|
||||
/// Optionally via `at`, a block hash at which the runtime should be queried can be specified.
|
||||
/// Optionally via `best_known_block_number`, the proof can be generated using the MMR's state
|
||||
/// at a specific best block. Note that if `best_known_block_number` is provided, then also
|
||||
/// specifying the block hash via `at` isn't super-useful here, unless you're generating proof
|
||||
/// using non-finalized blocks where there are several competing forks. That's because MMR state
|
||||
/// will be fixed to the state with `best_known_block_number`, which already points to
|
||||
/// some historical block.
|
||||
///
|
||||
/// Returns the (full) leaves and a proof for these leaves (compact encoding, i.e. hash of
|
||||
/// the leaves). Both parameters are SCALE-encoded.
|
||||
/// The order of entries in the `leaves` field of the returned struct
|
||||
/// is the same as the order of the entries in `block_numbers` supplied
|
||||
#[method(name = "mmr_generateProof")]
|
||||
fn generate_proof(
|
||||
&self,
|
||||
block_numbers: Vec<BlockNumber>,
|
||||
best_known_block_number: Option<BlockNumber>,
|
||||
at: Option<BlockHash>,
|
||||
) -> RpcResult<LeavesProof<BlockHash>>;
|
||||
|
||||
/// Generate an MMR ancestry proof for the given `prev_block_number`.
|
||||
///
|
||||
/// This method calls into a runtime with MMR pallet included and attempts to generate
|
||||
/// an MMR ancestry proof for the MMR root at the prior block with number `prev_block_number`,
|
||||
/// with the reference MMR root at `best_known_block_number`. `best_known_block_number` must be
|
||||
/// larger than the `prev_block_number` for the function to succeed.
|
||||
///
|
||||
/// Optionally via `at`, a block hash at which the runtime should be queried can be specified.
|
||||
/// Optionally via `best_known_block_number`, the proof can be generated using the MMR's state
|
||||
/// at a specific best block. Note that if `best_known_block_number` is provided, then also
|
||||
/// specifying the block hash via `at` isn't super-useful here, unless you're generating proof
|
||||
/// using non-finalized blocks where there are several competing forks. That's because MMR state
|
||||
/// will be fixed to the state with `best_known_block_number`, which already points to
|
||||
/// some historical block.
|
||||
///
|
||||
/// Returns the SCALE-encoded ancestry proof for the prior block's MMR root against the MMR root
|
||||
/// of the best block specified. The order of entries in the `leaves` field of the returned
|
||||
/// struct is the same as the order of the entries in `block_numbers` supplied
|
||||
#[method(name = "mmr_generateAncestryProof")]
|
||||
fn generate_ancestry_proof(
|
||||
&self,
|
||||
prev_block_number: BlockNumber,
|
||||
best_known_block_number: Option<BlockNumber>,
|
||||
at: Option<BlockHash>,
|
||||
) -> RpcResult<MmrAncestryProof<MmrHash>>;
|
||||
|
||||
/// Verify an MMR `proof`.
|
||||
///
|
||||
/// This method calls into a runtime with MMR pallet included and attempts to verify
|
||||
/// an MMR proof.
|
||||
///
|
||||
/// Returns `true` if the proof is valid, else returns the verification error.
|
||||
#[method(name = "mmr_verifyProof")]
|
||||
fn verify_proof(&self, proof: LeavesProof<BlockHash>) -> RpcResult<bool>;
|
||||
|
||||
/// Verify an MMR `proof` statelessly given an `mmr_root`.
|
||||
///
|
||||
/// This method calls into a runtime with MMR pallet included and attempts to verify
|
||||
/// an MMR proof against a provided MMR root.
|
||||
///
|
||||
/// Returns `true` if the proof is valid, else returns the verification error.
|
||||
#[method(name = "mmr_verifyProofStateless")]
|
||||
fn verify_proof_stateless(
|
||||
&self,
|
||||
mmr_root: MmrHash,
|
||||
proof: LeavesProof<BlockHash>,
|
||||
) -> RpcResult<bool>;
|
||||
}
|
||||
|
||||
/// MMR RPC methods.
|
||||
pub struct Mmr<Client, Block, S> {
|
||||
client: Arc<Client>,
|
||||
offchain_db: OffchainDb<S>,
|
||||
_marker: PhantomData<Block>,
|
||||
}
|
||||
|
||||
impl<C, B, S> Mmr<C, B, S> {
|
||||
/// Create new `Mmr` with the given reference to the client.
|
||||
pub fn new(client: Arc<C>, offchain_storage: S) -> Self {
|
||||
Self { client, _marker: Default::default(), offchain_db: OffchainDb::new(offchain_storage) }
|
||||
}
|
||||
}
|
||||
|
||||
#[async_trait]
|
||||
impl<Client, Block, MmrHash, S> MmrApiServer<<Block as BlockT>::Hash, NumberFor<Block>, MmrHash>
|
||||
for Mmr<Client, (Block, MmrHash), S>
|
||||
where
|
||||
Block: BlockT,
|
||||
Client: Send + Sync + 'static + ProvideRuntimeApi<Block> + HeaderBackend<Block>,
|
||||
Client::Api: MmrRuntimeApi<Block, MmrHash, NumberFor<Block>>,
|
||||
MmrHash: Codec + Send + Sync + 'static,
|
||||
S: OffchainStorage + 'static,
|
||||
{
|
||||
fn mmr_root(&self, at: Option<<Block as BlockT>::Hash>) -> RpcResult<MmrHash> {
|
||||
let block_hash = at.unwrap_or_else(||
|
||||
// If the block hash is not supplied assume the best block.
|
||||
self.client.info().best_hash);
|
||||
let api = self.client.runtime_api();
|
||||
let mmr_root = api
|
||||
.mmr_root(block_hash)
|
||||
.map_err(runtime_error_into_rpc_error)?
|
||||
.map_err(mmr_error_into_rpc_error)?;
|
||||
Ok(mmr_root)
|
||||
}
|
||||
|
||||
fn generate_proof(
|
||||
&self,
|
||||
block_numbers: Vec<NumberFor<Block>>,
|
||||
best_known_block_number: Option<NumberFor<Block>>,
|
||||
at: Option<<Block as BlockT>::Hash>,
|
||||
) -> RpcResult<LeavesProof<<Block as BlockT>::Hash>> {
|
||||
let mut api = self.client.runtime_api();
|
||||
let block_hash = at.unwrap_or_else(||
|
||||
// If the block hash is not supplied assume the best block.
|
||||
self.client.info().best_hash);
|
||||
|
||||
api.register_extension(OffchainDbExt::new(self.offchain_db.clone()));
|
||||
|
||||
let (leaves, proof) = api
|
||||
.generate_proof(block_hash, block_numbers, best_known_block_number)
|
||||
.map_err(runtime_error_into_rpc_error)?
|
||||
.map_err(mmr_error_into_rpc_error)?;
|
||||
|
||||
Ok(LeavesProof::new(block_hash, leaves, proof))
|
||||
}
|
||||
|
||||
fn generate_ancestry_proof(
|
||||
&self,
|
||||
prev_block_number: NumberFor<Block>,
|
||||
best_known_block_number: Option<NumberFor<Block>>,
|
||||
at: Option<<Block as BlockT>::Hash>,
|
||||
) -> RpcResult<MmrAncestryProof<MmrHash>> {
|
||||
let mut api = self.client.runtime_api();
|
||||
let block_hash = at.unwrap_or_else(||
|
||||
// If the block hash is not supplied assume the best block.
|
||||
self.client.info().best_hash);
|
||||
|
||||
api.register_extension(OffchainDbExt::new(self.offchain_db.clone()));
|
||||
|
||||
let proof = api
|
||||
.generate_ancestry_proof(block_hash, prev_block_number, best_known_block_number)
|
||||
.map_err(runtime_error_into_rpc_error)?
|
||||
.map_err(mmr_error_into_rpc_error)?;
|
||||
|
||||
Ok(proof)
|
||||
}
|
||||
|
||||
fn verify_proof(&self, proof: LeavesProof<<Block as BlockT>::Hash>) -> RpcResult<bool> {
|
||||
let mut api = self.client.runtime_api();
|
||||
|
||||
let leaves = Decode::decode(&mut &proof.leaves.0[..]).map_err(invalid_params)?;
|
||||
|
||||
let decoded_proof = Decode::decode(&mut &proof.proof.0[..]).map_err(invalid_params)?;
|
||||
|
||||
api.register_extension(OffchainDbExt::new(self.offchain_db.clone()));
|
||||
|
||||
api.verify_proof(proof.block_hash, leaves, decoded_proof)
|
||||
.map_err(runtime_error_into_rpc_error)?
|
||||
.map_err(mmr_error_into_rpc_error)?;
|
||||
|
||||
Ok(true)
|
||||
}
|
||||
|
||||
fn verify_proof_stateless(
|
||||
&self,
|
||||
mmr_root: MmrHash,
|
||||
proof: LeavesProof<<Block as BlockT>::Hash>,
|
||||
) -> RpcResult<bool> {
|
||||
let api = self.client.runtime_api();
|
||||
|
||||
let leaves = Decode::decode(&mut &proof.leaves.0[..]).map_err(invalid_params)?;
|
||||
|
||||
let decoded_proof = Decode::decode(&mut &proof.proof.0[..]).map_err(invalid_params)?;
|
||||
|
||||
api.verify_proof_stateless(proof.block_hash, mmr_root, leaves, decoded_proof)
|
||||
.map_err(runtime_error_into_rpc_error)?
|
||||
.map_err(mmr_error_into_rpc_error)?;
|
||||
|
||||
Ok(true)
|
||||
}
|
||||
}
|
||||
|
||||
/// Converts an mmr-specific error into a [`CallError`].
|
||||
fn mmr_error_into_rpc_error(err: MmrError) -> ErrorObjectOwned {
|
||||
let error_code = MMR_ERROR +
|
||||
match err {
|
||||
MmrError::LeafNotFound => 1,
|
||||
MmrError::GenerateProof => 2,
|
||||
MmrError::Verify => 3,
|
||||
MmrError::InvalidNumericOp => 4,
|
||||
MmrError::InvalidBestKnownBlock => 5,
|
||||
_ => 0,
|
||||
};
|
||||
|
||||
ErrorObject::owned(error_code, err.to_string(), Some(format!("{:?}", err)))
|
||||
}
|
||||
|
||||
/// Converts a runtime trap into a [`CallError`].
|
||||
fn runtime_error_into_rpc_error(err: impl std::fmt::Debug) -> ErrorObjectOwned {
|
||||
ErrorObject::owned(RUNTIME_ERROR, "Runtime trapped", Some(format!("{:?}", err)))
|
||||
}
|
||||
|
||||
fn invalid_params(e: impl std::error::Error) -> ErrorObjectOwned {
|
||||
ErrorObject::owned(
|
||||
jsonrpsee::types::error::ErrorCode::InvalidParams.code(),
|
||||
e.to_string(),
|
||||
None::<()>,
|
||||
)
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use pezsp_core::H256;
|
||||
|
||||
#[test]
|
||||
fn should_serialize_leaf_proof() {
|
||||
// given
|
||||
let leaf = vec![1_u8, 2, 3, 4];
|
||||
let proof = LeafProof {
|
||||
leaf_indices: vec![1],
|
||||
leaf_count: 9,
|
||||
items: vec![H256::repeat_byte(1), H256::repeat_byte(2)],
|
||||
};
|
||||
|
||||
let leaf_proof = LeavesProof::new(H256::repeat_byte(0), vec![leaf], proof);
|
||||
|
||||
// when
|
||||
let actual = serde_json::to_string(&leaf_proof).unwrap();
|
||||
|
||||
// then
|
||||
assert_eq!(
|
||||
actual,
|
||||
r#"{"blockHash":"0x0000000000000000000000000000000000000000000000000000000000000000","leaves":"0x041001020304","proof":"0x04010000000000000009000000000000000801010101010101010101010101010101010101010101010101010101010101010202020202020202020202020202020202020202020202020202020202020202"}"#
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn should_serialize_leaves_proof() {
|
||||
// given
|
||||
let leaf_a = vec![1_u8, 2, 3, 4];
|
||||
let leaf_b = vec![2_u8, 2, 3, 4];
|
||||
let proof = LeafProof {
|
||||
leaf_indices: vec![1, 2],
|
||||
leaf_count: 9,
|
||||
items: vec![H256::repeat_byte(1), H256::repeat_byte(2)],
|
||||
};
|
||||
|
||||
let leaf_proof = LeavesProof::new(H256::repeat_byte(0), vec![leaf_a, leaf_b], proof);
|
||||
|
||||
// when
|
||||
let actual = serde_json::to_string(&leaf_proof).unwrap();
|
||||
|
||||
// then
|
||||
assert_eq!(
|
||||
actual,
|
||||
r#"{"blockHash":"0x0000000000000000000000000000000000000000000000000000000000000000","leaves":"0x0810010203041002020304","proof":"0x080100000000000000020000000000000009000000000000000801010101010101010101010101010101010101010101010101010101010101010202020202020202020202020202020202020202020202020202020202020202"}"#
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn should_deserialize_leaf_proof() {
|
||||
// given
|
||||
let expected = LeavesProof {
|
||||
block_hash: H256::repeat_byte(0),
|
||||
leaves: Bytes(vec![vec![1_u8, 2, 3, 4]].encode()),
|
||||
proof: Bytes(
|
||||
LeafProof {
|
||||
leaf_indices: vec![1],
|
||||
leaf_count: 9,
|
||||
items: vec![H256::repeat_byte(1), H256::repeat_byte(2)],
|
||||
}
|
||||
.encode(),
|
||||
),
|
||||
};
|
||||
|
||||
// when
|
||||
let actual: LeavesProof<H256> = serde_json::from_str(r#"{
|
||||
"blockHash":"0x0000000000000000000000000000000000000000000000000000000000000000",
|
||||
"leaves":"0x041001020304",
|
||||
"proof":"0x04010000000000000009000000000000000801010101010101010101010101010101010101010101010101010101010101010202020202020202020202020202020202020202020202020202020202020202"
|
||||
}"#).unwrap();
|
||||
|
||||
// then
|
||||
assert_eq!(actual, expected);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn should_deserialize_leaves_proof() {
|
||||
// given
|
||||
let expected = LeavesProof {
|
||||
block_hash: H256::repeat_byte(0),
|
||||
leaves: Bytes(vec![vec![1_u8, 2, 3, 4], vec![2_u8, 2, 3, 4]].encode()),
|
||||
proof: Bytes(
|
||||
LeafProof {
|
||||
leaf_indices: vec![1, 2],
|
||||
leaf_count: 9,
|
||||
items: vec![H256::repeat_byte(1), H256::repeat_byte(2)],
|
||||
}
|
||||
.encode(),
|
||||
),
|
||||
};
|
||||
|
||||
// when
|
||||
let actual: LeavesProof<H256> = serde_json::from_str(r#"{
|
||||
"blockHash":"0x0000000000000000000000000000000000000000000000000000000000000000",
|
||||
"leaves":"0x0810010203041002020304",
|
||||
"proof":"0x080100000000000000020000000000000009000000000000000801010101010101010101010101010101010101010101010101010101010101010202020202020202020202020202020202020202020202020202020202020202"
|
||||
}"#).unwrap();
|
||||
|
||||
// then
|
||||
assert_eq!(actual, expected);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user