cargo-tangle 0.5.0-alpha.13

A command-line tool to create and deploy blueprints on Tangle Network
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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
use alloy_network::EthereumWallet;
use alloy_primitives::{Address, FixedBytes};
use alloy_signer_local::PrivateKeySigner;
/// EigenLayer rewards claiming and management
///
/// Requires EigenLayer Sidecar API (<https://github.com/Layr-Labs/sidecar>)
use blueprint_eigenlayer_extra::sidecar::{Proof, SidecarClient};
use blueprint_evm_extra::util::get_wallet_provider_http;
use blueprint_keystore::backends::Backend;
use blueprint_keystore::backends::eigenlayer::EigenlayerBackend;
use blueprint_keystore::crypto::k256::K256Ecdsa;
use blueprint_keystore::{Keystore, KeystoreConfig};
use color_eyre::Result;
use eigensdk::utils::rewardsv2::core::rewards_coordinator::{
    IRewardsCoordinator, RewardsCoordinator,
};
use std::str::FromStr;

const DEFAULT_SIDECAR_URL_MAINNET: &str = "https://sidecar-rpc.eigenlayer.xyz/mainnet";
const DEFAULT_SIDECAR_URL_HOLESKY: &str = "https://sidecar-rpc.eigenlayer.xyz/holesky";

/// Show rewards summary for an earner address
///
/// # Arguments
/// * `earner_address` - Ethereum address of the earner
/// * `sidecar_url` - Optional Sidecar API URL (defaults to mainnet)
/// * `network` - Network name (mainnet or holesky)
///
/// # Errors
///
/// Returns error if:
/// - Sidecar client cannot be created
/// - Rewards data cannot be fetched from Sidecar API
pub async fn show_rewards(
    earner_address: &str,
    sidecar_url: Option<&str>,
    network: Option<&str>,
) -> Result<()> {
    let url = sidecar_url.unwrap_or(match network {
        Some("holesky") => DEFAULT_SIDECAR_URL_HOLESKY,
        _ => DEFAULT_SIDECAR_URL_MAINNET,
    });

    println!("Fetching rewards from Sidecar: {}", url);

    let client = SidecarClient::new(url.to_string())
        .map_err(|e| color_eyre::eyre::eyre!("Failed to create Sidecar client: {}", e))?;

    let rewards = client
        .get_summarized_rewards(earner_address, None)
        .await
        .map_err(|e| color_eyre::eyre::eyre!("Failed to fetch rewards: {}", e))?;

    if rewards.is_empty() {
        println!("No rewards found for earner: {}", earner_address);
        return Ok(());
    }

    println!("\nRewards Summary for {}:", earner_address);
    println!("{:-<100}", "");
    println!(
        "{:<42} {:>15} {:>15} {:>15} {:>15}",
        "Token", "Earned", "Active", "Claimed", "Claimable"
    );
    println!("{:-<100}", "");

    for reward in rewards {
        println!(
            "{:<42} {:>15} {:>15} {:>15} {:>15}",
            reward.token, reward.earned, reward.active, reward.claimed, reward.claimable
        );
    }
    println!("{:-<100}", "");

    Ok(())
}

