sn_testnet_deploy/
funding.rs

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
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
// Copyright (c) 2023, MaidSafe.
// All rights reserved.
//
// This SAFE Network Software is licensed under the BSD-3-Clause license.
// Please see the LICENSE file for more details.

use crate::error::Result;
use crate::{
    ansible::{inventory::AnsibleInventoryType, provisioning::AnsibleProvisioner},
    error::Error,
    inventory::VirtualMachine,
    EvmNetwork,
};
use alloy::primitives::Address;
use alloy::{network::EthereumWallet, signers::local::PrivateKeySigner};
use evmlib::{common::U256, wallet::Wallet, Network};
use log::{debug, error, warn};
use std::collections::HashMap;
use std::str::FromStr;

/// 100 token (1e20)
const DEFAULT_TOKEN_AMOUNT: &str = "100_000_000_000_000_000_000";
/// 0.1 ETH (1e17)
const DEFAULT_GAS_AMOUNT: &str = "100_000_000_000_000_000";

pub struct FundingOptions {
    pub evm_network: EvmNetwork,
    /// For custom network
    pub evm_data_payments_address: Option<String>,
    /// For custom network
    pub evm_payment_token_address: Option<String>,
    /// For custom network
    pub evm_rpc_url: Option<String>,
    pub funding_wallet_secret_key: Option<String>,
    /// Have to specify during upscale and deploy
    pub uploaders_count: Option<u16>,
    /// The amount of tokens to transfer to each uploader.
    /// Defaults to 100 token, i.e., 100_000_000_000_000_000_000
    pub token_amount: Option<U256>,
    /// The amount of gas tokens to transfer to each uploader
    /// Defaults to 0.1 ETH i.e, 100_000_000_000_000_000
    pub gas_amount: Option<U256>,
}

impl AnsibleProvisioner {
    /// Retrieve the uploader secret keys for all uploader VMs
    pub fn get_uploader_secret_keys(
        &self,
    ) -> Result<HashMap<VirtualMachine, Vec<PrivateKeySigner>>> {
        let uploaders_count = self.get_current_uploader_count()?;

        debug!("Fetching uploader secret keys");
        let mut uploader_secret_keys = HashMap::new();

        if uploaders_count.is_empty() {
            debug!("No uploaders VMs found");
            return Err(Error::EmptyInventory(AnsibleInventoryType::Uploaders));
        }

        for (vm, count) in uploaders_count {
            if count == 0 {
                warn!("No uploader instances found for {:?}, ", vm.name);
                uploader_secret_keys.insert(vm.clone(), Vec::new());
            } else {
                let sks = self.get_uploader_secret_key_per_vm(&vm, count)?;
                uploader_secret_keys.insert(vm.clone(), sks);
            }
        }

        Ok(uploader_secret_keys)
    }

    /// Deposit funds from the funding_wallet_secret_key to the uploader wallets
    /// If FundingOptions::uploaders_count is provided, it will generate the missing secret keys.
    /// If not provided, we'll just fund the existing uploader wallets
    pub async fn deposit_funds_to_uploaders(
        &self,
        options: &FundingOptions,
    ) -> Result<HashMap<VirtualMachine, Vec<PrivateKeySigner>>> {
        debug!("Funding all the uploader wallets");
        let mut uploader_secret_keys = self.get_uploader_secret_keys()?;

        for (vm, keys) in uploader_secret_keys.iter_mut() {
            if let Some(provided_count) = options.uploaders_count {
                if provided_count < keys.len() as u16 {
                    error!("Provided {provided_count} is less than the existing {} uploaders count for {}", keys.len(), vm.name);
                    return Err(Error::InvalidUpscaleDesiredUploaderCount);
                }
                let missing_keys_count = provided_count - keys.len() as u16;
                debug!(
                    "Found {} secret keys for {}, missing {missing_keys_count} keys",
                    keys.len(),
                    vm.name
                );
                if missing_keys_count > 0 {
                    debug!(
                        "Generating {missing_keys_count} secret keys for {}",
                        vm.name
                    );
                    for _ in 0..missing_keys_count {
                        let sk = PrivateKeySigner::random();
                        debug!("Generated key with address: {}", sk.address());
                        keys.push(sk);
                    }
                }
            }
        }

        let funding_wallet_sk = if let Some(sk) = &options.funding_wallet_secret_key {
            Some(sk.parse().map_err(|_| Error::FailedToParseKey)?)
        } else {
            None
        };

        self.deposit_funds(funding_wallet_sk, &uploader_secret_keys, options)
            .await?;

        Ok(uploader_secret_keys)
    }

