sourcify 0.0.4

A lightweight wrapper for Sourcify and 4byte APIs for fetching Ethereum smart contract source code and signatures
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

use serde::{Deserialize, Serialize};
use std::collections::HashMap;

/// Public Sourcify 4byte API base URL used by the 4byte client.
pub const DEFAULT_BASE_URL: &str = "https://api.4byte.sourcify.dev";

/// Envelope returned by lookup and search endpoints.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct LookupResponse {
    /// Whether the upstream API considered the request successful.
    pub ok: bool,
    /// Grouped signature candidates.
    pub result: SignatureResponse,
}

/// Function and event signatures grouped by selector/topic hash.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SignatureResponse {
    /// Function signatures keyed by 4-byte selector. Unknown functions are `None`.
    #[serde(rename = "function")]
    pub functions: Option<HashMap<String, Option<Vec<Signature>>>>,
    /// Event signatures keyed by 32-byte topic hash.
    pub event: Option<HashMap<String, Vec<Signature>>>,
}

/// A decoded function or event signature candidate.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Signature {
    /// Human-readable Solidity signature, for example `transfer(address,uint256)`.
    pub name: String,
    /// Whether the upstream API marked this result as filtered.
    pub filtered: bool,
    /// Whether this signature is associated with a verified contract.
    #[serde(rename = "hasVerifiedContract")]
    pub has_verified_contract: bool,
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn deserializes_lookup_response_with_function_match() {
        let response: LookupResponse = serde_json::from_str(
            r#"{
                "ok": true,
                "result": {
                    "function": {
                        "0xa9059cbb": [{
                            "name": "transfer(address,uint256)",
                            "filtered": false,
                            "hasVerifiedContract": true
                        }]
                    }
                }
            }"#,
        )
        .unwrap();

        let signatures = response
            .result
            .functions
            .unwrap()
            .remove("0xa9059cbb")
            .unwrap()
            .unwrap();
        assert_eq!(signatures[0].name, "transfer(address,uint256)");
    }

    #[test]
    fn deserializes_lookup_response_with_missing_function_match() {
        let response: LookupResponse = serde_json::from_str(
            r#"{
                "ok": true,
                "result": {
                    "function": {
                        "0x12345678": null
                    }
                }
            }"#,
        )
        .unwrap();

        assert!(response
            .result
            .functions
            .unwrap()
            .get("0x12345678")
            .unwrap()
            .is_none());
    }
}