algosdk 2.8.0 → 3.0.0-beta.1

package/dist/types/makeTxn.d.ts

@@ -1,424 +1,165 @@
-import * as txnBuilder from './transaction';
-import { PaymentTxn, KeyRegistrationTxn, MustHaveSuggestedParams, AssetCreateTxn, AssetConfigTxn, AssetDestroyTxn, AssetFreezeTxn, AssetTransferTxn, AppCreateTxn, AppUpdateTxn, AppDeleteTxn, AppOptInTxn, AppCloseOutTxn, AppClearStateTxn, AppNoOpTxn } from './types/transactions';
-import { RenameProperties, RenameProperty, Expand } from './types/utils';
+import { Transaction } from './transaction.js';
+import { SuggestedParams, PaymentTransactionParams, KeyRegistrationTransactionParams, AssetConfigurationTransactionParams, AssetTransferTransactionParams, AssetFreezeTransactionParams, ApplicationCallTransactionParams } from './types/transactions/base.js';
+import { Address } from './encoding/address.js';
+/** Contains parameters common to every transaction type */
+export interface CommonTransactionParams {
+    /** Algorand address of sender */
+    sender: string | Address;
+    /** Suggested parameters relevant to the network that will accept this transaction */
+    suggestedParams: SuggestedParams;
+    /** Optional, arbitrary data to be stored in the transaction's note field */
+    note?: Uint8Array;
+    /**
+     * Optional, 32-byte lease to associate with this transaction.
+     *
+     * The sender cannot send another transaction with the same lease until the last round of original
+     * transaction has passed.
+     */
+    lease?: Uint8Array;
+    /** The Algorand address that will be used to authorize all future transactions from the sender, if provided. */
+    rekeyTo?: string | Address;
+}
 /**
- * makePaymentTxnWithSuggestedParams takes payment arguments and returns a Transaction object
- * @param from - string representation of Algorand address of sender
- * @param to - string representation of Algorand address of recipient
- * @param amount - integer amount to send, in microAlgos
- * @param closeRemainderTo - optionally close out remaining account balance to this account, represented as string rep of Algorand address
- * @param note - uint8array of arbitrary data for sender to store
- * @param suggestedParams - a dict holding common-to-all-txns args:
- * fee - integer fee per byte, in microAlgos. for a flat fee, set flatFee to true
- * flatFee - bool optionally set this to true to specify fee as microalgos-per-txn
- *       If true, txn fee may fall below the ALGORAND_MIN_TX_FEE
- * firstRound - integer first protocol round on which this txn is valid
- * lastRound - integer last protocol round on which this txn is valid
- * genesisHash - string specifies hash genesis block of network in use
- * genesisID - string specifies genesis ID of network in use
- * @param rekeyTo - rekeyTo address, optional
+ * Create a new payment transaction
+ *
+ * @param options - Payment transaction parameters
+ */
+export declare function makePaymentTxnWithSuggestedParamsFromObject({ sender, receiver, amount, closeRemainderTo, suggestedParams, note, lease, rekeyTo, }: PaymentTransactionParams & CommonTransactionParams): Transaction;
+/**
+ * Create a new key registration transaction
+ *
+ * @param options - Key registration transaction parameters
  */
-export declare function makePaymentTxnWithSuggestedParams(from: PaymentTxn['from'], to: PaymentTxn['to'], amount: PaymentTxn['amount'], closeRemainderTo: PaymentTxn['closeRemainderTo'], note: PaymentTxn['note'], suggestedParams: MustHaveSuggestedParams<PaymentTxn>['suggestedParams'], rekeyTo?: PaymentTxn['reKeyTo']): txnBuilder.Transaction;
-export declare function makePaymentTxnWithSuggestedParamsFromObject(o: Expand<Pick<RenameProperty<MustHaveSuggestedParams<PaymentTxn>, 'reKeyTo', 'rekeyTo'>, 'from' | 'to' | 'amount' | 'closeRemainderTo' | 'note' | 'suggestedParams' | 'rekeyTo'>>): txnBuilder.Transaction;
+export declare function makeKeyRegistrationTxnWithSuggestedParamsFromObject({ sender, voteKey, selectionKey, stateProofKey, voteFirst, voteLast, voteKeyDilution, nonParticipation, suggestedParams, note, lease, rekeyTo, }: KeyRegistrationTransactionParams & CommonTransactionParams): Transaction;
 /**
- * makeKeyRegistrationTxnWithSuggestedParams takes key registration arguments and returns a Transaction object for
- * that key registration operation
+ * Base function for creating any type of asset config transaction.
  *
- * @param from - string representation of Algorand address of sender
- * @param note - uint8array of arbitrary data for sender to store
- * @param voteKey - voting key. for key deregistration, leave undefined
- * @param selectionKey - selection key. for key deregistration, leave undefined
- * @param voteFirst - first round on which voteKey is valid
- * @param voteLast - last round on which voteKey is valid
- * @param voteKeyDilution - integer
- * @param suggestedParams - a dict holding common-to-all-txns args:
- * fee - integer fee per byte, in microAlgos. for a flat fee, set flatFee to true
- * flatFee - bool optionally set this to true to specify fee as microalgos-per-txn
- *       If true, txn fee may fall below the ALGORAND_MIN_TX_FEE
- * firstRound - integer first protocol round on which this txn is valid
- * lastRound - integer last protocol round on which this txn is valid
- * genesisHash - string specifies hash genesis block of network in use
- * genesisID - string specifies genesis ID of network in use
- * @param rekeyTo - rekeyTo address, optional
- * @param nonParticipation - configure whether the address wants to stop participating. If true,
- *   voteKey, selectionKey, voteFirst, voteLast, and voteKeyDilution must be undefined.
- * @param stateProofKey - state proof key. for key deregistration, leave undefined
+ * @param options - Asset config transaction parameters
  */
