wip - pr feedback

Author: PatrickDinh

src/transactions/asset.ts renamed to src/transactions/asset-config.ts

@@ -185,45 +185,6 @@ export type AssetDestroyParams = CommonTransactionParams & {
   assetId: bigint
 }
 
-/** Parameters to define an asset transfer transaction. */
-export type AssetTransferParams = CommonTransactionParams & {
-  /** ID of the asset to transfer. */
-  assetId: bigint
-  /** Amount of the asset to transfer (in smallest divisible (decimal) units). */
-  amount: bigint
-  /** The address of the account that will receive the asset unit(s). */
-  receiver: string | Address
-  /** Optional address of an account to clawback the asset from.
-   *
-   * Requires the sender to be the clawback account.
-   *
-   * **Warning:** Be careful with this parameter as it can lead to unexpected loss of funds if not used correctly.
-   */
-  clawbackTarget?: string | Address
-  /** Optional address of an account to close the asset position to.
-   *
-   * **Warning:** Be careful with this parameter as it can lead to loss of funds if not used correctly.
-   */
-  closeAssetTo?: string | Address
-}
-
-/** Parameters to define an asset opt-in transaction. */
-export type AssetOptInParams = CommonTransactionParams & {
-  /** ID of the asset that will be opted-in to. */
-  assetId: bigint
-}
-
-/** Parameters to define an asset opt-out transaction. */
-export type AssetOptOutParams = CommonTransactionParams & {
-  /** ID of the asset that will be opted-out of. */
-  assetId: bigint
-  /**
-   * The address of the asset creator account to close the asset
-   *   position to (any remaining asset units will be sent to this account).
-   */
-  creator: string | Address
-}
-
 export const buildAssetCreate = (params: AssetCreateParams, header: TransactionHeader): Transaction => {
   return {
     ...header,
@@ -280,42 +241,3 @@ export const buildAssetDestroy = (params: AssetDestroyParams, header: Transactio
     },
   }
 }
-
-export const buildAssetTransfer = (params: AssetTransferParams, header: TransactionHeader): Transaction => {
-  return {
-    ...header,
-    type: TransactionType.AssetTransfer,
-    assetTransfer: {
-      assetId: params.assetId,
-      amount: params.amount,
-      receiver: params.receiver.toString(),
-      assetSender: params.clawbackTarget?.toString(),
-      closeRemainderTo: params.closeAssetTo?.toString(),
-    },
-  }
-}
-
-export const buildAssetOptIn = (params: AssetOptInParams, header: TransactionHeader): Transaction => {
-  return {
-    ...header,
-    type: TransactionType.AssetTransfer,
-    assetTransfer: {
-      assetId: params.assetId,
-      amount: 0n,
-      receiver: header.sender,
-    },
-  }
-}
-
-export const buildAssetOptOut = (params: AssetOptOutParams, header: TransactionHeader): Transaction => {
-  return {
-    ...header,
-    type: TransactionType.AssetTransfer,
-    assetTransfer: {
-      assetId: params.assetId,
-      amount: 0n,
-      receiver: header.sender,
-      closeRemainderTo: params.creator?.toString(),
-    },
-  }
-}

src/transactions/asset-transfer.ts

