@algorandfoundation/algokit-utils 10.0.0-alpha.8 → 10.0.0-beta.1

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

@@ -0,0 +1,891 @@
+import { ReadableAddress } from "./packages/common/src/address.js";
+import { Expand } from "./packages/common/src/expand.js";
+import { ABIValue } from "./packages/abi/src/abi-value.js";
+import { ABIMethod } from "./packages/abi/src/abi-method.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";
+import { TransactionWithSigner } from "./transaction/transaction.js";
+import { BoxIdentifier, BoxReference } from "./app-manager.js";
+import { AppCallParams, AppCreateParams, AppDeleteParams, AppMethodCallParams, AppUpdateParams } from "./transactions/app-call.js";
+import { AssetOptInParams, AssetOptOutParams, AssetTransferParams } from "./transactions/asset-transfer.js";
+import { AssetConfigParams, AssetCreateParams, AssetDestroyParams, AssetFreezeParams } from "./transactions/asset-config.js";
+import { OfflineKeyRegistrationParams, OnlineKeyRegistrationParams } from "./transactions/key-registration.js";
+import { AppMethodCall } from "./transactions/method-call.js";
+import { PaymentParams } from "./transactions/payment.js";
+import { BuiltTransactions, TransactionComposer, TransactionComposerConfig } from "./composer.js";
+
+//#region src/algorand-client-transaction-creator.d.ts
+/** Orchestrates creating transactions for `AlgorandClient`. */
+declare class AlgorandClientTransactionCreator {
+  private _newGroup;
+  /**
+   * Creates a new `AlgorandClientTransactionCreator`
+   * @param newGroup A lambda that starts a new `TransactionComposer` transaction group
+   * @example
+   * ```typescript
+   * const transactionCreator = new AlgorandClientTransactionCreator(() => new TransactionComposer())
+   * ```
+   */
+  constructor(newGroup: (config?: TransactionComposerConfig) => TransactionComposer);
+  private _transaction;
+  private _transactions;
+  /**
+   * Create a payment transaction to transfer Algo between accounts.
+   * @param params The parameters for the payment transaction
+   * @example Basic example
+   * ```typescript
+   * await algorand.createTransaction.payment({
+   *   sender: 'SENDERADDRESS',
+   *   receiver: 'RECEIVERADDRESS',
+   *   amount: (4).algo(),
+   * })
+   * ```
+   * @example Advanced example
+   * ```typescript
+   * await algorand.createTransaction.payment({
+   *   amount: (4).algo(),
+   *   receiver: 'RECEIVERADDRESS',
+   *   sender: 'SENDERADDRESS',
+   *   closeRemainderTo: 'CLOSEREMAINDERTOADDRESS',
+   *   lease: 'lease',
+   *   note: 'note',
+   *   // Use this with caution, it's generally better to use algorand.account.rekeyAccount
+   *   rekeyTo: 'REKEYTOADDRESS',
+   *   // You wouldn't normally set this field
+   *   firstValidRound: 1000n,
+   *   validityWindow: 10,
+   *   extraFee: (1000).microAlgo(),
+   *   staticFee: (1000).microAlgo(),
+   *   // Max fee doesn't make sense with extraFee AND staticFee
+   *   //  already specified, but here for completeness
+   *   maxFee: (3000).microAlgo(),
+   * })
+   * ```
+   * @returns The payment transaction
+   */
+  payment: (params: PaymentParams) => Promise<Transaction>;
+  /** Create a create Algorand Standard Asset transaction.
+   *
+   * The account that sends this transaction will automatically be
+   * opted in to the asset and will hold all units after creation.
+   *
+   * @param params The parameters for the asset creation transaction
+   *
+   * @example Basic example
+   * ```typescript
+   * await algorand.createTransaction.assetCreate({ sender: "CREATORADDRESS", total: 100n})
+   * ```
+   * @example Advanced example
+   * ```typescript
+   * await algorand.createTransaction.assetCreate({
+   *   sender: 'CREATORADDRESS',
+   *   total: 100n,
+   *   decimals: 2,
+   *   assetName: 'asset',
+   *   unitName: 'unit',
+   *   url: 'url',
+   *   metadataHash: 'metadataHash',
+   *   defaultFrozen: false,
+   *   manager: 'MANAGERADDRESS',
+   *   reserve: 'RESERVEADDRESS',
+   *   freeze: 'FREEZEADDRESS',
+   *   clawback: 'CLAWBACKADDRESS',
+   *   lease: 'lease',
+   *   note: 'note',
+   *   // You wouldn't normally set this field
+   *   firstValidRound: 1000n,
+   *   validityWindow: 10,
+   *   extraFee: (1000).microAlgo(),
+   *   staticFee: (1000).microAlgo(),
+   *   // Max fee doesn't make sense with extraFee AND staticFee
+   *   //  already specified, but here for completeness
+   *   maxFee: (3000).microAlgo(),
+   * })
+   * ```
+   * @returns The asset create transaction
+   */
+  assetCreate: (params: AssetCreateParams) => Promise<Transaction>;
+  /** Create an asset config transaction to reconfigure an existing Algorand Standard Asset.
+   *
+   * **Note:** The manager, reserve, freeze, and clawback addresses
+   * are immutably empty if they are not set. If manager is not set then
+   * all fields are immutable from that point forward.
+   *
+   * @param params The parameters for the asset config transaction
+   *
+   * @example Basic example
+   * ```typescript
+   * await algorand.createTransaction.assetConfig({ sender: "MANAGERADDRESS", assetId: 123456n, manager: "MANAGERADDRESS" })
+   * ```
+   * @example Advanced example
+   * ```typescript
+   * await algorand.createTransaction.assetConfig({
+   *   sender: 'MANAGERADDRESS',
+   *   assetId: 123456n,
+   *   manager: 'MANAGERADDRESS',
+   *   reserve: 'RESERVEADDRESS',
+   *   freeze: 'FREEZEADDRESS',
+   *   clawback: 'CLAWBACKADDRESS',
+   *   lease: 'lease',
+   *   note: 'note',
+   *   // You wouldn't normally set this field
+   *   firstValidRound: 1000n,
+   *   validityWindow: 10,
+   *   extraFee: (1000).microAlgo(),
+   *   staticFee: (1000).microAlgo(),
+   *   // Max fee doesn't make sense with extraFee AND staticFee
+   *   //  already specified, but here for completeness
+   *   maxFee: (3000).microAlgo(),
+   * })
+   * ```
+   * @returns The asset config transaction
+   */
+  assetConfig: (params: AssetConfigParams) => Promise<Transaction>;
+  /** Create an Algorand Standard Asset freeze transaction.
+   *
+   * @param params The parameters for the asset freeze transaction
+   *
+   * @example Basic example
+   * ```typescript
+   * await algorand.createTransaction.assetFreeze({ sender: "MANAGERADDRESS", assetId: 123456n, account: "ACCOUNTADDRESS", frozen: true })
+   * ```
+   * @example Advanced example
+   * ```typescript
+   * await algorand.createTransaction.assetFreeze({
+   *   sender: 'MANAGERADDRESS',
+   *   assetId: 123456n,
+   *   account: 'ACCOUNTADDRESS',
+   *   frozen: true,
+   *   lease: 'lease',
+   *   note: 'note',
+   *   // You wouldn't normally set this field
+   *   firstValidRound: 1000n,
+   *   validityWindow: 10,
+   *   extraFee: (1000).microAlgo(),
+   *   staticFee: (1000).microAlgo(),
+   *   // Max fee doesn't make sense with extraFee AND staticFee
+   *   //  already specified, but here for completeness
+   *   maxFee: (3000).microAlgo(),
+   * })
+   * ```
+   * @returns The asset freeze transaction
+   */
+  assetFreeze: (params: AssetFreezeParams) => Promise<Transaction>;
+  /** Create an Algorand Standard Asset destroy transaction.
+   *
+   * Created assets can be destroyed only by the asset manager account.
+   * All of the assets must be owned by the creator of the asset before
+   * the asset can be deleted.
+   *
+   * @param params The parameters for the asset destroy transaction
+   *
+   * @example Basic example
+   * ```typescript
+   * await algorand.createTransaction.assetDestroy({ sender: "MANAGERADDRESS", assetId: 123456n })
+   * ```
+   * @example Advanced example
+   * ```typescript
+   * await algorand.createTransaction.assetDestroy({
+   *   sender: 'MANAGERADDRESS',
+   *   assetId: 123456n,
+   *   lease: 'lease',
+   *   note: 'note',
+   *   // You wouldn't normally set this field
+   *   firstValidRound: 1000n,
+   *   validityWindow: 10,
+   *   extraFee: (1000).microAlgo(),
+   *   staticFee: (1000).microAlgo(),
+   *   // Max fee doesn't make sense with extraFee AND staticFee
+   *   //  already specified, but here for completeness
+   *   maxFee: (3000).microAlgo(),
+   * })
+   * ```
+   * @returns The asset destroy transaction
+   */
+  assetDestroy: (params: AssetDestroyParams) => Promise<Transaction>;
+  /** Create an Algorand Standard Asset transfer transaction.
+   *
+   * @param params The parameters for the asset transfer transaction
+   *
+   * @example Basic example
+   * ```typescript
+   * await algorand.createTransaction.assetTransfer({ sender: "HOLDERADDRESS", assetId: 123456n, amount: 1n, receiver: "RECEIVERADDRESS" })
+   * ```
+   * @example Advanced example (with clawback)
+   * ```typescript
+   * await algorand.createTransaction.assetTransfer({
+   *   sender: 'CLAWBACKADDRESS',
+   *   assetId: 123456n,
+   *   amount: 1n,
+   *   receiver: 'RECEIVERADDRESS',
+   *   clawbackTarget: 'HOLDERADDRESS',
+   *   // This field needs to be used with caution
+   *   closeAssetTo: 'ADDRESSTOCLOSETO'
+   *   lease: 'lease',
+   *   note: 'note',
+   *   // You wouldn't normally set this field
+   *   firstValidRound: 1000n,
+   *   validityWindow: 10,
+   *   extraFee: (1000).microAlgo(),
+   *   staticFee: (1000).microAlgo(),
+   *   // Max fee doesn't make sense with extraFee AND staticFee
+   *   //  already specified, but here for completeness
+   *   maxFee: (3000).microAlgo(),
+   * })
+   * ```
+   * @returns The result of the asset transfer transaction
+   */
+  assetTransfer: (params: AssetTransferParams) => Promise<Transaction>;
+  /** Create an Algorand Standard Asset opt-in transaction.
+   *
+   * @param params The parameters for the asset opt-in transaction
+   *
+   * @example Basic example
+   * ```typescript
+   * await algorand.createTransaction.assetOptIn({ sender: "SENDERADDRESS", assetId: 123456n })
+   * ```
+   * @example Advanced example
+   * ```typescript
+   * await algorand.createTransaction.assetOptIn({
+   *   sender: 'SENDERADDRESS',
+   *   assetId: 123456n,
+   *   lease: 'lease',
+   *   note: 'note',
+   *   // You wouldn't normally set this field
+   *   firstValidRound: 1000n,
+   *   validityWindow: 10,
+   *   extraFee: (1000).microAlgo(),
+   *   staticFee: (1000).microAlgo(),
+   *   // Max fee doesn't make sense with extraFee AND staticFee
+   *   //  already specified, but here for completeness
+   *   maxFee: (3000).microAlgo(),
+   * })
+   * ```
+   * @returns The asset opt-in transaction
+   */
+  assetOptIn: (params: AssetOptInParams) => Promise<Transaction>;
+  /** Create an asset opt-out transaction.
+   *
+   * *Note:* If the account has a balance of the asset,
+   * it will lose those assets
+   *
+   * @param params The parameters for the asset opt-out transaction
+   *
+   * @example Basic example (without creator, will be retrieved from algod)
+   * ```typescript
+   * await algorand.createTransaction.assetOptOut({ sender: "SENDERADDRESS", assetId: 123456n, ensureZeroBalance: true })
+   * ```
+   * @example Basic example (with creator)
+   * ```typescript
+   * await algorand.createTransaction.assetOptOut({ sender: "SENDERADDRESS", creator: "CREATORADDRESS", assetId: 123456n, ensureZeroBalance: true })
+   * ```
+   * @example Advanced example
+   * ```typescript
+   * await algorand.createTransaction.assetOptOut({
+   *   sender: 'SENDERADDRESS',
+   *   assetId: 123456n,
+   *   creator: 'CREATORADDRESS',
+   *   ensureZeroBalance: true,
+   *   lease: 'lease',
+   *   note: 'note',
+   *   // You wouldn't normally set this field
+   *   firstValidRound: 1000n,
+   *   validityWindow: 10,
+   *   extraFee: (1000).microAlgo(),
+   *   staticFee: (1000).microAlgo(),
+   *   // Max fee doesn't make sense with extraFee AND staticFee
+   *   //  already specified, but here for completeness
+   *   maxFee: (3000).microAlgo(),
+   * })
+   * ```
+   * @returns The asset opt-out transaction
+   */
+  assetOptOut: (params: AssetOptOutParams) => Promise<Transaction>;
+  /** Create an application create transaction.
+   *
+   * Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality.
+   *
+   * @param params The parameters for the app creation transaction
+   * @example Basic example
+   * ```typescript
+   * await algorand.createTransaction.appCreate({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE' })
+   * ```
+   * @example Advanced example
+   * ```typescript
+   * await algorand.createTransaction.appCreate({
+   *  sender: 'CREATORADDRESS',
+   *  approvalProgram: "TEALCODE",
+   *  clearStateProgram: "TEALCODE",
+   *  schema: {
+   *    globalInts: 1,
+   *    globalByteSlices: 2,
+   *    localInts: 3,
+   *    localByteSlices: 4
+   *  },
+   *  extraProgramPages: 1,
+   *  onComplete: OnApplicationComplete.OptIn,
+   *  args: [new Uint8Array(1, 2, 3, 4)]
+   *  accountReferences: ["ACCOUNT_1"]
+   *  appReferences: [123n, 1234n]
+   *  assetReferences: [12345n]
+   *  boxReferences: ["box1", {appId: 1234n, name: "box2"}]
+   *  accessReferences: [{ appId: 1234n }]
+   *  lease: 'lease',
+   *  note: 'note',
+   *  // You wouldn't normally set this field
+   *  firstValidRound: 1000n,
+   *  validityWindow: 10,
+   *  extraFee: (1000).microAlgo(),
+   *  staticFee: (1000).microAlgo(),
+   *  // Max fee doesn't make sense with extraFee AND staticFee
+   *  //  already specified, but here for completeness
+   *  maxFee: (3000).microAlgo(),
+   *  rejectVersion: 1,
+   *})
+   * ```
+   * @returns The application create transaction
+   */
+  appCreate: (params: {
+    signer?: (TransactionSigner | AddressWithTransactionSigner) | undefined;
+    sender: SendingAddress;
+    rekeyTo?: ReadableAddress | undefined;
+    note?: (Uint8Array | string) | undefined;
+    lease?: (Uint8Array | string) | undefined;
+    staticFee?: AlgoAmount | undefined;
+    extraFee?: AlgoAmount | undefined;
+    maxFee?: AlgoAmount | undefined;
+    validityWindow?: number | bigint | undefined;
+    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?: ResourceReference[] | undefined;
+    rejectVersion?: number | undefined;
+    appId?: 0 | undefined;
+    approvalProgram: string | Uint8Array;
+    clearStateProgram: string | Uint8Array;
+    schema?: {
+      globalInts: number;
+      globalByteSlices: number;
+      localInts: number;
+      localByteSlices: number;
+    } | undefined;
+    extraProgramPages?: number | undefined;
+  }) => Promise<Transaction>;
+  /** Create an application update transaction.
+   *
+   * Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality.
+   *
+   * @param params The parameters for the app update transaction
+   * @example Basic example
+   * ```typescript
+   * await algorand.createTransaction.appUpdate({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE' })
+   * ```
+   * @example Advanced example
+   * ```typescript
+   * await algorand.createTransaction.appUpdate({
+   *  sender: 'CREATORADDRESS',
+   *  approvalProgram: "TEALCODE",
+   *  clearStateProgram: "TEALCODE",
+   *  onComplete: OnApplicationComplete.UpdateApplication,
+   *  args: [new Uint8Array(1, 2, 3, 4)]
+   *  accountReferences: ["ACCOUNT_1"]
+   *  appReferences: [123n, 1234n]
+   *  assetReferences: [12345n]
+   *  boxReferences: ["box1", {appId: 1234n, name: "box2"}]
+   *  accessReferences: [{ appId: 1234n }]
+   *  lease: 'lease',
+   *  note: 'note',
+   *  // You wouldn't normally set this field
+   *  firstValidRound: 1000n,
+   *  validityWindow: 10,
+   *  extraFee: (1000).microAlgo(),
+   *  staticFee: (1000).microAlgo(),
+   *  // Max fee doesn't make sense with extraFee AND staticFee
+   *  //  already specified, but here for completeness
+   *  maxFee: (3000).microAlgo(),
+   *  rejectVersion: 1,
+   *})
+   * ```
+   * @returns The application update transaction
+   */
+  appUpdate: (params: {
+    sender: SendingAddress;
+    signer?: (TransactionSigner | AddressWithTransactionSigner) | undefined;
+    rekeyTo?: ReadableAddress | undefined;
+    note?: (Uint8Array | string) | undefined;
+    lease?: (Uint8Array | string) | undefined;
+    staticFee?: AlgoAmount | undefined;
+    extraFee?: AlgoAmount | undefined;
+    maxFee?: AlgoAmount | undefined;
+    validityWindow?: number | bigint | undefined;
+    firstValidRound?: bigint | undefined;
+    lastValidRound?: bigint | undefined;
+    appId: bigint;
+    onComplete?: OnApplicationComplete.UpdateApplication | undefined;
+    args?: Uint8Array[] | undefined;
+    accountReferences?: ReadableAddress[] | undefined;
+    appReferences?: bigint[] | undefined;
+    assetReferences?: bigint[] | undefined;
+    boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
+    accessReferences?: ResourceReference[] | undefined;
+    rejectVersion?: number | undefined;
+    approvalProgram: string | Uint8Array;
+    clearStateProgram: string | Uint8Array;
+  }) => Promise<Transaction>;
+  /** Create an application delete transaction.
+   *
+   * Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality.
+   *
+   * @param params The parameters for the app deletion transaction
+   * @example Basic example
+   * ```typescript
+   * await algorand.createTransaction.appDelete({ sender: 'CREATORADDRESS' })
+   * ```
+   * @example Advanced example
+   * ```typescript
+   * await algorand.createTransaction.appDelete({
+   *  sender: 'CREATORADDRESS',
+   *  onComplete: OnApplicationComplete.DeleteApplication,
+   *  args: [new Uint8Array(1, 2, 3, 4)]
+   *  accountReferences: ["ACCOUNT_1"]
+   *  appReferences: [123n, 1234n]
+   *  assetReferences: [12345n]
+   *  boxReferences: ["box1", {appId: 1234n, name: "box2"}]
+   *  accessReferences: [{ appId: 1234n }]
+   *  lease: 'lease',
+   *  note: 'note',
+   *  // You wouldn't normally set this field
+   *  firstValidRound: 1000n,
+   *  validityWindow: 10,
+   *  extraFee: (1000).microAlgo(),
+   *  staticFee: (1000).microAlgo(),
+   *  // Max fee doesn't make sense with extraFee AND staticFee
+   *  //  already specified, but here for completeness
+   *  maxFee: (3000).microAlgo(),
+   *  rejectVersion: 1,
+   *})
+   * ```
+   * @returns The application delete transaction
+   */
+  appDelete: (params: AppDeleteParams) => Promise<Transaction>;
+  /** Create an application call transaction.
+   *
+   * Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality.
+   *
+   * @param params The parameters for the app call transaction
+   * @example Basic example
+   * ```typescript
+   * await algorand.createTransaction.appCall({ sender: 'CREATORADDRESS' })
+   * ```
+   * @example Advanced example
+   * ```typescript
+   * await algorand.createTransaction.appCall({
+   *  sender: 'CREATORADDRESS',
+   *  onComplete: OnApplicationComplete.OptIn,
+   *  args: [new Uint8Array(1, 2, 3, 4)]
+   *  accountReferences: ["ACCOUNT_1"]
+   *  appReferences: [123n, 1234n]
+   *  assetReferences: [12345n]
+   *  boxReferences: ["box1", {appId: 1234n, name: "box2"}]
+   *  accessReferences: [{ appId: 1234n }]
+   *  lease: 'lease',
+   *  note: 'note',
+   *  // You wouldn't normally set this field
+   *  firstValidRound: 1000n,
+   *  validityWindow: 10,
+   *  extraFee: (1000).microAlgo(),
+   *  staticFee: (1000).microAlgo(),
+   *  // Max fee doesn't make sense with extraFee AND staticFee
+   *  //  already specified, but here for completeness
+   *  maxFee: (3000).microAlgo(),
+   *  rejectVersion: 1,
+   *})
+   * ```
+   * @returns The application call transaction
+   */
+  appCall: (params: AppCallParams) => Promise<Transaction>;
+  /** Create an application create call with ABI method call transaction.
+   *
+   * Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality.
+   *
+   * @param params The parameters for the app creation transaction
+   * @example Basic example
+   * ```typescript
+   * const method = new ABIMethod({
+   *   name: 'method',
+   *   args: [{ name: 'arg1', type: 'string' }],
+   *   returns: { type: 'string' },
+   * })
+   * await algorand.createTransaction.appCreateMethodCall({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE', method: method, args: ["arg1_value"] })
+   * ```
+   * @example Advanced example
+   * ```typescript
+   * const method = new ABIMethod({
+   *   name: 'method',
+   *   args: [{ name: 'arg1', type: 'string' }],
+   *   returns: { type: 'string' },
+   * })
+   * await algorand.createTransaction.appCreateMethodCall({
+   *  sender: 'CREATORADDRESS',
+   *  method: method,
+   *  args: ["arg1_value"],
+   *  approvalProgram: "TEALCODE",
+   *  clearStateProgram: "TEALCODE",
+   *  schema: {
+   *    globalInts: 1,
+   *    globalByteSlices: 2,
+   *    localInts: 3,
+   *    localByteSlices: 4
+   *  },
+   *  extraProgramPages: 1,
+   *  onComplete: OnApplicationComplete.OptIn,
+   *  args: [new Uint8Array(1, 2, 3, 4)]
+   *  accountReferences: ["ACCOUNT_1"]
+   *  appReferences: [123n, 1234n]
+   *  assetReferences: [12345n]
+   *  boxReferences: ["box1", {appId: 1234n, name: "box2"}]
+   *  accessReferences: [{ appId: 1234n }]
+   *  lease: 'lease',
+   *  note: 'note',
+   *  // You wouldn't normally set this field
+   *  firstValidRound: 1000n,
+   *  validityWindow: 10,
+   *  extraFee: (1000).microAlgo(),
+   *  staticFee: (1000).microAlgo(),
+   *  // Max fee doesn't make sense with extraFee AND staticFee
+   *  //  already specified, but here for completeness
+   *  maxFee: (3000).microAlgo(),
+   *  rejectVersion: 1,
+   *})
+   * ```
+   * @returns The application ABI method create transaction
+   */
+  appCreateMethodCall: (params: {
+    signer?: (TransactionSigner | AddressWithTransactionSigner) | undefined;
+    appId?: 0 | undefined;
+    sender: SendingAddress;
+    rekeyTo?: ReadableAddress | undefined;
+    note?: (Uint8Array | string) | undefined;
+    lease?: (Uint8Array | string) | undefined;
+    staticFee?: AlgoAmount | undefined;
+    extraFee?: AlgoAmount | undefined;
+    maxFee?: AlgoAmount | undefined;
+    validityWindow?: number | bigint | undefined;
+    firstValidRound?: bigint | undefined;
+    lastValidRound?: bigint | undefined;
+    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?: ResourceReference[] | undefined;
+    rejectVersion?: number | undefined;
+    approvalProgram: string | Uint8Array;
+    clearStateProgram: string | Uint8Array;
+    schema?: {
+      globalInts: number;
+      globalByteSlices: number;
+      localInts: number;
+      localByteSlices: number;
+    } | undefined;
+    extraProgramPages?: number | undefined;
+    method: ABIMethod;
+    args?: (ABIValue | TransactionWithSigner | Transaction | Promise<Transaction> | AppMethodCall<AppCreateParams> | AppMethodCall<AppUpdateParams> | AppMethodCall<AppMethodCallParams> | undefined)[] | undefined;
+  }) => Promise<Expand<BuiltTransactions>>;
+  /** Create an application update call with ABI method call transaction.
+   *
+   * Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality.
+   *
+   * @param params The parameters for the app update transaction
+   * @example Basic example
+   * ```typescript
+   * const method = new ABIMethod({
+   *   name: 'method',
+   *   args: [{ name: 'arg1', type: 'string' }],
+   *   returns: { type: 'string' },
+   * })
+   * await algorand.createTransaction.appUpdateMethodCall({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE', method: method, args: ["arg1_value"] })
+   * ```
+   * @example Advanced example
+   * ```typescript
+   * const method = new ABIMethod({
+   *   name: 'method',
+   *   args: [{ name: 'arg1', type: 'string' }],
+   *   returns: { type: 'string' },
+   * })
+   * await algorand.createTransaction.appUpdateMethodCall({
+   *  sender: 'CREATORADDRESS',
+   *  method: method,
+   *  args: ["arg1_value"],
+   *  approvalProgram: "TEALCODE",
+   *  clearStateProgram: "TEALCODE",
+   *  onComplete: OnApplicationComplete.UpdateApplication,
+   *  args: [new Uint8Array(1, 2, 3, 4)]
+   *  accountReferences: ["ACCOUNT_1"]
+   *  appReferences: [123n, 1234n]
+   *  assetReferences: [12345n]
+   *  boxReferences: ["box1", {appId: 1234n, name: "box2"}]
+   *  accessReferences: [{ appId: 1234n }]
+   *  lease: 'lease',
+   *  note: 'note',
+   *  // You wouldn't normally set this field
+   *  firstValidRound: 1000n,
+   *  validityWindow: 10,
+   *  extraFee: (1000).microAlgo(),
+   *  staticFee: (1000).microAlgo(),
+   *  // Max fee doesn't make sense with extraFee AND staticFee
+   *  //  already specified, but here for completeness
+   *  maxFee: (3000).microAlgo(),
+   *  rejectVersion: 1,
+   *})
+   * ```
+   * @returns The application ABI method update transaction
+   */
+  appUpdateMethodCall: (params: {
+    signer?: (TransactionSigner | AddressWithTransactionSigner) | undefined;
+    appId: bigint;
+    sender: SendingAddress;
+    rekeyTo?: ReadableAddress | undefined;
+    note?: (Uint8Array | string) | undefined;
+    lease?: (Uint8Array | string) | undefined;
+    staticFee?: AlgoAmount | undefined;
+    extraFee?: AlgoAmount | undefined;
+    maxFee?: AlgoAmount | undefined;
+    validityWindow?: number | bigint | undefined;
+    firstValidRound?: bigint | undefined;
+    lastValidRound?: bigint | undefined;
+    onComplete?: OnApplicationComplete.UpdateApplication | undefined;
+    accountReferences?: ReadableAddress[] | undefined;
+    appReferences?: bigint[] | undefined;
+    assetReferences?: bigint[] | undefined;
+    boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
+    accessReferences?: ResourceReference[] | undefined;
+    rejectVersion?: number | undefined;
+    approvalProgram: string | Uint8Array;
+    clearStateProgram: string | Uint8Array;
+    method: ABIMethod;
+    args?: (ABIValue | TransactionWithSigner | Transaction | Promise<Transaction> | AppMethodCall<AppCreateParams> | AppMethodCall<AppUpdateParams> | AppMethodCall<AppMethodCallParams> | undefined)[] | undefined;
+  }) => Promise<Expand<BuiltTransactions>>;
+  /** Create an application delete call with ABI method call transaction.
+   *
+   * Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality.
+   *
+   * @param params The parameters for the app deletion transaction
+   * @example Basic example
+   * ```typescript
+   * const method = new ABIMethod({
+   *   name: 'method',
+   *   args: [{ name: 'arg1', type: 'string' }],
+   *   returns: { type: 'string' },
+   * })
+   * await algorand.createTransaction.appDeleteMethodCall({ sender: 'CREATORADDRESS', method: method, args: ["arg1_value"] })
+   * ```
+   * @example Advanced example
+   * ```typescript
+   * const method = new ABIMethod({
+   *   name: 'method',
+   *   args: [{ name: 'arg1', type: 'string' }],
+   *   returns: { type: 'string' },
+   * })
+   * await algorand.createTransaction.appDeleteMethodCall({
+   *  sender: 'CREATORADDRESS',
+   *  method: method,
+   *  args: ["arg1_value"],
+   *  onComplete: OnApplicationComplete.DeleteApplication,
+   *  args: [new Uint8Array(1, 2, 3, 4)]
+   *  accountReferences: ["ACCOUNT_1"]
+   *  appReferences: [123n, 1234n]
+   *  assetReferences: [12345n]
+   *  boxReferences: ["box1", {appId: 1234n, name: "box2"}]
+   *  accessReferences: [{ appId: 1234n }]
+   *  lease: 'lease',
+   *  note: 'note',
+   *  // You wouldn't normally set this field
+   *  firstValidRound: 1000n,
+   *  validityWindow: 10,
+   *  extraFee: (1000).microAlgo(),
+   *  staticFee: (1000).microAlgo(),
+   *  // Max fee doesn't make sense with extraFee AND staticFee
+   *  //  already specified, but here for completeness
+   *  maxFee: (3000).microAlgo(),
+   *  rejectVersion: 1,
+   *})
+   * ```
+   * @returns The application ABI method delete transaction
+   */
+  appDeleteMethodCall: (params: {
+    signer?: (TransactionSigner | AddressWithTransactionSigner) | undefined;
+    appId: bigint;
+    sender: SendingAddress;
+    rekeyTo?: ReadableAddress | undefined;
+    note?: (Uint8Array | string) | undefined;
+    lease?: (Uint8Array | string) | undefined;
+    staticFee?: AlgoAmount | undefined;
+    extraFee?: AlgoAmount | undefined;
+    maxFee?: AlgoAmount | undefined;
+    validityWindow?: number | bigint | undefined;
+    firstValidRound?: bigint | undefined;
+    lastValidRound?: bigint | undefined;
+    onComplete?: OnApplicationComplete.DeleteApplication | undefined;
+    accountReferences?: ReadableAddress[] | undefined;
+    appReferences?: bigint[] | undefined;
+    assetReferences?: bigint[] | undefined;
+    boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
+    accessReferences?: ResourceReference[] | undefined;
+    rejectVersion?: number | undefined;
+    method: ABIMethod;
+    args?: (ABIValue | TransactionWithSigner | Transaction | Promise<Transaction> | AppMethodCall<AppCreateParams> | AppMethodCall<AppUpdateParams> | AppMethodCall<AppMethodCallParams> | undefined)[] | undefined;
+  }) => Promise<Expand<BuiltTransactions>>;
+  /** Create an application call with ABI method call transaction.
+   *
+   * Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality.
+   *
+   * @param params The parameters for the app call transaction
+   * @example Basic example
+   * ```typescript
+   * const method = new ABIMethod({
+   *   name: 'method',
+   *   args: [{ name: 'arg1', type: 'string' }],
+   *   returns: { type: 'string' },
+   * })
+   * await algorand.createTransaction.appCallMethodCall({ sender: 'CREATORADDRESS', method: method, args: ["arg1_value"] })
+   * ```
+   * @example Advanced example
+   * ```typescript
+   * const method = new ABIMethod({
+   *   name: 'method',
+   *   args: [{ name: 'arg1', type: 'string' }],
+   *   returns: { type: 'string' },
+   * })
+   * await algorand.createTransaction.appCallMethodCall({
+   *  sender: 'CREATORADDRESS',
+   *  method: method,
+   *  args: ["arg1_value"],
+   *  onComplete: OnApplicationComplete.OptIn,
+   *  args: [new Uint8Array(1, 2, 3, 4)]
+   *  accountReferences: ["ACCOUNT_1"]
+   *  appReferences: [123n, 1234n]
+   *  assetReferences: [12345n]
+   *  boxReferences: ["box1", {appId: 1234n, name: "box2"}]
+   *  accessReferences: [{ appId: 1234n }]
+   *  lease: 'lease',
+   *  note: 'note',
+   *  // You wouldn't normally set this field
+   *  firstValidRound: 1000n,
+   *  validityWindow: 10,
+   *  extraFee: (1000).microAlgo(),
+   *  staticFee: (1000).microAlgo(),
+   *  // Max fee doesn't make sense with extraFee AND staticFee
+   *  //  already specified, but here for completeness
+   *  maxFee: (3000).microAlgo(),
+   *  rejectVersion: 1,
+   *})
+   * ```
+   * @returns The application ABI method call transaction
+   */
+  appCallMethodCall: (params: {
+    signer?: (TransactionSigner | AddressWithTransactionSigner) | undefined;
+    appId: bigint;
+    sender: SendingAddress;
+    rekeyTo?: ReadableAddress | undefined;
+    note?: (Uint8Array | string) | undefined;
+    lease?: (Uint8Array | string) | undefined;
+    staticFee?: AlgoAmount | undefined;
+    extraFee?: AlgoAmount | undefined;
+    maxFee?: AlgoAmount | undefined;
+    validityWindow?: number | bigint | undefined;
+    firstValidRound?: bigint | undefined;
+    lastValidRound?: bigint | undefined;
+    onComplete?: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.DeleteApplication | undefined;
+    accountReferences?: ReadableAddress[] | undefined;
+    appReferences?: bigint[] | undefined;
+    assetReferences?: bigint[] | undefined;
+    boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
+    accessReferences?: ResourceReference[] | undefined;
+    rejectVersion?: number | undefined;
+    method: ABIMethod;
+    args?: (ABIValue | TransactionWithSigner | Transaction | Promise<Transaction> | AppMethodCall<AppCreateParams> | AppMethodCall<AppUpdateParams> | AppMethodCall<AppMethodCallParams> | undefined)[] | undefined;
+  }) => Promise<Expand<BuiltTransactions>>;
+  /**
+   * Create an online key registration transaction.
+   * @param params The parameters for the key registration transaction
+   * @example Basic example
+   * ```typescript
+   * await algorand.createTransaction.onlineKeyRegistration({
+   *   sender: 'SENDERADDRESS',
+   *   voteKey: Uint8Array.from(Buffer.from("voteKeyBase64", 'base64')),
+   *   selectionKey: Uint8Array.from(Buffer.from("selectionKeyBase64", 'base64')),
+   *   stateProofKey: Uint8Array.from(Buffer.from("stateProofKeyBase64", 'base64')),
+   *   voteFirst: 1n,
+   *   voteLast: 1000n,
+   *   voteKeyDilution: 1n,
+   * })
+   * ```
+   * @example Advanced example
+   * ```typescript
+   * await algorand.createTransaction.onlineKeyRegistration({
+   *   sender: 'SENDERADDRESS',
+   *   voteKey: Uint8Array.from(Buffer.from("voteKeyBase64", 'base64')),
+   *   selectionKey: Uint8Array.from(Buffer.from("selectionKeyBase64", 'base64')),
+   *   stateProofKey: Uint8Array.from(Buffer.from("stateProofKeyBase64", 'base64')),
+   *   voteFirst: 1n,
+   *   voteLast: 1000n,
+   *   voteKeyDilution: 1n,
+   *   lease: 'lease',
+   *   note: 'note',
+   *   // Use this with caution, it's generally better to use algorand.account.rekeyAccount
+   *   rekeyTo: 'REKEYTOADDRESS',
+   *   // You wouldn't normally set this field
+   *   firstValidRound: 1000n,
+   *   validityWindow: 10,
+   *   extraFee: (1000).microAlgo(),
+   *   staticFee: (1000).microAlgo(),
+   *   // Max fee doesn't make sense with extraFee AND staticFee
+   *   //  already specified, but here for completeness
+   *   maxFee: (3000).microAlgo(),
+   * })
+   * ```
+   * @returns The online key registration transaction
+   */
+  onlineKeyRegistration: (params: OnlineKeyRegistrationParams) => Promise<Transaction>;
+  /**
+   * Create an offline key registration transaction.
+   * @param params The parameters for the key registration transaction
+   * @example Basic example
+   * ```typescript
+   * await algorand.createTransaction.offlineKeyRegistration({
+   *   sender: 'SENDERADDRESS',
+   * })
+   * ```
+   * @example Advanced example
+   * ```typescript
+   * await algorand.createTransaction.offlineKeyRegistration({
+   *   sender: 'SENDERADDRESS',
+   *   lease: 'lease',
+   *   note: 'note',
+   *   // Use this with caution, it's generally better to use algorand.account.rekeyAccount
+   *   rekeyTo: 'REKEYTOADDRESS',
+   *   // You wouldn't normally set this field
+   *   firstValidRound: 1000n,
+   *   validityWindow: 10,
+   *   extraFee: (1000).microAlgo(),
+   *   staticFee: (1000).microAlgo(),
+   *   // Max fee doesn't make sense with extraFee AND staticFee
+   *   //  already specified, but here for completeness
+   *   maxFee: (3000).microAlgo(),
+   * })
+   * ```
+   * @returns The offline key registration transaction
+   */
+  offlineKeyRegistration: (params: OfflineKeyRegistrationParams) => Promise<Transaction>;
+}
+//#endregion
+export { AlgorandClientTransactionCreator };
+//# sourceMappingURL=algorand-client-transaction-creator.d.ts.map