-export declare function makeKeyRegistrationTxnWithSuggestedParams(from: KeyRegistrationTxn['from'], note: KeyRegistrationTxn['note'], voteKey: KeyRegistrationTxn['voteKey'], selectionKey: KeyRegistrationTxn['selectionKey'], voteFirst: KeyRegistrationTxn['voteFirst'], voteLast: KeyRegistrationTxn['voteLast'], voteKeyDilution: KeyRegistrationTxn['voteKeyDilution'], suggestedParams: MustHaveSuggestedParams<KeyRegistrationTxn>['suggestedParams'], rekeyTo?: KeyRegistrationTxn['reKeyTo'], nonParticipation?: false, stateProofKey?: KeyRegistrationTxn['stateProofKey']): txnBuilder.Transaction;
-export declare function makeKeyRegistrationTxnWithSuggestedParams(from: KeyRegistrationTxn['from'], note: KeyRegistrationTxn['note'], voteKey: undefined, selectionKey: undefined, voteFirst: undefined, voteLast: undefined, voteKeyDilution: undefined, suggestedParams: MustHaveSuggestedParams<KeyRegistrationTxn>['suggestedParams'], rekeyTo?: KeyRegistrationTxn['reKeyTo'], nonParticipation?: boolean, stateProofKey?: undefined): txnBuilder.Transaction;
-export declare function makeKeyRegistrationTxnWithSuggestedParamsFromObject(o: Expand<Pick<RenameProperty<MustHaveSuggestedParams<KeyRegistrationTxn>, 'reKeyTo', 'rekeyTo'>, 'from' | 'note' | 'voteKey' | 'selectionKey' | 'stateProofKey' | 'voteFirst' | 'voteLast' | 'voteKeyDilution' | 'suggestedParams' | 'rekeyTo'> & {
-    nonParticipation?: false;
-}>): txnBuilder.Transaction;
-export declare function makeKeyRegistrationTxnWithSuggestedParamsFromObject(o: Expand<Pick<RenameProperty<MustHaveSuggestedParams<KeyRegistrationTxn>, 'reKeyTo', 'rekeyTo'>, 'from' | 'note' | 'suggestedParams' | 'rekeyTo' | 'nonParticipation'>>): txnBuilder.Transaction;
-/** makeAssetCreateTxnWithSuggestedParams takes asset creation arguments and returns a Transaction object
- * for creating that asset
+export declare function makeBaseAssetConfigTxn({ sender, assetIndex, total, decimals, defaultFrozen, manager, reserve, freeze, clawback, unitName, assetName, assetURL, assetMetadataHash, note, lease, rekeyTo, suggestedParams, }: AssetConfigurationTransactionParams & CommonTransactionParams): Transaction;
+/**
+ * Create a new asset creation transaction
  *
- * @param from - string representation of Algorand address of sender
- * @param note - uint8array of arbitrary data for sender to store
- * @param total - integer total supply of the asset
- * @param decimals - integer number of decimals for asset unit calculation
- * @param defaultFrozen - boolean whether asset accounts should default to being frozen
- * @param manager - string representation of Algorand address in charge of reserve, freeze, clawback, destruction, etc
- * @param reserve - string representation of Algorand address representing asset reserve
- * @param freeze - string representation of Algorand address with power to freeze/unfreeze asset holdings
- * @param clawback - string representation of Algorand address with power to revoke asset holdings
- * @param unitName - string units name for this asset
- * @param assetName - string name for this asset
- * @param assetURL - string URL relating to this asset
- * @param assetMetadataHash - Uint8Array or UTF-8 string representation of a hash commitment with respect to the asset. Must be exactly 32 bytes long.
- * @param suggestedParams - a dict holding common-to-all-txns args:
- * fee - integer fee per byte, in microAlgos. for a flat fee, set flatFee to true
- * flatFee - bool optionally set this to true to specify fee as microalgos-per-txn
- *       If true, txn fee may fall below the ALGORAND_MIN_TX_FEE
- * firstRound - integer first protocol round on which this txn is valid
- * lastRound - integer last protocol round on which this txn is valid
- * genesisHash - string specifies hash genesis block of network in use
- * genesisID - string specifies genesis ID of network in use
- * @param rekeyTo - rekeyTo address, optional
+ * @param options - Asset creation transaction parameters
  */
-export declare function makeAssetCreateTxnWithSuggestedParams(from: AssetCreateTxn['from'], note: AssetCreateTxn['note'], total: AssetCreateTxn['assetTotal'], decimals: AssetCreateTxn['assetDecimals'], defaultFrozen: AssetCreateTxn['assetDefaultFrozen'], manager: AssetCreateTxn['assetManager'], reserve: AssetCreateTxn['assetReserve'], freeze: AssetCreateTxn['assetFreeze'], clawback: AssetCreateTxn['assetClawback'], unitName: AssetCreateTxn['assetUnitName'], assetName: AssetCreateTxn['assetName'], assetURL: AssetCreateTxn['assetURL'], assetMetadataHash: AssetCreateTxn['assetMetadataHash'] | undefined, suggestedParams: MustHaveSuggestedParams<AssetCreateTxn>['suggestedParams'], rekeyTo?: AssetCreateTxn['reKeyTo']): txnBuilder.Transaction;
-export declare function makeAssetCreateTxnWithSuggestedParamsFromObject(o: Expand<Pick<RenameProperties<MustHaveSuggestedParams<AssetCreateTxn>, {
-    reKeyTo: 'rekeyTo';
-    assetTotal: 'total';
-    assetDecimals: 'decimals';
-    assetDefaultFrozen: 'defaultFrozen';
-    assetManager: 'manager';
-    assetReserve: 'reserve';
-    assetFreeze: 'freeze';
-    assetClawback: 'clawback';
-    assetUnitName: 'unitName';
-}>, 'from' | 'note' | 'total' | 'decimals' | 'defaultFrozen' | 'manager' | 'reserve' | 'freeze' | 'clawback' | 'unitName' | 'assetName' | 'assetURL' | 'assetMetadataHash' | 'suggestedParams' | 'rekeyTo'>>): txnBuilder.Transaction;
-/** makeAssetConfigTxnWithSuggestedParams can be issued by the asset manager to change the manager, reserve, freeze, or clawback
- * you must respecify existing addresses to keep them the same; leaving a field blank is the same as turning
- * that feature off for this asset
+export declare function makeAssetCreateTxnWithSuggestedParamsFromObject({ sender, total, decimals, defaultFrozen, manager, reserve, freeze, clawback, unitName, assetName, assetURL, assetMetadataHash, note, lease, rekeyTo, suggestedParams, }: Omit<AssetConfigurationTransactionParams, 'assetIndex'> & CommonTransactionParams): Transaction;
+/** Contains asset modification transaction parameters */
+export interface AssetModificationTransactionParams {
+    /**
+     * The unique ID of the asset to be modified
+     */
+    assetIndex: number | bigint;
+    /**
+     * The Algorand address in charge of reserve, freeze, clawback, destruction, etc.
+     *
+     * If empty, this role will be irrevocably removed from this asset.
+     */
+    manager?: string | Address;
+    /**
+     * The Algorand address representing asset reserve.
+     *
+     * If empty, this role will be irrevocably removed from this asset.
+     */
+    reserve?: string | Address;
+    /**
+     * The Algorand address with power to freeze/unfreeze asset holdings.
+     *
+     * If empty, this role will be irrevocably removed from this asset.
+     */
+    freeze?: string | Address;
+    /**
+     * The Algorand address with power to revoke asset holdings.
+     *
+     * If empty, this role will be irrevocably removed from this asset.
+     */
+    clawback?: string | Address;
+    /**
+     * This is a safety flag to prevent unintentionally removing a role from an asset. If undefined or
+     * true, an error will be thrown if any of assetManager, assetReserve, assetFreeze, or
+     * assetClawback are empty.
+     *
+     * Set this to false to allow removing roles by leaving the corresponding address empty.
+     */
+    strictEmptyAddressChecking?: boolean;
+}
+/**
+ * Create a new asset config transaction. This transaction can be issued by the asset manager to
+ * change the manager, reserve, freeze, or clawback address.
  *
- * @param from - string representation of Algorand address of sender
- * @param note - uint8array of arbitrary data for sender to store
- * @param assetIndex - int asset index uniquely specifying the asset
- * @param manager - string representation of new asset manager Algorand address
- * @param reserve - string representation of new reserve Algorand address
- * @param freeze - string representation of new freeze manager Algorand address
- * @param clawback - string representation of new revocation manager Algorand address
- * @param strictEmptyAddressChecking - boolean - throw an error if any of manager, reserve, freeze, or clawback are undefined. optional, defaults to true.
- * @param suggestedParams - a dict holding common-to-all-txns args:
- * fee - integer fee per byte, in microAlgos. for a flat fee, set flatFee to true
- * flatFee - bool optionally set this to true to specify fee as microalgos-per-txn
- *       If true, txn fee may fall below the ALGORAND_MIN_TX_FEE
- * firstRound - integer first protocol round on which this txn is valid
- * lastRound - integer last protocol round on which this txn is valid
- * genesisHash - string specifies hash genesis block of network in use
- * genesisID - string specifies genesis ID of network in use
- * @param rekeyTo - rekeyTo address, optional
+ * You must respecify existing addresses to keep them the same; leaving a field blank is the same as
+ * turning that feature off for this asset.
+ *
+ * @param options - Asset modification transaction parameters
  */
