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
use snarkos_errors::consensus::ConsensusError;
use snarkos_models::{
algorithms::LoadableMerkleParameters,
objects::{LedgerScheme, Transaction},
};
use snarkos_objects::{dpc::DPCTransactions, BlockHeader};
use snarkos_storage::Ledger;
use snarkos_utilities::{
bytes::{FromBytes, ToBytes},
has_duplicates,
to_bytes,
};
use std::collections::HashMap;
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord)]
pub struct Entry<T: Transaction> {
pub size: usize,
pub transaction: T,
}
#[derive(Debug, Clone)]
pub struct MemoryPool<T: Transaction> {
pub total_size: usize,
pub transactions: HashMap<Vec<u8>, Entry<T>>,
}
const BLOCK_HEADER_SIZE: usize = BlockHeader::size();
const COINBASE_TRANSACTION_SIZE: usize = 1490;
impl<T: Transaction> MemoryPool<T> {
#[inline]
pub fn new() -> Self {
Self {
total_size: 0,
transactions: HashMap::<Vec<u8>, Entry<T>>::new(),
}
}
#[inline]
pub fn from_storage<P: LoadableMerkleParameters>(storage: &Ledger<T, P>) -> Result<Self, ConsensusError> {
let mut memory_pool = Self::new();
if let Ok(serialized_transactions) = storage.get_memory_pool() {
if let Ok(transaction_bytes) = DPCTransactions::<T>::read(&serialized_transactions[..]) {
for transaction in transaction_bytes.0 {
let size = transaction.size();
let entry = Entry { transaction, size };
memory_pool.insert(storage, entry)?;
}
}
}
Ok(memory_pool)
}
#[inline]
pub fn store<P: LoadableMerkleParameters>(&self, storage: &Ledger<T, P>) -> Result<(), ConsensusError> {
let mut transactions = DPCTransactions::<T>::new();
for (_transaction_id, entry) in self.transactions.iter() {
transactions.push(entry.transaction.clone())
}
let serialized_transactions = to_bytes![transactions]?.to_vec();
storage.store_to_memory_pool(serialized_transactions)?;
Ok(())
}
#[inline]
pub fn insert<P: LoadableMerkleParameters>(
&mut self,
storage: &Ledger<T, P>,
entry: Entry<T>,
) -> Result<Option<Vec<u8>>, ConsensusError> {
let transaction_serial_numbers = entry.transaction.old_serial_numbers();
let transaction_commitments = entry.transaction.new_commitments();
let transaction_memo = entry.transaction.memorandum();
if has_duplicates(transaction_serial_numbers)
|| has_duplicates(transaction_commitments)
|| self.contains(&entry)
{
return Ok(None);
}
let mut holding_serial_numbers = vec![];
let mut holding_commitments = vec![];
let mut holding_memos = vec![];
for (_, tx) in self.transactions.iter() {
holding_serial_numbers.extend(tx.transaction.old_serial_numbers());
holding_commitments.extend(tx.transaction.new_commitments());
holding_memos.push(tx.transaction.memorandum());
}
for sn in transaction_serial_numbers {
if storage.contains_sn(sn) || holding_serial_numbers.contains(&sn) {
return Ok(None);
}
}
for cm in transaction_commitments {
if storage.contains_cm(cm) || holding_commitments.contains(&cm) {
return Ok(None);
}
}
if storage.contains_memo(transaction_memo) || holding_memos.contains(&transaction_memo) {
return Ok(None);
}
let transaction_id = entry.transaction.transaction_id()?.to_vec();
self.total_size += entry.size;
self.transactions.insert(transaction_id.clone(), entry);
Ok(Some(transaction_id))
}
#[inline]
pub fn cleanse<P: LoadableMerkleParameters>(&mut self, storage: &Ledger<T, P>) -> Result<(), ConsensusError> {
let mut new_memory_pool = Self::new();
for (_, entry) in self.clone().transactions.iter() {
new_memory_pool.insert(&storage, entry.clone())?;
}
self.total_size = new_memory_pool.total_size;
self.transactions = new_memory_pool.transactions;
Ok(())
}
#[inline]
pub fn remove(&mut self, entry: &Entry<T>) -> Result<Option<Vec<u8>>, ConsensusError> {
if self.contains(entry) {
self.total_size -= entry.size;
let transaction_id = entry.transaction.transaction_id()?.to_vec();
self.transactions.remove(&transaction_id);
return Ok(Some(transaction_id));
}
Ok(None)
}
#[inline]
pub fn remove_by_hash(&mut self, transaction_id: &Vec<u8>) -> Result<Option<Entry<T>>, ConsensusError> {
match self.transactions.clone().get(transaction_id) {
Some(entry) => {
self.total_size -= entry.size;
self.transactions.remove(transaction_id);
Ok(Some(entry.clone()))
}
None => Ok(None),
}
}
#[inline]
pub fn contains(&self, entry: &Entry<T>) -> bool {
match &entry.transaction.transaction_id() {
Ok(transaction_id) => self.transactions.contains_key(&transaction_id.to_vec()),
Err(_) => false,
}
}
#[inline]
pub fn get_candidates<P: LoadableMerkleParameters>(
&self,
storage: &Ledger<T, P>,
max_size: usize,
) -> Result<DPCTransactions<T>, ConsensusError> {
let max_size = max_size - (BLOCK_HEADER_SIZE + COINBASE_TRANSACTION_SIZE);
let mut block_size = 0;
let mut transactions = DPCTransactions::new();
for (_transaction_id, entry) in self.transactions.clone() {
if block_size + entry.size <= max_size {
if storage.transcation_conflicts(&entry.transaction) || transactions.conflicts(&entry.transaction) {
continue;
}
block_size += entry.size;
transactions.push(entry.transaction.clone());
}
}
Ok(transactions)
}
}
#[cfg(test)]
mod tests {
use super::*;
use snarkos_dpc::base_dpc::instantiated::Tx;
use snarkos_objects::Block;
use snarkos_testing::{consensus::*, storage::*};
use std::sync::Arc;
#[test]
fn push() {
let blockchain = Arc::new(FIXTURE_VK.ledger());
let mut mem_pool = MemoryPool::new();
let transaction = Tx::read(&TRANSACTION_2[..]).unwrap();
let size = TRANSACTION_2.len();
mem_pool
.insert(&blockchain, Entry {
size,
transaction: transaction.clone(),
})
.unwrap();
assert_eq!(size, mem_pool.total_size);
assert_eq!(1, mem_pool.transactions.len());
mem_pool.insert(&blockchain, Entry { size, transaction }).unwrap();
assert_eq!(size, mem_pool.total_size);
assert_eq!(1, mem_pool.transactions.len());
kill_storage_sync(blockchain);
}
#[test]
fn remove_entry() {
let blockchain = Arc::new(FIXTURE_VK.ledger());
let mut mem_pool = MemoryPool::new();
let transaction = Tx::read(&TRANSACTION_2[..]).unwrap();
let size = TRANSACTION_2.len();
let entry = Entry::<Tx> {
size,
transaction: transaction.clone(),
};
mem_pool.insert(&blockchain, entry.clone()).unwrap();
assert_eq!(1, mem_pool.transactions.len());
assert_eq!(size, mem_pool.total_size);
mem_pool.remove(&entry).unwrap();
assert_eq!(0, mem_pool.transactions.len());
assert_eq!(0, mem_pool.total_size);
kill_storage_sync(blockchain);
}
#[test]
fn remove_transaction_by_hash() {
let blockchain = Arc::new(FIXTURE_VK.ledger());
let mut mem_pool = MemoryPool::new();
let transaction = Tx::read(&TRANSACTION_2[..]).unwrap();
let size = TRANSACTION_2.len();
mem_pool
.insert(&blockchain, Entry {
size,
transaction: transaction.clone(),
})
.unwrap();
assert_eq!(1, mem_pool.transactions.len());
assert_eq!(size, mem_pool.total_size);
mem_pool
.remove_by_hash(&transaction.transaction_id().unwrap().to_vec())
.unwrap();
assert_eq!(0, mem_pool.transactions.len());
assert_eq!(0, mem_pool.total_size);
kill_storage_sync(blockchain);
}
#[test]
fn get_candidates() {
let blockchain = Arc::new(FIXTURE_VK.ledger());
let mut mem_pool = MemoryPool::new();
let transaction = Tx::read(&TRANSACTION_2[..]).unwrap();
let size = to_bytes![transaction].unwrap().len();
let expected_transaction = transaction.clone();
mem_pool.insert(&blockchain, Entry { size, transaction }).unwrap();
let max_block_size = size + BLOCK_HEADER_SIZE + COINBASE_TRANSACTION_SIZE;
let candidates = mem_pool.get_candidates(&blockchain, max_block_size).unwrap();
assert!(candidates.contains(&expected_transaction));
kill_storage_sync(blockchain);
}
#[test]
fn store_memory_pool() {
let blockchain = Arc::new(FIXTURE_VK.ledger());
let mut mem_pool = MemoryPool::new();
let transaction = Tx::read(&TRANSACTION_2[..]).unwrap();
mem_pool
.insert(&blockchain, Entry {
size: TRANSACTION_2.len(),
transaction: transaction.clone(),
})
.unwrap();
assert_eq!(1, mem_pool.transactions.len());
mem_pool.store(&blockchain).unwrap();
let new_mem_pool = MemoryPool::from_storage(&blockchain).unwrap();
assert_eq!(mem_pool.total_size, new_mem_pool.total_size);
kill_storage_sync(blockchain);
}
#[test]
fn cleanse_memory_pool() {
let blockchain = Arc::new(FIXTURE_VK.ledger());
let mut mem_pool = MemoryPool::new();
let transaction = Tx::read(&TRANSACTION_2[..]).unwrap();
mem_pool
.insert(&blockchain, Entry {
size: TRANSACTION_2.len(),
transaction: transaction.clone(),
})
.unwrap();
assert_eq!(1, mem_pool.transactions.len());
mem_pool.store(&blockchain).unwrap();
let block_1 = Block::<Tx>::read(&BLOCK_1[..]).unwrap();
let block_2 = Block::<Tx>::read(&BLOCK_2[..]).unwrap();
blockchain.insert_and_commit(&block_1).unwrap();
blockchain.insert_and_commit(&block_2).unwrap();
mem_pool.cleanse(&blockchain).unwrap();
assert_eq!(0, mem_pool.transactions.len());
assert_eq!(0, mem_pool.total_size);
kill_storage_sync(blockchain);
}
}