@algorandfoundation/algokit-utils 6.2.1 → 7.0.0-beta.1

package/types/algorand-client-transaction-sender.mjs

@@ -0,0 +1,420 @@
+import { Config } from '../config.mjs';
+
+/** Orchestrates sending transactions for `AlgorandClient`. */
+class AlgorandClientTransactionSender {
+    /**
+     * Creates a new `AlgorandClientSender`
+     * @param newGroup A lambda that starts a new `AlgoKitComposer` transaction group
+     * @param assetManager An `AssetManager` instance
+     */
+    constructor(newGroup, assetManager) {
+        /**
+         * Send a payment transaction to transfer Algo between accounts.
+         * @param params The parameters for the payment transaction
+         * @example Basic example
+         * ```typescript
+         * const result = await algorandClient.send.payment({
+         *  sender: 'SENDERADDRESS',
+         *  receiver: 'RECEIVERADDRESS',
+         *  amount: (4).algo(),
+         * })
+         * ```
+         * @example Advanced example
+         * ```typescript
+         * const result = await algorandClient.send.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(),
+         *   // Signer only needed if you want to provide one,
+         *   //  generally you'd register it with AlgorandClient
+         *   //  against the sender and not need to pass it in
+         *   signer: transactionSigner,
+         *   maxRoundsToWaitForConfirmation: 5,
+         *   suppressLog: true,
+         * })
+         * ```
+         *
+         * @returns The result of the transaction and the transaction that was sent
+         */
+        this.payment = this._send((c) => c.addPayment, {
+            preLog: (params, transaction) => `Sending ${params.amount.microAlgo} µALGO from ${params.sender} to ${params.receiver} via transaction ${transaction.txID()}`,
+        });
+        /**
+         * Create a new Algorand Standard Asset.
+         *
+         * 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.send.assetCreate({sender: "CREATORADDRESS", total: 100n})
+         * ```
+         * @example Advanced example
+         * ```typescript
+         * await algorand.send.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(),
+         *   // Signer only needed if you want to provide one,
+         *   //  generally you'd register it with AlgorandClient
+         *   //  against the sender and not need to pass it in
+         *   signer: transactionSigner,
+         *   maxRoundsToWaitForConfirmation: 5,
+         *   suppressLog: true,
+         * })
+         * ```
+         * @returns The result of the transaction and the transaction that was sent
+         */
+        this.assetCreate = async (params) => {
+            const result = await this._send((c) => c.addAssetCreate, {
+                postLog: (params, result) => `Created asset${params.assetName ? ` ${params.assetName}` : ''}${params.unitName ? ` (${params.unitName})` : ''} with ${params.total} units and ${params.decimals ?? 0} decimals created by ${params.sender} with ID ${result.confirmation.assetIndex} via transaction ${result.txIds.at(-1)}`,
+            })(params);
+            return { ...result, assetId: BigInt(result.confirmation.assetIndex ?? 0) };
+        };
+        /**
+         * Configure 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.send.assetConfig({sender: "MANAGERADDRESS", assetId: 123456n, manager: "MANAGERADDRESS" })
+         * ```
+         * @example Advanced example
+         * ```typescript
+         * await algorand.send.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(),
+         *   // Signer only needed if you want to provide one,
+         *   //  generally you'd register it with AlgorandClient
+         *   //  against the sender and not need to pass it in
+         *   signer: transactionSigner,
+         *   maxRoundsToWaitForConfirmation: 5,
+         *   suppressLog: true,
+         * })
+         * ```
+         * @returns The result of the transaction and the transaction that was sent
+         */
+        this.assetConfig = this._send((c) => c.addAssetConfig, {
+            preLog: (params, transaction) => `Configuring asset with ID ${params.assetId} via transaction ${transaction.txID()}`,
+        });
+        /**
+         * Freeze or unfreeze an Algorand Standard Asset for an account.
+         *
+         * @param params The parameters for the asset freeze transaction
+         *
+         * @example Basic example
+         * ```typescript
+         * await algorand.send.assetFreeze({sender: "MANAGERADDRESS", assetId: 123456n, account: "ACCOUNTADDRESS", frozen: true })
+         * ```
+         * @example Advanced example
+         * ```typescript
+         * await algorand.send.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(),
+         *   // Signer only needed if you want to provide one,
+         *   //  generally you'd register it with AlgorandClient
+         *   //  against the sender and not need to pass it in
+         *   signer: transactionSigner,
+         *   maxRoundsToWaitForConfirmation: 5,
+         *   suppressLog: true,
+         * })
+         * ```
+         * @returns The result of the transaction and the transaction that was sent
+         */
+        this.assetFreeze = this._send((c) => c.addAssetFreeze, {
+            preLog: (params, transaction) => `Freezing asset with ID ${params.assetId} via transaction ${transaction.txID()}`,
+        });
+        /**
+         * Destroys an Algorand Standard Asset.
+         *
+         * 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.send.assetDestroy({sender: "MANAGERADDRESS", assetId: 123456n })
+         * ```
+         * @example Advanced example
+         * ```typescript
+         * await algorand.send.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(),
+         *   // Signer only needed if you want to provide one,
+         *   //  generally you'd register it with AlgorandClient
+         *   //  against the sender and not need to pass it in
+         *   signer: transactionSigner,
+         *   maxRoundsToWaitForConfirmation: 5,
+         *   suppressLog: true,
+         * })
+         * ```
+         * @returns The result of the transaction and the transaction that was sent
+         */
+        this.assetDestroy = this._send((c) => c.addAssetDestroy, {
+            preLog: (params, transaction) => `Destroying asset with ID ${params.assetId} via transaction ${transaction.txID()}`,
+        });
+        /**
+         * Transfer an Algorand Standard Asset.
+         *
+         * @param params The parameters for the asset transfer transaction
+         *
+         * @example Basic example
+         * ```typescript
+         * await algorand.send.assetTransfer({sender: "HOLDERADDRESS", assetId: 123456n, amount: 1n, receiver: "RECEIVERADDRESS" })
+         * ```
+         * @example Advanced example (with clawback)
+         * ```typescript
+         * await algorand.send.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(),
+         *   // Signer only needed if you want to provide one,
+         *   //  generally you'd register it with AlgorandClient
+         *   //  against the sender and not need to pass it in
+         *   signer: transactionSigner,
+         *   maxRoundsToWaitForConfirmation: 5,
+         *   suppressLog: true,
+         * })
+         * ```
+         * @returns The result of the transaction and the transaction that was sent
+         */
+        this.assetTransfer = this._send((c) => c.addAssetTransfer, {
+            preLog: (params, transaction) => `Transferring ${params.amount} units of asset with ID ${params.assetId} from ${params.sender} to ${params.receiver} via transaction ${transaction.txID()}`,
+        });
+        /**
+         * Opt an account into an Algorand Standard Asset.
+         *
+         * @param params The parameters for the asset opt-in transaction
+         *
+         * @example Basic example
+         * ```typescript
+         * await algorand.send.assetOptIn({sender: "SENDERADDRESS", assetId: 123456n })
+         * ```
+         * @example Advanced example
+         * ```typescript
+         * await algorand.send.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(),
+         *   // Signer only needed if you want to provide one,
+         *   //  generally you'd register it with AlgorandClient
+         *   //  against the sender and not need to pass it in
+         *   signer: transactionSigner,
+         *   maxRoundsToWaitForConfirmation: 5,
+         *   suppressLog: true,
+         * })
+         * ```
+         * @returns The result of the transaction and the transaction that was sent
+         */
+        this.assetOptIn = this._send((c) => c.addAssetOptIn, {
+            preLog: (params, transaction) => `Opting in ${params.sender} to asset with ID ${params.assetId} via transaction ${transaction.txID()}`,
+        });
+        /**
+         * Opt an account out of an Algorand Standard Asset.
+         *
+         * *Note:* If the account has a balance of the asset,
+         * it will not be able to opt-out unless `ensureZeroBalance`
+         * is set to `false` (but then the account will lose the assets).
+         *
+         * @param params The parameters for the asset opt-out transaction
+         *
+         * @example Basic example (without creator)
+         * ```typescript
+         * await algorand.send.assetOptOut({sender: "SENDERADDRESS", assetId: 123456n, ensureZeroBalance: true })
+         * ```
+         * @example Basic example (with creator)
+         * ```typescript
+         * await algorand.send.assetOptOut({sender: "SENDERADDRESS", creator: "CREATORADDRESS", assetId: 123456n, ensureZeroBalance: true })
+         * ```
+         * @example Advanced example
+         * ```typescript
+         * await algorand.send.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(),
+         *   // Signer only needed if you want to provide one,
+         *   //  generally you'd register it with AlgorandClient
+         *   //  against the sender and not need to pass it in
+         *   signer: transactionSigner,
+         *   maxRoundsToWaitForConfirmation: 5,
+         *   suppressLog: true,
+         * })
+         * ```
+         * @returns The result of the transaction and the transaction that was sent
+         */
+        this.assetOptOut = async (params) => {
+            if (params.ensureZeroBalance) {
+                let balance = 0n;
+                try {
+                    const accountAssetInfo = await this._assetManager.getAccountInformation(params.sender, params.assetId);
+                    balance = accountAssetInfo.balance;
+                }
+                catch (e) {
+                    throw new Error(`Account ${params.sender} is not opted-in to Asset ${params.assetId}; can't opt-out.`);
+                }
+                if (balance !== 0n) {
+                    throw new Error(`Account ${params.sender} does not have a zero balance for Asset ${params.assetId}; can't opt-out.`);
+                }
+            }
+            params.creator = params.creator ?? (await this._assetManager.getById(params.assetId)).creator;
+            return await this._send((c) => c.addAssetOptOut, {
+                preLog: (params, transaction) => `Opting ${params.sender} out of asset with ID ${params.assetId} to creator ${params.creator} via transaction ${transaction.txID()}`,
+            })(params);
+        };
+        /**
+         * Call a smart contract.
+         *
+         * Note: you may prefer to use `algorandClient.client` to get an app client for more advanced functionality.
+         */
+        this.appCall = this._send((c) => c.addAppCall);
+        /**
+         * Call a smart contract ABI method.
+         *
+         * Note: you may prefer to use `algorandClient.client` to get an app client for more advanced functionality.
+         */
+        this.methodCall = this._send((c) => c.addMethodCall);
+        /** Register an online key. */
+        this.onlineKeyRegistration = this._send((c) => c.addOnlineKeyRegistration, {
+            preLog: (params, transaction) => `Registering online key for ${params.sender} via transaction ${transaction.txID()}`,
+        });
+        this._newGroup = newGroup;
+        this._assetManager = assetManager;
+    }
+    _send(c, log) {
+        return async (params) => {
+            const composer = this._newGroup();
+            // Ensure `this` is properly populated
+            c(composer).apply(composer, [params]);
+            if (log?.preLog) {
+                const transaction = (await composer.build()).transactions.at(-1).txn;
+                Config.getLogger(params?.suppressLog).debug(log.preLog(params, transaction));
+            }
+            const rawResult = await composer.execute(params);
+            const result = {
+                // Last item covers when a group is created by an app call with ABI transaction parameters
+                transaction: rawResult.transactions[rawResult.transactions.length - 1],
+                confirmation: rawResult.confirmations[rawResult.confirmations.length - 1],
+                txId: rawResult.txIds[0],
+                ...rawResult,
+            };
+            if (log?.postLog) {
+                Config.getLogger(params?.suppressLog).debug(log.postLog(params, result));
+            }
+            return result;
+        };
+    }
+}
+
+export { AlgorandClientTransactionSender };
+//# sourceMappingURL=algorand-client-transaction-sender.mjs.map