-export declare function makeAssetConfigTxnWithSuggestedParams(from: AssetConfigTxn['from'], note: AssetConfigTxn['note'], assetIndex: AssetConfigTxn['assetIndex'], manager: AssetConfigTxn['assetManager'], reserve: AssetConfigTxn['assetReserve'], freeze: AssetConfigTxn['assetFreeze'], clawback: AssetConfigTxn['assetClawback'], suggestedParams: MustHaveSuggestedParams<AssetConfigTxn>['suggestedParams'], strictEmptyAddressChecking?: boolean, rekeyTo?: AssetConfigTxn['reKeyTo']): txnBuilder.Transaction;
-export declare function makeAssetConfigTxnWithSuggestedParamsFromObject(o: Expand<Pick<RenameProperties<MustHaveSuggestedParams<AssetConfigTxn>, {
-    reKeyTo: 'rekeyTo';
-    assetManager: 'manager';
-    assetReserve: 'reserve';
-    assetFreeze: 'freeze';
-    assetClawback: 'clawback';
-}>, 'from' | 'note' | 'assetIndex' | 'manager' | 'reserve' | 'freeze' | 'clawback' | 'suggestedParams' | 'rekeyTo'> & {
-    strictEmptyAddressChecking: boolean;
-}>): txnBuilder.Transaction;
-/** makeAssetDestroyTxnWithSuggestedParams will allow the asset's manager to remove this asset from the ledger, so long
- * as all outstanding assets are held by the creator.
+export declare function makeAssetConfigTxnWithSuggestedParamsFromObject({ sender, assetIndex, manager, reserve, freeze, clawback, strictEmptyAddressChecking, note, lease, rekeyTo, suggestedParams, }: AssetModificationTransactionParams & CommonTransactionParams): Transaction;
+/**
+ * Create a new asset destroy transaction. This will allow the asset's manager to remove this asset
+ * from the ledger, provided all outstanding assets are held by the creator.
  *
- * @param from - string representation of Algorand address of sender
- * @param note - uint8array of arbitrary data for sender to store
- * @param assetIndex - int asset index uniquely specifying the asset
- * @param suggestedParams - a dict holding common-to-all-txns args:
- * fee - integer fee per byte, in microAlgos. for a flat fee, set flatFee to true
- * flatFee - bool optionally set this to true to specify fee as microalgos-per-txn
- *       If true, txn fee may fall below the ALGORAND_MIN_TX_FEE
- * firstRound - integer first protocol round on which this txn is valid
- * lastRound - integer last protocol round on which this txn is valid
- * genesisHash - string specifies hash genesis block of network in use
- * genesisID - string specifies genesis ID of network in use
- * @param rekeyTo - rekeyTo address, optional
+ * @param options - Asset destroy transaction parameters
  */
