forked from matter-labs/zksync-era
-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(eigen-client-extra-features): Add soft confirmations #322
Merged
gianbelinche
merged 25 commits into
eigen-client-extra-features
from
eigen-client-soft-conf
Nov 5, 2024
Merged
Changes from 17 commits
Commits
Show all changes
25 commits
Select commit
Hold shift + click to select a range
226834f
initial commit
juan518munoz 27413ac
Merge branch 'eigen-client-extra-features' into eigen-client-non-auth…
gianbelinche 0dd2289
Merge branch 'eigen-client-extra-features' into eigen-client-non-auth…
gianbelinche 7f5d01e
Add tests
gianbelinche ab03654
Add memstore
gianbelinche c565e84
Add assert to tests
gianbelinche f15932c
Merge branch 'eigen-client-non-auth-dispersal' into eigen-client-mems…
gianbelinche dc5b721
Add rest of memstore
gianbelinche 1bac89a
Add soft confirmations
gianbelinche 70b10a9
Remove print
gianbelinche 46838fc
Address pr comments
gianbelinche d450f8a
Merge branch 'eigen-client-extra-features' into eigen-client-memstore
gianbelinche ec1a65a
Remove to retriable error
gianbelinche 7864534
Merge branch 'eigen-client-extra-features' into eigen-client-memstore
gianbelinche edafcff
Fix conflicts
gianbelinche 645f15e
Merge branch 'eigen-client-memstore' into eigen-client-soft-conf
gianbelinche 3bd5812
Add inclusion data
gianbelinche 860bc28
Change status query timeout to millis
gianbelinche f892e99
Merge branch 'eigen-client-extra-features' into eigen-client-memstore
gianbelinche 22fd8a2
Document memstore
gianbelinche 84cbecd
Fix typo
gianbelinche 07f4a22
Merge branch 'eigen-client-memstore' into eigen-client-soft-conf
gianbelinche 1476acf
Fix typo
gianbelinche 04a144f
Merge branch 'eigen-client-extra-features' into eigen-client-soft-conf
gianbelinche 0b64699
Format
gianbelinche File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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 |
---|---|---|
|
@@ -10,37 +10,27 @@ use zksync_da_client::{ | |
DataAvailabilityClient, | ||
}; | ||
|
||
use super::{blob_info::BlobInfo, sdk::RawEigenClient}; | ||
use super::{blob_info::BlobInfo, memstore::MemStore, sdk::RawEigenClient, Disperser}; | ||
use crate::utils::to_non_retriable_da_error; | ||
|
||
#[derive(Debug, Clone)] | ||
pub struct EigenClient { | ||
client: Arc<RawEigenClient>, | ||
client: Disperser, | ||
} | ||
|
||
impl EigenClient { | ||
pub async fn new(config: EigenConfig, secrets: EigenSecrets) -> anyhow::Result<Self> { | ||
let private_key = SecretKey::from_str(secrets.private_key.0.expose_secret().as_str()) | ||
.map_err(|e| anyhow::anyhow!("Failed to parse private key: {}", e))?; | ||
|
||
match config { | ||
let disperser: Disperser = match config.clone() { | ||
EigenConfig::Disperser(config) => { | ||
// TODO: add complete config | ||
let client = RawEigenClient::new( | ||
config.disperser_rpc, | ||
config.status_query_interval, | ||
private_key, | ||
config.authenticaded, | ||
) | ||
.await?; | ||
Ok(EigenClient { | ||
client: Arc::new(client), | ||
}) | ||
let client = RawEigenClient::new(private_key, config).await?; | ||
Disperser::Remote(Arc::new(client)) | ||
} | ||
EigenConfig::MemStore(_) => { | ||
todo!() | ||
} | ||
} | ||
EigenConfig::MemStore(config) => Disperser::Memory(MemStore::new(config)), | ||
}; | ||
Ok(Self { client: disperser }) | ||
} | ||
} | ||
|
||
|
@@ -51,11 +41,17 @@ impl DataAvailabilityClient for EigenClient { | |
_: u32, // batch number | ||
data: Vec<u8>, | ||
) -> Result<DispatchResponse, DAError> { | ||
let blob_id = self | ||
.client | ||
.dispatch_blob(data) | ||
.await | ||
.map_err(to_non_retriable_da_error)?; | ||
let blob_id = match &self.client { | ||
Disperser::Remote(remote_disperser) => remote_disperser | ||
.dispatch_blob(data) | ||
.await | ||
.map_err(to_non_retriable_da_error)?, | ||
Disperser::Memory(memstore) => memstore | ||
.clone() | ||
.put_blob(data) | ||
.await | ||
.map_err(to_non_retriable_da_error)?, | ||
}; | ||
|
||
Ok(DispatchResponse::from(blob_id)) | ||
} | ||
|
@@ -87,16 +83,15 @@ impl DataAvailabilityClient for EigenClient { | |
#[cfg(test)] | ||
impl EigenClient { | ||
pub async fn get_blob_data(&self, blob_id: &str) -> anyhow::Result<Option<Vec<u8>>, DAError> { | ||
self.client.get_blob_data(blob_id).await | ||
/*match &self.disperser { | ||
match &self.client { | ||
Disperser::Remote(remote_client) => remote_client.get_blob_data(blob_id).await, | ||
Disperser::Memory(memstore) => memstore.clone().get_blob_data(blob_id).await, | ||
}*/ | ||
} | ||
} | ||
} | ||
#[cfg(test)] | ||
mod tests { | ||
use zksync_config::configs::da_client::eigen::DisperserConfig; | ||
use zksync_config::configs::da_client::eigen::{DisperserConfig, MemStoreConfig}; | ||
use zksync_types::secrets::PrivateKey; | ||
|
||
use super::*; | ||
|
@@ -112,7 +107,7 @@ mod tests { | |
eigenda_svc_manager_address: "0xD4A7E1Bd8015057293f0D0A557088c286942e84b".to_string(), | ||
blob_size_limit: 2 * 1024 * 1024, // 2MB | ||
status_query_timeout: 1800, // 30 minutes | ||
status_query_interval: 5, // 5 seconds | ||
status_query_interval: 5, // 5 ms | ||
wait_for_finalization: false, | ||
authenticaded: false, | ||
}); | ||
|
@@ -149,7 +144,7 @@ mod tests { | |
eigenda_svc_manager_address: "0xD4A7E1Bd8015057293f0D0A557088c286942e84b".to_string(), | ||
blob_size_limit: 2 * 1024 * 1024, // 2MB | ||
status_query_timeout: 1800, // 30 minutes | ||
status_query_interval: 5, // 5 seconds | ||
status_query_interval: 5, // 5 ms | ||
wait_for_finalization: false, | ||
authenticaded: true, | ||
}); | ||
|
@@ -175,4 +170,74 @@ mod tests { | |
let retrieved_data = client.get_blob_data(&result.blob_id).await.unwrap(); | ||
assert_eq!(retrieved_data.unwrap(), data); | ||
} | ||
|
||
#[tokio::test] | ||
async fn test_eigenda_memory_disperser() { | ||
let config = EigenConfig::MemStore(MemStoreConfig { | ||
max_blob_size_bytes: 2 * 1024 * 1024, // 2MB, | ||
blob_expiration: 60 * 2, | ||
get_latency: 0, | ||
put_latency: 0, | ||
}); | ||
let secrets = EigenSecrets { | ||
private_key: PrivateKey::from_str( | ||
"d08aa7ae1bb5ddd46c3c2d8cdb5894ab9f54dec467233686ca42629e826ac4c6", | ||
) | ||
.unwrap(), | ||
}; | ||
let client = EigenClient::new(config, secrets).await.unwrap(); | ||
let data = vec![1u8; 100]; | ||
let result = client.dispatch_blob(0, data.clone()).await.unwrap(); | ||
|
||
let blob_info: BlobInfo = | ||
rlp::decode(&hex::decode(result.blob_id.clone()).unwrap()).unwrap(); | ||
let expected_inclusion_data = blob_info.blob_verification_proof.inclusion_proof; | ||
let actual_inclusion_data = client | ||
.get_inclusion_data(&result.blob_id) | ||
.await | ||
.unwrap() | ||
.unwrap() | ||
.data; | ||
assert_eq!(expected_inclusion_data, actual_inclusion_data); | ||
|
||
let retrieved_data = client.get_blob_data(&result.blob_id).await.unwrap(); | ||
assert_eq!(retrieved_data.unwrap(), data); | ||
} | ||
|
||
#[tokio::test] | ||
async fn test_wait_for_finalization() { | ||
let config = EigenConfig::Disperser(DisperserConfig { | ||
custom_quorum_numbers: None, | ||
disperser_rpc: "https://disperser-holesky.eigenda.xyz:443".to_string(), | ||
eth_confirmation_depth: -1, | ||
eigenda_eth_rpc: String::default(), | ||
eigenda_svc_manager_address: "0xD4A7E1Bd8015057293f0D0A557088c286942e84b".to_string(), | ||
blob_size_limit: 2 * 1024 * 1024, // 2MB | ||
status_query_timeout: 1800, // 30 minutes | ||
status_query_interval: 5000, // 5000 ms | ||
wait_for_finalization: true, | ||
authenticaded: true, | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. typo: authenticaded -> authenticated |
||
}); | ||
let secrets = EigenSecrets { | ||
private_key: PrivateKey::from_str( | ||
"d08aa7ae1bb5ddd46c3c2d8cdb5894ab9f54dec467233686ca42629e826ac4c6", | ||
) | ||
.unwrap(), | ||
}; | ||
let client = EigenClient::new(config, secrets).await.unwrap(); | ||
let data = vec![1; 20]; | ||
let result = client.dispatch_blob(0, data.clone()).await.unwrap(); | ||
let blob_info: BlobInfo = | ||
rlp::decode(&hex::decode(result.blob_id.clone()).unwrap()).unwrap(); | ||
let expected_inclusion_data = blob_info.blob_verification_proof.inclusion_proof; | ||
let actual_inclusion_data = client | ||
.get_inclusion_data(&result.blob_id) | ||
.await | ||
.unwrap() | ||
.unwrap() | ||
.data; | ||
assert_eq!(expected_inclusion_data, actual_inclusion_data); | ||
let retrieved_data = client.get_blob_data(&result.blob_id).await.unwrap(); | ||
assert_eq!(retrieved_data.unwrap(), data); | ||
} | ||
} |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is the configuration documented somewhere? I found confusing that the numbers in status_query_timeout and status_query_interval (both related to the status_query) have different units.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done