/// Claim rewards for an earner
///
/// # Arguments
/// * `earner_address` - Ethereum address of the earner
/// * `recipient_address` - Address to receive rewards (defaults to earner)
/// * `token_addresses` - Specific tokens to claim (empty = all claimable)
/// * `rewards_coordinator` - `RewardsCoordinator` contract address
/// * `sidecar_url` - Optional Sidecar API URL
/// * `network` - Network name
/// * `keystore_uri` - Keystore URI for signing
/// * `rpc_url` - Ethereum RPC endpoint
/// * `batch_file` - Optional YAML file for batch claiming
///
/// # Errors
///
/// Returns error if:
/// - Sidecar client cannot be created
/// - Invalid address format for earner or recipient
/// - Keystore cannot be loaded or accessed
/// - ECDSA key not found in keystore
/// - Failed to create wallet signer
/// - Proof generation fails
/// - Transaction submission or receipt retrieval fails
/// - Batch file cannot be read or parsed
#[allow(clippy::too_many_arguments)]
pub async fn claim_rewards(
    earner_address: &str,
    recipient_address: Option<&str>,
    token_addresses: Vec<String>,
    rewards_coordinator: Address,
    sidecar_url: Option<&str>,
    network: Option<&str>,
    keystore_uri: &str,
    rpc_url: &str,
    batch_file: Option<&str>,
) -> Result<()> {
    let url = sidecar_url.unwrap_or(match network {
        Some("holesky") => DEFAULT_SIDECAR_URL_HOLESKY,
        _ => DEFAULT_SIDECAR_URL_MAINNET,
    });

    let sidecar = SidecarClient::new(url.to_string())
        .map_err(|e| color_eyre::eyre::eyre!("Failed to create Sidecar client: {}", e))?;

    let recipient = if let Some(addr) = recipient_address {
        Address::parse_checksummed(addr, None)
            .map_err(|e| color_eyre::eyre::eyre!("Invalid recipient address: {}", e))?
    } else {
        Address::parse_checksummed(earner_address, None)
            .map_err(|e| color_eyre::eyre::eyre!("Invalid earner address: {}", e))?
    };

    // Load keystore for signing
    println!("Loading keystore from: {}", keystore_uri);
    let keystore_config = KeystoreConfig::new().fs_root(keystore_uri);
    let keystore = Keystore::new(keystore_config)?;

    let ecdsa_public = keystore
        .first_local::<K256Ecdsa>()
        .map_err(|e| color_eyre::eyre::eyre!("Failed to get ECDSA key: {}", e))?;

    let ecdsa_secret = keystore
        .expose_ecdsa_secret(&ecdsa_public)
        .map_err(|e| color_eyre::eyre::eyre!("Failed to expose ECDSA secret: {}", e))?
        .ok_or_else(|| color_eyre::eyre::eyre!("No ECDSA secret found in keystore"))?;

    let private_key = alloy_primitives::hex::encode(ecdsa_secret.0.to_bytes());
    let wallet = PrivateKeySigner::from_str(&private_key)
        .map_err(|e| color_eyre::eyre::eyre!("Failed to create signer: {}", e))?;

    let provider = get_wallet_provider_http(rpc_url, EthereumWallet::from(wallet));
    let rewards_contract = RewardsCoordinator::new(rewards_coordinator, provider);

    if let Some(file_path) = batch_file {
        // Batch claim from YAML file
        println!("Processing batch claims from file: {}", file_path);
        let yaml_content = std::fs::read_to_string(file_path)?;

        #[derive(serde::Deserialize)]
        struct BatchClaimEntry {
            earner_address: String,
            token_addresses: Vec<String>,
        }

        let entries: Vec<BatchClaimEntry> = serde_yaml::from_str(&yaml_content)?;
        let mut proofs = Vec::new();

        for entry in entries {
            println!("Generating proof for earner: {}", entry.earner_address);

            let proof = sidecar
                .generate_claim_proof(&entry.earner_address, entry.token_addresses, None)
                .await
                .map_err(|e| color_eyre::eyre::eyre!("Failed to generate proof: {}", e))?;

            proofs.push(convert_proof_to_contract_format(proof));
        }

        if proofs.is_empty() {
            return Err(color_eyre::eyre::eyre!("No valid proofs generated"));
        }

        println!("Submitting batch claim with {} proofs...", proofs.len());

        let receipt = rewards_contract
            .processClaims(proofs, recipient)
            .send()
            .await
            .map_err(|e| color_eyre::eyre::eyre!("Transaction failed: {}", e))?
            .get_receipt()
            .await
            .map_err(|e| color_eyre::eyre::eyre!("Failed to get receipt: {}", e))?;

        println!("Batch claim successful!");
        println!("Transaction hash: {:?}", receipt.transaction_hash);
    } else {
        // Single claim
        println!("Generating claim proof for earner: {}", earner_address);

        let proof = sidecar
            .generate_claim_proof(earner_address, token_addresses, None)
            .await
            .map_err(|e| color_eyre::eyre::eyre!("Failed to generate proof: {}", e))?;

        let claim = convert_proof_to_contract_format(proof);

        println!("Submitting claim transaction...");

        let receipt = rewards_contract
            .processClaim(claim, recipient)
            .send()
            .await
            .map_err(|e| color_eyre::eyre::eyre!("Transaction failed: {}", e))?
            .get_receipt()
            .await
            .map_err(|e| color_eyre::eyre::eyre!("Failed to get receipt: {}", e))?;

        println!("Claim successful!");
        println!("Transaction hash: {:?}", receipt.transaction_hash);
    }

    Ok(())
}

