snarkos_node_bft/primary.rs
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 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681
// Copyright 2024 Aleo Network Foundation
// This file is part of the snarkOS 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 crate::{
Gateway,
MAX_BATCH_DELAY_IN_MS,
MAX_WORKERS,
MIN_BATCH_DELAY_IN_SECS,
PRIMARY_PING_IN_MS,
Sync,
Transport,
WORKER_PING_IN_MS,
Worker,
events::{BatchPropose, BatchSignature, Event},
helpers::{
BFTSender,
PrimaryReceiver,
PrimarySender,
Proposal,
ProposalCache,
SignedProposals,
Storage,
assign_to_worker,
assign_to_workers,
fmt_id,
init_sync_channels,
init_worker_channels,
now,
},
spawn_blocking,
};
use snarkos_account::Account;
use snarkos_node_bft_events::PrimaryPing;
use snarkos_node_bft_ledger_service::LedgerService;
use snarkos_node_sync::DUMMY_SELF_IP;
use snarkvm::{
console::{
prelude::*,
types::{Address, Field},
},
ledger::{
block::Transaction,
narwhal::{BatchCertificate, BatchHeader, Data, Transmission, TransmissionID},
puzzle::{Solution, SolutionID},
},
prelude::committee::Committee,
};
use colored::Colorize;
use futures::stream::{FuturesUnordered, StreamExt};
use indexmap::{IndexMap, IndexSet};
use parking_lot::{Mutex, RwLock};
use rayon::prelude::*;
use std::{
collections::{HashMap, HashSet},
future::Future,
net::SocketAddr,
sync::Arc,
time::Duration,
};
use tokio::{
sync::{Mutex as TMutex, OnceCell},
task::JoinHandle,
};
/// A helper type for an optional proposed batch.
pub type ProposedBatch<N> = RwLock<Option<Proposal<N>>>;
#[derive(Clone)]
pub struct Primary<N: Network> {
/// The sync module.
sync: Sync<N>,
/// The gateway.
gateway: Gateway<N>,
/// The storage.
storage: Storage<N>,
/// The ledger service.
ledger: Arc<dyn LedgerService<N>>,
/// The workers.
workers: Arc<[Worker<N>]>,
/// The BFT sender.
bft_sender: Arc<OnceCell<BFTSender<N>>>,
/// The batch proposal, if the primary is currently proposing a batch.
proposed_batch: Arc<ProposedBatch<N>>,
/// The timestamp of the most recent proposed batch.
latest_proposed_batch_timestamp: Arc<RwLock<i64>>,
/// The recently-signed batch proposals.
signed_proposals: Arc<RwLock<SignedProposals<N>>>,
/// The spawned handles.
handles: Arc<Mutex<Vec<JoinHandle<()>>>>,
/// The lock for propose_batch.
propose_lock: Arc<TMutex<u64>>,
}
impl<N: Network> Primary<N> {
/// The maximum number of unconfirmed transmissions to send to the primary.
pub const MAX_TRANSMISSIONS_TOLERANCE: usize = BatchHeader::<N>::MAX_TRANSMISSIONS_PER_BATCH * 2;
/// Initializes a new primary instance.
pub fn new(
account: Account<N>,
storage: Storage<N>,
ledger: Arc<dyn LedgerService<N>>,
ip: Option<SocketAddr>,
trusted_validators: &[SocketAddr],
dev: Option<u16>,
) -> Result<Self> {
// Initialize the gateway.
let gateway = Gateway::new(account, storage.clone(), ledger.clone(), ip, trusted_validators, dev)?;
// Initialize the sync module.
let sync = Sync::new(gateway.clone(), storage.clone(), ledger.clone());
// Initialize the primary instance.
Ok(Self {
sync,
gateway,
storage,
ledger,
workers: Arc::from(vec![]),
bft_sender: Default::default(),
proposed_batch: Default::default(),
latest_proposed_batch_timestamp: Default::default(),
signed_proposals: Default::default(),
handles: Default::default(),
propose_lock: Default::default(),
})
}
/// Load the proposal cache file and update the Primary state with the stored data.
async fn load_proposal_cache(&self) -> Result<()> {
// Fetch the signed proposals from the file system if it exists.
match ProposalCache::<N>::exists(self.gateway.dev()) {
// If the proposal cache exists, then process the proposal cache.
true => match ProposalCache::<N>::load(self.gateway.account().address(), self.gateway.dev()) {
Ok(proposal_cache) => {
// Extract the proposal and signed proposals.
let (latest_certificate_round, proposed_batch, signed_proposals, pending_certificates) =
proposal_cache.into();
// Write the proposed batch.
*self.proposed_batch.write() = proposed_batch;
// Write the signed proposals.
*self.signed_proposals.write() = signed_proposals;
// Writ the propose lock.
*self.propose_lock.lock().await = latest_certificate_round;
// Update the storage with the pending certificates.
for certificate in pending_certificates {
let batch_id = certificate.batch_id();
// We use a dummy IP because the node should not need to request from any peers.
// The storage should have stored all the transmissions. If not, we simply
// skip the certificate.
if let Err(err) = self.sync_with_certificate_from_peer::<true>(DUMMY_SELF_IP, certificate).await
{
warn!("Failed to load stored certificate {} from proposal cache - {err}", fmt_id(batch_id));
}
}
Ok(())
}
Err(err) => {
bail!("Failed to read the signed proposals from the file system - {err}.");
}
},
// If the proposal cache does not exist, then return early.
false => Ok(()),
}
}
/// Run the primary instance.
pub async fn run(
&mut self,
bft_sender: Option<BFTSender<N>>,
primary_sender: PrimarySender<N>,
primary_receiver: PrimaryReceiver<N>,
) -> Result<()> {
info!("Starting the primary instance of the memory pool...");
// Set the BFT sender.
if let Some(bft_sender) = &bft_sender {
// Set the BFT sender in the primary.
self.bft_sender.set(bft_sender.clone()).expect("BFT sender already set");
}
// Construct a map of the worker senders.
let mut worker_senders = IndexMap::new();
// Construct a map for the workers.
let mut workers = Vec::new();
// Initialize the workers.
for id in 0..MAX_WORKERS {
// Construct the worker channels.
let (tx_worker, rx_worker) = init_worker_channels();
// Construct the worker instance.
let worker = Worker::new(
id,
Arc::new(self.gateway.clone()),
self.storage.clone(),
self.ledger.clone(),
self.proposed_batch.clone(),
)?;
// Run the worker instance.
worker.run(rx_worker);
// Add the worker to the list of workers.
workers.push(worker);
// Add the worker sender to the map.
worker_senders.insert(id, tx_worker);
}
// Set the workers.
self.workers = Arc::from(workers);
// First, initialize the sync channels.
let (sync_sender, sync_receiver) = init_sync_channels();
// Next, initialize the sync module and sync the storage from ledger.
self.sync.initialize(bft_sender).await?;
// Next, load and process the proposal cache before running the sync module.
self.load_proposal_cache().await?;
// Next, run the sync module.
self.sync.run(sync_receiver).await?;
// Next, initialize the gateway.
self.gateway.run(primary_sender, worker_senders, Some(sync_sender)).await;
// Lastly, start the primary handlers.
// Note: This ensures the primary does not start communicating before syncing is complete.
self.start_handlers(primary_receiver);
Ok(())
}
/// Returns the current round.
pub fn current_round(&self) -> u64 {
self.storage.current_round()
}
/// Returns `true` if the primary is synced.
pub fn is_synced(&self) -> bool {
self.sync.is_synced()
}
/// Returns the gateway.
pub const fn gateway(&self) -> &Gateway<N> {
&self.gateway
}
/// Returns the storage.
pub const fn storage(&self) -> &Storage<N> {
&self.storage
}
/// Returns the ledger.
pub const fn ledger(&self) -> &Arc<dyn LedgerService<N>> {
&self.ledger
}
/// Returns the number of workers.
pub fn num_workers(&self) -> u8 {
u8::try_from(self.workers.len()).expect("Too many workers")
}
/// Returns the workers.
pub const fn workers(&self) -> &Arc<[Worker<N>]> {
&self.workers
}
/// Returns the batch proposal of our primary, if one currently exists.
pub fn proposed_batch(&self) -> &Arc<ProposedBatch<N>> {
&self.proposed_batch
}
}
impl<N: Network> Primary<N> {
/// Returns the number of unconfirmed transmissions.
pub fn num_unconfirmed_transmissions(&self) -> usize {
self.workers.iter().map(|worker| worker.num_transmissions()).sum()
}
/// Returns the number of unconfirmed ratifications.
pub fn num_unconfirmed_ratifications(&self) -> usize {
self.workers.iter().map(|worker| worker.num_ratifications()).sum()
}
/// Returns the number of solutions.
pub fn num_unconfirmed_solutions(&self) -> usize {
self.workers.iter().map(|worker| worker.num_solutions()).sum()
}
/// Returns the number of unconfirmed transactions.
pub fn num_unconfirmed_transactions(&self) -> usize {
self.workers.iter().map(|worker| worker.num_transactions()).sum()
}
}
impl<N: Network> Primary<N> {
/// Returns the worker transmission IDs.
pub fn worker_transmission_ids(&self) -> impl '_ + Iterator<Item = TransmissionID<N>> {
self.workers.iter().flat_map(|worker| worker.transmission_ids())
}
/// Returns the worker transmissions.
pub fn worker_transmissions(&self) -> impl '_ + Iterator<Item = (TransmissionID<N>, Transmission<N>)> {
self.workers.iter().flat_map(|worker| worker.transmissions())
}
/// Returns the worker solutions.
pub fn worker_solutions(&self) -> impl '_ + Iterator<Item = (SolutionID<N>, Data<Solution<N>>)> {
self.workers.iter().flat_map(|worker| worker.solutions())
}
/// Returns the worker transactions.
pub fn worker_transactions(&self) -> impl '_ + Iterator<Item = (N::TransactionID, Data<Transaction<N>>)> {
self.workers.iter().flat_map(|worker| worker.transactions())
}
}
impl<N: Network> Primary<N> {
/// Clears the worker solutions.
pub fn clear_worker_solutions(&self) {
self.workers.iter().for_each(Worker::clear_solutions);
}
}
impl<N: Network> Primary<N> {
/// Proposes the batch for the current round.
///
/// This method performs the following steps:
/// 1. Drain the workers.
/// 2. Sign the batch.
/// 3. Set the batch proposal in the primary.
/// 4. Broadcast the batch header to all validators for signing.
pub async fn propose_batch(&self) -> Result<()> {
// This function isn't re-entrant.
let mut lock_guard = self.propose_lock.lock().await;
// Check if the proposed batch has expired, and clear it if it has expired.
if let Err(e) = self.check_proposed_batch_for_expiration().await {
warn!("Failed to check the proposed batch for expiration - {e}");
return Ok(());
}
// Retrieve the current round.
let round = self.current_round();
// Compute the previous round.
let previous_round = round.saturating_sub(1);
// If the current round is 0, return early.
ensure!(round > 0, "Round 0 cannot have transaction batches");
// If the current storage round is below the latest proposal round, then return early.
if round < *lock_guard {
warn!("Cannot propose a batch for round {round} - the latest proposal cache round is {}", *lock_guard);
return Ok(());
}
// If there is a batch being proposed already,
// rebroadcast the batch header to the non-signers, and return early.
if let Some(proposal) = self.proposed_batch.read().as_ref() {
// Ensure that the storage is caught up to the proposal before proceeding to rebroadcast this.
if round < proposal.round()
|| proposal
.batch_header()
.previous_certificate_ids()
.iter()
.any(|id| !self.storage.contains_certificate(*id))
{
warn!(
"Cannot propose a batch for round {} - the current storage (round {round}) is not caught up to the proposed batch.",
proposal.round(),
);
return Ok(());
}
// Construct the event.
// TODO(ljedrz): the BatchHeader should be serialized only once in advance before being sent to non-signers.
let event = Event::BatchPropose(proposal.batch_header().clone().into());
// Iterate through the non-signers.
for address in proposal.nonsigners(&self.ledger.get_committee_lookback_for_round(proposal.round())?) {
// Resolve the address to the peer IP.
match self.gateway.resolver().get_peer_ip_for_address(address) {
// Resend the batch proposal to the validator for signing.
Some(peer_ip) => {
let (gateway, event_, round) = (self.gateway.clone(), event.clone(), proposal.round());
tokio::spawn(async move {
debug!("Resending batch proposal for round {round} to peer '{peer_ip}'");
// Resend the batch proposal to the peer.
if gateway.send(peer_ip, event_).await.is_none() {
warn!("Failed to resend batch proposal for round {round} to peer '{peer_ip}'");
}
});
}
None => continue,
}
}
debug!("Proposed batch for round {} is still valid", proposal.round());
return Ok(());
}
#[cfg(feature = "metrics")]
metrics::gauge(metrics::bft::PROPOSAL_ROUND, round as f64);
// Ensure that the primary does not create a new proposal too quickly.
if let Err(e) = self.check_proposal_timestamp(previous_round, self.gateway.account().address(), now()) {
debug!("Primary is safely skipping a batch proposal - {}", format!("{e}").dimmed());
return Ok(());
}
// Ensure the primary has not proposed a batch for this round before.
if self.storage.contains_certificate_in_round_from(round, self.gateway.account().address()) {
// If a BFT sender was provided, attempt to advance the current round.
if let Some(bft_sender) = self.bft_sender.get() {
match bft_sender.send_primary_round_to_bft(self.current_round()).await {
// 'is_ready' is true if the primary is ready to propose a batch for the next round.
Ok(true) => (), // continue,
// 'is_ready' is false if the primary is not ready to propose a batch for the next round.
Ok(false) => return Ok(()),
// An error occurred while attempting to advance the current round.
Err(e) => {
warn!("Failed to update the BFT to the next round - {e}");
return Err(e);
}
}
}
debug!("Primary is safely skipping {}", format!("(round {round} was already certified)").dimmed());
return Ok(());
}
// Determine if the current round has been proposed.
// Note: Do NOT make this judgment in advance before rebroadcast and round update. Rebroadcasting is
// good for network reliability and should not be prevented for the already existing proposed_batch.
// If a certificate already exists for the current round, an attempt should be made to advance the
// round as early as possible.
if round == *lock_guard {
warn!("Primary is safely skipping a batch proposal - round {round} already proposed");
return Ok(());
}
// Retrieve the committee to check against.
let committee_lookback = self.ledger.get_committee_lookback_for_round(round)?;
// Check if the primary is connected to enough validators to reach quorum threshold.
{
// Retrieve the connected validator addresses.
let mut connected_validators = self.gateway.connected_addresses();
// Append the primary to the set.
connected_validators.insert(self.gateway.account().address());
// If quorum threshold is not reached, return early.
if !committee_lookback.is_quorum_threshold_reached(&connected_validators) {
debug!(
"Primary is safely skipping a batch proposal {}",
"(please connect to more validators)".dimmed()
);
trace!("Primary is connected to {} validators", connected_validators.len() - 1);
return Ok(());
}
}
// Retrieve the previous certificates.
let previous_certificates = self.storage.get_certificates_for_round(previous_round);
// Check if the batch is ready to be proposed.
// Note: The primary starts at round 1, and round 0 contains no certificates, by definition.
let mut is_ready = previous_round == 0;
// If the previous round is not 0, check if the previous certificates have reached the quorum threshold.
if previous_round > 0 {
// Retrieve the committee lookback for the round.
let Ok(previous_committee_lookback) = self.ledger.get_committee_lookback_for_round(previous_round) else {
bail!("Cannot propose a batch for round {round}: the committee lookback is not known yet")
};
// Construct a set over the authors.
let authors = previous_certificates.iter().map(BatchCertificate::author).collect();
// Check if the previous certificates have reached the quorum threshold.
if previous_committee_lookback.is_quorum_threshold_reached(&authors) {
is_ready = true;
}
}
// If the batch is not ready to be proposed, return early.
if !is_ready {
debug!(
"Primary is safely skipping a batch proposal {}",
format!("(previous round {previous_round} has not reached quorum)").dimmed()
);
return Ok(());
}
// Determined the required number of transmissions per worker.
let num_transmissions_per_worker = BatchHeader::<N>::MAX_TRANSMISSIONS_PER_BATCH / self.num_workers() as usize;
// Initialize the map of transmissions.
let mut transmissions: IndexMap<_, _> = Default::default();
// Take the transmissions from the workers.
for worker in self.workers.iter() {
// Initialize a tracker for included transmissions for the current worker.
let mut num_transmissions_included_for_worker = 0;
// Keep draining the worker until the desired number of transmissions is reached or the worker is empty.
'outer: while num_transmissions_included_for_worker < num_transmissions_per_worker {
// Determine the number of remaining transmissions for the worker.
let num_remaining_transmissions =
num_transmissions_per_worker.saturating_sub(num_transmissions_included_for_worker);
// Drain the worker.
let mut worker_transmissions = worker.drain(num_remaining_transmissions).peekable();
// If the worker is empty, break early.
if worker_transmissions.peek().is_none() {
break 'outer;
}
// Iterate through the worker transmissions.
'inner: for (id, transmission) in worker_transmissions {
// Check if the ledger already contains the transmission.
if self.ledger.contains_transmission(&id).unwrap_or(true) {
trace!("Proposing - Skipping transmission '{}' - Already in ledger", fmt_id(id));
continue 'inner;
}
// Check if the storage already contain the transmission.
// Note: We do not skip if this is the first transmission in the proposal, to ensure that
// the primary does not propose a batch with no transmissions.
if !transmissions.is_empty() && self.storage.contains_transmission(id) {
trace!("Proposing - Skipping transmission '{}' - Already in storage", fmt_id(id));
continue 'inner;
}
// Check the transmission is still valid.
match (id, transmission.clone()) {
(TransmissionID::Solution(solution_id, checksum), Transmission::Solution(solution)) => {
// Ensure the checksum matches.
match solution.to_checksum::<N>() {
Ok(solution_checksum) if solution_checksum == checksum => (),
_ => {
trace!(
"Proposing - Skipping solution '{}' - Checksum mismatch",
fmt_id(solution_id)
);
continue 'inner;
}
}
// Check if the solution is still valid.
if let Err(e) = self.ledger.check_solution_basic(solution_id, solution).await {
trace!("Proposing - Skipping solution '{}' - {e}", fmt_id(solution_id));
continue 'inner;
}
}
(
TransmissionID::Transaction(transaction_id, checksum),
Transmission::Transaction(transaction),
) => {
// Ensure the checksum matches.
match transaction.to_checksum::<N>() {
Ok(transaction_checksum) if transaction_checksum == checksum => (),
_ => {
trace!(
"Proposing - Skipping transaction '{}' - Checksum mismatch",
fmt_id(transaction_id)
);
continue 'inner;
}
}
// Check if the transaction is still valid.
if let Err(e) = self.ledger.check_transaction_basic(transaction_id, transaction).await {
trace!("Proposing - Skipping transaction '{}' - {e}", fmt_id(transaction_id));
continue 'inner;
}
}
// Note: We explicitly forbid including ratifications,
// as the protocol currently does not support ratifications.
(TransmissionID::Ratification, Transmission::Ratification) => continue,
// All other combinations are clearly invalid.
_ => continue 'inner,
}
// Insert the transmission into the map.
transmissions.insert(id, transmission);
num_transmissions_included_for_worker += 1;
}
}
}
// Determine the current timestamp.
let current_timestamp = now();
*lock_guard = round;
/* Proceeding to sign & propose the batch. */
info!("Proposing a batch with {} transmissions for round {round}...", transmissions.len());
// Retrieve the private key.
let private_key = *self.gateway.account().private_key();
// Retrieve the committee ID.
let committee_id = committee_lookback.id();
// Prepare the transmission IDs.
let transmission_ids = transmissions.keys().copied().collect();
// Prepare the previous batch certificate IDs.
let previous_certificate_ids = previous_certificates.into_iter().map(|c| c.id()).collect();
// Sign the batch header and construct the proposal.
let (batch_header, proposal) = spawn_blocking!(BatchHeader::new(
&private_key,
round,
current_timestamp,
committee_id,
transmission_ids,
previous_certificate_ids,
&mut rand::thread_rng()
))
.and_then(|batch_header| {
Proposal::new(committee_lookback, batch_header.clone(), transmissions.clone())
.map(|proposal| (batch_header, proposal))
})
.inspect_err(|_| {
// On error, reinsert the transmissions and then propagate the error.
if let Err(e) = self.reinsert_transmissions_into_workers(transmissions) {
error!("Failed to reinsert transmissions: {e:?}");
}
})?;
// Broadcast the batch to all validators for signing.
self.gateway.broadcast(Event::BatchPropose(batch_header.into()));
// Set the timestamp of the latest proposed batch.
*self.latest_proposed_batch_timestamp.write() = proposal.timestamp();
// Set the proposed batch.
*self.proposed_batch.write() = Some(proposal);
Ok(())
}
/// Processes a batch propose from a peer.
///
/// This method performs the following steps:
/// 1. Verify the batch.
/// 2. Sign the batch.
/// 3. Broadcast the signature back to the validator.
///
/// If our primary is ahead of the peer, we will not sign the batch.
/// If our primary is behind the peer, but within GC range, we will sync up to the peer's round, and then sign the batch.
async fn process_batch_propose_from_peer(&self, peer_ip: SocketAddr, batch_propose: BatchPropose<N>) -> Result<()> {
let BatchPropose { round: batch_round, batch_header } = batch_propose;
// Deserialize the batch header.
let batch_header = spawn_blocking!(batch_header.deserialize_blocking())?;
// Ensure the round matches in the batch header.
if batch_round != batch_header.round() {
// Proceed to disconnect the validator.
self.gateway.disconnect(peer_ip);
bail!("Malicious peer - proposed round {batch_round}, but sent batch for round {}", batch_header.round());
}
// Retrieve the batch author.
let batch_author = batch_header.author();
// Ensure the batch proposal is from the validator.
match self.gateway.resolver().get_address(peer_ip) {
// If the peer is a validator, then ensure the batch proposal is from the validator.
Some(address) => {
if address != batch_author {
// Proceed to disconnect the validator.
self.gateway.disconnect(peer_ip);
bail!("Malicious peer - proposed batch from a different validator ({batch_author})");
}
}
None => bail!("Batch proposal from a disconnected validator"),
}
// Ensure the batch author is a current committee member.
if !self.gateway.is_authorized_validator_address(batch_author) {
// Proceed to disconnect the validator.
self.gateway.disconnect(peer_ip);
bail!("Malicious peer - proposed batch from a non-committee member ({batch_author})");
}
// Ensure the batch proposal is not from the current primary.
if self.gateway.account().address() == batch_author {
bail!("Invalid peer - proposed batch from myself ({batch_author})");
}
// Ensure that the batch proposal's committee ID matches the expected committee ID.
let expected_committee_id = self.ledger.get_committee_lookback_for_round(batch_round)?.id();
if expected_committee_id != batch_header.committee_id() {
// Proceed to disconnect the validator.
self.gateway.disconnect(peer_ip);
bail!(
"Malicious peer - proposed batch has a different committee ID ({expected_committee_id} != {})",
batch_header.committee_id()
);
}
// Retrieve the cached round and batch ID for this validator.
if let Some((signed_round, signed_batch_id, signature)) =
self.signed_proposals.read().get(&batch_author).copied()
{
// If the signed round is ahead of the peer's batch round, then the validator is malicious.
if signed_round > batch_header.round() {
bail!("Peer ({batch_author}) proposed a batch for a previous round ({})", batch_header.round());
}
// If the round matches and the batch ID differs, then the validator is malicious.
if signed_round == batch_header.round() && signed_batch_id != batch_header.batch_id() {
bail!("Peer ({batch_author}) proposed another batch for the same round ({signed_round})");
}
// If the round and batch ID matches, then skip signing the batch a second time.
// Instead, rebroadcast the cached signature to the peer.
if signed_round == batch_header.round() && signed_batch_id == batch_header.batch_id() {
let gateway = self.gateway.clone();
tokio::spawn(async move {
debug!("Resending a signature for a batch in round {batch_round} from '{peer_ip}'");
let event = Event::BatchSignature(BatchSignature::new(batch_header.batch_id(), signature));
// Resend the batch signature to the peer.
if gateway.send(peer_ip, event).await.is_none() {
warn!("Failed to resend a signature for a batch in round {batch_round} to '{peer_ip}'");
}
});
// Return early.
return Ok(());
}
}
// Ensure that the batch header doesn't already exist in storage.
// Note this is already checked in `check_batch_header`, however we can return early here without creating a blocking task.
if self.storage.contains_batch(batch_header.batch_id()) {
debug!(
"Primary is safely skipping a batch proposal from '{peer_ip}' - {}",
format!("batch for round {batch_round} already exists in storage").dimmed()
);
return Ok(());
}
// Compute the previous round.
let previous_round = batch_round.saturating_sub(1);
// Ensure that the peer did not propose a batch too quickly.
if let Err(e) = self.check_proposal_timestamp(previous_round, batch_author, batch_header.timestamp()) {
// Proceed to disconnect the validator.
self.gateway.disconnect(peer_ip);
bail!("Malicious peer - {e} from '{peer_ip}'");
}
// If the peer is ahead, use the batch header to sync up to the peer.
let mut missing_transmissions = self.sync_with_batch_header_from_peer::<false>(peer_ip, &batch_header).await?;
// Check that the transmission ids match and are not fee transactions.
if let Err(err) = cfg_iter_mut!(missing_transmissions).try_for_each(|(transmission_id, transmission)| {
// If the transmission is not well-formed, then return early.
self.ledger.ensure_transmission_is_well_formed(*transmission_id, transmission)
}) {
debug!("Batch propose from '{peer_ip}' contains an invalid transmission - {err}",);
return Ok(());
}
// Ensure the batch is for the current round.
// This method must be called after fetching previous certificates (above),
// and prior to checking the batch header (below).
if let Err(e) = self.ensure_is_signing_round(batch_round) {
// If the primary is not signing for the peer's round, then return early.
debug!("{e} from '{peer_ip}'");
return Ok(());
}
// Ensure the batch header from the peer is valid.
let (storage, header) = (self.storage.clone(), batch_header.clone());
let missing_transmissions =
spawn_blocking!(storage.check_batch_header(&header, missing_transmissions, Default::default()))?;
// Inserts the missing transmissions into the workers.
self.insert_missing_transmissions_into_workers(peer_ip, missing_transmissions.into_iter())?;
/* Proceeding to sign the batch. */
// Retrieve the batch ID.
let batch_id = batch_header.batch_id();
// Sign the batch ID.
let account = self.gateway.account().clone();
let signature = spawn_blocking!(account.sign(&[batch_id], &mut rand::thread_rng()))?;
// Ensure the proposal has not already been signed.
//
// Note: Due to the need to sync the batch header with the peer, it is possible
// for the primary to receive the same 'BatchPropose' event again, whereby only
// one instance of this handler should sign the batch. This check guarantees this.
match self.signed_proposals.write().0.entry(batch_author) {
std::collections::hash_map::Entry::Occupied(mut entry) => {
// If the validator has already signed a batch for this round, then return early,
// since, if the peer still has not received the signature, they will request it again,
// and the logic at the start of this function will resend the (now cached) signature
// to the peer if asked to sign this batch proposal again.
if entry.get().0 == batch_round {
return Ok(());
}
// Otherwise, cache the round, batch ID, and signature for this validator.
entry.insert((batch_round, batch_id, signature));
}
// If the validator has not signed a batch before, then continue.
std::collections::hash_map::Entry::Vacant(entry) => {
// Cache the round, batch ID, and signature for this validator.
entry.insert((batch_round, batch_id, signature));
}
};
// Broadcast the signature back to the validator.
let self_ = self.clone();
tokio::spawn(async move {
let event = Event::BatchSignature(BatchSignature::new(batch_id, signature));
// Send the batch signature to the peer.
if self_.gateway.send(peer_ip, event).await.is_some() {
debug!("Signed a batch for round {batch_round} from '{peer_ip}'");
}
});
Ok(())
}
/// Processes a batch signature from a peer.
///
/// This method performs the following steps:
/// 1. Ensure the proposed batch has not expired.
/// 2. Verify the signature, ensuring it corresponds to the proposed batch.
/// 3. Store the signature.
/// 4. Certify the batch if enough signatures have been received.
/// 5. Broadcast the batch certificate to all validators.
async fn process_batch_signature_from_peer(
&self,
peer_ip: SocketAddr,
batch_signature: BatchSignature<N>,
) -> Result<()> {
// Ensure the proposed batch has not expired, and clear the proposed batch if it has expired.
self.check_proposed_batch_for_expiration().await?;
// Retrieve the signature and timestamp.
let BatchSignature { batch_id, signature } = batch_signature;
// Retrieve the signer.
let signer = signature.to_address();
// Ensure the batch signature is signed by the validator.
if self.gateway.resolver().get_address(peer_ip).map_or(true, |address| address != signer) {
// Proceed to disconnect the validator.
self.gateway.disconnect(peer_ip);
bail!("Malicious peer - batch signature is from a different validator ({signer})");
}
// Ensure the batch signature is not from the current primary.
if self.gateway.account().address() == signer {
bail!("Invalid peer - received a batch signature from myself ({signer})");
}
let self_ = self.clone();
let Some(proposal) = spawn_blocking!({
// Acquire the write lock.
let mut proposed_batch = self_.proposed_batch.write();
// Add the signature to the batch, and determine if the batch is ready to be certified.
match proposed_batch.as_mut() {
Some(proposal) => {
// Ensure the batch ID matches the currently proposed batch ID.
if proposal.batch_id() != batch_id {
match self_.storage.contains_batch(batch_id) {
// If this batch was already certified, return early.
true => {
debug!(
"Primary is safely skipping a a batch signature from {peer_ip} for round {} - batch is already certified",
proposal.round()
);
return Ok(None);
}
// If the batch ID is unknown, return an error.
false => bail!(
"Unknown batch ID '{batch_id}', expected '{}' for round {}",
proposal.batch_id(),
proposal.round()
),
}
}
// Retrieve the committee lookback for the round.
let committee_lookback = self_.ledger.get_committee_lookback_for_round(proposal.round())?;
// Retrieve the address of the validator.
let Some(signer) = self_.gateway.resolver().get_address(peer_ip) else {
bail!("Signature is from a disconnected validator");
};
// Add the signature to the batch.
proposal.add_signature(signer, signature, &committee_lookback)?;
info!("Received a batch signature for round {} from '{peer_ip}'", proposal.round());
// Check if the batch is ready to be certified.
if !proposal.is_quorum_threshold_reached(&committee_lookback) {
// If the batch is not ready to be certified, return early.
return Ok(None);
}
}
// There is no proposed batch, so return early.
None => return Ok(None),
};
// Retrieve the batch proposal, clearing the proposed batch.
match proposed_batch.take() {
Some(proposal) => Ok(Some(proposal)),
None => Ok(None),
}
})?
else {
return Ok(());
};
/* Proceeding to certify the batch. */
info!("Quorum threshold reached - Preparing to certify our batch for round {}...", proposal.round());
// Retrieve the committee lookback for the round.
let committee_lookback = self.ledger.get_committee_lookback_for_round(proposal.round())?;
// Store the certified batch and broadcast it to all validators.
// If there was an error storing the certificate, reinsert the transmissions back into the ready queue.
if let Err(e) = self.store_and_broadcast_certificate(&proposal, &committee_lookback).await {
// Reinsert the transmissions back into the ready queue for the next proposal.
self.reinsert_transmissions_into_workers(proposal.into_transmissions())?;
return Err(e);
}
#[cfg(feature = "metrics")]
metrics::increment_gauge(metrics::bft::CERTIFIED_BATCHES, 1.0);
Ok(())
}
/// Processes a batch certificate from a peer.
///
/// This method performs the following steps:
/// 1. Stores the given batch certificate, after ensuring it is valid.
/// 2. If there are enough certificates to reach quorum threshold for the current round,
/// then proceed to advance to the next round.
async fn process_batch_certificate_from_peer(
&self,
peer_ip: SocketAddr,
certificate: BatchCertificate<N>,
) -> Result<()> {
// Ensure the batch certificate is from an authorized validator.
if !self.gateway.is_authorized_validator_ip(peer_ip) {
// Proceed to disconnect the validator.
self.gateway.disconnect(peer_ip);
bail!("Malicious peer - Received a batch certificate from an unauthorized validator IP ({peer_ip})");
}
// Ensure storage does not already contain the certificate.
if self.storage.contains_certificate(certificate.id()) {
return Ok(());
// Otherwise, ensure ephemeral storage contains the certificate.
} else if !self.storage.contains_unprocessed_certificate(certificate.id()) {
self.storage.insert_unprocessed_certificate(certificate.clone())?;
}
// Retrieve the batch certificate author.
let author = certificate.author();
// Retrieve the batch certificate round.
let certificate_round = certificate.round();
// Retrieve the batch certificate committee ID.
let committee_id = certificate.committee_id();
// Ensure the batch certificate is not from the current primary.
if self.gateway.account().address() == author {
bail!("Received a batch certificate for myself ({author})");
}
// Store the certificate, after ensuring it is valid.
self.sync_with_certificate_from_peer::<false>(peer_ip, certificate).await?;
// If there are enough certificates to reach quorum threshold for the certificate round,
// then proceed to advance to the next round.
// Retrieve the committee lookback.
let committee_lookback = self.ledger.get_committee_lookback_for_round(certificate_round)?;
// Retrieve the certificate authors.
let authors = self.storage.get_certificate_authors_for_round(certificate_round);
// Check if the certificates have reached the quorum threshold.
let is_quorum = committee_lookback.is_quorum_threshold_reached(&authors);
// Ensure that the batch certificate's committee ID matches the expected committee ID.
let expected_committee_id = committee_lookback.id();
if expected_committee_id != committee_id {
// Proceed to disconnect the validator.
self.gateway.disconnect(peer_ip);
bail!("Batch certificate has a different committee ID ({expected_committee_id} != {committee_id})");
}
// Determine if we are currently proposing a round that is relevant.
// Note: This is important, because while our peers have advanced,
// they may not be proposing yet, and thus still able to sign our proposed batch.
let should_advance = match &*self.proposed_batch.read() {
// We advance if the proposal round is less than the current round that was just certified.
Some(proposal) => proposal.round() < certificate_round,
// If there's no proposal, we consider advancing.
None => true,
};
// Retrieve the current round.
let current_round = self.current_round();
// Determine whether to advance to the next round.
if is_quorum && should_advance && certificate_round >= current_round {
// If we have reached the quorum threshold and the round should advance, then proceed to the next round.
self.try_increment_to_the_next_round(current_round + 1).await?;
}
Ok(())
}
}
impl<N: Network> Primary<N> {
/// Starts the primary handlers.
fn start_handlers(&self, primary_receiver: PrimaryReceiver<N>) {
let PrimaryReceiver {
mut rx_batch_propose,
mut rx_batch_signature,
mut rx_batch_certified,
mut rx_primary_ping,
mut rx_unconfirmed_solution,
mut rx_unconfirmed_transaction,
} = primary_receiver;
// Start the primary ping.
if self.sync.is_gateway_mode() {
let self_ = self.clone();
self.spawn(async move {
loop {
// Sleep briefly.
tokio::time::sleep(Duration::from_millis(PRIMARY_PING_IN_MS)).await;
// Retrieve the block locators.
let self__ = self_.clone();
let block_locators = match spawn_blocking!(self__.sync.get_block_locators()) {
Ok(block_locators) => block_locators,
Err(e) => {
warn!("Failed to retrieve block locators - {e}");
continue;
}
};
// Retrieve the latest certificate of the primary.
let primary_certificate = {
// Retrieve the primary address.
let primary_address = self_.gateway.account().address();
// Iterate backwards from the latest round to find the primary certificate.
let mut certificate = None;
let mut current_round = self_.current_round();
while certificate.is_none() {
// If the current round is 0, then break the while loop.
if current_round == 0 {
break;
}
// Retrieve the primary certificates.
if let Some(primary_certificate) =
self_.storage.get_certificate_for_round_with_author(current_round, primary_address)
{
certificate = Some(primary_certificate);
// If the primary certificate was not found, decrement the round.
} else {
current_round = current_round.saturating_sub(1);
}
}
// Determine if the primary certificate was found.
match certificate {
Some(certificate) => certificate,
// Skip this iteration of the loop (do not send a primary ping).
None => continue,
}
};
// Construct the primary ping.
let primary_ping = PrimaryPing::from((<Event<N>>::VERSION, block_locators, primary_certificate));
// Broadcast the event.
self_.gateway.broadcast(Event::PrimaryPing(primary_ping));
}
});
}
// Start the primary ping handler.
let self_ = self.clone();
self.spawn(async move {
while let Some((peer_ip, primary_certificate)) = rx_primary_ping.recv().await {
// If the primary is not synced, then do not process the primary ping.
if !self_.sync.is_synced() {
trace!("Skipping a primary ping from '{peer_ip}' {}", "(node is syncing)".dimmed());
continue;
}
// Spawn a task to process the primary certificate.
{
let self_ = self_.clone();
tokio::spawn(async move {
// Deserialize the primary certificate in the primary ping.
let Ok(primary_certificate) = spawn_blocking!(primary_certificate.deserialize_blocking())
else {
warn!("Failed to deserialize primary certificate in 'PrimaryPing' from '{peer_ip}'");
return;
};
// Process the primary certificate.
if let Err(e) = self_.process_batch_certificate_from_peer(peer_ip, primary_certificate).await {
warn!("Cannot process a primary certificate in a 'PrimaryPing' from '{peer_ip}' - {e}");
}
});
}
}
});
// Start the worker ping(s).
if self.sync.is_gateway_mode() {
let self_ = self.clone();
self.spawn(async move {
loop {
tokio::time::sleep(Duration::from_millis(WORKER_PING_IN_MS)).await;
// If the primary is not synced, then do not broadcast the worker ping(s).
if !self_.sync.is_synced() {
trace!("Skipping worker ping(s) {}", "(node is syncing)".dimmed());
continue;
}
// Broadcast the worker ping(s).
for worker in self_.workers.iter() {
worker.broadcast_ping();
}
}
});
}
// Start the batch proposer.
let self_ = self.clone();
self.spawn(async move {
loop {
// Sleep briefly, but longer than if there were no batch.
tokio::time::sleep(Duration::from_millis(MAX_BATCH_DELAY_IN_MS)).await;
// If the primary is not synced, then do not propose a batch.
if !self_.sync.is_synced() {
debug!("Skipping batch proposal {}", "(node is syncing)".dimmed());
continue;
}
// A best-effort attempt to skip the scheduled batch proposal if
// round progression already triggered one.
if self_.propose_lock.try_lock().is_err() {
trace!("Skipping batch proposal {}", "(node is already proposing)".dimmed());
continue;
};
// If there is no proposed batch, attempt to propose a batch.
// Note: Do NOT spawn a task around this function call. Proposing a batch is a critical path,
// and only one batch needs be proposed at a time.
if let Err(e) = self_.propose_batch().await {
warn!("Cannot propose a batch - {e}");
}
}
});
// Process the proposed batch.
let self_ = self.clone();
self.spawn(async move {
while let Some((peer_ip, batch_propose)) = rx_batch_propose.recv().await {
// If the primary is not synced, then do not sign the batch.
if !self_.sync.is_synced() {
trace!("Skipping a batch proposal from '{peer_ip}' {}", "(node is syncing)".dimmed());
continue;
}
// Spawn a task to process the proposed batch.
let self_ = self_.clone();
tokio::spawn(async move {
// Process the batch proposal.
if let Err(e) = self_.process_batch_propose_from_peer(peer_ip, batch_propose).await {
warn!("Cannot sign a batch from '{peer_ip}' - {e}");
}
});
}
});
// Process the batch signature.
let self_ = self.clone();
self.spawn(async move {
while let Some((peer_ip, batch_signature)) = rx_batch_signature.recv().await {
// If the primary is not synced, then do not store the signature.
if !self_.sync.is_synced() {
trace!("Skipping a batch signature from '{peer_ip}' {}", "(node is syncing)".dimmed());
continue;
}
// Process the batch signature.
// Note: Do NOT spawn a task around this function call. Processing signatures from peers
// is a critical path, and we should only store the minimum required number of signatures.
// In addition, spawning a task can cause concurrent processing of signatures (even with a lock),
// which means the RwLock for the proposed batch must become a 'tokio::sync' to be safe.
if let Err(e) = self_.process_batch_signature_from_peer(peer_ip, batch_signature).await {
warn!("Cannot store a signature from '{peer_ip}' - {e}");
}
}
});
// Process the certified batch.
let self_ = self.clone();
self.spawn(async move {
while let Some((peer_ip, batch_certificate)) = rx_batch_certified.recv().await {
// If the primary is not synced, then do not store the certificate.
if !self_.sync.is_synced() {
trace!("Skipping a certified batch from '{peer_ip}' {}", "(node is syncing)".dimmed());
continue;
}
// Spawn a task to process the batch certificate.
let self_ = self_.clone();
tokio::spawn(async move {
// Deserialize the batch certificate.
let Ok(batch_certificate) = spawn_blocking!(batch_certificate.deserialize_blocking()) else {
warn!("Failed to deserialize the batch certificate from '{peer_ip}'");
return;
};
// Process the batch certificate.
if let Err(e) = self_.process_batch_certificate_from_peer(peer_ip, batch_certificate).await {
warn!("Cannot store a certificate from '{peer_ip}' - {e}");
}
});
}
});
// Periodically try to increment to the next round.
// Note: This is necessary to ensure that the primary is not stuck on a previous round
// despite having received enough certificates to advance to the next round.
let self_ = self.clone();
self.spawn(async move {
loop {
// Sleep briefly.
tokio::time::sleep(Duration::from_millis(MAX_BATCH_DELAY_IN_MS)).await;
// If the primary is not synced, then do not increment to the next round.
if !self_.sync.is_synced() {
trace!("Skipping round increment {}", "(node is syncing)".dimmed());
continue;
}
// Attempt to increment to the next round.
let next_round = self_.current_round().saturating_add(1);
// Determine if the quorum threshold is reached for the current round.
let is_quorum_threshold_reached = {
// Retrieve the certificate authors for the next round.
let authors = self_.storage.get_certificate_authors_for_round(next_round);
// If there are no certificates, then skip this check.
if authors.is_empty() {
continue;
}
let Ok(committee_lookback) = self_.ledger.get_committee_lookback_for_round(next_round) else {
warn!("Failed to retrieve the committee lookback for round {next_round}");
continue;
};
committee_lookback.is_quorum_threshold_reached(&authors)
};
// Attempt to increment to the next round if the quorum threshold is reached.
if is_quorum_threshold_reached {
debug!("Quorum threshold reached for round {}", next_round);
if let Err(e) = self_.try_increment_to_the_next_round(next_round).await {
warn!("Failed to increment to the next round - {e}");
}
}
}
});
// Process the unconfirmed solutions.
let self_ = self.clone();
self.spawn(async move {
while let Some((solution_id, solution, callback)) = rx_unconfirmed_solution.recv().await {
// Compute the checksum for the solution.
let Ok(checksum) = solution.to_checksum::<N>() else {
error!("Failed to compute the checksum for the unconfirmed solution");
continue;
};
// Compute the worker ID.
let Ok(worker_id) = assign_to_worker((solution_id, checksum), self_.num_workers()) else {
error!("Unable to determine the worker ID for the unconfirmed solution");
continue;
};
let self_ = self_.clone();
tokio::spawn(async move {
// Retrieve the worker.
let worker = &self_.workers[worker_id as usize];
// Process the unconfirmed solution.
let result = worker.process_unconfirmed_solution(solution_id, solution).await;
// Send the result to the callback.
callback.send(result).ok();
});
}
});
// Process the unconfirmed transactions.
let self_ = self.clone();
self.spawn(async move {
while let Some((transaction_id, transaction, callback)) = rx_unconfirmed_transaction.recv().await {
trace!("Primary - Received an unconfirmed transaction '{}'", fmt_id(transaction_id));
// Compute the checksum for the transaction.
let Ok(checksum) = transaction.to_checksum::<N>() else {
error!("Failed to compute the checksum for the unconfirmed transaction");
continue;
};
// Compute the worker ID.
let Ok(worker_id) = assign_to_worker::<N>((&transaction_id, &checksum), self_.num_workers()) else {
error!("Unable to determine the worker ID for the unconfirmed transaction");
continue;
};
let self_ = self_.clone();
tokio::spawn(async move {
// Retrieve the worker.
let worker = &self_.workers[worker_id as usize];
// Process the unconfirmed transaction.
let result = worker.process_unconfirmed_transaction(transaction_id, transaction).await;
// Send the result to the callback.
callback.send(result).ok();
});
}
});
}
/// Checks if the proposed batch is expired, and clears the proposed batch if it has expired.
async fn check_proposed_batch_for_expiration(&self) -> Result<()> {
// Check if the proposed batch is timed out or stale.
let is_expired = match self.proposed_batch.read().as_ref() {
Some(proposal) => proposal.round() < self.current_round(),
None => false,
};
// If the batch is expired, clear the proposed batch.
if is_expired {
// Reset the proposed batch.
let proposal = self.proposed_batch.write().take();
if let Some(proposal) = proposal {
debug!("Cleared expired proposal for round {}", proposal.round());
self.reinsert_transmissions_into_workers(proposal.into_transmissions())?;
}
}
Ok(())
}
/// Increments to the next round.
async fn try_increment_to_the_next_round(&self, next_round: u64) -> Result<()> {
// If the next round is within GC range, then iterate to the penultimate round.
if self.current_round() + self.storage.max_gc_rounds() >= next_round {
let mut fast_forward_round = self.current_round();
// Iterate until the penultimate round is reached.
while fast_forward_round < next_round.saturating_sub(1) {
// Update to the next round in storage.
fast_forward_round = self.storage.increment_to_next_round(fast_forward_round)?;
// Clear the proposed batch.
*self.proposed_batch.write() = None;
}
}
// Retrieve the current round.
let current_round = self.current_round();
// Attempt to advance to the next round.
if current_round < next_round {
// If a BFT sender was provided, send the current round to the BFT.
let is_ready = if let Some(bft_sender) = self.bft_sender.get() {
match bft_sender.send_primary_round_to_bft(current_round).await {
Ok(is_ready) => is_ready,
Err(e) => {
warn!("Failed to update the BFT to the next round - {e}");
return Err(e);
}
}
}
// Otherwise, handle the Narwhal case.
else {
// Update to the next round in storage.
self.storage.increment_to_next_round(current_round)?;
// Set 'is_ready' to 'true'.
true
};
// Log whether the next round is ready.
match is_ready {
true => debug!("Primary is ready to propose the next round"),
false => debug!("Primary is not ready to propose the next round"),
}
// If the node is ready, propose a batch for the next round.
if is_ready {
self.propose_batch().await?;
}
}
Ok(())
}
/// Ensures the primary is signing for the specified batch round.
/// This method is used to ensure: for a given round, as soon as the primary starts proposing,
/// it will no longer sign for the previous round (as it has enough previous certificates to proceed).
fn ensure_is_signing_round(&self, batch_round: u64) -> Result<()> {
// Retrieve the current round.
let current_round = self.current_round();
// Ensure the batch round is within GC range of the current round.
if current_round + self.storage.max_gc_rounds() <= batch_round {
bail!("Round {batch_round} is too far in the future")
}
// Ensure the batch round is at or one before the current round.
// Intuition: Our primary has moved on to the next round, but has not necessarily started proposing,
// so we can still sign for the previous round. If we have started proposing, the next check will fail.
if current_round > batch_round + 1 {
bail!("Primary is on round {current_round}, and no longer signing for round {batch_round}")
}
// Check if the primary is still signing for the batch round.
if let Some(signing_round) = self.proposed_batch.read().as_ref().map(|proposal| proposal.round()) {
if signing_round > batch_round {
bail!("Our primary at round {signing_round} is no longer signing for round {batch_round}")
}
}
Ok(())
}
/// Ensure the primary is not creating batch proposals too frequently.
/// This checks that the certificate timestamp for the previous round is within the expected range.
fn check_proposal_timestamp(&self, previous_round: u64, author: Address<N>, timestamp: i64) -> Result<()> {
// Retrieve the timestamp of the previous timestamp to check against.
let previous_timestamp = match self.storage.get_certificate_for_round_with_author(previous_round, author) {
// Ensure that the previous certificate was created at least `MIN_BATCH_DELAY_IN_MS` seconds ago.
Some(certificate) => certificate.timestamp(),
None => match self.gateway.account().address() == author {
// If we are the author, then ensure the previous proposal was created at least `MIN_BATCH_DELAY_IN_MS` seconds ago.
true => *self.latest_proposed_batch_timestamp.read(),
// If we do not see a previous certificate for the author, then proceed optimistically.
false => return Ok(()),
},
};
// Determine the elapsed time since the previous timestamp.
let elapsed = timestamp
.checked_sub(previous_timestamp)
.ok_or_else(|| anyhow!("Timestamp cannot be before the previous certificate at round {previous_round}"))?;
// Ensure that the previous certificate was created at least `MIN_BATCH_DELAY_IN_MS` seconds ago.
match elapsed < MIN_BATCH_DELAY_IN_SECS as i64 {
true => bail!("Timestamp is too soon after the previous certificate at round {previous_round}"),
false => Ok(()),
}
}
/// Stores the certified batch and broadcasts it to all validators, returning the certificate.
async fn store_and_broadcast_certificate(&self, proposal: &Proposal<N>, committee: &Committee<N>) -> Result<()> {
// Create the batch certificate and transmissions.
let (certificate, transmissions) = tokio::task::block_in_place(|| proposal.to_certificate(committee))?;
// Convert the transmissions into a HashMap.
// Note: Do not change the `Proposal` to use a HashMap. The ordering there is necessary for safety.
let transmissions = transmissions.into_iter().collect::<HashMap<_, _>>();
// Store the certified batch.
let (storage, certificate_) = (self.storage.clone(), certificate.clone());
spawn_blocking!(storage.insert_certificate(certificate_, transmissions, Default::default()))?;
debug!("Stored a batch certificate for round {}", certificate.round());
// If a BFT sender was provided, send the certificate to the BFT.
if let Some(bft_sender) = self.bft_sender.get() {
// Await the callback to continue.
if let Err(e) = bft_sender.send_primary_certificate_to_bft(certificate.clone()).await {
warn!("Failed to update the BFT DAG from primary - {e}");
return Err(e);
};
}
// Broadcast the certified batch to all validators.
self.gateway.broadcast(Event::BatchCertified(certificate.clone().into()));
// Log the certified batch.
let num_transmissions = certificate.transmission_ids().len();
let round = certificate.round();
info!("\n\nOur batch with {num_transmissions} transmissions for round {round} was certified!\n");
// Increment to the next round.
self.try_increment_to_the_next_round(round + 1).await
}
/// Inserts the missing transmissions from the proposal into the workers.
fn insert_missing_transmissions_into_workers(
&self,
peer_ip: SocketAddr,
transmissions: impl Iterator<Item = (TransmissionID<N>, Transmission<N>)>,
) -> Result<()> {
// Insert the transmissions into the workers.
assign_to_workers(&self.workers, transmissions, |worker, transmission_id, transmission| {
worker.process_transmission_from_peer(peer_ip, transmission_id, transmission);
})
}
/// Re-inserts the transmissions from the proposal into the workers.
fn reinsert_transmissions_into_workers(
&self,
transmissions: IndexMap<TransmissionID<N>, Transmission<N>>,
) -> Result<()> {
// Re-insert the transmissions into the workers.
assign_to_workers(&self.workers, transmissions.into_iter(), |worker, transmission_id, transmission| {
worker.reinsert(transmission_id, transmission);
})
}
/// Recursively stores a given batch certificate, after ensuring:
/// - Ensure the round matches the committee round.
/// - Ensure the address is a member of the committee.
/// - Ensure the timestamp is within range.
/// - Ensure we have all of the transmissions.
/// - Ensure we have all of the previous certificates.
/// - Ensure the previous certificates are for the previous round (i.e. round - 1).
/// - Ensure the previous certificates have reached the quorum threshold.
/// - Ensure we have not already signed the batch ID.
#[async_recursion::async_recursion]
async fn sync_with_certificate_from_peer<const IS_SYNCING: bool>(
&self,
peer_ip: SocketAddr,
certificate: BatchCertificate<N>,
) -> Result<()> {
// Retrieve the batch header.
let batch_header = certificate.batch_header();
// Retrieve the batch round.
let batch_round = batch_header.round();
// If the certificate round is outdated, do not store it.
if batch_round <= self.storage.gc_round() {
return Ok(());
}
// If the certificate already exists in storage, return early.
if self.storage.contains_certificate(certificate.id()) {
return Ok(());
}
// If node is not in sync mode and the node is not synced. Then return an error.
if !IS_SYNCING && !self.is_synced() {
bail!(
"Failed to process certificate `{}` at round {batch_round} from '{peer_ip}' (node is syncing)",
fmt_id(certificate.id())
);
}
// If the peer is ahead, use the batch header to sync up to the peer.
let missing_transmissions = self.sync_with_batch_header_from_peer::<IS_SYNCING>(peer_ip, batch_header).await?;
// Check if the certificate needs to be stored.
if !self.storage.contains_certificate(certificate.id()) {
// Store the batch certificate.
let (storage, certificate_) = (self.storage.clone(), certificate.clone());
spawn_blocking!(storage.insert_certificate(certificate_, missing_transmissions, Default::default()))?;
debug!("Stored a batch certificate for round {batch_round} from '{peer_ip}'");
// If a BFT sender was provided, send the round and certificate to the BFT.
if let Some(bft_sender) = self.bft_sender.get() {
// Send the certificate to the BFT.
if let Err(e) = bft_sender.send_primary_certificate_to_bft(certificate).await {
warn!("Failed to update the BFT DAG from sync: {e}");
return Err(e);
};
}
}
Ok(())
}
/// Recursively syncs using the given batch header.
async fn sync_with_batch_header_from_peer<const IS_SYNCING: bool>(
&self,
peer_ip: SocketAddr,
batch_header: &BatchHeader<N>,
) -> Result<HashMap<TransmissionID<N>, Transmission<N>>> {
// Retrieve the batch round.
let batch_round = batch_header.round();
// If the certificate round is outdated, do not store it.
if batch_round <= self.storage.gc_round() {
bail!("Round {batch_round} is too far in the past")
}
// If node is not in sync mode and the node is not synced. Then return an error.
if !IS_SYNCING && !self.is_synced() {
bail!(
"Failed to process batch header `{}` at round {batch_round} from '{peer_ip}' (node is syncing)",
fmt_id(batch_header.batch_id())
);
}
// Determine if quorum threshold is reached on the batch round.
let is_quorum_threshold_reached = {
let authors = self.storage.get_certificate_authors_for_round(batch_round);
let committee_lookback = self.ledger.get_committee_lookback_for_round(batch_round)?;
committee_lookback.is_quorum_threshold_reached(&authors)
};
// Check if our primary should move to the next round.
// Note: Checking that quorum threshold is reached is important for mitigating a race condition,
// whereby Narwhal requires N-f, however the BFT only requires f+1. Without this check, the primary
// will advance to the next round assuming f+1, not N-f, which can lead to a network stall.
let is_behind_schedule = is_quorum_threshold_reached && batch_round > self.current_round();
// Check if our primary is far behind the peer.
let is_peer_far_in_future = batch_round > self.current_round() + self.storage.max_gc_rounds();
// If our primary is far behind the peer, update our committee to the batch round.
if is_behind_schedule || is_peer_far_in_future {
// If the batch round is greater than the current committee round, update the committee.
self.try_increment_to_the_next_round(batch_round).await?;
}
// Ensure the primary has all of the transmissions.
let missing_transmissions_handle = self.fetch_missing_transmissions(peer_ip, batch_header);
// Ensure the primary has all of the previous certificates.
let missing_previous_certificates_handle = self.fetch_missing_previous_certificates(peer_ip, batch_header);
// Wait for the missing transmissions and previous certificates to be fetched.
let (missing_transmissions, missing_previous_certificates) = tokio::try_join!(
missing_transmissions_handle,
missing_previous_certificates_handle,
).map_err(|e| {
anyhow!("Failed to fetch missing transmissions and previous certificates for round {batch_round} from '{peer_ip}' - {e}")
})?;
// Iterate through the missing previous certificates.
for batch_certificate in missing_previous_certificates {
// Store the batch certificate (recursively fetching any missing previous certificates).
self.sync_with_certificate_from_peer::<IS_SYNCING>(peer_ip, batch_certificate).await?;
}
Ok(missing_transmissions)
}
/// Fetches any missing transmissions for the specified batch header.
/// If a transmission does not exist, it will be fetched from the specified peer IP.
async fn fetch_missing_transmissions(
&self,
peer_ip: SocketAddr,
batch_header: &BatchHeader<N>,
) -> Result<HashMap<TransmissionID<N>, Transmission<N>>> {
// If the round is <= the GC round, return early.
if batch_header.round() <= self.storage.gc_round() {
return Ok(Default::default());
}
// Ensure this batch ID is new, otherwise return early.
if self.storage.contains_batch(batch_header.batch_id()) {
trace!("Batch for round {} from peer has already been processed", batch_header.round());
return Ok(Default::default());
}
// Retrieve the workers.
let workers = self.workers.clone();
// Initialize a list for the transmissions.
let mut fetch_transmissions = FuturesUnordered::new();
// Retrieve the number of workers.
let num_workers = self.num_workers();
// Iterate through the transmission IDs.
for transmission_id in batch_header.transmission_ids() {
// If the transmission does not exist in storage, proceed to fetch the transmission.
if !self.storage.contains_transmission(*transmission_id) {
// Determine the worker ID.
let Ok(worker_id) = assign_to_worker(*transmission_id, num_workers) else {
bail!("Unable to assign transmission ID '{transmission_id}' to a worker")
};
// Retrieve the worker.
let Some(worker) = workers.get(worker_id as usize) else { bail!("Unable to find worker {worker_id}") };
// Push the callback onto the list.
fetch_transmissions.push(worker.get_or_fetch_transmission(peer_ip, *transmission_id));
}
}
// Initialize a set for the transmissions.
let mut transmissions = HashMap::with_capacity(fetch_transmissions.len());
// Wait for all of the transmissions to be fetched.
while let Some(result) = fetch_transmissions.next().await {
// Retrieve the transmission.
let (transmission_id, transmission) = result?;
// Insert the transmission into the set.
transmissions.insert(transmission_id, transmission);
}
// Return the transmissions.
Ok(transmissions)
}
/// Fetches any missing previous certificates for the specified batch header from the specified peer.
async fn fetch_missing_previous_certificates(
&self,
peer_ip: SocketAddr,
batch_header: &BatchHeader<N>,
) -> Result<HashSet<BatchCertificate<N>>> {
// Retrieve the round.
let round = batch_header.round();
// If the previous round is 0, or is <= the GC round, return early.
if round == 1 || round <= self.storage.gc_round() + 1 {
return Ok(Default::default());
}
// Fetch the missing previous certificates.
let missing_previous_certificates =
self.fetch_missing_certificates(peer_ip, round, batch_header.previous_certificate_ids()).await?;
if !missing_previous_certificates.is_empty() {
debug!(
"Fetched {} missing previous certificates for round {round} from '{peer_ip}'",
missing_previous_certificates.len(),
);
}
// Return the missing previous certificates.
Ok(missing_previous_certificates)
}
/// Fetches any missing certificates for the specified batch header from the specified peer.
async fn fetch_missing_certificates(
&self,
peer_ip: SocketAddr,
round: u64,
certificate_ids: &IndexSet<Field<N>>,
) -> Result<HashSet<BatchCertificate<N>>> {
// Initialize a list for the missing certificates.
let mut fetch_certificates = FuturesUnordered::new();
// Initialize a set for the missing certificates.
let mut missing_certificates = HashSet::default();
// Iterate through the certificate IDs.
for certificate_id in certificate_ids {
// Check if the certificate already exists in the ledger.
if self.ledger.contains_certificate(certificate_id)? {
continue;
}
// Check if the certificate already exists in storage.
if self.storage.contains_certificate(*certificate_id) {
continue;
}
// If we have not fully processed the certificate yet, store it.
if let Some(certificate) = self.storage.get_unprocessed_certificate(*certificate_id) {
missing_certificates.insert(certificate);
} else {
// If we do not have the certificate, request it.
trace!("Primary - Found a new certificate ID for round {round} from '{peer_ip}'");
// TODO (howardwu): Limit the number of open requests we send to a peer.
// Send an certificate request to the peer.
fetch_certificates.push(self.sync.send_certificate_request(peer_ip, *certificate_id));
}
}
// If there are no missing certificates, return early.
match fetch_certificates.is_empty() {
true => return Ok(Default::default()),
false => trace!(
"Fetching {} missing certificates for round {round} from '{peer_ip}'...",
fetch_certificates.len(),
),
}
// Wait for all of the missing certificates to be fetched.
while let Some(result) = fetch_certificates.next().await {
// Insert the missing certificate into the set.
missing_certificates.insert(result?);
}
// Return the missing certificates.
Ok(missing_certificates)
}
}
impl<N: Network> Primary<N> {
/// Spawns a task with the given future; it should only be used for long-running tasks.
fn spawn<T: Future<Output = ()> + Send + 'static>(&self, future: T) {
self.handles.lock().push(tokio::spawn(future));
}
/// Shuts down the primary.
pub async fn shut_down(&self) {
info!("Shutting down the primary...");
// Shut down the workers.
self.workers.iter().for_each(|worker| worker.shut_down());
// Abort the tasks.
self.handles.lock().iter().for_each(|handle| handle.abort());
// Save the current proposal cache to disk.
let proposal_cache = {
let proposal = self.proposed_batch.write().take();
let signed_proposals = self.signed_proposals.read().clone();
let latest_round = proposal.as_ref().map(Proposal::round).unwrap_or(*self.propose_lock.lock().await);
let pending_certificates = self.storage.get_pending_certificates();
ProposalCache::new(latest_round, proposal, signed_proposals, pending_certificates)
};
if let Err(err) = proposal_cache.store(self.gateway.dev()) {
error!("Failed to store the current proposal cache: {err}");
}
// Close the gateway.
self.gateway.shut_down().await;
}
}
#[cfg(test)]
mod tests {
use super::*;
use snarkos_node_bft_ledger_service::MockLedgerService;
use snarkos_node_bft_storage_service::BFTMemoryService;
use snarkvm::{
ledger::committee::{Committee, MIN_VALIDATOR_STAKE},
prelude::{Address, Signature},
};
use bytes::Bytes;
use indexmap::IndexSet;
use rand::RngCore;
type CurrentNetwork = snarkvm::prelude::MainnetV0;
// Returns a primary and a list of accounts in the configured committee.
async fn primary_without_handlers(
rng: &mut TestRng,
) -> (Primary<CurrentNetwork>, Vec<(SocketAddr, Account<CurrentNetwork>)>) {
// Create a committee containing the primary's account.
let (accounts, committee) = {
const COMMITTEE_SIZE: usize = 4;
let mut accounts = Vec::with_capacity(COMMITTEE_SIZE);
let mut members = IndexMap::new();
for i in 0..COMMITTEE_SIZE {
let socket_addr = format!("127.0.0.1:{}", 5000 + i).parse().unwrap();
let account = Account::new(rng).unwrap();
members.insert(account.address(), (MIN_VALIDATOR_STAKE, true, rng.gen_range(0..100)));
accounts.push((socket_addr, account));
}
(accounts, Committee::<CurrentNetwork>::new(1, members).unwrap())
};
let account = accounts.first().unwrap().1.clone();
let ledger = Arc::new(MockLedgerService::new(committee));
let storage = Storage::new(ledger.clone(), Arc::new(BFTMemoryService::new()), 10);
// Initialize the primary.
let mut primary = Primary::new(account, storage, ledger, None, &[], None).unwrap();
// Construct a worker instance.
primary.workers = Arc::from([Worker::new(
0, // id
Arc::new(primary.gateway.clone()),
primary.storage.clone(),
primary.ledger.clone(),
primary.proposed_batch.clone(),
)
.unwrap()]);
for a in accounts.iter() {
primary.gateway.insert_connected_peer(a.0, a.0, a.1.address());
}
(primary, accounts)
}
// Creates a mock solution.
fn sample_unconfirmed_solution(rng: &mut TestRng) -> (SolutionID<CurrentNetwork>, Data<Solution<CurrentNetwork>>) {
// Sample a random fake solution ID.
let solution_id = rng.gen::<u64>().into();
// Vary the size of the solutions.
let size = rng.gen_range(1024..10 * 1024);
// Sample random fake solution bytes.
let mut vec = vec![0u8; size];
rng.fill_bytes(&mut vec);
let solution = Data::Buffer(Bytes::from(vec));
// Return the solution ID and solution.
(solution_id, solution)
}
// Creates a mock transaction.
fn sample_unconfirmed_transaction(
rng: &mut TestRng,
) -> (<CurrentNetwork as Network>::TransactionID, Data<Transaction<CurrentNetwork>>) {
// Sample a random fake transaction ID.
let id = Field::<CurrentNetwork>::rand(rng).into();
// Vary the size of the transactions.
let size = rng.gen_range(1024..10 * 1024);
// Sample random fake transaction bytes.
let mut vec = vec![0u8; size];
rng.fill_bytes(&mut vec);
let transaction = Data::Buffer(Bytes::from(vec));
// Return the ID and transaction.
(id, transaction)
}
// Creates a batch proposal with one solution and one transaction.
fn create_test_proposal(
author: &Account<CurrentNetwork>,
committee: Committee<CurrentNetwork>,
round: u64,
previous_certificate_ids: IndexSet<Field<CurrentNetwork>>,
timestamp: i64,
rng: &mut TestRng,
) -> Proposal<CurrentNetwork> {
let (solution_id, solution) = sample_unconfirmed_solution(rng);
let (transaction_id, transaction) = sample_unconfirmed_transaction(rng);
let solution_checksum = solution.to_checksum::<CurrentNetwork>().unwrap();
let transaction_checksum = transaction.to_checksum::<CurrentNetwork>().unwrap();
let solution_transmission_id = (solution_id, solution_checksum).into();
let transaction_transmission_id = (&transaction_id, &transaction_checksum).into();
// Retrieve the private key.
let private_key = author.private_key();
// Prepare the transmission IDs.
let transmission_ids = [solution_transmission_id, transaction_transmission_id].into();
let transmissions = [
(solution_transmission_id, Transmission::Solution(solution)),
(transaction_transmission_id, Transmission::Transaction(transaction)),
]
.into();
// Sign the batch header.
let batch_header = BatchHeader::new(
private_key,
round,
timestamp,
committee.id(),
transmission_ids,
previous_certificate_ids,
rng,
)
.unwrap();
// Construct the proposal.
Proposal::new(committee, batch_header, transmissions).unwrap()
}
// Creates a signature of the primary's current proposal for each committee member (excluding
// the primary).
fn peer_signatures_for_proposal(
primary: &Primary<CurrentNetwork>,
accounts: &[(SocketAddr, Account<CurrentNetwork>)],
rng: &mut TestRng,
) -> Vec<(SocketAddr, BatchSignature<CurrentNetwork>)> {
// Each committee member signs the batch.
let mut signatures = Vec::with_capacity(accounts.len() - 1);
for (socket_addr, account) in accounts {
if account.address() == primary.gateway.account().address() {
continue;
}
let batch_id = primary.proposed_batch.read().as_ref().unwrap().batch_id();
let signature = account.sign(&[batch_id], rng).unwrap();
signatures.push((*socket_addr, BatchSignature::new(batch_id, signature)));
}
signatures
}
/// Creates a signature of the batch ID for each committee member (excluding the primary).
fn peer_signatures_for_batch(
primary_address: Address<CurrentNetwork>,
accounts: &[(SocketAddr, Account<CurrentNetwork>)],
batch_id: Field<CurrentNetwork>,
rng: &mut TestRng,
) -> IndexSet<Signature<CurrentNetwork>> {
let mut signatures = IndexSet::new();
for (_, account) in accounts {
if account.address() == primary_address {
continue;
}
let signature = account.sign(&[batch_id], rng).unwrap();
signatures.insert(signature);
}
signatures
}
// Creates a batch certificate.
fn create_batch_certificate(
primary_address: Address<CurrentNetwork>,
accounts: &[(SocketAddr, Account<CurrentNetwork>)],
round: u64,
previous_certificate_ids: IndexSet<Field<CurrentNetwork>>,
rng: &mut TestRng,
) -> (BatchCertificate<CurrentNetwork>, HashMap<TransmissionID<CurrentNetwork>, Transmission<CurrentNetwork>>) {
let timestamp = now();
let author =
accounts.iter().find(|&(_, acct)| acct.address() == primary_address).map(|(_, acct)| acct.clone()).unwrap();
let private_key = author.private_key();
let committee_id = Field::rand(rng);
let (solution_id, solution) = sample_unconfirmed_solution(rng);
let (transaction_id, transaction) = sample_unconfirmed_transaction(rng);
let solution_checksum = solution.to_checksum::<CurrentNetwork>().unwrap();
let transaction_checksum = transaction.to_checksum::<CurrentNetwork>().unwrap();
let solution_transmission_id = (solution_id, solution_checksum).into();
let transaction_transmission_id = (&transaction_id, &transaction_checksum).into();
let transmission_ids = [solution_transmission_id, transaction_transmission_id].into();
let transmissions = [
(solution_transmission_id, Transmission::Solution(solution)),
(transaction_transmission_id, Transmission::Transaction(transaction)),
]
.into();
let batch_header = BatchHeader::new(
private_key,
round,
timestamp,
committee_id,
transmission_ids,
previous_certificate_ids,
rng,
)
.unwrap();
let signatures = peer_signatures_for_batch(primary_address, accounts, batch_header.batch_id(), rng);
let certificate = BatchCertificate::<CurrentNetwork>::from(batch_header, signatures).unwrap();
(certificate, transmissions)
}
// Create a certificate chain up to round in primary storage.
fn store_certificate_chain(
primary: &Primary<CurrentNetwork>,
accounts: &[(SocketAddr, Account<CurrentNetwork>)],
round: u64,
rng: &mut TestRng,
) -> IndexSet<Field<CurrentNetwork>> {
let mut previous_certificates = IndexSet::<Field<CurrentNetwork>>::new();
let mut next_certificates = IndexSet::<Field<CurrentNetwork>>::new();
for cur_round in 1..round {
for (_, account) in accounts.iter() {
let (certificate, transmissions) = create_batch_certificate(
account.address(),
accounts,
cur_round,
previous_certificates.clone(),
rng,
);
next_certificates.insert(certificate.id());
assert!(primary.storage.insert_certificate(certificate, transmissions, Default::default()).is_ok());
}
assert!(primary.storage.increment_to_next_round(cur_round).is_ok());
previous_certificates = next_certificates;
next_certificates = IndexSet::<Field<CurrentNetwork>>::new();
}
previous_certificates
}
// Insert the account socket addresses into the resolver so that
// they are recognized as "connected".
fn map_account_addresses(primary: &Primary<CurrentNetwork>, accounts: &[(SocketAddr, Account<CurrentNetwork>)]) {
// First account is primary, which doesn't need to resolve.
for (addr, acct) in accounts.iter().skip(1) {
primary.gateway.resolver().insert_peer(*addr, *addr, acct.address());
}
}
#[tokio::test]
async fn test_propose_batch() {
let mut rng = TestRng::default();
let (primary, _) = primary_without_handlers(&mut rng).await;
// Check there is no batch currently proposed.
assert!(primary.proposed_batch.read().is_none());
// Generate a solution and a transaction.
let (solution_id, solution) = sample_unconfirmed_solution(&mut rng);
let (transaction_id, transaction) = sample_unconfirmed_transaction(&mut rng);
// Store it on one of the workers.
primary.workers[0].process_unconfirmed_solution(solution_id, solution).await.unwrap();
primary.workers[0].process_unconfirmed_transaction(transaction_id, transaction).await.unwrap();
// Try to propose a batch again. This time, it should succeed.
assert!(primary.propose_batch().await.is_ok());
assert!(primary.proposed_batch.read().is_some());
}
#[tokio::test]
async fn test_propose_batch_with_no_transmissions() {
let mut rng = TestRng::default();
let (primary, _) = primary_without_handlers(&mut rng).await;
// Check there is no batch currently proposed.
assert!(primary.proposed_batch.read().is_none());
// Try to propose a batch with no transmissions.
assert!(primary.propose_batch().await.is_ok());
assert!(primary.proposed_batch.read().is_some());
}
#[tokio::test]
async fn test_propose_batch_in_round() {
let round = 3;
let mut rng = TestRng::default();
let (primary, accounts) = primary_without_handlers(&mut rng).await;
// Fill primary storage.
store_certificate_chain(&primary, &accounts, round, &mut rng);
// Sleep for a while to ensure the primary is ready to propose the next round.
tokio::time::sleep(Duration::from_secs(MIN_BATCH_DELAY_IN_SECS)).await;
// Generate a solution and a transaction.
let (solution_id, solution) = sample_unconfirmed_solution(&mut rng);
let (transaction_id, transaction) = sample_unconfirmed_transaction(&mut rng);
// Store it on one of the workers.
primary.workers[0].process_unconfirmed_solution(solution_id, solution).await.unwrap();
primary.workers[0].process_unconfirmed_transaction(transaction_id, transaction).await.unwrap();
// Propose a batch again. This time, it should succeed.
assert!(primary.propose_batch().await.is_ok());
assert!(primary.proposed_batch.read().is_some());
}
#[tokio::test]
async fn test_propose_batch_skip_transmissions_from_previous_certificates() {
let round = 3;
let prev_round = round - 1;
let mut rng = TestRng::default();
let (primary, accounts) = primary_without_handlers(&mut rng).await;
let peer_account = &accounts[1];
let peer_ip = peer_account.0;
// Fill primary storage.
store_certificate_chain(&primary, &accounts, round, &mut rng);
// Get transmissions from previous certificates.
let previous_certificate_ids: IndexSet<_> = primary.storage.get_certificate_ids_for_round(prev_round);
// Track the number of transmissions in the previous round.
let mut num_transmissions_in_previous_round = 0;
// Generate a solution and a transaction.
let (solution_commitment, solution) = sample_unconfirmed_solution(&mut rng);
let (transaction_id, transaction) = sample_unconfirmed_transaction(&mut rng);
let solution_checksum = solution.to_checksum::<CurrentNetwork>().unwrap();
let transaction_checksum = transaction.to_checksum::<CurrentNetwork>().unwrap();
// Store it on one of the workers.
primary.workers[0].process_unconfirmed_solution(solution_commitment, solution).await.unwrap();
primary.workers[0].process_unconfirmed_transaction(transaction_id, transaction).await.unwrap();
// Check that the worker has 2 transmissions.
assert_eq!(primary.workers[0].num_transmissions(), 2);
// Create certificates for the current round and add the transmissions to the worker before inserting the certificate to storage.
for (_, account) in accounts.iter() {
let (certificate, transmissions) = create_batch_certificate(
account.address(),
&accounts,
round,
previous_certificate_ids.clone(),
&mut rng,
);
// Add the transmissions to the worker.
for (transmission_id, transmission) in transmissions.iter() {
primary.workers[0].process_transmission_from_peer(peer_ip, *transmission_id, transmission.clone());
}
// Insert the certificate to storage.
num_transmissions_in_previous_round += transmissions.len();
primary.storage.insert_certificate(certificate, transmissions, Default::default()).unwrap();
}
// Sleep for a while to ensure the primary is ready to propose the next round.
tokio::time::sleep(Duration::from_secs(MIN_BATCH_DELAY_IN_SECS)).await;
// Advance to the next round.
assert!(primary.storage.increment_to_next_round(round).is_ok());
// Check that the worker has `num_transmissions_in_previous_round + 2` transmissions.
assert_eq!(primary.workers[0].num_transmissions(), num_transmissions_in_previous_round + 2);
// Propose the batch.
assert!(primary.propose_batch().await.is_ok());
// Check that the proposal only contains the new transmissions that were not in previous certificates.
let proposed_transmissions = primary.proposed_batch.read().as_ref().unwrap().transmissions().clone();
assert_eq!(proposed_transmissions.len(), 2);
assert!(proposed_transmissions.contains_key(&TransmissionID::Solution(solution_commitment, solution_checksum)));
assert!(
proposed_transmissions.contains_key(&TransmissionID::Transaction(transaction_id, transaction_checksum))
);
}
#[tokio::test]
async fn test_batch_propose_from_peer() {
let mut rng = TestRng::default();
let (primary, accounts) = primary_without_handlers(&mut rng).await;
// Create a valid proposal with an author that isn't the primary.
let round = 1;
let peer_account = &accounts[1];
let peer_ip = peer_account.0;
let timestamp = now() + MIN_BATCH_DELAY_IN_SECS as i64;
let proposal = create_test_proposal(
&peer_account.1,
primary.ledger.current_committee().unwrap(),
round,
Default::default(),
timestamp,
&mut rng,
);
// Make sure the primary is aware of the transmissions in the proposal.
for (transmission_id, transmission) in proposal.transmissions() {
primary.workers[0].process_transmission_from_peer(peer_ip, *transmission_id, transmission.clone())
}
// The author must be known to resolver to pass propose checks.
primary.gateway.resolver().insert_peer(peer_ip, peer_ip, peer_account.1.address());
// The primary must be considered synced.
primary.sync.block_sync().try_block_sync(&primary.gateway.clone()).await;
// Try to process the batch proposal from the peer, should succeed.
assert!(
primary.process_batch_propose_from_peer(peer_ip, (*proposal.batch_header()).clone().into()).await.is_ok()
);
}
#[tokio::test]
async fn test_batch_propose_from_peer_when_not_synced() {
let mut rng = TestRng::default();
let (primary, accounts) = primary_without_handlers(&mut rng).await;
// Create a valid proposal with an author that isn't the primary.
let round = 1;
let peer_account = &accounts[1];
let peer_ip = peer_account.0;
let timestamp = now() + MIN_BATCH_DELAY_IN_SECS as i64;
let proposal = create_test_proposal(
&peer_account.1,
primary.ledger.current_committee().unwrap(),
round,
Default::default(),
timestamp,
&mut rng,
);
// Make sure the primary is aware of the transmissions in the proposal.
for (transmission_id, transmission) in proposal.transmissions() {
primary.workers[0].process_transmission_from_peer(peer_ip, *transmission_id, transmission.clone())
}
// The author must be known to resolver to pass propose checks.
primary.gateway.resolver().insert_peer(peer_ip, peer_ip, peer_account.1.address());
// Try to process the batch proposal from the peer, should fail.
assert!(
primary.process_batch_propose_from_peer(peer_ip, (*proposal.batch_header()).clone().into()).await.is_err()
);
}
#[tokio::test]
async fn test_batch_propose_from_peer_in_round() {
let round = 2;
let mut rng = TestRng::default();
let (primary, accounts) = primary_without_handlers(&mut rng).await;
// Generate certificates.
let previous_certificates = store_certificate_chain(&primary, &accounts, round, &mut rng);
// Create a valid proposal with an author that isn't the primary.
let peer_account = &accounts[1];
let peer_ip = peer_account.0;
let timestamp = now() + MIN_BATCH_DELAY_IN_SECS as i64;
let proposal = create_test_proposal(
&peer_account.1,
primary.ledger.current_committee().unwrap(),
round,
previous_certificates,
timestamp,
&mut rng,
);
// Make sure the primary is aware of the transmissions in the proposal.
for (transmission_id, transmission) in proposal.transmissions() {
primary.workers[0].process_transmission_from_peer(peer_ip, *transmission_id, transmission.clone())
}
// The author must be known to resolver to pass propose checks.
primary.gateway.resolver().insert_peer(peer_ip, peer_ip, peer_account.1.address());
// The primary must be considered synced.
primary.sync.block_sync().try_block_sync(&primary.gateway.clone()).await;
// Try to process the batch proposal from the peer, should succeed.
primary.process_batch_propose_from_peer(peer_ip, (*proposal.batch_header()).clone().into()).await.unwrap();
}
#[tokio::test]
async fn test_batch_propose_from_peer_wrong_round() {
let mut rng = TestRng::default();
let (primary, accounts) = primary_without_handlers(&mut rng).await;
// Create a valid proposal with an author that isn't the primary.
let round = 1;
let peer_account = &accounts[1];
let peer_ip = peer_account.0;
let timestamp = now() + MIN_BATCH_DELAY_IN_SECS as i64;
let proposal = create_test_proposal(
&peer_account.1,
primary.ledger.current_committee().unwrap(),
round,
Default::default(),
timestamp,
&mut rng,
);
// Make sure the primary is aware of the transmissions in the proposal.
for (transmission_id, transmission) in proposal.transmissions() {
primary.workers[0].process_transmission_from_peer(peer_ip, *transmission_id, transmission.clone())
}
// The author must be known to resolver to pass propose checks.
primary.gateway.resolver().insert_peer(peer_ip, peer_ip, peer_account.1.address());
// The primary must be considered synced.
primary.sync.block_sync().try_block_sync(&primary.gateway.clone()).await;
// Try to process the batch proposal from the peer, should error.
assert!(
primary
.process_batch_propose_from_peer(peer_ip, BatchPropose {
round: round + 1,
batch_header: Data::Object(proposal.batch_header().clone())
})
.await
.is_err()
);
}
#[tokio::test]
async fn test_batch_propose_from_peer_in_round_wrong_round() {
let round = 4;
let mut rng = TestRng::default();
let (primary, accounts) = primary_without_handlers(&mut rng).await;
// Generate certificates.
let previous_certificates = store_certificate_chain(&primary, &accounts, round, &mut rng);
// Create a valid proposal with an author that isn't the primary.
let peer_account = &accounts[1];
let peer_ip = peer_account.0;
let timestamp = now() + MIN_BATCH_DELAY_IN_SECS as i64;
let proposal = create_test_proposal(
&peer_account.1,
primary.ledger.current_committee().unwrap(),
round,
previous_certificates,
timestamp,
&mut rng,
);
// Make sure the primary is aware of the transmissions in the proposal.
for (transmission_id, transmission) in proposal.transmissions() {
primary.workers[0].process_transmission_from_peer(peer_ip, *transmission_id, transmission.clone())
}
// The author must be known to resolver to pass propose checks.
primary.gateway.resolver().insert_peer(peer_ip, peer_ip, peer_account.1.address());
// The primary must be considered synced.
primary.sync.block_sync().try_block_sync(&primary.gateway.clone()).await;
// Try to process the batch proposal from the peer, should error.
assert!(
primary
.process_batch_propose_from_peer(peer_ip, BatchPropose {
round: round + 1,
batch_header: Data::Object(proposal.batch_header().clone())
})
.await
.is_err()
);
}
#[tokio::test]
async fn test_batch_propose_from_peer_with_invalid_timestamp() {
let round = 2;
let mut rng = TestRng::default();
let (primary, accounts) = primary_without_handlers(&mut rng).await;
// Generate certificates.
let previous_certificates = store_certificate_chain(&primary, &accounts, round, &mut rng);
// Create a valid proposal with an author that isn't the primary.
let peer_account = &accounts[1];
let peer_ip = peer_account.0;
let invalid_timestamp = now(); // Use a timestamp that is too early.
let proposal = create_test_proposal(
&peer_account.1,
primary.ledger.current_committee().unwrap(),
round,
previous_certificates,
invalid_timestamp,
&mut rng,
);
// Make sure the primary is aware of the transmissions in the proposal.
for (transmission_id, transmission) in proposal.transmissions() {
primary.workers[0].process_transmission_from_peer(peer_ip, *transmission_id, transmission.clone())
}
// The author must be known to resolver to pass propose checks.
primary.gateway.resolver().insert_peer(peer_ip, peer_ip, peer_account.1.address());
// The primary must be considered synced.
primary.sync.block_sync().try_block_sync(&primary.gateway.clone()).await;
// Try to process the batch proposal from the peer, should error.
assert!(
primary.process_batch_propose_from_peer(peer_ip, (*proposal.batch_header()).clone().into()).await.is_err()
);
}
#[tokio::test]
async fn test_batch_propose_from_peer_with_past_timestamp() {
let round = 2;
let mut rng = TestRng::default();
let (primary, accounts) = primary_without_handlers(&mut rng).await;
// Generate certificates.
let previous_certificates = store_certificate_chain(&primary, &accounts, round, &mut rng);
// Create a valid proposal with an author that isn't the primary.
let peer_account = &accounts[1];
let peer_ip = peer_account.0;
let past_timestamp = now() - 5; // Use a timestamp that is in the past.
let proposal = create_test_proposal(
&peer_account.1,
primary.ledger.current_committee().unwrap(),
round,
previous_certificates,
past_timestamp,
&mut rng,
);
// Make sure the primary is aware of the transmissions in the proposal.
for (transmission_id, transmission) in proposal.transmissions() {
primary.workers[0].process_transmission_from_peer(peer_ip, *transmission_id, transmission.clone())
}
// The author must be known to resolver to pass propose checks.
primary.gateway.resolver().insert_peer(peer_ip, peer_ip, peer_account.1.address());
// The primary must be considered synced.
primary.sync.block_sync().try_block_sync(&primary.gateway.clone()).await;
// Try to process the batch proposal from the peer, should error.
assert!(
primary.process_batch_propose_from_peer(peer_ip, (*proposal.batch_header()).clone().into()).await.is_err()
);
}
#[tokio::test]
async fn test_propose_batch_with_storage_round_behind_proposal_lock() {
let round = 3;
let mut rng = TestRng::default();
let (primary, _) = primary_without_handlers(&mut rng).await;
// Check there is no batch currently proposed.
assert!(primary.proposed_batch.read().is_none());
// Generate a solution and a transaction.
let (solution_id, solution) = sample_unconfirmed_solution(&mut rng);
let (transaction_id, transaction) = sample_unconfirmed_transaction(&mut rng);
// Store it on one of the workers.
primary.workers[0].process_unconfirmed_solution(solution_id, solution).await.unwrap();
primary.workers[0].process_unconfirmed_transaction(transaction_id, transaction).await.unwrap();
// Set the proposal lock to a round ahead of the storage.
let old_proposal_lock_round = *primary.propose_lock.lock().await;
*primary.propose_lock.lock().await = round + 1;
// Propose a batch and enforce that it fails.
assert!(primary.propose_batch().await.is_ok());
assert!(primary.proposed_batch.read().is_none());
// Set the proposal lock back to the old round.
*primary.propose_lock.lock().await = old_proposal_lock_round;
// Try to propose a batch again. This time, it should succeed.
assert!(primary.propose_batch().await.is_ok());
assert!(primary.proposed_batch.read().is_some());
}
#[tokio::test]
async fn test_propose_batch_with_storage_round_behind_proposal() {
let round = 5;
let mut rng = TestRng::default();
let (primary, accounts) = primary_without_handlers(&mut rng).await;
// Generate previous certificates.
let previous_certificates = store_certificate_chain(&primary, &accounts, round, &mut rng);
// Create a valid proposal.
let timestamp = now();
let proposal = create_test_proposal(
primary.gateway.account(),
primary.ledger.current_committee().unwrap(),
round + 1,
previous_certificates,
timestamp,
&mut rng,
);
// Store the proposal on the primary.
*primary.proposed_batch.write() = Some(proposal);
// Try to propose a batch will terminate early because the storage is behind the proposal.
assert!(primary.propose_batch().await.is_ok());
assert!(primary.proposed_batch.read().is_some());
assert!(primary.proposed_batch.read().as_ref().unwrap().round() > primary.current_round());
}
#[tokio::test(flavor = "multi_thread")]
async fn test_batch_signature_from_peer() {
let mut rng = TestRng::default();
let (primary, accounts) = primary_without_handlers(&mut rng).await;
map_account_addresses(&primary, &accounts);
// Create a valid proposal.
let round = 1;
let timestamp = now() + MIN_BATCH_DELAY_IN_SECS as i64;
let proposal = create_test_proposal(
primary.gateway.account(),
primary.ledger.current_committee().unwrap(),
round,
Default::default(),
timestamp,
&mut rng,
);
// Store the proposal on the primary.
*primary.proposed_batch.write() = Some(proposal);
// Each committee member signs the batch.
let signatures = peer_signatures_for_proposal(&primary, &accounts, &mut rng);
// Have the primary process the signatures.
for (socket_addr, signature) in signatures {
primary.process_batch_signature_from_peer(socket_addr, signature).await.unwrap();
}
// Check the certificate was created and stored by the primary.
assert!(primary.storage.contains_certificate_in_round_from(round, primary.gateway.account().address()));
// Check the round was incremented.
assert_eq!(primary.current_round(), round + 1);
}
#[tokio::test(flavor = "multi_thread")]
async fn test_batch_signature_from_peer_in_round() {
let round = 5;
let mut rng = TestRng::default();
let (primary, accounts) = primary_without_handlers(&mut rng).await;
map_account_addresses(&primary, &accounts);
// Generate certificates.
let previous_certificates = store_certificate_chain(&primary, &accounts, round, &mut rng);
// Create a valid proposal.
let timestamp = now();
let proposal = create_test_proposal(
primary.gateway.account(),
primary.ledger.current_committee().unwrap(),
round,
previous_certificates,
timestamp,
&mut rng,
);
// Store the proposal on the primary.
*primary.proposed_batch.write() = Some(proposal);
// Each committee member signs the batch.
let signatures = peer_signatures_for_proposal(&primary, &accounts, &mut rng);
// Have the primary process the signatures.
for (socket_addr, signature) in signatures {
primary.process_batch_signature_from_peer(socket_addr, signature).await.unwrap();
}
// Check the certificate was created and stored by the primary.
assert!(primary.storage.contains_certificate_in_round_from(round, primary.gateway.account().address()));
// Check the round was incremented.
assert_eq!(primary.current_round(), round + 1);
}
#[tokio::test]
async fn test_batch_signature_from_peer_no_quorum() {
let mut rng = TestRng::default();
let (primary, accounts) = primary_without_handlers(&mut rng).await;
map_account_addresses(&primary, &accounts);
// Create a valid proposal.
let round = 1;
let timestamp = now() + MIN_BATCH_DELAY_IN_SECS as i64;
let proposal = create_test_proposal(
primary.gateway.account(),
primary.ledger.current_committee().unwrap(),
round,
Default::default(),
timestamp,
&mut rng,
);
// Store the proposal on the primary.
*primary.proposed_batch.write() = Some(proposal);
// Each committee member signs the batch.
let signatures = peer_signatures_for_proposal(&primary, &accounts, &mut rng);
// Have the primary process only one signature, mimicking a lack of quorum.
let (socket_addr, signature) = signatures.first().unwrap();
primary.process_batch_signature_from_peer(*socket_addr, *signature).await.unwrap();
// Check the certificate was not created and stored by the primary.
assert!(!primary.storage.contains_certificate_in_round_from(round, primary.gateway.account().address()));
// Check the round was incremented.
assert_eq!(primary.current_round(), round);
}
#[tokio::test]
async fn test_batch_signature_from_peer_in_round_no_quorum() {
let round = 7;
let mut rng = TestRng::default();
let (primary, accounts) = primary_without_handlers(&mut rng).await;
map_account_addresses(&primary, &accounts);
// Generate certificates.
let previous_certificates = store_certificate_chain(&primary, &accounts, round, &mut rng);
// Create a valid proposal.
let timestamp = now() + MIN_BATCH_DELAY_IN_SECS as i64;
let proposal = create_test_proposal(
primary.gateway.account(),
primary.ledger.current_committee().unwrap(),
round,
previous_certificates,
timestamp,
&mut rng,
);
// Store the proposal on the primary.
*primary.proposed_batch.write() = Some(proposal);
// Each committee member signs the batch.
let signatures = peer_signatures_for_proposal(&primary, &accounts, &mut rng);
// Have the primary process only one signature, mimicking a lack of quorum.
let (socket_addr, signature) = signatures.first().unwrap();
primary.process_batch_signature_from_peer(*socket_addr, *signature).await.unwrap();
// Check the certificate was not created and stored by the primary.
assert!(!primary.storage.contains_certificate_in_round_from(round, primary.gateway.account().address()));
// Check the round was incremented.
assert_eq!(primary.current_round(), round);
}
#[tokio::test]
async fn test_insert_certificate_with_aborted_transmissions() {
let round = 3;
let prev_round = round - 1;
let mut rng = TestRng::default();
let (primary, accounts) = primary_without_handlers(&mut rng).await;
let peer_account = &accounts[1];
let peer_ip = peer_account.0;
// Fill primary storage.
store_certificate_chain(&primary, &accounts, round, &mut rng);
// Get transmissions from previous certificates.
let previous_certificate_ids: IndexSet<_> = primary.storage.get_certificate_ids_for_round(prev_round);
// Generate a solution and a transaction.
let (solution_commitment, solution) = sample_unconfirmed_solution(&mut rng);
let (transaction_id, transaction) = sample_unconfirmed_transaction(&mut rng);
// Store it on one of the workers.
primary.workers[0].process_unconfirmed_solution(solution_commitment, solution).await.unwrap();
primary.workers[0].process_unconfirmed_transaction(transaction_id, transaction).await.unwrap();
// Check that the worker has 2 transmissions.
assert_eq!(primary.workers[0].num_transmissions(), 2);
// Create certificates for the current round.
let account = accounts[0].1.clone();
let (certificate, transmissions) =
create_batch_certificate(account.address(), &accounts, round, previous_certificate_ids.clone(), &mut rng);
let certificate_id = certificate.id();
// Randomly abort some of the transmissions.
let mut aborted_transmissions = HashSet::new();
let mut transmissions_without_aborted = HashMap::new();
for (transmission_id, transmission) in transmissions.clone() {
match rng.gen::<bool>() || aborted_transmissions.is_empty() {
true => {
// Insert the aborted transmission.
aborted_transmissions.insert(transmission_id);
}
false => {
// Insert the transmission without the aborted transmission.
transmissions_without_aborted.insert(transmission_id, transmission);
}
};
}
// Add the non-aborted transmissions to the worker.
for (transmission_id, transmission) in transmissions_without_aborted.iter() {
primary.workers[0].process_transmission_from_peer(peer_ip, *transmission_id, transmission.clone());
}
// Check that inserting the transmission with missing transmissions fails.
assert!(
primary
.storage
.check_certificate(&certificate, transmissions_without_aborted.clone(), Default::default())
.is_err()
);
assert!(
primary
.storage
.insert_certificate(certificate.clone(), transmissions_without_aborted.clone(), Default::default())
.is_err()
);
// Insert the certificate to storage.
primary
.storage
.insert_certificate(certificate, transmissions_without_aborted, aborted_transmissions.clone())
.unwrap();
// Ensure the certificate exists in storage.
assert!(primary.storage.contains_certificate(certificate_id));
// Ensure that the aborted transmission IDs exist in storage.
for aborted_transmission_id in aborted_transmissions {
assert!(primary.storage.contains_transmission(aborted_transmission_id));
assert!(primary.storage.get_transmission(aborted_transmission_id).is_none());
}
}
}