2020-09-24 21:33:09 +00:00
|
|
|
//! Provides a unified interface for locally signing transactions.
|
|
|
|
//!
|
|
|
|
//! You can implement the `Signer` trait to extend functionality to other signers
|
|
|
|
//! such as Hardware Security Modules, KMS etc.
|
|
|
|
//!
|
|
|
|
//! The exposed interfaces return a recoverable signature. In order to convert the signature
|
|
|
|
//! and the [`TransactionRequest`] to a [`Transaction`], look at the signing middleware.
|
|
|
|
//!
|
|
|
|
//! Supported signers:
|
2020-12-31 19:08:12 +00:00
|
|
|
//! - [Private key](crate::LocalWallet)
|
|
|
|
//! - [Ledger](crate::Ledger)
|
|
|
|
//! - [YubiHSM2](crate::YubiWallet)
|
2020-06-20 13:55:07 +00:00
|
|
|
//!
|
|
|
|
//! ```no_run
|
|
|
|
//! # use ethers::{
|
2020-12-31 19:08:12 +00:00
|
|
|
//! # signers::{LocalWallet, Signer},
|
|
|
|
//! # core::{k256::ecdsa::SigningKey, types::TransactionRequest},
|
|
|
|
//! # };
|
2020-06-20 13:55:07 +00:00
|
|
|
//! # async fn foo() -> Result<(), Box<dyn std::error::Error>> {
|
2020-09-24 21:33:09 +00:00
|
|
|
//! // instantiate the wallet
|
|
|
|
//! let wallet = "dcf2cbdd171a21c480aa7f53d77f31bb102282b3ff099c78e3118b37348c72f7"
|
2020-10-02 08:41:16 +00:00
|
|
|
//! .parse::<LocalWallet>()?;
|
2020-06-20 13:55:07 +00:00
|
|
|
//!
|
|
|
|
//! // create a transaction
|
|
|
|
//! let tx = TransactionRequest::new()
|
|
|
|
//! .to("vitalik.eth") // this will use ENS
|
|
|
|
//! .value(10000);
|
|
|
|
//!
|
2020-09-24 21:33:09 +00:00
|
|
|
//! // sign it
|
|
|
|
//! let signature = wallet.sign_transaction(&tx).await?;
|
2020-06-20 13:55:07 +00:00
|
|
|
//!
|
2020-09-24 21:33:09 +00:00
|
|
|
//! // can also sign a message
|
|
|
|
//! let signature = wallet.sign_message("hello world").await?;
|
|
|
|
//! signature.verify("hello world", wallet.address()).unwrap();
|
2020-06-20 13:55:07 +00:00
|
|
|
//! # Ok(())
|
|
|
|
//! # }
|
2020-12-24 15:44:08 +00:00
|
|
|
//! ```
|
|
|
|
//!
|
|
|
|
//! [`Transaction`]: ethers_core::types::Transaction
|
|
|
|
//! [`TransactionRequest`]: ethers_core::types::TransactionRequest
|
2020-05-26 10:24:19 +00:00
|
|
|
mod wallet;
|
|
|
|
pub use wallet::Wallet;
|
|
|
|
|
2020-10-02 08:41:16 +00:00
|
|
|
/// A wallet instantiated with a locally stored private key
|
|
|
|
pub type LocalWallet = Wallet<ethers_core::k256::ecdsa::SigningKey>;
|
|
|
|
|
|
|
|
#[cfg(feature = "yubi")]
|
|
|
|
/// A wallet instantiated with a YubiHSM
|
|
|
|
pub type YubiWallet = Wallet<yubihsm::ecdsa::Signer<ethers_core::k256::Secp256k1>>;
|
|
|
|
|
2020-09-20 15:17:02 +00:00
|
|
|
#[cfg(feature = "ledger")]
|
2020-09-20 18:27:00 +00:00
|
|
|
mod ledger;
|
|
|
|
#[cfg(feature = "ledger")]
|
2020-09-23 08:04:54 +00:00
|
|
|
pub use ledger::{
|
|
|
|
app::LedgerEthereum as Ledger,
|
|
|
|
types::{DerivationType as HDPath, LedgerError},
|
|
|
|
};
|
2020-09-20 15:17:02 +00:00
|
|
|
|
2020-10-02 08:41:16 +00:00
|
|
|
#[cfg(feature = "yubi")]
|
|
|
|
pub use yubihsm;
|
|
|
|
|
2020-09-20 15:17:02 +00:00
|
|
|
use async_trait::async_trait;
|
2020-09-24 21:33:09 +00:00
|
|
|
use ethers_core::types::{Address, Signature, TransactionRequest};
|
2020-05-26 10:24:19 +00:00
|
|
|
use std::error::Error;
|
|
|
|
|
2020-12-24 10:38:27 +00:00
|
|
|
/// Applies [EIP155](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-155.md)
|
|
|
|
pub fn to_eip155_v<T: Into<u8>>(recovery_id: T, chain_id: Option<u64>) -> u64 {
|
|
|
|
let standard_v: u8 = recovery_id.into();
|
|
|
|
if let Some(chain_id) = chain_id {
|
|
|
|
// When signing with a chain ID, add chain replay protection.
|
|
|
|
(standard_v as u64) + 35 + chain_id * 2
|
|
|
|
} else {
|
|
|
|
// Otherwise, convert to 'Electrum' notation.
|
|
|
|
(standard_v as u64) + 27
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-05-26 10:24:19 +00:00
|
|
|
/// Trait for signing transactions and messages
|
|
|
|
///
|
|
|
|
/// Implement this trait to support different signing modes, e.g. Ledger, hosted etc.
|
2020-10-08 15:56:36 +00:00
|
|
|
#[async_trait]
|
2020-10-02 08:41:16 +00:00
|
|
|
pub trait Signer: std::fmt::Debug + Send + Sync {
|
2020-09-24 21:33:09 +00:00
|
|
|
type Error: Error + Send + Sync;
|
2020-05-26 10:24:19 +00:00
|
|
|
/// Signs the hash of the provided message after prefixing it
|
2020-09-20 15:17:02 +00:00
|
|
|
async fn sign_message<S: Send + Sync + AsRef<[u8]>>(
|
|
|
|
&self,
|
|
|
|
message: S,
|
|
|
|
) -> Result<Signature, Self::Error>;
|
2020-05-26 10:24:19 +00:00
|
|
|
|
|
|
|
/// Signs the transaction
|
2020-09-20 15:17:02 +00:00
|
|
|
async fn sign_transaction(
|
|
|
|
&self,
|
2020-09-24 21:33:09 +00:00
|
|
|
message: &TransactionRequest,
|
|
|
|
) -> Result<Signature, Self::Error>;
|
2020-05-26 10:24:19 +00:00
|
|
|
|
|
|
|
/// Returns the signer's Ethereum Address
|
2020-09-24 21:33:09 +00:00
|
|
|
fn address(&self) -> Address;
|
2020-05-26 09:37:31 +00:00
|
|
|
}
|