Struct frame_system::offchain::Signer

source · [−]

pub struct Signer<T: SigningTypes, C: AppCrypto<T::Public, T::Signature>, X = ForAny> { /* private fields */ }

Expand description

Provides an implementation for signing transaction payloads.

Keys used for signing are defined when instantiating the signer object. Signing can be done using:

All supported keys in the keystore
Any of the supported keys in the keystore
An intersection of in-keystore keys and the list of provided keys

The signer is then able to:

Submit a unsigned transaction with a signed payload
Submit a signed transaction

Implementations

source

impl<T: SigningTypes, C: AppCrypto<T::Public, T::Signature>, X> Signer<T, C, X>

source

pub fn all_accounts() -> Signer<T, C, ForAll>

Use all available keys for signing.

source

pub fn any_account() -> Signer<T, C, ForAny>

Use any of the available keys for signing.

source

pub fn with_filter(self, accounts: Vec<T::Public>) -> Self

Use provided accounts for signing.

Note that not all keys will be necessarily used. The provided vector of accounts will be intersected with the supported keys in the keystore and the resulting list will be used for signing.

source

pub fn can_sign(&self) -> bool

Check if there are any keys that could be used for signing.

Trait Implementations

source

impl<T: SigningTypes, C: AppCrypto<T::Public, T::Signature>, X> Debug for Signer<T, C, X> where
 T: Debug,
 C: Debug,
 X: Debug,

source

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

Formats the value using the given formatter. Read more

source

impl<T: SigningTypes, C: AppCrypto<T::Public, T::Signature>, X> Default for Signer<T, C, X>

source

fn default() -> Self

Returns the “default value” for a type. Read more

source

impl<T: CreateSignedTransaction<LocalCall> + SigningTypes, C: AppCrypto<T::Public, T::Signature>, LocalCall> SendSignedTransaction<T, C, LocalCall> for Signer<T, C, ForAny>

type Result = Option<(Account<T>, Result<(), ()>)>

A submission result. Read more

source

fn send_signed_transaction(
&self,
f: impl Fn(&Account<T>) -> LocalCall
) -> Self::Result

Submit a signed transaction to the local pool. Read more

source

fn send_single_signed_transaction(
 &self,
 account: &Account<T>,
 call: LocalCall
) -> Option<Result<(), ()>>

Wraps the call into transaction, signs using given account and submits to the pool.

source

impl<T: SigningTypes + CreateSignedTransaction<LocalCall>, C: AppCrypto<T::Public, T::Signature>, LocalCall> SendSignedTransaction<T, C, LocalCall> for Signer<T, C, ForAll>

type Result = Vec<(Account<T>, Result<(), ()>)>

A submission result. Read more

source

fn send_signed_transaction(
&self,
f: impl Fn(&Account<T>) -> LocalCall
) -> Self::Result

Submit a signed transaction to the local pool. Read more

source

fn send_single_signed_transaction(
 &self,
 account: &Account<T>,
 call: LocalCall
) -> Option<Result<(), ()>>

Wraps the call into transaction, signs using given account and submits to the pool.

source

impl<T: SigningTypes + SendTransactionTypes<LocalCall>, C: AppCrypto<T::Public, T::Signature>, LocalCall> SendUnsignedTransaction<T, LocalCall> for Signer<T, C, ForAny>

type Result = Option<(Account<T>, Result<(), ()>)>

A submission result. Read more

source

fn send_unsigned_transaction<TPayload, F>(
 &self,
 f: F,
 f2: impl Fn(TPayload, T::Signature) -> LocalCall
) -> Self::Result where
 F: Fn(&Account<T>) -> TPayload,
 TPayload: SignedPayload<T>,

Send an unsigned transaction with a signed payload. Read more

source

fn submit_unsigned_transaction(&self, call: LocalCall) -> Option<Result<(), ()>>

Submits an unsigned call to the transaction pool.

source

impl<T: SigningTypes + SendTransactionTypes<LocalCall>, C: AppCrypto<T::Public, T::Signature>, LocalCall> SendUnsignedTransaction<T, LocalCall> for Signer<T, C, ForAll>

type Result = Vec<(Account<T>, Result<(), ()>)>

A submission result. Read more

source

fn send_unsigned_transaction<TPayload, F>(
 &self,
 f: F,
 f2: impl Fn(TPayload, T::Signature) -> LocalCall
) -> Self::Result where
 F: Fn(&Account<T>) -> TPayload,
 TPayload: SignedPayload<T>,