-export declare function makeAssetDestroyTxnWithSuggestedParams(from: AssetDestroyTxn['from'], note: AssetDestroyTxn['note'], assetIndex: AssetDestroyTxn['assetIndex'], suggestedParams: MustHaveSuggestedParams<AssetDestroyTxn>['suggestedParams'], rekeyTo?: AssetDestroyTxn['reKeyTo']): txnBuilder.Transaction;
-export declare function makeAssetDestroyTxnWithSuggestedParamsFromObject(o: Expand<Pick<RenameProperty<MustHaveSuggestedParams<AssetDestroyTxn>, 'reKeyTo', 'rekeyTo'>, 'from' | 'note' | 'assetIndex' | 'suggestedParams' | 'rekeyTo'>>): txnBuilder.Transaction;
-/** makeAssetFreezeTxnWithSuggestedParams will allow the asset's freeze manager to freeze or un-freeze an account,
- * blocking or allowing asset transfers to and from the targeted account.
+export declare function makeAssetDestroyTxnWithSuggestedParamsFromObject({ sender, assetIndex, note, lease, rekeyTo, suggestedParams, }: Required<Pick<AssetConfigurationTransactionParams, 'assetIndex'>> & CommonTransactionParams): Transaction;
+/**
+ * Create a new asset freeze transaction. This transaction allows the asset's freeze manager to
+ * freeze or un-freeze an account, blocking or allowing asset transfers to and from the targeted
+ * account.
  *
- * @param from - string representation of Algorand address of sender
- * @param note - uint8array of arbitrary data for sender to store
- * @param assetIndex - int asset index uniquely specifying the asset
- * @param freezeTarget - string representation of Algorand address being frozen or unfrozen
- * @param freezeState - true if freezeTarget should be frozen, false if freezeTarget should be allowed to transact
- * @param suggestedParams - a dict holding common-to-all-txns args:
- * fee - integer fee per byte, in microAlgos. for a flat fee, set flatFee to true
- * flatFee - bool optionally set this to true to specify fee as microalgos-per-txn
- *       If true, txn fee may fall below the ALGORAND_MIN_TX_FEE
- * firstRound - integer first protocol round on which this txn is valid
- * lastRound - integer last protocol round on which this txn is valid
- * genesisHash - string specifies hash genesis block of network in use
- * genesisID - string specifies genesis ID of network in use
- * @param rekeyTo - rekeyTo address, optional
+ * @param options - Asset freeze transaction parameters
  */
-export declare function makeAssetFreezeTxnWithSuggestedParams(from: AssetFreezeTxn['from'], note: AssetFreezeTxn['note'], assetIndex: AssetFreezeTxn['assetIndex'], freezeTarget: AssetFreezeTxn['freezeAccount'], freezeState: AssetFreezeTxn['freezeState'], suggestedParams: MustHaveSuggestedParams<AssetFreezeTxn>['suggestedParams'], rekeyTo?: AssetFreezeTxn['reKeyTo']): txnBuilder.Transaction;
-export declare function makeAssetFreezeTxnWithSuggestedParamsFromObject(o: Expand<Pick<RenameProperties<MustHaveSuggestedParams<AssetFreezeTxn>, {
-    freezeAccount: 'freezeTarget';
-    reKeyTo: 'rekeyTo';
-}>, 'from' | 'note' | 'assetIndex' | 'freezeTarget' | 'freezeState' | 'suggestedParams' | 'rekeyTo'>>): txnBuilder.Transaction;
-/** makeAssetTransferTxnWithSuggestedParams allows for the creation of an asset transfer transaction.
- * Special case: to begin accepting assets, set amount=0 and from=to.
+export declare function makeAssetFreezeTxnWithSuggestedParamsFromObject({ sender, assetIndex, freezeTarget, frozen, suggestedParams, note, lease, rekeyTo, }: AssetFreezeTransactionParams & CommonTransactionParams): Transaction;
+/**
+ * Create a new asset transfer transaction.
+ *
+ * Special case: to opt into an assets, set amount=0 and sender=receiver.
  *
- * @param from - string representation of Algorand address of sender
- * @param to - string representation of Algorand address of asset recipient
- * @param closeRemainderTo - optional - string representation of Algorand address - if provided,
- * send all remaining assets after transfer to the "closeRemainderTo" address and close "from"'s asset holdings
- * @param revocationTarget - optional - string representation of Algorand address - if provided,
- * and if "from" is the asset's revocation manager, then deduct from "revocationTarget" rather than "from"
- * @param amount - integer amount of assets to send
- * @param note - uint8array of arbitrary data for sender to store
- * @param assetIndex - int asset index uniquely specifying the asset
- * @param suggestedParams - a dict holding common-to-all-txns args:
- * fee - integer fee per byte, in microAlgos. for a flat fee, set flatFee to true
- * flatFee - bool optionally set this to true to specify fee as microalgos-per-txn
- *       If true, txn fee may fall below the ALGORAND_MIN_TX_FEE
- * * flatFee - bool optionally set this to true to specify fee as microalgos-per-txn
- *       If true, txn fee may fall below the ALGORAND_MIN_TX_FEE
- * firstRound - integer first protocol round on which this txn is valid
- * lastRound - integer last protocol round on which this txn is valid
- * genesisHash - string specifies hash genesis block of network in use
- * genesisID - string specifies genesis ID of network in use
- * @param rekeyTo - rekeyTo address, optional
+ * @param options - Asset transfer transaction parameters
  */
-export declare function makeAssetTransferTxnWithSuggestedParams(from: AssetTransferTxn['from'], to: AssetTransferTxn['to'], closeRemainderTo: AssetTransferTxn['closeRemainderTo'], revocationTarget: AssetTransferTxn['assetRevocationTarget'], amount: AssetTransferTxn['amount'], note: AssetTransferTxn['note'], assetIndex: AssetTransferTxn['assetIndex'], suggestedParams: MustHaveSuggestedParams<AssetTransferTxn>['suggestedParams'], rekeyTo?: AssetTransferTxn['reKeyTo']): txnBuilder.Transaction;
-export declare function makeAssetTransferTxnWithSuggestedParamsFromObject(o: Expand<Pick<RenameProperties<MustHaveSuggestedParams<AssetTransferTxn>, {
-    assetRevocationTarget: 'revocationTarget';
-    reKeyTo: 'rekeyTo';
-}>, 'from' | 'to' | 'closeRemainderTo' | 'revocationTarget' | 'amount' | 'note' | 'assetIndex' | 'suggestedParams' | 'rekeyTo'>>): txnBuilder.Transaction;
+export declare function makeAssetTransferTxnWithSuggestedParamsFromObject({ sender, receiver, amount, closeRemainderTo, assetSender, note, assetIndex, suggestedParams, rekeyTo, lease, }: AssetTransferTransactionParams & CommonTransactionParams): Transaction;
+/**
+ * Base function for creating any application call transaction.
+ *
+ * @param options - Application call transaction parameters
+ */
+export declare function makeApplicationCallTxnFromObject({ sender, appIndex, onComplete, appArgs, accounts, foreignApps, foreignAssets, boxes, approvalProgram, clearProgram, numLocalInts, numLocalByteSlices, numGlobalInts, numGlobalByteSlices, extraPages, note, lease, rekeyTo, suggestedParams, }: ApplicationCallTransactionParams & CommonTransactionParams): Transaction;
 /**
  * Make a transaction that will create an application.
- * @param from - address of sender
- * @param suggestedParams - a dict holding common-to-all-txns args:
- * fee - integer fee per byte, in microAlgos. for a flat fee, set flatFee to true
- * flatFee - bool optionally set this to true to specify fee as microalgos-per-txn
- *       If true, txn fee may fall below the ALGORAND_MIN_TX_FEE
- * firstRound - integer first protocol round on which this txn is valid
- * lastRound - integer last protocol round on which this txn is valid
- * genesisHash - string specifies hash genesis block of network in use
- * genesisID - string specifies genesis ID of network in use
- * @param onComplete - algosdk.OnApplicationComplete, what application should do once the program is done being run
- * @param approvalProgram - Uint8Array, the compiled TEAL that approves a transaction
- * @param clearProgram - Uint8Array, the compiled TEAL that runs when clearing state
- * @param numLocalInts - restricts number of ints in per-user local state
- * @param numLocalByteSlices - restricts number of byte slices in per-user local state
- * @param numGlobalInts - restricts number of ints in global state
- * @param numGlobalByteSlices - restricts number of byte slices in global state
- * @param appArgs - Array of Uint8Array, any additional arguments to the application
- * @param accounts - Array of Address strings, any additional accounts to supply to the application
- * @param foreignApps - Array of int, any other apps used by the application, identified by index
- * @param foreignAssets - Array of int, any assets used by the application, identified by index
- * @param note - Arbitrary data for sender to store
- * @param lease - Lease a transaction
- * @param rekeyTo - String representation of the Algorand address that will be used to authorize all future transactions
- * @param extraPages - integer extra pages of memory to rent on creation of application
- * @param boxes - Array of BoxReference, app ID and name of box to be accessed
+ *
+ * @param options - Application creation transaction parameters
  */
