snarkos 2.0.2

A decentralized operating system
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

// Copyright (C) 2019-2022 Aleo Systems Inc.
// This file is part of the snarkOS library.

// The snarkOS library is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// The snarkOS library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with the snarkOS library. If not, see <https://www.gnu.org/licenses/>.

use crate::helpers::{NodeType, Status, Tasks};
use snarkvm::dpc::Network;

use once_cell::sync::OnceCell;
use rayon::{ThreadPool, ThreadPoolBuilder};
use std::{
    collections::HashSet,
    fmt::Debug,
    marker::PhantomData,
    net::SocketAddr,
    sync::{atomic::AtomicBool, Arc},
};

#[rustfmt::skip]
pub trait Environment: 'static + Clone + Debug + Default + Send + Sync {
    type Network: Network;
    /// The specified type of node.
    const NODE_TYPE: NodeType;
    /// The version of the network protocol; it can be incremented in order to force users to update.
    const MESSAGE_VERSION: u32 = 12;
    /// If `true`, a mining node will craft public coinbase transactions.
    const COINBASE_IS_PUBLIC: bool = false;

    /// The port for communicating with the node server.
    const DEFAULT_NODE_PORT: u16 = 4130 + Self::Network::NETWORK_ID;
    /// The port for communicating with the RPC server.
    const DEFAULT_RPC_PORT: u16 = 3030 + Self::Network::NETWORK_ID;

    /// The list of beacon nodes to bootstrap the node server with.
    const BEACON_NODES: &'static [&'static str] = &[];
    /// The list of sync nodes to bootstrap the node server with.
    const SYNC_NODES: &'static [&'static str] = &["127.0.0.1:4135"];

    /// The duration in seconds to sleep in between heartbeat executions.
    const HEARTBEAT_IN_SECS: u64 = 9;
    /// The maximum duration in seconds permitted for establishing a connection with a node,
    /// before dropping the connection; it should be no greater than the `HEARTBEAT_IN_SECS`.
    const CONNECTION_TIMEOUT_IN_MILLIS: u64 = 500;
    /// The duration in seconds to sleep in between ping requests with a connected peer.
    const PING_SLEEP_IN_SECS: u64 = 60;
    /// The duration in seconds after which a connected peer is considered inactive or
    /// disconnected if no message has been received in the meantime.
    const RADIO_SILENCE_IN_SECS: u64 = 210; // 3.5 minutes
    /// The duration in seconds after which to expire a failure from a peer.
    const FAILURE_EXPIRY_TIME_IN_SECS: u64 = 7200; // 2 hours

    /// The minimum number of peers required to maintain connections with.
    const MINIMUM_NUMBER_OF_PEERS: usize;
    /// The maximum number of peers permitted to maintain connections with.
    const MAXIMUM_NUMBER_OF_PEERS: usize;
    /// The maximum number of connection failures permitted by an inbound connecting peer.
    const MAXIMUM_CONNECTION_FAILURES: u32 = 3;
    /// The maximum number of candidate peers permitted to be stored in the node.
    const MAXIMUM_CANDIDATE_PEERS: usize = 10_000;

    /// The maximum size of a message that can be transmitted in the network.
    const MAXIMUM_MESSAGE_SIZE: usize = 128 * 1024 * 1024; // 128 MiB
    /// The maximum number of blocks that may be fetched in one request.
    const MAXIMUM_BLOCK_REQUEST: u32 = 250;
    /// The maximum number of failures tolerated before disconnecting from a peer.
    const MAXIMUM_NUMBER_OF_FAILURES: usize = 1024;

    /// Returns the list of beacon nodes to bootstrap the node server with.
    fn beacon_nodes() -> &'static HashSet<SocketAddr> {
        static NODES: OnceCell<HashSet<SocketAddr>> = OnceCell::new();
        NODES.get_or_init(|| Self::BEACON_NODES.iter().map(|ip| ip.parse().unwrap()).collect())
    }

    /// Returns the list of sync nodes to bootstrap the node server with.
    fn sync_nodes() -> &'static HashSet<SocketAddr> {
        static NODES: OnceCell<HashSet<SocketAddr>> = OnceCell::new();
        NODES.get_or_init(|| Self::SYNC_NODES.iter().map(|ip| ip.parse().unwrap()).collect())
    }
    
    /// Returns the tasks handler for the node.
    fn tasks() -> &'static Tasks<tokio::task::JoinHandle<()>> {
        static TASKS: OnceCell<Tasks<tokio::task::JoinHandle<()>>> = OnceCell::new();
        TASKS.get_or_init(Tasks::new)
    }
    
    /// Returns the status of the node.
    fn status() -> &'static Status {
        static STATUS: OnceCell<Status> = OnceCell::new();
        STATUS.get_or_init(Status::new)
    }
    
    /// Returns the terminator bit for the prover.
    fn terminator() -> &'static Arc<AtomicBool> {
        static TERMINATOR: OnceCell<Arc<AtomicBool>> = OnceCell::new();
        TERMINATOR.get_or_init(|| Arc::new(AtomicBool::new(false)))
    }

    /// Returns a thread pool for the node to perform intensive operations.
    fn thread_pool() -> &'static Arc<ThreadPool> {
        static POOL: OnceCell<Arc<ThreadPool>> = OnceCell::new();
        POOL.get_or_init(|| {
            Arc::new(ThreadPoolBuilder::new()
                .stack_size(8 * 1024 * 1024)
                .num_threads((num_cpus::get() * 7 / 8).max(2))
                .build()
                .expect("Failed to initialize a thread pool for the node"))
        })
    }
}