Send an unsigned transaction with a signed payload. Read more

source

fn submit_unsigned_transaction(&self, call: LocalCall) -> Option<Result<(), ()>>

Submits an unsigned call to the transaction pool.

source

impl<T: SigningTypes, C: AppCrypto<T::Public, T::Signature>> SignMessage<T> for Signer<T, C, ForAll>

type SignatureData = Vec<(Account<T>, T::Signature )>

A signature data. Read more

source

fn sign_message(&self, message: &[u8 ]) -> Self::SignatureData

Sign a message. Read more

source

fn sign<TPayload, F>(&self, f: F) -> Self::SignatureData where
F: Fn(&Account<T>) -> TPayload,
TPayload: SignedPayload<T>,

Construct and sign given payload. Read more

source

impl<T: SigningTypes, C: AppCrypto<T::Public, T::Signature>> SignMessage<T> for Signer<T, C, ForAny>

type SignatureData = Option<(Account<T>, T::Signature )>

A signature data. Read more

source

fn sign_message(&self, message: &[u8 ]) -> Self::SignatureData

Sign a message. Read more

source

fn sign<TPayload, F>(&self, f: F) -> Self::SignatureData where
F: Fn(&Account<T>) -> TPayload,
TPayload: SignedPayload<T>,

Construct and sign given payload. Read more

Auto Trait Implementations

impl<T, C, X> RefUnwindSafe for Signer<T, C, X> where
 C: RefUnwindSafe,
 X: RefUnwindSafe,
 <T as SigningTypes>::Public: RefUnwindSafe,

impl<T, C, X> Send for Signer<T, C, X> where
 C: Send,
 X: Send,
 <T as SigningTypes>::Public: Send,

impl<T, C, X> Sync for Signer<T, C, X> where
 C: Sync,
 X: Sync,
 <T as SigningTypes>::Public: Sync,

impl<T, C, X> Unpin for Signer<T, C, X> where
 C: Unpin,
 X: Unpin,
 <T as SigningTypes>::Public: Unpin,

impl<T, C, X> UnwindSafe for Signer<T, C, X> where
 C: UnwindSafe,
 X: UnwindSafe,
 <T as SigningTypes>::Public: UnwindSafe,

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> CheckedConversion for T

source

fn checked_from<T>(t: T) -> Option<Self> where
Self: TryFrom<T>,

Convert from a value of T into an equivalent instance of Option<Self>. Read more

source

fn checked_into<T>(self) -> Option<T> where
Self: TryInto<T>,

Consume self to return Some equivalent value of Option<T>. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> IsType<T> for T

source

pub fn from_ref(t: &T) -> &T

Cast reference.

source

pub fn into_ref(&self) -> &T

Cast reference.

source

pub fn from_mut(t: &mut T) -> &mut T

Cast mutable reference.

source

pub fn into_mut(&mut self) -> &mut T

Cast mutable reference.

source

impl<T, Outer> IsWrappedBy<Outer> for T where
Outer: AsRef<T> + AsMut<T> + From<T>,
T: From<Outer>,

source

pub fn from_ref(outer: &Outer) -> &T

Get a reference to the inner from the outer.

source

pub fn from_mut(outer: &mut Outer) -> &mut T

Get a mutable reference to the inner from the outer.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> SaturatedConversion for T

source

fn saturated_from<T>(t: T) -> Self where
Self: UniqueSaturatedFrom<T>,

Convert from a value of T into an equivalent instance of Self. Read more

source

fn saturated_into<T>(self) -> T where
Self: UniqueSaturatedInto<T>,

Consume self to return an equivalent value of T. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<S, T> UncheckedInto<T> for S where
T: UncheckedFrom<S>,

source

pub fn unchecked_into(self) -> T

The counterpart to unchecked_from.

source

impl<T, S> UniqueSaturatedInto<T> for S where
T: Bounded,
S: TryInto<T>,

source

pub fn unique_saturated_into(self) -> T

Consume self to return an equivalent value of T.

source

Struct frame_system::offchain::Signer

Implementations

impl<T: SigningTypes, C: AppCrypto<T::Public, T::Signature>, X> Signer<T, C, X>

pub fn all_accounts() -> Signer<T, C, ForAll>

pub fn any_account() -> Signer<T, C, ForAny>

pub fn with_filter(self, accounts: Vec<T::Public>) -> Self

pub fn can_sign(&self) -> bool

Trait Implementations