/// Set the claimer address for the earner
///
/// # Arguments
/// * `claimer_address` - Address authorized to claim on behalf of earner
/// * `rewards_coordinator` - `RewardsCoordinator` contract address
/// * `keystore_uri` - Keystore URI for signing
/// * `rpc_url` - Ethereum RPC endpoint
///
/// # Errors
///
/// Returns error if:
/// - Invalid claimer address format
/// - Keystore cannot be loaded or accessed
/// - ECDSA key not found in keystore
/// - Failed to derive earner address
/// - Failed to create wallet signer
/// - Transaction submission or receipt retrieval fails
pub async fn set_claimer(
    claimer_address: &str,
    rewards_coordinator: Address,
    keystore_uri: &str,
    rpc_url: &str,
) -> Result<()> {
    let claimer = Address::parse_checksummed(claimer_address, None)
        .map_err(|e| color_eyre::eyre::eyre!("Invalid claimer address: {}", e))?;

    println!("Loading keystore from: {}", keystore_uri);
    let keystore_config = KeystoreConfig::new().fs_root(keystore_uri);
    let keystore = Keystore::new(keystore_config)?;

    let ecdsa_public = keystore
        .first_local::<K256Ecdsa>()
        .map_err(|e| color_eyre::eyre::eyre!("Failed to get ECDSA key: {}", e))?;

    let ecdsa_secret = keystore
        .expose_ecdsa_secret(&ecdsa_public)
        .map_err(|e| color_eyre::eyre::eyre!("Failed to expose ECDSA secret: {}", e))?
        .ok_or_else(|| color_eyre::eyre::eyre!("No ECDSA secret found in keystore"))?;

    let earner_address = ecdsa_secret
        .alloy_address()
        .map_err(|e| color_eyre::eyre::eyre!("Failed to derive address: {}", e))?;

    let private_key = alloy_primitives::hex::encode(ecdsa_secret.0.to_bytes());
    let wallet = PrivateKeySigner::from_str(&private_key)
        .map_err(|e| color_eyre::eyre::eyre!("Failed to create signer: {}", e))?;

    let provider = get_wallet_provider_http(rpc_url, EthereumWallet::from(wallet));
    let rewards_contract = RewardsCoordinator::new(rewards_coordinator, provider);

    println!(
        "Setting claimer {} for earner {}...",
        claimer, earner_address
    );

    let receipt = rewards_contract
        .setClaimerFor(claimer)
        .send()
        .await
        .map_err(|e| color_eyre::eyre::eyre!("Transaction failed: {}", e))?
        .get_receipt()
        .await
        .map_err(|e| color_eyre::eyre::eyre!("Failed to get receipt: {}", e))?;

    println!("Claimer set successfully!");
    println!("Transaction hash: {:?}", receipt.transaction_hash);

    Ok(())
}