@@ -0,0 +1,81 @@
+import { Transaction, TransactionType } from '@algorandfoundation/algokit-transact'
+import { Address } from '@algorandfoundation/sdk'
+import { CommonTransactionParams, TransactionHeader } from './common'
+
+/** Parameters to define an asset transfer transaction. */
+export type AssetTransferParams = CommonTransactionParams & {
+  /** ID of the asset to transfer. */
+  assetId: bigint
+  /** Amount of the asset to transfer (in smallest divisible (decimal) units). */
+  amount: bigint
+  /** The address of the account that will receive the asset unit(s). */
+  receiver: string | Address
+  /** Optional address of an account to clawback the asset from.
+   *
+   * Requires the sender to be the clawback account.
+   *
+   * **Warning:** Be careful with this parameter as it can lead to unexpected loss of funds if not used correctly.
+   */
+  clawbackTarget?: string | Address
+  /** Optional address of an account to close the asset position to.
+   *
+   * **Warning:** Be careful with this parameter as it can lead to loss of funds if not used correctly.
+   */
+  closeAssetTo?: string | Address
+}
+
+/** Parameters to define an asset opt-in transaction. */
+export type AssetOptInParams = CommonTransactionParams & {
+  /** ID of the asset that will be opted-in to. */
+  assetId: bigint
+}
+
+/** Parameters to define an asset opt-out transaction. */
+export type AssetOptOutParams = CommonTransactionParams & {
+  /** ID of the asset that will be opted-out of. */
+  assetId: bigint
+  /**
+   * The address of the asset creator account to close the asset
+   *   position to (any remaining asset units will be sent to this account).
+   */
+  creator: string | Address
+}
+
+export const buildAssetTransfer = (params: AssetTransferParams, header: TransactionHeader): Transaction => {
+  return {
+    ...header,
+    type: TransactionType.AssetTransfer,
+    assetTransfer: {
+      assetId: params.assetId,
+      amount: params.amount,
+      receiver: params.receiver.toString(),
+      assetSender: params.clawbackTarget?.toString(),
+      closeRemainderTo: params.closeAssetTo?.toString(),
+    },
+  }
+}
+
+export const buildAssetOptIn = (params: AssetOptInParams, header: TransactionHeader): Transaction => {
+  return {
+    ...header,
+    type: TransactionType.AssetTransfer,
+    assetTransfer: {
+      assetId: params.assetId,
+      amount: 0n,
+      receiver: header.sender,
+    },
+  }
+}
+
+export const buildAssetOptOut = (params: AssetOptOutParams, header: TransactionHeader): Transaction => {
+  return {
+    ...header,
+    type: TransactionType.AssetTransfer,
+    assetTransfer: {
+      assetId: params.assetId,
+      amount: 0n,
+      receiver: header.sender,
+      closeRemainderTo: params.creator?.toString(),
+    },
+  }
+}

src/types/app-client.ts

@@ -2160,7 +2160,7 @@ export class ApplicationClient {
       call?.method &&
       // We aren't skipping the send
       !call.sendParams?.skipSending &&
-      // There isn't an composer passed in
+      // There isn't a composer passed in
       !call.sendParams?.transactionComposer &&
       // The method is readonly
       this.appSpec.hints?.[this.getABIMethodSignature(this.getABIMethod(call.method)!)]?.read_only

src/types/composer.ts

@@ -39,22 +39,25 @@ import {
   type AppDeleteParams,
   type AppUpdateParams,
 } from '../transactions/app-call'
+import {
+  buildAssetOptIn,
+  buildAssetOptOut,
+  buildAssetTransfer,
+  type AssetOptInParams,
+  type AssetOptOutParams,
+  type AssetTransferParams,
+} from '../transactions/asset-transfer'
+
 import {
   buildAssetConfig,
   buildAssetCreate,
   buildAssetDestroy,
   buildAssetFreeze,
-  buildAssetOptIn,
-  buildAssetOptOut,
-  buildAssetTransfer,
   type AssetConfigParams,
   type AssetCreateParams,
   type AssetDestroyParams,
   type AssetFreezeParams,
-  type AssetOptInParams,
-  type AssetOptOutParams,
-  type AssetTransferParams,
-} from '../transactions/asset'
+} from '../transactions/asset-config'
 import { deepCloneTransactionParams } from '../transactions/clone'
 import { buildTransactionHeader, calculateInnerFeeDelta, getDefaultValidityWindow } from '../transactions/common'
 import { buildKeyReg, type OfflineKeyRegistrationParams, type OnlineKeyRegistrationParams } from '../transactions/key-registration'
@@ -101,15 +104,8 @@ export type {
   AppUpdateParams,
   CommonAppCallParams,
 } from '../transactions/app-call'
-export type {
-  AssetConfigParams,
-  AssetCreateParams,
-  AssetDestroyParams,
-  AssetFreezeParams,
-  AssetOptInParams,
-  AssetOptOutParams,
-  AssetTransferParams,
-} from '../transactions/asset'
+export type { AssetConfigParams, AssetCreateParams, AssetDestroyParams, AssetFreezeParams } from '../transactions/asset-config'
+export type { AssetOptInParams, AssetOptOutParams, AssetTransferParams } from '../transactions/asset-transfer'
 export type { CommonTransactionParams } from '../transactions/common'
 export type { OfflineKeyRegistrationParams, OnlineKeyRegistrationParams } from '../transactions/key-registration'
 export type {