v7.0.0-beta.2

7.0.0-beta.2 (2024-09-04)

Deprecations

• createApp -> algorand.send.appCreate() / algorand.transactions.appCreate() / algorand.send.appCreateMethodCall() / algorand.transactions.appCreateMethodCall()
• updateApp -> algorand.send.appUpdate() / algorand.transactions.appUpdate() / algorand.send.appUpdateMethodCall() / algorand.transactions.appUpdateMethodCall()
• callApp -> algorand.send.appUpdate() / algorand.transactions.appUpdate() / algorand.send.appUpdateMethodCall() / algorand.transactions.appUpdateMethodCall()
• deployApp -> algorand.appDeployer.deploy
• getCreatorAppsByName -> algorand.appDeployer.getCreatorAppsByName
• getABIReturn -> AppManager.getABIReturn
• getAppGlobalState -> (await appManager.getById(appId)).globalState
• getAppLocalState -> algorand.app.getLocalState
• getAppBoxNames -> algorand.app.getBoxNames
• getAppBoxValue -> algorand.app.getBoxValue
• getAppBoxValues -> algorand.app.getBoxValues
• getAppBoxValueFromABIType -> algorand.app.getAppBoxValueFromABIType
• getBoxValueFromABIType -> algorand.app.getAppBoxValuesFromABIType
• decodeAppState -> AppManager.decodeAppState
• getBoxReference -> AppManager.getBoxReference
• getAppById -> algorand.app.getById
• compileTeal -> algorand.app.compileTeal
• performTemplateSubstitutionAndCompile -> algorand.appManager.compileTealTemplate
• replaceDeployTimeControlParams -> AppManager.replaceTealTemplateDeployTimeControlParams
• performTemplateSubstitution -> AppManager.replaceTealTemplateParams
• stripTealComments -> AppManager.stripTealComments
• getAppOnCompleteAction -> algosdk.OnApplicationComplete
• getABIMethodSignature -> abiMethod.getSignature() / new ABIMethod(abiMethodParams).getSignature()
• getAppArgsForTransaction
• getAppArgsForABICall
• isSchemaIsBroken
• getAppDeploymentTransactionNote

Updates

• Fixed numerous bugs in AlgoKitComposer related to handling app call transactions
• build on AlgoKitComposer now returns ABI method call objects for transactions that had them so you can resolve ABI return values

New functionality

• AppManager class and algorand.app
• AppDeployer class and algorand.appDeployer
• AlgoKitComposer.arc2Note to allow constructing an ARC-2 transaction note
• count method in AlgoKitComposer to support retrieving current number of transactions
• buildTransactions method in AlgoKitComposer to support building transactions without needing a signer present and switched to using that from algorand.transactions
• Added support for populateAppCallResources to AlgoKitComposer
• algorand.client.indexerIfPresent so you can optionally retrieve indexer if it's present
• algorand.send/transactions.{appMethods} for the following methods: appCreate, appCreateMethodCall, appUpdate, appUpdateMethodCall, appDelete, appDeleteMethodCall, appCall, appCallMethodCall and corresponding addX methods in AlgoKitComposer / algorand.newGroup()
• TEAL compilation caching (within AppManager instance)
• AppLookup caching (within AppDeployer instance)

⚠ BREAKING CHANGES

• Renamed clearProgram to clearStateProgram and extraPages to extraProgramPages in AlgoKitComposer to match algod api

• App deprecation (#310) (41d8df1), closes #310

v7.0.0-beta.1

7.0.0-beta.1 (2024-08-28)

⚠ BREAKING CHANGES

• Renamed AlgokitComposer to AlgoKitComposer to match AlgoKit naming conventions
• Collapsed the second object in algorand.send.type(params, executeOptions) to combine into params and make it easier to use based on devrel feedback
• Order of algorand.account.rekeyed() parameters to be rekeyed(sender, signer) since it conceptually makes more sense (the sender is rekeyed so should come first)
• All microAlgo return values from algorand.account.getInformation() now return an AlgoAmount, renamed amount to balance and round to validAsOfRound (which is now a bigint for broader consistency)
• Renamed algorand.account.getAssetInformation to algorand.asset.getAccountInformation

Features

• Deprecate transfer and asset modules (#291) (b2c0f91)
• Added:
  • Return value of algorand.send.assetCreate now includes { assetId: bigint }
  • Up to date documentation for rekeyAccount, AlgorandClient, asset, dispenser client, indexer, testing, transfer
  • Up to date documentation for how to refer to an Algo amount (Algo (not plural) in general and ALGO (not plural) when referring to a specific amount)
  • AssetManager class and algorand.asset.getById(), algorand.asset.bulkOptIn, and algorand.asset.bulkOptOut
  • indexer export off of @algorandfoundation/algokit-utils as the future home of all indexer methods
  • Added algorand.client.getTestNetDispenserFromEnvironment
  • Added algorand.account.assetBulkOptIn
  • Added algorand.account.assetBulkOptOut
  • Added algorand.account.ensureFunded
  • Added algorand.account.ensureFundedFromEnvironment
  • Added algorand.account.ensureFundedFromTestNetDispenserApi
  • Added algorand.account.rekeyAccount
  • Added algorand.send/transaction.assetOptOut
  • Added buildTransactions method to AlgoKitComposer so you can build transactions without needing to register a signer
  • Added .algo and .microAlgo methods/properties in place of the plural version for AlgoAmount to reflect the current guidance on how to represent Algo amounts, kept previous versions of those methods for now to avoid the breaking change
• Deprecated the following in favour of AlgorandClient functionality:
  • algokit.createAsset
  • algokit.assetOptIn
  • algokit.assetOptOut
  • algokit.assetBulkOptIn
  • algokit.assetBulkOptOut
  • algokit.ensureFunded
  • algokit.transferAsset
  • algokit.rekeyAccount
  • algokit.transferAlgos

v6.2.1

6.2.1 (2024-08-19)

Bug Fixes

• resolve kmd configuration when running on localnet to maintain previous behaviour (#308) (4fda89c)

v6.2.1-beta.1

6.2.1-beta.1 (2024-08-19)

Bug Fixes

• resolve kmd configuration when running on localnet to maintain previous behaviour (#308) (4fda89c)

v6.2.0

6.2.0 (2024-08-09)

Features

• allow bytes substitution for uint64 template vars (#306) (138ae68)

Bug Fixes

• correct resolve asset frozen boolean (#305) (3830657)

v6.2.0-beta.1

6.2.0-beta.1 (2024-08-09)

Features

• allow bytes substitution for uint64 template vars (#306) (138ae68)

v6.1.3-beta.1

6.1.3-beta.1 (2024-08-09)

Bug Fixes

• correct resolve asset frozen boolean (#305) (3830657)

v6.1.2

6.1.2 (2024-07-22)

Bug Fixes

• match the previous getTestAccount behaviour when no kmd client is supplied (#303) (77bc079)

v6.1.2-beta.1

6.1.2-beta.1 (2024-07-22)

Bug Fixes

• match the previous getTestAccount behaviour when no kmd client is supplied (#303) (77bc079)

v6.1.1

6.1.1 (2024-07-19)

Bug Fixes

• Ensuring that transactions issued by AlgoKit Composer to LocalNet don't have too short a validity window (#300) (edce1ad)

Changes

• Re-add the pre 6.1.0 getTestAccount signature for backwards compatibility (#302) (8c00f21)