-
Notifications
You must be signed in to change notification settings - Fork 2.1k
/
instruction.rs
1771 lines (1663 loc) · 69.7 KB
/
instruction.rs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
pub use solana_zk_sdk::zk_elgamal_proof_program::{
instruction::ProofInstruction, proof_data::*, state::ProofContextState,
};
#[cfg(feature = "serde-traits")]
use {
crate::serialization::aeciphertext_fromstr,
serde::{Deserialize, Serialize},
};
use {
crate::{
check_program_account,
extension::confidential_transfer::*,
instruction::{encode_instruction, TokenInstruction},
},
bytemuck::Zeroable,
num_enum::{IntoPrimitive, TryFromPrimitive},
solana_program::{
instruction::{AccountMeta, Instruction},
program_error::ProgramError,
pubkey::Pubkey,
system_program, sysvar,
},
spl_token_confidential_transfer_proof_extraction::instruction::{ProofData, ProofLocation},
};
/// Confidential Transfer extension instructions
#[cfg_attr(feature = "serde-traits", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "serde-traits", serde(rename_all = "camelCase"))]
#[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.
///
/// 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.
///
/// 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 `VerifyPubkeyValidity` instruction of the
/// `zk_elgamal_proof` program in the same transaction or the address of a
/// context state account for the proof must be provided.
///
/// Accounts expected by this instruction:
///
/// * Single owner/delegate
/// 0. `[writeable]` The SPL Token account.
/// 1. `[]` The corresponding SPL Token mint.
/// 2. `[]` Instructions sysvar if `VerifyPubkeyValidity` is included in
/// the same transaction or context state account if
/// `VerifyPubkeyValidity` is pre-verified into a context state
/// account.
/// 3. `[]` (Optional) Record account if the accompanying proof is to be
/// read from a record account.
/// 4. `[signer]` The single source account owner.
///
/// * Multisignature owner/delegate
/// 0. `[writeable]` The SPL Token account.
/// 1. `[]` The corresponding SPL Token mint.
/// 2. `[]` Instructions sysvar if `VerifyPubkeyValidity` is included in
/// the same transaction or context state account if
/// `VerifyPubkeyValidity` is pre-verified into a context state
/// account.
/// 3. `[]` (Optional) Record account if the accompanying proof is to be
/// read from a record account.
/// 4. `[]` The multisig source account owner.
/// 5. .. `[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 mint authority.
///
/// Data expected by this instruction:
/// None
ApproveAccount,
/// Empty the available balance in a confidential token account.
///
/// A token account that is extended for confidential transfers can only be
/// closed if the pending and available balance ciphertexts are emptied.
/// The pending balance can be emptied
/// via the `ConfidentialTransferInstruction::ApplyPendingBalance`
/// instruction. Use the `ConfidentialTransferInstruction::EmptyAccount`
/// instruction to empty the available balance ciphertext.
///
/// 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 `VerifyZeroCiphertext` instruction of the
/// `zk_elgamal_proof` program in the same transaction or the address of a
/// context state account for the proof must be provided.
///
/// * Single owner/delegate
/// 0. `[writable]` The SPL Token account.
/// 1. `[]` Instructions sysvar if `VerifyZeroCiphertext` is included in
/// the same transaction or context state account if
/// `VerifyZeroCiphertext` is pre-verified into a context state
/// account.
/// 2. `[]` (Optional) Record account if the accompanying proof is to be
/// read from a record account.
/// 3. `[signer]` The single account owner.
///
/// * Multisignature owner/delegate
/// 0. `[writable]` The SPL Token account.
/// 1. `[]` Instructions sysvar if `VerifyZeroCiphertext` is included in
/// the same transaction or context state account if
/// `VerifyZeroCiphertext` is pre-verified into a context state
/// account.
/// 2. `[]` (Optional) Record account if the accompanying proof is to be
/// read from a record account.
/// 3. `[]` The multisig account owner.
/// 4. .. `[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`.
/// Fails if the associated mint is extended as `ConfidentialMintBurn`.
///
/// 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.
///
/// In order for this instruction to be successfully processed, it must be
/// accompanied by the following list of `zk_elgamal_proof` program
/// instructions:
///
/// - `VerifyCiphertextCommitmentEquality`
/// - `VerifyBatchedRangeProofU64`
///
/// These instructions can be accompanied in the same transaction or can be
/// pre-verified into a context state account, in which case, only their
/// context state account address need to be provided.
///
/// Fails if the source or destination accounts are frozen.
/// Fails if the associated mint is extended as `NonTransferable`.
/// Fails if the associated mint is extended as `ConfidentialMintBurn`.
///
/// Accounts expected by this instruction:
///
/// * Single owner/delegate
/// 0. `[writable]` The SPL Token account.
/// 1. `[]` The token mint.
/// 2. `[]` (Optional) Instructions sysvar if at least one of the
/// `zk_elgamal_proof` instructions are included in the same
/// transaction.
/// 3. `[]` (Optional) Equality proof record account or context state
/// account.
/// 4. `[]` (Optional) Range proof record account or context state
/// account.
/// 5. `[signer]` The single source account owner.
///
/// * Multisignature owner/delegate
/// 0. `[writable]` The SPL Token account.
/// 1. `[]` The token mint.
/// 2. `[]` (Optional) Instructions sysvar if at least one of the
/// `zk_elgamal_proof` instructions are included in the same
/// transaction.
/// 3. `[]` (Optional) Equality proof record account or context state
/// account.
/// 4. `[]` (Optional) Range proof record account or context state
/// account.
/// 5. `[]` The multisig source account owner.
/// 6. .. `[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 the following list of `zk_elgamal_proof` program
/// instructions:
///
/// - `VerifyCiphertextCommitmentEquality`
/// - `VerifyBatchedGroupedCiphertext3HandlesValidity`
/// - `VerifyBatchedRangeProofU128`
///
/// These instructions can be accompanied in the same transaction or can be
/// pre-verified into a context state account, in which case, only their
/// context state account addresses need to be provided.
///
/// Fails if the associated mint is extended as `NonTransferable`.
///
/// * Single owner/delegate
/// 1. `[writable]` The source SPL Token account.
/// 2. `[]` The token mint.
/// 3. `[writable]` The destination SPL Token account.
/// 4. `[]` (Optional) Instructions sysvar if at least one of the
/// `zk_elgamal_proof` instructions are included in the same
/// transaction.
/// 5. `[]` (Optional) Equality proof record account or context state
/// account.
/// 6. `[]` (Optional) Ciphertext validity proof record account or context
/// state account.
/// 7. `[]` (Optional) Range proof record account or context state
/// account.
/// 8. `[signer]` The single source account owner.
///
/// * Multisignature owner/delegate
/// 1. `[writable]` The source SPL Token account.
/// 2. `[]` The token mint.
/// 3. `[writable]` The destination SPL Token account.
/// 4. `[]` (Optional) Instructions sysvar if at least one of the
/// `zk_elgamal_proof` instructions are included in the same
/// transaction.
/// 5. `[]` (Optional) Equality proof record account or context state
/// account.
/// 6. `[]` (Optional) Ciphertext validity proof record account or context
/// state account.
/// 7. `[]` (Optional) Range proof record account or context state
/// account.
/// 8. `[]` The multisig source account owner.
/// 9. .. `[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 tokens confidentially with fee.
///
/// In order for this instruction to be successfully processed, it must be
/// accompanied by the following list of `zk_elgamal_proof` program
/// instructions:
///
/// - `VerifyCiphertextCommitmentEquality`
/// - `VerifyBatchedGroupedCiphertext3HandlesValidity` (transfer amount
/// ciphertext)
/// - `VerifyPercentageWithFee`
/// - `VerifyBatchedGroupedCiphertext2HandlesValidity` (fee ciphertext)
/// - `VerifyBatchedRangeProofU256`
///
/// These instructions can be accompanied in the same transaction or can be
/// pre-verified into a context state account, in which case, only their
/// context state account addresses need to be provided.
///
/// The same restrictions for the `Transfer` applies to
/// `TransferWithFee`. Namely, the instruction fails if the
/// associated mint is extended as `NonTransferable`.
///
/// * Transfer without fee
/// 1. `[writable]` The source SPL Token account.
/// 2. `[]` The token mint.
/// 3. `[writable]` The destination SPL Token account.
/// 4. `[]` (Optional) Instructions sysvar if at least one of the
/// `zk_elgamal_proof` instructions are included in the same
/// transaction.
/// 5. `[]` (Optional) Equality proof record account or context state
/// account.
/// 6. `[]` (Optional) Transfer amount ciphertext validity proof record
/// account or context state account.
/// 7. `[]` (Optional) Fee sigma proof record account or context state
/// account.
/// 8. `[]` (Optional) Fee ciphertext validity proof record account or
/// context state account.
/// 9. `[]` (Optional) Range proof record account or context state
/// account.
/// 10. `[signer]` The source account owner.
///
/// * Transfer with fee
/// 1. `[writable]` The source SPL Token account.
/// 2. `[]` The token mint.
/// 3. `[writable]` The destination SPL Token account.
/// 4. `[]` (Optional) Instructions sysvar if at least one of the
/// `zk_elgamal_proof` instructions are included in the same
/// transaction.
/// 5. `[]` (Optional) Equality proof record account or context state
/// account.
/// 6. `[]` (Optional) Transfer amount ciphertext validity proof record
/// account or context state account.
/// 7. `[]` (Optional) Fee sigma proof record account or context state
/// account.
/// 8. `[]` (Optional) Fee ciphertext validity proof record account or
/// context state account.
/// 9. `[]` (Optional) Range proof record account or context state
/// account.
/// 10. `[]` The multisig source account owner.
/// 11. .. `[signer]` Required M signer accounts for the SPL Token
/// Multisig
///
/// Data expected by this instruction:
/// `TransferWithFeeInstructionData`
TransferWithFee,
/// Configures confidential transfers for a token account.
///
/// This instruction is identical to the `ConfigureAccount` account except
/// that a valid `ElGamalRegistry` account is expected in place of the
/// `VerifyPubkeyValidity` proof.
///
/// An `ElGamalRegistry` account is valid if it shares the same owner with
/// the token account. If a valid `ElGamalRegistry` account is provided,
/// then the program skips the verification of the ElGamal pubkey
/// validity proof as well as the token owner signature.
///
/// If the token account is not large enough to include the new
/// cconfidential transfer extension, then optionally reallocate the
/// account to increase the data size. To reallocate, a payer account to
/// fund the reallocation and the system account should be included in the
/// instruction.
///
/// Accounts expected by this instruction:
///
/// * Single owner/delegate
/// 0. `[writable]` The SPL Token account.
/// 1. `[]` The corresponding SPL Token mint.
/// 2. `[]` The ElGamal registry account.
/// 3. `[signer, writable]` (Optional) The payer account to fund
/// reallocation
/// 4. `[]` (Optional) System program for reallocation funding
///
/// Data expected by this instruction:
/// None
ConfigureAccountWithRegistry,
}
/// Data expected by `ConfidentialTransferInstruction::InitializeMint`
#[cfg_attr(feature = "serde-traits", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "serde-traits", serde(rename_all = "camelCase"))]
#[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_elgamal_pubkey: OptionalNonZeroElGamalPubkey,
}
/// Data expected by `ConfidentialTransferInstruction::UpdateMint`
#[cfg_attr(feature = "serde-traits", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "serde-traits", serde(rename_all = "camelCase"))]
#[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_elgamal_pubkey: OptionalNonZeroElGamalPubkey,
}
/// Data expected by `ConfidentialTransferInstruction::ConfigureAccount`
#[cfg_attr(feature = "serde-traits", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "serde-traits", serde(rename_all = "camelCase"))]
#[derive(Clone, Copy, Debug, PartialEq, Pod, Zeroable)]
#[repr(C)]
pub struct ConfigureAccountInstructionData {
/// The decryptable balance (always 0) once the configure account succeeds
#[cfg_attr(feature = "serde-traits", serde(with = "aeciphertext_fromstr"))]
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::ZeroCiphertextProof`
/// instruction to the `ConfigureAccount` instruction in the
/// transaction. If the offset is `0`, then use a context state account
/// for the proof.
pub proof_instruction_offset: i8,
}
/// Data expected by `ConfidentialTransferInstruction::EmptyAccount`
#[cfg_attr(feature = "serde-traits", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "serde-traits", serde(rename_all = "camelCase"))]
#[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. If
/// the offset is `0`, then use a context state account for the proof.
pub proof_instruction_offset: i8,
}
/// Data expected by `ConfidentialTransferInstruction::Deposit`
#[cfg_attr(feature = "serde-traits", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "serde-traits", serde(rename_all = "camelCase"))]
#[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`
#[cfg_attr(feature = "serde-traits", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "serde-traits", serde(rename_all = "camelCase"))]
#[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
#[cfg_attr(feature = "serde-traits", serde(with = "aeciphertext_fromstr"))]
pub new_decryptable_available_balance: DecryptableBalance,
/// Relative location of the
/// `ProofInstruction::VerifyCiphertextCommitmentEquality` instruction
/// to the `Withdraw` instruction in the transaction. If the offset is
/// `0`, then use a context state account for the proof.
pub equality_proof_instruction_offset: i8,
/// Relative location of the `ProofInstruction::BatchedRangeProofU64`
/// instruction to the `Withdraw` instruction in the transaction. If the
/// offset is `0`, then use a context state account for the proof.
pub range_proof_instruction_offset: i8,
}
/// Data expected by `ConfidentialTransferInstruction::Transfer`
#[cfg_attr(feature = "serde-traits", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "serde-traits", serde(rename_all = "camelCase"))]
#[derive(Clone, Copy, Debug, PartialEq, Pod, Zeroable)]
#[repr(C)]
pub struct TransferInstructionData {
/// The new source decryptable balance if the transfer succeeds
#[cfg_attr(feature = "serde-traits", serde(with = "aeciphertext_fromstr"))]
pub new_source_decryptable_available_balance: DecryptableBalance,
/// Relative location of the
/// `ProofInstruction::VerifyCiphertextCommitmentEquality` instruction
/// to the `Transfer` instruction in the transaction. If the offset is
/// `0`, then use a context state account for the proof.
pub equality_proof_instruction_offset: i8,
/// Relative location of the
/// `ProofInstruction::VerifyBatchedGroupedCiphertext3HandlesValidity`
/// instruction to the `Transfer` instruction in the transaction. If the
/// offset is `0`, then use a context state account for the proof.
pub ciphertext_validity_proof_instruction_offset: i8,
/// Relative location of the `ProofInstruction::BatchedRangeProofU128Data`
/// instruction to the `Transfer` instruction in the transaction. If the
/// offset is `0`, then use a context state account for the proof.
pub range_proof_instruction_offset: i8,
}
/// Data expected by `ConfidentialTransferInstruction::ApplyPendingBalance`
#[cfg_attr(feature = "serde-traits", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "serde-traits", serde(rename_all = "camelCase"))]
#[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
#[cfg_attr(feature = "serde-traits", serde(with = "aeciphertext_fromstr"))]
pub new_decryptable_available_balance: DecryptableBalance,
}
/// Data expected by `ConfidentialTransferInstruction::TransferWithFee`
#[cfg_attr(feature = "serde-traits", derive(Serialize, Deserialize))]
#[derive(Clone, Copy, Debug, PartialEq, Pod, Zeroable)]
#[repr(C)]
pub struct TransferWithFeeInstructionData {
/// The new source decryptable balance if the transfer succeeds
#[cfg_attr(feature = "serde-traits", serde(with = "aeciphertext_fromstr"))]
pub new_source_decryptable_available_balance: DecryptableBalance,
/// Relative location of the
/// `ProofInstruction::VerifyCiphertextCommitmentEquality` instruction
/// to the `TransferWithFee` instruction in the transaction. If the offset
/// is `0`, then use a context state account for the proof.
pub equality_proof_instruction_offset: i8,
/// Relative location of the
/// `ProofInstruction::VerifyBatchedGroupedCiphertext3HandlesValidity`
/// instruction to the `TransferWithFee` instruction in the transaction.
/// If the offset is `0`, then use a context state account for the
/// proof.
pub transfer_amount_ciphertext_validity_proof_instruction_offset: i8,
/// Relative location of the `ProofInstruction::VerifyPercentageWithFee`
/// instruction to the `TransferWithFee` instruction in the transaction.
/// If the offset is `0`, then use a context state account for the
/// proof.
pub fee_sigma_proof_instruction_offset: i8,
/// Relative location of the
/// `ProofInstruction::VerifyBatchedGroupedCiphertext2HandlesValidity`
/// instruction to the `TransferWithFee` instruction in the transaction.
/// If the offset is `0`, then use a context state account for the
/// proof.
pub fee_ciphertext_validity_proof_instruction_offset: i8,
/// Relative location of the `ProofInstruction::BatchedRangeProofU256Data`
/// instruction to the `TransferWithFee` instruction in the transaction.
/// If the offset is `0`, then use a context state account for the
/// proof.
pub range_proof_instruction_offset: i8,
}
/// Create a `InitializeMint` instruction
pub fn initialize_mint(
token_program_id: &Pubkey,
mint: &Pubkey,
authority: Option<Pubkey>,
auto_approve_new_accounts: bool,
auditor_elgamal_pubkey: Option<PodElGamalPubkey>,
) -> 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_elgamal_pubkey: auditor_elgamal_pubkey.try_into()?,
},
))
}
/// Create a `UpdateMint` instruction
pub fn update_mint(
token_program_id: &Pubkey,
mint: &Pubkey,
authority: &Pubkey,
multisig_signers: &[&Pubkey],
auto_approve_new_accounts: bool,
auditor_elgamal_pubkey: Option<PodElGamalPubkey>,
) -> Result<Instruction, ProgramError> {
check_program_account(token_program_id)?;
let mut accounts = vec![
AccountMeta::new(*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::UpdateMint,
&UpdateMintData {
auto_approve_new_accounts: auto_approve_new_accounts.into(),
auditor_elgamal_pubkey: auditor_elgamal_pubkey.try_into()?,
},
))
}
/// Create a `ConfigureAccount` instruction
///
/// This instruction is suitable for use with a cross-program `invoke`
#[allow(clippy::too_many_arguments)]
pub fn inner_configure_account(
token_program_id: &Pubkey,
token_account: &Pubkey,
mint: &Pubkey,
decryptable_zero_balance: PodAeCiphertext,
maximum_pending_balance_credit_counter: u64,
authority: &Pubkey,
multisig_signers: &[&Pubkey],
proof_data_location: ProofLocation<PubkeyValidityProofData>,
) -> Result<Instruction, ProgramError> {
check_program_account(token_program_id)?;
let mut accounts = vec![
AccountMeta::new(*token_account, false),
AccountMeta::new_readonly(*mint, false),
];
let proof_instruction_offset = match proof_data_location {
ProofLocation::InstructionOffset(proof_instruction_offset, proof_data) => {
accounts.push(AccountMeta::new_readonly(sysvar::instructions::id(), false));
if let ProofData::RecordAccount(record_address, _) = proof_data {
accounts.push(AccountMeta::new_readonly(*record_address, false));
}
proof_instruction_offset.into()
}
ProofLocation::ContextStateAccount(context_state_account) => {
accounts.push(AccountMeta::new_readonly(*context_state_account, false));
0
}
};
accounts.push(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,
maximum_pending_balance_credit_counter: maximum_pending_balance_credit_counter.into(),
proof_instruction_offset,
},
))
}
/// Create a `ConfigureAccount` instruction
#[allow(clippy::too_many_arguments)]
pub fn configure_account(
token_program_id: &Pubkey,
token_account: &Pubkey,
mint: &Pubkey,
decryptable_zero_balance: PodAeCiphertext,
maximum_pending_balance_credit_counter: u64,
authority: &Pubkey,
multisig_signers: &[&Pubkey],
proof_data_location: ProofLocation<PubkeyValidityProofData>,
) -> Result<Vec<Instruction>, ProgramError> {
let mut instructions = vec![inner_configure_account(
token_program_id,
token_account,
mint,
decryptable_zero_balance,
maximum_pending_balance_credit_counter,
authority,
multisig_signers,
proof_data_location,
)?];
if let ProofLocation::InstructionOffset(proof_instruction_offset, proof_data) =
proof_data_location
{
// This constructor appends the proof instruction right after the
// `ConfigureAccount` instruction. This means that the proof instruction
// offset must be always be 1. To use an arbitrary proof instruction
// offset, use the `inner_configure_account` constructor.
let proof_instruction_offset: i8 = proof_instruction_offset.into();
if proof_instruction_offset != 1 {
return Err(TokenError::InvalidProofInstructionOffset.into());
}
match proof_data {
ProofData::InstructionData(data) => instructions
.push(ProofInstruction::VerifyPubkeyValidity.encode_verify_proof(None, data)),
ProofData::RecordAccount(address, offset) => instructions.push(
ProofInstruction::VerifyPubkeyValidity
.encode_verify_proof_from_account(None, address, offset),
),
};
}
Ok(instructions)
}
/// Create an `ApproveAccount` instruction
pub fn approve_account(
token_program_id: &Pubkey,
account_to_approve: &Pubkey,
mint: &Pubkey,
authority: &Pubkey,
multisig_signers: &[&Pubkey],
) -> Result<Instruction, ProgramError> {
check_program_account(token_program_id)?;
let mut accounts = vec![
AccountMeta::new(*account_to_approve, 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::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_data_location: ProofLocation<ZeroCiphertextProofData>,
) -> Result<Instruction, ProgramError> {
check_program_account(token_program_id)?;
let mut accounts = vec![AccountMeta::new(*token_account, false)];
let proof_instruction_offset = match proof_data_location {
ProofLocation::InstructionOffset(proof_instruction_offset, proof_data) => {
accounts.push(AccountMeta::new_readonly(sysvar::instructions::id(), false));
if let ProofData::RecordAccount(record_address, _) = proof_data {
accounts.push(AccountMeta::new_readonly(*record_address, false));
}
proof_instruction_offset.into()
}
ProofLocation::ContextStateAccount(context_state_account) => {
accounts.push(AccountMeta::new_readonly(*context_state_account, false));
0
}
};
accounts.push(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_location: ProofLocation<ZeroCiphertextProofData>,
) -> Result<Vec<Instruction>, ProgramError> {
let mut instructions = vec![inner_empty_account(
token_program_id,
token_account,
authority,
multisig_signers,
proof_data_location,
)?];
if let ProofLocation::InstructionOffset(proof_instruction_offset, proof_data) =
proof_data_location
{
// This constructor appends the proof instruction right after the `EmptyAccount`
// instruction. This means that the proof instruction offset must be always be
// 1. To use an arbitrary proof instruction offset, use the
// `inner_empty_account` constructor.
let proof_instruction_offset: i8 = proof_instruction_offset.into();
if proof_instruction_offset != 1 {
return Err(TokenError::InvalidProofInstructionOffset.into());
}
match proof_data {
ProofData::InstructionData(data) => instructions
.push(ProofInstruction::VerifyZeroCiphertext.encode_verify_proof(None, data)),
ProofData::RecordAccount(address, offset) => instructions.push(
ProofInstruction::VerifyZeroCiphertext
.encode_verify_proof_from_account(None, address, offset),
),
};
};
Ok(instructions)
}
/// 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,