@algorandfoundation/algokit-utils 10.0.0-alpha.15 → 10.0.0-alpha.16

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/package.json +1 -1
  2. package/types/algorand-client-transaction-creator.d.ts +77 -77
  3. package/types/algorand-client-transaction-sender.d.ts +79 -79
  4. package/types/app-client.d.ts +256 -256
  5. package/types/app-factory.d.ts +91 -91
package/package.json CHANGED
@@ -6,7 +6,7 @@
6
6
  "**"
7
7
  ],
8
8
  "name": "@algorandfoundation/algokit-utils",
9
- "version": "10.0.0-alpha.15",
9
+ "version": "10.0.0-alpha.16",
10
10
  "private": false,
11
11
  "description": "A set of core Algorand utilities written in TypeScript and released via npm that make it easier to build solutions on Algorand.",
12
12
  "author": "Algorand Foundation",
package/types/algorand-client-transaction-creator.d.ts CHANGED
@@ -348,23 +348,23 @@ declare class AlgorandClientTransactionCreator {
348
348
  * @returns The application create transaction
349
349
  */
350
350
  appCreate: (params: {
351
- args?: Uint8Array[] | undefined;
351
+ maxFee?: AlgoAmount | undefined;
352
352
  sender: SendingAddress;
353
- signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
353
+ lease?: string | Uint8Array | undefined;
354
354
  rekeyTo?: ReadableAddress | undefined;
355
+ onComplete?: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.UpdateApplication | OnApplicationComplete.DeleteApplication | undefined;
356
+ signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
355
357
  note?: string | Uint8Array | undefined;
356
- lease?: string | Uint8Array | undefined;
357
358
  staticFee?: AlgoAmount | undefined;
358
359
  extraFee?: AlgoAmount | undefined;
359
- maxFee?: AlgoAmount | undefined;
360
360
  validityWindow?: number | bigint | undefined;
361
361
  firstValidRound?: bigint | undefined;
362
362
  lastValidRound?: bigint | undefined;
363
- onComplete?: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.UpdateApplication | OnApplicationComplete.DeleteApplication | undefined;
363
+ args?: Uint8Array[] | undefined;
364
364
  accountReferences?: ReadableAddress[] | undefined;
365
365
  appReferences?: bigint[] | undefined;
366
366
  assetReferences?: bigint[] | undefined;
367
- boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
367
+ boxReferences?: (BoxIdentifier | BoxReference)[] | undefined;
368
368
  accessReferences?: ResourceReference[] | undefined;
369
369
  rejectVersion?: number | undefined;
370
370
  appId?: 0 | undefined;
@@ -433,7 +433,7 @@ declare class AlgorandClientTransactionCreator {
433
433
  accountReferences?: ReadableAddress[] | undefined;
434
434
  appReferences?: bigint[] | undefined;
435
435
  assetReferences?: bigint[] | undefined;
436
- boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
436
+ boxReferences?: (BoxIdentifier | BoxReference)[] | undefined;
437
437
  accessReferences?: ResourceReference[] | undefined;
438
438
  rejectVersion?: number | undefined;
439
439
  approvalProgram: string | Uint8Array;
@@ -568,53 +568,53 @@ declare class AlgorandClientTransactionCreator {
568
568
  * @returns The application ABI method create transaction
569
569
  */
570
570
  appCreateMethodCall: (params: {
571
- appId?: 0 | undefined;
571
+ maxFee?: AlgoAmount | undefined;
572
+ schema?: {
573
+ globalInts: number;
574
+ globalByteSlices: number;
575
+ localInts: number;
576
+ localByteSlices: number;
577
+ } | undefined;
572
578
  sender: SendingAddress;
573
- signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
579
+ lease?: string | Uint8Array | undefined;
574
580
  rekeyTo?: ReadableAddress | undefined;
581
+ approvalProgram: string | Uint8Array;
582
+ clearStateProgram: string | Uint8Array;
583
+ appId?: 0 | undefined;
584
+ onComplete?: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.UpdateApplication | OnApplicationComplete.DeleteApplication | undefined;
585
+ signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
575
586
  note?: string | Uint8Array | undefined;
576
- lease?: string | Uint8Array | undefined;
577
587
  staticFee?: AlgoAmount | undefined;
578
588
  extraFee?: AlgoAmount | undefined;
579
- maxFee?: AlgoAmount | undefined;
580
589
  validityWindow?: number | bigint | undefined;
581
590
  firstValidRound?: bigint | undefined;
582
591
  lastValidRound?: bigint | undefined;
583
- onComplete?: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.UpdateApplication | OnApplicationComplete.DeleteApplication | undefined;
584
592
  accountReferences?: ReadableAddress[] | undefined;
585
593
  appReferences?: bigint[] | undefined;
586
594
  assetReferences?: bigint[] | undefined;
587
- boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
595
+ boxReferences?: (BoxIdentifier | BoxReference)[] | undefined;
588
596
  accessReferences?: ResourceReference[] | undefined;
589
597
  rejectVersion?: number | undefined;
590
- approvalProgram: string | Uint8Array;
591
- clearStateProgram: string | Uint8Array;
592
- schema?: {
593
- globalInts: number;
594
- globalByteSlices: number;
595
- localInts: number;
596
- localByteSlices: number;
597
- } | undefined;
598
598
  extraProgramPages?: number | undefined;
599
599
  method: ABIMethod;
600
- args?: (Transaction | ABIValue | TransactionWithSigner | AppMethodCall<{
601
- args?: Uint8Array[] | undefined;
600
+ args?: (ABIValue | TransactionWithSigner | Transaction | Promise<Transaction> | AppMethodCall<{
601
+ maxFee?: AlgoAmount | undefined;
602
602
  sender: SendingAddress;
603
- signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
603
+ lease?: string | Uint8Array | undefined;
604
604
  rekeyTo?: ReadableAddress | undefined;
605
+ onComplete?: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.UpdateApplication | OnApplicationComplete.DeleteApplication | undefined;
606
+ signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
605
607
  note?: string | Uint8Array | undefined;
606
- lease?: string | Uint8Array | undefined;
607
608
  staticFee?: AlgoAmount | undefined;
608
609
  extraFee?: AlgoAmount | undefined;
609
- maxFee?: AlgoAmount | undefined;
610
610
  validityWindow?: number | bigint | undefined;
611
611
  firstValidRound?: bigint | undefined;
612
612
  lastValidRound?: bigint | undefined;
613
- onComplete?: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.UpdateApplication | OnApplicationComplete.DeleteApplication | undefined;
613
+ args?: Uint8Array[] | undefined;
614
614
  accountReferences?: ReadableAddress[] | undefined;
615
615
  appReferences?: bigint[] | undefined;
616
616
  assetReferences?: bigint[] | undefined;
617
- boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
617
+ boxReferences?: (BoxIdentifier | BoxReference)[] | undefined;
618
618
  accessReferences?: ResourceReference[] | undefined;
619
619
  rejectVersion?: number | undefined;
620
620
  appId?: 0 | undefined;
@@ -645,12 +645,12 @@ declare class AlgorandClientTransactionCreator {
645
645
  accountReferences?: ReadableAddress[] | undefined;
646
646
  appReferences?: bigint[] | undefined;
647
647
  assetReferences?: bigint[] | undefined;
648
- boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
648
+ boxReferences?: (BoxIdentifier | BoxReference)[] | undefined;
649
649
  accessReferences?: ResourceReference[] | undefined;
650
650
  rejectVersion?: number | undefined;
651
651
  approvalProgram: string | Uint8Array;
652
652
  clearStateProgram: string | Uint8Array;
653
- }> | AppMethodCall<AppMethodCallParams> | Promise<Transaction> | undefined)[] | undefined;
653
+ }> | AppMethodCall<AppMethodCallParams> | undefined)[] | undefined;
654
654
  }) => Promise<Expand<BuiltTransactions>>;
655
655
  /** Create an application update call with ABI method call transaction.
656
656
  *
@@ -702,46 +702,46 @@ declare class AlgorandClientTransactionCreator {
702
702
  * @returns The application ABI method update transaction
703
703
  */
704
704
  appUpdateMethodCall: (params: {
705
- appId: bigint;
705
+ maxFee?: AlgoAmount | undefined;
706
706
  sender: SendingAddress;
707
- signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
707
+ lease?: string | Uint8Array | undefined;
708
708
  rekeyTo?: ReadableAddress | undefined;
709
+ approvalProgram: string | Uint8Array;
710
+ clearStateProgram: string | Uint8Array;
711
+ appId: bigint;
712
+ onComplete?: OnApplicationComplete.UpdateApplication | undefined;
713
+ signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
709
714
  note?: string | Uint8Array | undefined;
710
- lease?: string | Uint8Array | undefined;
711
715
  staticFee?: AlgoAmount | undefined;
712
716
  extraFee?: AlgoAmount | undefined;
713
- maxFee?: AlgoAmount | undefined;
714
717
  validityWindow?: number | bigint | undefined;
715
718
  firstValidRound?: bigint | undefined;
716
719
  lastValidRound?: bigint | undefined;
717
- onComplete?: OnApplicationComplete.UpdateApplication | undefined;
718
720
  accountReferences?: ReadableAddress[] | undefined;
719
721
  appReferences?: bigint[] | undefined;
720
722
  assetReferences?: bigint[] | undefined;
721
- boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
723
+ boxReferences?: (BoxIdentifier | BoxReference)[] | undefined;
722
724
  accessReferences?: ResourceReference[] | undefined;
723
725
  rejectVersion?: number | undefined;
724
- approvalProgram: string | Uint8Array;
725
- clearStateProgram: string | Uint8Array;
726
726
  method: ABIMethod;
727
- args?: (Transaction | ABIValue | TransactionWithSigner | AppMethodCall<{
728
- args?: Uint8Array[] | undefined;
727
+ args?: (ABIValue | TransactionWithSigner | Transaction | Promise<Transaction> | AppMethodCall<{
728
+ maxFee?: AlgoAmount | undefined;
729
729
  sender: SendingAddress;
730
- signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
730
+ lease?: string | Uint8Array | undefined;
731
731
  rekeyTo?: ReadableAddress | undefined;
732
+ onComplete?: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.UpdateApplication | OnApplicationComplete.DeleteApplication | undefined;
733
+ signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
732
734
  note?: string | Uint8Array | undefined;
733
- lease?: string | Uint8Array | undefined;
734
735
  staticFee?: AlgoAmount | undefined;
735
736
  extraFee?: AlgoAmount | undefined;
736
- maxFee?: AlgoAmount | undefined;
737
737
  validityWindow?: number | bigint | undefined;
738
738
  firstValidRound?: bigint | undefined;
739
739
  lastValidRound?: bigint | undefined;
740
- onComplete?: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.UpdateApplication | OnApplicationComplete.DeleteApplication | undefined;
740
+ args?: Uint8Array[] | undefined;
741
741
  accountReferences?: ReadableAddress[] | undefined;
742
742
  appReferences?: bigint[] | undefined;
743
743
  assetReferences?: bigint[] | undefined;
744
- boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
744
+ boxReferences?: (BoxIdentifier | BoxReference)[] | undefined;
745
745
  accessReferences?: ResourceReference[] | undefined;
746
746
  rejectVersion?: number | undefined;
747
747
  appId?: 0 | undefined;
@@ -772,12 +772,12 @@ declare class AlgorandClientTransactionCreator {
772
772
  accountReferences?: ReadableAddress[] | undefined;
773
773
  appReferences?: bigint[] | undefined;
774
774
  assetReferences?: bigint[] | undefined;
775
- boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
775
+ boxReferences?: (BoxIdentifier | BoxReference)[] | undefined;
776
776
  accessReferences?: ResourceReference[] | undefined;
777
777
  rejectVersion?: number | undefined;
778
778
  approvalProgram: string | Uint8Array;
779
779
  clearStateProgram: string | Uint8Array;
780
- }> | AppMethodCall<AppMethodCallParams> | Promise<Transaction> | undefined)[] | undefined;
780
+ }> | AppMethodCall<AppMethodCallParams> | undefined)[] | undefined;
781
781
  }) => Promise<Expand<BuiltTransactions>>;
782
782
  /** Create an application delete call with ABI method call transaction.
783
783
  *
@@ -827,44 +827,44 @@ declare class AlgorandClientTransactionCreator {
827
827
  * @returns The application ABI method delete transaction
828
828
  */
829
829
  appDeleteMethodCall: (params: {
830
- appId: bigint;
830
+ maxFee?: AlgoAmount | undefined;
831
831
  sender: SendingAddress;
832
- signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
832
+ lease?: string | Uint8Array | undefined;
833
833
  rekeyTo?: ReadableAddress | undefined;
834
+ appId: bigint;
835
+ onComplete?: OnApplicationComplete.DeleteApplication | undefined;
836
+ signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
834
837
  note?: string | Uint8Array | undefined;
835
- lease?: string | Uint8Array | undefined;
836
838
  staticFee?: AlgoAmount | undefined;
837
839
  extraFee?: AlgoAmount | undefined;
838
- maxFee?: AlgoAmount | undefined;
839
840
  validityWindow?: number | bigint | undefined;
840
841
  firstValidRound?: bigint | undefined;
841
842
  lastValidRound?: bigint | undefined;
842
- onComplete?: OnApplicationComplete.DeleteApplication | undefined;
843
843
  accountReferences?: ReadableAddress[] | undefined;
844
844
  appReferences?: bigint[] | undefined;
845
845
  assetReferences?: bigint[] | undefined;
846
- boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
846
+ boxReferences?: (BoxIdentifier | BoxReference)[] | undefined;
847
847
  accessReferences?: ResourceReference[] | undefined;
848
848
  rejectVersion?: number | undefined;
849
849
  method: ABIMethod;
850
- args?: (Transaction | ABIValue | TransactionWithSigner | AppMethodCall<{
851
- args?: Uint8Array[] | undefined;
850
+ args?: (ABIValue | TransactionWithSigner | Transaction | Promise<Transaction> | AppMethodCall<{
851
+ maxFee?: AlgoAmount | undefined;
852
852
  sender: SendingAddress;
853
- signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
853
+ lease?: string | Uint8Array | undefined;
854
854
  rekeyTo?: ReadableAddress | undefined;
855
+ onComplete?: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.UpdateApplication | OnApplicationComplete.DeleteApplication | undefined;
856
+ signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
855
857
  note?: string | Uint8Array | undefined;
856
- lease?: string | Uint8Array | undefined;
857
858
  staticFee?: AlgoAmount | undefined;
858
859
  extraFee?: AlgoAmount | undefined;
859
- maxFee?: AlgoAmount | undefined;
860
860
  validityWindow?: number | bigint | undefined;
861
861
  firstValidRound?: bigint | undefined;
862
862
  lastValidRound?: bigint | undefined;
863
- onComplete?: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.UpdateApplication | OnApplicationComplete.DeleteApplication | undefined;
863
+ args?: Uint8Array[] | undefined;
864
864
  accountReferences?: ReadableAddress[] | undefined;
865
865
  appReferences?: bigint[] | undefined;
866
866
  assetReferences?: bigint[] | undefined;
867
- boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
867
+ boxReferences?: (BoxIdentifier | BoxReference)[] | undefined;
868
868
  accessReferences?: ResourceReference[] | undefined;
869
869
  rejectVersion?: number | undefined;
870
870
  appId?: 0 | undefined;
@@ -895,12 +895,12 @@ declare class AlgorandClientTransactionCreator {
895
895
  accountReferences?: ReadableAddress[] | undefined;
896
896
  appReferences?: bigint[] | undefined;
897
897
  assetReferences?: bigint[] | undefined;
898
- boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
898
+ boxReferences?: (BoxIdentifier | BoxReference)[] | undefined;
899
899
  accessReferences?: ResourceReference[] | undefined;
900
900
  rejectVersion?: number | undefined;
901
901
  approvalProgram: string | Uint8Array;
902
902
  clearStateProgram: string | Uint8Array;
903
- }> | AppMethodCall<AppMethodCallParams> | Promise<Transaction> | undefined)[] | undefined;
903
+ }> | AppMethodCall<AppMethodCallParams> | undefined)[] | undefined;
904
904
  }) => Promise<Expand<BuiltTransactions>>;
905
905
  /** Create an application call with ABI method call transaction.
906
906
  *
@@ -950,44 +950,44 @@ declare class AlgorandClientTransactionCreator {
950
950
  * @returns The application ABI method call transaction
951
951
  */
952
952
  appCallMethodCall: (params: {
953
- appId: bigint;
953
+ maxFee?: AlgoAmount | undefined;
954
954
  sender: SendingAddress;
955
- signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
955
+ lease?: string | Uint8Array | undefined;
956
956
  rekeyTo?: ReadableAddress | undefined;
957
+ appId: bigint;
958
+ onComplete?: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.DeleteApplication | undefined;
959
+ signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
957
960
  note?: string | Uint8Array | undefined;
958
- lease?: string | Uint8Array | undefined;
959
961
  staticFee?: AlgoAmount | undefined;
960
962
  extraFee?: AlgoAmount | undefined;
961
- maxFee?: AlgoAmount | undefined;
962
963
  validityWindow?: number | bigint | undefined;
963
964
  firstValidRound?: bigint | undefined;
964
965
  lastValidRound?: bigint | undefined;
965
- onComplete?: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.DeleteApplication | undefined;
966
966
  accountReferences?: ReadableAddress[] | undefined;
967
967
  appReferences?: bigint[] | undefined;
968
968
  assetReferences?: bigint[] | undefined;
969
- boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
969
+ boxReferences?: (BoxIdentifier | BoxReference)[] | undefined;
970
970
  accessReferences?: ResourceReference[] | undefined;
971
971
  rejectVersion?: number | undefined;
972
972
  method: ABIMethod;
973
- args?: (Transaction | ABIValue | TransactionWithSigner | AppMethodCall<{
974
- args?: Uint8Array[] | undefined;
973
+ args?: (ABIValue | TransactionWithSigner | Transaction | Promise<Transaction> | AppMethodCall<{
974
+ maxFee?: AlgoAmount | undefined;
975
975
  sender: SendingAddress;
976
- signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
976
+ lease?: string | Uint8Array | undefined;
977
977
  rekeyTo?: ReadableAddress | undefined;
978
+ onComplete?: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.UpdateApplication | OnApplicationComplete.DeleteApplication | undefined;
979
+ signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
978
980
  note?: string | Uint8Array | undefined;
979
- lease?: string | Uint8Array | undefined;
980
981
  staticFee?: AlgoAmount | undefined;
981
982
  extraFee?: AlgoAmount | undefined;
982
- maxFee?: AlgoAmount | undefined;
983
983
  validityWindow?: number | bigint | undefined;
984
984
  firstValidRound?: bigint | undefined;
985
985
  lastValidRound?: bigint | undefined;
986
- onComplete?: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.UpdateApplication | OnApplicationComplete.DeleteApplication | undefined;
986
+ args?: Uint8Array[] | undefined;
987
987
  accountReferences?: ReadableAddress[] | undefined;
988
988
  appReferences?: bigint[] | undefined;
989
989
  assetReferences?: bigint[] | undefined;
990
- boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
990
+ boxReferences?: (BoxIdentifier | BoxReference)[] | undefined;
991
991
  accessReferences?: ResourceReference[] | undefined;
992
992
  rejectVersion?: number | undefined;
993
993
  appId?: 0 | undefined;
@@ -1018,12 +1018,12 @@ declare class AlgorandClientTransactionCreator {
1018
1018
  accountReferences?: ReadableAddress[] | undefined;
1019
1019
  appReferences?: bigint[] | undefined;
1020
1020
  assetReferences?: bigint[] | undefined;
1021
- boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
1021
+ boxReferences?: (BoxIdentifier | BoxReference)[] | undefined;
1022
1022
  accessReferences?: ResourceReference[] | undefined;
1023
1023
  rejectVersion?: number | undefined;
1024
1024
  approvalProgram: string | Uint8Array;
1025
1025
  clearStateProgram: string | Uint8Array;
1026
- }> | AppMethodCall<AppMethodCallParams> | Promise<Transaction> | undefined)[] | undefined;
1026
+ }> | AppMethodCall<AppMethodCallParams> | undefined)[] | undefined;
1027
1027
  }) => Promise<Expand<BuiltTransactions>>;
1028
1028
  /**
1029
1029
  * Create an online key registration transaction.