package/types/algorand-client-transaction-sender.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"algorand-client-transaction-sender.mjs","sources":["../../src/types/algorand-client-transaction-sender.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAWA;MACa,+BAA+B,CAAA;AAI1C;;;;AAIG;IACH,WAAY,CAAA,QAA+B,EAAE,YAA0B,EAAA;AAwCvE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwCG;AACH,QAAA,IAAA,CAAA,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,UAAU,EAAE;YACxC,MAAM,EAAE,CAAC,MAAM,EAAE,WAAW,KAC1B,CAAA,QAAA,EAAW,MAAM,CAAC,MAAM,CAAC,SAAS,CAAA,YAAA,EAAe,MAAM,CAAC,MAAM,CAAA,IAAA,EAAO,MAAM,CAAC,QAAQ,CAAA,iBAAA,EAAoB,WAAW,CAAC,IAAI,EAAE,CAAE,CAAA;AAC/H,SAAA,CAAC,CAAA;AACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8CG;AACH,QAAA,IAAA,CAAA,WAAW,GAAG,OAAO,MAAyC,KAAI;AAChE,YAAA,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,cAAc,EAAE;AACvD,gBAAA,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KACtB,CAAA,aAAA,EAAgB,MAAM,CAAC,SAAS,GAAG,CAAA,CAAA,EAAI,MAAM,CAAC,SAAS,CAAA,CAAE,GAAG,EAAE,CAAA,EAAG,MAAM,CAAC,QAAQ,GAAG,CAAA,EAAA,EAAK,MAAM,CAAC,QAAQ,CAAG,CAAA,CAAA,GAAG,EAAE,CAAA,MAAA,EAAS,MAAM,CAAC,KAAK,CAAc,WAAA,EAAA,MAAM,CAAC,QAAQ,IAAI,CAAC,wBAAwB,MAAM,CAAC,MAAM,CAAA,SAAA,EAAY,MAAM,CAAC,YAAY,CAAC,UAAU,CAAoB,iBAAA,EAAA,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAE,CAAA;aACjS,CAAC,CAAC,MAAM,CAAC,CAAA;AACV,YAAA,OAAO,EAAE,GAAG,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,UAAU,IAAI,CAAC,CAAC,EAAE,CAAA;AAC5E,SAAC,CAAA;AACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyCG;AACH,QAAA,IAAA,CAAA,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,cAAc,EAAE;AAChD,YAAA,MAAM,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,CAA6B,0BAAA,EAAA,MAAM,CAAC,OAAO,CAAA,iBAAA,EAAoB,WAAW,CAAC,IAAI,EAAE,CAAE,CAAA;AACrH,SAAA,CAAC,CAAA;AACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmCG;AACH,QAAA,IAAA,CAAA,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,cAAc,EAAE;AAChD,YAAA,MAAM,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,CAA0B,uBAAA,EAAA,MAAM,CAAC,OAAO,CAAA,iBAAA,EAAoB,WAAW,CAAC,IAAI,EAAE,CAAE,CAAA;AAClH,SAAA,CAAC,CAAA;AACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqCG;AACH,QAAA,IAAA,CAAA,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,eAAe,EAAE;AAClD,YAAA,MAAM,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,CAA4B,yBAAA,EAAA,MAAM,CAAC,OAAO,CAAA,iBAAA,EAAoB,WAAW,CAAC,IAAI,EAAE,CAAE,CAAA;AACpH,SAAA,CAAC,CAAA;AACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsCG;AACH,QAAA,IAAA,CAAA,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,gBAAgB,EAAE;AACpD,YAAA,MAAM,EAAE,CAAC,MAAM,EAAE,WAAW,KAC1B,CAAgB,aAAA,EAAA,MAAM,CAAC,MAAM,CAA2B,wBAAA,EAAA,MAAM,CAAC,OAAO,CAAS,MAAA,EAAA,MAAM,CAAC,MAAM,CAAO,IAAA,EAAA,MAAM,CAAC,QAAQ,CAAoB,iBAAA,EAAA,WAAW,CAAC,IAAI,EAAE,CAAE,CAAA;AAC7J,SAAA,CAAC,CAAA;AACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiCG;AACH,QAAA,IAAA,CAAA,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,aAAa,EAAE;YAC9C,MAAM,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,CAAa,UAAA,EAAA,MAAM,CAAC,MAAM,CAAA,kBAAA,EAAqB,MAAM,CAAC,OAAO,oBAAoB,WAAW,CAAC,IAAI,EAAE,CAAE,CAAA;AACvI,SAAA,CAAC,CAAA;AACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2CG;AACH,QAAA,IAAA,CAAA,WAAW,GAAG,OACZ,MAUiB,KACf;AACF,YAAA,IAAI,MAAM,CAAC,iBAAiB,EAAE;gBAC5B,IAAI,OAAO,GAAG,EAAE,CAAA;AAChB,gBAAA,IAAI;AACF,oBAAA,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,qBAAqB,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,CAAA;AACtG,oBAAA,OAAO,GAAG,gBAAgB,CAAC,OAAO,CAAA;iBACnC;gBAAC,OAAO,CAAC,EAAE;AACV,oBAAA,MAAM,IAAI,KAAK,CAAC,CAAA,QAAA,EAAW,MAAM,CAAC,MAAM,CAAA,0BAAA,EAA6B,MAAM,CAAC,OAAO,CAAA,gBAAA,CAAkB,CAAC,CAAA;iBACvG;AACD,gBAAA,IAAI,OAAO,KAAK,EAAE,EAAE;AAClB,oBAAA,MAAM,IAAI,KAAK,CAAC,CAAA,QAAA,EAAW,MAAM,CAAC,MAAM,CAAA,wCAAA,EAA2C,MAAM,CAAC,OAAO,CAAA,gBAAA,CAAkB,CAAC,CAAA;iBACrH;aACF;YAED,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,IAAI,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,CAAA;AAE7F,YAAA,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,cAAc,EAAE;gBAC/C,MAAM,EAAE,CAAC,MAAM,EAAE,WAAW,KAC1B,CAAU,OAAA,EAAA,MAAM,CAAC,MAAM,yBAAyB,MAAM,CAAC,OAAO,CAAA,YAAA,EAAe,MAAM,CAAC,OAAO,CAAA,iBAAA,EAAoB,WAAW,CAAC,IAAI,EAAE,CAAE,CAAA;aACtI,CAAC,CAAC,MAA2C,CAAC,CAAA;AACjD,SAAC,CAAA;AACD;;;;AAIG;AACH,QAAA,IAAA,CAAA,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,UAAU,CAAC,CAAA;AACzC;;;;AAIG;AACH,QAAA,IAAA,CAAA,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,aAAa,CAAC,CAAA;;AAE/C,QAAA,IAAA,CAAA,qBAAqB,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,wBAAwB,EAAE;AACpE,YAAA,MAAM,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,CAA8B,2BAAA,EAAA,MAAM,CAAC,MAAM,CAAA,iBAAA,EAAoB,WAAW,CAAC,IAAI,EAAE,CAAE,CAAA;AACrH,SAAA,CAAC,CAAA;AAnbA,QAAA,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAA;AACzB,QAAA,IAAI,CAAC,aAAa,GAAG,YAAY,CAAA;KAClC;IAEO,KAAK,CACX,CAAyD,EACzD,GAGC,EAAA;AAED,QAAA,OAAO,OAAO,MAAM,KAAI;AACtB,YAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,EAAE,CAAA;;AAGjC,YAAA,CAAC,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,CAAC,CAAA;AAErC,YAAA,IAAI,GAAG,EAAE,MAAM,EAAE;AACf,gBAAA,MAAM,WAAW,GAAG,CAAC,MAAM,QAAQ,CAAC,KAAK,EAAE,EAAE,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,CAAE,CAAC,GAAG,CAAA;AACrE,gBAAA,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,CAAA;aAC7E;YAED,MAAM,SAAS,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;AAChD,YAAA,MAAM,MAAM,GAAG;;AAEb,gBAAA,WAAW,EAAE,SAAS,CAAC,YAAY,CAAC,SAAS,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC;AACtE,gBAAA,YAAY,EAAE,SAAS,CAAC,aAAc,CAAC,SAAS,CAAC,aAAc,CAAC,MAAM,GAAG,CAAC,CAAC;AAC3E,gBAAA,IAAI,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;AACxB,gBAAA,GAAG,SAAS;aACb,CAAA;AAED,YAAA,IAAI,GAAG,EAAE,OAAO,EAAE;AAChB,gBAAA,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;aACzE;AAED,YAAA,OAAO,MAAM,CAAA;AACf,SAAC,CAAA;KACF;AA+YF;;;;"}

