sn-testnet-deploy 0.7.0

Tool for creating Autonomi networks
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
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
// 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::{
    ansible::provisioning::{PrivateNodeProvisionInventory, ProvisionOptions},
    error::{Error, Result},
    funding::get_address_from_sk,
    get_anvil_node_data_hardcoded, get_bootstrap_cache_url, get_genesis_multiaddr,
    write_environment_details, BinaryOption, DeploymentInventory, DeploymentType,
    EnvironmentDetails, EnvironmentType, EvmDetails, EvmNetwork, InfraRunOptions, LogFormat,
    NodeType, TestnetDeployer,
};
use alloy::{hex::ToHexExt, primitives::U256};
use colored::Colorize;
use log::error;
use serde::{Deserialize, Serialize};
use std::{path::PathBuf, time::Duration};

#[derive(Clone, Serialize, Deserialize)]
pub struct DeployOptions {
    pub binary_option: BinaryOption,
    pub chunk_size: Option<u64>,
    pub chunk_tracker_data_addresses: Vec<String>,
    pub chunk_tracker_services: u16,
    pub client_env_variables: Option<Vec<(String, String)>>,
    pub client_vm_count: Option<u16>,
    pub client_vm_size: Option<String>,
    pub current_inventory: DeploymentInventory,
    pub enable_logging: bool,
    pub enable_metrics: bool,
    pub environment_type: EnvironmentType,
    pub evm_data_payments_address: Option<String>,
    pub evm_merkle_payments_address: Option<String>,
    pub evm_network: EvmNetwork,
    pub evm_node_vm_size: Option<String>,
    pub evm_payment_token_address: Option<String>,
    pub evm_rpc_url: Option<String>,
    pub full_cone_vm_size: Option<String>,
    pub full_cone_private_node_count: u16,
    pub full_cone_private_node_vm_count: Option<u16>,
    pub full_cone_private_node_volume_size: Option<u16>,
    pub funding_wallet_secret_key: Option<String>,
    pub genesis_node_volume_size: Option<u16>,
    pub initial_gas: Option<U256>,
    pub initial_tokens: Option<U256>,
    pub interval: Duration,
    pub log_format: Option<LogFormat>,
    pub max_archived_log_files: u16,
    pub max_log_files: u16,
    pub max_uploads: Option<u32>,
    pub regular: bool,
    pub name: String,
    pub network_id: u8,
    pub network_dashboard_branch: Option<String>,
    pub node_count: u16,
    pub node_env_variables: Option<Vec<(String, String)>>,
    pub node_vm_count: Option<u16>,
    pub node_vm_size: Option<String>,
    pub node_volume_size: Option<u16>,
    pub output_inventory_dir_path: PathBuf,
    pub peer_cache_node_count: u16,
    pub peer_cache_node_vm_count: Option<u16>,
    pub peer_cache_node_vm_size: Option<String>,
    pub peer_cache_node_volume_size: Option<u16>,
    pub port_restricted_cone_vm_size: Option<String>,
    pub port_restricted_cone_private_node_count: u16,
    pub port_restricted_cone_private_node_vm_count: u16,
    pub port_restricted_cone_private_node_volume_size: Option<u16>,
    pub single_node_payment: bool,
    pub start_chunk_trackers: bool,
    pub start_delayed_verifier: bool,
    pub start_performance_verifier: bool,
    pub start_random_verifier: bool,
    pub symmetric_nat_gateway_vm_size: Option<String>,
    pub symmetric_private_node_count: u16,
    pub symmetric_private_node_vm_count: Option<u16>,
    pub symmetric_private_node_volume_size: Option<u16>,
    pub public_rpc: bool,
    pub region: String,
    pub rewards_address: String,
    pub uploaders_count: u16,
    pub upload_interval: u16,
    pub upload_size: u16,
    pub upnp_vm_size: Option<String>,
    pub upnp_private_node_count: u16,
    pub upnp_private_node_vm_count: Option<u16>,
    pub upnp_private_node_volume_size: Option<u16>,
}