-export declare function makeApplicationCreateTxn(from: AppCreateTxn['from'], suggestedParams: MustHaveSuggestedParams<AppCreateTxn>['suggestedParams'], onComplete: AppCreateTxn['appOnComplete'], approvalProgram: AppCreateTxn['appApprovalProgram'], clearProgram: AppCreateTxn['appClearProgram'], numLocalInts: AppCreateTxn['appLocalInts'], numLocalByteSlices: AppCreateTxn['appLocalByteSlices'], numGlobalInts: AppCreateTxn['appGlobalInts'], numGlobalByteSlices: AppCreateTxn['appGlobalByteSlices'], appArgs?: AppCreateTxn['appArgs'], accounts?: AppCreateTxn['appAccounts'], foreignApps?: AppCreateTxn['appForeignApps'], foreignAssets?: AppCreateTxn['appForeignAssets'], note?: AppCreateTxn['note'], lease?: AppCreateTxn['lease'], rekeyTo?: AppCreateTxn['reKeyTo'], extraPages?: AppCreateTxn['extraPages'], boxes?: AppCreateTxn['boxes']): txnBuilder.Transaction;
-export declare function makeApplicationCreateTxnFromObject(o: Expand<Pick<RenameProperties<MustHaveSuggestedParams<AppCreateTxn>, {
-    appOnComplete: 'onComplete';
-    appApprovalProgram: 'approvalProgram';
-    appClearProgram: 'clearProgram';
-    appLocalInts: 'numLocalInts';
-    appLocalByteSlices: 'numLocalByteSlices';
-    appGlobalInts: 'numGlobalInts';
-    appGlobalByteSlices: 'numGlobalByteSlices';
-    appAccounts: 'accounts';
-    appForeignApps: 'foreignApps';
-    appForeignAssets: 'foreignAssets';
-    reKeyTo: 'rekeyTo';
-}>, 'from' | 'suggestedParams' | 'onComplete' | 'approvalProgram' | 'clearProgram' | 'numLocalInts' | 'numLocalByteSlices' | 'numGlobalInts' | 'numGlobalByteSlices' | 'appArgs' | 'accounts' | 'foreignApps' | 'foreignAssets' | 'boxes' | 'note' | 'lease' | 'rekeyTo' | 'extraPages'>>): txnBuilder.Transaction;
+export declare function makeApplicationCreateTxnFromObject({ sender, onComplete, appArgs, accounts, foreignApps, foreignAssets, boxes, approvalProgram, clearProgram, numLocalInts, numLocalByteSlices, numGlobalInts, numGlobalByteSlices, extraPages, note, lease, rekeyTo, suggestedParams, }: Omit<ApplicationCallTransactionParams, 'appIndex' | 'approvalProgram' | 'clearProgram'> & Required<Pick<ApplicationCallTransactionParams, 'approvalProgram' | 'clearProgram'>> & CommonTransactionParams): Transaction;
 /**
  * Make a transaction that changes an application's approval and clear programs
- * @param from - address of sender
- * @param suggestedParams - a dict holding common-to-all-txns args:
- * fee - integer fee per byte, in microAlgos. for a flat fee, set flatFee to true
- * flatFee - bool optionally set this to true to specify fee as microalgos-per-txn
- *       If true, txn fee may fall below the ALGORAND_MIN_TX_FEE
- * firstRound - integer first protocol round on which this txn is valid
- * lastRound - integer last protocol round on which this txn is valid
- * genesisHash - string specifies hash genesis block of network in use
- * genesisID - string specifies genesis ID of network in use
- * @param appIndex - the ID of the app to be updated
- * @param approvalProgram - Uint8Array, the compiled TEAL that approves a transaction
- * @param clearProgram - Uint8Array, the compiled TEAL that runs when clearing state
- * @param appArgs - Array of Uint8Array, any additional arguments to the application
- * @param accounts - Array of Address strings, any additional accounts to supply to the application
- * @param foreignApps - Array of int, any other apps used by the application, identified by index
- * @param foreignAssets - Array of int, any assets used by the application, identified by index
- * @param note - Arbitrary data for sender to store
- * @param lease - Lease a transaction
- * @param rekeyTo - String representation of the Algorand address that will be used to authorize all future transactions
- * @param boxes - Array of BoxReference, app ID and name of box to be accessed
+ *
+ * @param options - Application update transaction parameters
  */
