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,30 @@
|
||||
[package]
|
||||
description = "Bizinikiwi mixnet types and runtime interface"
|
||||
name = "pezsp-mixnet"
|
||||
version = "0.4.0"
|
||||
license = "Apache-2.0"
|
||||
authors = [
|
||||
"Kurdistan Tech Institute <info@pezkuwichain.io>",
|
||||
"Parity Technologies <admin@parity.io>",
|
||||
]
|
||||
edition.workspace = true
|
||||
homepage.workspace = true
|
||||
repository.workspace = true
|
||||
readme = "README.md"
|
||||
|
||||
[lints]
|
||||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
targets = ["x86_64-unknown-linux-gnu"]
|
||||
|
||||
[dependencies]
|
||||
codec = { features = ["derive"], workspace = true }
|
||||
scale-info = { features = ["derive"], workspace = true }
|
||||
pezsp-api = { workspace = true }
|
||||
pezsp-application-crypto = { workspace = true }
|
||||
|
||||
[features]
|
||||
default = ["std"]
|
||||
std = ["codec/std", "scale-info/std", "pezsp-api/std", "pezsp-application-crypto/std"]
|
||||
runtime-benchmarks = ["pezsp-api/runtime-benchmarks"]
|
||||
@@ -0,0 +1,3 @@
|
||||
Bizinikiwi mixnet types and runtime interface.
|
||||
|
||||
License: Apache-2.0
|
||||
@@ -0,0 +1,26 @@
|
||||
// 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.
|
||||
|
||||
//! Bizinikiwi mixnet types and runtime interface.
|
||||
|
||||
#![warn(missing_docs)]
|
||||
#![cfg_attr(not(feature = "std"), no_std)]
|
||||
|
||||
extern crate alloc;
|
||||
|
||||
pub mod runtime_api;
|
||||
pub mod types;
|
||||
@@ -0,0 +1,52 @@
|
||||
// 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.
|
||||
|
||||
//! Runtime API for querying mixnet configuration and registering mixnodes.
|
||||
|
||||
use super::types::{Mixnode, MixnodesErr, SessionIndex, SessionStatus};
|
||||
use alloc::vec::Vec;
|
||||
|
||||
pezsp_api::decl_runtime_apis! {
|
||||
/// API to query the mixnet session status and mixnode sets, and to register mixnodes.
|
||||
pub trait MixnetApi {
|
||||
/// Get the index and phase of the current session.
|
||||
fn session_status() -> SessionStatus;
|
||||
|
||||
/// Get the mixnode set for the previous session.
|
||||
fn prev_mixnodes() -> Result<Vec<Mixnode>, MixnodesErr>;
|
||||
|
||||
/// Get the mixnode set for the current session.
|
||||
fn current_mixnodes() -> Result<Vec<Mixnode>, MixnodesErr>;
|
||||
|
||||
/// Try to register a mixnode for the next session.
|
||||
///
|
||||
/// If a registration extrinsic is submitted, `true` is returned. The caller should avoid
|
||||
/// calling `maybe_register` again for a few blocks, to give the submitted extrinsic a
|
||||
/// chance to get included.
|
||||
///
|
||||
/// With the above exception, `maybe_register` is designed to be called every block. Most
|
||||
/// of the time it will not do anything, for example:
|
||||
///
|
||||
/// - If it is not an appropriate time to submit a registration extrinsic.
|
||||
/// - If the local node has already registered a mixnode for the next session.
|
||||
/// - If the local node is not permitted to register a mixnode for the next session.
|
||||
///
|
||||
/// `session_index` should match `session_status().current_index`; if it does not, `false`
|
||||
/// is returned immediately.
|
||||
fn maybe_register(session_index: SessionIndex, mixnode: Mixnode) -> bool;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,101 @@
|
||||
// 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.
|
||||
|
||||
//! Mixnet types used by both host and runtime.
|
||||
|
||||
use alloc::vec::Vec;
|
||||
use codec::{Decode, Encode};
|
||||
use scale_info::TypeInfo;
|
||||
|
||||
mod app {
|
||||
use pezsp_application_crypto::{app_crypto, key_types::MIXNET, sr25519};
|
||||
app_crypto!(sr25519, MIXNET);
|
||||
}
|
||||
|
||||
/// Authority public session key, used to verify registration signatures.
|
||||
pub type AuthorityId = app::Public;
|
||||
/// Authority signature, attached to mixnode registrations.
|
||||
pub type AuthoritySignature = app::Signature;
|
||||
|
||||
/// Absolute session index.
|
||||
pub type SessionIndex = u32;
|
||||
|
||||
/// Each session should progress through these phases in order.
|
||||
#[derive(Decode, Encode, TypeInfo, PartialEq, Eq)]
|
||||
pub enum SessionPhase {
|
||||
/// Generate cover traffic to the current session's mixnode set.
|
||||
CoverToCurrent,
|
||||
/// Build requests using the current session's mixnode set.
|
||||
RequestsToCurrent,
|
||||
/// Only send cover (and forwarded) traffic to the previous session's mixnode set.
|
||||
CoverToPrev,
|
||||
/// Disconnect the previous session's mixnode set.
|
||||
DisconnectFromPrev,
|
||||
}
|
||||
|
||||
/// The index and phase of the current session.
|
||||
#[derive(Decode, Encode, TypeInfo)]
|
||||
pub struct SessionStatus {
|
||||
/// Index of the current session.
|
||||
pub current_index: SessionIndex,
|
||||
/// Current session phase.
|
||||
pub phase: SessionPhase,
|
||||
}
|
||||
|
||||
/// Size in bytes of a [`KxPublic`].
|
||||
pub const KX_PUBLIC_SIZE: usize = 32;
|
||||
|
||||
/// X25519 public key, used in key exchange between message senders and mixnodes. Mixnode public
|
||||
/// keys are published on-chain and change every session. Message senders generate a new key for
|
||||
/// every message they send.
|
||||
pub type KxPublic = [u8; KX_PUBLIC_SIZE];
|
||||
|
||||
/// Ed25519 public key of a libp2p peer.
|
||||
pub type PeerId = [u8; 32];
|
||||
|
||||
/// Information published on-chain for each mixnode every session.
|
||||
#[derive(Decode, Encode, TypeInfo)]
|
||||
pub struct Mixnode {
|
||||
/// Key-exchange public key for the mixnode.
|
||||
pub kx_public: KxPublic,
|
||||
/// libp2p peer ID of the mixnode.
|
||||
pub peer_id: PeerId,
|
||||
/// External addresses for the mixnode, in multiaddr format, UTF-8 encoded.
|
||||
pub external_addresses: Vec<Vec<u8>>,
|
||||
}
|
||||
|
||||
/// Error querying the runtime for a session's mixnode set.
|
||||
#[derive(Decode, Encode, TypeInfo)]
|
||||
pub enum MixnodesErr {
|
||||
/// Insufficient mixnodes were registered for the session.
|
||||
InsufficientRegistrations {
|
||||
/// The number of mixnodes that were registered for the session.
|
||||
num: u32,
|
||||
/// The minimum number of mixnodes that must be registered for the mixnet to operate.
|
||||
min: u32,
|
||||
},
|
||||
}
|
||||
|
||||
impl core::fmt::Display for MixnodesErr {
|
||||
fn fmt(&self, fmt: &mut core::fmt::Formatter) -> core::fmt::Result {
|
||||
match self {
|
||||
MixnodesErr::InsufficientRegistrations { num, min } => {
|
||||
write!(fmt, "{num} mixnode(s) registered; {min} is the minimum")
|
||||
},
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user