pub trait Config<I: 'static = ()>: Config + Config {
type TransactAsset: Mutate<Self::AccountId>;
- type CheckedAccount: Get<Option<(Self::AccountId, MintLocation)>>;
+ type CheckedAccount: Get<Option<(Self::AccountId, MintLocation)>>;
type TrustedTeleporter: Get<Option<(MultiLocation, MultiAsset)>>;
type TrustedReserve: Get<Option<(MultiLocation, MultiAsset)>>;
@@ -13,7 +13,7 @@
Consequently, a runtime that wants to include this pallet must implement this trait.
The type of fungible that is being used under the hood.
This is useful for testing and checking.
-The account used to check assets being teleported.
+The account used to check assets being teleported.
A trusted location which we allow teleports from, and the asset we allow to teleport.
A trusted location where reserve assets are stored, and the asset we allow to be reserves.
diff --git a/doc/pallet_xcm_benchmarks/trait.Config.html b/doc/pallet_xcm_benchmarks/trait.Config.html index f72f1736966a..b4177124e304 100644 --- a/doc/pallet_xcm_benchmarks/trait.Config.html +++ b/doc/pallet_xcm_benchmarks/trait.Config.html @@ -1,15 +1,15 @@pub trait Config: Config {
- type XcmConfig: XcmConfig;
- type AccountIdConverter: ConvertLocation<Self::AccountId>;
+ type XcmConfig: XcmConfig;
+ type AccountIdConverter: ConvertLocation<Self::AccountId>;
// Required methods
fn valid_destination() -> Result<MultiLocation, BenchmarkError>;
fn worst_case_holding(depositable_count: u32) -> MultiAssets;
}A base trait for all individual pallets
-The XCM configurations.
These might affect the execution of XCM messages, such as defining how the
TransactAsset is implemented.
A converter between a multi-location to a sovereign account.
+A converter between a multi-location to a sovereign account.
Does any necessary setup to create a valid destination for XCM messages. Returns that destination’s multi-location to be used in benchmarks.
Worst case scenario for a holding account in this runtime.
diff --git a/doc/pallet_xcm_benchmarks/type.AssetTransactorOf.html b/doc/pallet_xcm_benchmarks/type.AssetTransactorOf.html index ae31d165cc6e..aae290645d2c 100644 --- a/doc/pallet_xcm_benchmarks/type.AssetTransactorOf.html +++ b/doc/pallet_xcm_benchmarks/type.AssetTransactorOf.html @@ -1,2 +1,2 @@ -pub type AssetTransactorOf<T> = <<T as Config>::XcmConfig as XcmConfig>::AssetTransactor;The asset transactor of our executor
+pub type AssetTransactorOf<T> = <<T as Config>::XcmConfig as XcmConfig>::AssetTransactor;The asset transactor of our executor
pub type ExecutorOf<T> = XcmExecutor<<T as Config>::XcmConfig>;The XCM executor to use for doing stuff.
+pub type ExecutorOf<T> = XcmExecutor<<T as Config>::XcmConfig>;The XCM executor to use for doing stuff.
pub type XcmCallOf<T> = <<T as Config>::XcmConfig as XcmConfig>::RuntimeCall;The call type of executor’s config. Should eventually resolve to the same overarching call type.
+pub type XcmCallOf<T> = <<T as Config>::XcmConfig as XcmConfig>::RuntimeCall;The call type of executor’s config. Should eventually resolve to the same overarching call type.
Subsystem and return SpawnedSubsystem.Self and consume all of the given input data. Read moreself to use its Binary implementation when Debug-formatted.self to use its Display implementation when
Debug-formatted.Self and consume all of the given input data. Read moreself to use its Binary implementation when Debug-formatted.self to use its Display implementation when
Debug-formatted.Self and consume all of the given input data. Read moreself to use its Binary implementation when Debug-formatted.self to use its Display implementation when
Debug-formatted.pub struct Handshake {
- pub executor_params: ExecutorParams,
+ pub executor_params: ExecutorParams,
}The payload of the one-time handshake that is done when a worker process is created. Carries data from the host to the worker.
-executor_params: ExecutorParamsThe executor parameters.
+executor_params: ExecutorParamsThe executor parameters.
Self and consume all of the given input data. Read moreself to use its Binary implementation when Debug-formatted.self to use its Display implementation when
Debug-formatted.pub fn params_to_wasmtime_semantics(
- par: &ExecutorParams
+ par: &ExecutorParams
) -> Result<Semantics, String>pub struct Executor { /* private fields */ }A WASM executor with a given configuration. It is instantiated once per execute worker and is specific to that worker.
-Self and consume all of the given input data. Read moreself to use its Binary implementation when Debug-formatted.self to use its Display implementation when
Debug-formatted.Self and consume all of the given input data. Read moreself to use its Binary implementation when Debug-formatted.self to use its Display implementation when
Debug-formatted.Self and consume all of the given input data. Read moreself to use its Binary implementation when Debug-formatted.self to use its Display implementation when
Debug-formatted.Self and consume all of the given input data. Read moreself to use its Binary implementation when Debug-formatted.self to use its Display implementation when
Debug-formatted.Should be cheap to clone.
Returns an instance of the PVF out of the given PVF code and executor params.
Returns validation code hash for the PVF
Returns executor params
+Returns executor params
Returns preparation timeout.
Returns preparation kind.
key and return true if they are equal.pub struct Executor { /* private fields */ }A WASM executor with a given configuration. It is instantiated once per execute worker and is +
pub struct Executor { /* private fields */ }A WASM executor with a given configuration. It is instantiated once per execute worker and is specific to that worker.
-Constructs the runtime for the given PVF, given the artifact bytes.
@@ -24,7 +24,7 @@Failure to adhere to these requirements might lead to crashes and arbitrary code execution.
-pub fn prepare(
blob: RuntimeBlob,
- executor_params: &ExecutorParams
+ executor_params: &ExecutorParams
) -> Result<Vec<u8>, WasmError>Runs preparation on the given runtime blob. If successful, it returns a serialized compiled
artifact which can then be used to pass into Executor::execute after writing it to the disk.
Attach a para-id to the span.
Attach a candidate stage.
Should always come with a CandidateHash.
Add an additional int tag to the span without consuming.
+ claimed_validator_index: ValidatorIndex +) -> SelfAdd an additional int tag to the span without consuming.
Should be used sparingly, introduction of new types is preferred.
Adds the FollowsFrom relationship to this span with respect to the given one.
Add a PoV hash meta tag with lazy hash evaluation, without consuming the span.
+Add a PoV hash meta tag with lazy hash evaluation, without consuming the span.
Add a string tag, without consuming the span.
Add a string tag, without consuming the span.
Check whether jaeger is enabled diff --git a/doc/polkadot_node_network_protocol/grid_topology/struct.GridNeighbors.html b/doc/polkadot_node_network_protocol/grid_topology/struct.GridNeighbors.html index 516e17374d29..b07cfa7d033b 100644 --- a/doc/polkadot_node_network_protocol/grid_topology/struct.GridNeighbors.html +++ b/doc/polkadot_node_network_protocol/grid_topology/struct.GridNeighbors.html @@ -1,18 +1,18 @@
pub struct GridNeighbors {
pub peers_x: HashSet<PeerId>,
- pub validator_indices_x: HashSet<ValidatorIndex>,
+ pub validator_indices_x: HashSet<ValidatorIndex>,
pub peers_y: HashSet<PeerId>,
- pub validator_indices_y: HashSet<ValidatorIndex>,
+ pub validator_indices_y: HashSet<ValidatorIndex>,
}Information about the grid neighbors for a particular node in the topology.
peers_x: HashSet<PeerId>Represent peers in the X axis
-validator_indices_x: HashSet<ValidatorIndex>Represent validators in the X axis
+validator_indices_x: HashSet<ValidatorIndex>Represent validators in the X axis
peers_y: HashSet<PeerId>Represent peers in the Y axis
-validator_indices_y: HashSet<ValidatorIndex>Represent validators in the Y axis
+validator_indices_y: HashSet<ValidatorIndex>Represent validators in the Y axis
Utility function for creating an empty set of grid neighbors. Useful for testing.
Given the originator of a message as a validator index, indicates the part of the topology we’re meant to send the message to.
diff --git a/doc/polkadot_node_network_protocol/grid_topology/struct.SessionBoundGridTopologyStorage.html b/doc/polkadot_node_network_protocol/grid_topology/struct.SessionBoundGridTopologyStorage.html index dc3569f2deb9..a68817532bd9 100644 --- a/doc/polkadot_node_network_protocol/grid_topology/struct.SessionBoundGridTopologyStorage.html +++ b/doc/polkadot_node_network_protocol/grid_topology/struct.SessionBoundGridTopologyStorage.html @@ -14,7 +14,7 @@ &mut self, session_index: SessionIndex, topology: SessionGridTopology, - local_index: Option<ValidatorIndex> + local_index: Option<ValidatorIndex> )Update the current topology preserving the previous one
Returns a current grid topology
Access the current grid topology mutably. Dangerous and intended diff --git a/doc/polkadot_node_network_protocol/grid_topology/struct.SessionGridTopologies.html b/doc/polkadot_node_network_protocol/grid_topology/struct.SessionGridTopologies.html index 9efea08db984..40116bbec26e 100644 --- a/doc/polkadot_node_network_protocol/grid_topology/struct.SessionGridTopologies.html +++ b/doc/polkadot_node_network_protocol/grid_topology/struct.SessionGridTopologies.html @@ -9,7 +9,7 @@ &mut self, session: SessionIndex, topology: SessionGridTopology, - local_index: Option<ValidatorIndex> + local_index: Option<ValidatorIndex> )
Insert a new topology, no-op if already present.
Create a new session grid topology.
Produces the outgoing routing logic for a particular peer.
Returns None if the validator index is out of bounds.
source. Read moreself and other values to be equal, and is used
diff --git a/doc/polkadot_node_network_protocol/grid_topology/struct.TopologyPeerInfo.html b/doc/polkadot_node_network_protocol/grid_topology/struct.TopologyPeerInfo.html
index 895cd36e1b6f..88b5b7b9f211 100644
--- a/doc/polkadot_node_network_protocol/grid_topology/struct.TopologyPeerInfo.html
+++ b/doc/polkadot_node_network_protocol/grid_topology/struct.TopologyPeerInfo.html
@@ -1,10 +1,10 @@
pub struct TopologyPeerInfo {
pub peer_ids: Vec<PeerId>,
- pub validator_index: ValidatorIndex,
+ pub validator_index: ValidatorIndex,
pub discovery_id: AuthorityDiscoveryId,
}Information about a peer in the gossip topology for a session.
peer_ids: Vec<PeerId>The validator’s known peer IDs.
-validator_index: ValidatorIndexThe index of the validator in the discovery keys of the corresponding +
validator_index: ValidatorIndexThe index of the validator in the discovery keys of the corresponding
SessionInfo. This can extend beyond the set of active parachain validators.
discovery_id: AuthorityDiscoveryIdThe authority discovery public key of the validator in the corresponding
SessionInfo.
Polkadot.OurView with the given chain heads, finalized number 0 and disabled
-[jaeger::Span]’s.View.jaeger::Span’s.View.macro_rules! our_view { ( $( $hash:expr ),* $(,)? ) => { ... }; }
Construct a new OurView with the given chain heads, finalized number 0 and disabled
-[jaeger::Span]’s.
jaeger::Span’s.
NOTE: Use for tests only.
let our_view = our_view![Hash::repeat_byte(1), Hash::repeat_byte(2)];key and return true if they are equal.pub enum AvailableDataFetchingResponse {
- AvailableData(AvailableData),
+ AvailableData(AvailableData),
NoSuchData,
}Receive a requested available data.
-The requested data.
+The requested data.
Node was not in possession of the requested data.
source. Read moreself to use its Binary implementation when Debug-formatted.self to use its Display implementation when
Debug-formatted.Self and consume all of the given input data. Read moreself to use its Binary implementation when Debug-formatted.self to use its Display implementation when
Debug-formatted.pub enum CollationFetchingResponse {
- Collation(CandidateReceipt, PoV),
+ Collation(CandidateReceipt, PoV),
}Responses as sent by collators.
-Deliver requested collation.
+Deliver requested collation.
source. Read moreSelf and consume all of the given input data. Read moreself to use its Binary implementation when Debug-formatted.self to use its Display implementation when
Debug-formatted.Self and consume all of the given input data. Read morekey and return true if they are equal.pub enum PoVFetchingResponse {
- PoV(PoV),
+ PoV(PoV),
NoSuchPoV,
}Responses to PoVFetchingRequest.
Deliver requested PoV.
+source. Read moreself to use its Binary implementation when Debug-formatted.self to use its Display implementation when
Debug-formatted.pub enum StatementFetchingResponse {
- Statement(CommittedCandidateReceipt),
+ Statement(CommittedCandidateReceipt),
}Respond with found full statement.
In this protocol the requester will only request data it was previously notified about,
therefore not having the data is not really an option and would just result in a
RequestFailure.
Data missing to reconstruct the full signed statement.
+Data missing to reconstruct the full signed statement.
source. Read moreSelf and consume all of the given input data. Read moreself to use its Binary implementation when Debug-formatted.self to use its Display implementation when
Debug-formatted.Self and consume all of the given input data. Read moreself to use its Binary implementation when Debug-formatted.self to use its Display implementation when
Debug-formatted.pub struct ChunkFetchingRequest {
pub candidate_hash: CandidateHash,
- pub index: ValidatorIndex,
+ pub index: ValidatorIndex,
}Request an availability chunk.
candidate_hash: CandidateHashHash of candidate we want a chunk for.
-index: ValidatorIndexThe index of the chunk to fetch.
+index: ValidatorIndexThe index of the chunk to fetch.
source. Read moreSelf and consume all of the given input data. Read moreself to use its Binary implementation when Debug-formatted.self to use its Display implementation when
Debug-formatted.pub struct ChunkResponse {
pub chunk: Vec<u8>,
- pub proof: Proof,
+ pub proof: Proof,
}Skimmed down variant of ErasureChunk.
Instead of transmitting a full ErasureChunk we transmit ChunkResponse in
ChunkFetchingResponse, which omits the chunk’s index. The index is already known by
the requester and by not transmitting it, we ensure the requester is going to use his index
value for validating the response, thus making sure he got what he requested.
chunk: Vec<u8>The erasure-encoded chunk of data belonging to the candidate block.
-proof: ProofProof for this chunk’s branch in the Merkle tree.
-Re-build an ErasureChunk from response and request.
proof: ProofProof for this chunk’s branch in the Merkle tree.
+Re-build an ErasureChunk from response and request.
source. Read moreself to use its Binary implementation when Debug-formatted.self to use its Display implementation when
Debug-formatted.Self and consume all of the given input data. Read moreself to use its Binary implementation when Debug-formatted.self to use its Display implementation when
Debug-formatted.pub struct DisputeRequest(pub UncheckedDisputeMessage);A dispute request.
+pub struct DisputeRequest(pub UncheckedDisputeMessage);A dispute request.
Contains an invalid vote a valid one for a particular candidate in a given session.
-0: UncheckedDisputeMessagesource. Read more0: UncheckedDisputeMessagesource. Read moreself to use its Binary implementation when Debug-formatted.self to use its Display implementation when
Debug-formatted.Self and consume all of the given input data. Read moreself to use its Binary implementation when Debug-formatted.self to use its Display implementation when
Debug-formatted.Self and consume all of the given input data. Read moreself to use its Binary implementation when Debug-formatted.self to use its Display implementation when
Debug-formatted.Self and consume all of the given input data. Read moreself to use its Binary implementation when Debug-formatted.self to use its Display implementation when
Debug-formatted.pub struct AttestedCandidateResponse {
- pub candidate_receipt: CommittedCandidateReceipt,
- pub persisted_validation_data: PersistedValidationData,
- pub statements: Vec<UncheckedSignedStatement>,
+ pub candidate_receipt: CommittedCandidateReceipt,
+ pub persisted_validation_data: PersistedValidationData,
+ pub statements: Vec<UncheckedSignedStatement>,
}Response to an AttestedCandidateRequest.
candidate_receipt: CommittedCandidateReceiptThe candidate receipt, with commitments.
-persisted_validation_data: PersistedValidationDataThe [PersistedValidationData] corresponding to the candidate.
statements: Vec<UncheckedSignedStatement>All known statements about the candidate, in compact form, +
candidate_receipt: CommittedCandidateReceiptThe candidate receipt, with commitments.
+persisted_validation_data: PersistedValidationDataThe PersistedValidationData corresponding to the candidate.
statements: Vec<UncheckedSignedStatement>All known statements about the candidate, in compact form,
omitting Seconded statements which were intended to be masked
out.
source. Read moreself to use its Binary implementation when Debug-formatted.self to use its Display implementation when
Debug-formatted.Self and consume all of the given input data. Read moreself to use its Binary implementation when Debug-formatted.self to use its Display implementation when
Debug-formatted.pub struct OurView { /* private fields */ }Specialized wrapper around View.
Besides the access to the view itself, it also gives access to the [jaeger::Span] per
+
Besides the access to the view itself, it also gives access to the jaeger::Span per
leave/head.
Creates a new instance.
-Returns the span per head map.
+Check if the number of heads contained, is null.
diff --git a/doc/polkadot_node_network_protocol/struct.View.html b/doc/polkadot_node_network_protocol/struct.View.html index 6f93bd92a35a..2d8e638351dc 100644 --- a/doc/polkadot_node_network_protocol/struct.View.html +++ b/doc/polkadot_node_network_protocol/struct.View.html @@ -58,8 +58,8 @@ ) -> Result<T, Error>Self and consume all of the given input data. Read morekey and return true if they are equal.pub enum ApprovalDistributionMessage {
- Assignments(Vec<(IndirectAssignmentCert, CandidateIndex)>),
- Approvals(Vec<IndirectSignedApprovalVote>),
+ Assignments(Vec<(IndirectAssignmentCert, CandidateIndex)>),
+ Approvals(Vec<IndirectSignedApprovalVote>),
}Network messages used by the approval distribution subsystem.
-Assignments for candidates in recent, unfinalized blocks.
+Assignments for candidates in recent, unfinalized blocks.
Actually checking the assignment may yield a different result.
-Approvals for candidates in some recent, unfinalized block.
+Approvals for candidates in some recent, unfinalized block.
source. Read moreSelf and consume all of the given input data. Read morekey and return true if they are equal.pub enum BitfieldDistributionMessage {
- Bitfield(Hash, UncheckedSignedAvailabilityBitfield),
+ Bitfield(Hash, UncheckedSignedAvailabilityBitfield),
}Network messages used by the bitfield distribution subsystem.
-A signed availability bitfield for a given relay-parent hash.
+A signed availability bitfield for a given relay-parent hash.
source. Read moreSelf and consume all of the given input data. Read morekey and return true if they are equal.Self and consume all of the given input data. Read morekey and return true if they are equal.pub enum CollatorProtocolMessage {
- Declare(CollatorId, ParaId, CollatorSignature),
+ Declare(CollatorId, ParaId, CollatorSignature),
AdvertiseCollation(Hash),
- CollationSeconded(Hash, UncheckedSignedFullStatement),
+ CollationSeconded(Hash, UncheckedSignedFullStatement),
}Network messages used by the collator protocol subsystem
-Declare the intent to advertise collations under a collator ID, attaching a +
Declare the intent to advertise collations under a collator ID, attaching a
signature of the PeerId of the node using the given collator ID key.
Advertise a collation to a validator. Can only be sent once the peer has declared that they are a collator with given ID.
-A collation sent to a validator was seconded.
+A collation sent to a validator was seconded.
source. Read moreSelf and consume all of the given input data. Read morekey and return true if they are equal.pub enum StatementDistributionMessage {
- Statement(Hash, UncheckedSignedFullStatement),
+ Statement(Hash, UncheckedSignedFullStatement),
LargeStatement(StatementMetadata),
}Network messages used by the statement distribution subsystem.
-A signed full statement under a given relay-parent.
+A signed full statement under a given relay-parent.
Seconded statement with large payload (e.g. containing a runtime upgrade).
We only gossip the hash in that case, actual payloads can be fetched from sending node via request/response.
-Get fingerprint describing the contained statement uniquely.
-Get the signature from the statement.
+Get fingerprint describing the contained statement uniquely.
+Get the signature from the statement.
Get contained relay parent.
Whether this message contains a large statement.
source. Read morekey and return true if they are equal.Self and consume all of the given input data. Read morekey and return true if they are equal.pub struct StatementMetadata {
pub relay_parent: Hash,
pub candidate_hash: CandidateHash,
- pub signed_by: ValidatorIndex,
- pub signature: ValidatorSignature,
+ pub signed_by: ValidatorIndex,
+ pub signature: ValidatorSignature,
}Data that makes a statement unique.
relay_parent: HashRelay parent this statement is relevant under.
candidate_hash: CandidateHashHash of the candidate that got validated.
-signed_by: ValidatorIndexValidator that attested the validity.
-signature: ValidatorSignatureSignature of seconding validator.
+signed_by: ValidatorIndexValidator that attested the validity.
+signature: ValidatorSignatureSignature of seconding validator.
source. Read moreSelf and consume all of the given input data. Read morekey and return true if they are equal.