#[derive(Clone, Debug, Default)]
pub struct Client<N: Network>(PhantomData<N>);

#[rustfmt::skip]
impl<N: Network> Environment for Client<N> {
    type Network = N;
    const NODE_TYPE: NodeType = NodeType::Client;
    const MINIMUM_NUMBER_OF_PEERS: usize = 2;
    const MAXIMUM_NUMBER_OF_PEERS: usize = 21;
}

#[derive(Clone, Debug, Default)]
pub struct Miner<N: Network>(PhantomData<N>);

#[rustfmt::skip]
impl<N: Network> Environment for Miner<N> {
    type Network = N;
    const NODE_TYPE: NodeType = NodeType::Miner;
    const COINBASE_IS_PUBLIC: bool = true;
    const MINIMUM_NUMBER_OF_PEERS: usize = 1;
    const MAXIMUM_NUMBER_OF_PEERS: usize = 21;
}

#[derive(Clone, Debug, Default)]
pub struct Operator<N: Network>(PhantomData<N>);

#[rustfmt::skip]
impl<N: Network> Environment for Operator<N> {
    type Network = N;
    const NODE_TYPE: NodeType = NodeType::Operator;
    const COINBASE_IS_PUBLIC: bool = true;
    const MINIMUM_NUMBER_OF_PEERS: usize = 1;
    const MAXIMUM_NUMBER_OF_PEERS: usize = 1000;
}

#[derive(Clone, Debug, Default)]
pub struct Prover<N: Network>(PhantomData<N>);

#[rustfmt::skip]
impl<N: Network> Environment for Prover<N> {
    type Network = N;
    const NODE_TYPE: NodeType = NodeType::Prover;
    const COINBASE_IS_PUBLIC: bool = true;
    const MINIMUM_NUMBER_OF_PEERS: usize = 2;
    const MAXIMUM_NUMBER_OF_PEERS: usize = 21;
}

#[derive(Clone, Debug, Default)]
pub struct SyncNode<N: Network>(PhantomData<N>);

#[rustfmt::skip]
impl<N: Network> Environment for SyncNode<N> {
    type Network = N;
    const NODE_TYPE: NodeType = NodeType::Sync;
    const MINIMUM_NUMBER_OF_PEERS: usize = 35;
    const MAXIMUM_NUMBER_OF_PEERS: usize = 1024;
    const HEARTBEAT_IN_SECS: u64 = 5;
}

