alloy 2.0.0

Connect applications to blockchains
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228

#![doc = include_str!("../README.md")]
#![doc(
    html_logo_url = "https://raw.githubusercontent.com/alloy-rs/core/main/assets/alloy.jpg",
    html_favicon_url = "https://raw.githubusercontent.com/alloy-rs/core/main/assets/favicon.ico"
)]
#![cfg_attr(not(test), warn(unused_crate_dependencies))]
#![cfg_attr(docsrs, feature(doc_cfg))]
#![cfg_attr(not(feature = "std"), no_std)]

/* --------------------------------------- Core re-exports -------------------------------------- */

// This should generally not be used by downstream crates as we re-export everything else
// individually. It is acceptable to use this if an item has been added to `alloy-core`
// and it has not been added to the re-exports below.
#[doc(hidden)]
pub use alloy_core as core;

/// Low-level primitives for Ethereum.
#[doc(inline)]
pub use self::core::primitives;
#[doc(no_inline)]
pub use primitives::{hex, uint};

/// Dynamic Solidity type encoder.
#[cfg(feature = "dyn-abi")]
#[doc(inline)]
pub use self::core::dyn_abi;

/// Full Ethereum [JSON-ABI](https://docs.soliditylang.org/en/latest/abi-spec.html) implementation.
#[cfg(feature = "json-abi")]
#[doc(inline)]
pub use self::core::json_abi;

/// Solidity type modeling and [ABI] and [EIP-712] codec implementation.
///
/// [ABI]: https://docs.soliditylang.org/en/latest/abi-spec.html
/// [EIP-712]: https://eips.ethereum.org/EIPS/eip-712
#[cfg(feature = "sol-types")]
#[doc(inline)]
pub use self::core::sol_types;

// Show this re-export in docs instead of the wrapper below.
#[cfg(all(doc, feature = "sol-types"))]
#[doc(no_inline)]
pub use sol_types::sol;

/// A fast and simple [Ethereum RLP][rlp] implementation in Rust.
///
/// [rlp]: https://ethereum.org/en/developers/docs/data-structures-and-encoding/rlp
#[cfg(feature = "rlp")]
#[doc(inline)]
pub use self::core::rlp;

/// [`sol!`](sol_types::sol!) `macro_rules!` wrapper to set import attributes.
///
/// See [`sol!`](sol_types::sol!) for the actual macro documentation.
#[cfg(all(not(doc), feature = "sol-types"))] // Show the actual macro in docs.
#[macro_export]
macro_rules! sol {
    ($($t:tt)*) => {
        $crate::sol_types::sol! {
            #![sol(alloy_sol_types = $crate::sol_types, alloy_contract = $crate::contract)]
            $($t)*
        }
    };
}

/* --------------------------------------- Main re-exports -------------------------------------- */

/// Interact with on-chain contracts.
#[cfg(feature = "contract")]
#[doc(inline)]
pub use alloy_contract as contract;

/// Ethereum consensus interface.
#[cfg(feature = "consensus")]
#[doc(inline)]
pub use alloy_consensus as consensus;

/// Ethereum Improvement Proposal (EIP) implementations.
#[cfg(feature = "eips")]
#[doc(inline)]
pub use alloy_eips as eips;

/// Ethereum Name Service utilities like namehash, forward & reverse lookups. ENS Name
/// resolving utilities.
#[cfg(feature = "ens")]
#[doc(inline)]
pub use alloy_ens as ens;

/// Ethereum blockchain RPC behavior abstraction.
#[cfg(feature = "network")]
#[doc(inline)]
pub use alloy_network as network;

/// Ethereum genesis file definitions.
#[cfg(feature = "genesis")]
#[doc(inline)]
pub use alloy_genesis as genesis;

/// Ethereum execution-layer client bindings.
///
/// Enable the `node-bindings` feature to access this re-export.
/// For `ProviderBuilder::connect_anvil*` in `alloy::providers`, enable
/// `provider-anvil-node` or combine `providers` with `node-bindings`.
#[cfg(feature = "node-bindings")]
#[cfg_attr(docsrs, doc(cfg(feature = "node-bindings")))]
#[doc(inline)]
pub use alloy_node_bindings as node_bindings;