    /// Drain all the funds from the uploader wallets to the provided wallet
    pub async fn drain_funds_from_uploaders(
        &self,
        to_address: Address,
        evm_network: Network,
    ) -> Result<()> {
        debug!("Draining all the uploader wallets to {to_address:?}");
        println!("Draining all the uploader wallets to {to_address:?}");
        let uploader_secret_keys = self.get_uploader_secret_keys()?;

        for (vm, keys) in uploader_secret_keys.iter() {
            debug!(
                "Draining funds for uploader vm: {} to {to_address:?}",
                vm.name
            );
            for uploader_sk in keys.iter() {
                debug!(
                    "Draining funds for uploader vm: {} with key: {uploader_sk:?}",
                    vm.name,
                );

                let from_wallet = Wallet::new(
                    evm_network.clone(),
                    EthereumWallet::new(uploader_sk.clone()),
                );

                let token_balance = from_wallet.balance_of_tokens().await.inspect_err(|err| {
                    debug!(
                        "Failed to get token balance for {} with err: {err:?}",
                        from_wallet.address()
                    )
                })?;

                println!(
                    "Draining {token_balance} tokens from {} to {to_address:?}",
                    from_wallet.address()
                );
                debug!(
                    "Draining {token_balance} tokens from {} to {to_address:?}",
                    from_wallet.address()
                );

                if token_balance.is_zero() {
                    debug!(
                        "No tokens to drain from wallet: {} with token balance",
                        from_wallet.address()
                    );
                } else {
                    from_wallet
                        .transfer_tokens(to_address, token_balance)
                        .await
                        .inspect_err(|err| {
                            debug!(
                                "Failed to transfer {token_balance} tokens from {to_address} with err: {err:?}",
                            )
                        })?;
                    println!(
                        "Drained {token_balance} tokens from {} to {to_address:?}",
                        from_wallet.address()
                    );
                    debug!(
                        "Drained {token_balance} tokens from {} to {to_address:?}",
                        from_wallet.address()
                    );
                }

                let gas_balance = from_wallet
                    .balance_of_gas_tokens()
                    .await
                    .inspect_err(|err| {
                        debug!(
                            "Failed to get gas token balance for {} with err: {err:?}",
                            from_wallet.address()
                        )
                    })?;

                println!(
                    "Draining {gas_balance} gas from {} to {to_address:?}",
                    from_wallet.address()
                );
                debug!(
                    "Draining {gas_balance} gas from {} to {to_address:?}",
                    from_wallet.address()
                );

                if gas_balance.is_zero() {
                    debug!("No gas tokens to drain from wallet: {to_address}");
                } else {
                    from_wallet
                    // 0.001 gas
                        .transfer_gas_tokens(to_address, gas_balance - U256::from_str("10_000_000_000_000").unwrap()).await
                        .inspect_err(|err| {
                            debug!(
                                "Failed to transfer {gas_balance} gas from {to_address} with err: {err:?}",
                            )
                        })?;
                    println!(
                        "Drained {gas_balance} gas from {} to {to_address:?}",
                        from_wallet.address()
                    );
                    debug!(
                        "Drained {gas_balance} gas from {} to {to_address:?}",
                        from_wallet.address()
                    );
                }
            }
        }
        println!("All funds drained to {to_address:?} successfully");
        debug!("All funds drained to {to_address:?} successfully");

        Ok(())
    }