#[derive(Clone, Debug, Default)]
pub struct ClientTrial<N: Network>(PhantomData<N>);

#[rustfmt::skip]
impl<N: Network> Environment for ClientTrial<N> {
    type Network = N;
    const NODE_TYPE: NodeType = NodeType::Client;
    const SYNC_NODES: &'static [&'static str] = &[
        "144.126.219.193:4132", "165.232.145.194:4132", "143.198.164.241:4132", "188.166.7.13:4132", "167.99.40.226:4132",
        "159.223.124.150:4132", "137.184.192.155:4132", "147.182.213.228:4132", "137.184.202.162:4132", "159.223.118.35:4132",
        "161.35.106.91:4132", "157.245.133.62:4132", "143.198.166.150:4132",
    ];
    const MINIMUM_NUMBER_OF_PEERS: usize = 11;
    const MAXIMUM_NUMBER_OF_PEERS: usize = 31;
}

#[derive(Clone, Debug, Default)]
pub struct MinerTrial<N: Network>(PhantomData<N>);

#[rustfmt::skip]
impl<N: Network> Environment for MinerTrial<N> {
    type Network = N;
    const NODE_TYPE: NodeType = NodeType::Miner;
    const SYNC_NODES: &'static [&'static str] = &[
        "144.126.219.193:4132", "165.232.145.194:4132", "143.198.164.241:4132", "188.166.7.13:4132", "167.99.40.226:4132",
        "159.223.124.150:4132", "137.184.192.155:4132", "147.182.213.228:4132", "137.184.202.162:4132", "159.223.118.35:4132",
        "161.35.106.91:4132", "157.245.133.62:4132", "143.198.166.150:4132",
    ];
    const MINIMUM_NUMBER_OF_PEERS: usize = 11;
    const MAXIMUM_NUMBER_OF_PEERS: usize = 21;
    const COINBASE_IS_PUBLIC: bool = true;
}

#[derive(Clone, Debug, Default)]
pub struct OperatorTrial<N: Network>(PhantomData<N>);

#[rustfmt::skip]
impl<N: Network> Environment for OperatorTrial<N> {
    type Network = N;
    const NODE_TYPE: NodeType = NodeType::Operator;
    const SYNC_NODES: &'static [&'static str] = &[
        "144.126.219.193:4132", "165.232.145.194:4132", "143.198.164.241:4132", "188.166.7.13:4132", "167.99.40.226:4132",
        "159.223.124.150:4132", "137.184.192.155:4132", "147.182.213.228:4132", "137.184.202.162:4132", "159.223.118.35:4132",
        "161.35.106.91:4132", "157.245.133.62:4132", "143.198.166.150:4132",
    ];
    const MINIMUM_NUMBER_OF_PEERS: usize = 11;
    const MAXIMUM_NUMBER_OF_PEERS: usize = 1000;
    const COINBASE_IS_PUBLIC: bool = true;
}

#[derive(Clone, Debug, Default)]
pub struct ProverTrial<N: Network>(PhantomData<N>);

#[rustfmt::skip]
impl<N: Network> Environment for ProverTrial<N> {
    type Network = N;
    const NODE_TYPE: NodeType = NodeType::Prover;
    const SYNC_NODES: &'static [&'static str] = &[
        "144.126.219.193:4132", "165.232.145.194:4132", "143.198.164.241:4132", "188.166.7.13:4132", "167.99.40.226:4132",
        "159.223.124.150:4132", "137.184.192.155:4132", "147.182.213.228:4132", "137.184.202.162:4132", "159.223.118.35:4132",
        "161.35.106.91:4132", "157.245.133.62:4132", "143.198.166.150:4132",
    ];
    const MINIMUM_NUMBER_OF_PEERS: usize = 11;
    const MAXIMUM_NUMBER_OF_PEERS: usize = 21;
    const COINBASE_IS_PUBLIC: bool = true;
}