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
#[cfg(not(target_os = "solana"))]
use safe_zk_token_sdk::encryption::auth_encryption::AeCiphertext;
pub use safe_zk_token_sdk::zk_token_proof_instruction::*;
use {
crate::{
check_program_account,
extension::confidential_transfer::*,
instruction::{encode_instruction, TokenInstruction},
},
bytemuck::{Pod, Zeroable},
num_enum::{IntoPrimitive, TryFromPrimitive},
solana_program::{
instruction::{AccountMeta, Instruction},
program_error::ProgramError,
pubkey::Pubkey,
sysvar,
},
safe_zk_token_sdk::zk_token_elgamal::pod,
std::convert::TryFrom,
};
/// Confidential Transfer extension instructions
#[derive(Clone, Copy, Debug, TryFromPrimitive, IntoPrimitive)]
#[repr(u8)]
pub enum ConfidentialTransferInstruction {
/// Initializes confidential transfers for a mint.
///
/// The `ConfidentialTransferInstruction::InitializeMint` instruction requires no signers
/// and MUST be included within the same Transaction as `TokenInstruction::InitializeMint`.
/// Otherwise another party can initialize the configuration.
///
/// The instruction fails if the `TokenInstruction::InitializeMint` instruction has already
/// executed for the mint.
///
/// Note that the `withdraw_withheld_authority_encryption_pubkey` cannot be updated after it is
/// initialized.
///
/// Accounts expected by this instruction:
///
/// 0. `[writable]` The SPL Token mint.
///
/// Data expected by this instruction:
/// `InitializeMintData`
///
InitializeMint,
/// Updates the confidential transfer mint configuration for a mint.
///
/// Use `TokenInstruction::SetAuthority` to update the confidential transfer mint authority.
///
/// The `withdraw_withheld_authority_encryption_pubkey` and `withheld_amount` ciphertext are
/// not updatable.
///
/// Accounts expected by this instruction:
///
/// 0. `[writable]` The SPL Token mint.
/// 1. `[signer]` Confidential transfer mint authority.
///
/// Data expected by this instruction:
/// `UpdateMintData`
///
UpdateMint,
/// Configures confidential transfers for a token account.
///
/// The instruction fails if the confidential transfers are already configured, or if the mint
/// was not initialized with confidential transfer support.
///
/// The instruction fails if the `TokenInstruction::InitializeAccount` instruction has not yet
/// successfully executed for the token account.
///
/// Upon success, confidential and non-confidential deposits and transfers are enabled. Use the
/// `DisableConfidentialCredits` and `DisableNonConfidentialCredits` instructions to disable.
///
/// In order for this instruction to be successfully processed, it must be accompanied by the
/// `VerifyPubkey` instruction of the `zk_token_proof` program in the same transaction.
///
/// Accounts expected by this instruction:
///
/// * Single owner/delegate
/// 0. `[writeable]` The SPL Token account.
/// 1. `[]` The corresponding SPL Token mint.
/// 2. `[]` Instructions sysvar.
/// 3. `[signer]` The single source account owner.
///
/// * Multisignature owner/delegate
/// 0. `[writeable]` The SPL Token account.
/// 1. `[]` The corresponding SPL Token mint.
/// 2. `[]` The multisig source account owner.
/// 3. `[]` Instructions sysvar.
/// 4.. `[signer]` Required M signer accounts for the SPL Token Multisig account.
///
/// Data expected by this instruction:
/// `ConfigureAccountInstructionData`
///
ConfigureAccount,
/// Approves a token account for confidential transfers.
///
/// Approval is only required when the `ConfidentialTransferMint::approve_new_accounts`
/// field is set in the SPL Token mint. This instruction must be executed after the account
/// owner configures their account for confidential transfers with
/// `ConfidentialTransferInstruction::ConfigureAccount`.
///
/// Accounts expected by this instruction:
///
/// 0. `[writable]` The SPL Token account to approve.
/// 1. `[]` The SPL Token mint.
/// 2. `[signer]` Confidential transfer auditor authority.
///
/// Data expected by this instruction:
/// None
///
ApproveAccount,
/// Prepare a token account for closing. The account must not hold any confidential tokens in
/// its pending or available balances. Use
/// `ConfidentialTransferInstruction::DisableConfidentialCredits` to block balance credit
/// changes first if necessary.
///
/// Note that a newly configured account is always empty, so this instruction is not required
/// prior to account closing if no instructions beyond
/// `ConfidentialTransferInstruction::ConfigureAccount` have affected the token account.
///
/// In order for this instruction to be successfully processed, it must be accompanied by the
/// `VerifyCloseAccount` instruction of the `zk_token_proof` program in the same transaction.
///
/// * Single owner/delegate
/// 0. `[writable]` The SPL Token account.
/// 1. `[]` Instructions sysvar.
/// 2. `[signer]` The single account owner.
///
/// * Multisignature owner/delegate
/// 0. `[writable]` The SPL Token account.
/// 1. `[]` Instructions sysvar.
/// 2. `[]` The multisig account owner.
/// 3.. `[signer]` Required M signer accounts for the SPL Token Multisig account.
///
/// Data expected by this instruction:
/// `EmptyAccountInstructionData`
///
EmptyAccount,
/// Deposit SPL Tokens into the pending balance of a confidential token account.
///
/// The account owner can then invoke the `ApplyPendingBalance` instruction to roll the deposit
/// into their available balance at a time of their choosing.
///
/// Fails if the source or destination accounts are frozen.
/// Fails if the associated mint is extended as `NonTransferable`.
///
/// Accounts expected by this instruction:
///
/// * Single owner/delegate
/// 0. `[writable]` The SPL Token account.
/// 1. `[]` The token mint.
/// 2. `[signer]` The single account owner or delegate.
///
/// * Multisignature owner/delegate
/// 0. `[writable]` The SPL Token account.
/// 1. `[]` The token mint.
/// 2. `[]` The multisig account owner or delegate.
/// 3.. `[signer]` Required M signer accounts for the SPL Token Multisig account.
///
/// Data expected by this instruction:
/// `DepositInstructionData`
///
Deposit,
/// Withdraw SPL Tokens from the available balance of a confidential token account.
///
/// Fails if the source or destination accounts are frozen.
/// Fails if the associated mint is extended as `NonTransferable`.
///
/// In order for this instruction to be successfully processed, it must be accompanied by the
/// `VerifyWithdraw` instruction of the `zk_token_proof` program in the same transaction.
///
/// Accounts expected by this instruction:
///
/// * Single owner/delegate
/// 0. `[writable]` The SPL Token account.
/// 1. `[]` The token mint.
/// 2. `[]` Instructions sysvar.
/// 3. `[signer]` The single source account owner.
///
/// * Multisignature owner/delegate
/// 0. `[writable]` The SPL Token account.
/// 1. `[]` The token mint.
/// 2. `[]` Instructions sysvar.
/// 3. `[]` The multisig source account owner.
/// 4.. `[signer]` Required M signer accounts for the SPL Token Multisig account.
///
/// Data expected by this instruction:
/// `WithdrawInstructionData`
///
Withdraw,
/// Transfer tokens confidentially.
///
/// In order for this instruction to be successfully processed, it must be accompanied by
/// either the `VerifyTransfer` or `VerifyTransferWithFee` instruction of the `zk_token_proof`
/// program in the same transaction.
///
/// Fails if the associated mint is extended as `NonTransferable`.
///
/// * Single owner/delegate
/// 1. `[writable]` The source SPL Token account.
/// 2. `[writable]` The destination SPL Token account.
/// 3. `[]` The token mint.
/// 4. `[]` Instructions sysvar.
/// 5. `[signer]` The single source account owner.
///
/// * Multisignature owner/delegate
/// 1. `[writable]` The source SPL Token account.
/// 2. `[writable]` The destination SPL Token account.
/// 3. `[]` The token mint.
/// 4. `[]` Instructions sysvar.
/// 5. `[]` The multisig source account owner.
/// 6.. `[signer]` Required M signer accounts for the SPL Token Multisig account.
///
/// Data expected by this instruction:
/// `TransferInstructionData`
///
Transfer,
/// Applies the pending balance to the available balance, based on the history of `Deposit`
/// and/or `Transfer` instructions.
///
/// After submitting `ApplyPendingBalance`, the client should compare
/// `ConfidentialTransferAccount::expected_pending_balance_credit_counter` with
/// `ConfidentialTransferAccount::actual_applied_pending_balance_instructions`. If they are
/// equal then the `ConfidentialTransferAccount::decryptable_available_balance` is consistent
/// with `ConfidentialTransferAccount::available_balance`. If they differ then there is more
/// pending balance to be applied.
///
/// Account expected by this instruction:
///
/// * Single owner/delegate
/// 0. `[writable]` The SPL Token account.
/// 1. `[signer]` The single account owner.
///
/// * Multisignature owner/delegate
/// 0. `[writable]` The SPL Token account.
/// 1. `[]` The multisig account owner.
/// 2.. `[signer]` Required M signer accounts for the SPL Token Multisig account.
///
/// Data expected by this instruction:
/// `ApplyPendingBalanceData`
///
ApplyPendingBalance,
/// Configure a confidential extension account to accept incoming confidential transfers.
///
/// Accounts expected by this instruction:
///
/// * Single owner/delegate
/// 0. `[writable]` The SPL Token account.
/// 1. `[signer]` Single authority.
///
/// * Multisignature owner/delegate
/// 0. `[writable]` The SPL Token account.
/// 1. `[]` Multisig authority.
/// 2.. `[signer]` Required M signer accounts for the SPL Token Multisig account.
///
/// Data expected by this instruction:
/// None
///
EnableConfidentialCredits,
/// Configure a confidential extension account to reject any incoming confidential transfers.
///
/// If the `allow_non_confidential_credits` field is `true`, then the base account can still
/// receive non-confidential transfers.
///
/// This instruction can be used to disable confidential payments after a token account has
/// already been extended for confidential transfers.
///
/// Accounts expected by this instruction:
///
/// * Single owner/delegate
/// 0. `[writable]` The SPL Token account.
/// 1. `[signer]` The single account owner.
///
/// * Multisignature owner/delegate
/// 0. `[writable]` The SPL Token account.
/// 1. `[]` The multisig account owner.
/// 2.. `[signer]` Required M signer accounts for the SPL Token Multisig account.
///
/// Data expected by this instruction:
/// None
///
DisableConfidentialCredits,
/// Configure an account with the confidential extension to accept incoming non-confidential
/// transfers.
///
/// Accounts expected by this instruction:
///
/// * Single owner/delegate
/// 0. `[writable]` The SPL Token account.
/// 1. `[signer]` The single account owner.
///
/// * Multisignature owner/delegate
/// 0. `[writable]` The SPL Token account.
/// 1. `[]` The multisig account owner.
/// 2.. `[signer]` Required M signer accounts for the SPL Token Multisig account.
///
/// Data expected by this instruction:
/// None
///
EnableNonConfidentialCredits,
/// Configure an account with the confidential extension to reject any incoming
/// non-confidential transfers.
///
/// This instruction can be used to configure a confidential extension account to exclusively
/// receive confidential payments.
///
/// Accounts expected by this instruction:
///
/// * Single owner/delegate
/// 0. `[writable]` The SPL Token account.
/// 1. `[signer]` The single account owner.
///
/// * Multisignature owner/delegate
/// 0. `[writable]` The SPL Token account.
/// 1. `[]` The multisig account owner.
/// 2.. `[signer]` Required M signer accounts for the SPL Token Multisig account.
///
/// Data expected by this instruction:
/// None
///
DisableNonConfidentialCredits,
/// Transfer all withheld confidential tokens in the mint to an account. Signed by the mint's
/// withdraw withheld tokens authority.
///
/// In order for this instruction to be successfully processed, it must be accompanied by the
/// `VerifyWithdrawWithheldTokens` instruction of the `zk_token_proof` program in the same
/// transaction.
///
/// Accounts expected by this instruction:
///
/// * Single owner/delegate
/// 0. `[writable]` The token mint. Must include the `TransferFeeConfig` extension.
/// 1. `[writable]` The fee receiver account. Must include the `TransferFeeAmount` and
/// `ConfidentialTransferAccount` extensions.
/// 2. `[]` Instructions sysvar.
/// 3. `[signer]` The mint's `withdraw_withheld_authority`.
///
/// * Multisignature owner/delegate
/// 0. `[writable]` The token mint. Must include the `TransferFeeConfig` extension.
/// 1. `[writable]` The fee receiver account. Must include the `TransferFeeAmount` and
/// `ConfidentialTransferAccount` extensions.
/// 2. `[]` Instructions sysvar.
/// 3. `[]` The mint's multisig `withdraw_withheld_authority`.
/// 4. ..3+M `[signer]` M signer accounts.
///
/// Data expected by this instruction:
/// WithdrawWithheldTokensFromMintData
///
WithdrawWithheldTokensFromMint,
/// Transfer all withheld tokens to an account. Signed by the mint's withdraw withheld tokens
/// authority. This instruction is susceptible to front-running. Use
/// `HarvestWithheldTokensToMint` and `WithdrawWithheldTokensFromMint` as an alternative.
///
/// Note on front-running: This instruction requires a zero-knowledge proof verification
/// instruction that is checked with respect to the account state (the currently withheld
/// fees). Suppose that a withdraw withheld authority generates the
/// `WithdrawWithheldTokensFromAccounts` instruction along with a corresponding zero-knowledge
/// proof for a specified set of accounts, and submits it on chain. If the withheld fees at any
/// of the specified accounts change before the `WithdrawWithheldTokensFromAccounts` is
/// executed on chain, the zero-knowledge proof will not verify with respect to the new state,
/// forcing the transaction to fail.
///
/// If front-running occurs, then users can look up the updated states of the accounts,
/// generate a new zero-knowledge proof and try again. Alternatively, withdraw withheld
/// authority can first move the withheld amount to the mint using
/// `HarvestWithheldTokensToMint` and then move the withheld fees from mint to a specified
/// destination account using `WithdrawWithheldTokensFromMint`.
///
/// In order for this instruction to be successfully processed, it must be accompanied by the
/// `VerifyWithdrawWithheldTokens` instruction of the `zk_token_proof` program in the same
/// transaction.
///
/// Accounts expected by this instruction:
///
/// * Single owner/delegate
/// 0. `[]` The token mint. Must include the `TransferFeeConfig` extension.
/// 1. `[writable]` The fee receiver account. Must include the `TransferFeeAmount` and
/// `ConfidentialTransferAccount` extensions.
/// 2. `[]` Instructions sysvar.
/// 3. `[signer]` The mint's `withdraw_withheld_authority`.
/// 4. ..3+N `[writable]` The source accounts to withdraw from.
///
/// * Multisignature owner/delegate
/// 0. `[]` The token mint. Must include the `TransferFeeConfig` extension.
/// 1. `[writable]` The fee receiver account. Must include the `TransferFeeAmount` and
/// `ConfidentialTransferAccount` extensions.
/// 2. `[]` Instructions sysvar.
/// 3. `[]` The mint's multisig `withdraw_withheld_authority`.
/// 4. ..4+M `[signer]` M signer accounts.
/// 4+M+1. ..3+M+N `[writable]` The source accounts to withdraw from.
///
/// Data expected by this instruction:
/// WithdrawWithheldTokensFromAccountsData
///
WithdrawWithheldTokensFromAccounts,
/// Permissionless instruction to transfer all withheld confidential tokens to the mint.
///
/// Succeeds for frozen accounts.
///
/// Accounts provided should include both the `TransferFeeAmount` and
/// `ConfidentialTransferAccount` extension. If not, the account is skipped.
///
/// Accounts expected by this instruction:
///
/// 0. `[writable]` The mint.
/// 1. ..1+N `[writable]` The source accounts to harvest from.
///
/// Data expected by this instruction:
/// None
///
HarvestWithheldTokensToMint,
}
/// Data expected by `ConfidentialTransferInstruction::InitializeMint`
#[derive(Clone, Copy, Debug, PartialEq, Pod, Zeroable)]
#[repr(C)]
pub struct InitializeMintData {
/// Authority to modify the `ConfidentialTransferMint` configuration and to approve new
/// accounts.
pub authority: OptionalNonZeroPubkey,
/// Determines if newly configured accounts must be approved by the `authority` before they may
/// be used by the user.
pub auto_approve_new_accounts: PodBool,
/// New authority to decode any transfer amount in a confidential transfer.
pub auditor_encryption_pubkey: OptionalNonZeroEncryptionPubkey,
/// Authority to withdraw withheld fees that are associated with accounts.
pub withdraw_withheld_authority_encryption_pubkey: OptionalNonZeroEncryptionPubkey,
}
/// Data expected by `ConfidentialTransferInstruction::UpdateMint`
#[derive(Clone, Copy, Debug, PartialEq, Pod, Zeroable)]
#[repr(C)]
pub struct UpdateMintData {
/// Determines if newly configured accounts must be approved by the `authority` before they may
/// be used by the user.
pub auto_approve_new_accounts: PodBool,
/// New authority to decode any transfer amount in a confidential transfer.
pub auditor_encryption_pubkey: OptionalNonZeroEncryptionPubkey,
}
/// Data expected by `ConfidentialTransferInstruction::ConfigureAccount`
#[derive(Clone, Copy, Debug, PartialEq, Pod, Zeroable)]
#[repr(C)]
pub struct ConfigureAccountInstructionData {
/// The decryptable balance (always 0) once the configure account succeeds
pub decryptable_zero_balance: DecryptableBalance,
/// The maximum number of despots and transfers that an account can receiver before the
/// `ApplyPendingBalance` is executed
pub maximum_pending_balance_credit_counter: PodU64,
/// Relative location of the `ProofInstruction::VerifyPubkey` instruction to the
/// `ConfigureAccount` instruction in the transaction
pub proof_instruction_offset: i8,
}
/// Data expected by `ConfidentialTransferInstruction::EmptyAccount`
#[derive(Clone, Copy, Debug, PartialEq, Pod, Zeroable)]
#[repr(C)]
pub struct EmptyAccountInstructionData {
/// Relative location of the `ProofInstruction::VerifyCloseAccount` instruction to the
/// `EmptyAccount` instruction in the transaction
pub proof_instruction_offset: i8,
}
/// Data expected by `ConfidentialTransferInstruction::Deposit`
#[derive(Clone, Copy, Debug, PartialEq, Pod, Zeroable)]
#[repr(C)]
pub struct DepositInstructionData {
/// The amount of tokens to deposit
pub amount: PodU64,
/// Expected number of base 10 digits to the right of the decimal place
pub decimals: u8,
}
/// Data expected by `ConfidentialTransferInstruction::Withdraw`
#[derive(Clone, Copy, Debug, PartialEq, Pod, Zeroable)]
#[repr(C)]
pub struct WithdrawInstructionData {
/// The amount of tokens to withdraw
pub amount: PodU64,
/// Expected number of base 10 digits to the right of the decimal place
pub decimals: u8,
/// The new decryptable balance if the withdrawal succeeds
pub new_decryptable_available_balance: DecryptableBalance,
/// Relative location of the `ProofInstruction::VerifyWithdraw` instruction to the `Withdraw`
/// instruction in the transaction
pub proof_instruction_offset: i8,
}
/// Data expected by `ConfidentialTransferInstruction::Transfer`
#[derive(Clone, Copy, Debug, PartialEq, Pod, Zeroable)]
#[repr(C)]
pub struct TransferInstructionData {
/// The new source decryptable balance if the transfer succeeds
pub new_source_decryptable_available_balance: DecryptableBalance,
/// Relative location of the `ProofInstruction::VerifyTransfer` instruction to the
/// `Transfer` instruction in the transaction
pub proof_instruction_offset: i8,
}
/// Data expected by `ConfidentialTransferInstruction::ApplyPendingBalance`
#[derive(Clone, Copy, Debug, PartialEq, Pod, Zeroable)]
#[repr(C)]
pub struct ApplyPendingBalanceData {
/// The expected number of pending balance credits since the last successful
/// `ApplyPendingBalance` instruction
pub expected_pending_balance_credit_counter: PodU64,
/// The new decryptable balance if the pending balance is applied successfully
pub new_decryptable_available_balance: pod::AeCiphertext,
}
/// Data expected by `ConfidentialTransferInstruction::WithdrawWithheldTokensFromMint`
#[derive(Clone, Copy, Debug, PartialEq, Pod, Zeroable)]
#[repr(C)]
pub struct WithdrawWithheldTokensFromMintData {
/// Relative location of the `ProofInstruction::VerifyWithdrawWithheld` instruction to the
/// `WithdrawWithheldTokensFromMint` instruction in the transaction
pub proof_instruction_offset: i8,
}
/// Data expected by `ConfidentialTransferInstruction::WithdrawWithheldTokensFromAccounts`
#[derive(Clone, Copy, Debug, PartialEq, Pod, Zeroable)]
#[repr(C)]
pub struct WithdrawWithheldTokensFromAccountsData {
/// Number of token accounts harvested
pub num_token_accounts: u8,
/// Relative location of the `ProofInstruction::VerifyWithdrawWithheld` instruction to the
/// `VerifyWithdrawWithheldTokensFromAccounts` instruction in the transaction
pub proof_instruction_offset: i8,
}
/// Create a `InitializeMint` instruction
#[cfg(not(target_os = "solana"))]
pub fn initialize_mint(
token_program_id: &Pubkey,
mint: &Pubkey,
authority: Option<Pubkey>,
auto_approve_new_accounts: bool,
auditor_encryption_pubkey: Option<EncryptionPubkey>,
withdraw_withheld_authority_encryption_pubkey: Option<EncryptionPubkey>,
) -> Result<Instruction, ProgramError> {
check_program_account(token_program_id)?;
let accounts = vec![AccountMeta::new(*mint, false)];
Ok(encode_instruction(
token_program_id,
accounts,
TokenInstruction::ConfidentialTransferExtension,
ConfidentialTransferInstruction::InitializeMint,
&InitializeMintData {
authority: authority.try_into()?,
auto_approve_new_accounts: auto_approve_new_accounts.into(),
auditor_encryption_pubkey: auditor_encryption_pubkey.try_into()?,
withdraw_withheld_authority_encryption_pubkey:
withdraw_withheld_authority_encryption_pubkey.try_into()?,
},
))
}
/// Create a `UpdateMint` instruction
#[cfg(not(target_os = "solana"))]
pub fn update_mint(
token_program_id: &Pubkey,
mint: &Pubkey,
authority: &Pubkey,
auto_approve_new_accounts: bool,
auditor_encryption_pubkey: Option<EncryptionPubkey>,
) -> Result<Instruction, ProgramError> {
check_program_account(token_program_id)?;
let accounts = vec![
AccountMeta::new(*mint, false),
AccountMeta::new_readonly(*authority, true),
];
Ok(encode_instruction(
token_program_id,
accounts,
TokenInstruction::ConfidentialTransferExtension,
ConfidentialTransferInstruction::UpdateMint,
&UpdateMintData {
auto_approve_new_accounts: auto_approve_new_accounts.into(),
auditor_encryption_pubkey: auditor_encryption_pubkey.try_into()?,
},
))
}
/// Create a `ConfigureAccount` instruction
///
/// This instruction is suitable for use with a cross-program `invoke`
#[allow(clippy::too_many_arguments)]
#[cfg(not(target_os = "solana"))]
pub fn inner_configure_account(
token_program_id: &Pubkey,
token_account: &Pubkey,
mint: &Pubkey,
decryptable_zero_balance: AeCiphertext,
maximum_pending_balance_credit_counter: u64,
authority: &Pubkey,
multisig_signers: &[&Pubkey],
proof_instruction_offset: i8,
) -> Result<Instruction, ProgramError> {
check_program_account(token_program_id)?;
let mut accounts = vec![
AccountMeta::new(*token_account, false),
AccountMeta::new_readonly(*mint, false),
AccountMeta::new_readonly(sysvar::instructions::id(), false),
AccountMeta::new_readonly(*authority, multisig_signers.is_empty()),
];
for multisig_signer in multisig_signers.iter() {
accounts.push(AccountMeta::new_readonly(**multisig_signer, true));
}
Ok(encode_instruction(
token_program_id,
accounts,
TokenInstruction::ConfidentialTransferExtension,
ConfidentialTransferInstruction::ConfigureAccount,
&ConfigureAccountInstructionData {
decryptable_zero_balance: decryptable_zero_balance.into(),
maximum_pending_balance_credit_counter: maximum_pending_balance_credit_counter.into(),
proof_instruction_offset,
},
))
}
/// Create a `ConfigureAccount` instruction
#[allow(clippy::too_many_arguments)]
#[cfg(not(target_os = "solana"))]
pub fn configure_account(
token_program_id: &Pubkey,
token_account: &Pubkey,
mint: &Pubkey,
decryptable_zero_balance: AeCiphertext,
maximum_pending_balance_credit_counter: u64,
authority: &Pubkey,
multisig_signers: &[&Pubkey],
proof_data: &PubkeyValidityData,
) -> Result<Vec<Instruction>, ProgramError> {
Ok(vec![
inner_configure_account(
token_program_id,
token_account,
mint,
decryptable_zero_balance,
maximum_pending_balance_credit_counter,
authority,
multisig_signers,
1,
)?,
verify_pubkey_validity(proof_data),
])
}
/// Create an `ApproveAccount` instruction
pub fn approve_account(
token_program_id: &Pubkey,
account_to_approve: &Pubkey,
mint: &Pubkey,
authority: &Pubkey,
) -> Result<Instruction, ProgramError> {
check_program_account(token_program_id)?;
let accounts = vec![
AccountMeta::new(*account_to_approve, false),
AccountMeta::new_readonly(*mint, false),
AccountMeta::new_readonly(*authority, true),
];
Ok(encode_instruction(
token_program_id,
accounts,
TokenInstruction::ConfidentialTransferExtension,
ConfidentialTransferInstruction::ApproveAccount,
&(),
))
}
/// Create an inner `EmptyAccount` instruction
///
/// This instruction is suitable for use with a cross-program `invoke`
pub fn inner_empty_account(
token_program_id: &Pubkey,
token_account: &Pubkey,
authority: &Pubkey,
multisig_signers: &[&Pubkey],
proof_instruction_offset: i8,
) -> Result<Instruction, ProgramError> {
check_program_account(token_program_id)?;
let mut accounts = vec![
AccountMeta::new(*token_account, false),
AccountMeta::new_readonly(sysvar::instructions::id(), false),
AccountMeta::new_readonly(*authority, multisig_signers.is_empty()),
];
for multisig_signer in multisig_signers.iter() {
accounts.push(AccountMeta::new_readonly(**multisig_signer, true));
}
Ok(encode_instruction(
token_program_id,
accounts,
TokenInstruction::ConfidentialTransferExtension,
ConfidentialTransferInstruction::EmptyAccount,
&EmptyAccountInstructionData {
proof_instruction_offset,
},
))
}
/// Create a `EmptyAccount` instruction
pub fn empty_account(
token_program_id: &Pubkey,
token_account: &Pubkey,
authority: &Pubkey,
multisig_signers: &[&Pubkey],
proof_data: &CloseAccountData,
) -> Result<Vec<Instruction>, ProgramError> {
Ok(vec![
inner_empty_account(
token_program_id,
token_account,
authority,
multisig_signers,
1,
)?, // calls check_program_account
verify_close_account(proof_data),
])
}
/// Create a `Deposit` instruction
#[allow(clippy::too_many_arguments)]
pub fn deposit(
token_program_id: &Pubkey,
token_account: &Pubkey,
mint: &Pubkey,
amount: u64,
decimals: u8,
authority: &Pubkey,
multisig_signers: &[&Pubkey],
) -> Result<Instruction, ProgramError> {
check_program_account(token_program_id)?;
let mut accounts = vec![
AccountMeta::new(*token_account, false),
AccountMeta::new_readonly(*mint, false),
AccountMeta::new_readonly(*authority, multisig_signers.is_empty()),
];
for multisig_signer in multisig_signers.iter() {
accounts.push(AccountMeta::new_readonly(**multisig_signer, true));
}
Ok(encode_instruction(
token_program_id,
accounts,
TokenInstruction::ConfidentialTransferExtension,
ConfidentialTransferInstruction::Deposit,
&DepositInstructionData {
amount: amount.into(),
decimals,
},
))
}
/// Create a inner `Withdraw` instruction
///
/// This instruction is suitable for use with a cross-program `invoke`
#[allow(clippy::too_many_arguments)]
pub fn inner_withdraw(
token_program_id: &Pubkey,
token_account: &Pubkey,
mint: &Pubkey,
amount: u64,
decimals: u8,
new_decryptable_available_balance: DecryptableBalance,
authority: &Pubkey,
multisig_signers: &[&Pubkey],
proof_instruction_offset: i8,
) -> Result<Instruction, ProgramError> {
check_program_account(token_program_id)?;
let mut accounts = vec![
AccountMeta::new(*token_account, false),
AccountMeta::new_readonly(*mint, false),
AccountMeta::new_readonly(sysvar::instructions::id(), false),
AccountMeta::new_readonly(*authority, multisig_signers.is_empty()),
];
for multisig_signer in multisig_signers.iter() {
accounts.push(AccountMeta::new_readonly(**multisig_signer, true));
}
Ok(encode_instruction(
token_program_id,
accounts,
TokenInstruction::ConfidentialTransferExtension,
ConfidentialTransferInstruction::Withdraw,
&WithdrawInstructionData {
amount: amount.into(),
decimals,
new_decryptable_available_balance,
proof_instruction_offset,
},
))
}
/// Create a `Withdraw` instruction
#[allow(clippy::too_many_arguments)]
#[cfg(not(target_os = "solana"))]
pub fn withdraw(
token_program_id: &Pubkey,
token_account: &Pubkey,
mint: &Pubkey,
amount: u64,
decimals: u8,
new_decryptable_available_balance: AeCiphertext,
authority: &Pubkey,
multisig_signers: &[&Pubkey],
proof_data: &WithdrawData,
) -> Result<Vec<Instruction>, ProgramError> {
Ok(vec![
inner_withdraw(
token_program_id,
token_account,
mint,
amount,
decimals,
new_decryptable_available_balance.into(),
authority,
multisig_signers,
1,
)?, // calls check_program_account
verify_withdraw(proof_data),
])
}
/// Create a inner `Transfer` instruction
///
/// This instruction is suitable for use with a cross-program `invoke`
#[allow(clippy::too_many_arguments)]
pub fn inner_transfer(
token_program_id: &Pubkey,
source_token_account: &Pubkey,
destination_token_account: &Pubkey,
mint: &Pubkey,
new_source_decryptable_available_balance: DecryptableBalance,
authority: &Pubkey,
multisig_signers: &[&Pubkey],
proof_instruction_offset: i8,
) -> Result<Instruction, ProgramError> {
check_program_account(token_program_id)?;
let mut accounts = vec![
AccountMeta::new(*source_token_account, false),
AccountMeta::new(*destination_token_account, false),
AccountMeta::new_readonly(*mint, false),
AccountMeta::new_readonly(sysvar::instructions::id(), false),
AccountMeta::new_readonly(*authority, multisig_signers.is_empty()),
];
for multisig_signer in multisig_signers.iter() {
accounts.push(AccountMeta::new_readonly(**multisig_signer, true));
}
Ok(encode_instruction(
token_program_id,
accounts,
TokenInstruction::ConfidentialTransferExtension,
ConfidentialTransferInstruction::Transfer,
&TransferInstructionData {
new_source_decryptable_available_balance,
proof_instruction_offset,
},
))
}
/// Create a `Transfer` instruction with regular (no-fee) proof
#[allow(clippy::too_many_arguments)]
#[cfg(not(target_os = "solana"))]
pub fn transfer(
token_program_id: &Pubkey,
source_token_account: &Pubkey,
destination_token_account: &Pubkey,
mint: &Pubkey,
new_source_decryptable_available_balance: AeCiphertext,
authority: &Pubkey,
multisig_signers: &[&Pubkey],
proof_data: &TransferData,
) -> Result<Vec<Instruction>, ProgramError> {
Ok(vec![
inner_transfer(
token_program_id,
source_token_account,
destination_token_account,
mint,
new_source_decryptable_available_balance.into(),
authority,
multisig_signers,
1,
)?, // calls check_program_account
verify_transfer(proof_data),
])
}
/// Create a `Transfer` instruction with fee proof
#[allow(clippy::too_many_arguments)]
#[cfg(not(target_os = "solana"))]
pub fn transfer_with_fee(
token_program_id: &Pubkey,
source_token_account: &Pubkey,
destination_token_account: &Pubkey,
mint: &Pubkey,
new_source_decryptable_available_balance: AeCiphertext,
authority: &Pubkey,
multisig_signers: &[&Pubkey],
proof_data: &TransferWithFeeData,
) -> Result<Vec<Instruction>, ProgramError> {
Ok(vec![
inner_transfer(
token_program_id,
source_token_account,
destination_token_account,
mint,
new_source_decryptable_available_balance.into(),
authority,
multisig_signers,
1,
)?, // calls check_program_account
verify_transfer_with_fee(proof_data),
])
}
/// Create a inner `ApplyPendingBalance` instruction
///
/// This instruction is suitable for use with a cross-program `invoke`
pub fn inner_apply_pending_balance(
token_program_id: &Pubkey,
token_account: &Pubkey,
expected_pending_balance_credit_counter: u64,
new_decryptable_available_balance: DecryptableBalance,
authority: &Pubkey,
multisig_signers: &[&Pubkey],
) -> Result<Instruction, ProgramError> {
check_program_account(token_program_id)?;
let mut accounts = vec![
AccountMeta::new(*token_account, false),
AccountMeta::new_readonly(*authority, multisig_signers.is_empty()),
];
for multisig_signer in multisig_signers.iter() {
accounts.push(AccountMeta::new_readonly(**multisig_signer, true));
}
Ok(encode_instruction(
token_program_id,
accounts,
TokenInstruction::ConfidentialTransferExtension,
ConfidentialTransferInstruction::ApplyPendingBalance,
&ApplyPendingBalanceData {
expected_pending_balance_credit_counter: expected_pending_balance_credit_counter.into(),
new_decryptable_available_balance,
},
))
}
/// Create a `ApplyPendingBalance` instruction
#[cfg(not(target_os = "solana"))]
pub fn apply_pending_balance(
token_program_id: &Pubkey,
token_account: &Pubkey,
pending_balance_instructions: u64,
new_decryptable_available_balance: AeCiphertext,
authority: &Pubkey,
multisig_signers: &[&Pubkey],
) -> Result<Instruction, ProgramError> {
inner_apply_pending_balance(
token_program_id,
token_account,
pending_balance_instructions,
new_decryptable_available_balance.into(),
authority,
multisig_signers,
) // calls check_program_account
}
fn enable_or_disable_balance_credits(
instruction: ConfidentialTransferInstruction,
token_program_id: &Pubkey,
token_account: &Pubkey,
authority: &Pubkey,
multisig_signers: &[&Pubkey],
) -> Result<Instruction, ProgramError> {
check_program_account(token_program_id)?;
let mut accounts = vec![
AccountMeta::new(*token_account, false),
AccountMeta::new_readonly(*authority, multisig_signers.is_empty()),
];
for multisig_signer in multisig_signers.iter() {
accounts.push(AccountMeta::new_readonly(**multisig_signer, true));
}
Ok(encode_instruction(
token_program_id,
accounts,
TokenInstruction::ConfidentialTransferExtension,
instruction,
&(),
))
}
/// Create a `EnableConfidentialCredits` instruction
pub fn enable_confidential_credits(
token_program_id: &Pubkey,
token_account: &Pubkey,
authority: &Pubkey,
multisig_signers: &[&Pubkey],
) -> Result<Instruction, ProgramError> {
enable_or_disable_balance_credits(
ConfidentialTransferInstruction::EnableConfidentialCredits,
token_program_id,
token_account,
authority,
multisig_signers,
)
}
/// Create a `DisableConfidentialCredits` instruction
pub fn disable_confidential_credits(
token_program_id: &Pubkey,
token_account: &Pubkey,
authority: &Pubkey,
multisig_signers: &[&Pubkey],
) -> Result<Instruction, ProgramError> {
enable_or_disable_balance_credits(
ConfidentialTransferInstruction::DisableConfidentialCredits,
token_program_id,
token_account,
authority,
multisig_signers,
)
}
/// Create a `EnableNonConfidentialCredits` instruction
pub fn enable_non_confidential_credits(
token_program_id: &Pubkey,
token_account: &Pubkey,
authority: &Pubkey,
multisig_signers: &[&Pubkey],
) -> Result<Instruction, ProgramError> {
enable_or_disable_balance_credits(
ConfidentialTransferInstruction::EnableNonConfidentialCredits,
token_program_id,
token_account,
authority,
multisig_signers,
)
}
/// Create a `DisableNonConfidentialCredits` instruction
pub fn disable_non_confidential_credits(
token_program_id: &Pubkey,
token_account: &Pubkey,
authority: &Pubkey,
multisig_signers: &[&Pubkey],
) -> Result<Instruction, ProgramError> {
enable_or_disable_balance_credits(
ConfidentialTransferInstruction::DisableNonConfidentialCredits,
token_program_id,
token_account,
authority,
multisig_signers,
)
}
/// Create a inner `WithdrawWithheldTokensFromMint` instruction
///
/// This instruction is suitable for use with a cross-program `invoke`
pub fn inner_withdraw_withheld_tokens_from_mint(
token_program_id: &Pubkey,
mint: &Pubkey,
destination: &Pubkey,
authority: &Pubkey,
multisig_signers: &[&Pubkey],
proof_instruction_offset: i8,
) -> Result<Instruction, ProgramError> {
check_program_account(token_program_id)?;
let mut accounts = vec![
AccountMeta::new(*mint, false),
AccountMeta::new(*destination, false),
AccountMeta::new_readonly(sysvar::instructions::id(), false),
AccountMeta::new_readonly(*authority, multisig_signers.is_empty()),
];
for multisig_signer in multisig_signers.iter() {
accounts.push(AccountMeta::new(**multisig_signer, false));
}
Ok(encode_instruction(
token_program_id,
accounts,
TokenInstruction::ConfidentialTransferExtension,
ConfidentialTransferInstruction::WithdrawWithheldTokensFromMint,
&WithdrawWithheldTokensFromMintData {
proof_instruction_offset,
},
))
}
/// Create a `WithdrawWithheldTokensFromMint` instruction
pub fn withdraw_withheld_tokens_from_mint(
token_program_id: &Pubkey,
mint: &Pubkey,
destination: &Pubkey,
authority: &Pubkey,
multisig_signers: &[&Pubkey],
proof_data: &WithdrawWithheldTokensData,
) -> Result<Vec<Instruction>, ProgramError> {
Ok(vec![
inner_withdraw_withheld_tokens_from_mint(
token_program_id,
mint,
destination,
authority,
multisig_signers,
1,
)?,
verify_withdraw_withheld_tokens(proof_data),
])
}
/// Create a inner `WithdrawWithheldTokensFromMint` instruction
///
/// This instruction is suitable for use with a cross-program `invoke`
pub fn inner_withdraw_withheld_tokens_from_accounts(
token_program_id: &Pubkey,
mint: &Pubkey,
destination: &Pubkey,
authority: &Pubkey,
multisig_signers: &[&Pubkey],
sources: &[&Pubkey],
proof_instruction_offset: i8,
) -> Result<Instruction, ProgramError> {
check_program_account(token_program_id)?;
let num_token_accounts =
u8::try_from(sources.len()).map_err(|_| ProgramError::InvalidInstructionData)?;
let mut accounts = vec![
AccountMeta::new(*mint, false),
AccountMeta::new(*destination, false),
AccountMeta::new_readonly(sysvar::instructions::id(), false),
AccountMeta::new_readonly(*authority, multisig_signers.is_empty()),
];
for multisig_signer in multisig_signers.iter() {
accounts.push(AccountMeta::new(**multisig_signer, false));
}
for source in sources.iter() {
accounts.push(AccountMeta::new(**source, false));
}
Ok(encode_instruction(
token_program_id,
accounts,
TokenInstruction::ConfidentialTransferExtension,
ConfidentialTransferInstruction::WithdrawWithheldTokensFromAccounts,
&WithdrawWithheldTokensFromAccountsData {
proof_instruction_offset,
num_token_accounts,
},
))
}
/// Create a `WithdrawWithheldTokensFromAccounts` instruction
pub fn withdraw_withheld_tokens_from_accounts(
token_program_id: &Pubkey,
mint: &Pubkey,
destination: &Pubkey,
authority: &Pubkey,
multisig_signers: &[&Pubkey],
sources: &[&Pubkey],
proof_data: &WithdrawWithheldTokensData,
) -> Result<Vec<Instruction>, ProgramError> {
Ok(vec![
inner_withdraw_withheld_tokens_from_accounts(
token_program_id,
mint,
destination,
authority,
multisig_signers,
sources,
1,
)?,
verify_withdraw_withheld_tokens(proof_data),
])
}
/// Creates a `HarvestWithheldTokensToMint` instruction
pub fn harvest_withheld_tokens_to_mint(
token_program_id: &Pubkey,
mint: &Pubkey,
sources: &[&Pubkey],
) -> Result<Instruction, ProgramError> {
check_program_account(token_program_id)?;
let mut accounts = vec![AccountMeta::new(*mint, false)];
for source in sources.iter() {
accounts.push(AccountMeta::new(**source, false));
}
Ok(encode_instruction(
token_program_id,
accounts,
TokenInstruction::ConfidentialTransferExtension,
ConfidentialTransferInstruction::HarvestWithheldTokensToMint,
&(),
))
}