algosdk 2.9.0 → 3.0.0-beta.1

package/dist/types/types/transactions/base.d.ts

@@ -1,7 +1,7 @@
+import { Address } from '../../encoding/address.js';
+import { StateProof, StateProofMessage } from '../../stateproof.js';
 /**
  * Enum for application transaction types.
- *
- * The full list is available at https://developer.algorand.org/docs/reference/transactions/
  */
 export declare enum TransactionType {
     /**
@@ -33,6 +33,11 @@ export declare enum TransactionType {
      */
     stpf = "stpf"
 }
+/**
+ * Check if a string is a valid transaction type
+ * @param s - string to check
+ * @returns true if s is a valid transaction type
+ */
 export declare function isTransactionType(s: string): s is TransactionType;
 /**
  * Enums for application transactions on-transaction-complete behavior
@@ -72,7 +77,13 @@ export declare enum OnApplicationComplete {
     DeleteApplicationOC = 5
 }
 /**
- * A dict holding common-to-all-txns arguments
+ * Check if a value is a valid OnApplicationComplete value
+ * @param v - value to check
+ * @returns true if v is a valid OnApplicationComplete value
+ */
+export declare function isOnApplicationComplete(v: unknown): v is OnApplicationComplete;
+/**
+ * Contains parameters relevant to the creation of a new transaction in a specific network at a specific time
  */
 export interface SuggestedParams {
     /**
@@ -83,30 +94,28 @@ export interface SuggestedParams {
     /**
      * Integer fee per byte, in microAlgos. For a flat fee, set flatFee to true
      */
-    fee: number;
+    fee: number | bigint;
+    /**
+     * Minimum fee (not per byte) required for the transaction to be confirmed
+     */
+    minFee: number | bigint;
     /**
      * First protocol round on which this txn is valid
      */
-    firstRound: number;
+    firstValid: number | bigint;
     /**
      * Last protocol round on which this txn is valid
      */
-    lastRound: number;
+    lastValid: number | bigint;
     /**
      * Specifies genesis ID of network in use
      */
-    genesisID: string;
+    genesisID?: string;
     /**
      * Specifies hash genesis block of network in use
      */
-    genesisHash: string;
+    genesisHash?: Uint8Array;
 }
-export declare type SuggestedParamsWithMinFee = SuggestedParams & {
-    /**
-     * Minimum fee (not per byte) required for the transaction to be confirmed
-     */
-    minFee: number;
-};
 /**
  * A grouping of the app ID and name of the box in an Uint8Array
  */
@@ -114,180 +123,215 @@ export interface BoxReference {
     /**
      * A unique application index
      */
-    appIndex: number;
+    appIndex: number | bigint;
     /**
      * Name of box to reference
      */
     name: Uint8Array;
 }
 /**
- * A full list of all available transaction parameters
+ * Contains payment transaction parameters.
  *
  * The full documentation is available at:
- * https://developer.algorand.org/docs/reference/transactions/#common-fields-header-and-type
+ * https://developer.algorand.org/docs/get-details/transactions/transactions/#payment-transaction
  */
