Struct cumulus_primitives_core::relay_chain::v2::Signed

pub struct Signed<Payload, RealPayload = Payload>(_);

Signed data with signature already verified.

NOTE: This type does not have an Encode/Decode instance, as this would cancel out our valid signature guarantees. If you need to encode/decode you have to convert into an UncheckedSigned first.

Signed can easily be converted into UncheckedSigned and conversion back via into_signed enforces a valid signature again.

Implementations

impl<Payload, RealPayload> Signed<Payload, RealPayload>

pub fn into_unchecked(self) -> UncheckedSigned<Payload, RealPayload>

Convert back to an unchecked type.

impl<Payload, RealPayload> Signed<Payload, RealPayload>where
    Payload: EncodeAs<RealPayload>,
    RealPayload: Encode,

pub fn new<H>(
    payload: Payload,
    validator_index: ValidatorIndex,
    signature: Signature,
    context: &SigningContext<H>,
    key: &Public
) -> Option<Signed<Payload, RealPayload>>where
    H: Encode,

Used to create a Signed from already existing parts.

The signature is checked as part of the process.

pub async fn sign<H>(
    keystore: &Arc<dyn SyncCryptoStore + 'static>,
    payload: Payload,
    context: &SigningContext<H>,
    validator_index: ValidatorIndex,
    key: &Public
) -> impl Future<Output = Result<Option<Signed<Payload, RealPayload>>, Error>>where
    H: Encode,

Create a new Signed by signing data.

pub fn try_from_unchecked<H>(
    unchecked: UncheckedSigned<Payload, RealPayload>,
    context: &SigningContext<H>,
    key: &Public
) -> Result<Signed<Payload, RealPayload>, UncheckedSigned<Payload, RealPayload>>where
    H: Encode,

Try to convert from UncheckedSigned by checking the signature.

pub fn as_unchecked(&self) -> &UncheckedSigned<Payload, RealPayload>

Get a reference to data as unchecked.

pub fn payload(&self) -> &Payload

Immutably access the payload.

pub fn validator_index(&self) -> ValidatorIndex

Immutably access the validator index.

pub fn signature(&self) -> &Signature

Immutably access the signature.

pub fn into_payload(self) -> Payload

Discard signing data, get the payload

pub fn convert_payload(&self) -> Signed<RealPayload, RealPayload>where
    &'a Payload: for<'a> Into<RealPayload>,

Convert Payload into RealPayload.

pub fn convert_to_superpayload<SuperPayload>(
    self,
    claimed: SuperPayload
) -> Result<Signed<SuperPayload, RealPayload>, (Signed<Payload, RealPayload>, SuperPayload)>where
    SuperPayload: EncodeAs<RealPayload>,
    Payload: Encode,

Convert Payload into some claimed SuperPayload if the encoding matches.

Succeeds if and only if the super-payload provided actually encodes as the expected payload.

Trait Implementations

impl<Payload, RealPayload> Clone for Signed<Payload, RealPayload>where
    Payload: Clone,
    RealPayload: Clone,

fn clone(&self) -> Signed<Payload, RealPayload>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<Payload, RealPayload> Debug for Signed<Payload, RealPayload>where
    Payload: Debug,
    RealPayload: Debug,

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<Payload, RealPayload> From<Signed<Payload, RealPayload>> for UncheckedSigned<Payload, RealPayload>

fn from(
    signed: Signed<Payload, RealPayload>
) -> UncheckedSigned<Payload, RealPayload>

Converts to this type from the input type.

impl<Payload, RealPayload> PartialEq<Signed<Payload, RealPayload>> for Signed<Payload, RealPayload>where
    Payload: PartialEq<Payload>,
    RealPayload: PartialEq<RealPayload>,

fn eq(&self, other: &Signed<Payload, RealPayload>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Payload, RealPayload> Eq for Signed<Payload, RealPayload>where
    Payload: Eq,
    RealPayload: Eq,

impl<Payload, RealPayload> StructuralEq for Signed<Payload, RealPayload>

impl<Payload, RealPayload> StructuralPartialEq for Signed<Payload, RealPayload>