Enum WalletSigner

pub enum WalletSigner {
    Local(PrivateKeySigner),
    Ledger(LedgerSigner),
    Trezor(TrezorSigner),
    Aws(AwsSigner),
    Gcp(GcpSigner),
}

Wrapper enum around different signers.

Variants

Local(PrivateKeySigner)

Wrapper around local wallet. e.g. private key, mnemonic

Ledger(LedgerSigner)

Wrapper around Ledger signer.

Trezor(TrezorSigner)

Wrapper around Trezor signer.

Aws(AwsSigner)

Available on crate feature aws-kms only.

Wrapper around AWS KMS signer.

Gcp(GcpSigner)

Available on crate feature gcp-kms only.

Wrapper around Google Cloud KMS signer.

Implementations

impl WalletSigner

pub async fn from_ledger_path(path: LedgerHDPath) -> Result<Self>

pub async fn from_trezor_path(path: TrezorHDPath) -> Result<Self>

pub async fn from_aws(key_id: String) -> Result<Self>

pub async fn from_gcp( project_id: String, location: String, keyring: String, key_name: String, key_version: u64, ) -> Result<Self>

pub fn from_private_key(private_key: &B256) -> Result<Self>

pub async fn available_senders(&self, max: usize) -> Result<Vec<Address>>

Returns a list of addresses available to use with current signer

• for Ledger and Trezor signers the number of addresses to retrieve is specified as argument
• the result for Ledger signers includes addresses available for both LedgerLive and Legacy derivation paths
• for Local and AWS signers the result contains a single address

pub fn from_mnemonic( mnemonic: &str, passphrase: Option<&str>, derivation_path: Option<&str>, index: u32, ) -> Result<Self>

Trait Implementations

impl Debug for WalletSigner

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

Formats the value using the given formatter.

impl Signer for WalletSigner

fn sign_hash<'life0, 'life1, 'async_trait>( &'life0 self, hash: &'life1 B256, ) -> Pin<Box<dyn Future<Output = Result<PrimitiveSignature>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Signs the given hash.

fn sign_message<'life0, 'life1, 'async_trait>( &'life0 self, message: &'life1 [u8], ) -> Pin<Box<dyn Future<Output = Result<PrimitiveSignature>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Signs the hash of the provided message after prefixing it, as specified in EIP-191.

fn address(&self) -> Address

Returns the signer’s Ethereum Address.

fn chain_id(&self) -> Option<ChainId>

Returns the signer’s chain ID.

fn set_chain_id(&mut self, chain_id: Option<ChainId>)

Sets the signer’s chain ID.

fn sign_typed_data<'life0, 'life1, 'life2, 'async_trait, T>( &'life0 self, payload: &'life1 T, domain: &'life2 Eip712Domain, ) -> Pin<Box<dyn Future<Output = Result<PrimitiveSignature>> + Send + 'async_trait>>

where Self: Sized + 'async_trait, T: 'async_trait + SolStruct + Send + Sync, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Available on crate feature eip712 only.

Encodes and signs the typed data according to EIP-712.

fn sign_dynamic_typed_data<'life0, 'life1, 'async_trait>( &'life0 self, payload: &'life1 TypedData, ) -> Pin<Box<dyn Future<Output = Result<PrimitiveSignature>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Available on crate feature eip712 only.

Encodes and signs the typed data according to [EIP-712] for Signers that are not dynamically sized.

fn with_chain_id(self, chain_id: Option<u64>) -> Self

where Self: Sized,

Sets the signer’s chain ID and returns self.

impl TxSigner<PrimitiveSignature> for WalletSigner

fn address(&self) -> Address

Get the address of the signer.

fn sign_transaction<'life0, 'life1, 'async_trait>( &'life0 self, tx: &'life1 mut dyn SignableTransaction<PrimitiveSignature>, ) -> Pin<Box<dyn Future<Output = Result<PrimitiveSignature>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Asynchronously sign an unsigned transaction.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 272 bytes

Size for each variant:

• Local: 184 bytes
• Ledger: 136 bytes
• Trezor: 96 bytes
• Aws: 184 bytes
• Gcp: 272 bytes