-export interface TransactionParams {
-    /**
-     * String representation of Algorand address of sender
-     */
-    from: string;
+export interface PaymentTransactionParams {
     /**
-     * String representation of Algorand address of recipient
+     * Algorand address of recipient
      */
-    to: string;
+    receiver: string | Address;
     /**
-     * Integer fee per byte, in microAlgos. For a flat fee, set flatFee to true
-     */
-    fee: number;
-    /**
-     * Integer amount to send
+     * Integer amount to send, in microAlgos. Must be nonnegative.
      */
     amount: number | bigint;
     /**
-     * Integer first protocol round on which this txn is valid
+     * Optional, indicates the sender will close their account and the remaining balance will transfer
+     * to this account
      */
-    firstRound: number;
+    closeRemainderTo?: string | Address;
+}
+/**
+ * Contains key registration transaction parameters
+ *
+ * The full documentation is available at:
+ * https://developer.algorand.org/docs/get-details/transactions/transactions/#key-registration-transaction
+ */
+export interface KeyRegistrationTransactionParams {
     /**
-     * Integer last protocol round on which this txn is valid
+     * 32-byte voting key. For key deregistration, leave undefined
      */
-    lastRound: number;
+    voteKey?: Uint8Array | string;
     /**
-     * Arbitrary data for sender to store
+     * 32-byte selection key. For key deregistration, leave undefined
      */
-    note?: Uint8Array;
+    selectionKey?: Uint8Array | string;
     /**
-     * Specifies genesis ID of network in use
+     * 64-byte state proof key. For key deregistration, leave undefined
      */
-    genesisID: string;
+    stateProofKey?: Uint8Array | string;
     /**
-     * Specifies hash genesis block of network in use
+     * First round on which voting keys are valid
      */
-    genesisHash: string;
+    voteFirst?: number | bigint;
     /**
-     * Lease a transaction. The sender cannot send another txn with that same lease until the last round of original txn has passed
+     * Last round on which voting keys are valid
      */
-    lease?: Uint8Array;
+    voteLast?: number | bigint;
     /**
-     * Close out remaining account balance to this account
+     * The dilution fo the 2-level participation key
      */
-    closeRemainderTo?: string;
+    voteKeyDilution?: number | bigint;
     /**
-     * Voting key bytes. For key deregistration, leave undefined
+     * Set this value to true to mark this account as nonparticipating.
+     *
+     * All new Algorand accounts are participating by default. This means they earn rewards.
      */
-    voteKey: Uint8Array | string;
+    nonParticipation?: boolean;
+}
+/**
+ * Contains asset configuration transaction parameters.
+ *
+ * The full documentation is available at:
+ * https://developer.algorand.org/docs/get-details/transactions/transactions/#asset-configuration-transaction
+ */
+export interface AssetConfigurationTransactionParams {
     /**
-     *Selection key bytes. For key deregistration, leave undefined
+     * Asset index uniquely specifying the asset
      */
-    selectionKey: Uint8Array | string;
+    assetIndex?: number | bigint;
     /**
-     * State proof key bytes. For key deregistration, leave undefined
+     * Total supply of the asset
      */
-    stateProofKey: Uint8Array | string;
+    total?: number | bigint;
     /**
-     * First round on which voteKey is valid
+     * Integer number of decimals for asset unit calcuation
      */
-    voteFirst: number;
+    decimals?: number | bigint;
     /**
-     * Last round on which voteKey is valid
+     * Whether asset accounts should default to being frozen
      */
-    voteLast: number;
+    defaultFrozen?: boolean;
     /**
-     * The dilution fo the 2-level participation key
+     * The Algorand address in charge of reserve, freeze, clawback, destruction, etc.
      */
-    voteKeyDilution: number;
+    manager?: string | Address;
     /**
-     * Asset index uniquely specifying the asset
+     * The Algorand address representing asset reserve
      */
-    assetIndex: number;
+    reserve?: string | Address;
     /**
-     * Total supply of the asset
+     * The Algorand address with power to freeze/unfreeze asset holdings
      */
-    assetTotal: number | bigint;
+    freeze?: string | Address;
     /**
-     * Integer number of decimals for asset unit calcuation
+     * The Algorand address with power to revoke asset holdings
      */
-    assetDecimals: number;
+    clawback?: string | Address;
     /**
-     * Whether asset accounts should default to being frozen
+     * Unit name for this asset
      */
-    assetDefaultFrozen: boolean;
+    unitName?: string;
     /**
-     * String representation of Algorand address in charge of reserve, freeze, clawback, destruction, etc.
+     * Name for this asset
      */
-    assetManager?: string;
+    assetName?: string;
     /**
-     * String representation of Algorand address representing asset reserve
+     * URL relating to this asset
      */
-    assetReserve?: string;
+    assetURL?: string;
     /**
-     * String representation of Algorand address with power to freeze/unfreeze asset holdings
+     * Uint8Array containing a hash commitment with respect to the asset. Must be exactly 32 bytes long.
      */
-    assetFreeze?: string;
+    assetMetadataHash?: Uint8Array;
+}
+/**
+ * Contains asset transfer transaction parameters.
+ *
+ * The full documentation is available at:
+ * https://developer.algorand.org/docs/get-details/transactions/transactions/#asset-transfer-transaction
+ */
+export interface AssetTransferTransactionParams {
     /**
-     * String representation of Algorand address with power to revoke asset holdings
+     * Asset index uniquely specifying the asset
      */
-    assetClawback?: string;
+    assetIndex: number | bigint;
     /**
-     * Unit name for this asset
+     * String representation of Algorand address – if provided, and if "sender" is
+     * the asset's revocation manager, then deduct from "assetSender" rather than "sender"
      */
-    assetUnitName?: string;
+    assetSender?: string | Address;
     /**
-     * Name for this asset
+     * The Algorand address of recipient
      */
-    assetName?: string;
+    receiver: string | Address;
     /**
-     * URL relating to this asset
+     * Integer amount to send
      */
-    assetURL?: string;
+    amount: number | bigint;
     /**
-     * Uint8Array or UTF-8 string representation of a hash commitment with respect to the asset. Must be exactly 32 bytes long.
+     * Close out remaining asset balance of the sender to this account
      */
-    assetMetadataHash?: Uint8Array | string;
+    closeRemainderTo?: string | Address;
+}
+/**
+ * Contains asset freeze transaction parameters.
+ *
+ * The full documentation is available at:
+ * https://developer.algorand.org/docs/get-details/transactions/transactions/#asset-freeze-transaction
+ */
+export interface AssetFreezeTransactionParams {
     /**
-     * String representation of Algorand address being frozen or unfrozen
+     * Asset index uniquely specifying the asset
      */
-    freezeAccount: string;
+    assetIndex: number | bigint;
     /**
-     * true if freezeTarget should be frozen, false if freezeTarget should be allowed to transact
+     * Algorand address being frozen or unfrozen
      */
-    freezeState: boolean;
+    freezeTarget: string | Address;
     /**
-     * String representation of Algorand address – if provided, and if "from" is
-     * the asset's revocation manager, then deduct from "revocationTarget" rather than "from"
+     * true if freezeTarget should be frozen, false if freezeTarget should be allowed to transact
      */
-    assetRevocationTarget?: string;
+    frozen: boolean;
+}
+/**
+ * Contains application call transaction parameters.
+ *
+ * The full documentation is available at:
+ * https://developer.algorand.org/docs/get-details/transactions/transactions/#application-call-transaction
+ */
+export interface ApplicationCallTransactionParams {
     /**
-     * A unique application index
+     * A unique application ID
      */
-    appIndex: number;
+    appIndex: number | bigint;
     /**
      * What application should do once the program has been run
      */
-    appOnComplete: OnApplicationComplete;
+    onComplete: OnApplicationComplete;
     /**
      * Restricts number of ints in per-user local state
      */
-    appLocalInts: number;
+    numLocalInts?: number | bigint;
     /**
      * Restricts number of byte slices in per-user local state
      */
-    appLocalByteSlices: number;
+    numLocalByteSlices?: number | bigint;
     /**
      * Restricts number of ints in global state
      */
-    appGlobalInts: number;
+    numGlobalInts?: number | bigint;
     /**
      * Restricts number of byte slices in global state
      */
-    appGlobalByteSlices: number;
+    numGlobalByteSlices?: number | bigint;
     /**
      * The compiled TEAL that approves a transaction
      */
-    appApprovalProgram: Uint8Array;
+    approvalProgram?: Uint8Array;
     /**
      * The compiled TEAL program that runs when clearing state
      */
-    appClearProgram: Uint8Array;
+    clearProgram?: Uint8Array;
     /**
      * Array of Uint8Array, any additional arguments to the application
      */
@@ -295,54 +339,98 @@ export interface TransactionParams {
     /**
      * Array of Address strings, any additional accounts to supply to the application
      */
-    appAccounts?: string[];
+    accounts?: Array<string | Address>;
     /**
      * Array of int, any other apps used by the application, identified by index
      */
-    appForeignApps?: number[];
+    foreignApps?: Array<number | bigint>;
     /**
      * Array of int, any assets used by the application, identified by index
      */
-    appForeignAssets?: number[];
+    foreignAssets?: Array<number | bigint>;
+    /**
+     * Int representing extra pages of memory to rent during an application create transaction.
+     */
+    extraPages?: number | bigint;
+    /**
+     * A grouping of the app ID and name of the box in an Uint8Array
+     */
+    boxes?: BoxReference[];
+}
+/**
+ * Contains state proof transaction parameters.
+ */
+export interface StateProofTransactionParams {
+    stateProofType?: number | bigint;
+    /**
+     * The state proof.
+     */
+    stateProof?: StateProof;
+    /**
+     * The state proof message.
+     */
+    message?: StateProofMessage;
+}
+/**
+ * A full list of all available transaction parameters
+ *
+ * The full documentation is available at:
+ * https://developer.algorand.org/docs/get-details/transactions/transactions/#common-fields-header-and-type
+ */
+export interface TransactionParams {
     /**
      * Transaction type
      */
-    type?: TransactionType;
+    type: TransactionType;
+    /**
+     * Algorand address of sender
+     */
+    sender: string | Address;
+    /**
+     * Optional, arbitrary data to be included in the transaction's note field
+     */
+    note?: Uint8Array;
     /**
-     * Set this to true to specify fee as microalgos-per-txn.
+     * Optional, 32-byte lease to associate with this transaction.
      *
-     * If the final calculated fee is lower than the protocol minimum fee, the fee will be increased to match the minimum
+     * The sender cannot send another transaction with the same lease until the last round of original
+     * transaction has passed.
      */
-    flatFee?: boolean;
+    lease?: Uint8Array;
+    /**
+     * The Algorand address that will be used to authorize all future transactions from the sender, if provided.
+     */
+    rekeyTo?: string | Address;
     /**
-     * A dict holding common-to-all-txns arguments
+     * Suggested parameters relevant to the network that will accept this transaction
      */
     suggestedParams: SuggestedParams;
     /**
-     * String representation of the Algorand address that will be used to authorize all future transactions
+     * Payment transaction parameters. Only set if type is TransactionType.pay
      */
-    reKeyTo?: string;
+    paymentParams?: PaymentTransactionParams;
     /**
-     * Set this value to true to mark this account as nonparticipating.
-     *
-     * All new Algorand accounts are participating by default. This means they earn rewards.
+     * Key registration transaction parameters. Only set if type is TransactionType.keyreg
      */
-    nonParticipation?: boolean;
+    keyregParams?: KeyRegistrationTransactionParams;
     /**
-     * Int representing extra pages of memory to rent during an application create transaction.
+     * Asset configuration transaction parameters. Only set if type is TransactionType.acfg
      */
-    extraPages?: number;
+    assetConfigParams?: AssetConfigurationTransactionParams;
     /**
-     * A grouping of the app ID and name of the box in an Uint8Array
+     * Asset transfer transaction parameters. Only set if type is TransactionType.axfer
      */
-    boxes?: BoxReference[];
-    stateProofType?: number | bigint;
+    assetTransferParams?: AssetTransferTransactionParams;
+    /**
+     * Asset freeze transaction parameters. Only set if type is TransactionType.afrz
+     */
+    assetFreezeParams?: AssetFreezeTransactionParams;
     /**
-     * Byte array containing the state proof.
+     * Application call transaction parameters. Only set if type is TransactionType.appl
      */
-    stateProof?: Uint8Array;
+    appCallParams?: ApplicationCallTransactionParams;
     /**
-     * Byte array containing the state proof message.
+     * State proof transaction parameters. Only set if type is TransactionType.stpf
      */
-    stateProofMessage?: Uint8Array;
+    stateProofParams?: StateProofTransactionParams;
 }