/// Interface with an Ethereum blockchain.
///
/// See [`alloy_provider`] for more details.
#[cfg(feature = "providers")]
pub mod providers {
    #[doc(inline)]
    pub use alloy_provider::*;
}

/// Ethereum JSON-RPC publish-subscribe tower service and type definitions.
///
/// You will likely not need to use this module;
/// see the [`providers`] module for high-level usage of pubsub.
///
/// See [`alloy_pubsub`] for more details.
#[doc = "\n"] // Empty doc line `///` gets deleted by rustfmt.
#[cfg_attr(feature = "providers", doc = "[`providers`]: crate::providers")]
#[cfg_attr(
    not(feature = "providers"),
    doc = "[`providers`]: https://github.com/alloy-rs/alloy/tree/main/crates/provider"
)]
#[cfg(feature = "pubsub")]
pub mod pubsub {
    #[doc(inline)]
    pub use alloy_pubsub::*;
}

/// Ethereum JSON-RPC client and types.
#[cfg(feature = "rpc")]
pub mod rpc {
    #[cfg(feature = "rpc-client")]
    #[doc(inline)]
    pub use alloy_rpc_client as client;

    #[cfg(feature = "json-rpc")]
    #[doc(inline)]
    pub use alloy_json_rpc as json_rpc;

    /// Ethereum JSON-RPC type definitions.
    #[cfg(feature = "rpc-types")]
    #[doc(inline)]
    pub use alloy_rpc_types as types;
}

/// Serde related helpers for Alloy.
#[cfg(feature = "serde")]
#[doc(inline)]
pub use alloy_serde as serde;

/// Ethereum signer abstraction and implementations.
///
/// See [`alloy_signer`] for more details.
#[cfg(feature = "signers")]
pub mod signers {
    #[doc(inline)]
    pub use alloy_signer::*;

    #[cfg(feature = "signer-aws")]
    #[doc(inline)]
    pub use alloy_signer_aws as aws;

    #[cfg(feature = "signer-gcp")]
    #[doc(inline)]
    pub use alloy_signer_gcp as gcp;

    #[cfg(feature = "signer-ledger")]
    #[doc(inline)]
    pub use alloy_signer_ledger as ledger;

    #[cfg(feature = "signer-local")]
    #[doc(inline)]
    pub use alloy_signer_local as local;

    #[cfg(feature = "signer-trezor")]
    #[doc(inline)]
    pub use alloy_signer_trezor as trezor;

    #[cfg(feature = "signer-turnkey")]
    #[doc(inline)]
    pub use alloy_signer_turnkey as turnkey;
}

/// Low-level Ethereum JSON-RPC transport abstraction and implementations.
///
/// You will likely not need to use this module;
/// see the [`providers`] module for high-level usage of transports.
///
/// See [`alloy_transport`] for more details.
#[doc = "\n"] // Empty doc line `///` gets deleted by rustfmt.
#[cfg_attr(feature = "providers", doc = "[`providers`]: crate::providers")]
#[cfg_attr(
    not(feature = "providers"),
    doc = "[`providers`]: https://github.com/alloy-rs/alloy/tree/main/crates/provider"
)]
#[cfg(feature = "transports")]
pub mod transports {
    #[doc(inline)]
    pub use alloy_transport::*;

    #[cfg(feature = "transport-http")]
    #[doc(inline)]
    pub use alloy_transport_http as http;

    #[cfg(feature = "transport-ipc")]
    #[doc(inline)]
    pub use alloy_transport_ipc as ipc;

    #[cfg(feature = "transport-ws")]
    #[doc(inline)]
    pub use alloy_transport_ws as ws;
}

/// Fast Merkle-Patricia Trie (MPT) state root calculator and proof generator
/// for prefix-sorted nibbles.
///
/// See [`alloy_trie`] for more details.
#[cfg(feature = "trie")]
pub use alloy_trie as trie;