alloy_zksync/
lib.rs

1//! ## alloy-zksync
2//!
3//! Implementation of the ZKsync network support for the [alloy][alloy] ecosystem.
4//!
5//! ## Overview
6//!
7//! This crate is designed to be a plug-in for [alloy][alloy]. If you're not familiar with it, the great entrypoint
8//! would be the [alloy book](https://alloy.rs/) and [examples](https://github.com/alloy-rs/examples).
9//!
10//! `alloy-zksync` project has two main goals:
11//! - Everything that works in `alloy` should work in `alloy-zksync` as well, even if the underlying implementation
12//!   of functionality is different.
13//! - ZKsync-specific features are supported.
14//!
15//! Main entrypoints are:
16//! - [`ZksyncProvider`](crate::provider::ZksyncProvider) and [`zksync_provider`](crate::provider::zksync_provider). The
17//!   provider is used whenever you need to access the node API.
18//! - [`ZksyncWallet`](crate::wallet::ZksyncWallet). The wallet represents a provider with an account attached, and thus
19//!   can be used to sign transactions.
20//! - [`Zksync` network](crate::network::Zksync): a [network][alloy_network] definition. Most likely you won't need to
21//!   interact with it directly, but the Network trait implementation is useful to look at if you want to see main data
22//!   types.
23//!
24//! ## Examples
25//!
26//! Check out the [examples](https://github.com/popzxc/alloy-zksync/tree/main/examples) directory for more examples.
27//!
28//! [alloy]: https://github.com/alloy-rs/alloy/
29//! [alloy_network]: https://docs.rs/alloy/latest/alloy/network/trait.Network.html
30
31pub mod contracts;
32pub mod network;
33pub mod node_bindings;
34pub mod provider;
35pub mod types;
36pub mod utils;
37pub mod wallet;