impl<T: SigningTypes, C: AppCrypto<T::Public, T::Signature>, X> Debug for Signer<T, C, X> where T: Debug, C: Debug, X: Debug,

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

impl<T: SigningTypes, C: AppCrypto<T::Public, T::Signature>, X> Default for Signer<T, C, X>

fn default() -> Self

impl<T: CreateSignedTransaction<LocalCall> + SigningTypes, C: AppCrypto<T::Public, T::Signature>, LocalCall> SendSignedTransaction<T, C, LocalCall> for Signer<T, C, ForAny>

type Result = Option<(Account<T>, Result<(), ()>)>

fn send_signed_transaction( &self, f: impl Fn(&Account<T>) -> LocalCall) -> Self::Result

fn send_single_signed_transaction( &self, account: &Account<T>, call: LocalCall) -> Option<Result<(), ()>>

impl<T: SigningTypes + CreateSignedTransaction<LocalCall>, C: AppCrypto<T::Public, T::Signature>, LocalCall> SendSignedTransaction<T, C, LocalCall> for Signer<T, C, ForAll>

type Result = Vec<(Account<T>, Result<(), ()>)>

fn send_signed_transaction( &self, f: impl Fn(&Account<T>) -> LocalCall) -> Self::Result

fn send_single_signed_transaction( &self, account: &Account<T>, call: LocalCall) -> Option<Result<(), ()>>

impl<T: SigningTypes + SendTransactionTypes<LocalCall>, C: AppCrypto<T::Public, T::Signature>, LocalCall> SendUnsignedTransaction<T, LocalCall> for Signer<T, C, ForAny>

type Result = Option<(Account<T>, Result<(), ()>)>

fn send_unsigned_transaction<TPayload, F>( &self, f: F, f2: impl Fn(TPayload, T::Signature) -> LocalCall) -> Self::Result where F: Fn(&Account<T>) -> TPayload, TPayload: SignedPayload<T>,

fn submit_unsigned_transaction(&self, call: LocalCall) -> Option<Result<(), ()>>

impl<T: SigningTypes + SendTransactionTypes<LocalCall>, C: AppCrypto<T::Public, T::Signature>, LocalCall> SendUnsignedTransaction<T, LocalCall> for Signer<T, C, ForAll>

type Result = Vec<(Account<T>, Result<(), ()>)>

fn send_unsigned_transaction<TPayload, F>( &self, f: F, f2: impl Fn(TPayload, T::Signature) -> LocalCall) -> Self::Result where F: Fn(&Account<T>) -> TPayload, TPayload: SignedPayload<T>,

fn submit_unsigned_transaction(&self, call: LocalCall) -> Option<Result<(), ()>>

impl<T: SigningTypes, C: AppCrypto<T::Public, T::Signature>> SignMessage<T> for Signer<T, C, ForAll>

type SignatureData = Vec<(Account<T>, T::Signature)>

fn sign_message(&self, message: &[u8]) -> Self::SignatureData

fn sign<TPayload, F>(&self, f: F) -> Self::SignatureData where F: Fn(&Account<T>) -> TPayload, TPayload: SignedPayload<T>,

impl<T: SigningTypes, C: AppCrypto<T::Public, T::Signature>> SignMessage<T> for Signer<T, C, ForAny>

type SignatureData = Option<(Account<T>, T::Signature)>

fn sign_message(&self, message: &[u8]) -> Self::SignatureData

fn sign<TPayload, F>(&self, f: F) -> Self::SignatureData where F: Fn(&Account<T>) -> TPayload, TPayload: SignedPayload<T>,

Auto Trait Implementations

impl<T, C, X> RefUnwindSafe for Signer<T, C, X> where C: RefUnwindSafe, X: RefUnwindSafe, <T as SigningTypes>::Public: RefUnwindSafe,

impl<T, C, X> Send for Signer<T, C, X> where C: Send, X: Send, <T as SigningTypes>::Public: Send,

impl<T, C, X> Sync for Signer<T, C, X> where C: Sync, X: Sync, <T as SigningTypes>::Public: Sync,

impl<T, C, X> Unpin for Signer<T, C, X> where C: Unpin, X: Unpin, <T as SigningTypes>::Public: Unpin,

impl<T, C, X> UnwindSafe for Signer<T, C, X> where C: UnwindSafe, X: UnwindSafe, <T as SigningTypes>::Public: UnwindSafe,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> CheckedConversion for T

fn checked_from<T>(t: T) -> Option<Self> where Self: TryFrom<T>,

fn checked_into<T>(self) -> Option<T> where Self: TryInto<T>,

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> IsType<T> for T

