docs: fix broken rustdoc links across codebase
- Fix vendor/zombienet-sdk deprecated method doc links - Fix vendor/subxt doc links (eth::PublicKey, Client) - Fix vendor/ss58-registry TokenRegistry doc link - Fix pezpallet-presale event comment causing doc parse error - Fix pezframe-support broken Config trait link - Rebrand pezpallet-revive README with correct crate names and URLs
This commit is contained in:
@@ -1,12 +1,12 @@
|
|||||||
# Revive Pezpallet
|
# Revive Pezpallet
|
||||||
|
|
||||||
This is an **experimental** module that provides functionality for the runtime to deploy and execute PolkaVM
|
This is an **experimental** module that provides functionality for the runtime to deploy and execute PolkaVM
|
||||||
smart-contracts. It is a heavily modified `pallet_contracts` fork.
|
smart-contracts. It is a heavily modified `pezpallet_contracts` fork.
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
This module extends accounts based on the [`frame_support::traits::fungible`] traits to have smart-contract
|
This module extends accounts based on the [`pezframe_support::traits::fungible`] traits to have smart-contract
|
||||||
functionality. It can be used with other modules that implement accounts based on [`frame_support::traits::fungible`].
|
functionality. It can be used with other modules that implement accounts based on [`pezframe_support::traits::fungible`].
|
||||||
These "smart-contract accounts" have the ability to instantiate smart-contracts and make calls to other contract and
|
These "smart-contract accounts" have the ability to instantiate smart-contracts and make calls to other contract and
|
||||||
non-contract accounts.
|
non-contract accounts.
|
||||||
|
|
||||||
@@ -20,7 +20,7 @@ Finally, when an account is reaped, its associated code and storage of the smart
|
|||||||
|
|
||||||
### Weight
|
### Weight
|
||||||
|
|
||||||
Senders must specify a [`Weight`](https://docs.pezkuwichain.io/bizinikiwi/master/sp_weights/struct.Weight.html) limit
|
Senders must specify a [`Weight`](https://docs.pezkuwichain.io/bizinikiwi/master/pezsp_weights/struct.Weight.html) limit
|
||||||
with every call, as all instructions invoked by the smart-contract require weight. Unused weight is refunded after the
|
with every call, as all instructions invoked by the smart-contract require weight. Unused weight is refunded after the
|
||||||
call, regardless of the execution outcome.
|
call, regardless of the execution outcome.
|
||||||
|
|
||||||
@@ -79,7 +79,7 @@ to handle that failure, either proceeding or reverting A's changes.
|
|||||||
### Dispatchable functions
|
### Dispatchable functions
|
||||||
|
|
||||||
Those are documented in the [reference
|
Those are documented in the [reference
|
||||||
documentation](https://docs.pezkuwichain.io/sdk/master/pallet_revive/pezpallet/dispatchables/index.html).
|
documentation](https://docs.pezkuwichain.io/sdk/master/pezpallet_revive/pezpallet/dispatchables/index.html).
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
@@ -108,7 +108,7 @@ concept of an unstable interface. Akin to the rust nightly compiler it allows us
|
|||||||
unstable so that contract languages can experiment with them and give feedback before we stabilize those.
|
unstable so that contract languages can experiment with them and give feedback before we stabilize those.
|
||||||
|
|
||||||
In order to access interfaces which don't have a stable `#[stable]` in [`runtime.rs`](src/vm/runtime.rs)
|
In order to access interfaces which don't have a stable `#[stable]` in [`runtime.rs`](src/vm/runtime.rs)
|
||||||
one need to set `pallet_revive::Config::UnsafeUnstableInterface` to `ConstU32<true>`.
|
one need to set `pezpallet_revive::Config::UnsafeUnstableInterface` to `ConstU32<true>`.
|
||||||
**It should be obvious that any production runtime should never be compiled with this feature: In addition to be
|
**It should be obvious that any production runtime should never be compiled with this feature: In addition to be
|
||||||
subject to change or removal those interfaces might not have proper weights associated with them and are therefore
|
subject to change or removal those interfaces might not have proper weights associated with them and are therefore
|
||||||
considered unsafe**.
|
considered unsafe**.
|
||||||
|
|||||||
@@ -1041,8 +1041,7 @@ pub mod pezpallet_macros {
|
|||||||
/// ```
|
/// ```
|
||||||
///
|
///
|
||||||
/// I.e. a regular trait definition named `Config`, with the supertrait
|
/// I.e. a regular trait definition named `Config`, with the supertrait
|
||||||
/// [`pezframe_system::pezpallet::Config`](../../pezframe_system/pezpallet/trait.Config.
|
/// `pezframe_system::pezpallet::Config`, and optionally other supertraits and a where clause. (Specifying other
|
||||||
/// html), and optionally other supertraits and a where clause. (Specifying other
|
|
||||||
/// supertraits here is known as [tight coupling](https://docs.pezkuwichain.io/reference/how-to-guides/pezpallet-design/use-tight-coupling/))
|
/// supertraits here is known as [tight coupling](https://docs.pezkuwichain.io/reference/how-to-guides/pezpallet-design/use-tight-coupling/))
|
||||||
///
|
///
|
||||||
/// ## Optional: `with_default`
|
/// ## Optional: `with_default`
|
||||||
|
|||||||
@@ -453,7 +453,7 @@ pub mod pezpallet {
|
|||||||
Distributed { presale_id: PresaleId, who: T::AccountId, amount: u128 },
|
Distributed { presale_id: PresaleId, who: T::AccountId, amount: u128 },
|
||||||
/// Refund processed [presale_id, who, amount, fee]
|
/// Refund processed [presale_id, who, amount, fee]
|
||||||
Refunded { presale_id: PresaleId, who: T::AccountId, amount: u128, fee: u128 },
|
Refunded { presale_id: PresaleId, who: T::AccountId, amount: u128, fee: u128 },
|
||||||
/// Presale cancelled [presale_id]
|
/// Presale cancelled
|
||||||
PresaleCancelled { presale_id: PresaleId },
|
PresaleCancelled { presale_id: PresaleId },
|
||||||
/// Platform fee distributed [treasury_share, burn_share, staker_share]
|
/// Platform fee distributed [treasury_share, burn_share, staker_share]
|
||||||
PlatformFeeDistributed { treasury_share: u128, burn_share: u128, staker_share: u128 },
|
PlatformFeeDistributed { treasury_share: u128, burn_share: u128, staker_share: u128 },
|
||||||
|
|||||||
@@ -159,7 +159,7 @@ pub struct RpcClient {
|
|||||||
tx: mpsc::UnboundedSender<Op>,
|
tx: mpsc::UnboundedSender<Op>,
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Builder for [`Client`].
|
/// Builder for [`RpcClient`].
|
||||||
#[derive(Clone, Debug)]
|
#[derive(Clone, Debug)]
|
||||||
pub struct RpcClientBuilder<P> {
|
pub struct RpcClientBuilder<P> {
|
||||||
max_request_size: u32,
|
max_request_size: u32,
|
||||||
|
|||||||
+1
-1
@@ -104,7 +104,7 @@ impl Keypair {
|
|||||||
self.0.secret_key()
|
self.0.secret_key()
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Obtain the [`eth::PublicKey`] of this keypair.
|
/// Obtain the [`PublicKey`] of this keypair.
|
||||||
pub fn public_key(&self) -> PublicKey {
|
pub fn public_key(&self) -> PublicKey {
|
||||||
let uncompressed = self.0 .0.public_key().serialize_uncompressed();
|
let uncompressed = self.0 .0.public_key().serialize_uncompressed();
|
||||||
PublicKey(uncompressed)
|
PublicKey(uncompressed)
|
||||||
|
|||||||
@@ -499,7 +499,7 @@ impl RelaychainConfigBuilder<WithChain> {
|
|||||||
|
|
||||||
/// Add a new node using a nested [`NodeConfigBuilder`].
|
/// Add a new node using a nested [`NodeConfigBuilder`].
|
||||||
///
|
///
|
||||||
/// **Deprecated**: Use [`with_validator`] for validator nodes or [`with_fullnode`] for full nodes instead.
|
/// **Deprecated**: Use `with_validator` for validator nodes or `with_fullnode` for full nodes instead.
|
||||||
#[deprecated(
|
#[deprecated(
|
||||||
since = "0.4.0",
|
since = "0.4.0",
|
||||||
note = "Use `with_validator()` for validator nodes or `with_fullnode()` for full nodes instead"
|
note = "Use `with_validator()` for validator nodes or `with_fullnode()` for full nodes instead"
|
||||||
@@ -623,7 +623,7 @@ impl RelaychainConfigBuilder<WithAtLeastOneNode> {
|
|||||||
|
|
||||||
/// Add a new node using a nested [`NodeConfigBuilder`].
|
/// Add a new node using a nested [`NodeConfigBuilder`].
|
||||||
///
|
///
|
||||||
/// **Deprecated**: Use [`with_validator`] for validator nodes or [`with_fullnode`] for full nodes instead.
|
/// **Deprecated**: Use `with_validator` for validator nodes or `with_fullnode` for full nodes instead.
|
||||||
#[deprecated(
|
#[deprecated(
|
||||||
since = "0.4.0",
|
since = "0.4.0",
|
||||||
note = "Use `with_validator()` for validator nodes or `with_fullnode()` for full nodes instead"
|
note = "Use `with_validator()` for validator nodes or `with_fullnode()` for full nodes instead"
|
||||||
|
|||||||
@@ -882,7 +882,7 @@ impl<C: Context> TeyrchainConfigBuilder<WithId, C> {
|
|||||||
|
|
||||||
/// Add a new node using a nested [`NodeConfigBuilder`].
|
/// Add a new node using a nested [`NodeConfigBuilder`].
|
||||||
///
|
///
|
||||||
/// **Deprecated**: Use [`with_collator`] for collator nodes or [`with_fullnode`] for full nodes instead.
|
/// **Deprecated**: Use `with_collator` for collator nodes or `with_fullnode` for full nodes instead.
|
||||||
#[deprecated(
|
#[deprecated(
|
||||||
since = "0.4.0",
|
since = "0.4.0",
|
||||||
note = "Use `with_collator()` for collator nodes or `with_fullnode()` for full nodes instead"
|
note = "Use `with_collator()` for collator nodes or `with_fullnode()` for full nodes instead"
|
||||||
@@ -1014,7 +1014,7 @@ impl<C: Context> TeyrchainConfigBuilder<WithAtLeastOneCollator, C> {
|
|||||||
|
|
||||||
/// Add a new node using a nested [`NodeConfigBuilder`].
|
/// Add a new node using a nested [`NodeConfigBuilder`].
|
||||||
///
|
///
|
||||||
/// **Deprecated**: Use [`with_collator`] for collator nodes or [`with_fullnode`] for full nodes instead.
|
/// **Deprecated**: Use `with_collator` for collator nodes or `with_fullnode` for full nodes instead.
|
||||||
#[deprecated(
|
#[deprecated(
|
||||||
since = "0.4.0",
|
since = "0.4.0",
|
||||||
note = "Use `with_collator()` for collator nodes or `with_fullnode()` for full nodes instead"
|
note = "Use `with_collator()` for collator nodes or `with_fullnode()` for full nodes instead"
|
||||||
|
|||||||
+2
-2
@@ -90,8 +90,8 @@ const DEFAULT_PRESETS_TO_CHECK: [&str; 3] = ["local_testnet", "development", "de
|
|||||||
/// Chain-spec builder representation
|
/// Chain-spec builder representation
|
||||||
///
|
///
|
||||||
/// Multiple options are supported, and the current order is:
|
/// Multiple options are supported, and the current order is:
|
||||||
/// IF [`asset_location`] is _some_ -> Use this chain_spec by copying the file from [`AssetLocation`]
|
/// IF `asset_location` is _some_ -> Use this chain_spec by copying the file from [`AssetLocation`]
|
||||||
/// ELSE IF [`runtime_location`] is _some_ -> generate the chain-spec using the sc-chain-spec builder.
|
/// ELSE IF `runtime_location` is _some_ -> generate the chain-spec using the sc-chain-spec builder.
|
||||||
/// ELSE -> Fallback to use the `default` or customized cmd.
|
/// ELSE -> Fallback to use the `default` or customized cmd.
|
||||||
|
|
||||||
#[derive(Debug, Clone, Serialize, Deserialize)]
|
#[derive(Debug, Clone, Serialize, Deserialize)]
|
||||||
|
|||||||
@@ -185,7 +185,7 @@ impl NetworkNode {
|
|||||||
get_client_from_url(&self.ws_uri).await
|
get_client_from_url(&self.ws_uri).await
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Get the [online client](subxt::client::OnlineClient) for the node
|
/// Get the online client for the node
|
||||||
#[deprecated = "Use `wait_client` instead."]
|
#[deprecated = "Use `wait_client` instead."]
|
||||||
pub async fn client<Config: pezkuwi_subxt::Config>(
|
pub async fn client<Config: pezkuwi_subxt::Config>(
|
||||||
&self,
|
&self,
|
||||||
@@ -207,7 +207,7 @@ impl NetworkNode {
|
|||||||
get_client_from_url(&self.ws_uri).await
|
get_client_from_url(&self.ws_uri).await
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Wait until get the [online client](subxt::client::OnlineClient) for the node
|
/// Wait until get the online client for the node
|
||||||
pub async fn wait_client<Config: pezkuwi_subxt::Config>(
|
pub async fn wait_client<Config: pezkuwi_subxt::Config>(
|
||||||
&self,
|
&self,
|
||||||
) -> Result<OnlineClient<Config>, anyhow::Error> {
|
) -> Result<OnlineClient<Config>, anyhow::Error> {
|
||||||
@@ -219,7 +219,7 @@ impl NetworkNode {
|
|||||||
self.try_client().await.map_err(|e| anyhow!("Can't create a subxt client, err: {e}"))
|
self.try_client().await.map_err(|e| anyhow!("Can't create a subxt client, err: {e}"))
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Wait until get the [online client](subxt::client::OnlineClient) for the node with a defined timeout
|
/// Wait until get the online client for the node with a defined timeout
|
||||||
pub async fn wait_client_with_timeout<Config: pezkuwi_subxt::Config>(
|
pub async fn wait_client_with_timeout<Config: pezkuwi_subxt::Config>(
|
||||||
&self,
|
&self,
|
||||||
timeout_secs: impl Into<u64>,
|
timeout_secs: impl Into<u64>,
|
||||||
|
|||||||
Vendored
+1
-1
@@ -36,7 +36,7 @@ impl core::fmt::Debug for Token {
|
|||||||
|
|
||||||
impl Token {
|
impl Token {
|
||||||
/// Creates the specified amount of [`Token`] with its name and decimals filled from the
|
/// Creates the specified amount of [`Token`] with its name and decimals filled from the
|
||||||
/// [`TokenRegistry`] variant.
|
/// `TokenRegistry` variant.
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// # use ss58_registry::{Token, TokenRegistry};
|
/// # use ss58_registry::{Token, TokenRegistry};
|
||||||
|
|||||||
Reference in New Issue
Block a user