refactor: Rename AlgoKitComposer to TransactionComposer (#334)

* refactor: rename AlgoKitComposer to TransactionComposer * chore: update package json to cover `refactor` semantic commits
algorandfoundation · Oct 23, 2024 · 635a814 · 635a814
1 parent fad7040
commit 635a814
Show file tree

Hide file tree

Showing 29 changed files with 166 additions and 137 deletions.
diff --git a/docs/code/classes/types_algorand_client.AlgorandClient.md b/docs/code/classes/types_algorand_client.AlgorandClient.md
@@ -341,7 +341,7 @@ ___
 
 ▸ **newGroup**(): [`default`](types_composer.default.md)
 
-Start a new `AlgoKitComposer` transaction group
+Start a new `TransactionComposer` transaction group
 
 #### Returns
 

diff --git a/...s/types_algorand_client_transaction_creator.AlgorandClientTransactionCreator.md b/...s/types_algorand_client_transaction_creator.AlgorandClientTransactionCreator.md
@@ -50,7 +50,7 @@ Creates a new `AlgorandClientTransactionCreator`
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `newGroup` | () => [`default`](types_composer.default.md) | A lambda that starts a new `AlgoKitComposer` transaction group |
+| `newGroup` | () => [`default`](types_composer.default.md) | A lambda that starts a new `TransactionComposer` transaction group |
 
 #### Returns
 
@@ -140,7 +140,7 @@ await algorand.createTransaction.appCall({
 
 #### Defined in
 
-[src/types/algorand-client-transaction-creator.ts:470](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L470)
+[src/types/algorand-client-transaction-creator.ts:472](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L472)
 
 ___
 
@@ -216,7 +216,7 @@ await algorand.createTransaction.appCallMethodCall({
 
 #### Defined in
 
-[src/types/algorand-client-transaction-creator.ts:686](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L686)
+[src/types/algorand-client-transaction-creator.ts:688](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L688)
 
 ___
 
@@ -315,7 +315,7 @@ await algorand.createTransaction.appCreate({
 
 #### Defined in
 
-[src/types/algorand-client-transaction-creator.ts:351](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L351)
+[src/types/algorand-client-transaction-creator.ts:353](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L353)
 
 ___
 
@@ -401,7 +401,7 @@ await algorand.createTransaction.appCreate({
 
 #### Defined in
 
-[src/types/algorand-client-transaction-creator.ts:531](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L531)
+[src/types/algorand-client-transaction-creator.ts:533](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L533)
 
 ___
 
@@ -465,7 +465,7 @@ await algorand.createTransaction.appDelete({
 
 #### Defined in
 
-[src/types/algorand-client-transaction-creator.ts:431](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L431)
+[src/types/algorand-client-transaction-creator.ts:433](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L433)
 
 ___
 
@@ -541,7 +541,7 @@ await algorand.createTransaction.appDeleteMethodCall({
 
 #### Defined in
 
-[src/types/algorand-client-transaction-creator.ts:635](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L635)
+[src/types/algorand-client-transaction-creator.ts:637](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L637)
 
 ___
 
@@ -627,7 +627,7 @@ await algorand.createTransaction.appUpdate({
 
 #### Defined in
 
-[src/types/algorand-client-transaction-creator.ts:392](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L392)
+[src/types/algorand-client-transaction-creator.ts:394](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L394)
 
 ___
 
@@ -705,7 +705,7 @@ await algorand.createTransaction.appUpdateMethodCall({
 
 #### Defined in
 
-[src/types/algorand-client-transaction-creator.ts:584](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L584)
+[src/types/algorand-client-transaction-creator.ts:586](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L586)
 
 ___
 
@@ -764,7 +764,7 @@ await algorand.createTransaction.assetConfig({
 
 #### Defined in
 
-[src/types/algorand-client-transaction-creator.ts:146](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L146)
+[src/types/algorand-client-transaction-creator.ts:148](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L148)
 
 ___
 
@@ -828,7 +828,7 @@ await algorand.createTransaction.assetCreate({
 
 #### Defined in
 
-[src/types/algorand-client-transaction-creator.ts:110](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L110)
+[src/types/algorand-client-transaction-creator.ts:112](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L112)
 
 ___
 
@@ -883,7 +883,7 @@ await algorand.createTransaction.assetDestroy({
 
 #### Defined in
 
-[src/types/algorand-client-transaction-creator.ts:208](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L208)
+[src/types/algorand-client-transaction-creator.ts:210](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L210)
 
 ___
 
@@ -936,7 +936,7 @@ await algorand.createTransaction.assetFreeze({
 
 #### Defined in
 
-[src/types/algorand-client-transaction-creator.ts:176](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L176)
+[src/types/algorand-client-transaction-creator.ts:178](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L178)
 
 ___
 
@@ -987,7 +987,7 @@ await algorand.createTransaction.assetOptIn({
 
 #### Defined in
 
-[src/types/algorand-client-transaction-creator.ts:269](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L269)
+[src/types/algorand-client-transaction-creator.ts:271](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L271)
 
 ___
 
@@ -1043,7 +1043,7 @@ await algorand.createTransaction.assetOptIn({
 
 #### Defined in
 
-[src/types/algorand-client-transaction-creator.ts:302](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L302)
+[src/types/algorand-client-transaction-creator.ts:304](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L304)
 
 ___
 
@@ -1099,7 +1099,7 @@ await algorand.createTransaction.assetTransfer({
 
 #### Defined in
 
-[src/types/algorand-client-transaction-creator.ts:241](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L241)
+[src/types/algorand-client-transaction-creator.ts:243](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L243)
 
 ___
 
@@ -1125,7 +1125,7 @@ Create an online key registration transaction.
 
 #### Defined in
 
-[src/types/algorand-client-transaction-creator.ts:688](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L688)
+[src/types/algorand-client-transaction-creator.ts:690](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L690)
 
 ___
 
@@ -1184,7 +1184,7 @@ const result = await algorand.send.payment({
 
 #### Defined in
 
-[src/types/algorand-client-transaction-creator.ts:69](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L69)
+[src/types/algorand-client-transaction-creator.ts:71](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L71)
 
 ## Methods
 

diff --git a/...ses/types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md b/...ses/types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md
@@ -55,7 +55,7 @@ Creates a new `AlgorandClientSender`
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `newGroup` | () => [`default`](types_composer.default.md) | A lambda that starts a new `AlgoKitComposer` transaction group |
+| `newGroup` | () => [`default`](types_composer.default.md) | A lambda that starts a new `TransactionComposer` transaction group |
 | `assetManager` | [`AssetManager`](types_asset_manager.AssetManager.md) | An `AssetManager` instance |
 | `appManager` | [`AppManager`](types_app_manager.AppManager.md) | - |
 

diff --git a/docs/code/classes/types_app_client.AppClient.md b/docs/code/classes/types_app_client.AppClient.md
@@ -1137,7 +1137,7 @@ ___
 
 ▸ **newGroup**(): [`default`](types_composer.default.md)
 
-Start a new `AlgoKitComposer` transaction group
+Start a new `TransactionComposer` transaction group
 
 #### Returns
 

diff --git a/docs/code/classes/types_asset_manager.AssetManager.md b/docs/code/classes/types_asset_manager.AssetManager.md
@@ -37,7 +37,7 @@ Create a new asset manager.
 | Name | Type | Description |
 | :------ | :------ | :------ |
 | `algod` | `default` | An algod client |
-| `newGroup` | () => [`default`](types_composer.default.md) | A function that creates a new `AlgoKitComposer` transaction group |
+| `newGroup` | () => [`default`](types_composer.default.md) | A function that creates a new `TransactionComposer` transaction group |
 
 #### Returns
 
@@ -46,7 +46,7 @@ Create a new asset manager.
 **`Example`**
 
 ```typescript
-const assetManager = new AssetManager(algod, () => new AlgoKitComposer({algod, () => signer, () => suggestedParams}))
+const assetManager = new AssetManager(algod, () => new TransactionComposer({algod, () => signer, () => suggestedParams}))
 ```
 
 #### Defined in

diff --git a/docs/code/classes/types_composer.default.md b/docs/code/classes/types_composer.default.md
@@ -74,13 +74,13 @@ AlgoKit Composer helps you compose and execute transactions as a transaction gro
 
 • **new default**(`params`): [`default`](types_composer.default.md)
 
-Create an `AlgoKitComposer`.
+Create an `TransactionComposer`.
 
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `params` | [`AlgoKitComposerParams`](../modules/types_composer.md#algokitcomposerparams) | The configuration for this composer |
+| `params` | [`TransactionComposerParams`](../modules/types_composer.md#transactioncomposerparams) | The configuration for this composer |
 
 #### Returns
 

diff --git a/docs/code/interfaces/types_app.CreateAppParams.md b/docs/code/interfaces/types_app.CreateAppParams.md
@@ -6,7 +6,7 @@
 
 **`Deprecated`**
 
-Use `AlgoKitComposer` to construct create app transactions instead.
+Use `TransactionComposer` to construct create app transactions instead.
 
 Parameters that are passed in when creating an app.
 

diff --git a/docs/code/interfaces/types_app.UpdateAppParams.md b/docs/code/interfaces/types_app.UpdateAppParams.md
@@ -6,7 +6,7 @@
 
 **`Deprecated`**
 
-Use `AlgoKitComposer` to construct update app transactions instead.
+Use `TransactionComposer` to construct update app transactions instead.
 
 Parameters that are passed in when updating an app.
 

diff --git a/docs/code/interfaces/types_composer.BuiltTransactions.md b/docs/code/interfaces/types_composer.BuiltTransactions.md
@@ -4,7 +4,7 @@
 
 [types/composer](../modules/types_composer.md).BuiltTransactions
 
-Set of transactions built by `AlgoKitComposer`.
+Set of transactions built by `TransactionComposer`.
 
 ## Table of contents
 

diff --git a/docs/code/modules/index.md b/docs/code/modules/index.md
@@ -549,7 +549,7 @@ ___
 
 **`Deprecated`**
 
-Use `AlgoKitComposer` and the `maxFee` field in the transaction params instead.
+Use `TransactionComposer` and the `maxFee` field in the transaction params instead.
 
 Limit the acceptable fee to a defined amount of µAlgo.
 This also sets the transaction to be flatFee to ensure the transaction only succeeds at
@@ -615,7 +615,7 @@ ___
 
 **`Deprecated`**
 
-Use `AlgoKitComposer` and the `maxFee` and `staticFee` fields in the transaction params instead.
+Use `TransactionComposer` and the `maxFee` and `staticFee` fields in the transaction params instead.
 
 Allows for control of fees on a `Transaction` or `SuggestedParams` object
 
@@ -822,7 +822,7 @@ the transaction note ready for inclusion in a transaction
 
 **`Deprecated`**
 
-Convert your data to a `string` or `Uint8Array`, if using ARC-2 use `AlgoKitComposer.arc2Note`.
+Convert your data to a `string` or `Uint8Array`, if using ARC-2 use `TransactionComposer.arc2Note`.
 
 Encodes a transaction note into a byte array ready to be included in an Algorand transaction.
 
@@ -1427,7 +1427,7 @@ The parameters ready to pass into `addMethodCall` within AtomicTransactionCompos
 
 **`Deprecated`**
 
-Use `AlgoKitComposer` methods to construct transactions instead.
+Use `TransactionComposer` methods to construct transactions instead.
 
 Returns the app args ready to load onto an ABI method call in `AtomicTransactionComposer`
 
@@ -1455,7 +1455,7 @@ The args ready to load into a `Transaction`
 
 **`Deprecated`**
 
-Use `AlgoKitComposer` methods to construct transactions instead.
+Use `TransactionComposer` methods to construct transactions instead.
 
 Returns the app args ready to load onto an app `Transaction` object
 
@@ -2341,7 +2341,7 @@ A TransactionWithSigner object.
 
 **`Deprecated`**
 
-Use `AlgorandClient` / `AlgoKitComposer` to construct transactions instead or
+Use `AlgorandClient` / `TransactionComposer` to construct transactions instead or
 construct an `algosdk.TransactionWithSigner` manually instead.
 
 Given a transaction in a variety of supported formats, returns a TransactionWithSigner object ready to be passed to an
@@ -2951,7 +2951,7 @@ An object with transaction IDs, transactions, group transaction ID (`groupTransa
 
 **`Deprecated`**
 
-Use `AlgoKitComposer` (`algorand.newGroup()`) or `AtomicTransactionComposer` to construct and send group transactions instead.
+Use `TransactionComposer` (`algorand.newGroup()`) or `AtomicTransactionComposer` to construct and send group transactions instead.
 
 Signs and sends a group of [up to 16](https://developer.algorand.org/docs/get-details/atomic_transfers/#create-transactions) transactions to the chain
 
@@ -2983,7 +2983,7 @@ An object with transaction (`transaction`) and (if `skipWaiting` is `false` or `
 
 **`Deprecated`**
 
-Use `AlgorandClient` / `AlgoKitComposer` to send transactions.
+Use `AlgorandClient` / `TransactionComposer` to send transactions.
 
 Prepares a transaction for sending and then (if instructed) signs and sends the given transaction to the chain.
 
@@ -3012,7 +3012,7 @@ The signed transaction as a `Uint8Array`
 
 **`Deprecated`**
 
-Use `AlgorandClient` / `AlgoKitComposer` to sign transactions
+Use `AlgorandClient` / `TransactionComposer` to sign transactions
 or use the relevant underlying `account.signTxn` / `algosdk.signLogicSigTransactionObject`
 / `multiSigAccount.sign` / `TransactionSigner` methods directly.