pub fn from_ref(t: &T) -> &T

pub fn into_ref(&self) -> &T

pub fn from_mut(t: &mut T) -> &mut T

pub fn into_mut(&mut self) -> &mut T

impl<T, Outer> IsWrappedBy<Outer> for T where Outer: AsRef<T> + AsMut<T> + From<T>, T: From<Outer>,

pub fn from_ref(outer: &Outer) -> &T

pub fn from_mut(outer: &mut Outer) -> &mut T

impl<T> Same<T> for T

type Output = T

impl<T> SaturatedConversion for T

fn saturated_from<T>(t: T) -> Self where Self: UniqueSaturatedFrom<T>,

fn saturated_into<T>(self) -> T where Self: UniqueSaturatedInto<T>,

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<S, T> UncheckedInto<T> for S where T: UncheckedFrom<S>,

pub fn unchecked_into(self) -> T

impl<T: SigningTypes, C: AppCrypto<T::Public, T::Signature>, X> Debug for Signer<T, C, X> where
T: Debug,
C: Debug,
X: Debug,

fn send_signed_transaction(
&self,
f: impl Fn(&Account<T>) -> LocalCall
) -> Self::Result

fn send_single_signed_transaction(
&self,
account: &Account<T>,
call: LocalCall
) -> Option<Result<(), ()>>

fn send_signed_transaction(
&self,
f: impl Fn(&Account<T>) -> LocalCall
) -> Self::Result

fn send_single_signed_transaction(
&self,
account: &Account<T>,
call: LocalCall
) -> Option<Result<(), ()>>

fn send_unsigned_transaction<TPayload, F>(
&self,
f: F,
f2: impl Fn(TPayload, T::Signature) -> LocalCall
) -> Self::Result where
F: Fn(&Account<T>) -> TPayload,
TPayload: SignedPayload<T>,

fn send_unsigned_transaction<TPayload, F>(
&self,
f: F,
f2: impl Fn(TPayload, T::Signature) -> LocalCall
) -> Self::Result where
F: Fn(&Account<T>) -> TPayload,
TPayload: SignedPayload<T>,

type SignatureData = Vec<(Account<T>, T::Signature )>

fn sign_message(&self, message: &[u8 ]) -> Self::SignatureData

fn sign<TPayload, F>(&self, f: F) -> Self::SignatureData where
F: Fn(&Account<T>) -> TPayload,
TPayload: SignedPayload<T>,

type SignatureData = Option<(Account<T>, T::Signature )>

fn sign_message(&self, message: &[u8 ]) -> Self::SignatureData

fn sign<TPayload, F>(&self, f: F) -> Self::SignatureData where
F: Fn(&Account<T>) -> TPayload,
TPayload: SignedPayload<T>,

impl<T, C, X> RefUnwindSafe for Signer<T, C, X> where
C: RefUnwindSafe,
X: RefUnwindSafe,
<T as SigningTypes>::Public: RefUnwindSafe,

impl<T, C, X> Send for Signer<T, C, X> where
C: Send,
X: Send,
<T as SigningTypes>::Public: Send,

impl<T, C, X> Sync for Signer<T, C, X> where
C: Sync,
X: Sync,
<T as SigningTypes>::Public: Sync,

impl<T, C, X> Unpin for Signer<T, C, X> where
C: Unpin,
X: Unpin,
<T as SigningTypes>::Public: Unpin,

impl<T, C, X> UnwindSafe for Signer<T, C, X> where
C: UnwindSafe,
X: UnwindSafe,
<T as SigningTypes>::Public: UnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

fn checked_from<T>(t: T) -> Option<Self> where
Self: TryFrom<T>,

fn checked_into<T>(self) -> Option<T> where
Self: TryInto<T>,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, Outer> IsWrappedBy<Outer> for T where
Outer: AsRef<T> + AsMut<T> + From<T>,
T: From<Outer>,

fn saturated_from<T>(t: T) -> Self where
Self: UniqueSaturatedFrom<T>,

fn saturated_into<T>(self) -> T where
Self: UniqueSaturatedInto<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<S, T> UncheckedInto<T> for S where
T: UncheckedFrom<S>,

impl<T, S> UniqueSaturatedInto<T> for S where
T: Bounded,
S: TryInto<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

impl<T> MaybeDebug for T where
T: Debug,

impl<T> MaybeDebug for T where
T: Debug,

impl<T> MaybeRefUnwindSafe for T where
T: RefUnwindSafe,