-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Tweaks to the developer experience with EVM (#713)
* Add tests to cli ethereum utils * Rename ethereum cli to evm * Update the cli snapshot * Increase the test timeout to 30 seconds at block-check * Expose the evm cli command key-info code at crypto-utils-evm crate * Switch to evm_account_id_from_dev_seed at chainspec * Update the features shapshot * Clena up unused imports * Disable the libsecp256k1 features * Drop the unused dependencies from humanode-peer * Put the error handling in order * Eliminate an unwrap * Fix docs
- Loading branch information
Showing
15 changed files
with
287 additions
and
69 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| [package] | ||
| name = "crypto-utils-evm" | ||
| version = "0.1.0" | ||
| edition = "2021" | ||
| publish = false | ||
|
|
||
| [dependencies] | ||
| anyhow = "1" | ||
| bip32 = "0.5" | ||
| libsecp256k1 = { version = "0.7", default-features = false } | ||
| sha3 = "0.10" | ||
| sp-core = { git = "https://github.com/humanode-network/substrate", branch = "locked/polkadot-v0.9.38" } | ||
| thiserror = "1" | ||
| tiny-bip39 = "1.0" | ||
|
|
||
| [dev-dependencies] | ||
| hex-literal = "0.4" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,204 @@ | ||
| //! Various crypto helper functions for EVM. | ||
| use sp_core::{H160, H256}; | ||
|
|
||
| /// A structure representing the key information. | ||
| #[derive(Debug, Clone, PartialEq, Eq)] | ||
| pub struct KeyData { | ||
| /// The account address. | ||
| pub account: H160, | ||
| /// The private key of this account. | ||
| pub private_key: H256, | ||
| /// The mnemonic phrase. | ||
| pub mnemonic: String, | ||
| /// The drivation path used for this account. | ||
| pub derivation_path: bip32::DerivationPath, | ||
| } | ||
|
|
||
| /// An error that can occur at [`KeyData::from_mnemonic_bip39`] call. | ||
| #[derive(Debug, thiserror::Error)] | ||
| pub enum FromMnemonicBip39Error { | ||
| /// Derivation has failed. | ||
| #[error("derivation: {0}")] | ||
| Derivation(bip32::Error), | ||
| /// Secret key parsing failed. | ||
| #[error("secret key: {0}")] | ||
| SecretKey(libsecp256k1::Error), | ||
| } | ||
|
|
||
| /// An error that can occur at [`KeyData::from_mnemonic_bip44`] call. | ||
| #[derive(Debug, thiserror::Error)] | ||
| pub enum FromMnemonicBip44Error { | ||
| /// Derivation path was invalid. | ||
| #[error("derivation path: {0}")] | ||
| DerivationPath(bip32::Error), | ||
| /// Inner [`KeyData::from_mnemonic_bip39`] call failed. | ||
| #[error(transparent)] | ||
| FromMnemonicBip39(FromMnemonicBip39Error), | ||
| } | ||
|
|
||
| /// An error that can occur at [`KeyData::from_phrase_bip44`] call. | ||
| #[derive(Debug, thiserror::Error)] | ||
| pub enum FromPhraseBip44 { | ||
| /// Mnemonic parsing failed. | ||
| #[error("mnemonic: {0}")] | ||
| Mnemonic(anyhow::Error), | ||
| /// Inner [`KeyData::from_mnemonic_bip44`] call failed. | ||
| #[error(transparent)] | ||
| FromMnemonicBip44(FromMnemonicBip44Error), | ||
| } | ||
|
|
||
| impl KeyData { | ||
| /// Create a new [`KeyData`] from the given BIP39 mnemonic and an account index. | ||
| pub fn from_mnemonic_bip39( | ||
| mnemonic: &bip39::Mnemonic, | ||
| password: &str, | ||
| derivation_path: &bip32::DerivationPath, | ||
| ) -> Result<Self, FromMnemonicBip39Error> { | ||
| // Retrieve the seed from the mnemonic. | ||
| let seed = bip39::Seed::new(mnemonic, password); | ||
|
|
||
| // Derives the private key from. | ||
| let ext = bip32::XPrv::derive_from_path(seed, derivation_path) | ||
| .map_err(FromMnemonicBip39Error::Derivation)?; | ||
|
|
||
| let private_key = libsecp256k1::SecretKey::parse_slice(&ext.to_bytes()) | ||
| .map_err(FromMnemonicBip39Error::SecretKey)?; | ||
|
|
||
| // Retrieves the public key. | ||
| let public_key = libsecp256k1::PublicKey::from_secret_key(&private_key); | ||
|
|
||
| // Convert into Ethereum-style address. | ||
| let mut raw_public_key = [0u8; 64]; | ||
| raw_public_key.copy_from_slice(&public_key.serialize()[1..65]); | ||
|
|
||
| use sha3::Digest; | ||
| let digest = sha3::Keccak256::digest(raw_public_key); | ||
|
|
||
| let account = H160::from(H256::from_slice(digest.as_ref())); | ||
|
|
||
| Ok(Self { | ||
| account, | ||
| mnemonic: mnemonic.phrase().to_owned(), | ||
| private_key: H256::from(private_key.serialize()), | ||
| derivation_path: derivation_path.clone(), | ||
| }) | ||
| } | ||
|
|
||
| /// Construct the key info from the BIP39 mnemonic using BIP44 convenions. | ||
| pub fn from_mnemonic_bip44( | ||
| mnemonic: &bip39::Mnemonic, | ||
| password: &str, | ||
| account_index: Option<u32>, | ||
| ) -> Result<Self, FromMnemonicBip44Error> { | ||
| let derivation_path = format!("m/44'/60'/0'/0/{}", account_index.unwrap_or(0)); | ||
| let derivation_path = derivation_path | ||
| .parse() | ||
| .map_err(FromMnemonicBip44Error::DerivationPath)?; | ||
| Self::from_mnemonic_bip39(mnemonic, password, &derivation_path) | ||
| .map_err(FromMnemonicBip44Error::FromMnemonicBip39) | ||
| } | ||
|
|
||
| /// Construct the key info from the BIP39 mnemonic phrase (in English) using BIP44 convenions. | ||
| /// If you need other language - use [`Self::from_mnemonic_bip44`]. | ||
| pub fn from_phrase_bip44( | ||
| phrase: &str, | ||
| password: &str, | ||
| account_index: Option<u32>, | ||
| ) -> Result<Self, FromPhraseBip44> { | ||
| let mnemonic = bip39::Mnemonic::from_phrase(phrase, bip39::Language::English) | ||
| .map_err(FromPhraseBip44::Mnemonic)?; | ||
| Self::from_mnemonic_bip44(&mnemonic, password, account_index) | ||
| .map_err(FromPhraseBip44::FromMnemonicBip44) | ||
| } | ||
|
|
||
| /// Construct the key info from the account on the Substrate standard dev seed. | ||
| pub fn from_dev_seed(account_index: u32) -> Self { | ||
| Self::from_phrase_bip44(sp_core::crypto::DEV_PHRASE, "", Some(account_index)).unwrap() | ||
| } | ||
| } | ||
|
|
||
| #[cfg(test)] | ||
| mod tests { | ||
| use super::*; | ||
|
|
||
| #[test] | ||
| fn mnemonic_bip44() { | ||
| let cases = [ | ||
| ( | ||
| "test test test test test test test test test test test junk", | ||
| "", | ||
| KeyData { | ||
| account: H160(hex_literal::hex!( | ||
| "f39Fd6e51aad88F6F4ce6aB8827279cffFb92266" | ||
| )), | ||
| private_key: H256(hex_literal::hex!( | ||
| "ac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80" | ||
| )), | ||
| mnemonic: "test test test test test test test test test test test junk".into(), | ||
| derivation_path: "m/44'/60'/0'/0/0".parse().unwrap(), | ||
| }, | ||
| ), | ||
| ( | ||
| "zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo wrong", | ||
| "Substrate", | ||
| KeyData { | ||
| account: H160(hex_literal::hex!( | ||
| "cf1269fb02698ab9ee45426297e20c84142d9195" | ||
| )), | ||
| private_key: H256(hex_literal::hex!( | ||
| "b29728f71053098351f20350e7087dcb091b151689f8a878734b519901d19853" | ||
| )), | ||
| mnemonic: "zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo wrong".into(), | ||
| derivation_path: "m/44'/60'/0'/0/0".parse().unwrap(), | ||
| }, | ||
| ), | ||
| ]; | ||
|
|
||
| for (phrase, pw, expected_key_info) in cases { | ||
| let key_info = KeyData::from_phrase_bip44(phrase, pw, None).unwrap(); | ||
| assert_eq!(key_info, expected_key_info); | ||
| } | ||
| } | ||
|
|
||
| #[test] | ||
| fn dev_seed() { | ||
| let cases = [ | ||
| ( | ||
| 0, | ||
| KeyData { | ||
| account: H160(hex_literal::hex!( | ||
| "f24ff3a9cf04c71dbc94d0b566f7a27b94566cac" | ||
| )), | ||
| private_key: H256(hex_literal::hex!( | ||
| "5fb92d6e98884f76de468fa3f6278f8807c48bebc13595d45af5bdc4da702133" | ||
| )), | ||
| mnemonic: | ||
| "bottom drive obey lake curtain smoke basket hold race lonely fit walk" | ||
| .into(), | ||
| derivation_path: "m/44'/60'/0'/0/0".parse().unwrap(), | ||
| }, | ||
| ), | ||
| ( | ||
| 1, | ||
| KeyData { | ||
| account: H160(hex_literal::hex!( | ||
| "3cd0a705a2dc65e5b1e1205896baa2be8a07c6e0" | ||
| )), | ||
| private_key: H256(hex_literal::hex!( | ||
| "8075991ce870b93a8870eca0c0f91913d12f47948ca0fd25b49c6fa7cdbeee8b" | ||
| )), | ||
| mnemonic: | ||
| "bottom drive obey lake curtain smoke basket hold race lonely fit walk" | ||
| .into(), | ||
| derivation_path: "m/44'/60'/0'/0/1".parse().unwrap(), | ||
| }, | ||
| ), | ||
| ]; | ||
|
|
||
| for (account_index, expected_key_info) in cases { | ||
| let key_info = KeyData::from_dev_seed(account_index); | ||
| assert_eq!(key_info, expected_key_info); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.