ethers_signers/
lib.rs

1#![doc = include_str!("../README.md")]
2#![deny(unsafe_code, rustdoc::broken_intra_doc_links)]
3#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
4
5mod wallet;
6pub use wallet::{MnemonicBuilder, Wallet, WalletError};
7
8/// Re-export the BIP-32 crate so that wordlists can be accessed conveniently.
9pub use coins_bip39;
10
11/// A wallet instantiated with a locally stored private key
12pub type LocalWallet = Wallet<ethers_core::k256::ecdsa::SigningKey>;
13
14#[cfg(all(feature = "yubihsm", not(target_arch = "wasm32")))]
15/// A wallet instantiated with a YubiHSM
16pub type YubiWallet = Wallet<yubihsm::ecdsa::Signer<ethers_core::k256::Secp256k1>>;
17
18#[cfg(all(feature = "ledger", not(target_arch = "wasm32")))]
19mod ledger;
20#[cfg(all(feature = "ledger", not(target_arch = "wasm32")))]
21pub use ledger::{
22    app::LedgerEthereum as Ledger,
23    types::{DerivationType as HDPath, LedgerError},
24};
25
26#[cfg(all(feature = "trezor", not(target_arch = "wasm32")))]
27mod trezor;
28#[cfg(all(feature = "trezor", not(target_arch = "wasm32")))]
29pub use trezor::{
30    app::TrezorEthereum as Trezor,
31    types::{DerivationType as TrezorHDPath, TrezorError},
32};
33
34#[cfg(all(feature = "yubihsm", not(target_arch = "wasm32")))]
35pub use yubihsm;
36
37#[cfg(feature = "aws")]
38mod aws;
39#[cfg(feature = "aws")]
40pub use aws::{AwsSigner, AwsSignerError};
41
42use async_trait::async_trait;
43use ethers_core::types::{
44    transaction::{eip2718::TypedTransaction, eip712::Eip712},
45    Address, Signature,
46};
47use std::error::Error;
48
49/// Applies [EIP155](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-155.md)
50pub fn to_eip155_v<T: Into<u8>>(recovery_id: T, chain_id: u64) -> u64 {
51    (recovery_id.into() as u64) + 35 + chain_id * 2
52}
53
54/// Trait for signing transactions and messages
55///
56/// Implement this trait to support different signing modes, e.g. Ledger, hosted etc.
57#[cfg_attr(target_arch = "wasm32", async_trait(?Send))]
58#[cfg_attr(not(target_arch = "wasm32"), async_trait)]
59pub trait Signer: std::fmt::Debug + Send + Sync {
60    type Error: Error + Send + Sync;
61    /// Signs the hash of the provided message after prefixing it
62    async fn sign_message<S: Send + Sync + AsRef<[u8]>>(
63        &self,
64        message: S,
65    ) -> Result<Signature, Self::Error>;
66
67    /// Signs the transaction
68    async fn sign_transaction(&self, message: &TypedTransaction) -> Result<Signature, Self::Error>;
69
70    /// Encodes and signs the typed data according EIP-712.
71    /// Payload must implement Eip712 trait.
72    async fn sign_typed_data<T: Eip712 + Send + Sync>(
73        &self,
74        payload: &T,
75    ) -> Result<Signature, Self::Error>;
76
77    /// Returns the signer's Ethereum Address
78    fn address(&self) -> Address;
79
80    /// Returns the signer's chain id
81    fn chain_id(&self) -> u64;
82
83    /// Sets the signer's chain id
84    #[must_use]
85    fn with_chain_id<T: Into<u64>>(self, chain_id: T) -> Self;
86}
ethers_signers/lib.rs

ethers_signers/
lib.rs
