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 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634
// Copyright (C) 2019-2023 Aleo Systems Inc.
// This file is part of the snarkVM library.
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at:
// http://www.apache.org/licenses/LICENSE-2.0
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
use super::*;
impl<N: Network, C: ConsensusStorage<N>> VM<N, C> {
/// Speculates on the given list of transactions in the VM.
///
/// Returns the confirmed transactions, aborted transaction IDs,
/// and finalize operations from pre-ratify and post-ratify.
///
/// Note: This method is used to create a new block (including the genesis block).
/// - If `coinbase_reward = None`, then the `ratifications` will not be modified.
/// - If `coinbase_reward = Some(coinbase_reward)`, then the method will append a
/// `Ratify::BlockReward(block_reward)` and `Ratify::PuzzleReward(puzzle_reward)`
/// to the front of the `ratifications` list.
#[inline]
pub fn speculate<'a>(
&self,
state: FinalizeGlobalState,
coinbase_reward: Option<u64>,
candidate_ratifications: Vec<Ratify<N>>,
candidate_solutions: Option<&CoinbaseSolution<N>>,
candidate_transactions: impl ExactSizeIterator<Item = &'a Transaction<N>>,
) -> Result<(Ratifications<N>, Transactions<N>, Vec<N::TransactionID>, Vec<FinalizeOperation<N>>)> {
let timer = timer!("VM::speculate");
// Performs a **dry-run** over the list of ratifications, solutions, and transactions.
let (ratifications, confirmed_transactions, aborted_transactions, ratified_finalize_operations) = self
.atomic_speculate(
state,
coinbase_reward,
candidate_ratifications,
candidate_solutions,
candidate_transactions,
)?;
// Convert the aborted transactions into aborted transaction IDs.
let mut aborted_transaction_ids = Vec::with_capacity(aborted_transactions.len());
for (tx, error) in aborted_transactions {
warn!("Speculation safely aborted a transaction - {error} ({})", tx.id());
aborted_transaction_ids.push(tx.id());
}
finish!(timer, "Finished dry-run of the transactions");
// Return the ratifications, confirmed transactions, aborted transaction IDs, and ratified finalize operations.
Ok((
ratifications,
confirmed_transactions.into_iter().collect(),
aborted_transaction_ids,
ratified_finalize_operations,
))
}
/// Checks the speculation on the given transactions in the VM.
///
/// Returns the finalize operations from pre-ratify and post-ratify.
#[inline]
pub fn check_speculate(
&self,
state: FinalizeGlobalState,
ratifications: &Ratifications<N>,
solutions: Option<&CoinbaseSolution<N>>,
transactions: &Transactions<N>,
) -> Result<Vec<FinalizeOperation<N>>> {
let timer = timer!("VM::check_speculate");
// Reconstruct the candidate ratifications to verify the speculation.
let candidate_ratifications = ratifications.iter().cloned().collect::<Vec<_>>();
// Reconstruct the unconfirmed transactions to verify the speculation.
let candidate_transactions =
transactions.iter().map(|confirmed| confirmed.to_unconfirmed_transaction()).collect::<Result<Vec<_>>>()?;
// Performs a **dry-run** over the list of ratifications, solutions, and transactions.
let (speculate_ratifications, confirmed_transactions, aborted_transactions, ratified_finalize_operations) =
self.atomic_speculate(state, None, candidate_ratifications, solutions, candidate_transactions.iter())?;
// Ensure the ratifications after speculation match.
if ratifications != &speculate_ratifications {
bail!("The ratifications after speculation do not match the ratifications in the block");
}
// Ensure the transactions after speculation match.
if transactions != &confirmed_transactions.into_iter().collect() {
bail!("The transactions after speculation do not match the transactions in the block");
}
// Ensure there are no aborted transaction IDs from this speculation.
// Note: There should be no aborted transactions, because we are checking a block,
// where any aborted transactions should be in the aborted transaction ID list, not in transactions.
ensure!(aborted_transactions.is_empty(), "Aborted transactions found in the block (from speculation)");
finish!(timer, "Finished dry-run of the transactions");
// Return the ratified finalize operations.
Ok(ratified_finalize_operations)
}
/// Finalizes the given transactions into the VM.
///
/// Returns the finalize operations from pre-ratify and post-ratify.
#[inline]
pub fn finalize(
&self,
state: FinalizeGlobalState,
ratifications: &Ratifications<N>,
solutions: Option<&CoinbaseSolution<N>>,
transactions: &Transactions<N>,
) -> Result<Vec<FinalizeOperation<N>>> {
let timer = timer!("VM::finalize");
// Performs a **real-run** of finalize over the list of ratifications, solutions, and transactions.
let ratified_finalize_operations = self.atomic_finalize(state, ratifications, solutions, transactions)?;
finish!(timer, "Finished real-run of finalize");
Ok(ratified_finalize_operations)
}
}
impl<N: Network, C: ConsensusStorage<N>> VM<N, C> {
/// The maximum number of confirmed transactions allowed in a block.
#[cfg(not(any(test, feature = "test")))]
pub const MAXIMUM_CONFIRMED_TRANSACTIONS: usize = Transactions::<N>::MAX_TRANSACTIONS;
/// The maximum number of confirmed transactions allowed in a block.
/// This is set to a deliberately low value (8) for testing purposes only.
#[cfg(any(test, feature = "test"))]
pub const MAXIMUM_CONFIRMED_TRANSACTIONS: usize = 8;
/// Performs atomic speculation over a list of transactions.
///
/// Returns the ratifications, confirmed transactions, aborted transactions,
/// and finalize operations from pre-ratify and post-ratify.
///
/// Note: This method is used by `VM::speculate` and `VM::check_speculate`.
/// - If `coinbase_reward = None`, then the `ratifications` will not be modified.
/// - If `coinbase_reward = Some(coinbase_reward)`, then the method will append a
/// `Ratify::BlockReward(block_reward)` and `Ratify::PuzzleReward(puzzle_reward)`
/// to the front of the `ratifications` list.
fn atomic_speculate<'a>(
&self,
state: FinalizeGlobalState,
coinbase_reward: Option<u64>,
ratifications: Vec<Ratify<N>>,
solutions: Option<&CoinbaseSolution<N>>,
transactions: impl ExactSizeIterator<Item = &'a Transaction<N>>,
) -> Result<(
Ratifications<N>,
Vec<ConfirmedTransaction<N>>,
Vec<(Transaction<N>, String)>,
Vec<FinalizeOperation<N>>,
)> {
let timer = timer!("VM::atomic_speculate");
// Retrieve the number of transactions.
let num_transactions = transactions.len();
// Perform the finalize operation on the preset finalize mode.
atomic_finalize!(self.finalize_store(), FinalizeMode::DryRun, {
// Ensure the number of transactions does not exceed the maximum.
if num_transactions > 2 * Transactions::<N>::MAX_TRANSACTIONS {
// Note: This will abort the entire atomic batch.
return Err(format!(
"Too many transactions in the block - {num_transactions} (max: {})",
2 * Transactions::<N>::MAX_TRANSACTIONS
));
}
// Initialize an iterator for ratifications before finalize.
let pre_ratifications = ratifications.iter().filter(|r| match r {
Ratify::Genesis(_, _) => true,
Ratify::BlockReward(..) | Ratify::PuzzleReward(..) => false,
});
// Initialize an iterator for ratifications after finalize.
let post_ratifications = ratifications.iter().filter(|r| match r {
Ratify::Genesis(_, _) => false,
Ratify::BlockReward(..) | Ratify::PuzzleReward(..) => true,
});
// Initialize a list of finalize operations.
let mut ratified_finalize_operations = Vec::new();
// Retrieve the finalize store.
let store = self.finalize_store();
/* Perform the ratifications before finalize. */
match Self::atomic_pre_ratify(store, state, pre_ratifications) {
// Store the finalize operations from the post-ratify.
Ok(operations) => ratified_finalize_operations.extend(operations),
// Note: This will abort the entire atomic batch.
Err(e) => return Err(format!("Failed to pre-ratify - {e}")),
}
/* Perform the atomic finalize over the transactions. */
// Acquire the write lock on the process.
// Note: Due to the highly-sensitive nature of processing all `finalize` calls,
// we choose to acquire the write lock for the entire duration of this atomic batch.
let process = self.process.write();
// Initialize a list of the confirmed transactions.
let mut confirmed = Vec::with_capacity(num_transactions);
// Initialize a list of the aborted transactions.
let mut aborted = Vec::new();
// Initialize a counter for the confirmed transaction index.
let mut counter = 0u32;
// Finalize the transactions.
'outer: for transaction in transactions {
// Ensure the number of confirmed transactions does not exceed the maximum.
// Upon reaching the maximum number of confirmed transactions, all remaining transactions are aborted.
if confirmed.len() >= Self::MAXIMUM_CONFIRMED_TRANSACTIONS {
// Store the aborted transaction.
aborted.push((transaction.clone(), "Exceeds block transaction limit".to_string()));
// Continue to the next transaction.
continue 'outer;
}
// Process the transaction in an isolated atomic batch.
// - If the transaction succeeds, the finalize operations are stored.
// - If the transaction fails, the atomic batch is aborted and no finalize operations are stored.
let outcome = match transaction {
// The finalize operation here involves appending the 'stack',
// and adding the program to the finalize tree.
Transaction::Deploy(_, program_owner, deployment, fee) => {
match process.finalize_deployment(state, store, deployment, fee) {
// Construct the accepted deploy transaction.
Ok((_, finalize)) => {
ConfirmedTransaction::accepted_deploy(counter, transaction.clone(), finalize)
.map_err(|e| e.to_string())
}
// Construct the rejected deploy transaction.
Err(_error) => {
// Finalize the fee, to ensure it is valid.
match process.finalize_fee(state, store, fee).and_then(|finalize| {
Transaction::from_fee(fee.clone()).map(|fee_tx| (fee_tx, finalize))
}) {
Ok((fee_tx, finalize)) => {
// Construct the rejected deployment.
let rejected = Rejected::new_deployment(*program_owner, *deployment.clone());
// Construct the rejected deploy transaction.
ConfirmedTransaction::rejected_deploy(counter, fee_tx, rejected, finalize)
.map_err(|e| e.to_string())
}
Err(error) => {
// Note: On failure, skip this transaction, and continue speculation.
#[cfg(debug_assertions)]
eprintln!("Failed to finalize the fee in a rejected deploy - {error}");
// Store the aborted transaction.
aborted.push((transaction.clone(), error.to_string()));
// Continue to the next transaction.
continue 'outer;
}
}
}
}
}
// The finalize operation here involves calling 'update_key_value',
// and update the respective leaves of the finalize tree.
Transaction::Execute(_, execution, fee) => {
match process.finalize_execution(state, store, execution, fee.as_ref()) {
// Construct the accepted execute transaction.
Ok(finalize) => {
ConfirmedTransaction::accepted_execute(counter, transaction.clone(), finalize)
.map_err(|e| e.to_string())
}
// Construct the rejected execute transaction.
Err(_error) => match fee {
// Finalize the fee, to ensure it is valid.
Some(fee) => {
match process.finalize_fee(state, store, fee).and_then(|finalize| {
Transaction::from_fee(fee.clone()).map(|fee_tx| (fee_tx, finalize))
}) {
Ok((fee_tx, finalize)) => {
// Construct the rejected execution.
let rejected = Rejected::new_execution(execution.clone());
// Construct the rejected execute transaction.
ConfirmedTransaction::rejected_execute(counter, fee_tx, rejected, finalize)
.map_err(|e| e.to_string())
}
Err(error) => {
// Note: On failure, skip this transaction, and continue speculation.
#[cfg(debug_assertions)]
eprintln!("Failed to finalize the fee in a rejected execute - {error}");
// Store the aborted transaction.
aborted.push((transaction.clone(), error.to_string()));
// Continue to the next transaction.
continue 'outer;
}
}
}
// This is a foundational bug - the caller is violating protocol rules.
// Note: This will abort the entire atomic batch.
None => Err("Rejected execute transaction has no fee".to_string()),
},
}
}
// There are no finalize operations here.
// Note: This will abort the entire atomic batch.
Transaction::Fee(..) => Err("Cannot speculate on a fee transaction".to_string()),
};
lap!(timer, "Speculated on transaction '{}'", transaction.id());
match outcome {
// If the transaction succeeded, store it and continue to the next transaction.
Ok(confirmed_transaction) => {
confirmed.push(confirmed_transaction);
// Increment the transaction index counter.
counter = counter.saturating_add(1);
}
// If the transaction failed, abort the entire batch.
Err(error) => {
eprintln!("Critical bug in speculate: {error}\n\n{transaction}");
// Note: This will abort the entire atomic batch.
return Err(format!("Failed to speculate on transaction - {error}"));
}
}
}
// Ensure all transactions were processed.
if confirmed.len() + aborted.len() != num_transactions {
// Note: This will abort the entire atomic batch.
return Err("Not all transactions were processed in 'VM::atomic_speculate'".to_string());
}
/* Perform the ratifications after finalize. */
// Prepare the reward ratifications, if any.
let reward_ratifications = match coinbase_reward {
// If the coinbase reward is `None`, then there are no reward ratifications.
None => vec![],
// If the coinbase reward is `Some(coinbase_reward)`, then we must compute the reward ratifications.
Some(coinbase_reward) => {
// Calculate the transaction fees.
let Ok(transaction_fees) =
confirmed.iter().map(|tx| Ok(*tx.priority_fee_amount()?)).sum::<Result<u64>>()
else {
// Note: This will abort the entire atomic batch.
return Err("Failed to calculate the transaction fees during speculation".to_string());
};
// Compute the block reward.
let block_reward = ledger_block::block_reward(
N::STARTING_SUPPLY,
N::BLOCK_TIME,
coinbase_reward,
transaction_fees,
);
// Compute the puzzle reward.
let puzzle_reward = ledger_block::puzzle_reward(coinbase_reward);
// Output the reward ratifications.
vec![Ratify::BlockReward(block_reward), Ratify::PuzzleReward(puzzle_reward)]
}
};
// Update the post-ratifications iterator.
let post_ratifications = reward_ratifications.iter().chain(post_ratifications);
// Process the post-ratifications.
match Self::atomic_post_ratify(store, state, post_ratifications, solutions) {
// Store the finalize operations from the post-ratify.
Ok(operations) => ratified_finalize_operations.extend(operations),
// Note: This will abort the entire atomic batch.
Err(e) => return Err(format!("Failed to post-ratify - {e}")),
}
/* Construct the ratifications after speculation. */
let Ok(ratifications) =
Ratifications::try_from_iter(reward_ratifications.into_iter().chain(ratifications.into_iter()))
else {
// Note: This will abort the entire atomic batch.
return Err("Failed to construct the ratifications after speculation".to_string());
};
finish!(timer);
// On return, 'atomic_finalize!' will abort the batch, and return the ratifications,
// confirmed & aborted transactions, and finalize operations from pre-ratify and post-ratify.
Ok((ratifications, confirmed, aborted, ratified_finalize_operations))
})
}
/// Performs atomic finalization over a list of transactions.
///
/// Returns the finalize operations from pre-ratify and post-ratify.
#[inline]
fn atomic_finalize(
&self,
state: FinalizeGlobalState,
ratifications: &Ratifications<N>,
solutions: Option<&CoinbaseSolution<N>>,
transactions: &Transactions<N>,
) -> Result<Vec<FinalizeOperation<N>>> {
let timer = timer!("VM::atomic_finalize");
// Perform the finalize operation on the preset finalize mode.
atomic_finalize!(self.finalize_store(), FinalizeMode::RealRun, {
// Initialize an iterator for ratifications before finalize.
let pre_ratifications = ratifications.iter().filter(|r| match r {
Ratify::Genesis(_, _) => true,
Ratify::BlockReward(..) | Ratify::PuzzleReward(..) => false,
});
// Initialize an iterator for ratifications after finalize.
let post_ratifications = ratifications.iter().filter(|r| match r {
Ratify::Genesis(_, _) => false,
Ratify::BlockReward(..) | Ratify::PuzzleReward(..) => true,
});
// Initialize a list of finalize operations.
let mut ratified_finalize_operations = Vec::new();
// Retrieve the finalize store.
let store = self.finalize_store();
/* Perform the ratifications before finalize. */
match Self::atomic_pre_ratify(store, state, pre_ratifications) {
// Store the finalize operations from the post-ratify.
Ok(operations) => ratified_finalize_operations.extend(operations),
// Note: This will abort the entire atomic batch.
Err(e) => return Err(format!("Failed to pre-ratify - {e}")),
}
/* Perform the atomic finalize over the transactions. */
// Acquire the write lock on the process.
// Note: Due to the highly-sensitive nature of processing all `finalize` calls,
// we choose to acquire the write lock for the entire duration of this atomic batch.
let mut process = self.process.write();
// Initialize a list for the deployed stacks.
let mut stacks = Vec::new();
// Finalize the transactions.
for (index, transaction) in transactions.iter().enumerate() {
// Convert the transaction index to a u32.
// Note: On failure, this will abort the entire atomic batch.
let index = u32::try_from(index).map_err(|_| "Failed to convert transaction index".to_string())?;
// Ensure the index matches the expected index.
if index != transaction.index() {
// Note: This will abort the entire atomic batch.
return Err(format!("Mismatch in {} transaction index", transaction.variant()));
}
// Process the transaction in an isolated atomic batch.
// - If the transaction succeeds, the finalize operations are stored.
// - If the transaction fails, the atomic batch is aborted and no finalize operations are stored.
let outcome: Result<(), String> = match transaction {
ConfirmedTransaction::AcceptedDeploy(_, transaction, finalize) => {
// Extract the deployment and fee from the transaction.
let (deployment, fee) = match transaction {
Transaction::Deploy(_, _, deployment, fee) => (deployment, fee),
// Note: This will abort the entire atomic batch.
_ => return Err("Expected deploy transaction".to_string()),
};
// The finalize operation here involves appending the 'stack', and adding the program to the finalize tree.
match process.finalize_deployment(state, store, deployment, fee) {
// Ensure the finalize operations match the expected.
Ok((stack, finalize_operations)) => match finalize == &finalize_operations {
// Store the stack.
true => stacks.push(stack),
// Note: This will abort the entire atomic batch.
false => {
return Err(format!(
"Mismatch in finalize operations for an accepted deploy - (found: {finalize_operations:?}, expected: {finalize:?})"
));
}
},
// Note: This will abort the entire atomic batch.
Err(error) => {
return Err(format!("Failed to finalize an accepted deploy transaction - {error}"));
}
};
Ok(())
}
ConfirmedTransaction::AcceptedExecute(_, transaction, finalize) => {
// Extract the execution and fee from the transaction.
let (execution, fee) = match transaction {
Transaction::Execute(_, execution, fee) => (execution, fee),
// Note: This will abort the entire atomic batch.
_ => return Err("Expected execute transaction".to_string()),
};
// The finalize operation here involves calling 'update_key_value',
// and update the respective leaves of the finalize tree.
match process.finalize_execution(state, store, execution, fee.as_ref()) {
// Ensure the finalize operations match the expected.
Ok(finalize_operations) => {
if finalize != &finalize_operations {
// Note: This will abort the entire atomic batch.
return Err(format!(
"Mismatch in finalize operations for an accepted execute - (found: {finalize_operations:?}, expected: {finalize:?})"
));
}
}
// Note: This will abort the entire atomic batch.
Err(error) => {
return Err(format!("Failed to finalize an accepted execute transaction - {error}"));
}
}
Ok(())
}
ConfirmedTransaction::RejectedDeploy(_, Transaction::Fee(_, fee), rejected, finalize) => {
// Extract the rejected deployment.
let Some(deployment) = rejected.deployment() else {
// Note: This will abort the entire atomic batch.
return Err("Expected rejected deployment".to_string());
};
// Compute the expected deployment ID.
let Ok(expected_deployment_id) = deployment.to_deployment_id() else {
// Note: This will abort the entire atomic batch.
return Err("Failed to compute the deployment ID for a rejected deployment".to_string());
};
// Retrieve the candidate deployment ID.
let Ok(candidate_deployment_id) = fee.deployment_or_execution_id() else {
// Note: This will abort the entire atomic batch.
return Err("Failed to retrieve the deployment ID from the fee".to_string());
};
// Ensure this fee corresponds to the deployment.
if candidate_deployment_id != expected_deployment_id {
// Note: This will abort the entire atomic batch.
return Err("Mismatch in fee for a rejected deploy transaction".to_string());
}
// Lastly, finalize the fee.
match process.finalize_fee(state, store, fee) {
// Ensure the finalize operations match the expected.
Ok(finalize_operations) => {
if finalize != &finalize_operations {
// Note: This will abort the entire atomic batch.
return Err(format!(
"Mismatch in finalize operations for a rejected deploy - (found: {finalize_operations:?}, expected: {finalize:?})"
));
}
}
// Note: This will abort the entire atomic batch.
Err(_e) => {
return Err("Failed to finalize the fee in a rejected deploy transaction".to_string());
}
}
Ok(())
}
ConfirmedTransaction::RejectedExecute(_, Transaction::Fee(_, fee), rejected, finalize) => {
// Extract the rejected execution.
let Some(execution) = rejected.execution() else {
// Note: This will abort the entire atomic batch.
return Err("Expected rejected execution".to_string());
};
// Compute the expected execution ID.
let Ok(expected_execution_id) = execution.to_execution_id() else {
// Note: This will abort the entire atomic batch.
return Err("Failed to compute the execution ID for a rejected execution".to_string());
};
// Retrieve the candidate execution ID.
let Ok(candidate_execution_id) = fee.deployment_or_execution_id() else {
// Note: This will abort the entire atomic batch.
return Err("Failed to retrieve the execution ID from the fee".to_string());
};
// Ensure this fee corresponds to the execution.
if candidate_execution_id != expected_execution_id {
// Note: This will abort the entire atomic batch.
return Err("Mismatch in fee for a rejected execute transaction".to_string());
}
// Lastly, finalize the fee.
match process.finalize_fee(state, store, fee) {
// Ensure the finalize operations match the expected.
Ok(finalize_operations) => {
if finalize != &finalize_operations {
// Note: This will abort the entire atomic batch.
return Err(format!(
"Mismatch in finalize operations for a rejected execute - (found: {finalize_operations:?}, expected: {finalize:?})"
));
}
}
// Note: This will abort the entire atomic batch.
Err(_e) => {
return Err("Failed to finalize the fee in a rejected execute transaction".to_string());
}
}
Ok(())
}
// Note: This will abort the entire atomic batch.
_ => return Err("Invalid confirmed transaction type".to_string()),
};
lap!(timer, "Finalizing transaction {}", transaction.id());
match outcome {
// If the transaction succeeded to finalize, continue to the next transaction.
Ok(()) => (),
// If the transaction failed to finalize, abort and continue to the next transaction.
Err(error) => {
eprintln!("Critical bug in finalize: {error}\n\n{transaction}");
// Note: This will abort the entire atomic batch.
return Err(format!("Failed to finalize on transaction - {error}"));
}
}
}
/* Perform the ratifications after finalize. */
match Self::atomic_post_ratify(store, state, post_ratifications, solutions) {
// Store the finalize operations from the post-ratify.
Ok(operations) => ratified_finalize_operations.extend(operations),
// Note: This will abort the entire atomic batch.
Err(e) => return Err(format!("Failed to post-ratify - {e}")),
}
/* Start the commit process. */
// Commit all of the stacks to the process.
if !stacks.is_empty() {
stacks.into_iter().for_each(|stack| process.add_stack(stack))
}
finish!(timer); // <- Note: This timer does **not** include the time to write batch to DB.
Ok(ratified_finalize_operations)
})
}
/// Performs the pre-ratifications before finalizing transactions.
#[inline]
fn atomic_pre_ratify<'a>(
store: &FinalizeStore<N, C::FinalizeStorage>,
state: FinalizeGlobalState,
pre_ratifications: impl Iterator<Item = &'a Ratify<N>>,
) -> Result<Vec<FinalizeOperation<N>>> {
// Construct the program ID.
let program_id = ProgramID::from_str("credits.aleo")?;
// Construct the committee mapping name.
let committee_mapping = Identifier::from_str("committee")?;
// Construct the bonded mapping name.
let bonded_mapping = Identifier::from_str("bonded")?;
// Construct the account mapping name.
let account_mapping = Identifier::from_str("account")?;
// Initialize a list of finalize operations.
let mut finalize_operations = Vec::new();
// Initialize a flag for the genesis ratification.
let mut is_genesis_ratified = false;
// Iterate over the ratifications.
for ratify in pre_ratifications {
match ratify {
Ratify::Genesis(committee, public_balances) => {
// Ensure this is the genesis block.
ensure!(state.block_height() == 0, "Ratify::Genesis(..) expected a genesis block");
// Ensure the genesis committee round is 0.
ensure!(
committee.starting_round() == 0,
"Ratify::Genesis(..) expected a genesis committee round of 0"
);
// Ensure genesis has not been ratified yet.
ensure!(!is_genesis_ratified, "Ratify::Genesis(..) has already been ratified");
// TODO (howardwu): Consider whether to initialize the mappings here.
// Currently, this is breaking for test cases that use VM but do not insert the genesis block.
// // Initialize the store for 'credits.aleo'.
// let credits = Program::<N>::credits()?;
// for mapping in credits.mappings().values() {
// // Ensure that all mappings are initialized.
// if !store.contains_mapping_confirmed(credits.id(), mapping.name())? {
// // Initialize the mappings for 'credits.aleo'.
// finalize_operations.push(store.initialize_mapping(*credits.id(), *mapping.name())?);
// }
// }
// Initialize the stakers.
let mut stakers = IndexMap::with_capacity(committee.members().len());
// Iterate over the committee members.
for (validator, (microcredits, _)) in committee.members() {
// Insert the validator into the stakers.
stakers.insert(*validator, (*validator, *microcredits));
}
// Construct the next committee map and next bonded map.
let (next_committee_map, next_bonded_map) =
to_next_commitee_map_and_bonded_map(committee, &stakers);
// Insert the next committee into storage.
store.committee_store().insert(state.block_height(), committee.clone())?;
// Store the finalize operations for updating the committee and bonded mapping.
finalize_operations.extend(&[
// Replace the committee mapping in storage.
store.replace_mapping(program_id, committee_mapping, next_committee_map)?,
// Replace the bonded mapping in storage.
store.replace_mapping(program_id, bonded_mapping, next_bonded_map)?,
]);
// Iterate over the public balances.
for (address, amount) in public_balances {
// Construct the key.
let key = Plaintext::from(Literal::Address(*address));
// Retrieve the current public balance.
let value = store.get_value_speculative(program_id, account_mapping, &key)?;
// Compute the next public balance.
let next_value = Value::from(Literal::U64(U64::new(match value {
Some(Value::Plaintext(Plaintext::Literal(Literal::U64(value), _))) => {
(*value).saturating_add(*amount)
}
None => *amount,
v => bail!("Critical bug in pre-ratify - Invalid public balance type ({v:?})"),
})));
// Update the public balance in finalize storage.
let operation = store.update_key_value(program_id, account_mapping, key, next_value)?;
finalize_operations.push(operation);
}
// Set the genesis ratification flag.
is_genesis_ratified = true;
}
Ratify::BlockReward(..) | Ratify::PuzzleReward(..) => continue,
}
}
// Return the finalize operations.
Ok(finalize_operations)
}
/// Performs the post-ratifications after finalizing transactions.
#[inline]
fn atomic_post_ratify<'a>(
store: &FinalizeStore<N, C::FinalizeStorage>,
state: FinalizeGlobalState,
post_ratifications: impl Iterator<Item = &'a Ratify<N>>,
solutions: Option<&CoinbaseSolution<N>>,
) -> Result<Vec<FinalizeOperation<N>>> {
// Construct the program ID.
let program_id = ProgramID::from_str("credits.aleo")?;
// Construct the committee mapping name.
let committee_mapping = Identifier::from_str("committee")?;
// Construct the bonded mapping name.
let bonded_mapping = Identifier::from_str("bonded")?;
// Construct the account mapping name.
let account_mapping = Identifier::from_str("account")?;
// Initialize a list of finalize operations.
let mut finalize_operations = Vec::new();
// Initialize a flag for the block reward ratification.
let mut is_block_reward_ratified = false;
// Initialize a flag for the puzzle reward ratification.
let mut is_puzzle_reward_ratified = false;
// Iterate over the ratifications.
for ratify in post_ratifications {
match ratify {
Ratify::Genesis(..) => continue,
Ratify::BlockReward(block_reward) => {
// Ensure the block reward has not been ratified yet.
ensure!(!is_block_reward_ratified, "Ratify::BlockReward(..) has already been ratified");
// Retrieve the committee mapping from storage.
let current_committee_map = store.get_mapping_speculative(program_id, committee_mapping)?;
// Convert the committee mapping into a committee.
let current_committee = committee_map_into_committee(state.block_round(), current_committee_map)?;
// Retrieve the bonded mapping from storage.
let current_bonded_map = store.get_mapping_speculative(program_id, bonded_mapping)?;
// Convert the bonded map into stakers.
let current_stakers = bonded_map_into_stakers(current_bonded_map)?;
// Ensure the committee matches the bonded mapping.
ensure_stakers_matches(¤t_committee, ¤t_stakers)?;
// Compute the updated stakers, using the committee and block reward.
let next_stakers = staking_rewards(¤t_stakers, ¤t_committee, *block_reward);
// Compute the updated committee, using the stakers.
let next_committee = to_next_committee(¤t_committee, state.block_round(), &next_stakers)?;
// Construct the next committee map and next bonded map.
let (next_committee_map, next_bonded_map) =
to_next_commitee_map_and_bonded_map(&next_committee, &next_stakers);
// Insert the next committee into storage.
store.committee_store().insert(state.block_height(), next_committee)?;
// Store the finalize operations for updating the committee and bonded mapping.
finalize_operations.extend(&[
// Replace the committee mapping in storage.
store.replace_mapping(program_id, committee_mapping, next_committee_map)?,
// Replace the bonded mapping in storage.
store.replace_mapping(program_id, bonded_mapping, next_bonded_map)?,
]);
// Set the block reward ratification flag.
is_block_reward_ratified = true;
}
Ratify::PuzzleReward(puzzle_reward) => {
// Ensure the puzzle reward has not been ratified yet.
ensure!(!is_puzzle_reward_ratified, "Ratify::PuzzleReward(..) has already been ratified");
// If the puzzle reward is zero, skip.
if *puzzle_reward == 0 {
continue;
}
// Retrieve the solutions.
let Some(solutions) = solutions else {
continue;
};
// Compute the proof targets, with the corresponding addresses.
let proof_targets =
solutions.values().map(|s| Ok((s.address(), s.to_target()?))).collect::<Result<Vec<_>>>()?;
// Calculate the proving rewards.
let proving_rewards = proving_rewards(proof_targets, *puzzle_reward);
// Iterate over the proving rewards.
for (address, amount) in proving_rewards {
// Construct the key.
let key = Plaintext::from(Literal::Address(address));
// Retrieve the current public balance.
let value = store.get_value_speculative(program_id, account_mapping, &key)?;
// Compute the next public balance.
let next_value = Value::from(Literal::U64(U64::new(match value {
Some(Value::Plaintext(Plaintext::Literal(Literal::U64(value), _))) => {
(*value).saturating_add(amount)
}
None => amount,
v => bail!("Critical bug in post-ratify puzzle reward- Invalid amount ({v:?})"),
})));
// Update the public balance in finalize storage.
let operation = store.update_key_value(program_id, account_mapping, key, next_value)?;
finalize_operations.push(operation);
}
// Set the puzzle reward ratification flag.
is_puzzle_reward_ratified = true;
}
}
}
// Return the finalize operations.
Ok(finalize_operations)
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::vm::{test_helpers, test_helpers::sample_finalize_state};
use console::{
account::{Address, PrivateKey, ViewKey},
program::{Ciphertext, Entry, Record},
types::Field,
};
use ledger_block::{Block, Header, Metadata, Transaction, Transition};
use ledger_store::helpers::memory::ConsensusMemory;
use synthesizer_program::Program;
use rand::distributions::DistString;
type CurrentNetwork = test_helpers::CurrentNetwork;
/// Sample a new program and deploy it to the VM. Returns the program name.
fn new_program_deployment<R: Rng + CryptoRng>(
vm: &VM<CurrentNetwork, ConsensusMemory<CurrentNetwork>>,
private_key: &PrivateKey<CurrentNetwork>,
previous_block: &Block<CurrentNetwork>,
unspent_records: &mut Vec<Record<CurrentNetwork, Ciphertext<CurrentNetwork>>>,
rng: &mut R,
) -> Result<(String, Block<CurrentNetwork>)> {
let program_name = format!("a{}.aleo", Alphanumeric.sample_string(rng, 8).to_lowercase());
let program = Program::<CurrentNetwork>::from_str(&format!(
"
program {program_name};
mapping account:
// The token owner.
key as address.public;
// The token amount.
value as u64.public;
function mint_public:
input r0 as address.public;
input r1 as u64.public;
async mint_public r0 r1 into r2;
output r2 as {program_name}/mint_public.future;
finalize mint_public:
input r0 as address.public;
input r1 as u64.public;
get.or_use account[r0] 0u64 into r2;
add r2 r1 into r3;
set r3 into account[r0];
function transfer_public:
input r0 as address.public;
input r1 as u64.public;
async transfer_public self.caller r0 r1 into r2;
output r2 as {program_name}/transfer_public.future;
finalize transfer_public:
input r0 as address.public;
input r1 as address.public;
input r2 as u64.public;
get.or_use account[r0] 0u64 into r3;
get.or_use account[r1] 0u64 into r4;
sub r3 r2 into r5;
add r4 r2 into r6;
set r5 into account[r0];
set r6 into account[r1];"
))?;
// Prepare the additional fee.
let view_key = ViewKey::<CurrentNetwork>::try_from(private_key)?;
let credits = Some(unspent_records.pop().unwrap().decrypt(&view_key)?);
// Deploy.
let transaction = vm.deploy(private_key, &program, credits, 10, None, rng)?;
// Construct the new block.
let next_block = sample_next_block(vm, private_key, &[transaction], previous_block, unspent_records, rng)?;
Ok((program_name, next_block))
}
/// Construct a new block based on the given transactions.
fn sample_next_block<R: Rng + CryptoRng>(
vm: &VM<CurrentNetwork, ConsensusMemory<CurrentNetwork>>,
private_key: &PrivateKey<CurrentNetwork>,
transactions: &[Transaction<CurrentNetwork>],
previous_block: &Block<CurrentNetwork>,
unspent_records: &mut Vec<Record<CurrentNetwork, Ciphertext<CurrentNetwork>>>,
rng: &mut R,
) -> Result<Block<CurrentNetwork>> {
// Speculate on the candidate ratifications, solutions, and transactions.
let (ratifications, transactions, aborted_transaction_ids, ratified_finalize_operations) =
vm.speculate(sample_finalize_state(1), None, vec![], None, transactions.iter())?;
// Construct the metadata associated with the block.
let metadata = Metadata::new(
CurrentNetwork::ID,
previous_block.round() + 1,
previous_block.height() + 1,
0,
0,
CurrentNetwork::GENESIS_COINBASE_TARGET,
CurrentNetwork::GENESIS_PROOF_TARGET,
previous_block.last_coinbase_target(),
previous_block.last_coinbase_timestamp(),
CurrentNetwork::GENESIS_TIMESTAMP + 1,
)?;
// Construct the new block header.
let header = Header::from(
vm.block_store().current_state_root(),
transactions.to_transactions_root().unwrap(),
transactions.to_finalize_root(ratified_finalize_operations).unwrap(),
ratifications.to_ratifications_root().unwrap(),
Field::zero(),
Field::zero(),
metadata,
)?;
let block = Block::new_beacon(
private_key,
previous_block.hash(),
header,
ratifications,
None,
transactions,
aborted_transaction_ids,
rng,
)?;
// Track the new records.
let new_records = block
.transitions()
.cloned()
.flat_map(Transition::into_records)
.map(|(_, record)| record)
.collect::<Vec<_>>();
unspent_records.extend(new_records);
Ok(block)
}
/// Generate split transactions for the unspent records.
fn generate_splits<R: Rng + CryptoRng>(
vm: &VM<CurrentNetwork, ConsensusMemory<CurrentNetwork>>,
private_key: &PrivateKey<CurrentNetwork>,
previous_block: &Block<CurrentNetwork>,
unspent_records: &mut Vec<Record<CurrentNetwork, Ciphertext<CurrentNetwork>>>,
rng: &mut R,
) -> Result<Block<CurrentNetwork>> {
// Prepare the additional fee.
let view_key = ViewKey::<CurrentNetwork>::try_from(private_key)?;
// Generate split transactions.
let mut transactions = Vec::new();
while !unspent_records.is_empty() {
let record = unspent_records.pop().unwrap().decrypt(&view_key)?;
// Fetch the record balance and divide it in half.
let split_balance = match record.find(&[Identifier::from_str("microcredits")?]) {
Ok(Entry::Private(Plaintext::Literal(Literal::U64(amount), _))) => *amount / 2,
_ => bail!("fee record does not contain a microcredits entry"),
};
// Prepare the inputs.
let inputs = [
Value::<CurrentNetwork>::Record(record),
Value::<CurrentNetwork>::from_str(&format!("{split_balance}u64")).unwrap(),
]
.into_iter();
// Execute.
let transaction = vm.execute(private_key, ("credits.aleo", "split"), inputs, None, 0, None, rng).unwrap();
transactions.push(transaction);
}
// Construct the new block.
sample_next_block(vm, private_key, &transactions, previous_block, unspent_records, rng)
}
/// Create an execution transaction.
fn create_execution(
vm: &VM<CurrentNetwork, ConsensusMemory<CurrentNetwork>>,
caller_private_key: PrivateKey<CurrentNetwork>,
program_id: &str,
function_name: &str,
inputs: Vec<Value<CurrentNetwork>>,
unspent_records: &mut Vec<Record<CurrentNetwork, Ciphertext<CurrentNetwork>>>,
rng: &mut TestRng,
) -> Transaction<CurrentNetwork> {
assert!(vm.contains_program(&ProgramID::from_str(program_id).unwrap()));
// Prepare the additional fee.
let view_key = ViewKey::<CurrentNetwork>::try_from(caller_private_key).unwrap();
let credits = Some(unspent_records.pop().unwrap().decrypt(&view_key).unwrap());
// Execute.
let transaction = vm
.execute(&caller_private_key, (program_id, function_name), inputs.into_iter(), credits, 1, None, rng)
.unwrap();
// Verify.
vm.check_transaction(&transaction, None, rng).unwrap();
// Return the transaction.
transaction
}
/// Sample a public mint transaction.
fn sample_mint_public(
vm: &VM<CurrentNetwork, ConsensusMemory<CurrentNetwork>>,
caller_private_key: PrivateKey<CurrentNetwork>,
program_id: &str,
recipient: Address<CurrentNetwork>,
amount: u64,
unspent_records: &mut Vec<Record<CurrentNetwork, Ciphertext<CurrentNetwork>>>,
rng: &mut TestRng,
) -> Transaction<CurrentNetwork> {
let inputs = vec![
Value::<CurrentNetwork>::from_str(&recipient.to_string()).unwrap(),
Value::<CurrentNetwork>::from_str(&format!("{amount}u64")).unwrap(),
];
create_execution(vm, caller_private_key, program_id, "mint_public", inputs, unspent_records, rng)
}
/// Sample a public transfer transaction.
fn sample_transfer_public(
vm: &VM<CurrentNetwork, ConsensusMemory<CurrentNetwork>>,
caller_private_key: PrivateKey<CurrentNetwork>,
program_id: &str,
recipient: Address<CurrentNetwork>,
amount: u64,
unspent_records: &mut Vec<Record<CurrentNetwork, Ciphertext<CurrentNetwork>>>,
rng: &mut TestRng,
) -> Transaction<CurrentNetwork> {
let inputs = vec![
Value::<CurrentNetwork>::from_str(&recipient.to_string()).unwrap(),
Value::<CurrentNetwork>::from_str(&format!("{amount}u64")).unwrap(),
];
create_execution(vm, caller_private_key, program_id, "transfer_public", inputs, unspent_records, rng)
}
/// A helper method to construct the rejected transaction format for `atomic_finalize`.
fn reject(
index: u32,
transaction: &Transaction<CurrentNetwork>,
finalize: &[FinalizeOperation<CurrentNetwork>],
) -> ConfirmedTransaction<CurrentNetwork> {
match transaction {
Transaction::Execute(_, execution, fee) => ConfirmedTransaction::RejectedExecute(
index,
Transaction::from_fee(fee.clone().unwrap()).unwrap(),
Rejected::new_execution(execution.clone()),
finalize.to_vec(),
),
_ => panic!("only reject execution transactions"),
}
}
#[test]
fn test_finalize_duplicate_deployment() {
let rng = &mut TestRng::default();
let vm = crate::vm::test_helpers::sample_vm();
// Fetch a deployment transaction.
let deployment_transaction = crate::vm::test_helpers::sample_deployment_transaction(rng);
let deployment_transaction_id = deployment_transaction.id();
// Construct the program name.
let program_id = ProgramID::from_str("testing.aleo").unwrap();
// Prepare the confirmed transactions.
let (ratifications, confirmed_transactions, aborted_transaction_ids, _) = vm
.speculate(sample_finalize_state(1), None, vec![], None, [deployment_transaction.clone()].iter())
.unwrap();
assert_eq!(confirmed_transactions.len(), 1);
assert!(aborted_transaction_ids.is_empty());
// Ensure the VM does not contain this program.
assert!(!vm.contains_program(&program_id));
// Finalize the transaction.
assert!(vm.finalize(sample_finalize_state(1), &ratifications, None, &confirmed_transactions).is_ok());
// Ensure the VM contains this program.
assert!(vm.contains_program(&program_id));
// Ensure the VM can't redeploy the same transaction.
assert!(vm.finalize(sample_finalize_state(1), &ratifications, None, &confirmed_transactions).is_err());
// Ensure the VM contains this program.
assert!(vm.contains_program(&program_id));
// Ensure the dry run of the redeployment will cause a reject transaction to be created.
let (_, candidate_transactions, aborted_transaction_ids, _) =
vm.atomic_speculate(sample_finalize_state(1), None, vec![], None, [deployment_transaction].iter()).unwrap();
assert_eq!(candidate_transactions.len(), 1);
assert!(matches!(candidate_transactions[0], ConfirmedTransaction::RejectedDeploy(..)));
assert!(aborted_transaction_ids.is_empty());
// Check that the unconfirmed transaction id of the rejected deployment is correct.
assert_eq!(candidate_transactions[0].to_unconfirmed_transaction_id().unwrap(), deployment_transaction_id);
}
#[test]
fn test_atomic_finalize_many() {
let rng = &mut TestRng::default();
// Sample a private key and address for the caller.
let caller_private_key = test_helpers::sample_genesis_private_key(rng);
let caller_address = Address::try_from(&caller_private_key).unwrap();
// Sample a private key and address for the recipient.
let recipient_private_key = PrivateKey::new(rng).unwrap();
let recipient_address = Address::try_from(&recipient_private_key).unwrap();
// Initialize the vm.
let vm = test_helpers::sample_vm_with_genesis_block(rng);
// Deploy a new program.
let genesis =
vm.block_store().get_block(&vm.block_store().get_block_hash(0).unwrap().unwrap()).unwrap().unwrap();
// Get the unspent records.
let mut unspent_records = genesis
.transitions()
.cloned()
.flat_map(Transition::into_records)
.map(|(_, record)| record)
.collect::<Vec<_>>();
// Construct the deployment block.
let (program_id, deployment_block) =
new_program_deployment(&vm, &caller_private_key, &genesis, &mut unspent_records, rng).unwrap();
// Add the deployment block to the VM.
vm.add_next_block(&deployment_block).unwrap();
// Generate more records to use for the next block.
let splits_block =
generate_splits(&vm, &caller_private_key, &deployment_block, &mut unspent_records, rng).unwrap();
// Add the splits block to the VM.
vm.add_next_block(&splits_block).unwrap();
// Construct the initial mint.
let initial_mint =
sample_mint_public(&vm, caller_private_key, &program_id, caller_address, 20, &mut unspent_records, rng);
let initial_mint_block =
sample_next_block(&vm, &caller_private_key, &[initial_mint], &splits_block, &mut unspent_records, rng)
.unwrap();
// Add the block to the vm.
vm.add_next_block(&initial_mint_block).unwrap();
// Construct a mint and a transfer.
let mint_10 =
sample_mint_public(&vm, caller_private_key, &program_id, caller_address, 10, &mut unspent_records, rng);
let mint_20 =
sample_mint_public(&vm, caller_private_key, &program_id, caller_address, 20, &mut unspent_records, rng);
let transfer_10 = sample_transfer_public(
&vm,
caller_private_key,
&program_id,
recipient_address,
10,
&mut unspent_records,
rng,
);
let transfer_20 = sample_transfer_public(
&vm,
caller_private_key,
&program_id,
recipient_address,
20,
&mut unspent_records,
rng,
);
let transfer_30 = sample_transfer_public(
&vm,
caller_private_key,
&program_id,
recipient_address,
30,
&mut unspent_records,
rng,
);
// TODO (raychu86): Confirm that the finalize_operations here are correct.
// Starting Balance = 20
// Mint_10 -> Balance = 20 + 10 = 30
// Transfer_10 -> Balance = 30 - 10 = 20
// Transfer_20 -> Balance = 20 - 20 = 0
{
let transactions = [mint_10.clone(), transfer_10.clone(), transfer_20.clone()];
let (_, confirmed_transactions, aborted_transaction_ids, _) =
vm.atomic_speculate(sample_finalize_state(1), None, vec![], None, transactions.iter()).unwrap();
// Assert that all the transactions are accepted.
assert_eq!(confirmed_transactions.len(), 3);
confirmed_transactions.iter().for_each(|confirmed_tx| assert!(confirmed_tx.is_accepted()));
assert!(aborted_transaction_ids.is_empty());
assert_eq!(confirmed_transactions[0].transaction(), &mint_10);
assert_eq!(confirmed_transactions[1].transaction(), &transfer_10);
assert_eq!(confirmed_transactions[2].transaction(), &transfer_20);
}
// Starting Balance = 20
// Transfer_20 -> Balance = 20 - 20 = 0
// Mint_10 -> Balance = 0 + 10 = 10
// Mint_20 -> Balance = 10 + 20 = 30
// Transfer_30 -> Balance = 30 - 30 = 0
{
let transactions = [transfer_20.clone(), mint_10.clone(), mint_20.clone(), transfer_30.clone()];
let (_, confirmed_transactions, aborted_transaction_ids, _) =
vm.atomic_speculate(sample_finalize_state(1), None, vec![], None, transactions.iter()).unwrap();
// Assert that all the transactions are accepted.
assert_eq!(confirmed_transactions.len(), 4);
confirmed_transactions.iter().for_each(|confirmed_tx| assert!(confirmed_tx.is_accepted()));
assert!(aborted_transaction_ids.is_empty());
// Ensure that the transactions are in the correct order.
assert_eq!(confirmed_transactions[0].transaction(), &transfer_20);
assert_eq!(confirmed_transactions[1].transaction(), &mint_10);
assert_eq!(confirmed_transactions[2].transaction(), &mint_20);
assert_eq!(confirmed_transactions[3].transaction(), &transfer_30);
}
// Starting Balance = 20
// Transfer_20 -> Balance = 20 - 20 = 0
// Transfer_10 -> Balance = 0 - 10 = -10 (should be rejected)
{
let transactions = [transfer_20.clone(), transfer_10.clone()];
let (_, confirmed_transactions, aborted_transaction_ids, _) =
vm.atomic_speculate(sample_finalize_state(1), None, vec![], None, transactions.iter()).unwrap();
// Assert that the accepted and rejected transactions are correct.
assert_eq!(confirmed_transactions.len(), 2);
assert!(aborted_transaction_ids.is_empty());
assert!(confirmed_transactions[0].is_accepted());
assert!(confirmed_transactions[1].is_rejected());
assert_eq!(confirmed_transactions[0].transaction(), &transfer_20);
assert_eq!(
confirmed_transactions[1],
reject(1, &transfer_10, confirmed_transactions[1].finalize_operations())
);
}
// Starting Balance = 20
// Mint_20 -> Balance = 20 + 20
// Transfer_30 -> Balance = 40 - 30 = 10
// Transfer_20 -> Balance = 10 - 20 = -10 (should be rejected)
// Transfer_10 -> Balance = 10 - 10 = 0
{
let transactions = [mint_20.clone(), transfer_30.clone(), transfer_20.clone(), transfer_10.clone()];
let (_, confirmed_transactions, aborted_transaction_ids, _) =
vm.atomic_speculate(sample_finalize_state(1), None, vec![], None, transactions.iter()).unwrap();
// Assert that the accepted and rejected transactions are correct.
assert_eq!(confirmed_transactions.len(), 4);
assert!(aborted_transaction_ids.is_empty());
assert!(confirmed_transactions[0].is_accepted());
assert!(confirmed_transactions[1].is_accepted());
assert!(confirmed_transactions[2].is_rejected());
assert!(confirmed_transactions[3].is_accepted());
assert_eq!(confirmed_transactions[0].transaction(), &mint_20);
assert_eq!(confirmed_transactions[1].transaction(), &transfer_30);
assert_eq!(
confirmed_transactions[2],
reject(2, &transfer_20, confirmed_transactions[2].finalize_operations())
);
assert_eq!(confirmed_transactions[3].transaction(), &transfer_10);
}
}
#[test]
fn test_finalize_catch_halt() {
let rng = &mut TestRng::default();
// Sample a private key, view key, and address for the caller.
let caller_private_key = test_helpers::sample_genesis_private_key(rng);
let caller_view_key = ViewKey::try_from(&caller_private_key).unwrap();
for finalize_logic in &[
"finalize ped_hash:
input r0 as u128.public;
hash.ped64 r0 into r1 as field;
set r1 into hashes[r0];",
"finalize ped_hash:
input r0 as u128.public;
div r0 0u128 into r1;",
] {
// Initialize the vm.
let vm = test_helpers::sample_vm_with_genesis_block(rng);
// Deploy a new program.
let genesis =
vm.block_store().get_block(&vm.block_store().get_block_hash(0).unwrap().unwrap()).unwrap().unwrap();
// Get the unspent records.
let mut unspent_records = genesis
.transitions()
.cloned()
.flat_map(Transition::into_records)
.map(|(_, record)| record)
.collect::<Vec<_>>();
// Create a program that will always cause a E::halt in the finalize execution.
let program_id = "testing.aleo";
let program = Program::<CurrentNetwork>::from_str(&format!(
"
program {program_id};
mapping hashes:
key as u128.public;
value as field.public;
function ped_hash:
input r0 as u128.public;
// hash.ped64 r0 into r1 as field; // <--- This will cause a E::halt.
async ped_hash r0 into r1;
output r1 as {program_id}/ped_hash.future;
{finalize_logic}"
))
.unwrap();
let credits = Some(unspent_records.pop().unwrap().decrypt(&caller_view_key).unwrap());
// Deploy the program.
let deployment_transaction = vm.deploy(&caller_private_key, &program, credits, 10, None, rng).unwrap();
// Construct the deployment block.
let deployment_block = sample_next_block(
&vm,
&caller_private_key,
&[deployment_transaction],
&genesis,
&mut unspent_records,
rng,
)
.unwrap();
// Add the deployment block to the VM.
vm.add_next_block(&deployment_block).unwrap();
// Construct a transaction that will cause a E::halt in the finalize execution.
let inputs = vec![Value::<CurrentNetwork>::from_str("1u128").unwrap()];
let transaction =
create_execution(&vm, caller_private_key, program_id, "ped_hash", inputs, &mut unspent_records, rng);
// Speculatively execute the transaction. Ensure that this call does not panic and returns a rejected transaction.
let (_, confirmed_transactions, aborted_transaction_ids, _) =
vm.speculate(sample_finalize_state(1), None, vec![], None, [transaction.clone()].iter()).unwrap();
assert!(aborted_transaction_ids.is_empty());
// Ensure that the transaction is rejected.
assert_eq!(confirmed_transactions.len(), 1);
assert!(transaction.is_execute());
if let Transaction::Execute(_, execution, fee) = transaction {
let fee_transaction = Transaction::from_fee(fee.unwrap()).unwrap();
let expected_confirmed_transaction = ConfirmedTransaction::RejectedExecute(
0,
fee_transaction,
Rejected::new_execution(execution),
vec![],
);
let confirmed_transaction = confirmed_transactions.iter().next().unwrap();
assert_eq!(confirmed_transaction, &expected_confirmed_transaction);
}
}
}
#[test]
fn test_rejected_transaction_should_not_update_storage() {
let rng = &mut TestRng::default();
// Sample a private key.
let private_key = test_helpers::sample_genesis_private_key(rng);
let address = Address::try_from(&private_key).unwrap();
// Initialize the vm.
let vm = test_helpers::sample_vm_with_genesis_block(rng);
// Deploy a new program.
let genesis =
vm.block_store().get_block(&vm.block_store().get_block_hash(0).unwrap().unwrap()).unwrap().unwrap();
// Get the unspent records.
let mut unspent_records = genesis
.transitions()
.cloned()
.flat_map(Transition::into_records)
.map(|(_, record)| record)
.collect::<Vec<_>>();
// Generate more records to use for the next block.
let splits_block = generate_splits(&vm, &private_key, &genesis, &mut unspent_records, rng).unwrap();
// Add the splits block to the VM.
vm.add_next_block(&splits_block).unwrap();
// Construct the deployment block.
let deployment_block = {
let program = Program::<CurrentNetwork>::from_str(
"
program testing.aleo;
mapping entries:
key as address.public;
value as u8.public;
function compute:
input r0 as u8.public;
async compute self.caller r0 into r1;
output r1 as testing.aleo/compute.future;
finalize compute:
input r0 as address.public;
input r1 as u8.public;
get.or_use entries[r0] r1 into r2;
add r1 r2 into r3;
set r3 into entries[r0];
get entries[r0] into r4;
add r4 r1 into r5;
set r5 into entries[r0];
",
)
.unwrap();
// Prepare the additional fee.
let view_key = ViewKey::<CurrentNetwork>::try_from(private_key).unwrap();
let credits = Some(unspent_records.pop().unwrap().decrypt(&view_key).unwrap());
// Deploy.
let transaction = vm.deploy(&private_key, &program, credits, 10, None, rng).unwrap();
// Construct the new block.
sample_next_block(&vm, &private_key, &[transaction], &splits_block, &mut unspent_records, rng).unwrap()
};
// Add the deployment block to the VM.
vm.add_next_block(&deployment_block).unwrap();
// Generate more records to use for the next block.
let splits_block = generate_splits(&vm, &private_key, &deployment_block, &mut unspent_records, rng).unwrap();
// Add the splits block to the VM.
vm.add_next_block(&splits_block).unwrap();
// Create an execution transaction, that will be rejected.
let r0 = Value::<CurrentNetwork>::from_str("100u8").unwrap();
let first = create_execution(&vm, private_key, "testing.aleo", "compute", vec![r0], &mut unspent_records, rng);
// Construct the next block.
let next_block =
sample_next_block(&vm, &private_key, &[first], &splits_block, &mut unspent_records, rng).unwrap();
// Check that the transaction was rejected.
assert!(next_block.transactions().iter().next().unwrap().is_rejected());
// Add the next block to the VM.
vm.add_next_block(&next_block).unwrap();
// Check that the storage was not updated.
let program_id = ProgramID::from_str("testing.aleo").unwrap();
let mapping_name = Identifier::from_str("entries").unwrap();
let value = vm
.finalize_store()
.get_value_speculative(program_id, mapping_name, &Plaintext::from(Literal::Address(address)))
.unwrap();
println!("{:?}", value);
assert!(
!vm.finalize_store()
.contains_key_confirmed(program_id, mapping_name, &Plaintext::from(Literal::Address(address)))
.unwrap()
);
// Create an execution transaction, that will be rejected.
let r0 = Value::<CurrentNetwork>::from_str("100u8").unwrap();
let first = create_execution(&vm, private_key, "testing.aleo", "compute", vec![r0], &mut unspent_records, rng);
// Create an execution transaction, that will be accepted.
let r0 = Value::<CurrentNetwork>::from_str("1u8").unwrap();
let second = create_execution(&vm, private_key, "testing.aleo", "compute", vec![r0], &mut unspent_records, rng);
// Construct the next block.
let next_block =
sample_next_block(&vm, &private_key, &[first, second], &next_block, &mut unspent_records, rng).unwrap();
// Check that the first transaction was rejected.
assert!(next_block.transactions().iter().next().unwrap().is_rejected());
// Add the next block to the VM.
vm.add_next_block(&next_block).unwrap();
// Check that the storage was updated correctly.
let value = vm
.finalize_store()
.get_value_speculative(program_id, mapping_name, &Plaintext::from(Literal::Address(address)))
.unwrap()
.unwrap();
let expected = Value::<CurrentNetwork>::from_str("3u8").unwrap();
assert_eq!(value, expected);
}
#[test]
fn test_excess_transactions_should_be_aborted() {
let rng = &mut TestRng::default();
// Sample a private key.
let caller_private_key = test_helpers::sample_genesis_private_key(rng);
let caller_address = Address::try_from(&caller_private_key).unwrap();
// Initialize the vm.
let vm = test_helpers::sample_vm_with_genesis_block(rng);
// Deploy a new program.
let genesis =
vm.block_store().get_block(&vm.block_store().get_block_hash(0).unwrap().unwrap()).unwrap().unwrap();
// Get the unspent records.
let mut unspent_records = genesis
.transitions()
.cloned()
.flat_map(Transition::into_records)
.map(|(_, record)| record)
.collect::<Vec<_>>();
// Construct the deployment block.
let (program_id, deployment_block) =
new_program_deployment(&vm, &caller_private_key, &genesis, &mut unspent_records, rng).unwrap();
// Add the deployment block to the VM.
vm.add_next_block(&deployment_block).unwrap();
// Generate more records to use for the next block.
let splits_block =
generate_splits(&vm, &caller_private_key, &deployment_block, &mut unspent_records, rng).unwrap();
// Add the splits block to the VM.
vm.add_next_block(&splits_block).unwrap();
// Generate more records to use for the next block.
let splits_block = generate_splits(&vm, &caller_private_key, &splits_block, &mut unspent_records, rng).unwrap();
// Add the splits block to the VM.
vm.add_next_block(&splits_block).unwrap();
// Generate the transactions.
let mut transactions = Vec::new();
let mut excess_transaction_ids = Vec::new();
for _ in 0..VM::<CurrentNetwork, ConsensusMemory<_>>::MAXIMUM_CONFIRMED_TRANSACTIONS + 1 {
let transaction =
sample_mint_public(&vm, caller_private_key, &program_id, caller_address, 10, &mut unspent_records, rng);
// Abort the transaction if the block is full.
if transactions.len() >= VM::<CurrentNetwork, ConsensusMemory<_>>::MAXIMUM_CONFIRMED_TRANSACTIONS {
excess_transaction_ids.push(transaction.id());
}
transactions.push(transaction);
}
// Construct the next block.
let next_block =
sample_next_block(&vm, &caller_private_key, &transactions, &splits_block, &mut unspent_records, rng)
.unwrap();
// Ensure that the excess transactions were aborted.
assert_eq!(next_block.aborted_transaction_ids(), &excess_transaction_ids);
assert_eq!(
next_block.transactions().len(),
VM::<CurrentNetwork, ConsensusMemory<_>>::MAXIMUM_CONFIRMED_TRANSACTIONS
);
}
}