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
// 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, State},
Data,
Environment,
LedgerReader,
LedgerRequest,
LedgerRouter,
Message,
PeersRequest,
PeersRouter,
};
use snarkos_storage::{storage::Storage, ProverState};
use snarkvm::dpc::{posw::PoSWProof, prelude::*};
use anyhow::{anyhow, Result};
use rand::thread_rng;
use std::{
net::SocketAddr,
path::Path,
sync::{atomic::Ordering, Arc},
time::Duration,
};
use tokio::{
sync::{mpsc, oneshot, RwLock},
task,
};
/// Shorthand for the parent half of the `Prover` message channel.
pub(crate) type ProverRouter<N> = mpsc::Sender<ProverRequest<N>>;
#[allow(unused)]
/// Shorthand for the child half of the `Prover` message channel.
type ProverHandler<N> = mpsc::Receiver<ProverRequest<N>>;
/// The miner heartbeat in seconds.
const MINER_HEARTBEAT_IN_SECONDS: Duration = Duration::from_secs(2);
///
/// An enum of requests that the `Prover` struct processes.
///
#[derive(Debug)]
pub enum ProverRequest<N: Network> {
/// PoolRequest := (peer_ip, share_difficulty, block_template)
PoolRequest(SocketAddr, u64, BlockTemplate<N>),
/// MemoryPoolClear := (block)
MemoryPoolClear(Option<Block<N>>),
/// UnconfirmedTransaction := (peer_ip, transaction)
UnconfirmedTransaction(SocketAddr, Transaction<N>),
}
///
/// A prover for a specific network on the node server.
///
#[derive(Debug)]
pub struct Prover<N: Network, E: Environment> {
/// The state storage of the prover.
state: Arc<ProverState<N>>,
/// The Aleo address of the prover.
address: Option<Address<N>>,
/// The IP address of the connected pool.
pool: Option<SocketAddr>,
/// The prover router of the node.
prover_router: ProverRouter<N>,
/// The pool of unconfirmed transactions.
memory_pool: Arc<RwLock<MemoryPool<N>>>,
/// The peers router of the node.
peers_router: PeersRouter<N, E>,
/// The ledger state of the node.
ledger_reader: LedgerReader<N>,
/// The ledger router of the node.
ledger_router: LedgerRouter<N>,
}
impl<N: Network, E: Environment> Prover<N, E> {
/// Initializes a new instance of the prover.
pub async fn open<S: Storage, P: AsRef<Path> + Copy>(
path: P,
address: Option<Address<N>>,
local_ip: SocketAddr,
pool_ip: Option<SocketAddr>,
peers_router: PeersRouter<N, E>,
ledger_reader: LedgerReader<N>,
ledger_router: LedgerRouter<N>,
) -> Result<Arc<Self>> {
// Initialize an mpsc channel for sending requests to the `Prover` struct.
let (prover_router, mut prover_handler) = mpsc::channel(1024);
// Initialize the prover.
let prover = Arc::new(Self {
state: Arc::new(ProverState::open_writer::<S, P>(path)?),
address,
pool: pool_ip,
prover_router,
memory_pool: Arc::new(RwLock::new(MemoryPool::new())),
peers_router,
ledger_reader,
ledger_router,
});
// Initialize the handler for the prover.
{
let prover = prover.clone();
let (router, handler) = oneshot::channel();
E::tasks().append(task::spawn(async move {
// Notify the outer function that the task is ready.
let _ = router.send(());
// Asynchronously wait for a prover request.
while let Some(request) = prover_handler.recv().await {
// Hold the prover write lock briefly, to update the state of the prover.
prover.update(request).await;
}
}));
// Wait until the prover handler is ready.
let _ = handler.await;
}
// Initialize the miner, if the node type is a miner.
if E::NODE_TYPE == NodeType::Miner && prover.pool.is_none() {
Self::start_miner(prover.clone(), local_ip).await;
}
// Initialize the prover, if the node type is a prover.
if E::NODE_TYPE == NodeType::Prover && prover.pool.is_some() {
let prover = prover.clone();
let (router, handler) = oneshot::channel();
task::spawn(async move {
// Notify the outer function that the task is ready.
let _ = router.send(());
loop {
// Sleep for `1` second.
tokio::time::sleep(std::time::Duration::from_secs(1)).await;
// TODO (howardwu): Check that the prover is connected to the pool before proceeding.
// Currently we use a sleep function to probabilistically ensure the peer is connected.
if !E::terminator().load(Ordering::SeqCst) && !E::status().is_peering() && !E::status().is_mining() {
prover.send_pool_register().await;
}
}
});
// Wait until the operator handler is ready.
let _ = handler.await;
}
Ok(prover)
}
/// Returns an instance of the prover router.
pub fn router(&self) -> ProverRouter<N> {
self.prover_router.clone()
}
/// Returns an instance of the memory pool.
pub(crate) fn memory_pool(&self) -> Arc<RwLock<MemoryPool<N>>> {
self.memory_pool.clone()
}
/// Returns all coinbase records in storage.
pub fn to_coinbase_records(&self) -> Vec<(u32, Record<N>)> {
self.state.to_coinbase_records()
}
///
/// Performs the given `request` to the prover.
/// All requests must go through this `update`, so that a unified view is preserved.
///
pub(super) async fn update(&self, request: ProverRequest<N>) {
match request {
ProverRequest::PoolRequest(operator_ip, share_difficulty, block_template) => {
// Process the pool request message.
self.process_pool_request(operator_ip, share_difficulty, block_template).await;
}
ProverRequest::MemoryPoolClear(block) => match block {
Some(block) => self.memory_pool.write().await.remove_transactions(block.transactions()),
None => *self.memory_pool.write().await = MemoryPool::new(),
},
ProverRequest::UnconfirmedTransaction(peer_ip, transaction) => {
// Ensure the node is not peering.
if !E::status().is_peering() {
// Process the unconfirmed transaction.
self.add_unconfirmed_transaction(peer_ip, transaction).await
}
}
}
}
///
/// Sends a `PoolRegister` message to the pool IP address.
///
async fn send_pool_register(&self) {
if E::NODE_TYPE == NodeType::Prover {
if let Some(recipient) = self.address {
if let Some(pool_ip) = self.pool {
// Proceed to register the prover to receive a block template.
let request = PeersRequest::MessageSend(pool_ip, Message::PoolRegister(recipient));
if let Err(error) = self.peers_router.send(request).await {
warn!("[PoolRegister] {}", error);
}
} else {
error!("Missing pool IP address. Please specify a pool IP address in order to run the prover");
}
} else {
error!("Missing prover address. Please specify an Aleo address in order to prove");
}
}
}
///
/// Processes a `PoolRequest` message from a pool operator.
///
async fn process_pool_request(&self, operator_ip: SocketAddr, share_difficulty: u64, block_template: BlockTemplate<N>) {
if E::NODE_TYPE == NodeType::Prover {
if let Some(recipient) = self.address {
if let Some(pool_ip) = self.pool {
// Refuse work from any pool other than the registered one.
if pool_ip == operator_ip {
// If `terminator` is `false` and the status is not `Peering` or `Mining`
// already, mine the next block.
if !E::terminator().load(Ordering::SeqCst) && !E::status().is_peering() && !E::status().is_mining() {
// Set the status to `Mining`.
E::status().update(State::Mining);
let block_height = block_template.block_height();
let block_template = block_template.clone();
let result = task::spawn_blocking(move || {
E::thread_pool().install(move || {
loop {
let block_header =
BlockHeader::mine_once_unchecked(&block_template, E::terminator(), &mut thread_rng())?;
// Ensure the share difficulty target is met.
if N::posw().verify(
block_header.height(),
share_difficulty,
&[*block_header.to_header_root().unwrap(), *block_header.nonce()],
block_header.proof(),
) {
return Ok::<(N::PoSWNonce, PoSWProof<N>, u64), anyhow::Error>((
block_header.nonce(),
block_header.proof().clone(),
block_header.proof().to_proof_difficulty()?,
));
}
}
})
})
.await;
E::status().update(State::Ready);
match result {
Ok(Ok((nonce, proof, proof_difficulty))) => {
info!(
"Prover successfully mined a share for unconfirmed block {} with proof difficulty of {}",
block_height, proof_difficulty
);
// Send a `PoolResponse` to the operator.
let message = Message::PoolResponse(recipient, nonce, Data::Object(proof));
if let Err(error) = self.peers_router.send(PeersRequest::MessageSend(operator_ip, message)).await {
warn!("[PoolResponse] {}", error);
}
}
Ok(Err(error)) => trace!("{}", error),
Err(error) => trace!("{}", anyhow!("Failed to mine the next block {}", error)),
}
}
}
} else {
error!("Missing pool IP address. Please specify a pool IP address in order to run the prover");
}
} else {
error!("Missing prover address. Please specify an Aleo address in order to prove");
}
}
}
///
/// Adds the given unconfirmed transaction to the memory pool.
///
async fn add_unconfirmed_transaction(&self, peer_ip: SocketAddr, transaction: Transaction<N>) {
// Process the unconfirmed transaction.
trace!("Received unconfirmed transaction {} from {}", transaction.transaction_id(), peer_ip);
// Ensure the unconfirmed transaction is new.
if let Ok(false) = self.ledger_reader.contains_transaction(&transaction.transaction_id()) {
debug!("Adding unconfirmed transaction {} to memory pool", transaction.transaction_id());
// Attempt to add the unconfirmed transaction to the memory pool.
match self.memory_pool.write().await.add_transaction(&transaction) {
Ok(()) => {
// Upon success, propagate the unconfirmed transaction to the connected peers.
let request = PeersRequest::MessagePropagate(peer_ip, Message::UnconfirmedTransaction(Data::Object(transaction)));
if let Err(error) = self.peers_router.send(request).await {
warn!("[UnconfirmedTransaction] {}", error);
}
}
Err(error) => error!("{}", error),
}
}
}
///
/// Initialize the miner, if the node type is a miner.
///
async fn start_miner(prover: Arc<Self>, local_ip: SocketAddr) {
// Initialize a new instance of the miner.
if E::NODE_TYPE == NodeType::Miner && prover.pool.is_none() {
if let Some(recipient) = prover.address {
// Initialize the prover process.
let prover = prover.clone();
let (router, handler) = oneshot::channel();
E::tasks().append(task::spawn(async move {
// Notify the outer function that the task is ready.
let _ = router.send(());
loop {
// If `terminator` is `false` and the status is not `Peering` or `Mining` already, mine the next block.
if !E::terminator().load(Ordering::SeqCst) && !E::status().is_peering() && !E::status().is_mining() {
// Set the status to `Mining`.
E::status().update(State::Mining);
// Prepare the unconfirmed transactions and dependent objects.
let state = prover.state.clone();
let canon = prover.ledger_reader.clone(); // This is *safe* as the ledger only reads.
let unconfirmed_transactions = prover.memory_pool.read().await.transactions();
let ledger_router = prover.ledger_router.clone();
let prover_router = prover.prover_router.clone();
E::tasks().append(task::spawn(async move {
// Mine the next block.
let result = task::spawn_blocking(move || {
E::thread_pool().install(move || {
canon.mine_next_block(
recipient,
E::COINBASE_IS_PUBLIC,
&unconfirmed_transactions,
E::terminator(),
&mut thread_rng(),
)
})
})
.await
.map_err(|e| e.into());
// Set the status to `Ready`.
E::status().update(State::Ready);
match result {
Ok(Ok((block, coinbase_record))) => {
debug!("Miner has found unconfirmed block {} ({})", block.height(), block.hash());
// Store the coinbase record.
if let Err(error) = state.add_coinbase_record(block.height(), coinbase_record) {
warn!("[Miner] Failed to store coinbase record - {}", error);
}
// Broadcast the next block.
let request = LedgerRequest::UnconfirmedBlock(local_ip, block, prover_router.clone());
if let Err(error) = ledger_router.send(request).await {
warn!("Failed to broadcast mined block - {}", error);
}
}
Ok(Err(error)) | Err(error) => trace!("{}", error),
}
}));
}
// Proceed to sleep for a preset amount of time.
tokio::time::sleep(MINER_HEARTBEAT_IN_SECONDS).await;
}
}));
// Wait until the miner task is ready.
let _ = handler.await;
} else {
error!("Missing miner address. Please specify an Aleo address in order to mine");
}
}
}
}