    /// Return the (vm name, uploader count) for all uploader VMs
    fn get_current_uploader_count(&self) -> Result<HashMap<VirtualMachine, usize>> {
        let uploader_inventories = self
            .ansible_runner
            .get_inventory(AnsibleInventoryType::Uploaders, true)?;
        if uploader_inventories.is_empty() {
            debug!("No uploaders VMs found");
            return Err(Error::EmptyInventory(AnsibleInventoryType::Uploaders));
        }

        let mut uploader_count = HashMap::new();

        for vm in uploader_inventories {
            debug!(
                "Fetching uploader count for {} @ {}",
                vm.name, vm.public_ip_addr
            );
            let cmd = "systemctl list-units --type=service --all | grep ant_uploader_ | wc -l";
            let result = self
                .ssh_client
                .run_command(&vm.public_ip_addr, "root", cmd, true);
            match result {
                Ok(count) => {
                    debug!("Count found to be {count:?}, parsing");
                    let count = count
                        .first()
                        .ok_or_else(|| {
                            error!("No count found for {}", vm.name);
                            Error::SecretKeyNotFound
                        })?
                        .trim()
                        .parse()
                        .map_err(|_| Error::FailedToParseKey)?;
                    uploader_count.insert(vm.clone(), count);
                }
                Err(Error::ExternalCommandRunFailed {
                    binary,
                    exit_status,
                }) => {
                    if let Some(1) = exit_status.code() {
                        debug!("No uploaders found for {:?}", vm.public_ip_addr);
                        uploader_count.insert(vm.clone(), 0);
                    } else {
                        debug!("Error while fetching uploader count with different exit code {exit_status:?}",);
                        return Err(Error::ExternalCommandRunFailed {
                            binary,
                            exit_status,
                        });
                    }
                }
                Err(err) => {
                    debug!("Error while fetching uploader count: {err:?}",);
                    return Err(err);
                }
            }
        }

        Ok(uploader_count)
    }

    fn get_uploader_secret_key_per_vm(
        &self,
        vm: &VirtualMachine,
        instance_count: usize,
    ) -> Result<Vec<PrivateKeySigner>> {
        let mut sks_per_vm = Vec::new();

        debug!(
            "Fetching uploader secret key for {} @ {}",
            vm.name, vm.public_ip_addr
        );
        // Note: if this is gonna be parallelized, we need to make sure the secret keys are in order.
        // the playbook expects them in order
        for count in 1..=instance_count {
            let cmd = format!(
                "systemctl show ant_uploader_{count}.service --property=Environment | grep SECRET_KEY | cut -d= -f3 | awk '{{print $1}}'"
            );
            debug!("Fetching secret key for {} instance {count}", vm.name);
            let result = self
                .ssh_client
                .run_command(&vm.public_ip_addr, "root", &cmd, true);
            match result {
                Ok(secret_keys) => {
                    let sk_str = secret_keys
                        .iter()
                        .map(|sk| sk.trim().to_string())
                        .collect::<Vec<String>>();
                    let sk_str = sk_str.first().ok_or({
                        debug!("No secret key found for {}", vm.name);
                        Error::SecretKeyNotFound
                    })?;
                    let sk = sk_str.parse().map_err(|_| Error::FailedToParseKey)?;

                    debug!("Secret keys found for {} instance {count}: {sk:?}", vm.name,);

                    sks_per_vm.push(sk);
                }
                Err(err) => {
                    debug!("Error while fetching secret key: {err}");
                    return Err(err);
                }
            }
        }

        Ok(sks_per_vm)
    }