impl TestnetDeployer {
    pub async fn deploy_to_genesis(
        &self,
        options: &DeployOptions,
    ) -> Result<(ProvisionOptions, (String, String))> {
        let build_custom_binaries = options.binary_option.should_provision_build_machine();

        self.create_or_update_infra(&InfraRunOptions {
            client_image_id: None,
            client_vm_count: options.client_vm_count,
            client_vm_size: options.client_vm_size.clone(),
            enable_build_vm: build_custom_binaries,
            evm_node_count: match options.evm_network {
                EvmNetwork::Anvil => Some(1),
                EvmNetwork::ArbitrumOne => Some(0),
                EvmNetwork::ArbitrumSepoliaTest => Some(0),
                EvmNetwork::Custom => Some(0),
            },
            evm_node_vm_size: options.evm_node_vm_size.clone(),
            evm_node_image_id: None,
            full_cone_vm_size: options.full_cone_vm_size.clone(),
            full_cone_private_node_vm_count: options.full_cone_private_node_vm_count,
            full_cone_private_node_volume_size: options.full_cone_private_node_volume_size,
            genesis_vm_count: Some(1),
            genesis_node_volume_size: options.genesis_node_volume_size,
            name: options.name.clone(),
            nat_gateway_image_id: None,
            node_image_id: None,
            node_vm_count: options.node_vm_count,
            node_vm_size: options.node_vm_size.clone(),
            node_volume_size: options.node_volume_size,
            peer_cache_image_id: None,
            peer_cache_node_vm_count: options.peer_cache_node_vm_count,
            peer_cache_node_vm_size: options.peer_cache_node_vm_size.clone(),
            peer_cache_node_volume_size: options.peer_cache_node_volume_size,
            port_restricted_cone_vm_size: options.port_restricted_cone_vm_size.clone(),
            port_restricted_private_node_vm_count: Some(
                options.port_restricted_cone_private_node_vm_count,
            ),
            port_restricted_private_node_volume_size: options
                .port_restricted_cone_private_node_volume_size,
            region: options.region.clone(),
            symmetric_nat_gateway_vm_size: options.symmetric_nat_gateway_vm_size.clone(),
            symmetric_private_node_vm_count: options.symmetric_private_node_vm_count,
            symmetric_private_node_volume_size: options.symmetric_private_node_volume_size,
            tfvars_filenames: Some(options.environment_type.get_tfvars_filenames_with_fallback(
                &options.name,
                &options.region,
                &self.terraform_runner.working_directory_path,
            )),
            upnp_vm_size: options.upnp_vm_size.clone(),
            upnp_private_node_vm_count: options.upnp_private_node_vm_count,
            upnp_private_node_volume_size: options.upnp_private_node_volume_size,
        })
        .map_err(|err| {
            println!("Failed to create infra {err:?}");
            err
        })?;

        write_environment_details(
            &self.s3_repository,
            &options.name,
            &EnvironmentDetails {
                deployment_type: DeploymentType::New,
                environment_type: options.environment_type.clone(),
                evm_details: EvmDetails {
                    network: options.evm_network.clone(),
                    data_payments_address: options.evm_data_payments_address.clone(),
                    merkle_payments_address: options.evm_merkle_payments_address.clone(),
                    payment_token_address: options.evm_payment_token_address.clone(),
                    rpc_url: options.evm_rpc_url.clone(),
                },
                funding_wallet_address: None,
                network_id: Some(options.network_id),
                region: options.region.clone(),
                rewards_address: Some(options.rewards_address.clone()),
            },
        )
        .await?;

        let mut provision_options = ProvisionOptions::from(options.clone());
        let anvil_node_data = if options.evm_network == EvmNetwork::Anvil {
            self.ansible_provisioner
                .print_ansible_run_banner("Provision Anvil Node");
            self.ansible_provisioner
                .provision_evm_nodes(&provision_options)
                .map_err(|err| {
                    println!("Failed to provision evm node {err:?}");
                    err
                })?;

            Some(
                get_anvil_node_data_hardcoded(&self.ansible_provisioner.ansible_runner).map_err(
                    |err| {
                        println!("Failed to get evm testnet data {err:?}");
                        err
                    },
                )?,
            )
        } else {
            None
        };

        let funding_wallet_address = if let Some(secret_key) = &options.funding_wallet_secret_key {
            let address = get_address_from_sk(secret_key)?;
            Some(address.encode_hex())
        } else if let Some(emv_data) = &anvil_node_data {
            let address = get_address_from_sk(&emv_data.deployer_wallet_private_key)?;
            Some(address.encode_hex())
        } else {
            error!("Funding wallet address not provided");
            None
        };

        if let Some(custom_evm) = anvil_node_data {
            provision_options.evm_data_payments_address =
                Some(custom_evm.data_payments_address.clone());
            provision_options.evm_merkle_payments_address =
                Some(custom_evm.merkle_payments_address.clone());
            provision_options.evm_payment_token_address =
                Some(custom_evm.payment_token_address.clone());
            provision_options.evm_rpc_url = Some(custom_evm.rpc_url.clone());
            provision_options.funding_wallet_secret_key =
                Some(custom_evm.deployer_wallet_private_key.clone());
        };

        write_environment_details(
            &self.s3_repository,
            &options.name,
            &EnvironmentDetails {
                deployment_type: DeploymentType::New,
                environment_type: options.environment_type.clone(),
                evm_details: EvmDetails {
                    network: options.evm_network.clone(),
                    data_payments_address: provision_options.evm_data_payments_address.clone(),
                    merkle_payments_address: provision_options.evm_merkle_payments_address.clone(),
                    payment_token_address: provision_options.evm_payment_token_address.clone(),
                    rpc_url: provision_options.evm_rpc_url.clone(),
                },
                funding_wallet_address,
                network_id: Some(options.network_id),
                region: options.region.clone(),
                rewards_address: Some(options.rewards_address.clone()),
            },
        )
        .await?;

        if build_custom_binaries {
            self.ansible_provisioner
                .print_ansible_run_banner("Build Custom Binaries");
            self.ansible_provisioner
                .build_autonomi_binaries(&provision_options, None)
                .map_err(|err| {
                    println!("Failed to build safe network binaries {err:?}");
                    err
                })?;
        }

        self.ansible_provisioner
            .print_ansible_run_banner("Provision Genesis Node");
        self.ansible_provisioner
            .provision_genesis_node(&provision_options)
            .map_err(|err| {
                println!("Failed to provision genesis node {err:?}");
                err
            })?;

        let (genesis_multiaddr, genesis_ip) =
            get_genesis_multiaddr(&self.ansible_provisioner.ansible_runner, &self.ssh_client)?
                .ok_or_else(|| Error::GenesisListenAddress)?;
        Ok((
            provision_options,
            (genesis_multiaddr, get_bootstrap_cache_url(&genesis_ip)),
        ))
    }

