Skip to content

Commit 867be62

Browse files
Merge main into release
2 parents c1c8f5f + 1df9623 commit 867be62

29 files changed

+2289
-357
lines changed

docs/code/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,14 @@
3636
- [types/client-manager](modules/types_client_manager.md)
3737
- [types/client-manager.spec](modules/types_client_manager_spec.md)
3838
- [types/composer](modules/types_composer.md)
39+
- [types/composer.spec](modules/types_composer_spec.md)
3940
- [types/config](modules/types_config.md)
4041
- [types/debugging](modules/types_debugging.md)
4142
- [types/dispenser-client](modules/types_dispenser_client.md)
4243
- [types/dispenser-client.spec](modules/types_dispenser_client_spec.md)
4344
- [types/expand](modules/types_expand.md)
4445
- [types/indexer](modules/types_indexer.md)
46+
- [types/instance-of](modules/types_instance_of.md)
4547
- [types/kmd-account-manager](modules/types_kmd_account_manager.md)
4648
- [types/lifecycle-events](modules/types_lifecycle_events.md)
4749
- [types/logging](modules/types_logging.md)

docs/code/classes/types_algorand_client.AlgorandClient.md

Lines changed: 82 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ A client that brokers easy access to Algorand functionality.
2323
- [\_cachedSuggestedParamsTimeout](types_algorand_client.AlgorandClient.md#_cachedsuggestedparamstimeout)
2424
- [\_clientManager](types_algorand_client.AlgorandClient.md#_clientmanager)
2525
- [\_defaultValidityWindow](types_algorand_client.AlgorandClient.md#_defaultvaliditywindow)
26+
- [\_errorTransformers](types_algorand_client.AlgorandClient.md#_errortransformers)
2627
- [\_transactionCreator](types_algorand_client.AlgorandClient.md#_transactioncreator)
2728
- [\_transactionSender](types_algorand_client.AlgorandClient.md#_transactionsender)
2829

@@ -40,12 +41,14 @@ A client that brokers easy access to Algorand functionality.
4041

4142
- [getSuggestedParams](types_algorand_client.AlgorandClient.md#getsuggestedparams)
4243
- [newGroup](types_algorand_client.AlgorandClient.md#newgroup)
44+
- [registerErrorTransformer](types_algorand_client.AlgorandClient.md#registererrortransformer)
4345
- [setDefaultSigner](types_algorand_client.AlgorandClient.md#setdefaultsigner)
4446
- [setDefaultValidityWindow](types_algorand_client.AlgorandClient.md#setdefaultvaliditywindow)
4547
- [setSigner](types_algorand_client.AlgorandClient.md#setsigner)
4648
- [setSignerFromAccount](types_algorand_client.AlgorandClient.md#setsignerfromaccount)
4749
- [setSuggestedParamsCache](types_algorand_client.AlgorandClient.md#setsuggestedparamscache)
4850
- [setSuggestedParamsCacheTimeout](types_algorand_client.AlgorandClient.md#setsuggestedparamscachetimeout)
51+
- [unregisterErrorTransformer](types_algorand_client.AlgorandClient.md#unregistererrortransformer)
4952
- [defaultLocalNet](types_algorand_client.AlgorandClient.md#defaultlocalnet)
5053
- [fromClients](types_algorand_client.AlgorandClient.md#fromclients)
5154
- [fromConfig](types_algorand_client.AlgorandClient.md#fromconfig)
@@ -71,7 +74,7 @@ A client that brokers easy access to Algorand functionality.
7174

7275
#### Defined in
7376

74-
[src/types/algorand-client.ts:33](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L33)
77+
[src/types/algorand-client.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L40)
7578

7679
## Properties
7780

@@ -165,6 +168,20 @@ ___
165168

166169
___
167170

171+
### \_errorTransformers
172+
173+
`Private` **\_errorTransformers**: `Set`\<[`ErrorTransformer`](../modules/types_composer.md#errortransformer)\>
174+
175+
A set of error transformers to use when an error is caught in simulate or execute
176+
`registerErrorTransformer` and `unregisterErrorTransformer` can be used to add and remove
177+
error transformers from the set.
178+
179+
#### Defined in
180+
181+
[src/types/algorand-client.ts:38](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L38)
182+
183+
___
184+
168185
### \_transactionCreator
169186

170187
`Private` **\_transactionCreator**: [`AlgorandClientTransactionCreator`](types_algorand_client_transaction_creator.AlgorandClientTransactionCreator.md)
@@ -205,7 +222,7 @@ const accountManager = AlgorandClient.mainNet().account;
205222

206223
#### Defined in
207224

208-
[src/types/algorand-client.ts:175](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L175)
225+
[src/types/algorand-client.ts:182](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L182)
209226

210227
___
211228

@@ -229,7 +246,7 @@ const appManager = AlgorandClient.mainNet().app;
229246

230247
#### Defined in
231248

232-
[src/types/algorand-client.ts:195](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L195)
249+
[src/types/algorand-client.ts:202](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L202)
233250

234251
___
235252

@@ -253,7 +270,7 @@ const deployer = AlgorandClient.mainNet().appDeployer;
253270

254271
#### Defined in
255272

256-
[src/types/algorand-client.ts:205](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L205)
273+
[src/types/algorand-client.ts:212](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L212)
257274

258275
___
259276

@@ -277,7 +294,7 @@ const assetManager = AlgorandClient.mainNet().asset;
277294

278295
#### Defined in
279296

280-
[src/types/algorand-client.ts:185](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L185)
297+
[src/types/algorand-client.ts:192](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L192)
281298

282299
___
283300

@@ -301,7 +318,7 @@ const clientManager = AlgorandClient.mainNet().client;
301318

302319
#### Defined in
303320

304-
[src/types/algorand-client.ts:165](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L165)
321+
[src/types/algorand-client.ts:172](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L172)
305322

306323
___
307324

@@ -329,7 +346,7 @@ const payment = await AlgorandClient.mainNet().createTransaction.payment({
329346

330347
#### Defined in
331348

332-
[src/types/algorand-client.ts:250](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L250)
349+
[src/types/algorand-client.ts:269](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L269)
333350

334351
___
335352

@@ -357,7 +374,7 @@ const result = await AlgorandClient.mainNet().send.payment({
357374

358375
#### Defined in
359376

360-
[src/types/algorand-client.ts:236](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L236)
377+
[src/types/algorand-client.ts:255](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L255)
361378

362379
## Methods
363380

@@ -381,7 +398,7 @@ const params = await AlgorandClient.mainNet().getSuggestedParams();
381398

382399
#### Defined in
383400

384-
[src/types/algorand-client.ts:144](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L144)
401+
[src/types/algorand-client.ts:151](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L151)
385402

386403
___
387404

@@ -406,7 +423,30 @@ const result = await composer.addTransaction(payment).send()
406423

407424
#### Defined in
408425

409-
[src/types/algorand-client.ts:216](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L216)
426+
[src/types/algorand-client.ts:234](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L234)
427+
428+
___
429+
430+
### registerErrorTransformer
431+
432+
**registerErrorTransformer**(`transformer`): `void`
433+
434+
Register a function that will be used to transform an error caught when simulating or executing
435+
composed transaction groups made from `newGroup`
436+
437+
#### Parameters
438+
439+
| Name | Type |
440+
| :------ | :------ |
441+
| `transformer` | [`ErrorTransformer`](../modules/types_composer.md#errortransformer) |
442+
443+
#### Returns
444+
445+
`void`
446+
447+
#### Defined in
448+
449+
[src/types/algorand-client.ts:220](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L220)
410450

411451
___
412452

@@ -437,7 +477,7 @@ const algorand = AlgorandClient.mainNet().setDefaultSigner(signer)
437477

438478
#### Defined in
439479

440-
[src/types/algorand-client.ts:67](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L67)
480+
[src/types/algorand-client.ts:74](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L74)
441481

442482
___
443483

@@ -467,7 +507,7 @@ const algorand = AlgorandClient.mainNet().setDefaultValidityWindow(1000);
467507

468508
#### Defined in
469509

470-
[src/types/algorand-client.ts:52](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L52)
510+
[src/types/algorand-client.ts:59](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L59)
471511

472512
___
473513

@@ -499,7 +539,7 @@ const algorand = AlgorandClient.mainNet().setSigner(signer.addr, signer.signer)
499539

500540
#### Defined in
501541

502-
[src/types/algorand-client.ts:103](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L103)
542+
[src/types/algorand-client.ts:110](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L110)
503543

504544
___
505545

@@ -534,7 +574,7 @@ const accountManager = AlgorandClient.mainNet()
534574

535575
#### Defined in
536576

537-
[src/types/algorand-client.ts:87](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L87)
577+
[src/types/algorand-client.ts:94](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L94)
538578

539579
___
540580

@@ -565,7 +605,7 @@ const algorand = AlgorandClient.mainNet().setSuggestedParamsCache(suggestedParam
565605

566606
#### Defined in
567607

568-
[src/types/algorand-client.ts:118](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L118)
608+
[src/types/algorand-client.ts:125](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L125)
569609

570610
___
571611

@@ -595,7 +635,27 @@ const algorand = AlgorandClient.mainNet().setSuggestedParamsCacheTimeout(10_000)
595635

596636
#### Defined in
597637

598-
[src/types/algorand-client.ts:133](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L133)
638+
[src/types/algorand-client.ts:140](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L140)
639+
640+
___
641+
642+
### unregisterErrorTransformer
643+
644+
**unregisterErrorTransformer**(`transformer`): `void`
645+
646+
#### Parameters
647+
648+
| Name | Type |
649+
| :------ | :------ |
650+
| `transformer` | [`ErrorTransformer`](../modules/types_composer.md#errortransformer) |
651+
652+
#### Returns
653+
654+
`void`
655+
656+
#### Defined in
657+
658+
[src/types/algorand-client.ts:224](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L224)
599659

600660
___
601661

@@ -619,7 +679,7 @@ const algorand = AlgorandClient.defaultLocalNet();
619679

620680
#### Defined in
621681

622-
[src/types/algorand-client.ts:262](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L262)
682+
[src/types/algorand-client.ts:281](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L281)
623683

624684
___
625685

@@ -649,7 +709,7 @@ const algorand = AlgorandClient.fromClients({ algod, indexer, kmd });
649709

650710
#### Defined in
651711

652-
[src/types/algorand-client.ts:305](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L305)
712+
[src/types/algorand-client.ts:324](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L324)
653713

654714
___
655715

@@ -679,7 +739,7 @@ const client = AlgorandClient.fromConfig({ algodConfig, indexerConfig, kmdConfig
679739

680740
#### Defined in
681741

682-
[src/types/algorand-client.ts:339](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L339)
742+
[src/types/algorand-client.ts:358](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L358)
683743

684744
___
685745

@@ -716,7 +776,7 @@ const client = AlgorandClient.fromEnvironment();
716776

717777
#### Defined in
718778

719-
[src/types/algorand-client.ts:328](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L328)
779+
[src/types/algorand-client.ts:347](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L347)
720780

721781
___
722782

@@ -740,7 +800,7 @@ const algorand = AlgorandClient.mainNet();
740800

741801
#### Defined in
742802

743-
[src/types/algorand-client.ts:290](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L290)
803+
[src/types/algorand-client.ts:309](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L309)
744804

745805
___
746806

@@ -764,4 +824,4 @@ const algorand = AlgorandClient.testNet();
764824

765825
#### Defined in
766826

767-
[src/types/algorand-client.ts:276](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L276)
827+
[src/types/algorand-client.ts:295](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L295)

0 commit comments

Comments
 (0)