package/types/algorand-client.d.ts

@@ -1,19 +1,23 @@
 import algosdk from 'algosdk';
-import { TransactionSignerAccount } from './account';
+import { MultisigAccount, SigningAccount, TransactionSignerAccount } from './account';
 import { AccountManager } from './account-manager';
+import { AlgorandClientTransactionCreator } from './algorand-client-transaction-creator';
+import { AlgorandClientTransactionSender } from './algorand-client-transaction-sender';
+import { AssetManager } from './asset-manager';
 import { AlgoSdkClients, ClientManager } from './client-manager';
-import AlgokitComposer, { ExecuteParams, MethodCallParams } from './composer';
+import AlgoKitComposer from './composer';
 import { AlgoConfig } from './network-client';
-import { ConfirmedTransactionResult, SendAtomicTransactionComposerResults, SendTransactionFrom } from './transaction';
-import Transaction = algosdk.Transaction;
-/** Result from sending a single transaction. */
-export type SendSingleTransactionResult = SendAtomicTransactionComposerResults & ConfirmedTransactionResult;
+import Account = algosdk.Account;
+import LogicSigAccount = algosdk.LogicSigAccount;
 /**
  * A client that brokers easy access to Algorand functionality.
  */
 export declare class AlgorandClient {
     private _clientManager;
     private _accountManager;
+    private _assetManager;
+    private _transactionSender;
+    private _transactionCreator;
     private _cachedSuggestedParams?;
     private _cachedSuggestedParamsExpiry?;
     private _cachedSuggestedParamsTimeout;
@@ -33,10 +37,20 @@ export declare class AlgorandClient {
     setDefaultSigner(signer: algosdk.TransactionSigner | TransactionSignerAccount): AlgorandClient;
     /**
      * Tracks the given account for later signing.
-     * @param account The account to register
+     * @param account The account to register, which can be a `TransactionSignerAccount` or
+     *  a `algosdk.Account`, `algosdk.LogicSigAccount`, `SigningAccount` or `MultisigAccount`
+     * @example
+     * ```typescript
+     * const accountManager = AlgorandClient.mainnet()
+     *  .setSignerFromAccount(algosdk.generateAccount())
+     *  .setSignerFromAccount(new algosdk.LogicSigAccount(program, args))
+     *  .setSignerFromAccount(new SigningAccount(mnemonic, sender))
+     *  .setSignerFromAccount(new MultisigAccount({version: 1, threshold: 1, addrs: ["ADDRESS1...", "ADDRESS2..."]}, [account1, account2]))
+     *  .setSignerFromAccount({addr: "SENDERADDRESS", signer: transactionSigner})
+     * ```
      * @returns The `AlgorandClient` so method calls can be chained
      */
-    setSignerFromAccount(account: TransactionSignerAccount | SendTransactionFrom): this;
+    setSignerFromAccount(account: TransactionSignerAccount | TransactionSignerAccount | Account | LogicSigAccount | SigningAccount | MultisigAccount): this;
     /**
      * Tracks the given account for later signing.
      * @param sender The sender address to use this signer for
@@ -63,82 +77,18 @@ export declare class AlgorandClient {
     get client(): ClientManager;
     /** Get or create accounts that can sign transactions. */
     get account(): AccountManager;
-    /** Start a new `AlgokitComposer` transaction group */
-    newGroup(): AlgokitComposer;
-    private _send;
+    /** Methods for interacting with assets. */
+    get asset(): AssetManager;
+    /** Start a new `AlgoKitComposer` transaction group */
+    newGroup(): AlgoKitComposer;
     /**
      * Methods for sending a single transaction.
      */
-    send: {
-        /**
-         * Send a payment transaction.
-         */
-        payment: (params: import("./composer").PaymentParams, config?: ExecuteParams) => Promise<SendSingleTransactionResult>;
-        /**
-         * Create an asset.
-         */
-        assetCreate: (params: import("./composer").AssetCreateParams, config?: ExecuteParams) => Promise<SendSingleTransactionResult>;
-        /**
-         * Configure an existing asset.
-         */
-        assetConfig: (params: import("./composer").AssetConfigParams, config?: ExecuteParams) => Promise<SendSingleTransactionResult>;
-        /**
-         * Freeze or unfreeze an asset.
-         */
-        assetFreeze: (params: import("./composer").AssetFreezeParams, config?: ExecuteParams) => Promise<SendSingleTransactionResult>;
-        /**
-         * Destroy an asset.
-         */
-        assetDestroy: (params: import("./composer").AssetDestroyParams, config?: ExecuteParams) => Promise<SendSingleTransactionResult>;
-        /**
-         * Transfer an asset.
-         */
-        assetTransfer: (params: import("./composer").AssetTransferParams, config?: ExecuteParams) => Promise<SendSingleTransactionResult>;
-        /**
-         * Opt an account into an asset.
-         */
-        assetOptIn: (params: import("./composer").AssetOptInParams, config?: ExecuteParams) => Promise<SendSingleTransactionResult>;
-        /**
-         * Call a smart contract.
-         *
-         * Note: you may prefer to use `algorandClient.client` to get an app client for more advanced functionality.
-         */
-        appCall: (params: import("./composer").AppCallParams, config?: ExecuteParams) => Promise<SendSingleTransactionResult>;
-        /**
-         * Call a smart contract ABI method.
-         *
-         * Note: you may prefer to use `algorandClient.client` to get an app client for more advanced functionality.
-         */
-        methodCall: (params: MethodCallParams, config?: ExecuteParams) => Promise<SendSingleTransactionResult>;
-        /** Register an online key. */
-        onlineKeyRegistration: (params: import("./composer").OnlineKeyRegistrationParams, config?: ExecuteParams) => Promise<SendSingleTransactionResult>;
-    };
-    private _transaction;
+    get send(): AlgorandClientTransactionSender;
     /**
      * Methods for building transactions
      */
-    transactions: {
-        /** Create a payment transaction. */
-        payment: (params: import("./composer").PaymentParams) => Promise<Transaction>;
-        /** Create an asset creation transaction. */
-        assetCreate: (params: import("./composer").AssetCreateParams) => Promise<Transaction>;
-        /** Create an asset config transaction. */
-        assetConfig: (params: import("./composer").AssetConfigParams) => Promise<Transaction>;
-        /** Create an asset freeze transaction. */
-        assetFreeze: (params: import("./composer").AssetFreezeParams) => Promise<Transaction>;
-        /** Create an asset destroy transaction. */
-        assetDestroy: (params: import("./composer").AssetDestroyParams) => Promise<Transaction>;
-        /** Create an asset transfer transaction. */
-        assetTransfer: (params: import("./composer").AssetTransferParams) => Promise<Transaction>;
-        /** Create an asset opt-in transaction. */
-        assetOptIn: (params: import("./composer").AssetOptInParams) => Promise<Transaction>;
-        /** Create an application call transaction. */
-        appCall: (params: import("./composer").AppCallParams) => Promise<Transaction>;
-        /** Create an application call with ABI method call transaction. */
-        methodCall: (params: MethodCallParams) => Promise<algosdk.Transaction[]>;
-        /** Create an online key registration transaction. */
-        onlineKeyRegistration: (params: import("./composer").OnlineKeyRegistrationParams) => Promise<Transaction>;
-    };
+    get transactions(): AlgorandClientTransactionCreator;
     /**
      * Returns an `AlgorandClient` pointing at default LocalNet ports and API token.
      * @returns The `AlgorandClient`

package/types/algorand-client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"algorand-client.d.ts","sourceRoot":"","sources":["../../src/types/algorand-client.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAA;AAE7B,OAAO,EAAE,wBAAwB,EAAE,MAAM,WAAW,CAAA;AACpD,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAClD,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAA;AAChE,OAAO,eAAe,EAAE,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAA;AAC7E,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAC7C,OAAO,EAAE,0BAA0B,EAAE,oCAAoC,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAA;AACrH,OAAO,WAAW,GAAG,OAAO,CAAC,WAAW,CAAA;AAExC,gDAAgD;AAChD,MAAM,MAAM,2BAA2B,GAAG,oCAAoC,GAAG,0BAA0B,CAAA;AAE3G;;GAEG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,cAAc,CAAe;IACrC,OAAO,CAAC,eAAe,CAAgB;IAEvC,OAAO,CAAC,sBAAsB,CAAC,CAAyB;IACxD,OAAO,CAAC,4BAA4B,CAAC,CAAM;IAC3C,OAAO,CAAC,6BAA6B,CAAgB;IAErD,OAAO,CAAC,sBAAsB,CAAgC;IAE9D,OAAO;IAKP;;;;OAIG;IACI,wBAAwB,CAAC,cAAc,EAAE,MAAM;IAKtD;;;;OAIG;IACI,gBAAgB,CAAC,MAAM,EAAE,OAAO,CAAC,iBAAiB,GAAG,wBAAwB,GAAG,cAAc;IAKrG;;;;OAIG;IACI,oBAAoB,CAAC,OAAO,EAAE,wBAAwB,GAAG,mBAAmB;IAKnF;;;;;OAKG;IACI,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,iBAAiB;IAKlE;;;;;OAKG;IACI,kBAAkB,CAAC,eAAe,EAAE,OAAO,CAAC,eAAe,EAAE,KAAK,CAAC,EAAE,IAAI;IAMhF;;;;OAIG;IACI,yBAAyB,CAAC,OAAO,EAAE,MAAM;IAKhD,0GAA0G;IACpG,kBAAkB,IAAI,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC;IAe5D,8DAA8D;IAC9D,IAAW,MAAM,kBAEhB;IAED,yDAAyD;IACzD,IAAW,OAAO,mBAEjB;IAED,sDAAsD;IACtD,QAAQ;IASR,OAAO,CAAC,KAAK;IAmCb;;OAEG;IACH,IAAI;QACF;;WAEG;uEAnCmB,aAAa,KAAK,QAAQ,2BAA2B,CAAC;QAwC5E;;WAEG;+EA1CmB,aAAa,KAAK,QAAQ,2BAA2B,CAAC;QA+C5E;;WAEG;+EAjDmB,aAAa,KAAK,QAAQ,2BAA2B,CAAC;QAqD5E;;WAEG;+EAvDmB,aAAa,KAAK,QAAQ,2BAA2B,CAAC;QA2D5E;;WAEG;iFA7DmB,aAAa,KAAK,QAAQ,2BAA2B,CAAC;QAiE5E;;WAEG;mFAnEmB,aAAa,KAAK,QAAQ,2BAA2B,CAAC;QAwE5E;;WAEG;6EA1EmB,aAAa,KAAK,QAAQ,2BAA2B,CAAC;QA+E5E;;;;WAIG;uEAnFmB,aAAa,KAAK,QAAQ,2BAA2B,CAAC;QAqF5E;;;;WAIG;wDAzFmB,aAAa,KAAK,QAAQ,2BAA2B,CAAC;QA2F5E,8BAA8B;mGA3FR,aAAa,KAAK,QAAQ,2BAA2B,CAAC;MA+F7E;IAED,OAAO,CAAC,YAAY;IAQpB;;OAEG;IACH,YAAY;QACV,oCAAoC;iEAZ6D,QAAQ,WAAW,CAAC;QAcrH,4CAA4C;yEAdqD,QAAQ,WAAW,CAAC;QAgBrH,0CAA0C;yEAhBuD,QAAQ,WAAW,CAAC;QAkBrH,0CAA0C;yEAlBuD,QAAQ,WAAW,CAAC;QAoBrH,2CAA2C;2EApBsD,QAAQ,WAAW,CAAC;QAsBrH,4CAA4C;6EAtBqD,QAAQ,WAAW,CAAC;QAwBrH,0CAA0C;uEAxBuD,QAAQ,WAAW,CAAC;QA0BrH,8CAA8C;iEA1BmD,QAAQ,WAAW,CAAC;QA4BrH,mEAAmE;6BACxC,gBAAgB;QAG3C,qDAAqD;6FAhC4C,QAAQ,WAAW,CAAC;MAkCtH;IAID;;;OAGG;WACW,eAAe;IAQ7B;;;OAGG;WACW,OAAO;IAQrB;;;OAGG;WACW,OAAO;IAQrB;;;;OAIG;WACW,WAAW,CAAC,OAAO,EAAE,cAAc;IAIjD;;;;;;;;;;;;;;;;OAgBG;WACW,eAAe;IAI7B;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,UAAU;CAG5C;AAED,eAAe,cAAc,CAAA"}
+{"version":3,"file":"algorand-client.d.ts","sourceRoot":"","sources":["../../src/types/algorand-client.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAA;AAC7B,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,wBAAwB,EAAE,MAAM,WAAW,CAAA;AACrF,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAClD,OAAO,EAAE,gCAAgC,EAAE,MAAM,uCAAuC,CAAA;AACxF,OAAO,EAAE,+BAA+B,EAAE,MAAM,sCAAsC,CAAA;AACtF,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAC9C,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAA;AAChE,OAAO,eAAe,MAAM,YAAY,CAAA;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAC7C,OAAO,OAAO,GAAG,OAAO,CAAC,OAAO,CAAA;AAChC,OAAO,eAAe,GAAG,OAAO,CAAC,eAAe,CAAA;AAEhD;;GAEG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,cAAc,CAAe;IACrC,OAAO,CAAC,eAAe,CAAgB;IACvC,OAAO,CAAC,aAAa,CAAc;IACnC,OAAO,CAAC,kBAAkB,CAAiC;IAC3D,OAAO,CAAC,mBAAmB,CAAkC;IAE7D,OAAO,CAAC,sBAAsB,CAAC,CAAyB;IACxD,OAAO,CAAC,4BAA4B,CAAC,CAAM;IAC3C,OAAO,CAAC,6BAA6B,CAAgB;IAErD,OAAO,CAAC,sBAAsB,CAAgC;IAE9D,OAAO;IAQP;;;;OAIG;IACI,wBAAwB,CAAC,cAAc,EAAE,MAAM;IAKtD;;;;OAIG;IACI,gBAAgB,CAAC,MAAM,EAAE,OAAO,CAAC,iBAAiB,GAAG,wBAAwB,GAAG,cAAc;IAKrG;;;;;;;;;;;;;;OAcG;IACI,oBAAoB,CACzB,OAAO,EAAE,wBAAwB,GAAG,wBAAwB,GAAG,OAAO,GAAG,eAAe,GAAG,cAAc,GAAG,eAAe;IAM7H;;;;;OAKG;IACI,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,iBAAiB;IAKlE;;;;;OAKG;IACI,kBAAkB,CAAC,eAAe,EAAE,OAAO,CAAC,eAAe,EAAE,KAAK,CAAC,EAAE,IAAI;IAMhF;;;;OAIG;IACI,yBAAyB,CAAC,OAAO,EAAE,MAAM;IAKhD,0GAA0G;IAC7F,kBAAkB,IAAI,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC;IAenE,8DAA8D;IAC9D,IAAW,MAAM,kBAEhB;IAED,yDAAyD;IACzD,IAAW,OAAO,mBAEjB;IAED,2CAA2C;IAC3C,IAAW,KAAK,iBAEf;IAED,sDAAsD;IAC/C,QAAQ;IASf;;OAEG;IACH,IAAW,IAAI,oCAEd;IAED;;OAEG;IACH,IAAW,YAAY,qCAEtB;IAID;;;OAGG;WACW,eAAe;IAQ7B;;;OAGG;WACW,OAAO;IAQrB;;;OAGG;WACW,OAAO;IAQrB;;;;OAIG;WACW,WAAW,CAAC,OAAO,EAAE,cAAc;IAIjD;;;;;;;;;;;;;;;;OAgBG;WACW,eAAe;IAI7B;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,UAAU;CAG5C;AAED,eAAe,cAAc,CAAA"}