    pub async fn deploy(&self, options: &DeployOptions) -> Result<()> {
        let (mut provision_options, (genesis_multiaddr, genesis_network_contacts)) =
            self.deploy_to_genesis(options).await?;

        println!("Obtained multiaddr for genesis node: {genesis_multiaddr}, network contact: {genesis_network_contacts}");

        let mut node_provision_failed = false;
        self.ansible_provisioner
            .print_ansible_run_banner("Provision Peer Cache Nodes");
        match self.ansible_provisioner.provision_nodes(
            &provision_options,
            Some(genesis_multiaddr.clone()),
            Some(genesis_network_contacts.clone()),
            NodeType::PeerCache,
        ) {
            Ok(()) => {
                println!("Provisioned Peer Cache nodes");
            }
            Err(err) => {
                error!("Failed to provision Peer Cache nodes: {err}");
                node_provision_failed = true;
            }
        }

        self.ansible_provisioner
            .print_ansible_run_banner("Provision Public Nodes");
        match self.ansible_provisioner.provision_nodes(
            &provision_options,
            Some(genesis_multiaddr.clone()),
            Some(genesis_network_contacts.clone()),
            NodeType::Generic,
        ) {
            Ok(()) => {
                println!("Provisioned public nodes");
            }
            Err(err) => {
                error!("Failed to provision public nodes: {err}");
                node_provision_failed = true;
            }
        }

        self.ansible_provisioner
            .print_ansible_run_banner("Provision UPnP Nodes");
        match self.ansible_provisioner.provision_nodes(
            &provision_options,
            Some(genesis_multiaddr.clone()),
            Some(genesis_network_contacts.clone()),
            NodeType::Upnp,
        ) {
            Ok(()) => {
                println!("Provisioned UPnP nodes");
            }
            Err(err) => {
                error!("Failed to provision UPnP nodes: {err}");
                node_provision_failed = true;
            }
        }

        let private_node_inventory = PrivateNodeProvisionInventory::new(
            &self.ansible_provisioner,
            options.full_cone_private_node_vm_count,
            options.symmetric_private_node_vm_count,
            Some(options.port_restricted_cone_private_node_vm_count),
        )?;

        if private_node_inventory.should_provision_full_cone_private_nodes() {
            match self.ansible_provisioner.provision_full_cone(
                &provision_options,
                Some(genesis_multiaddr.clone()),
                Some(genesis_network_contacts.clone()),
                private_node_inventory.clone(),
                None,
            ) {
                Ok(()) => {
                    println!("Provisioned Full Cone nodes and Gateway");
                }
                Err(err) => {
                    error!("Failed to provision Full Cone nodes and Gateway: {err}");
                    node_provision_failed = true;
                }
            }
        }

        if private_node_inventory.should_provision_port_restricted_cone_private_nodes() {
            match self.ansible_provisioner.provision_port_restricted_cone(
                &provision_options,
                Some(genesis_multiaddr.clone()),
                Some(genesis_network_contacts.clone()),
                private_node_inventory.clone(),
                None,
            ) {
                Ok(()) => {
                    println!("Provisioned Port Restricted Cone nodes and Gateway");
                }
                Err(err) => {
                    error!("Failed to provision Port Restricted Cone nodes and Gateway: {err}");
                    node_provision_failed = true;
                }
            }
        }

        if private_node_inventory.should_provision_symmetric_private_nodes() {
            self.ansible_provisioner
                .print_ansible_run_banner("Provision Symmetric NAT Gateway");
            self.ansible_provisioner
                .provision_symmetric_nat_gateway(&provision_options, &private_node_inventory)
                .map_err(|err| {
                    println!("Failed to provision Symmetric NAT gateway {err:?}");
                    err
                })?;

            self.ansible_provisioner
                .print_ansible_run_banner("Provision Symmetric Private Nodes");
            match self.ansible_provisioner.provision_symmetric_private_nodes(
                &mut provision_options,
                Some(genesis_multiaddr.clone()),
                Some(genesis_network_contacts.clone()),
                &private_node_inventory,
            ) {
                Ok(()) => {
                    println!("Provisioned Symmetric private nodes");
                }
                Err(err) => {
                    error!("Failed to provision Symmetric Private nodes: {err}");
                    node_provision_failed = true;
                }
            }
        }

        self.ansible_provisioner
            .print_ansible_run_banner("Provision Uploaders");
        self.ansible_provisioner
            .provision_uploaders(
                &provision_options,
                Some(genesis_multiaddr.clone()),
                Some(genesis_network_contacts.clone()),
            )
            .await
            .map_err(|err| {
                println!("Failed to provision Clients {err:?}");
                err
            })?;
        self.ansible_provisioner
            .print_ansible_run_banner("Provision Downloaders");
        self.ansible_provisioner
            .provision_downloaders(
                &provision_options,
                Some(genesis_multiaddr.clone()),
                Some(genesis_network_contacts.clone()),
            )
            .await
            .map_err(|err| {
                println!("Failed to provision downloaders {err:?}");
                err
            })?;
        self.ansible_provisioner
            .print_ansible_run_banner("Provision Chunk Trackers");
        self.ansible_provisioner
            .provision_chunk_trackers(
                &provision_options,
                Some(genesis_multiaddr.clone()),
                Some(genesis_network_contacts.clone()),
            )
            .await
            .map_err(|err| {
                println!("Failed to provision chunk trackers {err:?}");
                err
            })?;

        if node_provision_failed {
            println!();
            println!("{}", "WARNING!".yellow());
            println!("Some nodes failed to provision without error.");
            println!("This usually means a small number of nodes failed to start on a few VMs.");
            println!("However, most of the time the deployment will still be usable.");
            println!("See the output from Ansible to determine which VMs had failures.");
        }

        Ok(())
    }
}