pezkuwi-sdk is an umbrella crate for the PezkuwiChain SDK, in the sense that it is an "umbrella" that encompasses other components. More specifically, it re-exports all the crates that are needed by builders.

pezkuwi-sdk aims to be the entry to the PezkuwiChain and Bizinikiwi ecosystem and make the SDK more approachable—the entire development environment made available with one dependency. More importantly, it guarantees the compatible combination of crate versions. So even if you know exactly which crates to use, you may still benefit from using pezkuwi-sdk for painless dependency updates.

You may have seen another umbrella crate named pezkuwi-sdk-frame, also known as the FRAME umbrella crate. For clarification, while pezkuwi-sdk aims to ease dependency management, pezkuwi-sdk-frame intends to simplify FRAME pezpallet implementation, as demonstrated in the example below.

💻 Usage

The re-exported crates are grouped under the following feature sets.

• node: Anything that you need to build a node
• runtime: Most things that you need to build a runtime
• runtime-full: Also the extended runtime features that are sometimes needed

[dependencies]
pezkuwi-sdk = { version = "0.12.0", features = ["runtime", "serde"], default-features = false }

[features]
runtime-benchmarks = ["pezkuwi-sdk/runtime-benchmarks"]
with-tracing = ["pezkuwi-sdk/with-tracing"]

cargo build --features "runtime-benchmarks,with-tracing"

[dependencies]
pezkuwi-sdk = { version = "0.12.0", features = ["runtime"], default-features = false }

[features]
try-runtime = ["pezkuwi-sdk/try-runtime"]

cargo build --features "try-runtime"

[dependencies]
pezkuwi-sdk = { version = "0.12.0", features = ["runtime", "tuples-96"], default-features = false }

When using pezkuwi-sdk to build a node, it is a good start to enable the node feature.

[dependencies]
pezkuwi-sdk = { version = "0.12.0", features = ["node"] }

For a runtime implementation, you need the runtime feature instead. Besides, you may want to opt out of std with default-features = false to allow the runtime to be executed in environments where std isn't available.

[dependencies]
pezkuwi-sdk = { version = "0.12.0", features = ["runtime"], default-features = false }

When building a runtime or writing an application pezpallet, pezkuwi-sdk-frame can be a handy toolkit to start with. It gathers all the common types, traits, and functions from many different crates so that you can import them with a one-liner.

pezkuwi-sdk-frame is also a part of pezkuwi-sdk. It is enabled by the runtime feature.

// It's a convention to rename it to `frame`.
use pezkuwi_sdk::pezkuwi_sdk_frame as frame;

#[frame::pezpallet(dev_mode)]
pub mod pezpallet {
    // Import declarations aren't automatically inherited.
    // Need to "re-import" to make `frame` available here.
    use super::*;
    // One-liner to import all the dependencies used here.
    use frame::prelude::*;

    pub type Balance = u128;

    #[pezpallet::pezpallet]
    pub struct Pezpallet<T>(_);

    #[pezpallet::config]
    #[pezpallet::disable_frame_system_supertrait_check]
    pub trait Config: frame_system::Config {}

    #[pezpallet::storage]
    pub type Balances<T: Config> = StorageMap<_, _, T::AccountId, Balance>;

    impl<T: Config> Pezpallet<T> {
        pub fn transfer(
            from: T::RuntimeOrigin,
            to: T::AccountId,
            amount: Balance,
        ) -> DispatchResult {
            let sender = ensure_signed(from)?;
            let sender_balance = Balances::<T>::get(&sender).ok_or("NonExistentAccount")?;
            let sender_remainder = sender_balance
                .checked_sub(amount)
                .ok_or("InsufficientBalance")?;

            Balances::<T>::mutate(to, |b| *b = Some(b.unwrap_or(0) + amount));
            Balances::<T>::insert(&sender, sender_remainder);

            Ok(())
        }
    }
}

For more detailed documentation and examples on pezkuwi-sdk-frame, see pezkuwi_sdk_frame.

To learn more about building with the Pezkuwi SDK, you may start with these guides and our official docs.

🚀 Versioning

We do a stable release for the SDK every three months with a version schema reflecting the release cadence, which is tracked in the release registry. At the time of writing, the latest version is stable2412 (released in 2024 December). To avoid confusion, we will align the versioning of pezkuwi-sdk with the established schema. For instance, the next stable version will be 2503.0.0.