Struct ethers_signers::Wallet [−][src]
An Ethereum private-public key pair which can be used for signing messages.
Examples
Signing and Verifying a message
The wallet can be used to produce ECDSA Signature objects, which can be
then verified. Note that this uses hash_message under the hood which will
prefix the message being hashed with the Ethereum Signed Message domain separator.
use ethers_core::rand::thread_rng; use ethers_signers::{LocalWallet, Signer}; let wallet = LocalWallet::new(&mut thread_rng()); // Optionally, the wallet's chain id can be set, in order to use EIP-155 // replay protection with different chains let wallet = wallet.set_chain_id(1337u64); // The wallet can be used to sign messages let message = b"hello"; let signature = wallet.sign_message(message).await?; assert_eq!(signature.recover(&message[..]).unwrap(), wallet.address());
Implementations
impl Wallet<SigningKey>[src]
pub fn new_keystore<P, R, S>(
dir: P,
rng: &mut R,
password: S
) -> Result<Self, WalletError> where
P: AsRef<Path>,
R: Rng + CryptoRng,
S: AsRef<[u8]>, [src]
dir: P,
rng: &mut R,
password: S
) -> Result<Self, WalletError> where
P: AsRef<Path>,
R: Rng + CryptoRng,
S: AsRef<[u8]>,
Creates a new random encrypted JSON with the provided password and stores it in the provided directory
pub fn decrypt_keystore<P, S>(
keypath: P,
password: S
) -> Result<Self, WalletError> where
P: AsRef<Path>,
S: AsRef<[u8]>, [src]
keypath: P,
password: S
) -> Result<Self, WalletError> where
P: AsRef<Path>,
S: AsRef<[u8]>,
Decrypts an encrypted JSON from the provided path to construct a Wallet instance
pub fn new<R: Rng + CryptoRng>(rng: &mut R) -> Self[src]
Creates a new random keypair seeded with the provided RNG
impl Wallet<YubiSigner<Secp256k1>>[src]
pub fn connect(connector: Connector, credentials: Credentials, id: Id) -> Self[src]
Connects to a yubi key's ECDSA account at the provided id
pub fn new(
connector: Connector,
credentials: Credentials,
id: Id,
label: Label,
domain: Domain
) -> Self[src]
connector: Connector,
credentials: Credentials,
id: Id,
label: Label,
domain: Domain
) -> Self
Creates a new random ECDSA keypair on the yubi at the provided id
pub fn from_key(
connector: Connector,
credentials: Credentials,
id: Id,
label: Label,
domain: Domain,
key: impl Into<Vec<u8>>
) -> Self[src]
connector: Connector,
credentials: Credentials,
id: Id,
label: Label,
domain: Domain,
key: impl Into<Vec<u8>>
) -> Self
Uploads the provided keypair on the yubi at the provided id
impl<D: DigestSigner<ProxyDigest<Sha256>, RecoverableSignature>> Wallet<D>[src]
pub fn set_chain_id<T: Into<u64>>(self, chain_id: T) -> Self[src]
Sets the wallet's chain_id, used in conjunction with EIP-155 signing
pub fn signer(&self) -> &D[src]
Gets the wallet's signer
pub fn chain_id(&self) -> Option<u64>[src]
Gets the wallet's chain id
pub fn address(&self) -> Address[src]
Returns the wallet's address
Trait Implementations
impl Clone for Wallet<SigningKey>[src]
fn clone(&self) -> Self[src]
pub fn clone_from(&mut self, source: &Self)1.0.0[src]
impl<D: DigestSigner<ProxyDigest<Sha256>, RecoverableSignature>> Debug for Wallet<D>[src]
impl From<SecretKey<Secp256k1>> for Wallet<SigningKey>[src]
fn from(key: K256SecretKey) -> Self[src]
impl From<Signer<Secp256k1>> for Wallet<YubiSigner<Secp256k1>>[src]
fn from(signer: YubiSigner<Secp256k1>) -> Self[src]
impl From<SigningKey> for Wallet<SigningKey>[src]
fn from(signer: SigningKey) -> Self[src]
impl FromStr for Wallet<SigningKey>[src]
type Err = K256Error
The associated error which can be returned from parsing.
fn from_str(src: &str) -> Result<Self, Self::Err>[src]
impl PartialEq<Wallet<SigningKey>> for Wallet<SigningKey>[src]
impl<D: Sync + Send + DigestSigner<ProxyDigest<Sha256>, RecoverableSignature>> Signer for Wallet<D>[src]
type Error = Infallible
fn sign_message<'life0, 'async_trait, S: Send + Sync + AsRef<[u8]>>(
&'life0 self,
message: S
) -> Pin<Box<dyn Future<Output = Result<Signature, Self::Error>> + Send + 'async_trait>> where
S: 'async_trait,
'life0: 'async_trait,
Self: 'async_trait, [src]
&'life0 self,
message: S
) -> Pin<Box<dyn Future<Output = Result<Signature, Self::Error>> + Send + 'async_trait>> where
S: 'async_trait,
'life0: 'async_trait,
Self: 'async_trait,
fn sign_transaction<'life0, 'life1, 'async_trait>(
&'life0 self,
tx: &'life1 TransactionRequest
) -> Pin<Box<dyn Future<Output = Result<Signature, Self::Error>> + Send + 'async_trait>> where
'life0: 'async_trait,
'life1: 'async_trait,
Self: 'async_trait, [src]
&'life0 self,
tx: &'life1 TransactionRequest
) -> Pin<Box<dyn Future<Output = Result<Signature, Self::Error>> + Send + 'async_trait>> where
'life0: 'async_trait,
'life1: 'async_trait,
Self: 'async_trait,
fn address(&self) -> Address[src]
Auto Trait Implementations
impl<D> RefUnwindSafe for Wallet<D> where
D: RefUnwindSafe,
D: RefUnwindSafe,
impl<D> Send for Wallet<D> where
D: Send,
D: Send,
impl<D> Sync for Wallet<D> where
D: Sync,
D: Sync,
impl<D> Unpin for Wallet<D> where
D: Unpin,
D: Unpin,
impl<D> UnwindSafe for Wallet<D> where
D: UnwindSafe,
D: UnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized, [src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized, [src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized, [src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T[src]
impl<T> Conv for T
impl<T> FmtForward for T
pub fn fmt_binary(self) -> FmtBinary<Self> where
Self: Binary,
Self: Binary,
pub fn fmt_display(self) -> FmtDisplay<Self> where
Self: Display,
Self: Display,
pub fn fmt_lower_exp(self) -> FmtLowerExp<Self> where
Self: LowerExp,
Self: LowerExp,
pub fn fmt_lower_hex(self) -> FmtLowerHex<Self> where
Self: LowerHex,
Self: LowerHex,
pub fn fmt_octal(self) -> FmtOctal<Self> where
Self: Octal,
Self: Octal,
pub fn fmt_pointer(self) -> FmtPointer<Self> where
Self: Pointer,
Self: Pointer,
pub fn fmt_upper_exp(self) -> FmtUpperExp<Self> where
Self: UpperExp,
Self: UpperExp,
pub fn fmt_upper_hex(self) -> FmtUpperHex<Self> where
Self: UpperHex,
Self: UpperHex,
impl<T> From<T> for T[src]
impl<T, U> Into<U> for T where
U: From<T>, [src]
U: From<T>,
impl<T> Pipe for T
impl<T> PipeAsRef for T
pub fn pipe_as_ref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: AsRef<T>,
T: 'a,
R: 'a,
Self: AsRef<T>,
T: 'a,
R: 'a,
pub fn pipe_as_mut<'a, T, R>(
&'a mut self,
func: impl FnOnce(&'a mut T) -> R
) -> R where
Self: AsMut<T>,
T: 'a,
R: 'a,
&'a mut self,
func: impl FnOnce(&'a mut T) -> R
) -> R where
Self: AsMut<T>,
T: 'a,
R: 'a,
impl<T> PipeBorrow for T
pub fn pipe_borrow<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: Borrow<T>,
T: 'a,
R: 'a,
Self: Borrow<T>,
T: 'a,
R: 'a,
pub fn pipe_borrow_mut<'a, T, R>(
&'a mut self,
func: impl FnOnce(&'a mut T) -> R
) -> R where
Self: BorrowMut<T>,
T: 'a,
R: 'a,
&'a mut self,
func: impl FnOnce(&'a mut T) -> R
) -> R where
Self: BorrowMut<T>,
T: 'a,
R: 'a,
impl<T> PipeDeref for T
pub fn pipe_deref<'a, R>(
&'a self,
func: impl FnOnce(&'a Self::Target) -> R
) -> R where
Self: Deref,
R: 'a,
&'a self,
func: impl FnOnce(&'a Self::Target) -> R
) -> R where
Self: Deref,
R: 'a,
pub fn pipe_deref_mut<'a, R>(
&'a mut self,
func: impl FnOnce(&'a mut Self::Target) -> R
) -> R where
Self: DerefMut,
R: 'a,
&'a mut self,
func: impl FnOnce(&'a mut Self::Target) -> R
) -> R where
Self: DerefMut,
R: 'a,
impl<T> PipeRef for T
pub fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R where
R: 'a,
R: 'a,
pub fn pipe_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R where
R: 'a,
R: 'a,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> Tap for T
pub fn tap<F, R>(self, func: F) -> Self where
F: FnOnce(&Self) -> R,
F: FnOnce(&Self) -> R,
pub fn tap_dbg<F, R>(self, func: F) -> Self where
F: FnOnce(&Self) -> R,
F: FnOnce(&Self) -> R,
pub fn tap_mut<F, R>(self, func: F) -> Self where
F: FnOnce(&mut Self) -> R,
F: FnOnce(&mut Self) -> R,
pub fn tap_mut_dbg<F, R>(self, func: F) -> Self where
F: FnOnce(&mut Self) -> R,
F: FnOnce(&mut Self) -> R,
impl<T, U> TapAsRef<U> for T where
U: ?Sized,
U: ?Sized,
pub fn tap_ref<F, R>(self, func: F) -> Self where
Self: AsRef<T>,
F: FnOnce(&T) -> R,
Self: AsRef<T>,
F: FnOnce(&T) -> R,
pub fn tap_ref_dbg<F, R>(self, func: F) -> Self where
Self: AsRef<T>,
F: FnOnce(&T) -> R,
Self: AsRef<T>,
F: FnOnce(&T) -> R,
pub fn tap_ref_mut<F, R>(self, func: F) -> Self where
Self: AsMut<T>,
F: FnOnce(&mut T) -> R,
Self: AsMut<T>,
F: FnOnce(&mut T) -> R,
pub fn tap_ref_mut_dbg<F, R>(self, func: F) -> Self where
Self: AsMut<T>,
F: FnOnce(&mut T) -> R,
Self: AsMut<T>,
F: FnOnce(&mut T) -> R,
impl<T, U> TapBorrow<U> for T where
U: ?Sized,
U: ?Sized,
pub fn tap_borrow<F, R>(self, func: F) -> Self where
Self: Borrow<T>,
F: FnOnce(&T) -> R,
Self: Borrow<T>,
F: FnOnce(&T) -> R,
pub fn tap_borrow_dbg<F, R>(self, func: F) -> Self where
Self: Borrow<T>,
F: FnOnce(&T) -> R,
Self: Borrow<T>,
F: FnOnce(&T) -> R,
pub fn tap_borrow_mut<F, R>(self, func: F) -> Self where
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R,
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R,
pub fn tap_borrow_mut_dbg<F, R>(self, func: F) -> Self where
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R,
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R,
impl<T> TapDeref for T
pub fn tap_deref<F, R>(self, func: F) -> Self where
Self: Deref,
F: FnOnce(&Self::Target) -> R,
Self: Deref,
F: FnOnce(&Self::Target) -> R,
pub fn tap_deref_dbg<F, R>(self, func: F) -> Self where
Self: Deref,
F: FnOnce(&Self::Target) -> R,
Self: Deref,
F: FnOnce(&Self::Target) -> R,
pub fn tap_deref_mut<F, R>(self, func: F) -> Self where
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R,
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R,
pub fn tap_deref_mut_dbg<F, R>(self, func: F) -> Self where
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R,
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R,
impl<T> ToOwned for T where
T: Clone, [src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T[src]
pub fn clone_into(&self, target: &mut T)[src]
impl<T> TryConv for T
impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,