tycho-core 0.3.7

Basic functionality of peer.
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

use std::net::{IpAddr, Ipv4Addr};
use std::path::Path;

use serde::{Deserialize, Serialize};
use tycho_network::{DhtConfig, NetworkConfig, OverlayConfig, PeerResolverConfig};
use tycho_storage::StorageConfig;
use tycho_util::config::PartialConfig;

use crate::block_strider::{
    ArchiveBlockProviderConfig, BlockchainBlockProviderConfig, StarterConfig,
};
use crate::blockchain_rpc::{BlockchainRpcClientConfig, BlockchainRpcServiceConfig};
use crate::overlay_client::PublicOverlayClientConfig;
#[cfg(feature = "s3")]
use crate::s3::S3ClientConfig;
use crate::storage::CoreStorageConfig;

#[derive(Debug, Clone, Serialize, Deserialize, PartialConfig)]
#[serde(default)]
pub struct NodeBaseConfig {
    /// Public IP address of the node.
    ///
    /// Default: resolved automatically.
    #[important]
    pub public_ip: Option<IpAddr>,

    /// Ip address to listen on.
    ///
    /// Default: 0.0.0.0
    #[important]
    pub local_ip: IpAddr,

    /// Default: 30000.
    #[important]
    pub port: u16,

    pub network: NetworkConfig,

    pub dht: DhtConfig,

    pub peer_resolver: PeerResolverConfig,

    pub overlay: OverlayConfig,

    pub public_overlay_client: PublicOverlayClientConfig,

    #[partial]
    pub storage: StorageConfig,

    #[partial]
    pub core_storage: CoreStorageConfig,

    #[partial]
    pub starter: StarterConfig,

    pub blockchain_rpc_client: BlockchainRpcClientConfig,

    pub blockchain_rpc_service: BlockchainRpcServiceConfig,

    pub archive_block_provider: ArchiveBlockProviderConfig,

    pub blockchain_block_provider: BlockchainBlockProviderConfig,

    #[cfg(feature = "s3")]
    pub s3_client: Option<S3ClientConfig>,
}

impl Default for NodeBaseConfig {
    fn default() -> Self {
        Self {
            public_ip: None,
            local_ip: IpAddr::V4(Ipv4Addr::UNSPECIFIED),
            port: 30000,
            network: NetworkConfig::default(),
            dht: DhtConfig::default(),
            peer_resolver: PeerResolverConfig::default(),
            overlay: OverlayConfig::default(),
            public_overlay_client: PublicOverlayClientConfig::default(),
            storage: StorageConfig::default(),
            core_storage: CoreStorageConfig::default(),
            starter: StarterConfig::default(),
            blockchain_rpc_client: BlockchainRpcClientConfig::default(),
            blockchain_rpc_service: BlockchainRpcServiceConfig::default(),
            blockchain_block_provider: BlockchainBlockProviderConfig::default(),
            archive_block_provider: ArchiveBlockProviderConfig::default(),

            #[cfg(feature = "s3")]
            s3_client: None,
        }
    }
}

impl NodeBaseConfig {
    #[cfg(feature = "cli")]
    pub async fn resolve_public_ip(&self) -> anyhow::Result<std::net::SocketAddr> {
        let public_ip = tycho_util::cli::resolve_public_ip(self.public_ip).await?;
        Ok(std::net::SocketAddr::new(public_ip, self.port))
    }

    pub fn with_relative_paths<P: AsRef<Path>>(mut self, base_dir: P) -> Self {
        let base_dir = base_dir.as_ref();
        self.storage.root_dir = base_dir.join(self.storage.root_dir);
        self
    }
}