Struct polkadot_sdk_frame::prelude::frame_system::offchain::Signer

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

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

impl<T, C, X> Signer<T, C, X>

where T: SigningTypes, C: AppCrypto<<T as SigningTypes>::Public, <T as SigningTypes>::Signature>,

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

Use all available keys for signing.

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

Use any of the available keys for signing.

pub fn with_filter( self, accounts: Vec<<T as SigningTypes>::Public>, ) -> Signer<T, C, X>

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.

pub fn can_sign(&self) -> bool

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

pub fn accounts_from_keys<'a>( &'a self, ) -> Box<dyn Iterator<Item = Account<T>> + 'a>

Return a vector of the intersection between all available accounts and the provided accounts in with_filter. If no accounts are provided, use all accounts by default.

pub fn keystore_accounts() -> impl Iterator<Item = Account<T>>

Return all available accounts in keystore.

Trait Implementations

impl<T, C, X> Debug for Signer<T, C, X>

where T: SigningTypes + Debug, C: AppCrypto<<T as SigningTypes>::Public, <T as SigningTypes>::Signature> + Debug, X: Debug,

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

Formats the value using the given formatter.

impl<T, C, X> Default for Signer<T, C, X>

where T: SigningTypes, C: AppCrypto<<T as SigningTypes>::Public, <T as SigningTypes>::Signature>,

fn default() -> Signer<T, C, X>

Returns the “default value” for a type.

impl<T, C, LocalCall> SendSignedTransaction<T, C, LocalCall> for Signer<T, C>

where T: CreateSignedTransaction<LocalCall> + SigningTypes, C: AppCrypto<<T as SigningTypes>::Public, <T as SigningTypes>::Signature>,

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

A submission result.

fn send_signed_transaction( &self, f: impl Fn(&Account<T>) -> LocalCall, ) -> <Signer<T, C> as SendSignedTransaction<T, C, LocalCall>>::Result

Submit a signed transaction to the local pool.

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.

impl<T, C, LocalCall> SendSignedTransaction<T, C, LocalCall> for Signer<T, C, ForAll>

where T: SigningTypes + CreateSignedTransaction<LocalCall>, C: AppCrypto<<T as SigningTypes>::Public, <T as SigningTypes>::Signature>,

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

A submission result.

fn send_signed_transaction( &self, f: impl Fn(&Account<T>) -> LocalCall, ) -> <Signer<T, C, ForAll> as SendSignedTransaction<T, C, LocalCall>>::Result

Submit a signed transaction to the local pool.

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.

impl<T, C, LocalCall> SendUnsignedTransaction<T, LocalCall> for Signer<T, C>

where T: SigningTypes + CreateInherent<LocalCall>, C: AppCrypto<<T as SigningTypes>::Public, <T as SigningTypes>::Signature>,

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

A submission result.

fn send_unsigned_transaction<TPayload, F>( &self, f: F, f2: impl Fn(TPayload, <T as SigningTypes>::Signature) -> LocalCall, ) -> <Signer<T, C> as SendUnsignedTransaction<T, LocalCall>>::Result

where F: Fn(&Account<T>) -> TPayload, TPayload: SignedPayload<T>,

Send an unsigned transaction with a signed payload.

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

Submits an unsigned call to the transaction pool.

impl<T, C, LocalCall> SendUnsignedTransaction<T, LocalCall> for Signer<T, C, ForAll>

where T: SigningTypes + CreateInherent<LocalCall>, C: AppCrypto<<T as SigningTypes>::Public, <T as SigningTypes>::Signature>,

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

A submission result.

fn send_unsigned_transaction<TPayload, F>( &self, f: F, f2: impl Fn(TPayload, <T as SigningTypes>::Signature) -> LocalCall, ) -> <Signer<T, C, ForAll> as SendUnsignedTransaction<T, LocalCall>>::Result

where F: Fn(&Account<T>) -> TPayload, TPayload: SignedPayload<T>,

Send an unsigned transaction with a signed payload.

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

Submits an unsigned call to the transaction pool.

impl<T, C> SignMessage<T> for Signer<T, C>

where T: SigningTypes, C: AppCrypto<<T as SigningTypes>::Public, <T as SigningTypes>::Signature>,

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

A signature data.

fn sign_message( &self, message: &[u8], ) -> <Signer<T, C> as SignMessage<T>>::SignatureData

Sign a message.

fn sign<TPayload, F>( &self, f: F, ) -> <Signer<T, C> as SignMessage<T>>::SignatureData

where F: Fn(&Account<T>) -> TPayload, TPayload: SignedPayload<T>,

Construct and sign given payload.

impl<T, C> SignMessage<T> for Signer<T, C, ForAll>

where T: SigningTypes, C: AppCrypto<<T as SigningTypes>::Public, <T as SigningTypes>::Signature>,

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

A signature data.

fn sign_message( &self, message: &[u8], ) -> <Signer<T, C, ForAll> as SignMessage<T>>::SignatureData

Sign a message.

fn sign<TPayload, F>( &self, f: F, ) -> <Signer<T, C, ForAll> as SignMessage<T>>::SignatureData

where F: Fn(&Account<T>) -> TPayload, TPayload: SignedPayload<T>,

Construct and sign given payload.