-export declare function makeApplicationUpdateTxn(from: AppUpdateTxn['from'], suggestedParams: MustHaveSuggestedParams<AppUpdateTxn>['suggestedParams'], appIndex: AppUpdateTxn['appIndex'], approvalProgram: AppUpdateTxn['appApprovalProgram'], clearProgram: AppUpdateTxn['appClearProgram'], appArgs?: AppUpdateTxn['appArgs'], accounts?: AppUpdateTxn['appAccounts'], foreignApps?: AppUpdateTxn['appForeignApps'], foreignAssets?: AppUpdateTxn['appForeignAssets'], note?: AppUpdateTxn['note'], lease?: AppUpdateTxn['lease'], rekeyTo?: AppUpdateTxn['reKeyTo'], boxes?: AppUpdateTxn['boxes']): txnBuilder.Transaction;
-export declare function makeApplicationUpdateTxnFromObject(o: Expand<Pick<RenameProperties<MustHaveSuggestedParams<AppUpdateTxn>, {
-    appApprovalProgram: 'approvalProgram';
-    appClearProgram: 'clearProgram';
-    appAccounts: 'accounts';
-    appForeignApps: 'foreignApps';
-    appForeignAssets: 'foreignAssets';
-    reKeyTo: 'rekeyTo';
-}>, 'from' | 'suggestedParams' | 'appIndex' | 'approvalProgram' | 'clearProgram' | 'appArgs' | 'accounts' | 'foreignApps' | 'foreignAssets' | 'boxes' | 'note' | 'lease' | 'rekeyTo'>>): txnBuilder.Transaction;
+export declare function makeApplicationUpdateTxnFromObject({ sender, appIndex, appArgs, accounts, foreignApps, foreignAssets, boxes, approvalProgram, clearProgram, note, lease, rekeyTo, suggestedParams, }: Omit<ApplicationCallTransactionParams, 'onComplete' | 'numLocalInts' | 'numLocalByteSlices' | 'numGlobalInts' | 'numGlobalByteSlices' | 'extraPages' | 'approvalProgram' | 'clearProgram'> & Required<Pick<ApplicationCallTransactionParams, 'approvalProgram' | 'clearProgram'>> & CommonTransactionParams): Transaction;
 /**
  * Make a transaction that deletes an application
- * @param from - address of sender
- * @param suggestedParams - a dict holding common-to-all-txns args:
- * fee - integer fee per byte, in microAlgos. for a flat fee, set flatFee to true
- * flatFee - bool optionally set this to true to specify fee as microalgos-per-txn
- *       If true, txn fee may fall below the ALGORAND_MIN_TX_FEE
- * firstRound - integer first protocol round on which this txn is valid
- * lastRound - integer last protocol round on which this txn is valid
- * genesisHash - string specifies hash genesis block of network in use
- * genesisID - string specifies genesis ID of network in use
- * @param appIndex - the ID of the app to be deleted
- * @param appArgs - Array of Uint8Array, any additional arguments to the application
- * @param accounts - Array of Address strings, any additional accounts to supply to the application
- * @param foreignApps - Array of int, any other apps used by the application, identified by index
- * @param foreignAssets - Array of int, any assets used by the application, identified by index
- * @param note - Arbitrary data for sender to store
- * @param lease - Lease a transaction
- * @param rekeyTo - String representation of the Algorand address that will be used to authorize all future transactions
- * @param boxes - Array of BoxReference, app ID and name of box to be accessed
+ *
+ * @param options - Application deletion transaction parameters
  */
-export declare function makeApplicationDeleteTxn(from: AppDeleteTxn['from'], suggestedParams: MustHaveSuggestedParams<AppDeleteTxn>['suggestedParams'], appIndex: AppDeleteTxn['appIndex'], appArgs?: AppDeleteTxn['appArgs'], accounts?: AppDeleteTxn['appAccounts'], foreignApps?: AppDeleteTxn['appForeignApps'], foreignAssets?: AppDeleteTxn['appForeignAssets'], note?: AppDeleteTxn['note'], lease?: AppDeleteTxn['lease'], rekeyTo?: AppDeleteTxn['reKeyTo'], boxes?: AppDeleteTxn['boxes']): txnBuilder.Transaction;
-export declare function makeApplicationDeleteTxnFromObject(o: Expand<Pick<RenameProperties<MustHaveSuggestedParams<AppDeleteTxn>, {
-    appAccounts: 'accounts';
-    appForeignApps: 'foreignApps';
-    appForeignAssets: 'foreignAssets';
-    reKeyTo: 'rekeyTo';
-}>, 'from' | 'suggestedParams' | 'appIndex' | 'appArgs' | 'accounts' | 'foreignApps' | 'foreignAssets' | 'boxes' | 'note' | 'lease' | 'rekeyTo'>>): txnBuilder.Transaction;
+export declare function makeApplicationDeleteTxnFromObject({ sender, appIndex, appArgs, accounts, foreignApps, foreignAssets, boxes, note, lease, rekeyTo, suggestedParams, }: Omit<ApplicationCallTransactionParams, 'onComplete' | 'numLocalInts' | 'numLocalByteSlices' | 'numGlobalInts' | 'numGlobalByteSlices' | 'extraPages' | 'approvalProgram' | 'clearProgram'> & CommonTransactionParams): Transaction;
 /**
  * Make a transaction that opts in to use an application
- * @param from - address of sender
- * @param suggestedParams - a dict holding common-to-all-txns args:
- * fee - integer fee per byte, in microAlgos. for a flat fee, set flatFee to true
- * flatFee - bool optionally set this to true to specify fee as microalgos-per-txn
- *       If true, txn fee may fall below the ALGORAND_MIN_TX_FEE
- * firstRound - integer first protocol round on which this txn is valid
- * lastRound - integer last protocol round on which this txn is valid
- * genesisHash - string specifies hash genesis block of network in use
- * genesisID - string specifies genesis ID of network in use
- * @param appIndex - the ID of the app to join
- * @param appArgs - Array of Uint8Array, any additional arguments to the application
- * @param accounts - Array of Address strings, any additional accounts to supply to the application
- * @param foreignApps - Array of int, any other apps used by the application, identified by index
- * @param foreignAssets - Array of int, any assets used by the application, identified by index
- * @param note - Arbitrary data for sender to store
- * @param lease - Lease a transaction
- * @param rekeyTo - String representation of the Algorand address that will be used to authorize all future transactions
- * @param boxes - Array of BoxReference, app ID and name of box to be accessed
+ *
+ * @param options - Application opt-in transaction parameters
  */
