Skip to main content

vanity_core/chains/
filecoin.rs

1use crate::chain::{ChainGrinder, GrindAttempt, KeyExport, KeypairResult};
2use crate::pattern::Pattern;
3use data_encoding::BASE32_NOPAD;
4use secp256k1::{PublicKey, Secp256k1, SecretKey};
5
6use super::util::{
7    base32_combinations, blake2b_var, build_base58_pattern, expected_from_pattern, grind_secp256k1,
8    matches_pattern, secret_from_attempt, BASE32_ALPHABET_LOWER,
9};
10
11#[derive(Clone, Default)]
12pub struct FilecoinGrinder;
13
14impl FilecoinGrinder {
15    /// Protocol 1 (secp256k1) address: f1 + base32(payload || checksum).
16    fn address_from_uncompressed_pubkey(uncompressed: &[u8]) -> String {
17        let payload = blake2b_var(uncompressed, 20);
18        let mut checksum_input = Vec::with_capacity(21);
19        checksum_input.push(1u8); // protocol
20        checksum_input.extend_from_slice(&payload);
21        let checksum = blake2b_var(&checksum_input, 4);
22        let mut encoded = Vec::with_capacity(24);
23        encoded.extend_from_slice(&payload);
24        encoded.extend_from_slice(&checksum);
25        format!("f1{}", BASE32_NOPAD.encode(&encoded).to_ascii_lowercase())
26    }
27
28    fn derive(secret: &SecretKey) -> String {
29        let secp = Secp256k1::new();
30        let pubkey: PublicKey = secret.public_key(&secp);
31        Self::address_from_uncompressed_pubkey(&pubkey.serialize_uncompressed())
32    }
33}
34
35impl ChainGrinder for FilecoinGrinder {
36    fn id(&self) -> &'static str {
37        "fil"
38    }
39
40    fn display_name(&self) -> &'static str {
41        "Filecoin (f1)"
42    }
43
44    fn grind_attempt(&self) -> (String, GrindAttempt) {
45        grind_secp256k1(Self::derive)
46    }
47
48    fn finalize(&self, attempt: GrindAttempt) -> KeypairResult {
49        let secret_bytes = secret_from_attempt(attempt);
50        let secret_key = SecretKey::from_slice(&secret_bytes).expect("valid secp256k1 secret");
51        let address = Self::derive(&secret_key);
52
53        KeypairResult {
54            address,
55            exports: vec![KeyExport {
56                label: "Private Key (hex)".into(),
57                value: hex::encode(secret_bytes),
58                hint: Some("Lotus / Glif secp256k1 (f1) import".into()),
59            }],
60        }
61    }
62
63    fn build_pattern(
64        &self,
65        prefix: Option<&str>,
66        suffix: Option<&str>,
67        exact: bool,
68    ) -> Result<Pattern, String> {
69        let lower = |s: Option<&str>| s.map(|v| v.to_ascii_lowercase());
70        let mut pattern = build_base58_pattern(
71            lower(prefix).as_deref(),
72            lower(suffix).as_deref(),
73            exact,
74            BASE32_ALPHABET_LOWER,
75            64,
76        )?;
77        if pattern.has_prefix() && !pattern.prefix.starts_with("f1") {
78            let rest = pattern.prefix.strip_prefix('f').unwrap_or(&pattern.prefix);
79            pattern.prefix = format!("f1{rest}");
80            pattern.prefix_match = pattern.prefix.clone();
81        }
82        Ok(pattern)
83    }
84
85    fn expected_attempts(&self, pattern: &Pattern) -> f64 {
86        expected_from_pattern(pattern, |p| {
87            let data = p.strip_prefix("f1").unwrap_or(p);
88            base32_combinations(data)
89        })
90    }
91
92    fn matches(&self, address: &str, pattern: &Pattern) -> bool {
93        matches_pattern(address, pattern, true)
94    }
95
96    fn supports_exact_case(&self) -> bool {
97        false
98    }
99
100    fn pattern_hint(&self) -> &'static str {
101        "Base32 after f1 (secp256k1 protocol-1 addresses)."
102    }
103}
104
105#[cfg(test)]
106mod tests {
107    use super::FilecoinGrinder;
108    use crate::chain::ChainGrinder;
109
110    #[test]
111    fn filecoin_address_starts_with_f1() {
112        let g = FilecoinGrinder;
113        let (addr, _) = g.grind_attempt();
114        assert!(addr.starts_with("f1"));
115    }
116
117    /// Known-answer test from filecoin-project/go-address's own
118    /// TestVectorSecp256k1Address: this exact uncompressed pubkey must
119    /// produce this exact mainnet f1 address.
120    #[test]
121    fn filecoin_matches_go_address_known_vector() {
122        let uncompressed: [u8; 65] = [
123            4, 148, 2, 250, 195, 126, 100, 50, 164, 22, 163, 160, 202, 84, 38, 181, 24, 90, 179,
124            178, 79, 97, 52, 239, 162, 92, 228, 135, 200, 45, 46, 78, 19, 191, 69, 37, 17, 224,
125            210, 36, 84, 33, 248, 97, 59, 193, 13, 114, 250, 33, 102, 102, 169, 108, 59, 193, 57,
126            32, 211, 255, 35, 63, 208, 188, 5,
127        ];
128        let addr = FilecoinGrinder::address_from_uncompressed_pubkey(&uncompressed);
129        assert_eq!(addr, "f15ihq5ibzwki2b4ep2f46avlkrqzhpqgtga7pdrq");
130    }
131}