Update documentation and templates for Pezkuwi branding

This commit is contained in:
2026-01-17 23:19:40 +03:00
parent d839cbd92b
commit 9bd688a742
172 changed files with 12903 additions and 6604 deletions
@@ -2,11 +2,11 @@
:highlightjs-languages: rust
:github-icon: pass:[<svg class="icon"><use href="#github-icon"/></svg>]
= cumulus_pezpallet_xcmp_queue
= pezcumulus_pezpallet_xcmp_queue
Branch/Release: `release-polkadot-v1.10.0`
Branch/Release: `release-pezkuwi-v1.10.0`
== Source Code link:https://github.com/paritytech/polkadot-sdk/blob/release-polkadot-v1.10.0/cumulus/pezpallets/xcmp-queue/src/lib.rs[{github-icon},role=heading-link]
== Source Code link:https://github.com/pezkuwichain/pezkuwi-sdk/blob/release-pezkuwi-v1.10.0/pezcumulus/pezpallets/xcmp-queue/src/lib.rs[{github-icon},role=heading-link]
== Purpose
@@ -14,14 +14,14 @@ Responsible for the Queues (both incoming and outgoing) for XCMP messages. This
== Config
* Pezpallet-specific configs
* Pezpezpallet-specific configs
** `ChannelInfo` -- Configures two functions `get_channel_status` and `get_channel_info` to provide information about channels (`ChannelStatus` and `ChannelInfo`).
** `VersionWrapper` -- Means of converting an `Xcm` into a `VersionedXcm`. Xcm's should be versioned in order to pass the validation.
** `XcmpQueue` -- Defines max length of an XCMP message, and how `enqueue_message` should behave.
** `MaxInboundSuspended` -- The maximum number of inbound XCMP channels that can be suspended simultaneously. Any further channel suspensions will fail and messages may get dropped without further notice. Choosing a high value (1000) is okay.
** `ControllerOrigin` -- The origin that is allowed to resume or suspend the XCMP queue.
** `ControllerOriginConverter` -- The conversion function used to attempt to convert an XCM `xref:glossary.adoc#multilocation[MultiLocation]` origin to a superuser origin. This is used for allowing the superuser's queue to send messages even to paused queues.
** `PriceForSiblingDelivery` -- The price for delivering an XCM to a sibling parachain destination.
** `PriceForSiblingDelivery` -- The price for delivering an XCM to a sibling teyrchain destination.
* Common configs
** `RuntimeEvent` -- The overarching event type.
** `WeightInfo` -- The xref:glossary.adoc#weight[weight] information of this pezpallet.
@@ -122,11 +122,11 @@ IMPORTANT: messages are not ordered when they are received, but they are ordered
Messages and signals are stored in different queues. When the messages to be sent are taken with `take_outbound_messages`, they will be ordered:
* if there are signals present for outbound messages that targeting a parachain, we will only send signals, not messages
* if there are signals present for outbound messages that targeting a teyrchain, we will only send signals, not messages
* messages (that are not signals) wont be ordered
NOTE: polkadot/xcm/src/v3 has `SendXcm` trait, which has 2 blank methods validate and deliver. For each router struct, one can implement `SendXcm` for it.
NOTE: pezkuwi/xcm/src/v3 has `SendXcm` trait, which has 2 blank methods validate and deliver. For each router struct, one can implement `SendXcm` for it.
. `deliver` method take `destination` as a parameter, and calls `send_fragment` function with the target parachain id.
. `send_fragment` puts the message to the queue of the given parachain id.
. `deliver` method take `destination` as a parameter, and calls `send_fragment` function with the target teyrchain id.
. `send_fragment` puts the message to the queue of the given teyrchain id.
** unlike it's name, `deliver` method does not actually delivers the message. It is calling `send_fragment`, which places a message fragment on the outgoing XCMP queue for recipient. So, `deliver` is only putting the message to the respective outgoing xcmp queue