-export declare function makeApplicationOptInTxn(from: AppOptInTxn['from'], suggestedParams: MustHaveSuggestedParams<AppOptInTxn>['suggestedParams'], appIndex: AppOptInTxn['appIndex'], appArgs?: AppOptInTxn['appArgs'], accounts?: AppOptInTxn['appAccounts'], foreignApps?: AppOptInTxn['appForeignApps'], foreignAssets?: AppOptInTxn['appForeignAssets'], note?: AppOptInTxn['note'], lease?: AppOptInTxn['lease'], rekeyTo?: AppOptInTxn['reKeyTo'], boxes?: AppOptInTxn['boxes']): txnBuilder.Transaction;
-export declare function makeApplicationOptInTxnFromObject(o: Expand<Pick<RenameProperties<MustHaveSuggestedParams<AppOptInTxn>, {
-    appAccounts: 'accounts';
-    appForeignApps: 'foreignApps';
-    appForeignAssets: 'foreignAssets';
-    reKeyTo: 'rekeyTo';
-}>, 'from' | 'suggestedParams' | 'appIndex' | 'appArgs' | 'accounts' | 'foreignApps' | 'foreignAssets' | 'boxes' | 'note' | 'lease' | 'rekeyTo'>>): txnBuilder.Transaction;
+export declare function makeApplicationOptInTxnFromObject({ sender, appIndex, appArgs, accounts, foreignApps, foreignAssets, boxes, note, lease, rekeyTo, suggestedParams, }: Omit<ApplicationCallTransactionParams, 'onComplete' | 'numLocalInts' | 'numLocalByteSlices' | 'numGlobalInts' | 'numGlobalByteSlices' | 'extraPages' | 'approvalProgram' | 'clearProgram'> & CommonTransactionParams): Transaction;
 /**
  * Make a transaction that closes out a user's state in an application
- * @param from - address of sender
- * @param suggestedParams - a dict holding common-to-all-txns args:
- * fee - integer fee per byte, in microAlgos. for a flat fee, set flatFee to true
- * flatFee - bool optionally set this to true to specify fee as microalgos-per-txn
- *       If true, txn fee may fall below the ALGORAND_MIN_TX_FEE
- * firstRound - integer first protocol round on which this txn is valid
- * lastRound - integer last protocol round on which this txn is valid
- * genesisHash - string specifies hash genesis block of network in use
- * genesisID - string specifies genesis ID of network in use
- * @param appIndex - the ID of the app to use
- * @param appArgs - Array of Uint8Array, any additional arguments to the application
- * @param accounts - Array of Address strings, any additional accounts to supply to the application
- * @param foreignApps - Array of int, any other apps used by the application, identified by index
- * @param foreignAssets - Array of int, any assets used by the application, identified by index
- * @param note - Arbitrary data for sender to store
- * @param lease - Lease a transaction
- * @param rekeyTo - String representation of the Algorand address that will be used to authorize all future transactions
- * @param boxes - Array of BoxReference, app ID and name of box to be accessed
+ *
+ * @param options - Application close-out transaction parameters
  */
-export declare function makeApplicationCloseOutTxn(from: AppCloseOutTxn['from'], suggestedParams: MustHaveSuggestedParams<AppCloseOutTxn>['suggestedParams'], appIndex: AppCloseOutTxn['appIndex'], appArgs?: AppCloseOutTxn['appArgs'], accounts?: AppCloseOutTxn['appAccounts'], foreignApps?: AppCloseOutTxn['appForeignApps'], foreignAssets?: AppCloseOutTxn['appForeignAssets'], note?: AppCloseOutTxn['note'], lease?: AppCloseOutTxn['lease'], rekeyTo?: AppCloseOutTxn['reKeyTo'], boxes?: AppCloseOutTxn['boxes']): txnBuilder.Transaction;
-export declare function makeApplicationCloseOutTxnFromObject(o: Expand<Pick<RenameProperties<MustHaveSuggestedParams<AppOptInTxn>, {
-    appAccounts: 'accounts';
-    appForeignApps: 'foreignApps';
-    appForeignAssets: 'foreignAssets';
-    reKeyTo: 'rekeyTo';
-}>, 'from' | 'suggestedParams' | 'appIndex' | 'appArgs' | 'accounts' | 'foreignApps' | 'foreignAssets' | 'boxes' | 'note' | 'lease' | 'rekeyTo'>>): txnBuilder.Transaction;
+export declare function makeApplicationCloseOutTxnFromObject({ sender, appIndex, appArgs, accounts, foreignApps, foreignAssets, boxes, note, lease, rekeyTo, suggestedParams, }: Omit<ApplicationCallTransactionParams, 'onComplete' | 'numLocalInts' | 'numLocalByteSlices' | 'numGlobalInts' | 'numGlobalByteSlices' | 'extraPages' | 'approvalProgram' | 'clearProgram'> & CommonTransactionParams): Transaction;
 /**
  * Make a transaction that clears a user's state in an application
- * @param from - address of sender
- * @param suggestedParams - a dict holding common-to-all-txns args:
- * fee - integer fee per byte, in microAlgos. for a flat fee, set flatFee to true
- * flatFee - bool optionally set this to true to specify fee as microalgos-per-txn
- *       If true, txn fee may fall below the ALGORAND_MIN_TX_FEE
- * firstRound - integer first protocol round on which this txn is valid
- * lastRound - integer last protocol round on which this txn is valid
- * genesisHash - string specifies hash genesis block of network in use
- * genesisID - string specifies genesis ID of network in use
- * @param appIndex - the ID of the app to use
- * @param appArgs - Array of Uint8Array, any additional arguments to the application
- * @param accounts - Array of Address strings, any additional accounts to supply to the application
- * @param foreignApps - Array of int, any other apps used by the application, identified by index
- * @param foreignAssets - Array of int, any assets used by the application, identified by index
- * @param note - Arbitrary data for sender to store
- * @param lease - Lease a transaction
- * @param rekeyTo - String representation of the Algorand address that will be used to authorize all future transactions
- * @param boxes - Array of BoxReference, app ID and name of box to be accessed
+ *
+ * @param options - Application clear state transaction parameters
  */
