fix: Complete snowbridge pezpallet rebrand and critical bug fixes
- snowbridge-pezpallet-* → pezsnowbridge-pezpallet-* (201 refs) - pallet/ directories → pezpallet/ (4 locations) - Fixed pezpallet.rs self-include recursion bug - Fixed sc-chain-spec hardcoded crate name in derive macro - Reverted .pezpallet_by_name() to .pallet_by_name() (subxt API) - Added BizinikiwiConfig type alias for zombienet tests - Deleted obsolete session state files Verified: pezsnowbridge-pezpallet-*, pezpallet-staking, pezpallet-staking-async, pezframe-benchmarking-cli all pass cargo check
This commit is contained in:
@@ -34,7 +34,7 @@ All branches must follow these naming patterns:
|
||||
| --- | --- | --- |
|
||||
| `feature/<name>` | New features | `feature/parliamentary-nft-voting` |
|
||||
| `fix/<name>` | Bug fixes | `fix/presale-overflow-check` |
|
||||
| `pallet/<name>` | Pallet-specific changes | `pallet/welati-liquid-democracy` |
|
||||
| `pezpallet/<name>` | Pezpallet-specific changes | `pezpallet/welati-liquid-democracy` |
|
||||
| `runtime/<name>` | Runtime configuration changes | `runtime/xcm-v5-upgrade` |
|
||||
| `docs/<name>` | Documentation updates | `docs/token-economics` |
|
||||
| `ci/<name>` | CI/CD changes | `ci/benchmark-workflow` |
|
||||
|
||||
@@ -7,7 +7,7 @@ These crates are used by external developers and need thorough documentation. Th
|
||||
development.
|
||||
|
||||
- [Documentation Guidelines](#documentation-guidelines)
|
||||
- [General/Non-Pallet Crates](#generalnon-pezpallet-crates)
|
||||
- [General/Non-Pezpallet Crates](#generalnon-pezpallet-crates)
|
||||
- [What to Document?](#what-to-document)
|
||||
- [Rust Docs vs. Code Comments](#rust-docs-vs-code-comments)
|
||||
- [How to Document?](#how-to-document)
|
||||
@@ -16,8 +16,8 @@ development.
|
||||
- [Other Guidelines](#other-guidelines)
|
||||
- [Document Through Code](#document-through-code)
|
||||
- [Formatting Matters](#formatting-matters)
|
||||
- [Pallet Crates](#pezpallet-crates)
|
||||
- [Top Level Pallet Docs (`lib.rs`)](#top-level-pezpallet-docs-librs)
|
||||
- [Pezpallet Crates](#pezpallet-crates)
|
||||
- [Top Level Pezpallet Docs (`lib.rs`)](#top-level-pezpallet-docs-librs)
|
||||
- [Pezkuwi and Bizinikiwi](#pezkuwi-and-bizinikiwi)
|
||||
- [Dispatchables](#dispatchables)
|
||||
- [Storage Items](#storage-items)
|
||||
@@ -25,7 +25,7 @@ development.
|
||||
|
||||
---
|
||||
|
||||
## General/Non-Pallet Crates
|
||||
## General/Non-Pezpallet Crates
|
||||
|
||||
First, consider the case for all such crates, except for those that are pallets.
|
||||
|
||||
@@ -203,49 +203,49 @@ properly do this.
|
||||
|
||||
---
|
||||
|
||||
## Pallet Crates
|
||||
## Pezpallet Crates
|
||||
|
||||
The guidelines so far have been general in nature, and are applicable to crates that are pallets and crates that are not
|
||||
pallets.
|
||||
|
||||
The following is relevant to how to document parts of a crate that is a pallet. See
|
||||
The following is relevant to how to document parts of a crate that is a pezpallet. See
|
||||
[`pezpallet-fast-unstake`](../../bizinikiwi/pezframe/fast-unstake/src/lib.rs) as one example of adhering these guidelines.
|
||||
|
||||
---
|
||||
|
||||
### Top Level Pallet Docs (`lib.rs`)
|
||||
### Top Level Pezpallet Docs (`lib.rs`)
|
||||
|
||||
For the top-level pallet docs, consider the following template:
|
||||
For the top-level pezpallet docs, consider the following template:
|
||||
|
||||
```
|
||||
//! # <Pallet Name>
|
||||
//! # <Pezpallet Name>
|
||||
//!
|
||||
//! <single-liner about the pallet>.
|
||||
//! <single-liner about the pezpallet>.
|
||||
//!
|
||||
//! ## Pallet API
|
||||
//! ## Pezpallet API
|
||||
//!
|
||||
//! <Reminder: inside the [`pallet`] module, a template that leads the reader to the relevant items is auto-generated. There is no need to repeat
|
||||
//! things like "See Config trait for ...", which are generated inside [`pallet`] here anyways. You can use the line below as-is:>
|
||||
//! <Reminder: inside the [`pezpallet`] module, a template that leads the reader to the relevant items is auto-generated. There is no need to repeat
|
||||
//! things like "See Config trait for ...", which are generated inside [`pezpallet`] here anyways. You can use the line below as-is:>
|
||||
//!
|
||||
//! See the [`pallet`] module for more information about the interfaces this pallet exposes, including its
|
||||
//! See the [`pezpallet`] module for more information about the interfaces this pezpallet exposes, including its
|
||||
//! configuration trait, dispatchables, storage items, events and errors.
|
||||
//!
|
||||
//! ## Overview
|
||||
//!
|
||||
//! <should be high-level details that are relevant to the most broad audience>
|
||||
//!
|
||||
//! <The audience here is potentially non-coders who just want to know what this pallet does, not how it does it>
|
||||
//! <The audience here is potentially non-coders who just want to know what this pezpallet does, not how it does it>
|
||||
//!
|
||||
//! <potentially a few paragraphs, focus on what external folks should know about the pallet>
|
||||
//! <potentially a few paragraphs, focus on what external folks should know about the pezpallet>
|
||||
//!
|
||||
//! ### Example
|
||||
//!
|
||||
//! <Your pallet must have a few tests that cover important user journeys. Use https://crates.io/crates/docify to
|
||||
//! <Your pezpallet must have a few tests that cover important user journeys. Use https://crates.io/crates/docify to
|
||||
//! reuse these as examples.>
|
||||
//!
|
||||
//! <The audience of this is those who want to know how this pallet works, to the extent of being able to build
|
||||
//! something on top of it, like a DApp or another pallet. In some cases, you might want to add an example of how to
|
||||
//! use this pallet in other pallets.>
|
||||
//! <The audience of this is those who want to know how this pezpallet works, to the extent of being able to build
|
||||
//! something on top of it, like a DApp or another pezpallet. In some cases, you might want to add an example of how to
|
||||
//! use this pezpallet in other pallets.>
|
||||
//!
|
||||
//! This section can most often be left as-is.
|
||||
//!
|
||||
@@ -253,16 +253,16 @@ For the top-level pallet docs, consider the following template:
|
||||
//!
|
||||
//! <The format of this section is up to you, but we suggest the Design-oriented approach that follows>
|
||||
//!
|
||||
//! <The audience of this would be your future self, or anyone who wants to gain a deep understanding of how the pallet
|
||||
//! <The audience of this would be your future self, or anyone who wants to gain a deep understanding of how the pezpallet
|
||||
//! works so that they can eventually propose optimizations to it>
|
||||
//!
|
||||
//! ### Design Goals (optional)
|
||||
//!
|
||||
//! <Describe your goals with the pallet design.>
|
||||
//! <Describe your goals with the pezpallet design.>
|
||||
//!
|
||||
//! ### Design (optional)
|
||||
//!
|
||||
//! <Describe how you've reached those goals. This should describe the storage layout of your pallet and what was your
|
||||
//! <Describe how you've reached those goals. This should describe the storage layout of your pezpallet and what was your
|
||||
//! approach in designing it that way.>
|
||||
//!
|
||||
//! ### Terminology (optional)
|
||||
@@ -285,7 +285,7 @@ and beyond are flexible.
|
||||
|
||||
#### Pezkuwi and Bizinikiwi
|
||||
|
||||
Optionally, in order to demonstrate the relation between the two, you can start the pallet documentation with:
|
||||
Optionally, in order to demonstrate the relation between the two, you can start the pezpallet documentation with:
|
||||
|
||||
```
|
||||
//! > Made with *Bizinikiwi*, for *Pezkuwi*.
|
||||
@@ -301,7 +301,7 @@ Optionally, in order to demonstrate the relation between the two, you can start
|
||||
|
||||
### Dispatchables
|
||||
|
||||
For each dispatchable (`fn` item inside `#[pallet::call]`), consider the following template:
|
||||
For each dispatchable (`fn` item inside `#[pezpallet::call]`), consider the following template:
|
||||
|
||||
```
|
||||
/// <One-liner explaining what the dispatchable does>
|
||||
@@ -337,8 +337,8 @@ because ...`). Recall that this is not relevant information to external people,
|
||||
|
||||
2. Consider explaining the crypto-economics of how a deposit is being taken in return of the storage being used.
|
||||
|
||||
3. Consider explaining why it is safe for the storage item to be unbounded, if `#[pallet::unbounded]` or
|
||||
`#[pallet::without_storage_info]` is being used.
|
||||
3. Consider explaining why it is safe for the storage item to be unbounded, if `#[pezpallet::unbounded]` or
|
||||
`#[pezpallet::without_storage_info]` is being used.
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
- [ ] Bug fix (non-breaking change that fixes an issue)
|
||||
- [ ] New feature (non-breaking change that adds functionality)
|
||||
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
|
||||
- [ ] Pallet change (changes to custom pallets in `/pezkuwi/pallets/`)
|
||||
- [ ] Pezpallet change (changes to custom pallets in `/pezkuwi/pallets/`)
|
||||
- [ ] Runtime change (changes to runtime configuration)
|
||||
- [ ] XCM/Cross-chain change
|
||||
- [ ] Documentation update
|
||||
@@ -70,5 +70,5 @@ N/A
|
||||
**For Reviewers:**
|
||||
- Check that tests cover the changes adequately
|
||||
- Verify no regressions in existing functionality
|
||||
- For pallet changes: review weight calculations
|
||||
- For pezpallet changes: review weight calculations
|
||||
- For XCM changes: verify cross-chain compatibility
|
||||
|
||||
@@ -38,6 +38,6 @@ the default branch.
|
||||
|
||||
The regex in cmd.yml is: `^(\/cmd )([-\/\s\w.=:]+)$` accepts only alphanumeric, space, "-", "/", "=", ":", "." chars.
|
||||
|
||||
`/cmd bench --runtime bridge-hub-zagros --pallet=pallet_name`
|
||||
`/cmd bench --runtime bridge-hub-zagros --pezpallet=pallet_name`
|
||||
`/cmd prdoc --audience runtime_dev runtime_user --bump patch --force`
|
||||
`/cmd update-ui --image=docker.io/paritytech/ci-unified:bullseye-1.77.0-2024-04-10-v202407161507 --clean`
|
||||
|
||||
@@ -22,7 +22,7 @@ Options:
|
||||
providing template runtimes. Also devs using pallets, FRAME etc directly. These are people who
|
||||
care about the protocol (WASM), not the meta-protocol (client).
|
||||
- `runtime_user`: Anyone using the runtime. Can be front-end devs reading the state, exchanges
|
||||
listening for events, libraries that have hard-coded pallet indices etc. Anything that would
|
||||
listening for events, libraries that have hard-coded pezpallet indices etc. Anything that would
|
||||
result in an observable change to the runtime behaviour must be marked with this.
|
||||
- `node_dev`: Those who build around the client side code. Alternative client builders, SMOLDOT,
|
||||
those who consume RPCs. These are people who are oblivious to the runtime changes. They only care
|
||||
@@ -88,11 +88,11 @@ For example when you modified two crates and record the changes:
|
||||
crates:
|
||||
- name: frame-example
|
||||
bump: major
|
||||
- name: frame-example-pallet
|
||||
- name: frame-example-pezpallet
|
||||
bump: minor
|
||||
```
|
||||
|
||||
It means that downstream code using `frame-example-pallet` is still guaranteed to work as before,
|
||||
It means that downstream code using `frame-example-pezpallet` is still guaranteed to work as before,
|
||||
while code using `frame-example` might break.
|
||||
|
||||
### Dependencies
|
||||
@@ -114,12 +114,12 @@ crates:
|
||||
- name: frame-example
|
||||
bump: major
|
||||
validate: false
|
||||
- name: frame-example-pallet
|
||||
- name: frame-example-pezpallet
|
||||
bump: minor
|
||||
```
|
||||
|
||||
By putting `validate: false` for `frame-example`, the version bump is ignored by the tooling. For
|
||||
`frame-example-pallet` the version bump is still validated by the CI check.
|
||||
`frame-example-pezpallet` the version bump is still validated by the CI check.
|
||||
|
||||
### Backporting PRs
|
||||
|
||||
|
||||
@@ -33,7 +33,7 @@ To generate weights for all pallets in a particular runtime(s), run the followin
|
||||
For Bizinikiwi pallets (supports sub-modules too):
|
||||
|
||||
```sh
|
||||
/cmd bench --runtime dev --pallet pallet_asset_conversion_ops
|
||||
/cmd bench --runtime dev --pezpallet pallet_asset_conversion_ops
|
||||
```
|
||||
|
||||
> **📝 Note**: The action is not being run right-away, it will be queued and run in the next available runner.
|
||||
@@ -50,13 +50,13 @@ For Bizinikiwi pallets (supports sub-modules too):
|
||||
This way it runs all possible runtimes for the specified pallets, if it finds them in the runtime
|
||||
|
||||
```sh
|
||||
/cmd bench --pallet pallet_balances pallet_xcm_benchmarks::generic pallet_xcm_benchmarks::fungible
|
||||
/cmd bench --pezpallet pallet_balances pallet_xcm_benchmarks::generic pallet_xcm_benchmarks::fungible
|
||||
```
|
||||
|
||||
If you want to run all specific pallet(s) for specific runtime(s), you can do it like this:
|
||||
If you want to run all specific pezpallet(s) for specific runtime(s), you can do it like this:
|
||||
|
||||
```sh
|
||||
/cmd bench --runtime bridge-hub-pezkuwi --pallet pallet_xcm_benchmarks::generic pallet_xcm_benchmarks::fungible
|
||||
/cmd bench --runtime bridge-hub-pezkuwi --pezpallet pallet_xcm_benchmarks::generic pallet_xcm_benchmarks::fungible
|
||||
```
|
||||
|
||||
> **💡Hint #1** : Sometimes when you run too many commands, or they keep failing and you're rerunning them again,
|
||||
@@ -64,7 +64,7 @@ If you want to run all specific pallet(s) for specific runtime(s), you can do it
|
||||
> /cmd commands.
|
||||
|
||||
```sh
|
||||
/cmd bench --runtime kusama pezkuwi --pallet=pallet_balances --clean
|
||||
/cmd bench --runtime kusama pezkuwi --pezpallet=pallet_balances --clean
|
||||
```
|
||||
|
||||
> **💡Hint #2** : If you have questions or need help, feel free to tag @paritytech/opstooling (in github comments)
|
||||
|
||||
Reference in New Issue
Block a user