-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: missing GKMSSigner feature (#91)
Co-authored-by: Calvin Lau <[email protected]>
- Loading branch information
Showing
16 changed files
with
870 additions
and
60 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,161 @@ | ||
| use std::result::Result; | ||
|
|
||
| use ethers_signers::Signer as EthSigner; | ||
| use google_cloud_gax::retry::RetrySetting; | ||
| use google_cloud_kms::{ | ||
| client::{Client, ClientConfig}, | ||
| signer::ethereum::Signer, | ||
| }; | ||
| use hex; | ||
| use tracing::{self}; | ||
| use zksync_basic_types::{Address, H256, U256,web3::{keccak256, Signature}}; | ||
| use zksync_crypto_primitives::{ | ||
| EIP712TypedStructure, Eip712Domain, PackedEthSignature, | ||
| }; | ||
|
|
||
| use crate::{ | ||
| raw_ethereum_tx::{Transaction, TransactionParameters}, | ||
| EthereumSigner, SignerError, | ||
| }; | ||
|
|
||
| pub const GOOGLE_KMS_OP_KEY_NAME: &str = "GOOGLE_KMS_OP_KEY_NAME"; | ||
| pub const GOOGLE_KMS_OP_BLOB_KEY_NAME: &str = "GOOGLE_KMS_OP_BLOB_KEY_NAME"; | ||
|
|
||
| #[derive(Clone)] | ||
| pub struct GKMSSigner { | ||
| signer: Signer, | ||
| } | ||
|
|
||
| impl GKMSSigner { | ||
| pub async fn new(key_name: String, _chain_id: u64) -> Result<Self, SignerError> { | ||
| let config = ClientConfig::default() | ||
| .with_auth() | ||
| .await | ||
| .map_err(|e| SignerError::SigningFailed(e.to_string()))?; | ||
|
|
||
| let client = Client::new(config) | ||
| .await | ||
| .map_err(|e| SignerError::SigningFailed(e.to_string()))?; | ||
|
|
||
| let signer = Signer::new(client, &key_name, _chain_id, Some(RetrySetting::default())) | ||
| .await | ||
| .map_err(|e| SignerError::SigningFailed(e.to_string()))?; | ||
|
|
||
| tracing::info!("KMS signer address: {:?}", hex::encode(signer.address())); | ||
|
|
||
| Ok(GKMSSigner { signer }) | ||
| } | ||
|
|
||
| fn u256_to_h256(u: U256) -> H256 { | ||
| let mut bytes = [0u8; 32]; | ||
| u.to_big_endian(&mut bytes); | ||
| H256::from(bytes) | ||
| } | ||
| } | ||
|
|
||
| #[async_trait::async_trait] | ||
| impl EthereumSigner for GKMSSigner { | ||
| /// Get Ethereum address that matches the private key. | ||
| async fn get_address(&self) -> Result<Address, SignerError> { | ||
| Ok(self.signer.address()) | ||
| } | ||
|
|
||
| /// Signs typed struct using Ethereum private key by EIP-712 signature standard. | ||
| /// Result of this function is the equivalent of RPC calling `eth_signTypedData`. | ||
| async fn sign_typed_data<S: EIP712TypedStructure + Sync>( | ||
| &self, | ||
| domain: &Eip712Domain, | ||
| typed_struct: &S, | ||
| ) -> Result<PackedEthSignature, SignerError> { | ||
| let digest = | ||
| H256::from(PackedEthSignature::typed_data_to_signed_bytes(domain, typed_struct).0); | ||
|
|
||
| let signature = self | ||
| .signer | ||
| .sign_digest(digest.as_bytes()) | ||
| .await | ||
| .map_err(|e| SignerError::SigningFailed(e.to_string()))?; | ||
|
|
||
| // Convert the signature components to the appropriate format. | ||
| let r_h256 = GKMSSigner::u256_to_h256(signature.r); | ||
| let s_h256 = GKMSSigner::u256_to_h256(signature.s); | ||
|
|
||
| // Ensure the `v` component is in the correct byte format. | ||
| let v_byte = match signature.v.try_into() { | ||
| Ok(v) => v, | ||
| Err(_) => { | ||
| return Err(SignerError::SigningFailed( | ||
| "V value conversion failed".to_string(), | ||
| )) | ||
| } | ||
| }; | ||
|
|
||
| // Construct the Ethereum signature from the R, S, and V components. | ||
| let eth_sig = PackedEthSignature::from_rsv(&r_h256, &s_h256, v_byte); | ||
|
|
||
| Ok(eth_sig) | ||
| } | ||
|
|
||
| /// Signs and returns the RLP-encoded transaction. | ||
| async fn sign_transaction( | ||
| &self, | ||
| raw_tx: TransactionParameters, | ||
| ) -> Result<Vec<u8>, SignerError> { | ||
| // According to the code in web3 <https://docs.rs/web3/latest/src/web3/api/accounts.rs.html#86> | ||
| // We should use `max_fee_per_gas` as `gas_price` if we use EIP1559 | ||
| let gas_price = raw_tx.max_fee_per_gas; | ||
| let max_priority_fee_per_gas = raw_tx.max_priority_fee_per_gas; | ||
|
|
||
| let tx = Transaction { | ||
| to: raw_tx.to, | ||
| nonce: raw_tx.nonce, | ||
| gas: raw_tx.gas, | ||
| gas_price, | ||
| value: raw_tx.value, | ||
| data: raw_tx.data, | ||
| transaction_type: raw_tx.transaction_type, | ||
| access_list: raw_tx.access_list.unwrap_or_default(), | ||
| max_priority_fee_per_gas, | ||
| max_fee_per_blob_gas: raw_tx.max_fee_per_blob_gas, | ||
| blob_versioned_hashes: raw_tx.blob_versioned_hashes, | ||
| }; | ||
|
|
||
| let encoded = tx.encode_pub(raw_tx.chain_id, None); | ||
| let digest = H256(keccak256(encoded.as_ref())); | ||
|
|
||
| let signature = self | ||
| .signer | ||
| .sign_digest(digest.as_bytes()) | ||
| .await | ||
| .map_err(|e| SignerError::SigningFailed(e.to_string()))?; | ||
|
|
||
| let adjusted_v = if let Some(transaction_type) = tx.transaction_type.map(|t| t.as_u64()) { | ||
| match transaction_type { | ||
| 0 => signature.v + raw_tx.chain_id * 2 + 35, // EIP-155 | ||
| _ => signature.v, // EIP-2930 and others | ||
| } | ||
| } else { | ||
| signature.v + raw_tx.chain_id * 2 + 35 // EIP-155 | ||
| }; | ||
|
|
||
| let r_h256 = GKMSSigner::u256_to_h256(signature.r); | ||
| let s_h256 = GKMSSigner::u256_to_h256(signature.s); | ||
|
|
||
| tracing::debug!( | ||
| "KMS sign_transaction signature: v: {}, r: {}, s: {}", | ||
| adjusted_v, | ||
| hex::encode(r_h256), | ||
| hex::encode(s_h256), | ||
| ); | ||
|
|
||
| let web3_sig = Signature { | ||
| v: adjusted_v, | ||
| r: r_h256, | ||
| s: s_h256, | ||
| }; | ||
|
|
||
| let signed = tx.encode_pub(raw_tx.chain_id, Some(&web3_sig)); | ||
|
|
||
| return Ok(signed); | ||
| } | ||
| } |
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.