feat: Rebrand Kurdistan SDK to PezkuwiChain
This commit is contained in:
+4
-4
@@ -25,8 +25,8 @@ The outputs of a stable release are:
|
||||
|
||||
# Timeline
|
||||
`Stable` releases are scheduled on a quarterly basis, usually by the end of the last month of each quarter. The exact
|
||||
schedule can be found on the [Release Registry](https://github.com/paritytech/release-registry/).It is possible to
|
||||
subscribe to a [calendar link](https://raw.githubusercontent.com/paritytech/release-registry/main/releases-v1.ics)
|
||||
schedule can be found on the [Release Registry](https://github.com/pezkuwichain/release-registry/).It is possible to
|
||||
subscribe to a [calendar link](https://raw.githubusercontent.com/pezkuwichain/release-registry/main/releases-v1.ics)
|
||||
to have it in your personal calendar.
|
||||
|
||||
Each stable release is supported for a period of one year from its first release. For example, `Pezkuwi stable2412`
|
||||
@@ -175,8 +175,8 @@ to have it as a final rc on the S3
|
||||
From the main Pezkuwi-sdk repository in the paritytech org:
|
||||
|
||||
1. Synchronize templates using [Synchronize templates](/.github/workflows/misc-sync-templates.yml)
|
||||
2. Update the [Release Registry](https://github.com/paritytech/release-registry/)
|
||||
follwoing the [instructions](https://github.com/paritytech/release-registry?tab=readme-ov-file#maintenance)
|
||||
2. Update the [Release Registry](https://github.com/pezkuwichain/release-registry/)
|
||||
follwoing the [instructions](https://github.com/pezkuwichain/release-registry?tab=readme-ov-file#maintenance)
|
||||
in the repo with the actual release dates.
|
||||
|
||||
## Patch release for the latest stable version
|
||||
|
||||
@@ -16,7 +16,7 @@ Parity builds and publishes a container image that can be found as `docker.io/pa
|
||||
## Parity CI image
|
||||
|
||||
Parity maintains and uses internally a generic "CI" image that can be used as a base to build binaries: [Parity CI
|
||||
container image](https://github.com/paritytech/dockerfiles/tree/main/ci-unified):
|
||||
container image](https://github.com/pezkuwichain/dockerfiles/tree/main/ci-unified):
|
||||
|
||||
The command below allows building a Linux binary without having to even install Rust or any dependency locally:
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# PRDoc
|
||||
|
||||
A [prdoc](https://github.com/paritytech/prdoc) is like a changelog but for a Pull Request. We use
|
||||
A [prdoc](https://github.com/pezkuwichain/prdoc) is like a changelog but for a Pull Request. We use
|
||||
this approach to record changes on a crate level. This information is then processed by the release
|
||||
team to apply the correct crate version bumps and to generate the CHANGELOG of the next release.
|
||||
|
||||
@@ -53,12 +53,11 @@ Options:
|
||||
A `.prdoc` file is a YAML file with a defined structure (ie JSON Schema). Please follow these steps
|
||||
to generate one:
|
||||
|
||||
1. Install the [`prdoc` CLI](https://github.com/paritytech/prdoc) by running `cargo install
|
||||
parity-prdoc`.
|
||||
1. Install the [`prdoc` CLI](https://github.com/pezkuwichain/prdoc) by running `cargo install`
|
||||
1. Open a Pull Request and get the PR number.
|
||||
1. Generate the file with `prdoc generate <PR_NUMBER>`. The output filename will be printed.
|
||||
1. Optional: Install the `prdoc/schema_user.json` schema in your editor, for example
|
||||
[VsCode](https://github.com/paritytech/prdoc?tab=readme-ov-file#schemas).
|
||||
[VsCode](https://github.com/pezkuwichain/prdoc?tab=readme-ov-file#schemas).
|
||||
1. Edit your `.prdoc` file according to the [Audience](#pick-an-audience) and
|
||||
[SemVer](#record-semver-changes) sections.
|
||||
1. Check your prdoc with `prdoc check -n <PR_NUMBER>`. This is optional since the CI will also check
|
||||
|
||||
@@ -88,7 +88,7 @@
|
||||
//! build their WASM files as a part of normal build command (e.g. `cargo build`). Once built, the
|
||||
//! wasm file is placed in `./target/{debug|release}/wbuild/{runtime_name}/{runtime_name}.wasm`.
|
||||
//!
|
||||
//! In order to ensure that the WASM build is **deterministic**, the [Bizinikiwi Runtime Toolbox (srtool)](https://github.com/paritytech/srtool) can be used.
|
||||
//! In order to ensure that the WASM build is **deterministic**, the [Bizinikiwi Runtime Toolbox (srtool)](https://github.com/pezkuwichain/srtool) can be used.
|
||||
//!
|
||||
//! ### Anatomy of a Binary Crate
|
||||
//!
|
||||
|
||||
@@ -58,18 +58,18 @@
|
||||
//!
|
||||
//! #### XCM
|
||||
//!
|
||||
//! [](https://github.com/paritytech/polkadot-sdk/blob/master/polkadot/LICENSE)
|
||||
//! [](https://github.com/pezkuwichain/pezkuwi-sdk/blob/master/pezkuwi/LICENSE)
|
||||
//! [](https://github.com/paritytech/polkadot-sdk/blob/master/polkadot/xcm)
|
||||
//! Repo](https://img.shields.io/badge/github-XCM-e6007a?logo=polkadot)](https://github.com/pezkuwichain/pezkuwi-sdk/blob/master/pezkuwi/xcm)
|
||||
//!
|
||||
//! [`xcm`], short for "cross consensus message", is the primary format that is used for
|
||||
//! communication between teyrchains, but is intended to be extensible to other use cases as well.
|
||||
//!
|
||||
//! #### Pezkuwi
|
||||
//!
|
||||
//! [](https://github.com/paritytech/polkadot-sdk/blob/master/polkadot/LICENSE)
|
||||
//! [](https://github.com/pezkuwichain/pezkuwi-sdk/blob/master/pezkuwi/LICENSE)
|
||||
//! [](https://github.com/paritytech/polkadot-sdk/blob/master/polkadot)
|
||||
//! Repo](https://img.shields.io/badge/github-polkadot-e6007a?logo=polkadot)](https://github.com/pezkuwichain/pezkuwi-sdk/blob/master/pezkuwi)
|
||||
//!
|
||||
//! [`pezkuwi`] is an implementation of a Pezkuwi node in Rust, by `@paritytech`. The Pezkuwi
|
||||
//! runtimes are located under the
|
||||
@@ -116,10 +116,10 @@
|
||||
//!
|
||||
//! ## Notable Upstream Crates
|
||||
//!
|
||||
//! - [`parity-scale-codec`](https://github.com/paritytech/parity-scale-codec)
|
||||
//! - [`parity-db`](https://github.com/paritytech/parity-db)
|
||||
//! - [`trie`](https://github.com/paritytech/trie)
|
||||
//! - [`parity-common`](https://github.com/paritytech/parity-common)
|
||||
//! - [`parity-scale-codec`](https://github.com/pezkuwichain/parity-scale-codec)
|
||||
//! - [`parity-db`](https://github.com/pezkuwichain/parity-db)
|
||||
//! - [`trie`](https://github.com/pezkuwichain/trie)
|
||||
//! - [`parity-common`](https://github.com/pezkuwichain/parity-common)
|
||||
//!
|
||||
//! ## Trophy Section: Notable Downstream Projects
|
||||
//!
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
//!
|
||||
//! ## Overview
|
||||
//!
|
||||
//! XCM is a standard, specification of which lives in the [xcm format repo](https://github.com/paritytech/xcm-format).
|
||||
//! XCM is a standard, specification of which lives in the [xcm format repo](https://github.com/pezkuwichain/xcm-format).
|
||||
//! It's agnostic both in programming language and blockchain platform, which means it could be used
|
||||
//! in Rust in Pezkuwi, or in Go or C++ in any other platform like Cosmos or Ethereum.
|
||||
//!
|
||||
@@ -30,7 +30,7 @@
|
||||
//!
|
||||
//! ## Implementation
|
||||
//!
|
||||
//! A ready-to-use Rust implementation lives in the [pezkuwi-sdk repo](https://github.com/paritytech/polkadot-sdk/tree/master/polkadot/xcm),
|
||||
//! A ready-to-use Rust implementation lives in the [pezkuwi-sdk repo](https://github.com/pezkuwichain/kurdistan-sdk/tree/main/pezkuwi/xcm),
|
||||
//! but will be moved to its own repo in the future.
|
||||
//!
|
||||
//! Its main components are:
|
||||
|
||||
@@ -87,8 +87,8 @@
|
||||
//! - Touching too many storage keys and resulting in an excessively large PoV.
|
||||
//! - Taking too long to execute.
|
||||
//!
|
||||
//! [`try-runtime-cli`](https://github.com/paritytech/try-runtime-cli) has a sub-command
|
||||
//! [`on-runtime-upgrade`](https://paritytech.github.io/try-runtime-cli/try_runtime_core/commands/enum.Action.html#variant.OnRuntimeUpgrade)
|
||||
//! [`try-runtime-cli`](https://github.com/pezkuwichain/try-runtime-cli) has a sub-command
|
||||
//! [`on-runtime-upgrade`](https://pezkuwichain.github.io/try-runtime-cli/try_runtime_core/commands/enum.Action.html#variant.OnRuntimeUpgrade)
|
||||
//! which is designed to help with exactly this.
|
||||
//!
|
||||
//! Developers MUST run this command before deploying migrations to ensure they will not
|
||||
@@ -100,7 +100,7 @@
|
||||
//!
|
||||
//! ### Note on the Manipulability of PoV Size and Execution Time
|
||||
//!
|
||||
//! While [`try-runtime-cli`](https://github.com/paritytech/try-runtime-cli) can help ensure with
|
||||
//! While [`try-runtime-cli`](https://github.com/pezkuwichain/try-runtime-cli) can help ensure with
|
||||
//! very high certainty that a migration will succeed given **existing** on-chain state, it cannot
|
||||
//! prevent a malicious actor from manipulating state in a way that will cause the migration to take
|
||||
//! longer or produce a PoV much larger than previously measured.
|
||||
|
||||
Reference in New Issue
Block a user