/// Convert Sidecar Proof to `RewardsCoordinator` contract format
fn convert_proof_to_contract_format(proof: Proof) -> IRewardsCoordinator::RewardsMerkleClaim {
    let mut earner_token_root = [0u8; 32];
    earner_token_root.copy_from_slice(&proof.earner_leaf.earner_token_root);

    let earner = proof
        .earner_leaf
        .earner
        .parse()
        .expect("Invalid earner address in proof");

    let token_leaves: Vec<IRewardsCoordinator::TokenTreeMerkleLeaf> = proof
        .token_leaves
        .into_iter()
        .map(|leaf| {
            let token: Address = leaf.token.parse().expect("Invalid token address in proof");
            let cumulative_earnings = alloy_primitives::U256::from_str(&leaf.cumulative_earnings)
                .expect("Invalid cumulative earnings");

            IRewardsCoordinator::TokenTreeMerkleLeaf {
                token,
                cumulativeEarnings: cumulative_earnings,
            }
        })
        .collect();

    let token_tree_proofs: Vec<alloy_primitives::Bytes> = proof
        .token_tree_proofs
        .into_iter()
        .map(|p| {
            let bytes =
                hex::decode(p.trim_start_matches("0x")).expect("Invalid hex in token tree proof");
            alloy_primitives::Bytes::from(bytes)
        })
        .collect();

    IRewardsCoordinator::RewardsMerkleClaim {
        rootIndex: proof.root_index,
        earnerIndex: proof.earner_index,
        earnerTreeProof: proof.earner_tree_proof.into(),
        earnerLeaf: IRewardsCoordinator::EarnerTreeMerkleLeaf {
            earner,
            earnerTokenRoot: FixedBytes::from(earner_token_root),
        },
        tokenIndices: proof.token_indices,
        tokenTreeProofs: token_tree_proofs,
        tokenLeaves: token_leaves,
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use blueprint_eigenlayer_extra::sidecar::{EarnerLeaf, TokenLeaf};

    #[test]
    fn test_convert_proof_to_contract_format() {
        let earner_token_root = vec![1u8; 32];
        let root = vec![2u8; 32];
        let earner_tree_proof = vec![3u8; 32];

        let proof = Proof {
            root,
            root_index: 1,
            earner_index: 2,
            earner_tree_proof,
            earner_leaf: EarnerLeaf {
                earner: "0x1234567890123456789012345678901234567890".to_string(),
                earner_token_root,
            },
            token_indices: vec![0, 1],
            token_tree_proofs: vec![
                "0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa".to_string(),
                "0xbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb".to_string(),
            ],
            token_leaves: vec![
                TokenLeaf {
                    token: "0xabcdabcdabcdabcdabcdabcdabcdabcdabcdabcd".to_string(),
                    cumulative_earnings: "1000000000000000000".to_string(),
                },
                TokenLeaf {
                    token: "0x1111111111111111111111111111111111111111".to_string(),
                    cumulative_earnings: "2000000000000000000".to_string(),
                },
            ],
        };

        let claim = convert_proof_to_contract_format(proof);

        assert_eq!(claim.rootIndex, 1);
        assert_eq!(claim.earnerIndex, 2);
        assert_eq!(claim.tokenIndices, vec![0, 1]);
        assert_eq!(claim.tokenLeaves.len(), 2);
        assert_eq!(claim.tokenTreeProofs.len(), 2);
        assert_eq!(
            claim.earnerLeaf.earner,
            Address::parse_checksummed("0x1234567890123456789012345678901234567890", None).unwrap()
        );
    }

    #[test]
    fn test_proof_conversion_with_hex_prefixes() {
        let proof = Proof {
            root: vec![1u8; 32],
            root_index: 0,
            earner_index: 0,
            earner_tree_proof: vec![2u8; 32],
            earner_leaf: EarnerLeaf {
                earner: "0x1234567890123456789012345678901234567890".to_string(),
                earner_token_root: vec![3u8; 32],
            },
            token_indices: vec![0],
            token_tree_proofs: vec![
                "0xcccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc".to_string(),
            ],
            token_leaves: vec![TokenLeaf {
                token: "0xabcdabcdabcdabcdabcdabcdabcdabcdabcdabcd".to_string(),
                cumulative_earnings: "1000".to_string(),
            }],
        };

        let claim = convert_proof_to_contract_format(proof);
        assert_eq!(claim.tokenTreeProofs.len(), 1);
        assert_eq!(claim.tokenTreeProofs[0].len(), 32);
    }

    #[test]
    fn test_proof_conversion_without_hex_prefixes() {
        let proof = Proof {
            root: vec![1u8; 32],
            root_index: 0,
            earner_index: 0,
            earner_tree_proof: vec![2u8; 32],
            earner_leaf: EarnerLeaf {
                earner: "0x1234567890123456789012345678901234567890".to_string(),
                earner_token_root: vec![3u8; 32],
            },
            token_indices: vec![0],
            token_tree_proofs: vec![
                "dddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddd".to_string(),
            ],
            token_leaves: vec![TokenLeaf {
                token: "0xabcdabcdabcdabcdabcdabcdabcdabcdabcdabcd".to_string(),
                cumulative_earnings: "1000".to_string(),
            }],
        };

        let claim = convert_proof_to_contract_format(proof);
        assert_eq!(claim.tokenTreeProofs.len(), 1);
        assert_eq!(claim.tokenTreeProofs[0].len(), 32);
    }
}