@@ -23,6 +23,7 @@ A client that brokers easy access to Algorand functionality.
23
23
- [ \_ cachedSuggestedParamsTimeout] ( types_algorand_client.AlgorandClient.md#_cachedsuggestedparamstimeout )
24
24
- [ \_ clientManager] ( types_algorand_client.AlgorandClient.md#_clientmanager )
25
25
- [ \_ defaultValidityWindow] ( types_algorand_client.AlgorandClient.md#_defaultvaliditywindow )
26
+ - [ \_ errorTransformers] ( types_algorand_client.AlgorandClient.md#_errortransformers )
26
27
- [ \_ transactionCreator] ( types_algorand_client.AlgorandClient.md#_transactioncreator )
27
28
- [ \_ transactionSender] ( types_algorand_client.AlgorandClient.md#_transactionsender )
28
29
@@ -40,12 +41,14 @@ A client that brokers easy access to Algorand functionality.
40
41
41
42
- [ getSuggestedParams] ( types_algorand_client.AlgorandClient.md#getsuggestedparams )
42
43
- [ newGroup] ( types_algorand_client.AlgorandClient.md#newgroup )
44
+ - [ registerErrorTransformer] ( types_algorand_client.AlgorandClient.md#registererrortransformer )
43
45
- [ setDefaultSigner] ( types_algorand_client.AlgorandClient.md#setdefaultsigner )
44
46
- [ setDefaultValidityWindow] ( types_algorand_client.AlgorandClient.md#setdefaultvaliditywindow )
45
47
- [ setSigner] ( types_algorand_client.AlgorandClient.md#setsigner )
46
48
- [ setSignerFromAccount] ( types_algorand_client.AlgorandClient.md#setsignerfromaccount )
47
49
- [ setSuggestedParamsCache] ( types_algorand_client.AlgorandClient.md#setsuggestedparamscache )
48
50
- [ setSuggestedParamsCacheTimeout] ( types_algorand_client.AlgorandClient.md#setsuggestedparamscachetimeout )
51
+ - [ unregisterErrorTransformer] ( types_algorand_client.AlgorandClient.md#unregistererrortransformer )
49
52
- [ defaultLocalNet] ( types_algorand_client.AlgorandClient.md#defaultlocalnet )
50
53
- [ fromClients] ( types_algorand_client.AlgorandClient.md#fromclients )
51
54
- [ fromConfig] ( types_algorand_client.AlgorandClient.md#fromconfig )
@@ -71,7 +74,7 @@ A client that brokers easy access to Algorand functionality.
71
74
72
75
#### Defined in
73
76
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 )
75
78
76
79
## Properties
77
80
165
168
166
169
___
167
170
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
+
168
185
### \_ transactionCreator
169
186
170
187
• ` Private ` ** \_ transactionCreator** : [ ` AlgorandClientTransactionCreator ` ] ( types_algorand_client_transaction_creator.AlgorandClientTransactionCreator.md )
@@ -205,7 +222,7 @@ const accountManager = AlgorandClient.mainNet().account;
205
222
206
223
#### Defined in
207
224
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 )
209
226
210
227
___
211
228
@@ -229,7 +246,7 @@ const appManager = AlgorandClient.mainNet().app;
229
246
230
247
#### Defined in
231
248
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 )
233
250
234
251
___
235
252
@@ -253,7 +270,7 @@ const deployer = AlgorandClient.mainNet().appDeployer;
253
270
254
271
#### Defined in
255
272
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 )
257
274
258
275
___
259
276
@@ -277,7 +294,7 @@ const assetManager = AlgorandClient.mainNet().asset;
277
294
278
295
#### Defined in
279
296
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 )
281
298
282
299
___
283
300
@@ -301,7 +318,7 @@ const clientManager = AlgorandClient.mainNet().client;
301
318
302
319
#### Defined in
303
320
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 )
305
322
306
323
___
307
324
@@ -329,7 +346,7 @@ const payment = await AlgorandClient.mainNet().createTransaction.payment({
329
346
330
347
#### Defined in
331
348
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 )
333
350
334
351
___
335
352
@@ -357,7 +374,7 @@ const result = await AlgorandClient.mainNet().send.payment({
357
374
358
375
#### Defined in
359
376
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 )
361
378
362
379
## Methods
363
380
@@ -381,7 +398,7 @@ const params = await AlgorandClient.mainNet().getSuggestedParams();
381
398
382
399
#### Defined in
383
400
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 )
385
402
386
403
___
387
404
@@ -406,7 +423,30 @@ const result = await composer.addTransaction(payment).send()
406
423
407
424
#### Defined in
408
425
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 )
410
450
411
451
___
412
452
@@ -437,7 +477,7 @@ const algorand = AlgorandClient.mainNet().setDefaultSigner(signer)
437
477
438
478
#### Defined in
439
479
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 )
441
481
442
482
___
443
483
@@ -467,7 +507,7 @@ const algorand = AlgorandClient.mainNet().setDefaultValidityWindow(1000);
467
507
468
508
#### Defined in
469
509
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 )
471
511
472
512
___
473
513
@@ -499,7 +539,7 @@ const algorand = AlgorandClient.mainNet().setSigner(signer.addr, signer.signer)
499
539
500
540
#### Defined in
501
541
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 )
503
543
504
544
___
505
545
@@ -534,7 +574,7 @@ const accountManager = AlgorandClient.mainNet()
534
574
535
575
#### Defined in
536
576
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 )
538
578
539
579
___
540
580
@@ -565,7 +605,7 @@ const algorand = AlgorandClient.mainNet().setSuggestedParamsCache(suggestedParam
565
605
566
606
#### Defined in
567
607
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 )
569
609
570
610
___
571
611
@@ -595,7 +635,27 @@ const algorand = AlgorandClient.mainNet().setSuggestedParamsCacheTimeout(10_000)
595
635
596
636
#### Defined in
597
637
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 )
599
659
600
660
___
601
661
@@ -619,7 +679,7 @@ const algorand = AlgorandClient.defaultLocalNet();
619
679
620
680
#### Defined in
621
681
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 )
623
683
624
684
___
625
685
@@ -649,7 +709,7 @@ const algorand = AlgorandClient.fromClients({ algod, indexer, kmd });
649
709
650
710
#### Defined in
651
711
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 )
653
713
654
714
___
655
715
@@ -679,7 +739,7 @@ const client = AlgorandClient.fromConfig({ algodConfig, indexerConfig, kmdConfig
679
739
680
740
#### Defined in
681
741
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 )
683
743
684
744
___
685
745
@@ -716,7 +776,7 @@ const client = AlgorandClient.fromEnvironment();
716
776
717
777
#### Defined in
718
778
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 )
720
780
721
781
___
722
782
@@ -740,7 +800,7 @@ const algorand = AlgorandClient.mainNet();
740
800
741
801
#### Defined in
742
802
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 )
744
804
745
805
___
746
806
@@ -764,4 +824,4 @@ const algorand = AlgorandClient.testNet();
764
824
765
825
#### Defined in
766
826
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