    async fn deposit_funds(
        &self,
        funding_wallet_sk: Option<PrivateKeySigner>,
        all_secret_keys: &HashMap<VirtualMachine, Vec<PrivateKeySigner>>,
        options: &FundingOptions,
    ) -> Result<()> {
        if all_secret_keys.is_empty() {
            error!("No uploader secret keys found");
            return Err(Error::SecretKeyNotFound);
        }

        let _sk_count = all_secret_keys.values().map(|v| v.len()).sum::<usize>();

        let from_wallet = match &options.evm_network {
            EvmNetwork::Anvil | EvmNetwork::Custom => {
                let network = if let (
                    Some(evm_data_payments_address),
                    Some(evm_payment_token_address),
                    Some(evm_rpc_url),
                ) = (
                    options.evm_data_payments_address.as_ref(),
                    options.evm_payment_token_address.as_ref(),
                    options.evm_rpc_url.as_ref(),
                ) {
                    Network::new_custom(
                        evm_rpc_url,
                        evm_payment_token_address,
                        evm_data_payments_address,
                    )
                } else {
                    error!("Custom evm network data not provided");
                    return Err(Error::EvmTestnetDataNotFound);
                };

                let Some(deployer_wallet_sk) = &options.funding_wallet_secret_key else {
                    error!("Deployer wallet secret key not provided");
                    return Err(Error::SecretKeyNotFound);
                };
                let deployer_wallet_sk: PrivateKeySigner = deployer_wallet_sk
                    .parse()
                    .map_err(|_| Error::FailedToParseKey)?;

                Wallet::new(network.clone(), EthereumWallet::new(deployer_wallet_sk))
            }
            EvmNetwork::ArbitrumOne => {
                let funding_wallet_sk = funding_wallet_sk.ok_or_else(|| {
                    error!("Funding wallet secret key not provided");
                    Error::SecretKeyNotFound
                })?;
                let network = Network::ArbitrumOne;
                Wallet::new(network.clone(), EthereumWallet::new(funding_wallet_sk))
            }
            EvmNetwork::ArbitrumSepolia => {
                let funding_wallet_sk = funding_wallet_sk.ok_or_else(|| {
                    error!("Funding wallet secret key not provided");
                    Error::SecretKeyNotFound
                })?;
                let network = Network::ArbitrumSepolia;
                Wallet::new(network.clone(), EthereumWallet::new(funding_wallet_sk))
            }
        };
        debug!("Using emv network: {:?}", options.evm_network);

        let token_balance = from_wallet.balance_of_tokens().await?;
        let gas_balance = from_wallet.balance_of_gas_tokens().await?;
        println!("Funding wallet token balance: {token_balance}");
        println!("Funding wallet gas balance: {gas_balance}");
        debug!("Funding wallet token balance: {token_balance:?} and gas balance {gas_balance}");

        let default_token_amount = U256::from_str(DEFAULT_TOKEN_AMOUNT).unwrap();
        let default_gas_amount = U256::from_str(DEFAULT_GAS_AMOUNT).unwrap();

        let token_amount = options.token_amount.unwrap_or(default_token_amount);
        let gas_amount = options.gas_amount.unwrap_or(default_gas_amount);

        println!("Transferring {token_amount} tokens and {gas_amount} gas tokens to each uploader");
        debug!("Transferring {token_amount} tokens and {gas_amount} gas tokens to each uploader");

        for (vm, vm_secret_keys) in all_secret_keys.iter() {
            println!("Transferring funds for uploader vm: {}", vm.name);
            for sk in vm_secret_keys.iter() {
                sk.address();

                if !token_amount.is_zero() {
                    print!("Transferring {token_amount} tokens to {}...", sk.address());
                    from_wallet
                        .transfer_tokens(sk.address(), token_amount)
                        .await
                        .inspect_err(|err| {
                            debug!(
                                "Failed to transfer {token_amount} tokens to {}: {err:?}",
                                sk.address()
                            )
                        })?;
                    println!("Transfer complete");
                }
                if !gas_amount.is_zero() {
                    print!("Transferring {gas_amount} gas to {}...", sk.address());
                    from_wallet
                        .transfer_gas_tokens(sk.address(), gas_amount)
                        .await
                        .inspect_err(|err| {
                            debug!(
                                "Failed to transfer {gas_amount} gas to {}: {err:?}",
                                sk.address()
                            )
                        })?;
                    println!("Transfer complete");
                }
            }
        }
        println!("All funds transferred successfully");
        debug!("All funds transferred successfully");

        Ok(())
    }
}

/// Get the Address of the funding wallet from the secret key string
pub fn get_address_from_sk(secret_key: &str) -> Result<Address> {
    let sk: PrivateKeySigner = secret_key.parse().map_err(|_| Error::FailedToParseKey)?;
    Ok(sk.address())
}