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

package/types/algorand-client-transaction-sender.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, ABIReturn } 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 { PendingTransactionResponse } from "../packages/algod_client/src/models/pending-transaction-response.js";
@@ -236,7 +236,7 @@ declare class AlgorandClientTransactionSender {
    */
   assetFreeze: (params: CommonTransactionParams & {
     assetId: bigint;
-    account: ReadableAddress;
+    freezeTarget: ReadableAddress;
     frozen: boolean;
   } & SendParams) => Promise<SendSingleTransactionResult>;
   /**
@@ -478,9 +478,8 @@ declare class AlgorandClientTransactionSender {
    * @returns The result of the app create transaction and the transaction that was sent
    */
   appCreate: (params: {
-    args?: Uint8Array[] | undefined;
-    sender: SendingAddress;
     signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
+    sender: SendingAddress;
     rekeyTo?: ReadableAddress | undefined;
     note?: string | Uint8Array | undefined;
     lease?: string | Uint8Array | undefined;
@@ -491,11 +490,12 @@ declare class AlgorandClientTransactionSender {
     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;
@@ -569,7 +569,7 @@ declare class AlgorandClientTransactionSender {
     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;
@@ -623,7 +623,7 @@ declare class AlgorandClientTransactionSender {
     appReferences?: bigint[] | undefined;
     assetReferences?: bigint[] | undefined;
     boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
-    accessReferences?: AccessReference[] | undefined;
+    accessReferences?: ResourceReference[] | undefined;
     rejectVersion?: number | undefined;
   } & {
     onComplete?: OnApplicationComplete.DeleteApplication | undefined;
@@ -677,7 +677,7 @@ declare class AlgorandClientTransactionSender {
     appReferences?: bigint[] | undefined;
     assetReferences?: bigint[] | undefined;
     boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
-    accessReferences?: AccessReference[] | undefined;
+    accessReferences?: ResourceReference[] | undefined;
     rejectVersion?: number | undefined;
   } & {
     onComplete?: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.ClearState | OnApplicationComplete.DeleteApplication | undefined;
@@ -746,8 +746,8 @@ declare class AlgorandClientTransactionSender {
    * @returns The result of the application ABI method create transaction and the transaction that was sent
    */
   appCreateMethodCall: (params: {
-    sender: SendingAddress;
     signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
+    sender: SendingAddress;
     rekeyTo?: ReadableAddress | undefined;
     note?: string | Uint8Array | undefined;
     lease?: string | Uint8Array | undefined;
@@ -757,15 +757,15 @@ declare class AlgorandClientTransactionSender {
     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;
@@ -775,7 +775,6 @@ declare class AlgorandClientTransactionSender {
     extraProgramPages?: number | undefined;
     method: ABIMethod;
     args?: (Transaction | ABIValue | TransactionWithSigner | AppMethodCall<{
-      args?: Uint8Array[] | undefined;
       sender: SendingAddress;
       signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
       rekeyTo?: ReadableAddress | undefined;
@@ -787,25 +786,20 @@ declare class AlgorandClientTransactionSender {
       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;
@@ -815,18 +809,24 @@ declare class AlgorandClientTransactionSender {
       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;
   } & SendParams) => Promise<SendAppCreateTransactionResult>;
   /**
    * Update a smart contract via an ABI method.
@@ -884,9 +884,8 @@ declare class AlgorandClientTransactionSender {
    * @returns The result of the application ABI method update transaction and the transaction that was sent
    */
   appUpdateMethodCall: (params: {
-    appId: bigint;
-    sender: SendingAddress;
     signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
+    sender: SendingAddress;
     rekeyTo?: ReadableAddress | undefined;
     note?: string | Uint8Array | undefined;
     lease?: string | Uint8Array | undefined;
@@ -896,18 +895,18 @@ declare class AlgorandClientTransactionSender {
     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;
@@ -919,25 +918,20 @@ declare class AlgorandClientTransactionSender {
       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;
@@ -947,18 +941,24 @@ declare class AlgorandClientTransactionSender {
       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;
   } & SendParams) => Promise<SendAppUpdateTransactionResult>;
   /**
    * Delete a smart contract via an ABI method.
@@ -1014,9 +1014,8 @@ declare class AlgorandClientTransactionSender {
    * @returns The result of the application ABI method delete transaction and the transaction that was sent
    */
   appDeleteMethodCall: (params: {
-    appId: bigint;
-    sender: SendingAddress;
     signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
+    sender: SendingAddress;
     rekeyTo?: ReadableAddress | undefined;
     note?: string | Uint8Array | undefined;
     lease?: string | Uint8Array | undefined;
@@ -1026,16 +1025,16 @@ declare class AlgorandClientTransactionSender {
     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;
@@ -1047,25 +1046,20 @@ declare class AlgorandClientTransactionSender {
       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;
@@ -1075,18 +1069,24 @@ declare class AlgorandClientTransactionSender {
       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;
   } & SendParams) => Promise<SendAppTransactionResult>;
   /**
    * Call a smart contract via an ABI method.
@@ -1142,9 +1142,8 @@ declare class AlgorandClientTransactionSender {
    * @returns The result of the application ABI method call transaction and the transaction that was sent
    */
   appCallMethodCall: (params: {
-    appId: bigint;
-    sender: SendingAddress;
     signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
+    sender: SendingAddress;
     rekeyTo?: ReadableAddress | undefined;
     note?: string | Uint8Array | undefined;
     lease?: string | Uint8Array | undefined;
@@ -1154,16 +1153,16 @@ declare class AlgorandClientTransactionSender {
     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;
@@ -1175,25 +1174,20 @@ declare class AlgorandClientTransactionSender {
       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;
@@ -1203,18 +1197,24 @@ declare class AlgorandClientTransactionSender {
       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;
   } & SendParams) => Promise<SendAppTransactionResult>;
   /**
    * Register an online key.