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
use anchor_lang::prelude::*;
use anchor_lang::solana_program::system_program;
use anchor_lang::solana_program::sysvar;
use anchor_spl::token::{Mint, TokenAccount};
use crate::errors::*;
use crate::state::*;
use crate::util::*;
/// This instruction creates the global config account and sets the
/// DFlow admin.
/// The DFlow admin controls access to the protocol by granting roles
/// to accounts that allow them to perform privileged actions such
/// as auction management. This instruction must be the first instruction
/// called after program deployment and can only be called once.
#[derive(Accounts)]
#[instruction(
global_config_account_bump: u8,
)]
pub struct InitGlobalConfigInstruction<'info> {
/// This account stores the DFlow admin's public key.
/// This account is being initialized with 40 bytes, paid for by
/// dflow_admin. This account is a PDA generated by the following
/// seeds: the string literal `global_config`
#[account(
init,
payer = dflow_admin,
space = 40,
seeds = [
b"global_config".as_ref(),
],
bump
)]
pub global_config_account: Account<'info, GlobalConfigAccount>,
/// The public key of the DFlow admin. This account
/// is a signer for the instruction. This account is expected to
/// be mutable
#[account(
signer,
mut,
)]
pub dflow_admin: AccountInfo<'info>,
#[account(address = system_program::ID)]
pub system_program: AccountInfo<'info>,
pub rent: Sysvar<'info, Rent>,
}
/// This instruction updates the DFlow admin.
/// The current DFlow admin can use this instruction to assign a
/// new DFlow admin.
#[derive(Accounts)]
#[instruction(
global_config_account_bump: u8,
)]
pub struct SetNewDflowAdmin<'info> {
/// This account stores the DFlow admin's public key.
/// This account is a PDA generated by the following seeds: the string
/// literal `global_config`. This account is expected to be mutable
#[account(
seeds = [
b"global_config".as_ref(),
],
bump = global_config_account_bump,
mut,
)]
pub global_config_account: Account<'info, GlobalConfigAccount>,
/// The public key of the DFlow admin. This account
/// is a signer for the instruction
#[account(signer)]
pub dflow_admin: AccountInfo<'info>,
/// The new DFlow admin's public key.
pub new_dflow_admin: AccountInfo<'info>,
}
/// This instruction creates the principal's whitelist entry account
/// and grants the specified role to the principal.
#[derive(Accounts)]
#[instruction(
global_config_account_bump: u8,
whitelist_entry_bump: u8,
)]
pub struct GrantRoleUninitializedEntry<'info> {
/// This account stores the DFlow admin's public key.
/// This account is a PDA generated by the following seeds: the string
/// literal `global_config`
#[account(
seeds = [
b"global_config".as_ref(),
],
bump = global_config_account_bump,
)]
pub global_config_account: Account<'info, GlobalConfigAccount>,
/// The account to which the whitelist permissions apply.
pub principal: AccountInfo<'info>,
/// The public key of the DFlow admin. This account
/// is a signer for the instruction. This account is expected to
/// be mutable
#[account(
signer,
mut,
)]
pub dflow_admin: AccountInfo<'info>,
/// This account stores the permissions that apply
/// to the principal. This account is being initialized with 42 bytes,
/// paid for by dflow_admin. This account is a PDA generated by the
/// following seeds: the string literal `whitelist_entry`, the public
/// key of the principal account
#[account(
init,
payer = dflow_admin,
space = 42,
seeds = [
b"whitelist_entry".as_ref(),
principal.key.as_ref(),
],
bump
)]
pub whitelist_entry: Account<'info, WhitelistEntry>,
#[account(address = system_program::ID)]
pub system_program: AccountInfo<'info>,
pub rent: Sysvar<'info, Rent>,
}
/// This instruction grants the specified role to the principal.
#[derive(Accounts)]
#[instruction(
global_config_account_bump: u8,
whitelist_entry_bump: u8,
)]
pub struct GrantRole<'info> {
/// This account stores the DFlow admin's public key.
/// This account is a PDA generated by the following seeds: the string
/// literal `global_config`
#[account(
seeds = [
b"global_config".as_ref(),
],
bump = global_config_account_bump,
)]
pub global_config_account: Account<'info, GlobalConfigAccount>,
/// The account to which the whitelist permissions apply.
pub principal: AccountInfo<'info>,
/// The public key of the DFlow admin. This account
/// is a signer for the instruction. This account is expected to
/// be mutable
#[account(
signer,
mut,
)]
pub dflow_admin: AccountInfo<'info>,
/// This account stores the permissions that apply
/// to the principal. This account is expected to be mutable. This
/// account is a PDA generated by the following seeds: the string
/// literal `whitelist_entry`, the public key of the principal account
#[account(
mut,
seeds = [
b"whitelist_entry".as_ref(),
principal.key.as_ref(),
],
bump = whitelist_entry_bump,
)]
pub whitelist_entry: Account<'info, WhitelistEntry>,
}
/// This instruction revokes the specified role from the principal
/// and closes the principal's whitelist account if it no longer
/// grants any permissions.
#[derive(Accounts)]
#[instruction(
global_config_account_bump: u8,
whitelist_entry_bump: u8,
)]
pub struct RevokeRole<'info> {
/// This account stores the DFlow admin's public key.
/// This account is a PDA generated by the following seeds: the string
/// literal `global_config`
#[account(
seeds = [
b"global_config".as_ref(),
],
bump = global_config_account_bump,
)]
pub global_config_account: Account<'info, GlobalConfigAccount>,
/// This account stores the permissions that apply
/// to the principal. This account is expected to be mutable. This
/// account is a PDA generated by the following seeds: the string
/// literal `whitelist_entry`, the public key of the principal account
#[account(
mut,
seeds = [
b"whitelist_entry".as_ref(),
principal.key.as_ref(),
],
bump = whitelist_entry_bump,
)]
pub whitelist_entry: Account<'info, WhitelistEntry>,
/// The account to which the whitelist permissions apply.
pub principal: AccountInfo<'info>,
/// The public key of the DFlow admin. This account
/// is a signer for the instruction. This account is expected to
/// be mutable
#[account(
signer,
mut,
)]
pub dflow_admin: AccountInfo<'info>,
}
/// This instruction creates a recovery vault.
/// Recovery vaults are required for all mints used in the protocol.
/// If a transfer recipient does not have a token account set up,
/// the transferor can direct the protocol to transfer the tokens
/// to the recovery vault. The intended recipient can then recover
/// the tokens by submitting a recovery claim.
#[derive(Accounts)]
#[instruction(
recovery_state_account_bump: u8,
recovery_vault_account_bump: u8,
auction_owner_whitelist_entry_bump: u8,
)]
pub struct InitRecoveryVaultInstruction<'info> {
/// The recovery state account holds state specific
/// to the recovery vault. This account is being initialized with
/// 40 bytes, paid for by auction_owner. This account is a PDA generated
/// by the following seeds: the public key of the recovery_vault_mint
/// account, the string literal `recovery_state`
#[account(
init,
payer = auction_owner,
space = 40,
seeds = [
recovery_vault_mint.key().as_ref(),
b"recovery_state".as_ref(),
],
bump
)]
pub recovery_state_account: Account<'info, RecoveryStateAccount>,
/// The recovery vault account is an SPL token account
/// that holds assets that could not be transferred to the intended
/// recipient because the intended recipient did not have a token
/// account at transfer time. Assets deposited into this account
/// are held until the intended recipient makes a claim to retrieve
/// the assets. This account is being initialized and is paid for
/// by auction_owner. This is a token account which is being initialized,
/// and is associated with the recovery_vault_mint mint. The authority
/// for this token account is recovery_state_account. This account
/// is a PDA generated by the following seeds: the public key of
/// the recovery_vault_mint account, the string literal `recovery_vault`
#[account(
init,
payer = auction_owner,
token::mint = recovery_vault_mint,
token::authority = recovery_state_account,
seeds = [
recovery_vault_mint.key().as_ref(),
b"recovery_vault".as_ref(),
],
bump
)]
pub recovery_vault_account: Account<'info, TokenAccount>,
/// The SPL mint for the recovery vault account.
pub recovery_vault_mint: Account<'info, Mint>,
/// The auction owner is an authority with permission
/// granted by the DFlow admin to create recovery vaults, create
/// new auctions, and halt, resume, or deprecate existing auctions.
/// This account is a signer for the instruction. This account is
/// expected to be mutable
#[account(
signer,
mut,
)]
pub auction_owner: AccountInfo<'info>,
/// This account stores the permissions that apply
/// to the auction_owner. This account is a PDA generated by the
/// following seeds: the string literal `whitelist_entry`, the public
/// key of the auction_owner account
#[account(
seeds = [
b"whitelist_entry".as_ref(),
auction_owner.key.as_ref(),
],
bump = auction_owner_whitelist_entry_bump,
)]
pub auction_owner_whitelist_entry: Account<'info, WhitelistEntry>,
#[account(address = system_program::ID)]
pub system_program: AccountInfo<'info>,
pub rent: Sysvar<'info, Rent>,
#[account(address = anchor_spl::token::ID)]
pub token_program: AccountInfo<'info>,
}
/// This instruction initializes the auction mapper account.
/// The auction mapper account contains a list of auctions that are
/// not deprecated. Auctions will either be in a trading or halted
/// state. This function can only be called by the DFlow admin.
#[derive(Accounts)]
#[instruction(
global_config_account_bump: u8,
auction_mapper_bump: u8,
)]
pub struct InitAuctionMapperInstruction<'info> {
/// This account stores the DFlow admin's public key.
/// This account is a PDA generated by the following seeds: the string
/// literal `global_config`
#[account(
seeds = [
b"global_config".as_ref(),
],
bump = global_config_account_bump,
)]
pub global_config_account: Account<'info, GlobalConfigAccount>,
/// This account contains a list of non-deprecated
/// auction IDs. This account is being initialized with 8240 bytes,
/// paid for by dflow_admin. This account is a PDA generated by the
/// following seeds: the string literal `mapper`
#[account(
init,
payer = dflow_admin,
space = 8240,
seeds = [
b"mapper".as_ref(),
],
bump
)]
pub auction_mapper: Account<'info, AuctionMapper>,
/// The public key of the DFlow admin. This account
/// is a signer for the instruction. This account is expected to
/// be mutable
#[account(
signer,
mut,
)]
pub dflow_admin: AccountInfo<'info>,
#[account(address = system_program::ID)]
pub system_program: AccountInfo<'info>,
pub rent: Sysvar<'info, Rent>,
}
/// This instruction initializes an auction for order flow, and describes
/// the specifications of the order flow account.
/// This instruction is only callable by an auction owner. Once the
/// auction is initialized, it remains in a Halted state until the
/// auction owner sets the auction state to Trading.
#[derive(Accounts)]
#[instruction(
auction_state_account_bump: u8,
bid_vault_account_bump: u8,
vote_vault_account_bump: u8,
auction_mapper_bump: u8,
auction_owner_whitelist_entry_bump: u8,
bid_recovery_state_account_bump: u8,
bid_recovery_vault_account_bump: u8,
vote_recovery_state_account_bump: u8,
vote_recovery_vault_account_bump: u8,
/// An unsigned 64 bit integer. The auction ID used as a seed to
/// generate the program derived address
auction_id: u64,
)]
pub struct InitAuctionState<'info> {
/// The auction state account holds state specific
/// to the auction. This account is being initialized with 1280 bytes,
/// paid for by auction_owner. This account is a PDA generated by
/// the following seeds: the string literal `auction_state`, an unsigned
/// 64 bit integer
#[account(
init,
payer = auction_owner,
space = 1280,
seeds = [
b"auction_state".as_ref(),
&auction_id.to_le_bytes(),
],
bump
)]
pub auction_state_account: Account<'info, AuctionStateAccount>,
/// The bid vault account is an SPL token account
/// that holds bids made by market makers in the auctions for order
/// flow. Bids held in this account are held only temporarily, and
/// are distributed out upon fills and fill arbitration. This account
/// is being initialized and is paid for by auction_owner. This is
/// a token account which is being initialized, and is associated
/// with the bid_mint_account mint. The authority for this token
/// account is auction_state_account. This account is a PDA generated
/// by the following seeds: the string literal `bid_vault`, an unsigned
/// 64 bit integer
#[account(
init,
payer = auction_owner,
token::mint = bid_mint_account,
token::authority = auction_state_account,
seeds = [
b"bid_vault".as_ref(),
&auction_id.to_le_bytes(),
],
bump
)]
pub bid_vault_account: Account<'info, TokenAccount>,
/// The vote vault account is an SPL token account
/// that holds votes made by arbiters on each fill. Vote stakes held
/// in this account are returned to the arbiters upon honest voting
/// of the fill. This account is being initialized and is paid for
/// by auction_owner. This is a token account which is being initialized,
/// and is associated with the vote_mint_account mint. The authority
/// for this token account is auction_state_account. This account
/// is a PDA generated by the following seeds: the string literal
/// `vote_vault`, an unsigned 64 bit integer
#[account(
init,
payer = auction_owner,
token::mint = vote_mint_account,
token::authority = auction_state_account,
seeds = [
b"vote_vault".as_ref(),
&auction_id.to_le_bytes(),
],
bump
)]
pub vote_vault_account: Account<'info, TokenAccount>,
/// This account contains a list of non-deprecated
/// auction IDs. This account is expected to be mutable. This account
/// is a PDA generated by the following seeds: the string literal
/// `mapper`
#[account(
mut,
seeds = [
b"mapper".as_ref(),
],
bump = auction_mapper_bump,
)]
pub auction_mapper: Box<Account<'info, AuctionMapper>>,
/// The auction owner is an authority with permission
/// granted by the DFlow admin to create recovery vaults, create
/// new auctions, and halt, resume, or deprecate existing auctions.
/// This account is a signer for the instruction. This account is
/// expected to be mutable
#[account(
signer,
mut,
)]
pub auction_owner: AccountInfo<'info>,
/// This account stores the permissions that apply
/// to the auction_owner. This account is a PDA generated by the
/// following seeds: the string literal `whitelist_entry`, the public
/// key of the auction_owner account
#[account(
seeds = [
b"whitelist_entry".as_ref(),
auction_owner.key.as_ref(),
],
bump = auction_owner_whitelist_entry_bump,
)]
pub auction_owner_whitelist_entry: Account<'info, WhitelistEntry>,
/// The SPL mint associated with the token that market
/// makers use to bid in the order flow auctions.
pub bid_mint_account: Box<Account<'info, Mint>>,
/// The SPL mint associated with the token that arbiters
/// use to vote on the fairness of the fills.
pub vote_mint_account: Box<Account<'info, Mint>>,
/// The recovery state account for the bid mint. This
/// account is a PDA generated by the following seeds: the public
/// key of the bid_mint_account account, the string literal `recovery_state`
#[account(
seeds = [
bid_mint_account.key().as_ref(),
b"recovery_state".as_ref(),
],
bump = bid_recovery_state_account_bump,
)]
pub bid_recovery_state_account: Box<Account<'info, RecoveryStateAccount>>,
/// The recovery vault account for the bid mint. This
/// account is a PDA generated by the following seeds: the public
/// key of the bid_mint_account account, the string literal `recovery_vault`
#[account(
seeds = [
bid_mint_account.key().as_ref(),
b"recovery_vault".as_ref(),
],
bump = bid_recovery_vault_account_bump,
)]
pub bid_recovery_vault_account: Box<Account<'info, TokenAccount>>,
/// The recovery state account for the vote mint.
/// This account is a PDA generated by the following seeds: the public
/// key of the vote_mint_account account, the string literal `recovery_state`
#[account(
seeds = [
vote_mint_account.key().as_ref(),
b"recovery_state".as_ref(),
],
bump = vote_recovery_state_account_bump,
)]
pub vote_recovery_state_account: Box<Account<'info, RecoveryStateAccount>>,
/// The recovery vault account for the vote mint.
/// This account is a PDA generated by the following seeds: the public
/// key of the vote_mint_account account, the string literal `recovery_vault`
#[account(
seeds = [
vote_mint_account.key().as_ref(),
b"recovery_vault".as_ref(),
],
bump = vote_recovery_vault_account_bump,
)]
pub vote_recovery_vault_account: Box<Account<'info, TokenAccount>>,
#[account(address = system_program::ID)]
pub system_program: AccountInfo<'info>,
pub rent: Sysvar<'info, Rent>,
#[account(address = anchor_spl::token::ID)]
pub token_program: AccountInfo<'info>,
}
/// This instruction adds a currency pair to an existing auction.
/// Only a certain number of token pairs are allowed to exist in
/// an auction and an error is thrown if this instruction is called
/// when the token pairs count is saturated
#[derive(Accounts)]
#[instruction(
auction_state_account_bump: u8,
base_recovery_state_account_bump: u8,
base_recovery_vault_account_bump: u8,
quote_recovery_state_account_bump: u8,
quote_recovery_vault_account_bump: u8,
auction_owner_whitelist_entry_bump: u8,
/// An unsigned 64 bit integer. The auction ID used as a seed to
/// generate the program derived address
auction_id: u64,
)]
pub struct AddCurrencyPair<'info> {
/// The auction state account holds state specific
/// to the auction. This account is expected to be mutable. This
/// account is a PDA generated by the following seeds: the string
/// literal `auction_state`, an unsigned 64 bit integer
#[account(
mut,
seeds = [
b"auction_state".as_ref(),
&auction_id.to_le_bytes(),
],
bump = auction_state_account_bump,
)]
pub auction_state_account: Box<Account<'info, AuctionStateAccount>>,
/// The SPL mint associated with the base token in
/// a currency pair.
pub base_currency: Account<'info, Mint>,
/// The SPL mint associated with the quote token in
/// a currency pair.
pub quote_currency: Account<'info, Mint>,
/// The Pyth price oracle associated with the base
/// token in a currency pair.
pub base_oracle: AccountInfo<'info>,
/// The Pyth price oracle associated with the quote
/// token in a currency pair.
pub quote_oracle: AccountInfo<'info>,
/// The recovery state account for the base mint.
/// This account is a PDA generated by the following seeds: the public
/// key of the base_currency account, the string literal `recovery_state`
#[account(
seeds = [
base_currency.key().as_ref(),
b"recovery_state".as_ref(),
],
bump = base_recovery_state_account_bump,
)]
pub base_recovery_state_account: Box<Account<'info, RecoveryStateAccount>>,
/// The recovery vault account for the base mint.
/// This account is a PDA generated by the following seeds: the public
/// key of the base_currency account, the string literal `recovery_vault`
#[account(
seeds = [
base_currency.key().as_ref(),
b"recovery_vault".as_ref(),
],
bump = base_recovery_vault_account_bump,
)]
pub base_recovery_vault_account: Account<'info, TokenAccount>,
/// The recovery state account for the quote mint.
/// This account is a PDA generated by the following seeds: the public
/// key of the quote_currency account, the string literal `recovery_state`
#[account(
seeds = [
quote_currency.key().as_ref(),
b"recovery_state".as_ref(),
],
bump = quote_recovery_state_account_bump,
)]
pub quote_recovery_state_account: Box<Account<'info, RecoveryStateAccount>>,
/// The recovery vault account for the quote mint.
/// This account is a PDA generated by the following seeds: the public
/// key of the quote_currency account, the string literal `recovery_vault`
#[account(
seeds = [
quote_currency.key().as_ref(),
b"recovery_vault".as_ref(),
],
bump = quote_recovery_vault_account_bump,
)]
pub quote_recovery_vault_account: Account<'info, TokenAccount>,
/// The auction owner is an authority with permission
/// granted by the DFlow admin to create recovery vaults, create
/// new auctions, and halt, resume, or deprecate existing auctions.
/// This account is a signer for the instruction
#[account(signer)]
pub auction_owner: AccountInfo<'info>,
/// This account stores the permissions that apply
/// to the auction_owner. This account is a PDA generated by the
/// following seeds: the string literal `whitelist_entry`, the public
/// key of the auction_owner account
#[account(
seeds = [
b"whitelist_entry".as_ref(),
auction_owner.key.as_ref(),
],
bump = auction_owner_whitelist_entry_bump,
)]
pub auction_owner_whitelist_entry: Account<'info, WhitelistEntry>,
#[account(address = anchor_spl::token::ID)]
pub token_program: AccountInfo<'info>,
}
/// This instruction changes the status of an auction
/// This instruction can be used to change the status of an auction
/// between Halted, Trading, or Expired. Once Expired, the auction
/// will not be revivable.
#[derive(Accounts)]
#[instruction(
auction_state_account_bump: u8,
auction_mapper_bump: u8,
auction_owner_whitelist_entry_bump: u8,
/// An unsigned 64 bit integer. The auction ID used as a seed to
/// generate the program derived address
auction_id: u64,
)]
pub struct ChangeAuctionStatus<'info> {
/// The auction state account holds state specific
/// to the auction. This account is expected to be mutable. This
/// account is being closed, and the destination of the lamports
/// will be the auction_owner account. This account is a PDA generated
/// by the following seeds: the string literal `auction_state`, an
/// unsigned 64 bit integer
#[account(
mut,
seeds = [
b"auction_state".as_ref(),
&auction_id.to_le_bytes(),
],
bump = auction_state_account_bump,
)]
pub auction_state_account: Account<'info, AuctionStateAccount>,
/// This account contains a list of non-deprecated
/// auction IDs. This account is expected to be mutable. This account
/// is a PDA generated by the following seeds: the string literal
/// `mapper`
#[account(
mut,
seeds = [
b"mapper".as_ref(),
],
bump = auction_mapper_bump,
)]
pub auction_mapper: Account<'info, AuctionMapper>,
/// The auction owner is an authority with permission
/// granted by the DFlow admin to create recovery vaults, create
/// new auctions, and halt, resume, or deprecate existing auctions.
/// This account is a signer for the instruction. This account is
/// expected to be mutable
#[account(
signer,
mut,
)]
pub auction_owner: AccountInfo<'info>,
/// This account stores the permissions that apply
/// to the auction_owner. This account is a PDA generated by the
/// following seeds: the string literal `whitelist_entry`, the public
/// key of the auction_owner account
#[account(
seeds = [
b"whitelist_entry".as_ref(),
auction_owner.key.as_ref(),
],
bump = auction_owner_whitelist_entry_bump,
)]
pub auction_owner_whitelist_entry: Account<'info, WhitelistEntry>,
#[account(address = system_program::ID)]
pub system_program: AccountInfo<'info>,
}
/// This instruction initializes the market maker account
/// The market maker account tracks state specific to the market
/// maker's market making activities. This instruction must be called
/// prior to a market maker being active on DFlow.
#[derive(Accounts)]
#[instruction(
market_maker_whitelist_entry_bump: u8,
)]
pub struct InitMarketMakerAccountInstruction<'info> {
/// The account storing state specific to the market
/// maker. This account must be owned by the DFlow program, and this
/// account must be initialized by calling the initialize market
/// maker instruction. This account is expected to be zeroed out
/// upon the start of instruction processing
#[account(zero)]
pub market_maker_data_account: Account<'info, MarketMakerDataAccount>,
/// The public key of the market maker. This account
/// is a signer for the instruction
#[account(signer)]
pub market_maker_account_owner: AccountInfo<'info>,
/// This account stores the permissions that apply
/// to the market_maker_account_owner. This account is a PDA generated
/// by the following seeds: the string literal `whitelist_entry`,
/// the public key of the market_maker_account_owner account
#[account(
seeds = [
b"whitelist_entry".as_ref(),
market_maker_account_owner.key.as_ref(),
],
bump = market_maker_whitelist_entry_bump,
)]
pub market_maker_whitelist_entry: Account<'info, WhitelistEntry>,
}
/// This instruction updates the market maker's 256-bit X25519 public
/// key.
/// Retail traders use the market maker's 256-bit X25519 public key
/// to encrypt their order details when routing orders to the market
/// maker. This instruction updates the market maker's X25519 public
/// key.
#[derive(Accounts)]
#[instruction(
market_maker_whitelist_entry_bump: u8,
)]
pub struct UpdateEncryptionKeyInstruction<'info> {
/// The account storing state specific to the market
/// maker. This account must be owned by the DFlow program, and this
/// account must be initialized by calling the initialize market
/// maker instruction. This account is expected to be mutable
#[account(mut)]
pub market_maker_data_account: Account<'info, MarketMakerDataAccount>,
/// The public key of the market maker. This account
/// is a signer for the instruction
#[account(signer)]
pub market_maker_account_owner: AccountInfo<'info>,
/// This account stores the permissions that apply
/// to the market_maker_account_owner. This account is a PDA generated
/// by the following seeds: the string literal `whitelist_entry`,
/// the public key of the market_maker_account_owner account
#[account(
seeds = [
b"whitelist_entry".as_ref(),
market_maker_account_owner.key.as_ref(),
],
bump = market_maker_whitelist_entry_bump,
)]
pub market_maker_whitelist_entry: Account<'info, WhitelistEntry>,
}
/// This instruction initializes an auction epoch state account
/// AuctionEpochState carries state specific to a certain auction
/// that needs to be remembered after the epoch ends. The AuctionEpochState
/// accounts associated with auction epochs N and N + 1 need to be
/// initialized when the auction for epoch N begins (i.e. in the
/// first SubmitAuctionBid that auction N will receive). Recall that
/// if the AuctionState has an epoch field that has value X, then
/// auction X is currently active, and auction X - 1 is currently
/// receiving order flow.
#[derive(Accounts)]
#[instruction(
auction_epoch_state_bump: u8,
auction_state_account_bump: u8,
/// An unsigned 64 bit integer. The auction ID used as a seed to
/// generate the program derived address
auction_id: u64,
/// An unsigned 64 bit integer. The integer epoch used to generate
/// the PDA of the auction epoch account
auction_epoch: u64,
)]
pub struct InitAuctionEpochStateInstruction<'info> {
/// The auction epoch state account holds state specific
/// to an epoch of the auction, if that state must be remembered
/// beyond the duration of that auction epoch. This account is being
/// initialized with 101 bytes, paid for by owner. This account is
/// a PDA generated by the following seeds: the string literal `epoch`,
/// an unsigned 64 bit integer, an unsigned 64 bit integer
#[account(
init,
payer = owner,
space = 101,
seeds = [
b"epoch".as_ref(),
&auction_id.to_le_bytes(),
&auction_epoch.to_le_bytes(),
],
bump
)]
pub auction_epoch_state: Account<'info, AuctionEpochState>,
/// The auction state account holds state specific
/// to the auction. This account is expected to be mutable. This
/// account is a PDA generated by the following seeds: the string
/// literal `auction_state`, an unsigned 64 bit integer
#[account(
mut,
seeds = [
b"auction_state".as_ref(),
&auction_id.to_le_bytes(),
],
bump = auction_state_account_bump,
)]
pub auction_state_account: Account<'info, AuctionStateAccount>,
/// The creator and owner of AuctionEpochState account.
/// This account is a signer for the instruction. This account is
/// expected to be mutable
#[account(
signer,
mut,
)]
pub owner: AccountInfo<'info>,
#[account(address = system_program::ID)]
pub system_program: AccountInfo<'info>,
pub rent: Sysvar<'info, Rent>,
}
/// This instruction initializes the retail traders account.
/// The retail data account tracks state specific to the retail trader's
/// trading activities on DFlow.
#[derive(Accounts)]
#[instruction(
)]
pub struct InitRetailDataAccountInstruction<'info> {
/// The retail data account holds state specific to
/// the retail trader. This account is expected to be zeroed out
/// upon the start of instruction processing
#[account(zero)]
pub retail_data_account: Account<'info, RetailDataAccount>,
/// The public key of the retail trader. This account
/// is a signer for the instruction
#[account(signer)]
pub retail_account_owner: AccountInfo<'info>,
}
/// This instruction closes the retail trader's data account.
/// When retail traders wish to close their account, and regain the
/// lamports used to allocate the space for their data account, they
/// can call this instruction. Retail traders may not close their
/// account if they have open orders, and must wait for the orders
/// to be filled, or cancel them.
#[derive(Accounts)]
#[instruction(
)]
pub struct CloseRetailDataAccount<'info> {
/// The retail data account holds state specific to
/// the retail trader. This account is being closed, and the destination
/// of the lamports will be the retail_account_owner account. This
/// account is expected to be mutable
#[account(
mut,
)]
pub retail_data_account: Account<'info, RetailDataAccount>,
/// The public key of the retail trader. This account
/// is a signer for the instruction. This account is expected to
/// be mutable
#[account(
signer,
mut,
)]
pub retail_account_owner: AccountInfo<'info>,
#[account(address = system_program::ID)]
pub system_program: AccountInfo<'info>,
}
/// This instruction is called by the market maker prior to bidding
/// in an auction.
/// Before a market maker bids in an auction, they must use this
/// instruction to initialize an account to track their current bid
/// in the auction.
#[derive(Accounts)]
#[instruction(
auction_state_account_bump: u8,
auction_epoch_state_bump: u8,
bid_record_account_bump: u8,
market_maker_whitelist_entry_bump: u8,
/// An unsigned 64 bit integer. The auction ID used as a seed to
/// generate the program derived address
auction_id: u64,
/// An unsigned 64 bit integer. The integer epoch used to generate
/// the PDA of the auction epoch account
auction_epoch: u64,
)]
pub struct InitBidRecordAccount<'info> {
/// The auction state account holds state specific
/// to the auction. This account is a PDA generated by the following
/// seeds: the string literal `auction_state`, an unsigned 64 bit
/// integer
#[account(
seeds = [
b"auction_state".as_ref(),
&auction_id.to_le_bytes(),
],
bump = auction_state_account_bump,
)]
pub auction_state_account: Account<'info, AuctionStateAccount>,
/// The auction epoch state account holds state specific
/// to an epoch of the auction, if that state must be remembered
/// beyond the duration of that auction epoch. This account is a
/// PDA generated by the following seeds: the string literal `epoch`,
/// an unsigned 64 bit integer, an unsigned 64 bit integer
#[account(
seeds = [
b"epoch".as_ref(),
&auction_id.to_le_bytes(),
&auction_epoch.to_le_bytes(),
],
bump = auction_epoch_state_bump,
)]
pub auction_epoch_state: Account<'info, AuctionEpochState>,
/// The account which tracks the market maker's current
/// bid in the auction. This account is being initialized with 16
/// bytes, paid for by market_maker_account_owner. This account is
/// a PDA generated by the following seeds: the string literal `bid_record`,
/// an unsigned 64 bit integer, an unsigned 64 bit integer, the public
/// key of the market_maker_data_account account
#[account(
init,
payer = market_maker_account_owner,
space = 16,
seeds = [
b"bid_record".as_ref(),
&auction_id.to_le_bytes(),
&auction_epoch.to_le_bytes(),
market_maker_data_account.key().as_ref(),
],
bump
)]
pub bid_record_account: Account<'info, BidRecordAccount>,
/// The account storing state specific to the market
/// maker. This account must be owned by the DFlow program, and this
/// account must be initialized by calling the initialize market
/// maker instruction.
pub market_maker_data_account: Account<'info, MarketMakerDataAccount>,
/// The public key of the market maker. This account
/// is a signer for the instruction. This account is expected to
/// be mutable
#[account(
signer,
mut,
)]
pub market_maker_account_owner: AccountInfo<'info>,
/// This account stores the permissions that apply
/// to the market_maker_account_owner. This account is a PDA generated
/// by the following seeds: the string literal `whitelist_entry`,
/// the public key of the market_maker_account_owner account
#[account(
seeds = [
b"whitelist_entry".as_ref(),
market_maker_account_owner.key.as_ref(),
],
bump = market_maker_whitelist_entry_bump,
)]
pub market_maker_whitelist_entry: Account<'info, WhitelistEntry>,
#[account(address = system_program::ID)]
pub system_program: AccountInfo<'info>,
pub rent: Sysvar<'info, Rent>,
}
/// This instruction is called by the market maker to bid in an auction.
/// When a market maker wishes to bid in an auction, they can use
/// this instruction to specify the parameters of their bid. Note
/// that the first bidder in auction epoch N must ensure that auction
/// epoch state accounts are initialized for auction epochs N and
/// N + 1.
#[derive(Accounts)]
#[instruction(
auction_state_account_bump: u8,
auction_epoch_state_bump: u8,
next_auction_epoch_state_bump: u8,
bid_vault_account_bump: u8,
bid_record_account_bump: u8,
market_maker_whitelist_entry_bump: u8,
/// An unsigned 64 bit integer. The auction ID used as a seed to
/// generate the program derived address
auction_id: u64,
/// An unsigned 64 bit integer. The integer epoch used to generate
/// the PDA of the auction epoch account
auction_epoch: u64,
/// An unsigned 64 bit integer. The next auction epoch number. If
/// bidding in auction epoch N, this must be N + 1.
next_auction_epoch: u64,
)]
pub struct SubmitAuctionBidInstruction<'info> {
/// The auction state account holds state specific
/// to the auction. This account is expected to be mutable. This
/// account is a PDA generated by the following seeds: the string
/// literal `auction_state`, an unsigned 64 bit integer
#[account(
mut,
seeds = [
b"auction_state".as_ref(),
&auction_id.to_le_bytes(),
],
bump = auction_state_account_bump,
)]
pub auction_state_account: Box<Account<'info, AuctionStateAccount>>,
/// The auction epoch state account holds state specific
/// to an epoch of the auction, if that state must be remembered
/// beyond the duration of that auction epoch. This account is expected
/// to be mutable. This account is a PDA generated by the following
/// seeds: the string literal `epoch`, an unsigned 64 bit integer,
/// an unsigned 64 bit integer
#[account(
mut,
seeds = [
b"epoch".as_ref(),
&auction_id.to_le_bytes(),
&auction_epoch.to_le_bytes(),
],
bump = auction_epoch_state_bump,
)]
pub auction_epoch_state: Account<'info, AuctionEpochState>,
/// The auction epoch state account for the next epoch.
/// This account is a PDA generated by the following seeds: the string
/// literal `epoch`, an unsigned 64 bit integer, an unsigned 64 bit
/// integer
#[account(
seeds = [
b"epoch".as_ref(),
&auction_id.to_le_bytes(),
&next_auction_epoch.to_le_bytes(),
],
bump = next_auction_epoch_state_bump,
)]
pub next_auction_epoch_state: Box<Account<'info, AuctionEpochState>>,
/// The bid vault account is an SPL token account
/// that holds bids made by market makers in the auctions for order
/// flow. Bids held in this account are held only temporarily, and
/// are distributed out upon fills and fill arbitration. This account
/// is expected to be mutable. This account is a PDA generated by
/// the following seeds: the string literal `bid_vault`, an unsigned
/// 64 bit integer
#[account(
mut,
seeds = [
b"bid_vault".as_ref(),
&auction_id.to_le_bytes(),
],
bump = bid_vault_account_bump,
)]
pub bid_vault_account: Account<'info, TokenAccount>,
/// The account storing state specific to the market
/// maker. This account must be owned by the DFlow program, and this
/// account must be initialized by calling the initialize market
/// maker instruction.
pub market_maker_data_account: Box<Account<'info, MarketMakerDataAccount>>,
/// The SPL token account associated with the market
/// maker used to bid in the auctions. This account is expected to
/// be mutable
#[account(mut)]
pub market_maker_auction_token_account: Account<'info, TokenAccount>,
/// The account which tracks the market maker's current
/// bid in the auction. This account is expected to be mutable. This
/// account is a PDA generated by the following seeds: the string
/// literal `bid_record`, an unsigned 64 bit integer, an unsigned
/// 64 bit integer, the public key of the market_maker_data_account
/// account
#[account(
mut,
seeds = [
b"bid_record".as_ref(),
&auction_id.to_le_bytes(),
&auction_epoch.to_le_bytes(),
market_maker_data_account.key().as_ref(),
],
bump = bid_record_account_bump,
)]
pub bid_record_account: Account<'info, BidRecordAccount>,
/// The public key of the market maker. This account
/// is a signer for the instruction
#[account(signer)]
pub market_maker_account_owner: AccountInfo<'info>,
/// This account stores the permissions that apply
/// to the market_maker_account_owner. This account is a PDA generated
/// by the following seeds: the string literal `whitelist_entry`,
/// the public key of the market_maker_account_owner account
#[account(
seeds = [
b"whitelist_entry".as_ref(),
market_maker_account_owner.key.as_ref(),
],
bump = market_maker_whitelist_entry_bump,
)]
pub market_maker_whitelist_entry: Account<'info, WhitelistEntry>,
#[account(address = anchor_spl::token::ID)]
pub token_program: AccountInfo<'info>,
}
/// This instruction is called by the market maker to withdraw its
/// losing auction bids and close its bid record account for the
/// given auction.
/// A market maker who is outbid in an auction can use this instruction
/// to withdraw its bids in the auction and close its bid record
/// account for the auction. A market maker who has won an auction
/// can use this instruction to close its bid record account for
/// the auction.
#[derive(Accounts)]
#[instruction(
auction_state_account_bump: u8,
auction_epoch_state_bump: u8,
bid_vault_account_bump: u8,
bid_record_account_bump: u8,
market_maker_whitelist_entry_bump: u8,
/// An unsigned 64 bit integer. The auction ID used as a seed to
/// generate the program derived address
auction_id: u64,
/// An unsigned 64 bit integer. The integer epoch used to generate
/// the PDA of the auction epoch account
auction_epoch: u64,
)]
pub struct ReclaimAuctionBidInstruction<'info> {
/// The auction state account holds state specific
/// to the auction. This account is a PDA generated by the following
/// seeds: the string literal `auction_state`, an unsigned 64 bit
/// integer
#[account(
seeds = [
b"auction_state".as_ref(),
&auction_id.to_le_bytes(),
],
bump = auction_state_account_bump,
)]
pub auction_state_account: Box<Account<'info, AuctionStateAccount>>,
/// The auction epoch state account holds state specific
/// to an epoch of the auction, if that state must be remembered
/// beyond the duration of that auction epoch. This account is a
/// PDA generated by the following seeds: the string literal `epoch`,
/// an unsigned 64 bit integer, an unsigned 64 bit integer
#[account(
seeds = [
b"epoch".as_ref(),
&auction_id.to_le_bytes(),
&auction_epoch.to_le_bytes(),
],
bump = auction_epoch_state_bump,
)]
pub auction_epoch_state: Account<'info, AuctionEpochState>,
/// The bid vault account is an SPL token account
/// that holds bids made by market makers in the auctions for order
/// flow. Bids held in this account are held only temporarily, and
/// are distributed out upon fills and fill arbitration. This account
/// is expected to be mutable. This account is a PDA generated by
/// the following seeds: the string literal `bid_vault`, an unsigned
/// 64 bit integer
#[account(
mut,
seeds = [
b"bid_vault".as_ref(),
&auction_id.to_le_bytes(),
],
bump = bid_vault_account_bump,
)]
pub bid_vault_account: Account<'info, TokenAccount>,
/// The account storing state specific to the market
/// maker. This account must be owned by the DFlow program, and this
/// account must be initialized by calling the initialize market
/// maker instruction.
pub market_maker_data_account: Box<Account<'info, MarketMakerDataAccount>>,
/// The SPL token account associated with the market
/// maker used to bid in the auctions. This account is expected to
/// be mutable
#[account(mut)]
pub market_maker_auction_token_account: Account<'info, TokenAccount>,
/// The account which tracks the market maker's current
/// bid in the auction. This account is expected to be mutable. This
/// account is a PDA generated by the following seeds: the string
/// literal `bid_record`, an unsigned 64 bit integer, an unsigned
/// 64 bit integer, the public key of the market_maker_data_account
/// account
#[account(
mut,
seeds = [
b"bid_record".as_ref(),
&auction_id.to_le_bytes(),
&auction_epoch.to_le_bytes(),
market_maker_data_account.key().as_ref(),
],
bump = bid_record_account_bump,
)]
pub bid_record_account: Account<'info, BidRecordAccount>,
/// The public key of the market maker. This account
/// is expected to be mutable. This account is a signer for the instruction
#[account(
mut,
signer,
)]
pub market_maker_account_owner: AccountInfo<'info>,
/// This account stores the permissions that apply
/// to the market_maker_account_owner. This account is a PDA generated
/// by the following seeds: the string literal `whitelist_entry`,
/// the public key of the market_maker_account_owner account
#[account(
seeds = [
b"whitelist_entry".as_ref(),
market_maker_account_owner.key.as_ref(),
],
bump = market_maker_whitelist_entry_bump,
)]
pub market_maker_whitelist_entry: Account<'info, WhitelistEntry>,
#[account(address = anchor_spl::token::ID)]
pub token_program: AccountInfo<'info>,
}
/// This instruction is called by retail traders when they submit
/// their order. A transaction containing this instruction must be
/// signed by a signatory server.
/// When submitting orders, retail traders must encrypt the details
/// of their order in order to hide information regarding which token
/// is being received.
#[derive(Accounts)]
#[instruction(
vault_token_account_bump: u8,
vault_meta_account_bump: u8,
current_auction_epoch_state_bump: u8,
previous_auction_epoch_state_bump: u8,
auction_state_account_bump: u8,
signatory_record_bump: u8,
/// An unsigned 64 bit integer. The auction ID used as a seed to
/// generate the program derived address
auction_id: u64,
/// An unsigned 64 bit integer. The integer epoch used to generate
/// the PDA of the auction epoch account
auction_epoch: u64,
/// An unsigned 64 bit integer. The previous epoch. This must be
/// equal to auction_epoch - 1.
previous_auction_epoch: u64,
)]
pub struct NewOrderInstruction<'info> {
/// The SPL token account owned by the escrow vault,
/// which holds the sold tokens during a swap from the retail trader.
/// This account is being initialized and is paid for by retail_account_owner.
/// This is a token account which is being initialized, and is associated
/// with the x_mint mint. The authority for this token account is
/// vault_meta_account. This account is a PDA generated by the following
/// seeds: the public key of the retail_account_owner account, the
/// string literal `vault`, the unsigned integer field named nonce
/// in the retail_data_account account
#[account(
init,
payer = retail_account_owner,
token::mint = x_mint,
token::authority = vault_meta_account,
seeds = [
retail_account_owner.key.as_ref(),
b"vault".as_ref(),
&retail_data_account.nonce.to_le_bytes(),
],
bump
)]
pub vault_token_account: Account<'info, TokenAccount>,
/// The account which holds state specific to a given
/// order initiated by the retail trader. This account is being initialized
/// with 816 bytes, paid for by retail_account_owner. This account
/// is a PDA generated by the following seeds: the public key of
/// the retail_account_owner account, the string literal `vault_meta`,
/// the unsigned integer field named nonce in the retail_data_account
/// account
#[account(
init,
payer = retail_account_owner,
space = 816,
seeds = [
retail_account_owner.key.as_ref(),
b"vault_meta".as_ref(),
&retail_data_account.nonce.to_le_bytes(),
],
bump
)]
pub vault_meta_account: Box<Account<'info, VaultMetaAccount>>,
/// The auction epoch state account for the current
/// epoch. This account is expected to be mutable. This account is
/// a PDA generated by the following seeds: the string literal `epoch`,
/// an unsigned 64 bit integer, an unsigned 64 bit integer
#[account(
mut,
seeds = [
b"epoch".as_ref(),
&auction_id.to_le_bytes(),
&auction_epoch.to_le_bytes(),
],
bump = current_auction_epoch_state_bump,
)]
pub current_auction_epoch_state: Box<Account<'info, AuctionEpochState>>,
/// The auction epoch state account for the previous
/// epoch. This account is expected to be mutable. This account is
/// a PDA generated by the following seeds: the string literal `epoch`,
/// an unsigned 64 bit integer, an unsigned 64 bit integer
#[account(
mut,
seeds = [
b"epoch".as_ref(),
&auction_id.to_le_bytes(),
&previous_auction_epoch.to_le_bytes(),
],
bump = previous_auction_epoch_state_bump,
)]
pub previous_auction_epoch_state: Account<'info, AuctionEpochState>,
/// The SPL token account associated with the retail
/// trader which is used to deposit the sold token into escrow prior
/// to the trade occurring. This account is expected to be mutable
#[account(mut)]
pub retail_x_token_account: Account<'info, TokenAccount>,
/// The SPL token account associated with the order
/// used to receive a payment from the network, with the same mint
/// as the token accounts used by market makers to bid in the associated
/// auction.
pub rebate_receiver_token_account: Box<Account<'info, TokenAccount>>,
/// The auction state account holds state specific
/// to the auction. This account is expected to be mutable. This
/// account is a PDA generated by the following seeds: the string
/// literal `auction_state`, an unsigned 64 bit integer
#[account(
mut,
seeds = [
b"auction_state".as_ref(),
&auction_id.to_le_bytes(),
],
bump = auction_state_account_bump,
)]
pub auction_state_account: Box<Account<'info, AuctionStateAccount>>,
/// The retail data account holds state specific to
/// the retail trader. This account is expected to be mutable
#[account(mut)]
pub retail_data_account: Box<Account<'info, RetailDataAccount>>,
/// The account storing state specific to the market
/// maker. This account must be owned by the DFlow program, and this
/// account must be initialized by calling the initialize market
/// maker instruction. This account is expected to be mutable
#[account(mut)]
pub market_maker_data_account: Box<Account<'info, MarketMakerDataAccount>>,
/// The public key of the retail trader. This account
/// is a signer for the instruction. This account is expected to
/// be mutable
#[account(
signer,
mut,
)]
pub retail_account_owner: AccountInfo<'info>,
/// The SPL mint account associated with the token
/// that is sold by the retail trader during the swap.
pub x_mint: Account<'info, Mint>,
/// The signatory record account holds information
/// about a signatory server, and the existence of the signatory
/// record account is a valid proof that the signatory server has
/// staked the requisite value in the protocol allowing it to endorse
/// flow as originating from a retail source. This account is a PDA
/// generated by the following seeds: the public key of the signatory_server
/// account
#[account(
seeds = [
signatory_server.key.as_ref(),
],
bump = signatory_record_bump,
)]
pub signatory_record: Account<'info, SignatoryRecord>,
/// The public key of the signatory server that endorses
/// new orders as originating from a retail source. This account
/// is a signer for the instruction. This account is expected to
/// be mutable
#[account(
signer,
mut,
)]
pub signatory_server: AccountInfo<'info>,
#[account(address = system_program::ID)]
pub system_program: AccountInfo<'info>,
pub rent: Sysvar<'info, Rent>,
#[account(address = anchor_spl::token::ID)]
pub token_program: AccountInfo<'info>,
}
/// This instruction cancels an open order.
/// Cancelling an open order can only be done if it has not been
/// filled and if the order has been filled partially, the retail
/// trader can only cancel the part of the order which is still open.
#[derive(Accounts)]
#[instruction(
vault_token_account_bump: u8,
vault_meta_account_bump: u8,
auction_epoch_state_bump: u8,
/// An unsigned 64 bit integer. The nonce used as a seed to generate
/// the PDA for the vault token account, taken from the retail trader's
/// account when the order in question was initially created.
nonce: u64,
)]
pub struct CancelOrderInstruction<'info> {
/// The SPL token account owned by the escrow vault,
/// which holds the sold tokens during a swap from the retail trader.
/// This account is expected to be mutable. This account is being
/// closed, and the destination of the lamports will be the retail_account_owner
/// account. This account is a PDA generated by the following seeds:
/// the public key of the retail_account_owner account, the string
/// literal `vault`, an unsigned 64 bit integer
#[account(
mut,
seeds = [
retail_account_owner.key.as_ref(),
b"vault".as_ref(),
&nonce.to_le_bytes(),
],
bump = vault_token_account_bump,
)]
pub vault_token_account: Account<'info, TokenAccount>,
/// The account which holds state specific to a given
/// order initiated by the retail trader. This account is expected
/// to be mutable. This account is being closed, and the destination
/// of the lamports will be the retail_account_owner account. This
/// account is a PDA generated by the following seeds: the public
/// key of the retail_account_owner account, the string literal `vault_meta`,
/// an unsigned 64 bit integer
#[account(
mut,
seeds = [
retail_account_owner.key.as_ref(),
b"vault_meta".as_ref(),
&nonce.to_le_bytes(),
],
bump = vault_meta_account_bump,
)]
pub vault_meta_account: Box<Account<'info, VaultMetaAccount>>,
/// The auction epoch state account holds state specific
/// to an epoch of the auction, if that state must be remembered
/// beyond the duration of that auction epoch. This account is expected
/// to be mutable. This account is a PDA generated by the following
/// seeds: the string literal `epoch`, the unsigned integer field
/// named auction_id in the vault_meta_account account, the unsigned
/// integer field named auction_epoch in the vault_meta_account account
#[account(
mut,
seeds = [
b"epoch".as_ref(),
&vault_meta_account.auction_id.to_le_bytes(),
&vault_meta_account.auction_epoch.to_le_bytes(),
],
bump = auction_epoch_state_bump,
)]
pub auction_epoch_state: Account<'info, AuctionEpochState>,
/// The retail data account holds state specific to
/// the retail trader. This account is expected to be mutable
#[account(mut)]
pub retail_data_account: Account<'info, RetailDataAccount>,
/// The account storing state specific to the market
/// maker. This account must be owned by the DFlow program, and this
/// account must be initialized by calling the initialize market
/// maker instruction. This account is expected to be mutable
#[account(mut)]
pub market_maker_data_account: Account<'info, MarketMakerDataAccount>,
/// The SPL token account associated with the retail
/// trader which is used to deposit the sold token into escrow prior
/// to the trade occurring. This account is expected to be mutable
#[account(mut)]
pub retail_x_token_account: Account<'info, TokenAccount>,
/// The public key of the retail trader. This account
/// is a signer for the instruction. This account is expected to
/// be mutable
#[account(
signer,
mut,
)]
pub retail_account_owner: AccountInfo<'info>,
/// The SPL mint account associated with the token
/// that is sold by the retail trader during the swap.
pub x_mint: Box<Account<'info, Mint>>,
#[account(address = system_program::ID)]
pub system_program: AccountInfo<'info>,
#[account(address = anchor_spl::token::ID)]
pub token_program: AccountInfo<'info>,
}
/// This instruction is used to fill an open order
/// When a market maker fills an order that is assigned to them,
/// this instruction will partially settle the trade; the retail
/// trader will receive the tokens from the market maker, but the
/// market maker must wait until arbiters have voted on the fairness
/// of the fill in order to receive the retail trader's tokens.
#[derive(Accounts)]
#[instruction(
vault_meta_account_bump: u8,
fill_record_account_bump: u8,
auction_epoch_state_bump: u8,
auction_state_account_bump: u8,
market_maker_whitelist_entry_bump: u8,
y_recovery_vault_account_bump: u8,
/// An unsigned 64 bit integer. The nonce used as a seed to generate
/// the PDA for the vault meta account, taken from the retail trader's
/// account when the order in question was initially created.
nonce: u64,
)]
pub struct FillOrderInstruction<'info> {
/// The account which holds state specific to a given
/// order initiated by the retail trader. This account is expected
/// to be mutable. This account is a PDA generated by the following
/// seeds: the public key of the retail_account_owner account, the
/// string literal `vault_meta`, an unsigned 64 bit integer
#[account(
mut,
seeds = [
retail_account_owner.key.as_ref(),
b"vault_meta".as_ref(),
&nonce.to_le_bytes(),
],
bump = vault_meta_account_bump,
)]
pub vault_meta_account: Box<Account<'info, VaultMetaAccount>>,
/// The account which holds meta-information about
/// the fill, so that arbiters can reference the information when
/// voting on the fairness of the fill. This account is being initialized
/// with 194 bytes, paid for by market_maker_account_owner. This
/// account is a PDA generated by the following seeds: the public
/// key of the vault_meta_account account, the unsigned integer field
/// named fill_nonce in the vault_meta_account account, the string
/// literal `fra`
#[account(
init,
payer = market_maker_account_owner,
space = 194,
seeds = [
vault_meta_account.key().as_ref(),
&vault_meta_account.fill_nonce.to_le_bytes(),
b"fra".as_ref(),
],
bump
)]
pub fill_record_account: Box<Account<'info, FillRecordAccount>>,
/// The retail data account holds state specific to
/// the retail trader. This account is expected to be mutable
#[account(mut)]
pub retail_data_account: Box<Account<'info, RetailDataAccount>>,
/// The account storing state specific to the market
/// maker. This account must be owned by the DFlow program, and this
/// account must be initialized by calling the initialize market
/// maker instruction. This account is expected to be mutable
#[account(mut)]
pub market_maker_data_account: Box<Account<'info, MarketMakerDataAccount>>,
/// The auction epoch state account holds state specific
/// to an epoch of the auction, if that state must be remembered
/// beyond the duration of that auction epoch. This account is expected
/// to be mutable. This account is a PDA generated by the following
/// seeds: the string literal `epoch`, the unsigned integer field
/// named auction_id in the vault_meta_account account, the unsigned
/// integer field named auction_epoch in the vault_meta_account account
#[account(
mut,
seeds = [
b"epoch".as_ref(),
&vault_meta_account.auction_id.to_le_bytes(),
&vault_meta_account.auction_epoch.to_le_bytes(),
],
bump = auction_epoch_state_bump,
)]
pub auction_epoch_state: Account<'info, AuctionEpochState>,
/// The auction state account holds state specific
/// to the auction. This account is a PDA generated by the following
/// seeds: the string literal `auction_state`, the unsigned integer
/// field named auction_id in the vault_meta_account account
#[account(
seeds = [
b"auction_state".as_ref(),
&vault_meta_account.auction_id.to_le_bytes(),
],
bump = auction_state_account_bump,
)]
pub auction_state_account: Box<Account<'info, AuctionStateAccount>>,
/// The public key of the retail trader.
pub retail_account_owner: AccountInfo<'info>,
/// The SPL mint account associated with the token
/// that is sold by the retail trader during the swap.
pub x_mint: Box<Account<'info, Mint>>,
/// The SPL mint account associated with the token
/// that is received by the retail trader during the swap.
pub y_mint: Box<Account<'info, Mint>>,
/// The SPL token account associated with the market
/// maker, and which sends the asset being received by the retail
/// trader during a trade. This account is expected to be mutable
#[account(mut)]
pub market_maker_y_token_account: Account<'info, TokenAccount>,
/// The public key of the market maker. This account
/// is a signer for the instruction. This account is expected to
/// be mutable
#[account(
signer,
mut,
)]
pub market_maker_account_owner: AccountInfo<'info>,
/// This account stores the permissions that apply
/// to the market_maker_account_owner. This account is a PDA generated
/// by the following seeds: the string literal `whitelist_entry`,
/// the public key of the market_maker_account_owner account
#[account(
seeds = [
b"whitelist_entry".as_ref(),
market_maker_account_owner.key.as_ref(),
],
bump = market_maker_whitelist_entry_bump,
)]
pub market_maker_whitelist_entry: Account<'info, WhitelistEntry>,
/// The SPL token account associated with the retail
/// trader, and which receives the asset being sent by the market
/// maker during a trade. This account is expected to be mutable.
/// This account is the retail_y_token_account's associated token
/// account for the mint of the asset sent by the market maker
#[account(
mut,
constraint = is_associated_token_account_address(
&retail_y_token_account.key(),
retail_account_owner.key,
&y_mint.key(),
) @ DFlowError::InvalidRetailYTokenAccount,
)]
pub retail_y_token_account: AccountInfo<'info>,
#[account(address = system_program::ID)]
pub system_program: AccountInfo<'info>,
pub rent: Sysvar<'info, Rent>,
#[account(address = anchor_spl::token::ID)]
pub token_program: AccountInfo<'info>,
#[account(address = sysvar::instructions::ID)]
pub instructions: UncheckedAccount<'info>,
}
/// This instruction is used to vote on the fairness of a fill
/// Arbiters vote on the fairness of a fill when the fill is open
/// for voting. In order to vote on a fill, the arbiter must stake
/// tokens on the accuracy of their vote. If the arbiter voted in
/// the majority, they receive their tokens back. Otherwise the tokens
/// are deposited into a DAO governed backstop fund for the protocol.
#[derive(Accounts)]
#[instruction(
vault_meta_account_bump: u8,
fill_record_account_bump: u8,
vote_record_account_bump: u8,
auction_state_account_bump: u8,
arbiter_whitelist_entry_bump: u8,
vote_vault_account_bump: u8,
/// An unsigned 64 bit integer. The nonce used as a seed to generate
/// the PDA for the vault meta account, taken from the retail trader's
/// account when the order in question was initially created.
nonce: u64,
/// An unsigned 16 bit integer. The fill nonce taken from the vault
/// meta account at fill time, and used to generate the PDA for the
/// fill record account.
fill_nonce: u16,
)]
pub struct FillVoteInstruction<'info> {
/// The account which holds state specific to a given
/// order initiated by the retail trader. This account is a PDA generated
/// by the following seeds: the public key of the retail_account_owner
/// account, the string literal `vault_meta`, an unsigned 64 bit
/// integer
#[account(
seeds = [
retail_account_owner.key.as_ref(),
b"vault_meta".as_ref(),
&nonce.to_le_bytes(),
],
bump = vault_meta_account_bump,
)]
pub vault_meta_account: Box<Account<'info, VaultMetaAccount>>,
/// The account which holds meta-information about
/// the fill, so that arbiters can reference the information when
/// voting on the fairness of the fill. This account is expected
/// to be mutable. This account is a PDA generated by the following
/// seeds: the public key of the vault_meta_account account, an unsigned
/// 16 bit integer, the string literal `fra`
#[account(
mut,
seeds = [
vault_meta_account.key().as_ref(),
&fill_nonce.to_le_bytes(),
b"fra".as_ref(),
],
bump = fill_record_account_bump,
)]
pub fill_record_account: Box<Account<'info, FillRecordAccount>>,
/// The account which holds the voting record made
/// by an arbiter when the arbiter votes on the fairness of the fill.
/// This account is being initialized with 9 bytes, paid for by arbiter.
/// This account is a PDA generated by the following seeds: the public
/// key of the fill_record_account account, the public key of the
/// arbiter account, the string literal `vra`
#[account(
init,
payer = arbiter,
space = 9,
seeds = [
fill_record_account.key().as_ref(),
arbiter.key.as_ref(),
b"vra".as_ref(),
],
bump
)]
pub vote_record_account: Box<Account<'info, VoteRecordAccount>>,
/// The auction state account holds state specific
/// to the auction. This account is a PDA generated by the following
/// seeds: the string literal `auction_state`, the unsigned integer
/// field named auction_id in the vault_meta_account account
#[account(
seeds = [
b"auction_state".as_ref(),
&vault_meta_account.auction_id.to_le_bytes(),
],
bump = auction_state_account_bump,
)]
pub auction_state_account: Account<'info, AuctionStateAccount>,
/// The public key associated with the arbiter. This
/// account is a signer for the instruction. This account is expected
/// to be mutable
#[account(
signer,
mut,
)]
pub arbiter: AccountInfo<'info>,
/// This account stores the permissions that apply
/// to the arbiter. This account is a PDA generated by the following
/// seeds: the string literal `whitelist_entry`, the public key of
/// the arbiter account
#[account(
seeds = [
b"whitelist_entry".as_ref(),
arbiter.key.as_ref(),
],
bump = arbiter_whitelist_entry_bump,
)]
pub arbiter_whitelist_entry: Account<'info, WhitelistEntry>,
/// The public key of the retail trader.
pub retail_account_owner: AccountInfo<'info>,
/// The SPL token account associated with the arbiter
/// used to vote on the fairness of the fill by the market maker.
/// This account is expected to be mutable
#[account(mut)]
pub arbiter_token_account: Account<'info, TokenAccount>,
/// The vote vault account is an SPL token account
/// that holds votes made by arbiters on each fill. Vote stakes held
/// in this account are returned to the arbiters upon honest voting
/// of the fill. This account is expected to be mutable. This account
/// is a PDA generated by the following seeds: the string literal
/// `vote_vault`, the unsigned integer field named auction_id in
/// the vault_meta_account account
#[account(
mut,
seeds = [
b"vote_vault".as_ref(),
&vault_meta_account.auction_id.to_le_bytes(),
],
bump = vote_vault_account_bump,
)]
pub vote_vault_account: Account<'info, TokenAccount>,
#[account(address = system_program::ID)]
pub system_program: AccountInfo<'info>,
pub rent: Sysvar<'info, Rent>,
#[account(address = anchor_spl::token::ID)]
pub token_program: AccountInfo<'info>,
}
/// This instruction is used to claim back the tokens staked during
/// a fill vote by an arbiter.
/// If voting with the majority, the arbiter will receieve a payment
/// from the network along with their original vote. However, if
/// the arbiter did not vote in the majority on the fill, they will
/// not receive their tokens back.
#[derive(Accounts)]
#[instruction(
vault_meta_account_bump: u8,
fill_record_account_bump: u8,
vote_record_account_bump: u8,
vote_vault_account_bump: u8,
bid_vault_account_bump: u8,
auction_state_account_bump: u8,
auction_epoch_state_bump: u8,
arbiter_whitelist_entry_bump: u8,
/// An unsigned 64 bit integer. The nonce used as a seed to generate
/// the PDA for the vault meta account, taken from the retail trader's
/// account when the order in question was initially created.
nonce: u64,
/// An unsigned 16 bit integer. The fill nonce taken from the vault
/// meta account at fill time, and used to generate the PDA for the
/// fill record account.
fill_nonce: u16,
)]
pub struct ClaimVoteRewardInstruction<'info> {
/// The account which holds state specific to a given
/// order initiated by the retail trader. This account is a PDA generated
/// by the following seeds: the public key of the retail_account_owner
/// account, the string literal `vault_meta`, an unsigned 64 bit
/// integer
#[account(
seeds = [
retail_account_owner.key.as_ref(),
b"vault_meta".as_ref(),
&nonce.to_le_bytes(),
],
bump = vault_meta_account_bump,
)]
pub vault_meta_account: Box<Account<'info, VaultMetaAccount>>,
/// The account which holds meta-information about
/// the fill, so that arbiters can reference the information when
/// voting on the fairness of the fill. This account is being closed,
/// and the destination of the lamports will be the market_maker_account_owner
/// account. This account is a PDA generated by the following seeds:
/// the public key of the vault_meta_account account, an unsigned
/// 16 bit integer, the string literal `fra`
#[account(
seeds = [
vault_meta_account.key().as_ref(),
&fill_nonce.to_le_bytes(),
b"fra".as_ref(),
],
bump = fill_record_account_bump,
)]
pub fill_record_account: Box<Account<'info, FillRecordAccount>>,
/// The account which holds the voting record made
/// by an arbiter when the arbiter votes on the fairness of the fill.
/// This account is expected to be mutable. This account is being
/// closed, and the destination of the lamports will be the market_maker_account_owner
/// account. This account is a PDA generated by the following seeds:
/// the public key of the fill_record_account account, the public
/// key of the arbiter account, the string literal `vra`
#[account(
mut,
seeds = [
fill_record_account.key().as_ref(),
arbiter.key.as_ref(),
b"vra".as_ref(),
],
bump = vote_record_account_bump,
)]
pub vote_record_account: Box<Account<'info, VoteRecordAccount>>,
/// The vote vault account is an SPL token account
/// that holds votes made by arbiters on each fill. Vote stakes held
/// in this account are returned to the arbiters upon honest voting
/// of the fill. This account is expected to be mutable. This account
/// is a PDA generated by the following seeds: the string literal
/// `vote_vault`, the unsigned integer field named auction_id in
/// the vault_meta_account account
#[account(
mut,
seeds = [
b"vote_vault".as_ref(),
&vault_meta_account.auction_id.to_le_bytes(),
],
bump = vote_vault_account_bump,
)]
pub vote_vault_account: Account<'info, TokenAccount>,
/// The bid vault account is an SPL token account
/// that holds bids made by market makers in the auctions for order
/// flow. Bids held in this account are held only temporarily, and
/// are distributed out upon fills and fill arbitration. This account
/// is expected to be mutable. This account is a PDA generated by
/// the following seeds: the string literal `bid_vault`, the unsigned
/// integer field named auction_id in the vault_meta_account account
#[account(
mut,
seeds = [
b"bid_vault".as_ref(),
&vault_meta_account.auction_id.to_le_bytes(),
],
bump = bid_vault_account_bump,
)]
pub bid_vault_account: Account<'info, TokenAccount>,
/// The auction state account holds state specific
/// to the auction. This account is a PDA generated by the following
/// seeds: the string literal `auction_state`, the unsigned integer
/// field named auction_id in the vault_meta_account account
#[account(
seeds = [
b"auction_state".as_ref(),
&vault_meta_account.auction_id.to_le_bytes(),
],
bump = auction_state_account_bump,
)]
pub auction_state_account: Box<Account<'info, AuctionStateAccount>>,
/// The auction epoch state account holds state specific
/// to an epoch of the auction, if that state must be remembered
/// beyond the duration of that auction epoch. This account is a
/// PDA generated by the following seeds: the string literal `epoch`,
/// the unsigned integer field named auction_id in the vault_meta_account
/// account, the unsigned integer field named auction_epoch in the
/// vault_meta_account account
#[account(
seeds = [
b"epoch".as_ref(),
&vault_meta_account.auction_id.to_le_bytes(),
&vault_meta_account.auction_epoch.to_le_bytes(),
],
bump = auction_epoch_state_bump,
)]
pub auction_epoch_state: Account<'info, AuctionEpochState>,
/// The SPL token account associated with the arbiter
/// used to receive a payment from the network, with the same mint
/// as the token accounts used by market makers to bid in the associated
/// auction. This account is expected to be mutable
#[account(mut)]
pub arbiter_bid_token_account: Box<Account<'info, TokenAccount>>,
/// The public key associated with the arbiter. This
/// account is a signer for the instruction. This account is expected
/// to be mutable
#[account(
signer,
mut,
)]
pub arbiter: AccountInfo<'info>,
/// This account stores the permissions that apply
/// to the arbiter. This account is a PDA generated by the following
/// seeds: the string literal `whitelist_entry`, the public key of
/// the arbiter account
#[account(
seeds = [
b"whitelist_entry".as_ref(),
arbiter.key.as_ref(),
],
bump = arbiter_whitelist_entry_bump,
)]
pub arbiter_whitelist_entry: Account<'info, WhitelistEntry>,
/// The public key of the retail trader.
pub retail_account_owner: AccountInfo<'info>,
/// The SPL token account associated with the arbiter
/// used to vote on the fairness of the fill by the market maker.
/// This account is expected to be mutable
#[account(mut)]
pub arbiter_token_account: Account<'info, TokenAccount>,
#[account(address = system_program::ID)]
pub system_program: AccountInfo<'info>,
#[account(address = anchor_spl::token::ID)]
pub token_program: AccountInfo<'info>,
}
/// This instruction is used to close the various accounts opened
/// during the lifecycle of the trade, and additionally give a rebate
/// to the order flow source for its order flow.
/// Lamports used to open the accounts will be returned to the payers
/// who opened the accounts.
#[derive(Accounts)]
#[instruction(
vault_token_account_bump: u8,
vault_meta_account_bump: u8,
fill_record_account_bump: u8,
bid_vault_account_bump: u8,
auction_state_account_bump: u8,
auction_epoch_state_bump: u8,
arbiter_whitelist_entry_bump: u8,
bid_recovery_vault_account_bump: u8,
x_recovery_vault_account_bump: u8,
/// An unsigned 64 bit integer. The nonce used as a seed to generate
/// the PDA for the vault token account, taken from the retail trader's
/// account when the order in question was initially created.
nonce: u64,
/// An unsigned 16 bit integer. The fill nonce taken from the vault
/// meta account at fill time, and used to generate the PDA for the
/// fill record account.
fill_nonce: u16,
)]
pub struct CloseFillAccounts<'info> {
/// The SPL token account owned by the escrow vault,
/// which holds the sold tokens during a swap from the retail trader.
/// This account is expected to be mutable. This account is being
/// closed, and the destination of the lamports will be the retail_account_owner
/// account. This account is a PDA generated by the following seeds:
/// the public key of the retail_account_owner account, the string
/// literal `vault`, an unsigned 64 bit integer
#[account(
mut,
seeds = [
retail_account_owner.key.as_ref(),
b"vault".as_ref(),
&nonce.to_le_bytes(),
],
bump = vault_token_account_bump,
)]
pub vault_token_account: Account<'info, TokenAccount>,
/// The account which holds state specific to a given
/// order initiated by the retail trader. This account is expected
/// to be mutable. This account is being closed, and the destination
/// of the lamports will be the retail_account_owner account. This
/// account is a PDA generated by the following seeds: the public
/// key of the retail_account_owner account, the string literal `vault_meta`,
/// an unsigned 64 bit integer. The key of rebate_receiver_token_account
/// must match the field named rebate_receiver_token_account in this
/// account
#[account(
mut,
seeds = [
retail_account_owner.key.as_ref(),
b"vault_meta".as_ref(),
&nonce.to_le_bytes(),
],
bump = vault_meta_account_bump,
has_one = rebate_receiver_token_account @ DFlowError::InvalidRebateReceiverTokenAccount,
)]
pub vault_meta_account: Box<Account<'info, VaultMetaAccount>>,
/// The account which holds meta-information about
/// the fill, so that arbiters can reference the information when
/// voting on the fairness of the fill. This account is expected
/// to be mutable. This account is being closed, and the destination
/// of the lamports will be the market_maker_account_owner account.
/// This account is a PDA generated by the following seeds: the public
/// key of the vault_meta_account account, an unsigned 16 bit integer,
/// the string literal `fra`. The key of market_maker_account_owner
/// must match the field named market_maker_account_owner in this
/// account
#[account(
mut,
seeds = [
vault_meta_account.key().as_ref(),
&fill_nonce.to_le_bytes(),
b"fra".as_ref(),
],
bump = fill_record_account_bump,
has_one = market_maker_account_owner @ DFlowError::InvalidMarketMakerAccountOwner,
)]
pub fill_record_account: Box<Account<'info, FillRecordAccount>>,
/// The bid vault account is an SPL token account
/// that holds bids made by market makers in the auctions for order
/// flow. Bids held in this account are held only temporarily, and
/// are distributed out upon fills and fill arbitration. This account
/// is expected to be mutable. This account is a PDA generated by
/// the following seeds: the string literal `bid_vault`, the unsigned
/// integer field named auction_id in the vault_meta_account account
#[account(
mut,
seeds = [
b"bid_vault".as_ref(),
&vault_meta_account.auction_id.to_le_bytes(),
],
bump = bid_vault_account_bump,
)]
pub bid_vault_account: Account<'info, TokenAccount>,
/// The auction state account holds state specific
/// to the auction. This account is a PDA generated by the following
/// seeds: the string literal `auction_state`, the unsigned integer
/// field named auction_id in the vault_meta_account account
#[account(
seeds = [
b"auction_state".as_ref(),
&vault_meta_account.auction_id.to_le_bytes(),
],
bump = auction_state_account_bump,
)]
pub auction_state_account: Box<Account<'info, AuctionStateAccount>>,
/// The auction epoch state account holds state specific
/// to an epoch of the auction, if that state must be remembered
/// beyond the duration of that auction epoch. This account is expected
/// to be mutable. This account is a PDA generated by the following
/// seeds: the string literal `epoch`, the unsigned integer field
/// named auction_id in the vault_meta_account account, the unsigned
/// integer field named auction_epoch in the vault_meta_account account
#[account(
mut,
seeds = [
b"epoch".as_ref(),
&vault_meta_account.auction_id.to_le_bytes(),
&vault_meta_account.auction_epoch.to_le_bytes(),
],
bump = auction_epoch_state_bump,
)]
pub auction_epoch_state: Account<'info, AuctionEpochState>,
/// The SPL token account associated with the market
/// maker, and which receives the asset sold by the retail trader
/// during a trade. This account is expected to be mutable. This
/// account is the market_maker_account_owner's associated token
/// account for the mint of the asset sent by the retail trader
#[account(
mut,
constraint = is_associated_token_account_address(
&market_maker_x_token_account.key(),
market_maker_account_owner.key,
&vault_token_account.mint,
) @ DFlowError::InvalidMarketMakerXTokenAccount,
)]
pub market_maker_x_token_account: AccountInfo<'info>,
/// The retail data account holds state specific to
/// the retail trader. This account is expected to be mutable. The
/// key of retail_account_owner must match the field named retail_account_owner
/// in this account
#[account(
mut,
has_one = retail_account_owner @ DFlowError::InvalidCloseFillRetailDataAccount,
)]
pub retail_data_account: Account<'info, RetailDataAccount>,
/// The public key of the market maker. This account
/// is expected to be mutable
#[account(mut)]
pub market_maker_account_owner: AccountInfo<'info>,
/// The public key associated with the arbiter. This
/// account is a signer for the instruction
#[account(signer)]
pub arbiter: AccountInfo<'info>,
/// This account stores the permissions that apply
/// to the arbiter. This account is a PDA generated by the following
/// seeds: the string literal `whitelist_entry`, the public key of
/// the arbiter account
#[account(
seeds = [
b"whitelist_entry".as_ref(),
arbiter.key.as_ref(),
],
bump = arbiter_whitelist_entry_bump,
)]
pub arbiter_whitelist_entry: Account<'info, WhitelistEntry>,
/// The public key of the retail trader. This account
/// is expected to be mutable
#[account(mut)]
pub retail_account_owner: AccountInfo<'info>,
/// The SPL token account associated with the order
/// used to receive a payment from the network, with the same mint
/// as the token accounts used by market makers to bid in the associated
/// auction. This account is expected to be mutable
#[account(mut)]
pub rebate_receiver_token_account: AccountInfo<'info>,
#[account(address = system_program::ID)]
pub system_program: AccountInfo<'info>,
#[account(address = anchor_spl::token::ID)]
pub token_program: AccountInfo<'info>,
}
/// This instruction is used to initialize global state for tracking
/// the system of signatory servers.
/// This instruction can only be called by the DFlow admin and can
/// only be called once.
#[derive(Accounts)]
#[instruction(
global_config_account_bump: u8,
signatory_state_bump: u8,
signatory_stake_vault_bump: u8,
)]
pub struct InitSignatorySystem<'info> {
/// This account stores the DFlow admin's public key.
/// This account is a PDA generated by the following seeds: the string
/// literal `global_config`
#[account(
seeds = [
b"global_config".as_ref(),
],
bump = global_config_account_bump,
)]
pub global_config_account: Account<'info, GlobalConfigAccount>,
/// The signatory state account holds information
/// about the global system of signatory servers, and the existence
/// of the signatory state account is a valid proof that the signatory
/// server system has been initialized. This account is being initialized
/// with 40 bytes, paid for by dflow_admin. This account is a PDA
/// generated by the following seeds: the string literal `sigstate`
#[account(
init,
payer = dflow_admin,
space = 40,
seeds = [
b"sigstate".as_ref(),
],
bump
)]
pub signatory_state: Account<'info, SignatoryState>,
/// The signatory stake vault holds staked assets
/// from signatory server operators. This account is being initialized
/// and is paid for by dflow_admin. This is a token account which
/// is being initialized, and is associated with the signatory_stake_mint
/// mint. The authority for this token account is signatory_state.
/// This account is a PDA generated by the following seeds: the string
/// literal `sigstake`
#[account(
init,
payer = dflow_admin,
token::mint = signatory_stake_mint,
token::authority = signatory_state,
seeds = [
b"sigstake".as_ref(),
],
bump
)]
pub signatory_stake_vault: Account<'info, TokenAccount>,
/// The SPL mint account associated with the token
/// that is staked by the signatory server.
pub signatory_stake_mint: Account<'info, Mint>,
/// The public key of the DFlow admin. This account
/// is a signer for the instruction. This account is expected to
/// be mutable
#[account(
signer,
mut,
)]
pub dflow_admin: AccountInfo<'info>,
#[account(address = system_program::ID)]
pub system_program: AccountInfo<'info>,
pub rent: Sysvar<'info, Rent>,
#[account(address = anchor_spl::token::ID)]
pub token_program: AccountInfo<'info>,
}
/// This instruction is used to stake the requisite amount of tokens
/// necessary to endorse flow as retail. This stake is subject to
/// slashing based on the quality of the order flow sent by the signatory
/// server.
/// Signatory server operators provide helpful network participation
/// by endorsing and forwarding retail order flow to the network.
/// This helpful network participation is rewarded, or slashed based
/// on the quality of order flow sent.
#[derive(Accounts)]
#[instruction(
signatory_record_bump: u8,
signatory_stake_vault_bump: u8,
signatory_server_whitelist_entry_bump: u8,
)]
pub struct CreateSignatory<'info> {
/// The signatory record account holds information
/// about a signatory server, and the existence of the signatory
/// record account is a valid proof that the signatory server has
/// staked the requisite value in the protocol allowing it to endorse
/// flow as originating from a retail source. This account is being
/// initialized with 48 bytes, paid for by signatory_server. This
/// account is a PDA generated by the following seeds: the public
/// key of the signatory_server account
#[account(
init,
payer = signatory_server,
space = 48,
seeds = [
signatory_server.key.as_ref(),
],
bump
)]
pub signatory_record: Account<'info, SignatoryRecord>,
/// The signatory stake vault holds staked assets
/// from signatory server operators. This account is expected to
/// be mutable. This account is a PDA generated by the following
/// seeds: the string literal `sigstake`
#[account(
mut,
seeds = [
b"sigstake".as_ref(),
],
bump = signatory_stake_vault_bump,
)]
pub signatory_stake_vault: Account<'info, TokenAccount>,
/// The signatory server's token account used for
/// originating the stake transfer. This account is expected to be
/// mutable
#[account(mut)]
pub signatory_server_token_account: Account<'info, TokenAccount>,
/// The public key of the signatory server that endorses
/// new orders as originating from a retail source. This account
/// is a signer for the instruction. This account is expected to
/// be mutable
#[account(
signer,
mut,
)]
pub signatory_server: AccountInfo<'info>,
/// This account stores the permissions that apply
/// to the signatory_server. This account is a PDA generated by the
/// following seeds: the string literal `whitelist_entry`, the public
/// key of the signatory_server account
#[account(
seeds = [
b"whitelist_entry".as_ref(),
signatory_server.key.as_ref(),
],
bump = signatory_server_whitelist_entry_bump,
)]
pub signatory_server_whitelist_entry: Account<'info, WhitelistEntry>,
#[account(address = system_program::ID)]
pub system_program: AccountInfo<'info>,
pub rent: Sysvar<'info, Rent>,
#[account(address = anchor_spl::token::ID)]
pub token_program: AccountInfo<'info>,
}
/// This instruction is used to stake additional tokens into an existing
/// signatory server stake vault.
/// Signatory servers are subject to slashing, and if slashed to
/// below the stake minimum they may no longer be qualified to endorse
/// order flow as originated from a retail source.
#[derive(Accounts)]
#[instruction(
signatory_record_bump: u8,
signatory_stake_vault_bump: u8,
signatory_server_whitelist_entry_bump: u8,
)]
pub struct StakeSignatory<'info> {
/// The signatory record account holds information
/// about a signatory server, and the existence of the signatory
/// record account is a valid proof that the signatory server has
/// staked the requisite value in the protocol allowing it to endorse
/// flow as originating from a retail source. This account is expected
/// to be mutable. This account is a PDA generated by the following
/// seeds: the public key of the signatory_server account
#[account(
mut,
seeds = [
signatory_server.key.as_ref(),
],
bump = signatory_record_bump,
)]
pub signatory_record: Account<'info, SignatoryRecord>,
/// The signatory stake vault holds staked assets
/// from signatory server operators. This account is expected to
/// be mutable. This account is a PDA generated by the following
/// seeds: the string literal `sigstake`
#[account(
mut,
seeds = [
b"sigstake".as_ref(),
],
bump = signatory_stake_vault_bump,
)]
pub signatory_stake_vault: Account<'info, TokenAccount>,
/// The signatory server's token account used for
/// originating the stake transfer. This account is expected to be
/// mutable
#[account(mut)]
pub signatory_server_token_account: Account<'info, TokenAccount>,
/// The public key of the signatory server that endorses
/// new orders as originating from a retail source. This account
/// is a signer for the instruction. This account is expected to
/// be mutable
#[account(
signer,
mut,
)]
pub signatory_server: AccountInfo<'info>,
/// This account stores the permissions that apply
/// to the signatory_server. This account is a PDA generated by the
/// following seeds: the string literal `whitelist_entry`, the public
/// key of the signatory_server account
#[account(
seeds = [
b"whitelist_entry".as_ref(),
signatory_server.key.as_ref(),
],
bump = signatory_server_whitelist_entry_bump,
)]
pub signatory_server_whitelist_entry: Account<'info, WhitelistEntry>,
#[account(address = anchor_spl::token::ID)]
pub token_program: AccountInfo<'info>,
}
/// This instruction is used to close an AuctionEpochState account.
/// The auction owner can use this instruction to close the AuctionEpochState
/// account for an old epoch that has no open orders or fills pending
/// settlement. The auction owner can also use this instruction close
/// the AuctionEpochState account for the last, current, or next
/// epoch if the auction is in the Draining state.
#[derive(Accounts)]
#[instruction(
auction_epoch_state_bump: u8,
auction_state_account_bump: u8,
/// An unsigned 64 bit integer. The auction ID used as a seed to
/// generate the program derived address
auction_id: u64,
/// An unsigned 64 bit integer. The integer epoch used to generate
/// the PDA of the auction epoch account
auction_epoch: u64,
)]
pub struct CloseAuctionEpochState<'info> {
/// The auction epoch state account holds state specific
/// to an epoch of the auction, if that state must be remembered
/// beyond the duration of that auction epoch. This account is expected
/// to be mutable. This account is being closed, and the destination
/// of the lamports will be the auction_owner account. This account
/// is a PDA generated by the following seeds: the string literal
/// `epoch`, an unsigned 64 bit integer, an unsigned 64 bit integer.
/// The key of owner must match the field named owner in this account
#[account(
mut,
seeds = [
b"epoch".as_ref(),
&auction_id.to_le_bytes(),
&auction_epoch.to_le_bytes(),
],
bump = auction_epoch_state_bump,
has_one = owner @ DFlowError::InvalidCloseAuctionEpochStateOwner,
)]
pub auction_epoch_state: Account<'info, AuctionEpochState>,
/// The auction state account holds state specific
/// to the auction. This account is expected to be mutable. This
/// account is a PDA generated by the following seeds: the string
/// literal `auction_state`, an unsigned 64 bit integer
#[account(
mut,
seeds = [
b"auction_state".as_ref(),
&auction_id.to_le_bytes(),
],
bump = auction_state_account_bump,
)]
pub auction_state_account: Account<'info, AuctionStateAccount>,
/// The account that created the AuctionEpochState
/// account by calling init_auction_epoch_state_account. This account
/// is a signer for the instruction. This account is expected to
/// be mutable
#[account(
signer,
mut,
)]
pub owner: AccountInfo<'info>,
#[account(address = system_program::ID)]
pub system_program: AccountInfo<'info>,
}