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
//! Program instructions
use {
crate::{
state::{
enums::MintMaxVoterWeightSource,
governance::{
get_governance_address, get_mint_governance_address,
get_program_governance_address, get_token_governance_address, GovernanceConfig,
},
native_treasury::get_native_treasury_address,
program_metadata::get_program_metadata_address,
proposal::{get_proposal_address, VoteType},
proposal_deposit::get_proposal_deposit_address,
proposal_transaction::{get_proposal_transaction_address, InstructionData},
realm::{
get_governing_token_holding_address, get_realm_address,
GoverningTokenConfigAccountArgs, GoverningTokenConfigArgs, RealmConfigArgs,
SetRealmAuthorityAction,
},
realm_config::get_realm_config_address,
required_signatory::get_required_signatory_address,
signatory_record::get_signatory_record_address,
token_owner_record::get_token_owner_record_address,
vote_record::{get_vote_record_address, Vote},
},
tools::bpf_loader_upgradeable::get_program_data_address,
},
borsh::{BorshDeserialize, BorshSchema, BorshSerialize},
solana_program::{
bpf_loader_upgradeable,
instruction::{AccountMeta, Instruction},
pubkey::Pubkey,
system_program, sysvar,
},
};
/// Instructions supported by the Governance program
#[derive(Clone, Debug, PartialEq, Eq, BorshDeserialize, BorshSerialize, BorshSchema)]
#[allow(clippy::large_enum_variant)]
pub enum GovernanceInstruction {
/// Creates Governance Realm account which aggregates governances for given
/// Community Mint and optional Council Mint
///
/// 0. `[writable]` Governance Realm account.
/// * PDA seeds:['governance',name]
/// 1. `[]` Realm authority
/// 2. `[]` Community Token Mint
/// 3. `[writable]` Community Token Holding account.
/// * PDA seeds: ['governance',realm,community_mint]
/// The account will be created with the Realm PDA as its owner
/// 4. `[signer]` Payer
/// 5. `[]` System
/// 6. `[]` SPL Token
/// 7. `[]` Sysvar Rent
/// 8. `[]` Council Token Mint - optional
/// 9. `[writable]` Council Token Holding account - optional unless council
/// is used.
/// * PDA seeds: ['governance',realm,council_mint]
/// The account will be created with the Realm PDA as its owner
/// 10. `[writable]` RealmConfig account.
/// * PDA seeds: ['realm-config', realm]
/// 11. `[]` Optional Community Voter Weight Addin Program Id
/// 12. `[]` Optional Max Community Voter Weight Addin Program Id
/// 13. `[]` Optional Council Voter Weight Addin Program Id
/// 14. `[]` Optional Max Council Voter Weight Addin Program Id
CreateRealm {
#[allow(dead_code)]
/// UTF-8 encoded Governance Realm name
name: String,
#[allow(dead_code)]
/// Realm config args
config_args: RealmConfigArgs,
},
/// Deposits governing tokens (Community or Council) to Governance Realm and
/// establishes your voter weight to be used for voting within the Realm
/// Note: If subsequent (top up) deposit is made and there are active votes
/// for the Voter then the vote weights won't be updated automatically
/// It can be done by relinquishing votes on active Proposals and voting
/// again with the new weight
///
/// 0. `[]` Realm account
/// 1. `[writable]` Governing Token Holding account.
/// * PDA seeds: ['governance',realm, governing_token_mint]
/// 2. `[writable]` Governing Token Source account. It can be either
/// spl-token TokenAccount or MintAccount Tokens will be transferred or
/// minted to the Holding account
/// 3. `[signer]` Governing Token Owner account
/// 4. `[signer]` Governing Token Source account authority It should be
/// owner for TokenAccount and mint_authority for MintAccount
/// 5. `[writable]` TokenOwnerRecord account.
/// * PDA seeds: ['governance',realm, governing_token_mint,
/// governing_token_owner]
/// 6. `[signer]` Payer
/// 7. `[]` System
/// 8. `[]` SPL Token program
/// 9. `[]` RealmConfig account.
/// * PDA seeds: ['realm-config', realm]
DepositGoverningTokens {
/// The amount to deposit into the realm
#[allow(dead_code)]
amount: u64,
},
/// Withdraws governing tokens (Community or Council) from Governance Realm
/// and downgrades your voter weight within the Realm.
/// Note: It's only possible to withdraw tokens if the Voter doesn't have
/// any outstanding active votes.
/// If there are any outstanding votes then they must be relinquished
/// before tokens could be withdrawn
///
/// 0. `[]` Realm account
/// 1. `[writable]` Governing Token Holding account.
/// * PDA seeds: ['governance',realm, governing_token_mint]
/// 2. `[writable]` Governing Token Destination account. All tokens will be
/// transferred to this account
/// 3. `[signer]` Governing Token Owner account
/// 4. `[writable]` TokenOwnerRecord account.
/// * PDA seeds: ['governance',realm, governing_token_mint,
/// governing_token_owner]
/// 5. `[]` SPL Token program
/// 6. `[]` RealmConfig account.
/// * PDA seeds: ['realm-config', realm]
WithdrawGoverningTokens {},
/// Sets Governance Delegate for the given Realm and Governing Token Mint
/// (Community or Council). The Delegate would have voting rights and
/// could vote on behalf of the Governing Token Owner. The Delegate would
/// also be able to create Proposals on behalf of the Governing Token
/// Owner.
/// Note: This doesn't take voting rights from the Token Owner who still can
/// vote and change governance_delegate
///
/// 0. `[signer]` Current Governance Delegate or Governing Token owner
/// 1. `[writable]` Token Owner Record
SetGovernanceDelegate {
#[allow(dead_code)]
/// New Governance Delegate
new_governance_delegate: Option<Pubkey>,
},
/// Creates Governance account which can be used to govern any arbitrary
/// Solana account or asset
///
/// 0. `[]` Realm account the created Governance belongs to
/// 1. `[writable]` Account Governance account.
/// * PDA seeds: ['account-governance', realm, governed_account]
/// 2. `[]` Account governed by this Governance Note: The account doesn't
/// have to exist and can be only used as a unique identifier for the
/// Governance account
/// 3. `[]` Governing TokenOwnerRecord account (Used only if not signed by
/// RealmAuthority)
/// 4. `[signer]` Payer
/// 5. `[]` System program
/// 6. `[signer]` Governance authority
/// 7. `[]` RealmConfig account.
/// * PDA seeds: ['realm-config', realm]
/// 8. `[]` Optional Voter Weight Record
CreateGovernance {
/// Governance config
#[allow(dead_code)]
config: GovernanceConfig,
},
/// Creates Program Governance account which governs an upgradable program
///
/// 0. `[]` Realm account the created Governance belongs to
/// 1. `[writable]` Program Governance account.
/// * PDA seeds: ['program-governance', realm, governed_program]
/// 2. `[]` Program governed by this Governance account
/// 3. `[writable]` Program Data account of the Program governed by this
/// Governance account
/// 4. `[signer]` Current Upgrade Authority account of the Program
/// governed by this Governance account
/// 5. `[]` Governing TokenOwnerRecord account (Used only if not signed by
/// RealmAuthority)
/// 6. `[signer]` Payer
/// 7. `[]` bpf_upgradeable_loader program
/// 8. `[]` System program
/// 9. `[signer]` Governance authority
/// 10. `[]` RealmConfig account.
/// * PDA seeds: ['realm-config', realm]
/// 11. `[]` Optional Voter Weight Record
CreateProgramGovernance {
/// Governance config
#[allow(dead_code)]
config: GovernanceConfig,
#[allow(dead_code)]
/// Indicates whether Program's upgrade_authority should be transferred
/// to the Governance PDA If it's set to false then it can be
/// done at a later time However the instruction would validate
/// the current upgrade_authority signed the transaction nonetheless
transfer_upgrade_authority: bool,
},
/// Creates Proposal account for Transactions which will be executed at some
/// point in the future
///
/// 0. `[]` Realm account the created Proposal belongs to
/// 1. `[writable]` Proposal account.
/// * PDA seeds ['governance',governance, governing_token_mint,
/// proposal_seed]
/// 2. `[writable]` Governance account
/// 3. `[writable]` TokenOwnerRecord account of the Proposal owner
/// 4. `[]` Governing Token Mint the Proposal is created for
/// 5. `[signer]` Governance Authority (Token Owner or Governance
/// Delegate)
/// 6. `[signer]` Payer
/// 7. `[]` System program
/// 8. `[]` RealmConfig account.
/// * PDA seeds: ['realm-config', realm]
/// 9. `[]` Optional Voter Weight Record
/// 10.`[writable]` Optional ProposalDeposit account.
/// * PDA seeds: ['proposal-deposit', proposal, deposit payer]
/// Proposal deposit is required when there are more active proposals
/// than the configured deposit exempt amount.
/// The deposit is paid by the Payer of the transaction and can be
/// reclaimed using RefundProposalDeposit once the Proposal is no
/// longer active.
CreateProposal {
#[allow(dead_code)]
/// UTF-8 encoded name of the proposal
name: String,
#[allow(dead_code)]
/// Link to a gist explaining the proposal
description_link: String,
#[allow(dead_code)]
/// Proposal vote type
vote_type: VoteType,
#[allow(dead_code)]
/// Proposal options
options: Vec<String>,
#[allow(dead_code)]
/// Indicates whether the proposal has the deny option
/// A proposal without the rejecting option is a non binding survey
/// Only proposals with the rejecting option can have executable
/// transactions
use_deny_option: bool,
#[allow(dead_code)]
/// Unique seed for the Proposal PDA
proposal_seed: Pubkey,
},
/// Adds a signatory to the Proposal which means this Proposal can't leave
/// Draft state until yet another Signatory signs
///
/// 0. `[]` Governance account
/// 1. `[writable]` Proposal account associated with the governance
/// 2. `[writable]` Signatory Record Account
/// 3. `[signer]` Payer
/// 4. `[]` System program
/// Either:
/// - 5. `[]` TokenOwnerRecord account of the Proposal owner
/// 6. `[signer]` Governance Authority (Token Owner or Governance
/// Delegate)
///
/// - 5. `[]` RequiredSignatory account associated with the governance.
AddSignatory {
#[allow(dead_code)]
/// Signatory to add to the Proposal
signatory: Pubkey,
},
/// Formerly RemoveSignatory. Exists for backwards-compatibility.
Legacy1,
/// Inserts Transaction with a set of instructions for the Proposal at the
/// given index position New Transaction must be inserted at the end of
/// the range indicated by Proposal transactions_next_index
/// If a Transaction replaces an existing Transaction at a given index then
/// the old one must be removed using RemoveTransaction first
/// 0. `[]` Governance account
/// 1. `[writable]` Proposal account
/// 2. `[]` TokenOwnerRecord account of the Proposal owner
/// 3. `[signer]` Governance Authority (Token Owner or Governance
/// Delegate)
/// 4. `[writable]` ProposalTransaction, account.
/// * PDA seeds: ['governance', proposal, option_index, index]
/// 5. `[signer]` Payer
/// 6. `[]` System program
/// 7. `[]` Rent sysvar
InsertTransaction {
#[allow(dead_code)]
/// The index of the option the transaction is for
option_index: u8,
#[allow(dead_code)]
/// Transaction index to be inserted at.
index: u16,
#[allow(dead_code)]
/// Waiting time (in seconds) between vote period ending and this being
/// eligible for execution
hold_up_time: u32,
#[allow(dead_code)]
/// Instructions Data
instructions: Vec<InstructionData>,
},
/// Removes Transaction from the Proposal
///
/// 0. `[writable]` Proposal account
/// 1. `[]` TokenOwnerRecord account of the Proposal owner
/// 2. `[signer]` Governance Authority (Token Owner or Governance
/// Delegate)
/// 3. `[writable]` ProposalTransaction, account
/// 4. `[writable]` Beneficiary Account which would receive lamports from
/// the disposed ProposalTransaction account
RemoveTransaction,
/// Cancels Proposal by changing its state to Canceled
///
/// 0. `[]` Realm account
/// 1. `[writable]` Governance account
/// 2. `[writable]` Proposal account
/// 3. `[writable]` TokenOwnerRecord account of the Proposal owner
/// 4. `[signer]` Governance Authority (Token Owner or Governance
/// Delegate)
CancelProposal,
/// Signs off Proposal indicating the Signatory approves the Proposal
/// When the last Signatory signs off the Proposal it enters Voting state
/// Note: Adding signatories to a Proposal is a quality and not a security
/// gate and it's entirely at the discretion of the Proposal owner
/// If Proposal owner doesn't designate any signatories then can sign off
/// the Proposal themself
///
/// 0. `[]` Realm account
/// 1. `[]` Governance account
/// 2. `[writable]` Proposal account
/// 3. `[signer]` Signatory account signing off the Proposal Or Proposal
/// owner if the owner hasn't appointed any signatories
/// 4. `[]` TokenOwnerRecord for the Proposal owner, required when the
/// owner signs off the Proposal Or `[writable]` SignatoryRecord
/// account, required when non owner sings off the Proposal
SignOffProposal,
/// Uses your voter weight (deposited Community or Council tokens) to cast
/// a vote on a Proposal By doing so you indicate you approve or
/// disapprove of running the Proposal set of transactions If you tip
/// the consensus then the transactions can begin to be run after their hold
/// up time
///
/// 0. `[]` Realm account
/// 1. `[writable]` Governance account
/// 2. `[writable]` Proposal account
/// 3. `[writable]` TokenOwnerRecord of the Proposal owner
/// 4. `[writable]` TokenOwnerRecord of the voter.
/// * PDA seeds: ['governance',realm, vote_governing_token_mint,
/// governing_token_owner]
/// 5. `[signer]` Governance Authority (Token Owner or Governance
/// Delegate)
/// 6. `[writable]` Proposal VoteRecord account.
/// * PDA seeds: ['governance',proposal,token_owner_record]
/// 7. `[]` The Governing Token Mint which is used to cast the vote
/// (vote_governing_token_mint).
/// The voting token mint is the governing_token_mint of the Proposal
/// for Approve, Deny and Abstain votes.
/// For Veto vote the voting token mint is the mint of the opposite
/// voting population Council mint to veto Community proposals and
/// Community mint to veto Council proposals.
/// Note: In the current version only Council veto is supported
/// 8. `[signer]` Payer
/// 9. `[]` System program
/// 10. `[]` RealmConfig account.
/// * PDA seeds: ['realm-config', realm]
/// 11. `[]` Optional Voter Weight Record
/// 12. `[]` Optional Max Voter Weight Record
CastVote {
#[allow(dead_code)]
/// User's vote
vote: Vote,
},
/// Finalizes vote in case the Vote was not automatically tipped within
/// max_voting_time period
///
/// 0. `[]` Realm account
/// 1. `[writable]` Governance account
/// 2. `[writable]` Proposal account
/// 3. `[writable]` TokenOwnerRecord of the Proposal owner
/// 4. `[]` Governing Token Mint
/// 5. `[]` RealmConfig account.
/// * PDA seeds: ['realm-config', realm]
/// 6. `[]` Optional Max Voter Weight Record
FinalizeVote {},
/// Relinquish Vote removes voter weight from a Proposal and removes it
/// from voter's active votes. If the Proposal is still being voted on
/// then the voter's weight won't count towards the vote outcome. If the
/// Proposal is already in decided state then the instruction has no impact
/// on the Proposal and only allows voters to prune their outstanding
/// votes in case they wanted to withdraw Governing tokens from the Realm
///
/// 0. `[]` Realm account
/// 1. `[]` Governance account
/// 2. `[writable]` Proposal account
/// 3. `[writable]` TokenOwnerRecord account.
/// * PDA seeds: ['governance',realm, vote_governing_token_mint,
/// governing_token_owner]
/// 4. `[writable]` Proposal VoteRecord account.
/// * PDA seeds: ['governance',proposal, token_owner_record]
/// 5. `[]` The Governing Token Mint which was used to cast the vote
/// (vote_governing_token_mint)
/// 6. `[signer]` Optional Governance Authority (Token Owner or Governance
/// Delegate) It's required only when Proposal is still being voted on
/// 7. `[writable]` Optional Beneficiary account which would receive
/// lamports when VoteRecord Account is disposed It's required only
/// when Proposal is still being voted on
RelinquishVote,
/// Executes a Transaction in the Proposal
/// Anybody can execute transaction once Proposal has been voted Yes and
/// transaction_hold_up time has passed The actual transaction being
/// executed will be signed by Governance PDA the Proposal belongs to
/// For example to execute Program upgrade the ProgramGovernance PDA would
/// be used as the signer
///
/// 0. `[]` Governance account
/// 1. `[writable]` Proposal account
/// 2. `[writable]` ProposalTransaction account you wish to execute
/// 3+ Any extra accounts that are part of the transaction, in order
ExecuteTransaction,
/// Creates Mint Governance account which governs a mint
///
/// 0. `[]` Realm account the created Governance belongs to
/// 1. `[writable]` Mint Governance account.
/// * PDA seeds: ['mint-governance', realm, governed_mint]
/// 2. `[writable]` Mint governed by this Governance account
/// 3. `[signer]` Current Mint authority (MintTokens and optionally
/// FreezeAccount)
/// 4. `[]` Governing TokenOwnerRecord account (Used only if not signed by
/// RealmAuthority)
/// 5. `[signer]` Payer
/// 6. `[]` SPL Token program
/// 7. `[]` System program
/// 8. `[signer]` Governance authority
/// 9. `[]` RealmConfig account.
/// * PDA seeds: ['realm-config', realm]
/// 10. `[]` Optional Voter Weight Record
CreateMintGovernance {
#[allow(dead_code)]
/// Governance config
config: GovernanceConfig,
#[allow(dead_code)]
/// Indicates whether Mint's authorities (MintTokens, FreezeAccount)
/// should be transferred to the Governance PDA. If it's set to
/// false then it can be done at a later time. However the
/// instruction would validate the current mint authority signed the
/// transaction nonetheless
transfer_mint_authorities: bool,
},
/// Creates Token Governance account which governs a token account
///
/// 0. `[]` Realm account the created Governance belongs to
/// 1. `[writable]` Token Governance account.
/// * PDA seeds: ['token-governance', realm, governed_token]
/// 2. `[writable]` Token account governed by this Governance account
/// 3. `[signer]` Current token account authority (AccountOwner and
/// optionally CloseAccount)
/// 4. `[]` Governing TokenOwnerRecord account (Used only if not signed by
/// RealmAuthority)
/// 5. `[signer]` Payer
/// 6. `[]` SPL Token program
/// 7. `[]` System program
/// 8. `[signer]` Governance authority
/// 9. `[]` RealmConfig account.
/// * PDA seeds: ['realm-config', realm]
/// 10. `[]` Optional Voter Weight Record
CreateTokenGovernance {
#[allow(dead_code)]
/// Governance config
config: GovernanceConfig,
#[allow(dead_code)]
/// Indicates whether the token account authorities (AccountOwner and
/// optionally CloseAccount) should be transferred to the Governance PDA
/// If it's set to false then it can be done at a later time
/// However the instruction would validate the current token owner
/// signed the transaction nonetheless
transfer_account_authorities: bool,
},
/// Sets GovernanceConfig for a Governance
///
/// 0. `[]` Realm account the Governance account belongs to
/// 1. `[writable, signer]` The Governance account the config is for
SetGovernanceConfig {
#[allow(dead_code)]
/// New governance config
config: GovernanceConfig,
},
/// Flags a transaction and its parent Proposal with error status
/// It can be used by Proposal owner in case the transaction is permanently
/// broken and can't be executed.
/// Note: This instruction is a workaround because currently it's not
/// possible to catch errors from CPI calls and the Governance program has
/// no way to know when instruction failed and flag it automatically.
///
/// 0. `[writable]` Proposal account
/// 1. `[]` TokenOwnerRecord account of the Proposal owner
/// 2. `[signer]` Governance Authority (Token Owner or Governance
/// Delegate)
/// 3. `[writable]` ProposalTransaction account to flag
FlagTransactionError,
/// Sets new Realm authority
///
/// 0. `[writable]` Realm account
/// 1. `[signer]` Current Realm authority
/// 2. `[]` New realm authority. Must be one of the realm governances when
/// set
SetRealmAuthority {
#[allow(dead_code)]
/// Set action ( SetUnchecked, SetChecked, Remove)
action: SetRealmAuthorityAction,
},
/// Sets realm config
/// 0. `[writable]` Realm account
/// 1. `[signer]` Realm authority
/// 2. `[]` Council Token Mint - optional
/// Note: In the current version it's only possible to remove council
/// mint (set it to None).
/// After setting council to None it won't be possible to withdraw the
/// tokens from the Realm any longer.
/// If that's required then it must be done before executing this
/// instruction.
/// 3. `[writable]` Council Token Holding account - optional unless
/// council is used.
/// * PDA seeds: ['governance',realm,council_mint] The account will be
/// created with the Realm PDA as its owner
/// 4. `[]` System
/// 5. `[writable]` RealmConfig account.
/// * PDA seeds: ['realm-config', realm]
/// 6. `[]` Optional Community Voter Weight Addin Program Id
/// 7. `[]` Optional Max Community Voter Weight Addin Program Id
/// 8. `[]` Optional Council Voter Weight Addin Program Id
/// 9. `[]` Optional Max Council Voter Weight Addin Program Id
/// 10. `[signer]` Optional Payer. Required if RealmConfig doesn't exist
/// and needs to be created
SetRealmConfig {
#[allow(dead_code)]
/// Realm config args
config_args: RealmConfigArgs,
},
/// Creates TokenOwnerRecord with 0 deposit amount
/// It's used to register TokenOwner when voter weight addin is used and the
/// Governance program doesn't take deposits
///
/// 0. `[]` Realm account
/// 1. `[]` Governing Token Owner account
/// 2. `[writable]` TokenOwnerRecord account.
/// * PDA seeds: ['governance',realm, governing_token_mint,
/// governing_token_owner]
/// 3. `[]` Governing Token Mint
/// 4. `[signer]` Payer
/// 5. `[]` System
CreateTokenOwnerRecord {},
/// Updates ProgramMetadata account
/// The instruction dumps information implied by the program's code into a
/// persistent account
///
/// 0. `[writable]` ProgramMetadata account.
/// * PDA seeds: ['metadata']
/// 1. `[signer]` Payer
/// 2. `[]` System
UpdateProgramMetadata {},
/// Creates native SOL treasury account for a Governance account
/// The account has no data and can be used as a payer for instructions
/// signed by Governance PDAs or as a native SOL treasury
///
/// 0. `[]` Governance account the treasury account is for
/// 1. `[writable]` NativeTreasury account.
/// * PDA seeds: ['native-treasury', governance]
/// 2. `[signer]` Payer
/// 3. `[]` System
CreateNativeTreasury,
/// Revokes (burns) membership governing tokens for the given
/// TokenOwnerRecord and hence takes away governance power from the
/// TokenOwner. Note: If there are active votes for the TokenOwner then
/// the vote weights won't be updated automatically
///
/// 0. `[]` Realm account
/// 1. `[writable]` Governing Token Holding account.
/// * PDA seeds: ['governance',realm, governing_token_mint]
/// 2. `[writable]` TokenOwnerRecord account.
/// * PDA seeds: ['governance',realm, governing_token_mint,
/// governing_token_owner]
/// 3. `[writable]` GoverningTokenMint
/// 4. `[signer]` Revoke authority which can be either of:
/// 1) GoverningTokenMint mint_authority to forcefully revoke
/// the membership tokens
/// 2) GoverningTokenOwner who voluntarily revokes their own
/// membership
/// 5. `[]` RealmConfig account.
/// * PDA seeds: ['realm-config', realm]
/// 6. `[]` SPL Token program
RevokeGoverningTokens {
/// The amount to revoke
#[allow(dead_code)]
amount: u64,
},
/// Refunds ProposalDeposit once the given proposal is no longer active
/// (Draft, SigningOff, Voting) Once the condition is met the
/// instruction is permissionless and returns the deposit amount to the
/// deposit payer
///
/// 0. `[]` Proposal account
/// 1. `[writable]` ProposalDeposit account.
/// * PDA seeds: ['proposal-deposit', proposal, deposit payer]
/// 2. `[writable]` Proposal deposit payer (beneficiary) account
RefundProposalDeposit {},
/// Transitions an off-chain or manually executable Proposal from Succeeded
/// into Completed state
///
/// Upon a successful vote on an off-chain or manually executable proposal
/// it remains in Succeeded state Once the external actions are executed
/// the Proposal owner can use the instruction to manually transition it to
/// Completed state
///
///
/// 0. `[writable]` Proposal account
/// 1. `[]` TokenOwnerRecord account of the Proposal owner
/// 2. `[signer]` CompleteProposal authority (Token Owner or Delegate)
CompleteProposal {},
/// Adds a required signatory to the Governance, which will be applied to
/// all proposals created with it
///
/// 0. `[writable, signer]` The Governance account the config is for
/// 1. `[writable]` RequiredSignatory Account
/// 2. `[signer]` Payer
/// 3. `[]` System program
AddRequiredSignatory {
#[allow(dead_code)]
/// Required signatory to add to the Governance
signatory: Pubkey,
},
/// Removes a required signatory from the Governance
///
/// 0. `[writable, signer]` The Governance account the config is for
/// 1. `[writable]` RequiredSignatory Account
/// 2. `[writable]` Beneficiary Account which would receive lamports from
/// the disposed RequiredSignatory Account
RemoveRequiredSignatory,
}
/// Creates CreateRealm instruction
#[allow(clippy::too_many_arguments)]
pub fn create_realm(
program_id: &Pubkey,
// Accounts
realm_authority: &Pubkey,
community_token_mint: &Pubkey,
payer: &Pubkey,
council_token_mint: Option<Pubkey>,
// Accounts Args
community_token_config_args: Option<GoverningTokenConfigAccountArgs>,
council_token_config_args: Option<GoverningTokenConfigAccountArgs>,
// Args
name: String,
min_community_weight_to_create_governance: u64,
community_mint_max_voter_weight_source: MintMaxVoterWeightSource,
) -> Instruction {
let realm_address = get_realm_address(program_id, &name);
let community_token_holding_address =
get_governing_token_holding_address(program_id, &realm_address, community_token_mint);
let mut accounts = vec![
AccountMeta::new(realm_address, false),
AccountMeta::new_readonly(*realm_authority, false),
AccountMeta::new_readonly(*community_token_mint, false),
AccountMeta::new(community_token_holding_address, false),
AccountMeta::new(*payer, true),
AccountMeta::new_readonly(system_program::id(), false),
AccountMeta::new_readonly(spl_token::id(), false),
AccountMeta::new_readonly(sysvar::rent::id(), false),
];
let use_council_mint = if let Some(council_token_mint) = council_token_mint {
let council_token_holding_address =
get_governing_token_holding_address(program_id, &realm_address, &council_token_mint);
accounts.push(AccountMeta::new_readonly(council_token_mint, false));
accounts.push(AccountMeta::new(council_token_holding_address, false));
true
} else {
false
};
let realm_config_address = get_realm_config_address(program_id, &realm_address);
accounts.push(AccountMeta::new(realm_config_address, false));
let community_token_config_args =
with_governing_token_config_args(&mut accounts, community_token_config_args);
let council_token_config_args =
with_governing_token_config_args(&mut accounts, council_token_config_args);
let instruction = GovernanceInstruction::CreateRealm {
config_args: RealmConfigArgs {
use_council_mint,
min_community_weight_to_create_governance,
community_mint_max_voter_weight_source,
community_token_config_args,
council_token_config_args,
},
name,
};
Instruction {
program_id: *program_id,
accounts,
data: instruction.try_to_vec().unwrap(),
}
}
/// Creates DepositGoverningTokens instruction
#[allow(clippy::too_many_arguments)]
pub fn deposit_governing_tokens(
program_id: &Pubkey,
// Accounts
realm: &Pubkey,
governing_token_source: &Pubkey,
governing_token_owner: &Pubkey,
governing_token_source_authority: &Pubkey,
payer: &Pubkey,
// Args
amount: u64,
governing_token_mint: &Pubkey,
) -> Instruction {
let token_owner_record_address = get_token_owner_record_address(
program_id,
realm,
governing_token_mint,
governing_token_owner,
);
let governing_token_holding_address =
get_governing_token_holding_address(program_id, realm, governing_token_mint);
let realm_config_address = get_realm_config_address(program_id, realm);
let accounts = vec![
AccountMeta::new_readonly(*realm, false),
AccountMeta::new(governing_token_holding_address, false),
AccountMeta::new(*governing_token_source, false),
AccountMeta::new_readonly(*governing_token_owner, true),
AccountMeta::new_readonly(*governing_token_source_authority, true),
AccountMeta::new(token_owner_record_address, false),
AccountMeta::new(*payer, true),
AccountMeta::new_readonly(system_program::id(), false),
AccountMeta::new_readonly(spl_token::id(), false),
AccountMeta::new_readonly(realm_config_address, false),
];
let instruction = GovernanceInstruction::DepositGoverningTokens { amount };
Instruction {
program_id: *program_id,
accounts,
data: instruction.try_to_vec().unwrap(),
}
}
/// Creates WithdrawGoverningTokens instruction
pub fn withdraw_governing_tokens(
program_id: &Pubkey,
// Accounts
realm: &Pubkey,
governing_token_destination: &Pubkey,
governing_token_owner: &Pubkey,
// Args
governing_token_mint: &Pubkey,
) -> Instruction {
let token_owner_record_address = get_token_owner_record_address(
program_id,
realm,
governing_token_mint,
governing_token_owner,
);
let governing_token_holding_address =
get_governing_token_holding_address(program_id, realm, governing_token_mint);
let realm_config_address = get_realm_config_address(program_id, realm);
let accounts = vec![
AccountMeta::new_readonly(*realm, false),
AccountMeta::new(governing_token_holding_address, false),
AccountMeta::new(*governing_token_destination, false),
AccountMeta::new_readonly(*governing_token_owner, true),
AccountMeta::new(token_owner_record_address, false),
AccountMeta::new_readonly(spl_token::id(), false),
AccountMeta::new_readonly(realm_config_address, false),
];
let instruction = GovernanceInstruction::WithdrawGoverningTokens {};
Instruction {
program_id: *program_id,
accounts,
data: instruction.try_to_vec().unwrap(),
}
}
/// Creates SetGovernanceDelegate instruction
pub fn set_governance_delegate(
program_id: &Pubkey,
// Accounts
governance_authority: &Pubkey,
// Args
realm: &Pubkey,
governing_token_mint: &Pubkey,
governing_token_owner: &Pubkey,
new_governance_delegate: &Option<Pubkey>,
) -> Instruction {
let vote_record_address = get_token_owner_record_address(
program_id,
realm,
governing_token_mint,
governing_token_owner,
);
let accounts = vec![
AccountMeta::new_readonly(*governance_authority, true),
AccountMeta::new(vote_record_address, false),
];
let instruction = GovernanceInstruction::SetGovernanceDelegate {
new_governance_delegate: *new_governance_delegate,
};
Instruction {
program_id: *program_id,
accounts,
data: instruction.try_to_vec().unwrap(),
}
}
/// Creates CreateGovernance instruction using optional voter weight addin
#[allow(clippy::too_many_arguments)]
pub fn create_governance(
program_id: &Pubkey,
// Accounts
realm: &Pubkey,
governed_account: Option<&Pubkey>,
token_owner_record: &Pubkey,
payer: &Pubkey,
create_authority: &Pubkey,
voter_weight_record: Option<Pubkey>,
// Args
config: GovernanceConfig,
) -> Instruction {
let governed_account_address = if let Some(governed_account) = governed_account {
*governed_account
} else {
// If the governed account is not provided then generate a unique identifier for
// the Governance account
Pubkey::new_unique()
};
let governance_address = get_governance_address(program_id, realm, &governed_account_address);
let mut accounts = vec![
AccountMeta::new_readonly(*realm, false),
AccountMeta::new(governance_address, false),
AccountMeta::new_readonly(governed_account_address, false),
AccountMeta::new_readonly(*token_owner_record, false),
AccountMeta::new(*payer, true),
AccountMeta::new_readonly(system_program::id(), false),
AccountMeta::new_readonly(*create_authority, true),
];
with_realm_config_accounts(program_id, &mut accounts, realm, voter_weight_record, None);
let instruction = GovernanceInstruction::CreateGovernance { config };
Instruction {
program_id: *program_id,
accounts,
data: instruction.try_to_vec().unwrap(),
}
}
/// Creates CreateProgramGovernance instruction
#[allow(clippy::too_many_arguments)]
pub fn create_program_governance(
program_id: &Pubkey,
// Accounts
realm: &Pubkey,
governed_program: &Pubkey,
governed_program_upgrade_authority: &Pubkey,
token_owner_record: &Pubkey,
payer: &Pubkey,
create_authority: &Pubkey,
voter_weight_record: Option<Pubkey>,
// Args
config: GovernanceConfig,
transfer_upgrade_authority: bool,
) -> Instruction {
let program_governance_address =
get_program_governance_address(program_id, realm, governed_program);
let governed_program_data_address = get_program_data_address(governed_program);
let mut accounts = vec![
AccountMeta::new_readonly(*realm, false),
AccountMeta::new(program_governance_address, false),
AccountMeta::new_readonly(*governed_program, false),
AccountMeta::new(governed_program_data_address, false),
AccountMeta::new_readonly(*governed_program_upgrade_authority, true),
AccountMeta::new_readonly(*token_owner_record, false),
AccountMeta::new(*payer, true),
AccountMeta::new_readonly(bpf_loader_upgradeable::id(), false),
AccountMeta::new_readonly(system_program::id(), false),
AccountMeta::new_readonly(*create_authority, true),
];
with_realm_config_accounts(program_id, &mut accounts, realm, voter_weight_record, None);
let instruction = GovernanceInstruction::CreateProgramGovernance {
config,
transfer_upgrade_authority,
};
Instruction {
program_id: *program_id,
accounts,
data: instruction.try_to_vec().unwrap(),
}
}
/// Creates CreateMintGovernance
#[allow(clippy::too_many_arguments)]
pub fn create_mint_governance(
program_id: &Pubkey,
// Accounts
realm: &Pubkey,
governed_mint: &Pubkey,
governed_mint_authority: &Pubkey,
token_owner_record: &Pubkey,
payer: &Pubkey,
create_authority: &Pubkey,
voter_weight_record: Option<Pubkey>,
// Args
config: GovernanceConfig,
transfer_mint_authorities: bool,
) -> Instruction {
let mint_governance_address = get_mint_governance_address(program_id, realm, governed_mint);
let mut accounts = vec![
AccountMeta::new_readonly(*realm, false),
AccountMeta::new(mint_governance_address, false),
AccountMeta::new(*governed_mint, false),
AccountMeta::new_readonly(*governed_mint_authority, true),
AccountMeta::new_readonly(*token_owner_record, false),
AccountMeta::new(*payer, true),
AccountMeta::new_readonly(spl_token::id(), false),
AccountMeta::new_readonly(system_program::id(), false),
AccountMeta::new_readonly(*create_authority, true),
];
with_realm_config_accounts(program_id, &mut accounts, realm, voter_weight_record, None);
let instruction = GovernanceInstruction::CreateMintGovernance {
config,
transfer_mint_authorities,
};
Instruction {
program_id: *program_id,
accounts,
data: instruction.try_to_vec().unwrap(),
}
}
/// Creates CreateTokenGovernance instruction
#[allow(clippy::too_many_arguments)]
pub fn create_token_governance(
program_id: &Pubkey,
// Accounts
realm: &Pubkey,
governed_token: &Pubkey,
governed_token_owner: &Pubkey,
token_owner_record: &Pubkey,
payer: &Pubkey,
create_authority: &Pubkey,
voter_weight_record: Option<Pubkey>,
// Args
config: GovernanceConfig,
transfer_account_authorities: bool,
) -> Instruction {
let token_governance_address = get_token_governance_address(program_id, realm, governed_token);
let mut accounts = vec![
AccountMeta::new_readonly(*realm, false),
AccountMeta::new(token_governance_address, false),
AccountMeta::new(*governed_token, false),
AccountMeta::new_readonly(*governed_token_owner, true),
AccountMeta::new_readonly(*token_owner_record, false),
AccountMeta::new(*payer, true),
AccountMeta::new_readonly(spl_token::id(), false),
AccountMeta::new_readonly(system_program::id(), false),
AccountMeta::new_readonly(*create_authority, true),
];
with_realm_config_accounts(program_id, &mut accounts, realm, voter_weight_record, None);
let instruction = GovernanceInstruction::CreateTokenGovernance {
config,
transfer_account_authorities,
};
Instruction {
program_id: *program_id,
accounts,
data: instruction.try_to_vec().unwrap(),
}
}
/// Creates CreateProposal instruction
#[allow(clippy::too_many_arguments)]
pub fn create_proposal(
program_id: &Pubkey,
// Accounts
governance: &Pubkey,
proposal_owner_record: &Pubkey,
governance_authority: &Pubkey,
payer: &Pubkey,
voter_weight_record: Option<Pubkey>,
// Args
realm: &Pubkey,
name: String,
description_link: String,
governing_token_mint: &Pubkey,
vote_type: VoteType,
options: Vec<String>,
use_deny_option: bool,
proposal_seed: &Pubkey,
) -> Instruction {
let proposal_address =
get_proposal_address(program_id, governance, governing_token_mint, proposal_seed);
let mut accounts = vec![
AccountMeta::new_readonly(*realm, false),
AccountMeta::new(proposal_address, false),
AccountMeta::new(*governance, false),
AccountMeta::new(*proposal_owner_record, false),
AccountMeta::new_readonly(*governing_token_mint, false),
AccountMeta::new_readonly(*governance_authority, true),
AccountMeta::new(*payer, true),
AccountMeta::new_readonly(system_program::id(), false),
];
with_realm_config_accounts(program_id, &mut accounts, realm, voter_weight_record, None);
// Deposit is only required when there are more active proposal then the
// configured exempt amount Note: We always pass the account because the
// actual value is not known here without passing Governance account data
let proposal_deposit_address =
get_proposal_deposit_address(program_id, &proposal_address, payer);
accounts.push(AccountMeta::new(proposal_deposit_address, false));
let instruction = GovernanceInstruction::CreateProposal {
name,
description_link,
vote_type,
options,
use_deny_option,
proposal_seed: *proposal_seed,
};
Instruction {
program_id: *program_id,
accounts,
data: instruction.try_to_vec().unwrap(),
}
}
/// Creates AddSignatory instruction
pub fn add_signatory(
program_id: &Pubkey,
// Accounts
governance: &Pubkey,
proposal: &Pubkey,
add_signatory_authority: &AddSignatoryAuthority,
payer: &Pubkey,
// Args
signatory: &Pubkey,
) -> Instruction {
let signatory_record_address = get_signatory_record_address(program_id, proposal, signatory);
let mut accounts = vec![
AccountMeta::new_readonly(*governance, false),
AccountMeta::new(*proposal, false),
AccountMeta::new(signatory_record_address, false),
AccountMeta::new(*payer, true),
AccountMeta::new_readonly(system_program::id(), false),
];
match add_signatory_authority {
AddSignatoryAuthority::ProposalOwner {
governance_authority,
token_owner_record,
} => {
accounts.push(AccountMeta::new_readonly(*token_owner_record, false));
accounts.push(AccountMeta::new_readonly(*governance_authority, true));
}
AddSignatoryAuthority::None => {
accounts.push(AccountMeta::new_readonly(
get_required_signatory_address(program_id, governance, signatory),
false,
));
}
};
let instruction = GovernanceInstruction::AddSignatory {
signatory: *signatory,
};
Instruction {
program_id: *program_id,
accounts,
data: instruction.try_to_vec().unwrap(),
}
}
#[derive(Debug, Copy, Clone)]
/// Enum to specify the authority by which the instruction should add a
/// signatory
pub enum AddSignatoryAuthority {
/// Proposal owners can add optional signatories to a proposal
ProposalOwner {
/// Token owner or its delegate
governance_authority: Pubkey,
/// Token owner record of the Proposal owner
token_owner_record: Pubkey,
},
/// Anyone can add signatories that are required by the governance to a
/// proposal
None,
}
/// Creates SignOffProposal instruction
pub fn sign_off_proposal(
program_id: &Pubkey,
// Accounts
realm: &Pubkey,
governance: &Pubkey,
proposal: &Pubkey,
signatory: &Pubkey,
proposal_owner_record: Option<&Pubkey>,
) -> Instruction {
let mut accounts = vec![
AccountMeta::new_readonly(*realm, false),
AccountMeta::new_readonly(*governance, false),
AccountMeta::new(*proposal, false),
AccountMeta::new_readonly(*signatory, true),
];
if let Some(proposal_owner_record) = proposal_owner_record {
accounts.push(AccountMeta::new_readonly(*proposal_owner_record, false))
} else {
let signatory_record_address =
get_signatory_record_address(program_id, proposal, signatory);
accounts.push(AccountMeta::new(signatory_record_address, false));
}
let instruction = GovernanceInstruction::SignOffProposal;
Instruction {
program_id: *program_id,
accounts,
data: instruction.try_to_vec().unwrap(),
}
}
/// Creates CastVote instruction
#[allow(clippy::too_many_arguments)]
pub fn cast_vote(
program_id: &Pubkey,
// Accounts
realm: &Pubkey,
governance: &Pubkey,
proposal: &Pubkey,
proposal_owner_record: &Pubkey,
voter_token_owner_record: &Pubkey,
governance_authority: &Pubkey,
vote_governing_token_mint: &Pubkey,
payer: &Pubkey,
voter_weight_record: Option<Pubkey>,
max_voter_weight_record: Option<Pubkey>,
// Args
vote: Vote,
) -> Instruction {
let vote_record_address =
get_vote_record_address(program_id, proposal, voter_token_owner_record);
let mut accounts = vec![
AccountMeta::new_readonly(*realm, false),
AccountMeta::new(*governance, false),
AccountMeta::new(*proposal, false),
AccountMeta::new(*proposal_owner_record, false),
AccountMeta::new(*voter_token_owner_record, false),
AccountMeta::new_readonly(*governance_authority, true),
AccountMeta::new(vote_record_address, false),
AccountMeta::new_readonly(*vote_governing_token_mint, false),
AccountMeta::new(*payer, true),
AccountMeta::new_readonly(system_program::id(), false),
];
with_realm_config_accounts(
program_id,
&mut accounts,
realm,
voter_weight_record,
max_voter_weight_record,
);
let instruction = GovernanceInstruction::CastVote { vote };
Instruction {
program_id: *program_id,
accounts,
data: instruction.try_to_vec().unwrap(),
}
}
/// Creates FinalizeVote instruction
pub fn finalize_vote(
program_id: &Pubkey,
// Accounts
realm: &Pubkey,
governance: &Pubkey,
proposal: &Pubkey,
proposal_owner_record: &Pubkey,
governing_token_mint: &Pubkey,
max_voter_weight_record: Option<Pubkey>,
) -> Instruction {
let mut accounts = vec![
AccountMeta::new_readonly(*realm, false),
AccountMeta::new(*governance, false),
AccountMeta::new(*proposal, false),
AccountMeta::new(*proposal_owner_record, false),
AccountMeta::new_readonly(*governing_token_mint, false),
];
with_realm_config_accounts(
program_id,
&mut accounts,
realm,
None,
max_voter_weight_record,
);
let instruction = GovernanceInstruction::FinalizeVote {};
Instruction {
program_id: *program_id,
accounts,
data: instruction.try_to_vec().unwrap(),
}
}
/// Creates RelinquishVote instruction
#[allow(clippy::too_many_arguments)]
pub fn relinquish_vote(
program_id: &Pubkey,
// Accounts
realm: &Pubkey,
governance: &Pubkey,
proposal: &Pubkey,
token_owner_record: &Pubkey,
vote_governing_token_mint: &Pubkey,
governance_authority: Option<Pubkey>,
beneficiary: Option<Pubkey>,
) -> Instruction {
let vote_record_address = get_vote_record_address(program_id, proposal, token_owner_record);
let mut accounts = vec![
AccountMeta::new_readonly(*realm, false),
AccountMeta::new_readonly(*governance, false),
AccountMeta::new(*proposal, false),
AccountMeta::new(*token_owner_record, false),
AccountMeta::new(vote_record_address, false),
AccountMeta::new_readonly(*vote_governing_token_mint, false),
];
if let Some(governance_authority) = governance_authority {
accounts.push(AccountMeta::new_readonly(governance_authority, true));
accounts.push(AccountMeta::new(beneficiary.unwrap(), false));
}
let instruction = GovernanceInstruction::RelinquishVote {};
Instruction {
program_id: *program_id,
accounts,
data: instruction.try_to_vec().unwrap(),
}
}
/// Creates CancelProposal instruction
pub fn cancel_proposal(
program_id: &Pubkey,
// Accounts
realm: &Pubkey,
governance: &Pubkey,
proposal: &Pubkey,
proposal_owner_record: &Pubkey,
governance_authority: &Pubkey,
) -> Instruction {
let accounts = vec![
AccountMeta::new_readonly(*realm, false),
AccountMeta::new(*governance, false),
AccountMeta::new(*proposal, false),
AccountMeta::new(*proposal_owner_record, false),
AccountMeta::new_readonly(*governance_authority, true),
];
let instruction = GovernanceInstruction::CancelProposal {};
Instruction {
program_id: *program_id,
accounts,
data: instruction.try_to_vec().unwrap(),
}
}
/// Creates InsertTransaction instruction
#[allow(clippy::too_many_arguments)]
pub fn insert_transaction(
program_id: &Pubkey,
// Accounts
governance: &Pubkey,
proposal: &Pubkey,
token_owner_record: &Pubkey,
governance_authority: &Pubkey,
payer: &Pubkey,
// Args
option_index: u8,
index: u16,
hold_up_time: u32,
instructions: Vec<InstructionData>,
) -> Instruction {
let proposal_transaction_address = get_proposal_transaction_address(
program_id,
proposal,
&option_index.to_le_bytes(),
&index.to_le_bytes(),
);
let accounts = vec![
AccountMeta::new_readonly(*governance, false),
AccountMeta::new(*proposal, false),
AccountMeta::new_readonly(*token_owner_record, false),
AccountMeta::new_readonly(*governance_authority, true),
AccountMeta::new(proposal_transaction_address, false),
AccountMeta::new(*payer, true),
AccountMeta::new_readonly(system_program::id(), false),
AccountMeta::new_readonly(sysvar::rent::id(), false),
];
let instruction = GovernanceInstruction::InsertTransaction {
option_index,
index,
hold_up_time,
instructions,
};
Instruction {
program_id: *program_id,
accounts,
data: instruction.try_to_vec().unwrap(),
}
}
/// Creates RemoveTransaction instruction
pub fn remove_transaction(
program_id: &Pubkey,
// Accounts
proposal: &Pubkey,
token_owner_record: &Pubkey,
governance_authority: &Pubkey,
proposal_transaction: &Pubkey,
beneficiary: &Pubkey,
) -> Instruction {
let accounts = vec![
AccountMeta::new(*proposal, false),
AccountMeta::new_readonly(*token_owner_record, false),
AccountMeta::new_readonly(*governance_authority, true),
AccountMeta::new(*proposal_transaction, false),
AccountMeta::new(*beneficiary, false),
];
let instruction = GovernanceInstruction::RemoveTransaction {};
Instruction {
program_id: *program_id,
accounts,
data: instruction.try_to_vec().unwrap(),
}
}
/// Creates ExecuteTransaction instruction
pub fn execute_transaction(
program_id: &Pubkey,
// Accounts
governance: &Pubkey,
proposal: &Pubkey,
proposal_transaction: &Pubkey,
instruction_program_id: &Pubkey,
instruction_accounts: &[AccountMeta],
) -> Instruction {
let mut accounts = vec![
AccountMeta::new_readonly(*governance, false),
AccountMeta::new(*proposal, false),
AccountMeta::new(*proposal_transaction, false),
AccountMeta::new_readonly(*instruction_program_id, false),
];
accounts.extend_from_slice(instruction_accounts);
let instruction = GovernanceInstruction::ExecuteTransaction {};
Instruction {
program_id: *program_id,
accounts,
data: instruction.try_to_vec().unwrap(),
}
}
/// Creates SetGovernanceConfig instruction
pub fn set_governance_config(
program_id: &Pubkey,
// Accounts
governance: &Pubkey,
// Args
config: GovernanceConfig,
) -> Instruction {
let accounts = vec![AccountMeta::new(*governance, true)];
let instruction = GovernanceInstruction::SetGovernanceConfig { config };
Instruction {
program_id: *program_id,
accounts,
data: instruction.try_to_vec().unwrap(),
}
}
/// Creates FlagTransactionError instruction
pub fn flag_transaction_error(
program_id: &Pubkey,
// Accounts
proposal: &Pubkey,
token_owner_record: &Pubkey,
governance_authority: &Pubkey,
proposal_transaction: &Pubkey,
) -> Instruction {
let accounts = vec![
AccountMeta::new(*proposal, false),
AccountMeta::new_readonly(*token_owner_record, false),
AccountMeta::new_readonly(*governance_authority, true),
AccountMeta::new(*proposal_transaction, false),
];
let instruction = GovernanceInstruction::FlagTransactionError {};
Instruction {
program_id: *program_id,
accounts,
data: instruction.try_to_vec().unwrap(),
}
}
/// Creates SetRealmAuthority instruction
pub fn set_realm_authority(
program_id: &Pubkey,
// Accounts
realm: &Pubkey,
realm_authority: &Pubkey,
new_realm_authority: Option<&Pubkey>,
// Args
action: SetRealmAuthorityAction,
) -> Instruction {
let mut accounts = vec![
AccountMeta::new(*realm, false),
AccountMeta::new_readonly(*realm_authority, true),
];
match action {
SetRealmAuthorityAction::SetChecked | SetRealmAuthorityAction::SetUnchecked => {
accounts.push(AccountMeta::new_readonly(
*new_realm_authority.unwrap(),
false,
));
}
SetRealmAuthorityAction::Remove => {}
}
let instruction = GovernanceInstruction::SetRealmAuthority { action };
Instruction {
program_id: *program_id,
accounts,
data: instruction.try_to_vec().unwrap(),
}
}
/// Creates SetRealmConfig instruction
#[allow(clippy::too_many_arguments)]
pub fn set_realm_config(
program_id: &Pubkey,
// Accounts
realm: &Pubkey,
realm_authority: &Pubkey,
council_token_mint: Option<Pubkey>,
payer: &Pubkey,
// Accounts Args
community_token_config_args: Option<GoverningTokenConfigAccountArgs>,
council_token_config_args: Option<GoverningTokenConfigAccountArgs>,
// Args
min_community_weight_to_create_governance: u64,
community_mint_max_voter_weight_source: MintMaxVoterWeightSource,
) -> Instruction {
let mut accounts = vec![
AccountMeta::new(*realm, false),
AccountMeta::new_readonly(*realm_authority, true),
];
let use_council_mint = if let Some(council_token_mint) = council_token_mint {
let council_token_holding_address =
get_governing_token_holding_address(program_id, realm, &council_token_mint);
accounts.push(AccountMeta::new_readonly(council_token_mint, false));
accounts.push(AccountMeta::new(council_token_holding_address, false));
true
} else {
false
};
accounts.push(AccountMeta::new_readonly(system_program::id(), false));
// Always pass realm_config_address because it's needed when
// use_community_voter_weight_addin is set to true but also when it's set to
// false and the addin is being removed from the realm
let realm_config_address = get_realm_config_address(program_id, realm);
accounts.push(AccountMeta::new(realm_config_address, false));
let community_token_config_args =
with_governing_token_config_args(&mut accounts, community_token_config_args);
let council_token_config_args =
with_governing_token_config_args(&mut accounts, council_token_config_args);
accounts.push(AccountMeta::new(*payer, true));
let instruction = GovernanceInstruction::SetRealmConfig {
config_args: RealmConfigArgs {
use_council_mint,
min_community_weight_to_create_governance,
community_mint_max_voter_weight_source,
community_token_config_args,
council_token_config_args,
},
};
Instruction {
program_id: *program_id,
accounts,
data: instruction.try_to_vec().unwrap(),
}
}
/// Adds realm config account and accounts referenced by the config
/// 1) VoterWeightRecord
/// 2) MaxVoterWeightRecord
pub fn with_realm_config_accounts(
program_id: &Pubkey,
accounts: &mut Vec<AccountMeta>,
realm: &Pubkey,
voter_weight_record: Option<Pubkey>,
max_voter_weight_record: Option<Pubkey>,
) {
let realm_config_address = get_realm_config_address(program_id, realm);
accounts.push(AccountMeta::new_readonly(realm_config_address, false));
if let Some(voter_weight_record) = voter_weight_record {
accounts.push(AccountMeta::new_readonly(voter_weight_record, false));
true
} else {
false
};
if let Some(max_voter_weight_record) = max_voter_weight_record {
accounts.push(AccountMeta::new_readonly(max_voter_weight_record, false));
true
} else {
false
};
}
/// Creates CreateTokenOwnerRecord instruction
pub fn create_token_owner_record(
program_id: &Pubkey,
// Accounts
realm: &Pubkey,
governing_token_owner: &Pubkey,
governing_token_mint: &Pubkey,
payer: &Pubkey,
) -> Instruction {
let token_owner_record_address = get_token_owner_record_address(
program_id,
realm,
governing_token_mint,
governing_token_owner,
);
let accounts = vec![
AccountMeta::new_readonly(*realm, false),
AccountMeta::new_readonly(*governing_token_owner, false),
AccountMeta::new(token_owner_record_address, false),
AccountMeta::new_readonly(*governing_token_mint, false),
AccountMeta::new(*payer, true),
AccountMeta::new_readonly(system_program::id(), false),
];
let instruction = GovernanceInstruction::CreateTokenOwnerRecord {};
Instruction {
program_id: *program_id,
accounts,
data: instruction.try_to_vec().unwrap(),
}
}
/// Creates UpdateProgramMetadata instruction
pub fn upgrade_program_metadata(
program_id: &Pubkey,
// Accounts
payer: &Pubkey,
) -> Instruction {
let program_metadata_address = get_program_metadata_address(program_id);
let accounts = vec![
AccountMeta::new(program_metadata_address, false),
AccountMeta::new(*payer, true),
AccountMeta::new_readonly(system_program::id(), false),
];
let instruction = GovernanceInstruction::UpdateProgramMetadata {};
Instruction {
program_id: *program_id,
accounts,
data: instruction.try_to_vec().unwrap(),
}
}
/// Creates CreateNativeTreasury instruction
pub fn create_native_treasury(
program_id: &Pubkey,
// Accounts
governance: &Pubkey,
payer: &Pubkey,
) -> Instruction {
let native_treasury_address = get_native_treasury_address(program_id, governance);
let accounts = vec![
AccountMeta::new_readonly(*governance, false),
AccountMeta::new(native_treasury_address, false),
AccountMeta::new(*payer, true),
AccountMeta::new_readonly(system_program::id(), false),
];
let instruction = GovernanceInstruction::CreateNativeTreasury {};
Instruction {
program_id: *program_id,
accounts,
data: instruction.try_to_vec().unwrap(),
}
}
/// Creates RevokeGoverningTokens instruction
#[allow(clippy::too_many_arguments)]
pub fn revoke_governing_tokens(
program_id: &Pubkey,
// Accounts
realm: &Pubkey,
governing_token_owner: &Pubkey,
governing_token_mint: &Pubkey,
revoke_authority: &Pubkey,
// Args
amount: u64,
) -> Instruction {
let token_owner_record_address = get_token_owner_record_address(
program_id,
realm,
governing_token_mint,
governing_token_owner,
);
let governing_token_holding_address =
get_governing_token_holding_address(program_id, realm, governing_token_mint);
let realm_config_address = get_realm_config_address(program_id, realm);
let accounts = vec![
AccountMeta::new_readonly(*realm, false),
AccountMeta::new(governing_token_holding_address, false),
AccountMeta::new(token_owner_record_address, false),
AccountMeta::new(*governing_token_mint, false),
AccountMeta::new_readonly(*revoke_authority, true),
AccountMeta::new_readonly(realm_config_address, false),
AccountMeta::new_readonly(spl_token::id(), false),
];
let instruction = GovernanceInstruction::RevokeGoverningTokens { amount };
Instruction {
program_id: *program_id,
accounts,
data: instruction.try_to_vec().unwrap(),
}
}
/// Creates AddRequiredSignatory instruction
pub fn add_required_signatory(
program_id: &Pubkey,
// Accounts
governance: &Pubkey,
payer: &Pubkey,
// Args
signatory: &Pubkey,
) -> Instruction {
let required_signatory_address =
get_required_signatory_address(program_id, governance, signatory);
let accounts = vec![
AccountMeta::new(*governance, true),
AccountMeta::new(required_signatory_address, false),
AccountMeta::new(*payer, true),
AccountMeta::new_readonly(system_program::id(), false),
];
let instruction = GovernanceInstruction::AddRequiredSignatory {
signatory: *signatory,
};
Instruction {
program_id: *program_id,
accounts,
data: instruction.try_to_vec().unwrap(),
}
}
/// Creates RemoveRequiredSignatory instruction
pub fn remove_required_signatory(
program_id: &Pubkey,
// Accounts
governance: &Pubkey,
signatory: &Pubkey,
beneficiary: &Pubkey,
) -> Instruction {
let required_signatory_address =
get_required_signatory_address(program_id, governance, signatory);
let accounts = vec![
AccountMeta::new(*governance, true),
AccountMeta::new(required_signatory_address, false),
AccountMeta::new(*beneficiary, false),
];
let instruction = GovernanceInstruction::RemoveRequiredSignatory;
Instruction {
program_id: *program_id,
accounts,
data: instruction.try_to_vec().unwrap(),
}
}
/// Adds accounts specified by GoverningTokenConfigAccountArgs
/// and returns GoverningTokenConfigArgs
pub fn with_governing_token_config_args(
accounts: &mut Vec<AccountMeta>,
governing_token_config_args: Option<GoverningTokenConfigAccountArgs>,
) -> GoverningTokenConfigArgs {
let governing_token_config_args = governing_token_config_args.unwrap_or_default();
let use_voter_weight_addin =
if let Some(voter_weight_addin) = governing_token_config_args.voter_weight_addin {
accounts.push(AccountMeta::new_readonly(voter_weight_addin, false));
true
} else {
false
};
let use_max_voter_weight_addin =
if let Some(max_voter_weight_addin) = governing_token_config_args.max_voter_weight_addin {
accounts.push(AccountMeta::new_readonly(max_voter_weight_addin, false));
true
} else {
false
};
GoverningTokenConfigArgs {
use_voter_weight_addin,
use_max_voter_weight_addin,
token_type: governing_token_config_args.token_type,
}
}
/// Creates RefundProposalDeposit instruction
#[allow(clippy::too_many_arguments)]
pub fn refund_proposal_deposit(
program_id: &Pubkey,
// Accounts
proposal: &Pubkey,
proposal_deposit_payer: &Pubkey,
// Args
) -> Instruction {
let proposal_deposit_address =
get_proposal_deposit_address(program_id, proposal, proposal_deposit_payer);
let accounts = vec![
AccountMeta::new_readonly(*proposal, false),
AccountMeta::new(proposal_deposit_address, false),
AccountMeta::new(*proposal_deposit_payer, false),
];
let instruction = GovernanceInstruction::RefundProposalDeposit {};
Instruction {
program_id: *program_id,
accounts,
data: instruction.try_to_vec().unwrap(),
}
}
/// Creates CompleteProposal instruction to move proposal from Succeeded to
/// Completed
pub fn complete_proposal(
program_id: &Pubkey,
// Accounts
proposal: &Pubkey,
token_owner_record: &Pubkey,
complete_proposal_authority: &Pubkey,
) -> Instruction {
let accounts = vec![
AccountMeta::new(*proposal, false),
AccountMeta::new_readonly(*token_owner_record, false),
AccountMeta::new_readonly(*complete_proposal_authority, true),
];
let instruction = GovernanceInstruction::CompleteProposal {};
Instruction {
program_id: *program_id,
accounts,
data: instruction.try_to_vec().unwrap(),
}
}