foundry-block-explorers 0.23.1

Bindings for Etherscan.io and other block explorer APIs
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
229
230
231

use crate::{init_tracing, run_with_client, run_with_client_cached};
use alloy_chains::{Chain, NamedChain};
use foundry_block_explorers::{Client, contract::SourceCodeMetadata, errors::EtherscanError};
use serial_test::serial;

/// Abi of [0x00000000219ab540356cBB839Cbe05303d7705Fa](https://api.etherscan.io/api?module=contract&action=getsourcecode&address=0x00000000219ab540356cBB839Cbe05303d7705Fa).
const DEPOSIT_CONTRACT_ABI: &str = include!("../../test-data/deposit_contract.expr");

// Ignoring since API key is invalid
#[ignore]
#[tokio::test]
#[serial]
async fn external_can_fetch_ftm_contract_abi() {
    run_with_client(Chain::from_named(NamedChain::Fantom), |client| async move {
        let _abi = client
            .contract_abi("0x80AA7cb0006d5DDD91cce684229Ac6e398864606".parse().unwrap())
            .await
            .unwrap();
    })
    .await;
}

#[tokio::test]
#[serial]
async fn external_can_fetch_contract_abi() {
    run_with_client(Chain::mainnet(), |client| async move {
        let abi = client
            .contract_abi("0x00000000219ab540356cBB839Cbe05303d7705Fa".parse().unwrap())
            .await
            .unwrap();
        assert_eq!(abi, serde_json::from_str(DEPOSIT_CONTRACT_ABI).unwrap());
    })
    .await;
}

#[tokio::test]
#[serial]
async fn external_can_fetch_and_cache_contract_abi() {
    async fn fetch_abi(client: &Client, addr: &str) {
        let abi = client.contract_abi(addr.parse().unwrap()).await.unwrap();
        assert_eq!(abi, serde_json::from_str(DEPOSIT_CONTRACT_ABI).unwrap());
    }

    run_with_client_cached(Chain::mainnet(), |client| async move {
        // Fetch the abi and cache it.
        fetch_abi(&client, "0x00000000219ab540356cBB839Cbe05303d7705Fa").await;

        // Repeated calls on the cached abi should not trigger a new request.
        for _ in 0..10 {
            fetch_abi(&client, "0x00000000219ab540356cBB839Cbe05303d7705Fa").await;
        }
    })
    .await;
}

#[tokio::test]
#[serial]
async fn external_can_fetch_and_cache_contract_source_code() {
    async fn fetch_source_code(client: &Client, addr: &str) {
        let meta = client.contract_source_code(addr.parse().unwrap()).await.unwrap();
        assert_eq!(meta.items.len(), 1);

        let item = &meta.items[0];
        assert!(matches!(item.source_code, SourceCodeMetadata::SourceCode(_)));
        assert_eq!(item.source_code.sources().len(), 1);
        assert_eq!(item.abi().unwrap(), serde_json::from_str(DEPOSIT_CONTRACT_ABI).unwrap());
    }

    run_with_client_cached(Chain::mainnet(), |client| async move {
        // Fetch the source code and cache it.
        fetch_source_code(&client, "0x00000000219ab540356cBB839Cbe05303d7705Fa").await;

        // Repeated calls on the cached source code should not trigger a new request.
        for _ in 0..10 {
            fetch_source_code(&client, "0x00000000219ab540356cBB839Cbe05303d7705Fa").await;
        }
    })
    .await;
}

#[tokio::test]
#[serial]
async fn external_can_fetch_deposit_contract_source_code_from_blockscout() {
    let client = Client::builder()
        .with_url("https://eth.blockscout.com")
        .unwrap()
        .with_api_url("https://eth.blockscout.com/api")
        .unwrap()
        .with_api_key("test")
        .build()
        .unwrap();
    let meta = client
        .contract_source_code("0x00000000219ab540356cBB839Cbe05303d7705Fa".parse().unwrap())
        .await
        .unwrap();

    assert_eq!(meta.items.len(), 1);
    let item = &meta.items[0];
    assert!(matches!(item.source_code, SourceCodeMetadata::SourceCode(_)));
    assert_eq!(item.source_code.sources().len(), 1);
    assert_eq!(item.abi().unwrap(), serde_json::from_str(DEPOSIT_CONTRACT_ABI).unwrap());
}

