@algorandfoundation/algokit-utils 10.0.0-alpha.5 → 10.0.0-alpha.6

package/types/algorand-client-transaction-creator.d.ts

@@ -1,7 +1,7 @@
 import { ReadableAddress } from "../packages/common/src/address.js";
 import { ABIValue } from "../packages/abi/src/abi-value.js";
 import { ABIMethod } from "../packages/abi/src/abi-method.js";
-import { AccessReference, OnApplicationComplete } from "../packages/transact/src/transactions/app-call.js";
+import { OnApplicationComplete, ResourceReference } from "../packages/transact/src/transactions/app-call.js";
 import { Transaction } from "../packages/transact/src/transactions/transaction.js";
 import { AddressWithTransactionSigner, SendingAddress, TransactionSigner } from "../packages/transact/src/signer.js";
 import { AlgoAmount } from "./amount.js";
@@ -347,9 +347,8 @@ declare class AlgorandClientTransactionCreator {
    * @returns The application create transaction
    */
   appCreate: (params: {
-    args?: Uint8Array[] | undefined;
-    sender: SendingAddress;
     signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
+    sender: SendingAddress;
     rekeyTo?: ReadableAddress | undefined;
     note?: string | Uint8Array | undefined;
     lease?: string | Uint8Array | undefined;
@@ -360,11 +359,12 @@ declare class AlgorandClientTransactionCreator {
     firstValidRound?: bigint | undefined;
     lastValidRound?: bigint | undefined;
     onComplete?: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.UpdateApplication | OnApplicationComplete.DeleteApplication | undefined;
+    args?: Uint8Array[] | undefined;
     accountReferences?: ReadableAddress[] | undefined;
     appReferences?: bigint[] | undefined;
     assetReferences?: bigint[] | undefined;
     boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
-    accessReferences?: AccessReference[] | undefined;
+    accessReferences?: ResourceReference[] | undefined;
     rejectVersion?: number | undefined;
     approvalProgram: string | Uint8Array;
     clearStateProgram: string | Uint8Array;
@@ -431,7 +431,7 @@ declare class AlgorandClientTransactionCreator {
     appReferences?: bigint[] | undefined;
     assetReferences?: bigint[] | undefined;
     boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
-    accessReferences?: AccessReference[] | undefined;
+    accessReferences?: ResourceReference[] | undefined;
     rejectVersion?: number | undefined;
     approvalProgram: string | Uint8Array;
     clearStateProgram: string | Uint8Array;
@@ -562,8 +562,8 @@ declare class AlgorandClientTransactionCreator {
    * @returns The application ABI method create transaction
    */
   appCreateMethodCall: (params: {
-    sender: SendingAddress;
     signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
+    sender: SendingAddress;
     rekeyTo?: ReadableAddress | undefined;
     note?: string | Uint8Array | undefined;
     lease?: string | Uint8Array | undefined;
@@ -573,15 +573,15 @@ declare class AlgorandClientTransactionCreator {
     validityWindow?: number | bigint | undefined;
     firstValidRound?: bigint | undefined;
     lastValidRound?: bigint | undefined;
+    approvalProgram: string | Uint8Array;
+    clearStateProgram: string | Uint8Array;
     onComplete?: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.UpdateApplication | OnApplicationComplete.DeleteApplication | undefined;
     accountReferences?: ReadableAddress[] | undefined;
     appReferences?: bigint[] | undefined;
     assetReferences?: bigint[] | undefined;
     boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
-    accessReferences?: AccessReference[] | undefined;
+    accessReferences?: ResourceReference[] | undefined;
     rejectVersion?: number | undefined;
-    approvalProgram: string | Uint8Array;
-    clearStateProgram: string | Uint8Array;
     schema?: {
       globalInts: number;
       globalByteSlices: number;
@@ -591,7 +591,6 @@ declare class AlgorandClientTransactionCreator {
     extraProgramPages?: number | undefined;
     method: ABIMethod;
     args?: (Transaction | ABIValue | TransactionWithSigner | AppMethodCall<{
-      args?: Uint8Array[] | undefined;
       sender: SendingAddress;
       signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
       rekeyTo?: ReadableAddress | undefined;
@@ -603,25 +602,20 @@ declare class AlgorandClientTransactionCreator {
       validityWindow?: number | bigint | undefined;
       firstValidRound?: bigint | undefined;
       lastValidRound?: bigint | undefined;
-      onComplete?: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.UpdateApplication | OnApplicationComplete.DeleteApplication | undefined;
+      appId: bigint;
+      onComplete?: OnApplicationComplete.UpdateApplication | undefined;
+      args?: Uint8Array[] | undefined;
       accountReferences?: ReadableAddress[] | undefined;
       appReferences?: bigint[] | undefined;
       assetReferences?: bigint[] | undefined;
       boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
-      accessReferences?: AccessReference[] | undefined;
+      accessReferences?: ResourceReference[] | undefined;
       rejectVersion?: number | undefined;
       approvalProgram: string | Uint8Array;
       clearStateProgram: string | Uint8Array;
-      schema?: {
-        globalInts: number;
-        globalByteSlices: number;
-        localInts: number;
-        localByteSlices: number;
-      } | undefined;
-      extraProgramPages?: number | undefined;
     }> | AppMethodCall<{
-      sender: SendingAddress;
       signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
+      sender: SendingAddress;
       rekeyTo?: ReadableAddress | undefined;
       note?: string | Uint8Array | undefined;
       lease?: string | Uint8Array | undefined;
@@ -631,18 +625,24 @@ declare class AlgorandClientTransactionCreator {
       validityWindow?: number | bigint | undefined;
       firstValidRound?: bigint | undefined;
       lastValidRound?: bigint | undefined;
-      appId: bigint;
-      onComplete?: OnApplicationComplete.UpdateApplication | undefined;
+      onComplete?: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.UpdateApplication | OnApplicationComplete.DeleteApplication | undefined;
       args?: Uint8Array[] | undefined;
       accountReferences?: ReadableAddress[] | undefined;
       appReferences?: bigint[] | undefined;
       assetReferences?: bigint[] | undefined;
       boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
-      accessReferences?: AccessReference[] | undefined;
+      accessReferences?: ResourceReference[] | undefined;
       rejectVersion?: number | undefined;
       approvalProgram: string | Uint8Array;
       clearStateProgram: string | Uint8Array;
-    }> | AppMethodCall<AppMethodCallParams> | Promise<Transaction> | undefined)[] | undefined;
+      schema?: {
+        globalInts: number;
+        globalByteSlices: number;
+        localInts: number;
+        localByteSlices: number;
+      } | undefined;
+      extraProgramPages?: number | undefined;
+    }> | Promise<Transaction> | AppMethodCall<AppMethodCallParams> | undefined)[] | undefined;
   }) => Promise<Expand<BuiltTransactions>>;
   /** Create an application update call with ABI method call transaction.
    *
@@ -693,9 +693,8 @@ declare class AlgorandClientTransactionCreator {
    * @returns The application ABI method update transaction
    */
   appUpdateMethodCall: (params: {
-    appId: bigint;
-    sender: SendingAddress;
     signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
+    sender: SendingAddress;
     rekeyTo?: ReadableAddress | undefined;
     note?: string | Uint8Array | undefined;
     lease?: string | Uint8Array | undefined;
@@ -705,18 +704,18 @@ declare class AlgorandClientTransactionCreator {
     validityWindow?: number | bigint | undefined;
     firstValidRound?: bigint | undefined;
     lastValidRound?: bigint | undefined;
+    appId: bigint;
+    approvalProgram: string | Uint8Array;
+    clearStateProgram: string | Uint8Array;
     onComplete?: OnApplicationComplete.UpdateApplication | undefined;
     accountReferences?: ReadableAddress[] | undefined;
     appReferences?: bigint[] | undefined;
     assetReferences?: bigint[] | undefined;
     boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
-    accessReferences?: AccessReference[] | undefined;
+    accessReferences?: ResourceReference[] | undefined;
     rejectVersion?: number | undefined;
-    approvalProgram: string | Uint8Array;
-    clearStateProgram: string | Uint8Array;
     method: ABIMethod;
     args?: (Transaction | ABIValue | TransactionWithSigner | AppMethodCall<{
-      args?: Uint8Array[] | undefined;
       sender: SendingAddress;
       signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
       rekeyTo?: ReadableAddress | undefined;
@@ -728,25 +727,20 @@ declare class AlgorandClientTransactionCreator {
       validityWindow?: number | bigint | undefined;
       firstValidRound?: bigint | undefined;
       lastValidRound?: bigint | undefined;
-      onComplete?: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.UpdateApplication | OnApplicationComplete.DeleteApplication | undefined;
+      appId: bigint;
+      onComplete?: OnApplicationComplete.UpdateApplication | undefined;
+      args?: Uint8Array[] | undefined;
       accountReferences?: ReadableAddress[] | undefined;
       appReferences?: bigint[] | undefined;
       assetReferences?: bigint[] | undefined;
       boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
-      accessReferences?: AccessReference[] | undefined;
+      accessReferences?: ResourceReference[] | undefined;
       rejectVersion?: number | undefined;
       approvalProgram: string | Uint8Array;
       clearStateProgram: string | Uint8Array;
-      schema?: {
-        globalInts: number;
-        globalByteSlices: number;
-        localInts: number;
-        localByteSlices: number;
-      } | undefined;
-      extraProgramPages?: number | undefined;
     }> | AppMethodCall<{
-      sender: SendingAddress;
       signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
+      sender: SendingAddress;
       rekeyTo?: ReadableAddress | undefined;
       note?: string | Uint8Array | undefined;
       lease?: string | Uint8Array | undefined;
@@ -756,18 +750,24 @@ declare class AlgorandClientTransactionCreator {
       validityWindow?: number | bigint | undefined;
       firstValidRound?: bigint | undefined;
       lastValidRound?: bigint | undefined;
-      appId: bigint;
-      onComplete?: OnApplicationComplete.UpdateApplication | undefined;
+      onComplete?: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.UpdateApplication | OnApplicationComplete.DeleteApplication | undefined;
       args?: Uint8Array[] | undefined;
       accountReferences?: ReadableAddress[] | undefined;
       appReferences?: bigint[] | undefined;
       assetReferences?: bigint[] | undefined;
       boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
-      accessReferences?: AccessReference[] | undefined;
+      accessReferences?: ResourceReference[] | undefined;
       rejectVersion?: number | undefined;
       approvalProgram: string | Uint8Array;
       clearStateProgram: string | Uint8Array;
-    }> | AppMethodCall<AppMethodCallParams> | Promise<Transaction> | undefined)[] | undefined;
+      schema?: {
+        globalInts: number;
+        globalByteSlices: number;
+        localInts: number;
+        localByteSlices: number;
+      } | undefined;
+      extraProgramPages?: number | undefined;
+    }> | Promise<Transaction> | AppMethodCall<AppMethodCallParams> | undefined)[] | undefined;
   }) => Promise<Expand<BuiltTransactions>>;
   /** Create an application delete call with ABI method call transaction.
    *
@@ -816,9 +816,8 @@ declare class AlgorandClientTransactionCreator {
    * @returns The application ABI method delete transaction
    */
   appDeleteMethodCall: (params: {
-    appId: bigint;
-    sender: SendingAddress;
     signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
+    sender: SendingAddress;
     rekeyTo?: ReadableAddress | undefined;
     note?: string | Uint8Array | undefined;
     lease?: string | Uint8Array | undefined;
@@ -828,16 +827,16 @@ declare class AlgorandClientTransactionCreator {
     validityWindow?: number | bigint | undefined;
     firstValidRound?: bigint | undefined;
     lastValidRound?: bigint | undefined;
+    appId: bigint;
     onComplete?: OnApplicationComplete.DeleteApplication | undefined;
     accountReferences?: ReadableAddress[] | undefined;
     appReferences?: bigint[] | undefined;
     assetReferences?: bigint[] | undefined;
     boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
-    accessReferences?: AccessReference[] | undefined;
+    accessReferences?: ResourceReference[] | undefined;
     rejectVersion?: number | undefined;
     method: ABIMethod;
     args?: (Transaction | ABIValue | TransactionWithSigner | AppMethodCall<{
-      args?: Uint8Array[] | undefined;
       sender: SendingAddress;
       signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
       rekeyTo?: ReadableAddress | undefined;
@@ -849,25 +848,20 @@ declare class AlgorandClientTransactionCreator {
       validityWindow?: number | bigint | undefined;
       firstValidRound?: bigint | undefined;
       lastValidRound?: bigint | undefined;
-      onComplete?: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.UpdateApplication | OnApplicationComplete.DeleteApplication | undefined;
+      appId: bigint;
+      onComplete?: OnApplicationComplete.UpdateApplication | undefined;
+      args?: Uint8Array[] | undefined;
       accountReferences?: ReadableAddress[] | undefined;
       appReferences?: bigint[] | undefined;
       assetReferences?: bigint[] | undefined;
       boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
-      accessReferences?: AccessReference[] | undefined;
+      accessReferences?: ResourceReference[] | undefined;
       rejectVersion?: number | undefined;
       approvalProgram: string | Uint8Array;
       clearStateProgram: string | Uint8Array;
-      schema?: {
-        globalInts: number;
-        globalByteSlices: number;
-        localInts: number;
-        localByteSlices: number;
-      } | undefined;
-      extraProgramPages?: number | undefined;
     }> | AppMethodCall<{
-      sender: SendingAddress;
       signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
+      sender: SendingAddress;
       rekeyTo?: ReadableAddress | undefined;
       note?: string | Uint8Array | undefined;
       lease?: string | Uint8Array | undefined;
@@ -877,18 +871,24 @@ declare class AlgorandClientTransactionCreator {
       validityWindow?: number | bigint | undefined;
       firstValidRound?: bigint | undefined;
       lastValidRound?: bigint | undefined;
-      appId: bigint;
-      onComplete?: OnApplicationComplete.UpdateApplication | undefined;
+      onComplete?: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.UpdateApplication | OnApplicationComplete.DeleteApplication | undefined;
       args?: Uint8Array[] | undefined;
       accountReferences?: ReadableAddress[] | undefined;
       appReferences?: bigint[] | undefined;
       assetReferences?: bigint[] | undefined;
       boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
-      accessReferences?: AccessReference[] | undefined;
+      accessReferences?: ResourceReference[] | undefined;
       rejectVersion?: number | undefined;
       approvalProgram: string | Uint8Array;
       clearStateProgram: string | Uint8Array;
-    }> | AppMethodCall<AppMethodCallParams> | Promise<Transaction> | undefined)[] | undefined;
+      schema?: {
+        globalInts: number;
+        globalByteSlices: number;
+        localInts: number;
+        localByteSlices: number;
+      } | undefined;
+      extraProgramPages?: number | undefined;
+    }> | Promise<Transaction> | AppMethodCall<AppMethodCallParams> | undefined)[] | undefined;
   }) => Promise<Expand<BuiltTransactions>>;
   /** Create an application call with ABI method call transaction.
    *
@@ -937,9 +937,8 @@ declare class AlgorandClientTransactionCreator {
    * @returns The application ABI method call transaction
    */
   appCallMethodCall: (params: {
-    appId: bigint;
-    sender: SendingAddress;
     signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
+    sender: SendingAddress;
     rekeyTo?: ReadableAddress | undefined;
     note?: string | Uint8Array | undefined;
     lease?: string | Uint8Array | undefined;
@@ -949,16 +948,16 @@ declare class AlgorandClientTransactionCreator {
     validityWindow?: number | bigint | undefined;
     firstValidRound?: bigint | undefined;
     lastValidRound?: bigint | undefined;
+    appId: bigint;
     onComplete?: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.DeleteApplication | undefined;
     accountReferences?: ReadableAddress[] | undefined;
     appReferences?: bigint[] | undefined;
     assetReferences?: bigint[] | undefined;
     boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
-    accessReferences?: AccessReference[] | undefined;
+    accessReferences?: ResourceReference[] | undefined;
     rejectVersion?: number | undefined;
     method: ABIMethod;
     args?: (Transaction | ABIValue | TransactionWithSigner | AppMethodCall<{
-      args?: Uint8Array[] | undefined;
       sender: SendingAddress;
       signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
       rekeyTo?: ReadableAddress | undefined;
@@ -970,25 +969,20 @@ declare class AlgorandClientTransactionCreator {
       validityWindow?: number | bigint | undefined;
       firstValidRound?: bigint | undefined;
       lastValidRound?: bigint | undefined;
-      onComplete?: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.UpdateApplication | OnApplicationComplete.DeleteApplication | undefined;
+      appId: bigint;
+      onComplete?: OnApplicationComplete.UpdateApplication | undefined;
+      args?: Uint8Array[] | undefined;
       accountReferences?: ReadableAddress[] | undefined;
       appReferences?: bigint[] | undefined;
       assetReferences?: bigint[] | undefined;
       boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
-      accessReferences?: AccessReference[] | undefined;
+      accessReferences?: ResourceReference[] | undefined;
       rejectVersion?: number | undefined;
       approvalProgram: string | Uint8Array;
       clearStateProgram: string | Uint8Array;
-      schema?: {
-        globalInts: number;
-        globalByteSlices: number;
-        localInts: number;
-        localByteSlices: number;
-      } | undefined;
-      extraProgramPages?: number | undefined;
     }> | AppMethodCall<{
-      sender: SendingAddress;
       signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
+      sender: SendingAddress;
       rekeyTo?: ReadableAddress | undefined;
       note?: string | Uint8Array | undefined;
       lease?: string | Uint8Array | undefined;
@@ -998,18 +992,24 @@ declare class AlgorandClientTransactionCreator {
       validityWindow?: number | bigint | undefined;
       firstValidRound?: bigint | undefined;
       lastValidRound?: bigint | undefined;
-      appId: bigint;
-      onComplete?: OnApplicationComplete.UpdateApplication | undefined;
+      onComplete?: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.UpdateApplication | OnApplicationComplete.DeleteApplication | undefined;
       args?: Uint8Array[] | undefined;
       accountReferences?: ReadableAddress[] | undefined;
       appReferences?: bigint[] | undefined;
       assetReferences?: bigint[] | undefined;
       boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
-      accessReferences?: AccessReference[] | undefined;
+      accessReferences?: ResourceReference[] | undefined;
       rejectVersion?: number | undefined;
       approvalProgram: string | Uint8Array;
       clearStateProgram: string | Uint8Array;
-    }> | AppMethodCall<AppMethodCallParams> | Promise<Transaction> | undefined)[] | undefined;
+      schema?: {
+        globalInts: number;
+        globalByteSlices: number;
+        localInts: number;
+        localByteSlices: number;
+      } | undefined;
+      extraProgramPages?: number | undefined;
+    }> | Promise<Transaction> | AppMethodCall<AppMethodCallParams> | undefined)[] | undefined;
   }) => Promise<Expand<BuiltTransactions>>;
   /**
    * Create an online key registration transaction.