-export declare function makeApplicationClearStateTxn(from: AppClearStateTxn['from'], suggestedParams: MustHaveSuggestedParams<AppClearStateTxn>['suggestedParams'], appIndex: AppClearStateTxn['appIndex'], appArgs?: AppClearStateTxn['appArgs'], accounts?: AppClearStateTxn['appAccounts'], foreignApps?: AppClearStateTxn['appForeignApps'], foreignAssets?: AppClearStateTxn['appForeignAssets'], note?: AppClearStateTxn['note'], lease?: AppClearStateTxn['lease'], rekeyTo?: AppClearStateTxn['reKeyTo'], boxes?: AppClearStateTxn['boxes']): txnBuilder.Transaction;
-export declare function makeApplicationClearStateTxnFromObject(o: Expand<Pick<RenameProperties<MustHaveSuggestedParams<AppOptInTxn>, {
-    appAccounts: 'accounts';
-    appForeignApps: 'foreignApps';
-    appForeignAssets: 'foreignAssets';
-    reKeyTo: 'rekeyTo';
-}>, 'from' | 'suggestedParams' | 'appIndex' | 'appArgs' | 'accounts' | 'foreignApps' | 'foreignAssets' | 'boxes' | 'note' | 'lease' | 'rekeyTo'>>): txnBuilder.Transaction;
+export declare function makeApplicationClearStateTxnFromObject({ sender, appIndex, appArgs, accounts, foreignApps, foreignAssets, boxes, note, lease, rekeyTo, suggestedParams, }: Omit<ApplicationCallTransactionParams, 'onComplete' | 'numLocalInts' | 'numLocalByteSlices' | 'numGlobalInts' | 'numGlobalByteSlices' | 'extraPages' | 'approvalProgram' | 'clearProgram'> & CommonTransactionParams): Transaction;
 /**
  * Make a transaction that just calls an application, doing nothing on completion
- * @param from - address of sender
- * @param suggestedParams - a dict holding common-to-all-txns args:
- * fee - integer fee per byte, in microAlgos. for a flat fee, set flatFee to true
- * flatFee - bool optionally set this to true to specify fee as microalgos-per-txn
- *       If true, txn fee may fall below the ALGORAND_MIN_TX_FEE
- * firstRound - integer first protocol round on which this txn is valid
- * lastRound - integer last protocol round on which this txn is valid
- * genesisHash - string specifies hash genesis block of network in use
- * genesisID - string specifies genesis ID of network in use
- * @param appIndex - the ID of the app to use
- * @param appArgs - Array of Uint8Array, any additional arguments to the application
- * @param accounts - Array of Address strings, any additional accounts to supply to the application
- * @param foreignApps - Array of int, any other apps used by the application, identified by index
- * @param foreignAssets - Array of int, any assets used by the application, identified by index
- * @param note - Arbitrary data for sender to store
- * @param lease - Lease a transaction
- * @param rekeyTo - String representation of the Algorand address that will be used to authorize all future transactions
- * @param boxes - Array of BoxReference, app ID and name of box to be accessed
- */
-export declare function makeApplicationNoOpTxn(from: AppNoOpTxn['from'], suggestedParams: MustHaveSuggestedParams<AppNoOpTxn>['suggestedParams'], appIndex: AppNoOpTxn['appIndex'], appArgs?: AppNoOpTxn['appArgs'], accounts?: AppNoOpTxn['appAccounts'], foreignApps?: AppNoOpTxn['appForeignApps'], foreignAssets?: AppNoOpTxn['appForeignAssets'], note?: AppNoOpTxn['note'], lease?: AppNoOpTxn['lease'], rekeyTo?: AppNoOpTxn['reKeyTo'], boxes?: AppNoOpTxn['boxes']): txnBuilder.Transaction;
-export declare function makeApplicationNoOpTxnFromObject(o: Expand<Pick<RenameProperties<MustHaveSuggestedParams<AppOptInTxn>, {
-    appAccounts: 'accounts';
-    appForeignApps: 'foreignApps';
-    appForeignAssets: 'foreignAssets';
-    reKeyTo: 'rekeyTo';
-}>, 'from' | 'suggestedParams' | 'appIndex' | 'appArgs' | 'accounts' | 'foreignApps' | 'foreignAssets' | 'boxes' | 'note' | 'lease' | 'rekeyTo'>>): txnBuilder.Transaction;
-export { OnApplicationComplete } from './types/transactions/base';
-/**
- * Generic function for creating any application call transaction.
+ *
+ * @param options - Application no-op transaction parameters
  */
-export declare function makeApplicationCallTxnFromObject(options: Expand<Pick<RenameProperties<MustHaveSuggestedParams<AppCreateTxn>, {
-    appOnComplete: 'onComplete';
-    appAccounts: 'accounts';
-    appForeignApps: 'foreignApps';
-    appForeignAssets: 'foreignAssets';
-    reKeyTo: 'rekeyTo';
-}>, 'from' | 'suggestedParams' | 'appIndex' | 'onComplete' | 'appArgs' | 'accounts' | 'foreignApps' | 'foreignAssets' | 'boxes' | 'note' | 'lease' | 'rekeyTo' | 'extraPages'> & Partial<Pick<RenameProperties<MustHaveSuggestedParams<AppCreateTxn>, {
-    appApprovalProgram: 'approvalProgram';
-    appClearProgram: 'clearProgram';
-    appLocalInts: 'numLocalInts';
-    appLocalByteSlices: 'numLocalByteSlices';
-    appGlobalInts: 'numGlobalInts';
-    appGlobalByteSlices: 'numGlobalByteSlices';
-}>, 'approvalProgram' | 'clearProgram' | 'numLocalInts' | 'numLocalByteSlices' | 'numGlobalInts' | 'numGlobalByteSlices'>>>): txnBuilder.Transaction;
+export declare function makeApplicationNoOpTxnFromObject({ sender, appIndex, appArgs, accounts, foreignApps, foreignAssets, boxes, note, lease, rekeyTo, suggestedParams, }: Omit<ApplicationCallTransactionParams, 'onComplete' | 'numLocalInts' | 'numLocalByteSlices' | 'numGlobalInts' | 'numGlobalByteSlices' | 'extraPages' | 'approvalProgram' | 'clearProgram'> & CommonTransactionParams): Transaction;

package/dist/types/mnemonic/mnemonic.d.ts

@@ -1,4 +1,4 @@
-import Account from '../types/account';
+import Account from '../types/account.js';
 export declare const FAIL_TO_DECODE_MNEMONIC_ERROR_MSG = "failed to decode mnemonic";
 export declare const NOT_IN_WORDS_LIST_ERROR_MSG = "the mnemonic contains a word that is not in the wordlist";
 /**