Releases: algorandfoundation/algokit-utils-ts
Releases · algorandfoundation/algokit-utils-ts
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
onAlgoKitComposer
now returns ABI method call objects for transactions that had them so you can resolve ABI return values
New functionality
AppManager
class andalgorand.app
AppDeployer
class andalgorand.appDeployer
AlgoKitComposer.arc2Note
to allow constructing an ARC-2 transaction notecount
method inAlgoKitComposer
to support retrieving current number of transactionsbuildTransactions
method inAlgoKitComposer
to support building transactions without needing a signer present and switched to using that fromalgorand.transactions
- Added support for
populateAppCallResources
toAlgoKitComposer
algorand.client.indexerIfPresent
so you can optionally retrieve indexer if it's presentalgorand.send/transactions.{appMethods}
for the following methods:appCreate
,appCreateMethodCall
,appUpdate
,appUpdateMethodCall
,appDelete
,appDeleteMethodCall
,appCall
,appCallMethodCall
and correspondingaddX
methods inAlgoKitComposer
/algorand.newGroup()
- TEAL compilation caching (within
AppManager
instance) - AppLookup caching (within
AppDeployer
instance)
⚠ BREAKING CHANGES
v7.0.0-beta.1
7.0.0-beta.1 (2024-08-28)
⚠ BREAKING CHANGES
- Renamed
AlgokitComposer
toAlgoKitComposer
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 berekeyed(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 anAlgoAmount
, renamedamount
tobalance
andround
tovalidAsOfRound
(which is now abigint
for broader consistency) - Renamed
algorand.account.getAssetInformation
toalgorand.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 andalgorand.asset.getById()
,algorand.asset.bulkOptIn
, andalgorand.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 toAlgoKitComposer
so you can build transactions without needing to register a signer - Added
.algo
and.microAlgo
methods/properties in place of the plural version forAlgoAmount
to reflect the current guidance on how to represent Algo amounts, kept previous versions of those methods for now to avoid the breaking change
- Return value of
- 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