#[tokio::test]
#[serial]
async fn external_can_fetch_other_contract_source_code_from_blockscout() {
    let client = Client::builder()
        .with_url("https://eth.blockscout.com")
        .unwrap()
        .with_api_url("https://eth.blockscout.com/api")
        .unwrap()
        .with_api_key("test")
        .build()
        .unwrap();
    let meta = client
        .contract_source_code("0xDef1C0ded9bec7F1a1670819833240f027b25EfF".parse().unwrap())
        .await
        .unwrap();

    assert_eq!(meta.items.len(), 1);
    let item = &meta.items[0];
    assert!(matches!(item.source_code, SourceCodeMetadata::SourceCode(_)));
    assert_eq!(item.source_code.sources().len(), 1);
}

#[tokio::test]
#[serial]
async fn external_can_fetch_contract_source_code() {
    run_with_client(Chain::mainnet(), |client| async move {
        let meta = client
            .contract_source_code("0x00000000219ab540356cBB839Cbe05303d7705Fa".parse().unwrap())
            .await
            .unwrap();

        assert_eq!(meta.items.len(), 1);
        let item = &meta.items[0];
        assert!(matches!(item.source_code, SourceCodeMetadata::SourceCode(_)));
        assert_eq!(item.source_code.sources().len(), 1);
        assert_eq!(item.abi().unwrap(), serde_json::from_str(DEPOSIT_CONTRACT_ABI).unwrap());
    })
    .await
}

#[tokio::test]
#[serial]
async fn external_can_get_error_on_unverified_contract() {
    init_tracing();
    run_with_client(Chain::mainnet(), |client| async move {
        let addr = "0xb5c31a0e22cae98ac08233e512bd627885aa24e5".parse().unwrap();
        let err = client.contract_source_code(addr).await.unwrap_err();
        assert!(matches!(err, EtherscanError::ContractCodeNotVerified(_)));
    })
    .await
}

/// Query a contract that has a single string source entry instead of underlying JSON metadata.
#[tokio::test]
#[serial]
async fn external_can_fetch_contract_source_tree_for_singleton_contract() {
    run_with_client(Chain::mainnet(), |client| async move {
        let meta = client
            .contract_source_code("0x00000000219ab540356cBB839Cbe05303d7705Fa".parse().unwrap())
            .await
            .unwrap();

        assert_eq!(meta.items.len(), 1);
        let item = &meta.items[0];
        assert!(matches!(item.source_code, SourceCodeMetadata::SourceCode(_)));
        assert_eq!(item.source_code.sources().len(), 1);
        assert_eq!(item.abi().unwrap(), serde_json::from_str(DEPOSIT_CONTRACT_ABI).unwrap());
    })
    .await
}

/// Query a contract that has many source entries as JSON metadata and ensure they are reflected.
#[tokio::test]
#[serial]
async fn external_can_fetch_contract_source_tree_for_multi_entry_contract() {
    run_with_client(Chain::mainnet(), |client| async move {
        let meta = client
            .contract_source_code("0x8d04a8c79cEB0889Bdd12acdF3Fa9D207eD3Ff63".parse().unwrap())
            .await
            .unwrap();

        assert_eq!(meta.items.len(), 1);
        assert!(matches!(meta.items[0].source_code, SourceCodeMetadata::Metadata { .. }));
        assert_eq!(meta.source_tree().entries.len(), 15);
    })
    .await
}

/// Query a contract that has a plain source code mapping instead of tagged structures.
#[tokio::test]
#[serial]
async fn external_can_fetch_contract_source_tree_for_plain_source_code_mapping() {
    run_with_client(Chain::mainnet(), |client| async move {
        let meta = client
            .contract_source_code("0x68b26dcf21180d2a8de5a303f8cc5b14c8d99c4c".parse().unwrap())
            .await
            .unwrap();

        assert_eq!(meta.items.len(), 1);
        assert!(matches!(meta.items[0].source_code, SourceCodeMetadata::Sources(_)));
        assert_eq!(meta.source_tree().entries.len(), 6);
    })
    .await
}

#[tokio::test]
#[serial]
async fn external_can_fetch_contract_creation_data() {
    run_with_client(Chain::mainnet(), |client| async move {
        client
            .contract_creation_data("0xdac17f958d2ee523a2206206994597c13d831ec7".parse().unwrap())
            .await
            .unwrap();
    })
    .await
}

#[tokio::test]
#[serial]
async fn external_error_when_creation_data_for_eoa() {
    init_tracing();
    run_with_client(Chain::mainnet(), |client| async move {
        let addr = "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045".parse().unwrap();
        let err = client.contract_creation_data(addr).await.unwrap_err();
        assert!(matches!(err, EtherscanError::ContractNotFound(_)));
    })
    .await
}