Skip to content
This repository has been archived by the owner on Nov 15, 2023. It is now read-only.

Commit

Permalink
Update docs (#7230)
Browse files Browse the repository at this point in the history
  • Loading branch information
gavofyork authored May 15, 2023
1 parent 1702beb commit 54c9ff1
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion xcm/xcm-builder/src/universal_exports.rs
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,15 @@ impl<Bridges: ExporterFor, Router: SendXcm, UniversalLocation: Get<InteriorMulti
}

pub trait DispatchBlob {
/// Dispatches an incoming blob and returns the unexpectable weight consumed by the dispatch.
/// Takes an incoming blob from over some point-to-point link (usually from some sort of
/// inter-consensus bridge) and then does what needs to be done with it. Usually this means
/// forwarding it on into some other location sharing our consensus or possibly just enqueuing
/// it for execution locally if it is destined for the local chain.
///
/// NOTE: The API does not provide for any kind of weight or fee management; the size of the
/// `blob` is known to the caller and so the operation must have a linear weight relative to
/// `blob`'s length. This means that you will generally only want to **enqueue** the blob, not
/// enact it. Fees must be handled by the caller.
fn dispatch_blob(blob: Vec<u8>) -> Result<(), DispatchBlobError>;
}

Expand Down

0 comments on commit 54c9ff1

Please sign in to comment.