@algorandfoundation/algokit-utils 10.0.0-alpha.31 → 10.0.0-alpha.32

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (318) hide show
  1. package/account-manager.d.ts +448 -0
  2. package/account-manager.js +623 -0
  3. package/account-manager.js.map +1 -0
  4. package/account-manager.mjs +620 -0
  5. package/account-manager.mjs.map +1 -0
  6. package/account.d.ts +156 -0
  7. package/account.js +10 -0
  8. package/account.js.map +1 -0
  9. package/account.mjs +9 -0
  10. package/account.mjs.map +1 -0
  11. package/algorand-client-transaction-creator.d.ts +1103 -0
  12. package/algorand-client-transaction-creator.js +735 -0
  13. package/algorand-client-transaction-creator.js.map +1 -0
  14. package/algorand-client-transaction-creator.mjs +734 -0
  15. package/algorand-client-transaction-creator.mjs.map +1 -0
  16. package/algorand-client-transaction-sender.d.ts +1317 -0
  17. package/algorand-client-transaction-sender.js +933 -0
  18. package/algorand-client-transaction-sender.js.map +1 -0
  19. package/algorand-client-transaction-sender.mjs +932 -0
  20. package/algorand-client-transaction-sender.mjs.map +1 -0
  21. package/algorand-client.d.ts +246 -0
  22. package/algorand-client.js +325 -0
  23. package/algorand-client.js.map +1 -0
  24. package/algorand-client.mjs +325 -0
  25. package/algorand-client.mjs.map +1 -0
  26. package/amount.d.ts +46 -3
  27. package/amount.js +92 -13
  28. package/amount.js.map +1 -1
  29. package/amount.mjs +80 -3
  30. package/amount.mjs.map +1 -1
  31. package/app-client.d.ts +2130 -0
  32. package/app-client.js +909 -0
  33. package/app-client.js.map +1 -0
  34. package/app-client.mjs +908 -0
  35. package/app-client.mjs.map +1 -0
  36. package/app-deployer.d.ts +166 -0
  37. package/app-deployer.js +353 -0
  38. package/app-deployer.js.map +1 -0
  39. package/app-deployer.mjs +353 -0
  40. package/app-deployer.mjs.map +1 -0
  41. package/app-factory.d.ts +965 -0
  42. package/app-factory.js +448 -0
  43. package/app-factory.js.map +1 -0
  44. package/app-factory.mjs +448 -0
  45. package/app-factory.mjs.map +1 -0
  46. package/app-manager.d.ts +323 -0
  47. package/app-manager.js +468 -0
  48. package/app-manager.js.map +1 -0
  49. package/app-manager.mjs +468 -0
  50. package/app-manager.mjs.map +1 -0
  51. package/app-spec.d.ts +203 -0
  52. package/app-spec.js +137 -0
  53. package/app-spec.js.map +1 -0
  54. package/app-spec.mjs +137 -0
  55. package/app-spec.mjs.map +1 -0
  56. package/app.d.ts +257 -0
  57. package/app.js +49 -0
  58. package/app.js.map +1 -0
  59. package/app.mjs +42 -0
  60. package/app.mjs.map +1 -0
  61. package/asset-manager.d.ts +212 -0
  62. package/asset-manager.js +166 -0
  63. package/asset-manager.js.map +1 -0
  64. package/asset-manager.mjs +166 -0
  65. package/asset-manager.mjs.map +1 -0
  66. package/async-event-emitter.d.ts +16 -0
  67. package/async-event-emitter.js +38 -0
  68. package/async-event-emitter.js.map +1 -0
  69. package/async-event-emitter.mjs +37 -0
  70. package/async-event-emitter.mjs.map +1 -0
  71. package/client-manager.d.ts +475 -0
  72. package/client-manager.js +616 -0
  73. package/client-manager.js.map +1 -0
  74. package/client-manager.mjs +616 -0
  75. package/client-manager.mjs.map +1 -0
  76. package/composer.d.ts +947 -0
  77. package/composer.js +1584 -0
  78. package/composer.js.map +1 -0
  79. package/composer.mjs +1583 -0
  80. package/composer.mjs.map +1 -0
  81. package/config.d.ts +1 -1
  82. package/config.js +2 -2
  83. package/config.js.map +1 -1
  84. package/config.mjs +1 -1
  85. package/config.mjs.map +1 -1
  86. package/debugging.d.ts +47 -0
  87. package/debugging.js +20 -0
  88. package/debugging.js.map +1 -0
  89. package/debugging.mjs +15 -0
  90. package/debugging.mjs.map +1 -0
  91. package/dispenser-client.d.ts +90 -0
  92. package/dispenser-client.js +127 -0
  93. package/dispenser-client.js.map +1 -0
  94. package/dispenser-client.mjs +127 -0
  95. package/dispenser-client.mjs.map +1 -0
  96. package/expand.d.ts +2 -0
  97. package/expand.js +0 -0
  98. package/expand.mjs +0 -0
  99. package/index.d.ts +6 -5
  100. package/index.js +4 -3
  101. package/index.mjs +5 -5
  102. package/indexer-client/indexer-lookup.d.ts +1 -1
  103. package/indexer-client/indexer-lookup.js.map +1 -1
  104. package/indexer-client/indexer-lookup.mjs.map +1 -1
  105. package/indexer.d.ts +40 -0
  106. package/indexer.js +38 -0
  107. package/indexer.js.map +1 -0
  108. package/indexer.mjs +35 -0
  109. package/indexer.mjs.map +1 -0
  110. package/instance-of.d.ts +8 -0
  111. package/kmd-account-manager.d.ts +74 -0
  112. package/kmd-account-manager.js +167 -0
  113. package/kmd-account-manager.js.map +1 -0
  114. package/kmd-account-manager.mjs +165 -0
  115. package/kmd-account-manager.mjs.map +1 -0
  116. package/lifecycle-events.d.ts +14 -0
  117. package/lifecycle-events.js +11 -0
  118. package/lifecycle-events.js.map +1 -0
  119. package/lifecycle-events.mjs +10 -0
  120. package/lifecycle-events.mjs.map +1 -0
  121. package/logging.d.ts +13 -0
  122. package/logging.js +47 -0
  123. package/logging.js.map +1 -0
  124. package/logging.mjs +42 -0
  125. package/logging.mjs.map +1 -0
  126. package/logic-error.d.ts +39 -0
  127. package/logic-error.js +54 -0
  128. package/logic-error.js.map +1 -0
  129. package/logic-error.mjs +53 -0
  130. package/logic-error.mjs.map +1 -0
  131. package/network-client.d.ts +43 -0
  132. package/network-client.js +14 -0
  133. package/network-client.js.map +1 -0
  134. package/network-client.mjs +13 -0
  135. package/network-client.mjs.map +1 -0
  136. package/package.json +11 -1
  137. package/testing/account.d.ts +2 -2
  138. package/testing/account.js +1 -1
  139. package/testing/account.js.map +1 -1
  140. package/testing/account.mjs +1 -1
  141. package/testing/account.mjs.map +1 -1
  142. package/testing/fixtures/algokit-log-capture-fixture.d.ts +1 -1
  143. package/testing/fixtures/algokit-log-capture-fixture.js.map +1 -1
  144. package/testing/fixtures/algokit-log-capture-fixture.mjs.map +1 -1
  145. package/testing/fixtures/algorand-fixture.d.ts +2 -2
  146. package/testing/fixtures/algorand-fixture.js +2 -2
  147. package/testing/fixtures/algorand-fixture.js.map +1 -1
  148. package/testing/fixtures/algorand-fixture.mjs +2 -2
  149. package/testing/fixtures/algorand-fixture.mjs.map +1 -1
  150. package/testing/index.d.ts +2 -1
  151. package/testing/test-logger.d.ts +1 -1
  152. package/testing/test-logger.js.map +1 -1
  153. package/testing/test-logger.mjs.map +1 -1
  154. package/testing/types.d.ts +156 -0
  155. package/transaction/index.d.ts +4 -0
  156. package/transaction/index.js +9 -0
  157. package/transaction/index.mjs +4 -0
  158. package/transaction/perform-transaction-composer-simulate.d.ts +1 -1
  159. package/transaction/perform-transaction-composer-simulate.js.map +1 -1
  160. package/transaction/perform-transaction-composer-simulate.mjs.map +1 -1
  161. package/transaction/transaction.d.ts +2 -2
  162. package/transaction/transaction.js.map +1 -1
  163. package/transaction/transaction.mjs.map +1 -1
  164. package/transaction/types.d.ts +133 -0
  165. package/transactions/app-call.d.ts +1 -1
  166. package/transactions/app-call.js +1 -1
  167. package/transactions/app-call.js.map +1 -1
  168. package/transactions/app-call.mjs +1 -1
  169. package/transactions/app-call.mjs.map +1 -1
  170. package/transactions/common.d.ts +1 -1
  171. package/transactions/common.js.map +1 -1
  172. package/transactions/common.mjs.map +1 -1
  173. package/transactions/method-call.d.ts +1 -1
  174. package/transactions/method-call.js +1 -1
  175. package/transactions/method-call.js.map +1 -1
  176. package/transactions/method-call.mjs +1 -1
  177. package/transactions/method-call.mjs.map +1 -1
  178. package/transactions/payment.d.ts +1 -1
  179. package/transactions/payment.js.map +1 -1
  180. package/transactions/payment.mjs.map +1 -1
  181. package/types/account-manager.d.ts +11 -442
  182. package/types/account-manager.js +5 -616
  183. package/types/account-manager.js.map +1 -1
  184. package/types/account-manager.mjs +5 -614
  185. package/types/account-manager.mjs.map +1 -1
  186. package/types/account.d.ts +8 -150
  187. package/types/account.js +3 -4
  188. package/types/account.js.map +1 -1
  189. package/types/account.mjs +4 -4
  190. package/types/account.mjs.map +1 -1
  191. package/types/algorand-client-transaction-creator.d.ts +5 -1098
  192. package/types/algorand-client-transaction-creator.js +3 -729
  193. package/types/algorand-client-transaction-creator.js.map +1 -1
  194. package/types/algorand-client-transaction-creator.mjs +4 -729
  195. package/types/algorand-client-transaction-creator.mjs.map +1 -1
  196. package/types/algorand-client-transaction-sender.d.ts +5 -1312
  197. package/types/algorand-client-transaction-sender.js +3 -927
  198. package/types/algorand-client-transaction-sender.js.map +1 -1
  199. package/types/algorand-client-transaction-sender.mjs +3 -926
  200. package/types/algorand-client-transaction-sender.mjs.map +1 -1
  201. package/types/algorand-client.d.ts +5 -241
  202. package/types/algorand-client.js +3 -319
  203. package/types/algorand-client.js.map +1 -1
  204. package/types/algorand-client.mjs +3 -319
  205. package/types/algorand-client.mjs.map +1 -1
  206. package/types/amount.d.ts +6 -45
  207. package/types/amount.js +3 -79
  208. package/types/amount.js.map +1 -1
  209. package/types/amount.mjs +4 -79
  210. package/types/amount.mjs.map +1 -1
  211. package/types/app-client.d.ts +75 -2125
  212. package/types/app-client.js +3 -903
  213. package/types/app-client.js.map +1 -1
  214. package/types/app-client.mjs +3 -902
  215. package/types/app-client.mjs.map +1 -1
  216. package/types/app-deployer.d.ts +21 -161
  217. package/types/app-deployer.js +3 -347
  218. package/types/app-deployer.js.map +1 -1
  219. package/types/app-deployer.mjs +3 -347
  220. package/types/app-deployer.mjs.map +1 -1
  221. package/types/app-factory.d.ts +21 -960
  222. package/types/app-factory.js +3 -442
  223. package/types/app-factory.js.map +1 -1
  224. package/types/app-factory.mjs +3 -442
  225. package/types/app-factory.mjs.map +1 -1
  226. package/types/app-manager.d.ts +15 -318
  227. package/types/app-manager.js +3 -462
  228. package/types/app-manager.js.map +1 -1
  229. package/types/app-manager.mjs +3 -462
  230. package/types/app-manager.mjs.map +1 -1
  231. package/types/app-spec.d.ts +39 -198
  232. package/types/app-spec.js +3 -131
  233. package/types/app-spec.js.map +1 -1
  234. package/types/app-spec.mjs +3 -131
  235. package/types/app-spec.mjs.map +1 -1
  236. package/types/app.d.ts +62 -247
  237. package/types/app.js +15 -37
  238. package/types/app.js.map +1 -1
  239. package/types/app.mjs +16 -37
  240. package/types/app.mjs.map +1 -1
  241. package/types/asset-manager.d.ts +9 -207
  242. package/types/asset-manager.js +3 -160
  243. package/types/asset-manager.js.map +1 -1
  244. package/types/asset-manager.mjs +3 -160
  245. package/types/asset-manager.mjs.map +1 -1
  246. package/types/async-event-emitter.d.ts +7 -11
  247. package/types/async-event-emitter.js +3 -32
  248. package/types/async-event-emitter.js.map +1 -1
  249. package/types/async-event-emitter.mjs +4 -32
  250. package/types/async-event-emitter.mjs.map +1 -1
  251. package/types/client-manager.d.ts +27 -470
  252. package/types/client-manager.js +3 -610
  253. package/types/client-manager.js.map +1 -1
  254. package/types/client-manager.mjs +3 -610
  255. package/types/client-manager.mjs.map +1 -1
  256. package/types/composer.d.ts +79 -943
  257. package/types/composer.js +3 -1578
  258. package/types/composer.js.map +1 -1
  259. package/types/composer.mjs +3 -1577
  260. package/types/composer.mjs.map +1 -1
  261. package/types/config.d.ts +7 -52
  262. package/types/config.js +3 -74
  263. package/types/config.js.map +1 -1
  264. package/types/config.mjs +3 -74
  265. package/types/config.mjs.map +1 -1
  266. package/types/debugging.d.ts +12 -37
  267. package/types/debugging.js +11 -10
  268. package/types/debugging.js.map +1 -1
  269. package/types/debugging.mjs +12 -10
  270. package/types/debugging.mjs.map +1 -1
  271. package/types/dispenser-client.d.ts +11 -85
  272. package/types/dispenser-client.js +3 -121
  273. package/types/dispenser-client.js.map +1 -1
  274. package/types/dispenser-client.mjs +3 -121
  275. package/types/dispenser-client.mjs.map +1 -1
  276. package/types/expand.d.ts +8 -2
  277. package/types/indexer.d.ts +16 -36
  278. package/types/indexer.js +7 -30
  279. package/types/indexer.js.map +1 -1
  280. package/types/indexer.mjs +8 -30
  281. package/types/indexer.mjs.map +1 -1
  282. package/types/instance-of.d.ts +4 -4
  283. package/types/kmd-account-manager.d.ts +5 -69
  284. package/types/kmd-account-manager.js +3 -161
  285. package/types/kmd-account-manager.js.map +1 -1
  286. package/types/kmd-account-manager.mjs +3 -159
  287. package/types/kmd-account-manager.mjs.map +1 -1
  288. package/types/lifecycle-events.d.ts +7 -9
  289. package/types/lifecycle-events.js +3 -5
  290. package/types/lifecycle-events.js.map +1 -1
  291. package/types/lifecycle-events.mjs +4 -5
  292. package/types/lifecycle-events.mjs.map +1 -1
  293. package/types/logging.d.ts +14 -9
  294. package/types/logging.js +11 -37
  295. package/types/logging.js.map +1 -1
  296. package/types/logging.mjs +12 -37
  297. package/types/logging.mjs.map +1 -1
  298. package/types/logic-error.d.ts +8 -35
  299. package/types/logic-error.js +3 -48
  300. package/types/logic-error.js.map +1 -1
  301. package/types/logic-error.mjs +4 -48
  302. package/types/logic-error.mjs.map +1 -1
  303. package/types/network-client.d.ts +10 -39
  304. package/types/network-client.js +3 -8
  305. package/types/network-client.js.map +1 -1
  306. package/types/network-client.mjs +4 -8
  307. package/types/network-client.mjs.map +1 -1
  308. package/types/testing.d.ts +13 -151
  309. package/types/transaction.d.ts +33 -128
  310. package/updatable-config.d.ts +57 -0
  311. package/updatable-config.js +80 -0
  312. package/updatable-config.js.map +1 -0
  313. package/updatable-config.mjs +80 -0
  314. package/updatable-config.mjs.map +1 -0
  315. package/util.js +1 -1
  316. package/util.js.map +1 -1
  317. package/util.mjs +1 -1
  318. package/util.mjs.map +1 -1
@@ -1,1317 +1,10 @@
1
- import { ReadableAddress } from "../packages/common/src/address.js";
2
- import { ABIValue } from "../packages/abi/src/abi-value.js";
3
- import { ABIMethod, ABIReturn } from "../packages/abi/src/abi-method.js";
4
- import { OnApplicationComplete, ResourceReference } from "../packages/transact/src/transactions/app-call.js";
5
- import { Transaction } from "../packages/transact/src/transactions/transaction.js";
6
- import { AddressWithTransactionSigner, SendingAddress, TransactionSigner } from "../packages/transact/src/signer.js";
7
- import { PendingTransactionResponse } from "../packages/algod_client/src/models/pending-transaction-response.js";
8
- import { AlgoAmount } from "./amount.js";
9
- import { AppManager, BoxIdentifier, BoxReference } from "./app-manager.js";
10
- import { CommonTransactionParams } from "../transactions/common.js";
11
- import { AppMethodCallParams } from "../transactions/app-call.js";
12
- import { AssetOptOutParams } from "../transactions/asset-transfer.js";
13
- import { AssetCreateParams } from "../transactions/asset-config.js";
14
- import { AppMethodCall } from "../transactions/method-call.js";
15
- import { SendParams, SendSingleTransactionResult } from "./transaction.js";
16
- import { TransactionComposer, TransactionComposerConfig } from "./composer.js";
17
- import { TransactionWithSigner } from "../transaction/transaction.js";
18
- import { SendAppCreateTransactionResult, SendAppTransactionResult, SendAppUpdateTransactionResult } from "./app.js";
19
- import { AssetManager } from "./asset-manager.js";
1
+ import { AlgorandClientTransactionSender as AlgorandClientTransactionSender$1 } from "../algorand-client-transaction-sender.js";
20
2
 
21
3
  //#region src/types/algorand-client-transaction-sender.d.ts
22
- /** Orchestrates sending transactions for `AlgorandClient`. */
23
- declare class AlgorandClientTransactionSender {
24
- private _newGroup;
25
- private _assetManager;
26
- private _appManager;
27
- /**
28
- * Creates a new `AlgorandClientSender`
29
- * @param newGroup A lambda that starts a new `TransactionComposer` transaction group
30
- * @param assetManager An `AssetManager` instance
31
- * @param appManager An `AppManager` instance
32
- * @example
33
- * ```typescript
34
- * const transactionSender = new AlgorandClientTransactionSender(() => new TransactionComposer(), assetManager, appManager)
35
- * ```
36
- */
37
- constructor(newGroup: (config?: TransactionComposerConfig) => TransactionComposer, assetManager: AssetManager, appManager: AppManager);
38
- /**
39
- * Start a new `TransactionComposer` transaction group
40
- * @returns A new instance of `TransactionComposer`.
41
- * @example
42
- * const composer = AlgorandClient.mainNet().send.newGroup();
43
- * const result = await composer.addTransaction(payment).send()
44
- */
45
- newGroup(): TransactionComposer;
46
- private _send;
47
- private _sendAppCall;
48
- private _sendAppUpdateCall;
49
- private _sendAppCreateCall;
50
- /**
51
- * Send a payment transaction to transfer Algo between accounts.
52
- * @param params The parameters for the payment transaction
53
- * @example Basic example
54
- * ```typescript
55
- * const result = await algorand.send.payment({
56
- * sender: 'SENDERADDRESS',
57
- * receiver: 'RECEIVERADDRESS',
58
- * amount: (4).algo(),
59
- * })
60
- * ```
61
- * @example Advanced example
62
- * ```typescript
63
- * const result = await algorand.send.payment({
64
- * amount: (4).algo(),
65
- * receiver: 'RECEIVERADDRESS',
66
- * sender: 'SENDERADDRESS',
67
- * closeRemainderTo: 'CLOSEREMAINDERTOADDRESS',
68
- * lease: 'lease',
69
- * note: 'note',
70
- * // Use this with caution, it's generally better to use algorand.account.rekeyAccount
71
- * rekeyTo: 'REKEYTOADDRESS',
72
- * // You wouldn't normally set this field
73
- * firstValidRound: 1000n,
74
- * validityWindow: 10,
75
- * extraFee: (1000).microAlgo(),
76
- * staticFee: (1000).microAlgo(),
77
- * // Max fee doesn't make sense with extraFee AND staticFee
78
- * // already specified, but here for completeness
79
- * maxFee: (3000).microAlgo(),
80
- * // Signer only needed if you want to provide one,
81
- * // generally you'd register it with AlgorandClient
82
- * // against the sender and not need to pass it in
83
- * signer: transactionSigner,
84
- * maxRoundsToWaitForConfirmation: 5,
85
- * suppressLog: true,
86
- * })
87
- * ```
88
- * @returns The result of the payment transaction and the transaction that was sent
89
- */
90
- payment: (params: CommonTransactionParams & {
91
- receiver: ReadableAddress;
92
- amount: AlgoAmount;
93
- closeRemainderTo?: ReadableAddress | undefined;
94
- } & SendParams) => Promise<SendSingleTransactionResult>;
95
- /**
96
- * Create a new Algorand Standard Asset.
97
- *
98
- * The account that sends this transaction will automatically be
99
- * opted in to the asset and will hold all units after creation.
100
- *
101
- * @param params The parameters for the asset creation transaction
102
- *
103
- * @example Basic example
104
- * ```typescript
105
- * await algorand.send.assetCreate({ sender: "CREATORADDRESS", total: 100n})
106
- * ```
107
- * @example Advanced example
108
- * ```typescript
109
- * await algorand.send.assetCreate({
110
- * sender: 'CREATORADDRESS',
111
- * total: 100n,
112
- * decimals: 2,
113
- * assetName: 'asset',
114
- * unitName: 'unit',
115
- * url: 'url',
116
- * metadataHash: 'metadataHash',
117
- * defaultFrozen: false,
118
- * manager: 'MANAGERADDRESS',
119
- * reserve: 'RESERVEADDRESS',
120
- * freeze: 'FREEZEADDRESS',
121
- * clawback: 'CLAWBACKADDRESS',
122
- * lease: 'lease',
123
- * note: 'note',
124
- * // You wouldn't normally set this field
125
- * firstValidRound: 1000n,
126
- * validityWindow: 10,
127
- * extraFee: (1000).microAlgo(),
128
- * staticFee: (1000).microAlgo(),
129
- * // Max fee doesn't make sense with extraFee AND staticFee
130
- * // already specified, but here for completeness
131
- * maxFee: (3000).microAlgo(),
132
- * // Signer only needed if you want to provide one,
133
- * // generally you'd register it with AlgorandClient
134
- * // against the sender and not need to pass it in
135
- * signer: transactionSigner,
136
- * maxRoundsToWaitForConfirmation: 5,
137
- * suppressLog: true,
138
- * })
139
- * ```
140
- * @returns The result of the asset create transaction and the transaction that was sent
141
- */
142
- assetCreate: (params: AssetCreateParams & SendParams) => Promise<{
143
- assetId: bigint;
144
- groupId: string | undefined;
145
- txIds: string[];
146
- returns?: ABIReturn[] | undefined;
147
- confirmations: PendingTransactionResponse[];
148
- transactions: Transaction[];
149
- confirmation: PendingTransactionResponse;
150
- transaction: Transaction;
151
- }>;
152
- /**
153
- * Configure an existing Algorand Standard Asset.
154
- *
155
- * **Note:** The manager, reserve, freeze, and clawback addresses
156
- * are immutably empty if they are not set. If manager is not set then
157
- * all fields are immutable from that point forward.
158
- *
159
- * @param params The parameters for the asset config transaction
160
- *
161
- * @example Basic example
162
- * ```typescript
163
- * await algorand.send.assetConfig({ sender: "MANAGERADDRESS", assetId: 123456n, manager: "MANAGERADDRESS" })
164
- * ```
165
- * @example Advanced example
166
- * ```typescript
167
- * await algorand.send.assetConfig({
168
- * sender: 'MANAGERADDRESS',
169
- * assetId: 123456n,
170
- * manager: 'MANAGERADDRESS',
171
- * reserve: 'RESERVEADDRESS',
172
- * freeze: 'FREEZEADDRESS',
173
- * clawback: 'CLAWBACKADDRESS',
174
- * lease: 'lease',
175
- * note: 'note',
176
- * // You wouldn't normally set this field
177
- * firstValidRound: 1000n,
178
- * validityWindow: 10,
179
- * extraFee: (1000).microAlgo(),
180
- * staticFee: (1000).microAlgo(),
181
- * // Max fee doesn't make sense with extraFee AND staticFee
182
- * // already specified, but here for completeness
183
- * maxFee: (3000).microAlgo(),
184
- * // Signer only needed if you want to provide one,
185
- * // generally you'd register it with AlgorandClient
186
- * // against the sender and not need to pass it in
187
- * signer: transactionSigner,
188
- * maxRoundsToWaitForConfirmation: 5,
189
- * suppressLog: true,
190
- * })
191
- * ```
192
- * @returns The result of the asset config transaction and the transaction that was sent
193
- */
194
- assetConfig: (params: CommonTransactionParams & {
195
- assetId: bigint;
196
- manager?: ReadableAddress | undefined;
197
- reserve?: ReadableAddress | undefined;
198
- freeze?: ReadableAddress | undefined;
199
- clawback?: ReadableAddress | undefined;
200
- } & SendParams) => Promise<SendSingleTransactionResult>;
201
- /**
202
- * Freeze or unfreeze an Algorand Standard Asset for an account.
203
- *
204
- * @param params The parameters for the asset freeze transaction
205
- *
206
- * @example Basic example
207
- * ```typescript
208
- * await algorand.send.assetFreeze({ sender: "MANAGERADDRESS", assetId: 123456n, account: "ACCOUNTADDRESS", frozen: true })
209
- * ```
210
- * @example Advanced example
211
- * ```typescript
212
- * await algorand.send.assetFreeze({
213
- * sender: 'MANAGERADDRESS',
214
- * assetId: 123456n,
215
- * account: 'ACCOUNTADDRESS',
216
- * frozen: true,
217
- * lease: 'lease',
218
- * note: 'note',
219
- * // You wouldn't normally set this field
220
- * firstValidRound: 1000n,
221
- * validityWindow: 10,
222
- * extraFee: (1000).microAlgo(),
223
- * staticFee: (1000).microAlgo(),
224
- * // Max fee doesn't make sense with extraFee AND staticFee
225
- * // already specified, but here for completeness
226
- * maxFee: (3000).microAlgo(),
227
- * // Signer only needed if you want to provide one,
228
- * // generally you'd register it with AlgorandClient
229
- * // against the sender and not need to pass it in
230
- * signer: transactionSigner,
231
- * maxRoundsToWaitForConfirmation: 5,
232
- * suppressLog: true,
233
- * })
234
- * ```
235
- * @returns The result of the asset freeze transaction and the transaction that was sent
236
- */
237
- assetFreeze: (params: CommonTransactionParams & {
238
- assetId: bigint;
239
- freezeTarget: ReadableAddress;
240
- frozen: boolean;
241
- } & SendParams) => Promise<SendSingleTransactionResult>;
242
- /**
243
- * Destroys an Algorand Standard Asset.
244
- *
245
- * Created assets can be destroyed only by the asset manager account.
246
- * All of the assets must be owned by the creator of the asset before
247
- * the asset can be deleted.
248
- *
249
- * @param params The parameters for the asset destroy transaction
250
- *
251
- * @example Basic example
252
- * ```typescript
253
- * await algorand.send.assetDestroy({ sender: "MANAGERADDRESS", assetId: 123456n })
254
- * ```
255
- * @example Advanced example
256
- * ```typescript
257
- * await algorand.send.assetDestroy({
258
- * sender: 'MANAGERADDRESS',
259
- * assetId: 123456n,
260
- * lease: 'lease',
261
- * note: 'note',
262
- * // You wouldn't normally set this field
263
- * firstValidRound: 1000n,
264
- * validityWindow: 10,
265
- * extraFee: (1000).microAlgo(),
266
- * staticFee: (1000).microAlgo(),
267
- * // Max fee doesn't make sense with extraFee AND staticFee
268
- * // already specified, but here for completeness
269
- * maxFee: (3000).microAlgo(),
270
- * // Signer only needed if you want to provide one,
271
- * // generally you'd register it with AlgorandClient
272
- * // against the sender and not need to pass it in
273
- * signer: transactionSigner,
274
- * maxRoundsToWaitForConfirmation: 5,
275
- * suppressLog: true,
276
- * })
277
- * ```
278
- * @returns The result of the asset destroy transaction and the transaction that was sent
279
- */
280
- assetDestroy: (params: CommonTransactionParams & {
281
- assetId: bigint;
282
- } & SendParams) => Promise<SendSingleTransactionResult>;
283
- /**
284
- * Transfer an Algorand Standard Asset.
285
- *
286
- * @param params The parameters for the asset transfer transaction
287
- *
288
- * @example Basic example
289
- * ```typescript
290
- * await algorand.send.assetTransfer({ sender: "HOLDERADDRESS", assetId: 123456n, amount: 1n, receiver: "RECEIVERADDRESS" })
291
- * ```
292
- * @example Advanced example (with clawback)
293
- * ```typescript
294
- * await algorand.send.assetTransfer({
295
- * sender: 'CLAWBACKADDRESS',
296
- * assetId: 123456n,
297
- * amount: 1n,
298
- * receiver: 'RECEIVERADDRESS',
299
- * clawbackTarget: 'HOLDERADDRESS',
300
- * // This field needs to be used with caution
301
- * closeAssetTo: 'ADDRESSTOCLOSETO'
302
- * lease: 'lease',
303
- * note: 'note',
304
- * // You wouldn't normally set this field
305
- * firstValidRound: 1000n,
306
- * validityWindow: 10,
307
- * extraFee: (1000).microAlgo(),
308
- * staticFee: (1000).microAlgo(),
309
- * // Max fee doesn't make sense with extraFee AND staticFee
310
- * // already specified, but here for completeness
311
- * maxFee: (3000).microAlgo(),
312
- * // Signer only needed if you want to provide one,
313
- * // generally you'd register it with AlgorandClient
314
- * // against the sender and not need to pass it in
315
- * signer: transactionSigner,
316
- * maxRoundsToWaitForConfirmation: 5,
317
- * suppressLog: true,
318
- * })
319
- * ```
320
- * @returns The result of the asset transfer transaction and the transaction that was sent
321
- */
322
- assetTransfer: (params: CommonTransactionParams & {
323
- assetId: bigint;
324
- amount: bigint;
325
- receiver: ReadableAddress;
326
- clawbackTarget?: ReadableAddress | undefined;
327
- closeAssetTo?: ReadableAddress | undefined;
328
- } & SendParams) => Promise<SendSingleTransactionResult>;
329
- /**
330
- * Opt an account into an Algorand Standard Asset.
331
- *
332
- * @param params The parameters for the asset opt-in transaction
333
- *
334
- * @example Basic example
335
- * ```typescript
336
- * await algorand.send.assetOptIn({ sender: "SENDERADDRESS", assetId: 123456n })
337
- * ```
338
- * @example Advanced example
339
- * ```typescript
340
- * await algorand.send.assetOptIn({
341
- * sender: 'SENDERADDRESS',
342
- * assetId: 123456n,
343
- * lease: 'lease',
344
- * note: 'note',
345
- * // You wouldn't normally set this field
346
- * firstValidRound: 1000n,
347
- * validityWindow: 10,
348
- * extraFee: (1000).microAlgo(),
349
- * staticFee: (1000).microAlgo(),
350
- * // Max fee doesn't make sense with extraFee AND staticFee
351
- * // already specified, but here for completeness
352
- * maxFee: (3000).microAlgo(),
353
- * // Signer only needed if you want to provide one,
354
- * // generally you'd register it with AlgorandClient
355
- * // against the sender and not need to pass it in
356
- * signer: transactionSigner,
357
- * maxRoundsToWaitForConfirmation: 5,
358
- * suppressLog: true,
359
- * })
360
- * ```
361
- * @returns The result of the asset opt-in transaction and the transaction that was sent
362
- */
363
- assetOptIn: (params: CommonTransactionParams & {
364
- assetId: bigint;
365
- } & SendParams) => Promise<SendSingleTransactionResult>;
366
- /**
367
- * Opt an account out of an Algorand Standard Asset.
368
- *
369
- * *Note:* If the account has a balance of the asset,
370
- * it will not be able to opt-out unless `ensureZeroBalance`
371
- * is set to `false` (but then the account will lose the assets).
372
- *
373
- * @param params The parameters for the asset opt-out transaction
374
- *
375
- * @example Basic example (without creator, will be retrieved from algod)
376
- * ```typescript
377
- * await algorand.send.assetOptOut({ sender: "SENDERADDRESS", assetId: 123456n, ensureZeroBalance: true })
378
- * ```
379
- * @example Basic example (with creator)
380
- * ```typescript
381
- * await algorand.send.assetOptOut({ sender: "SENDERADDRESS", creator: "CREATORADDRESS", assetId: 123456n, ensureZeroBalance: true })
382
- * ```
383
- * @example Advanced example
384
- * ```typescript
385
- * await algorand.send.assetOptOut({
386
- * sender: 'SENDERADDRESS',
387
- * assetId: 123456n,
388
- * creator: 'CREATORADDRESS',
389
- * ensureZeroBalance: true,
390
- * lease: 'lease',
391
- * note: 'note',
392
- * // You wouldn't normally set this field
393
- * firstValidRound: 1000n,
394
- * validityWindow: 10,
395
- * extraFee: (1000).microAlgo(),
396
- * staticFee: (1000).microAlgo(),
397
- * // Max fee doesn't make sense with extraFee AND staticFee
398
- * // already specified, but here for completeness
399
- * maxFee: (3000).microAlgo(),
400
- * // Signer only needed if you want to provide one,
401
- * // generally you'd register it with AlgorandClient
402
- * // against the sender and not need to pass it in
403
- * signer: transactionSigner,
404
- * maxRoundsToWaitForConfirmation: 5,
405
- * suppressLog: true,
406
- * })
407
- * ```
408
- * @returns The result of the asset opt-out transaction and the transaction that was sent
409
- */
410
- assetOptOut: (params: Omit<AssetOptOutParams, 'creator'> & {
411
- /** Optional asset creator account address; if not specified it will be retrieved from algod */
412
- creator?: ReadableAddress;
413
- /** Whether or not to check if the account has a zero balance first or not.
414
- *
415
- * If this is set to `true` and the account has an asset balance it will throw an error.
416
- *
417
- * If this is set to `false` and the account has an asset balance it will lose those assets to the asset creator.
418
- */
419
- ensureZeroBalance: boolean;
420
- } & SendParams) => Promise<{
421
- groupId: string | undefined;
422
- txIds: string[];
423
- returns?: ABIReturn[] | undefined;
424
- confirmations: PendingTransactionResponse[];
425
- transactions: Transaction[];
426
- confirmation: PendingTransactionResponse;
427
- transaction: Transaction;
428
- }>;
429
- /**
430
- * Create a smart contract.
431
- *
432
- * Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality.
433
- *
434
- * @param params The parameters for the app creation transaction
435
- * @example Basic example
436
- * ```typescript
437
- * const result = await algorand.send.appCreate({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE' })
438
- * const createdAppId = result.appId
439
- * ```
440
- * @example Advanced example
441
- * ```typescript
442
- * await algorand.send.appCreate({
443
- * sender: 'CREATORADDRESS',
444
- * approvalProgram: "TEALCODE",
445
- * clearStateProgram: "TEALCODE",
446
- * schema: {
447
- * globalInts: 1,
448
- * globalByteSlices: 2,
449
- * localInts: 3,
450
- * localByteSlices: 4
451
- * },
452
- * extraProgramPages: 1,
453
- * onComplete: OnApplicationComplete.OptIn,
454
- * args: [new Uint8Array(1, 2, 3, 4)]
455
- * accountReferences: ["ACCOUNT_1"]
456
- * appReferences: [123n, 1234n]
457
- * assetReferences: [12345n]
458
- * boxReferences: ["box1", {appId: 1234n, name: "box2"}]
459
- * accessReferences: [{ appId: 1234n }]
460
- * lease: 'lease',
461
- * note: 'note',
462
- * // You wouldn't normally set this field
463
- * firstValidRound: 1000n,
464
- * validityWindow: 10,
465
- * extraFee: (1000).microAlgo(),
466
- * staticFee: (1000).microAlgo(),
467
- * // Max fee doesn't make sense with extraFee AND staticFee
468
- * // already specified, but here for completeness
469
- * maxFee: (3000).microAlgo(),
470
- * rejectVersion: 1,
471
- * // Signer only needed if you want to provide one,
472
- * // generally you'd register it with AlgorandClient
473
- * // against the sender and not need to pass it in
474
- * signer: transactionSigner,
475
- * maxRoundsToWaitForConfirmation: 5,
476
- * suppressLog: true,
477
- *})
478
- * ```
479
- * @returns The result of the app create transaction and the transaction that was sent
480
- */
481
- appCreate: (params: {
482
- signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
483
- sender: SendingAddress;
484
- rekeyTo?: ReadableAddress | undefined;
485
- note?: string | Uint8Array | undefined;
486
- lease?: string | Uint8Array | undefined;
487
- staticFee?: AlgoAmount | undefined;
488
- extraFee?: AlgoAmount | undefined;
489
- maxFee?: AlgoAmount | undefined;
490
- validityWindow?: number | bigint | undefined;
491
- firstValidRound?: bigint | undefined;
492
- lastValidRound?: bigint | undefined;
493
- onComplete?: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.UpdateApplication | OnApplicationComplete.DeleteApplication | undefined;
494
- args?: Uint8Array[] | undefined;
495
- accountReferences?: ReadableAddress[] | undefined;
496
- appReferences?: bigint[] | undefined;
497
- assetReferences?: bigint[] | undefined;
498
- boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
499
- accessReferences?: ResourceReference[] | undefined;
500
- rejectVersion?: number | undefined;
501
- appId?: 0 | undefined;
502
- approvalProgram: string | Uint8Array;
503
- clearStateProgram: string | Uint8Array;
504
- schema?: {
505
- globalInts: number;
506
- globalByteSlices: number;
507
- localInts: number;
508
- localByteSlices: number;
509
- } | undefined;
510
- extraProgramPages?: number | undefined;
511
- } & SendParams) => Promise<SendAppCreateTransactionResult>;
512
- /**
513
- * Update a smart contract.
514
- *
515
- * Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality.
516
- *
517
- * @param params The parameters for the app update transaction
518
- * @example Basic example
519
- * ```typescript
520
- * await algorand.send.appUpdate({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE' })
521
- * ```
522
- * @example Advanced example
523
- * ```typescript
524
- * await algorand.send.appUpdate({
525
- * sender: 'CREATORADDRESS',
526
- * approvalProgram: "TEALCODE",
527
- * clearStateProgram: "TEALCODE",
528
- * onComplete: OnApplicationComplete.UpdateApplication,
529
- * args: [new Uint8Array(1, 2, 3, 4)]
530
- * accountReferences: ["ACCOUNT_1"]
531
- * appReferences: [123n, 1234n]
532
- * assetReferences: [12345n]
533
- * boxReferences: ["box1", {appId: 1234n, name: "box2"}]
534
- * accessReferences: [{ appId: 1234n }]
535
- * lease: 'lease',
536
- * note: 'note',
537
- * // You wouldn't normally set this field
538
- * firstValidRound: 1000n,
539
- * validityWindow: 10,
540
- * extraFee: (1000).microAlgo(),
541
- * staticFee: (1000).microAlgo(),
542
- * // Max fee doesn't make sense with extraFee AND staticFee
543
- * // already specified, but here for completeness
544
- * maxFee: (3000).microAlgo(),
545
- * rejectVersion: 1,
546
- * // Signer only needed if you want to provide one,
547
- * // generally you'd register it with AlgorandClient
548
- * // against the sender and not need to pass it in
549
- * signer: transactionSigner,
550
- * maxRoundsToWaitForConfirmation: 5,
551
- * suppressLog: true,
552
- *})
553
- * ```
554
- * @returns The result of the app update transaction and the transaction that was sent
555
- */
556
- appUpdate: (params: {
557
- sender: SendingAddress;
558
- signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
559
- rekeyTo?: ReadableAddress | undefined;
560
- note?: string | Uint8Array | undefined;
561
- lease?: string | Uint8Array | undefined;
562
- staticFee?: AlgoAmount | undefined;
563
- extraFee?: AlgoAmount | undefined;
564
- maxFee?: AlgoAmount | undefined;
565
- validityWindow?: number | bigint | undefined;
566
- firstValidRound?: bigint | undefined;
567
- lastValidRound?: bigint | undefined;
568
- appId: bigint;
569
- onComplete?: OnApplicationComplete.UpdateApplication | undefined;
570
- args?: Uint8Array[] | undefined;
571
- accountReferences?: ReadableAddress[] | undefined;
572
- appReferences?: bigint[] | undefined;
573
- assetReferences?: bigint[] | undefined;
574
- boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
575
- accessReferences?: ResourceReference[] | undefined;
576
- rejectVersion?: number | undefined;
577
- approvalProgram: string | Uint8Array;
578
- clearStateProgram: string | Uint8Array;
579
- } & SendParams) => Promise<SendAppUpdateTransactionResult>;
580
- /**
581
- * Delete a smart contract.
582
- *
583
- * Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality.
584
- *
585
- * @param params The parameters for the app deletion transaction
586
- * @example Basic example
587
- * ```typescript
588
- * await algorand.send.appDelete({ sender: 'CREATORADDRESS' })
589
- * ```
590
- * @example Advanced example
591
- * ```typescript
592
- * await algorand.send.appDelete({
593
- * sender: 'CREATORADDRESS',
594
- * onComplete: OnApplicationComplete.DeleteApplication,
595
- * args: [new Uint8Array(1, 2, 3, 4)]
596
- * accountReferences: ["ACCOUNT_1"]
597
- * appReferences: [123n, 1234n]
598
- * assetReferences: [12345n]
599
- * boxReferences: ["box1", {appId: 1234n, name: "box2"}]
600
- * accessReferences: [{ appId: 1234n }]
601
- * lease: 'lease',
602
- * note: 'note',
603
- * // You wouldn't normally set this field
604
- * firstValidRound: 1000n,
605
- * validityWindow: 10,
606
- * extraFee: (1000).microAlgo(),
607
- * staticFee: (1000).microAlgo(),
608
- * // Max fee doesn't make sense with extraFee AND staticFee
609
- * // already specified, but here for completeness
610
- * maxFee: (3000).microAlgo(),
611
- * rejectVersion: 1,
612
- * // Signer only needed if you want to provide one,
613
- * // generally you'd register it with AlgorandClient
614
- * // against the sender and not need to pass it in
615
- * signer: transactionSigner,
616
- * maxRoundsToWaitForConfirmation: 5,
617
- * suppressLog: true,
618
- *})
619
- * ```
620
- * @returns The result of the app delete transaction and the transaction that was sent
621
- */
622
- appDelete: (params: CommonTransactionParams & {
623
- appId: bigint;
624
- onComplete?: OnApplicationComplete | undefined;
625
- args?: Uint8Array[] | undefined;
626
- accountReferences?: ReadableAddress[] | undefined;
627
- appReferences?: bigint[] | undefined;
628
- assetReferences?: bigint[] | undefined;
629
- boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
630
- accessReferences?: ResourceReference[] | undefined;
631
- rejectVersion?: number | undefined;
632
- } & {
633
- onComplete?: OnApplicationComplete.DeleteApplication | undefined;
634
- } & SendParams) => Promise<SendAppTransactionResult>;
635
- /**
636
- * Call a smart contract.
637
- *
638
- * Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality.
639
- *
640
- * @param params The parameters for the app call transaction
641
- * @example Basic example
642
- * ```typescript
643
- * await algorand.send.appCall({ sender: 'CREATORADDRESS' })
644
- * ```
645
- * @example Advanced example
646
- * ```typescript
647
- * await algorand.send.appCall({
648
- * sender: 'CREATORADDRESS',
649
- * onComplete: OnApplicationComplete.OptIn,
650
- * args: [new Uint8Array(1, 2, 3, 4)]
651
- * accountReferences: ["ACCOUNT_1"]
652
- * appReferences: [123n, 1234n]
653
- * assetReferences: [12345n]
654
- * boxReferences: ["box1", {appId: 1234n, name: "box2"}]
655
- * accessReferences: [{ appId: 1234n }]
656
- * lease: 'lease',
657
- * note: 'note',
658
- * // You wouldn't normally set this field
659
- * firstValidRound: 1000n,
660
- * validityWindow: 10,
661
- * extraFee: (1000).microAlgo(),
662
- * staticFee: (1000).microAlgo(),
663
- * // Max fee doesn't make sense with extraFee AND staticFee
664
- * // already specified, but here for completeness
665
- * maxFee: (3000).microAlgo(),
666
- * rejectVersion: 1,
667
- * // Signer only needed if you want to provide one,
668
- * // generally you'd register it with AlgorandClient
669
- * // against the sender and not need to pass it in
670
- * signer: transactionSigner,
671
- * maxRoundsToWaitForConfirmation: 5,
672
- * suppressLog: true,
673
- *})
674
- * ```
675
- * @returns The result of the app call transaction and the transaction that was sent
676
- */
677
- appCall: (params: CommonTransactionParams & {
678
- appId: bigint;
679
- onComplete?: OnApplicationComplete | undefined;
680
- args?: Uint8Array[] | undefined;
681
- accountReferences?: ReadableAddress[] | undefined;
682
- appReferences?: bigint[] | undefined;
683
- assetReferences?: bigint[] | undefined;
684
- boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
685
- accessReferences?: ResourceReference[] | undefined;
686
- rejectVersion?: number | undefined;
687
- } & {
688
- onComplete?: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.ClearState | OnApplicationComplete.DeleteApplication | undefined;
689
- } & SendParams) => Promise<SendAppTransactionResult>;
690
- /**
691
- * Create a smart contract via an ABI method.
692
- *
693
- * Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality.
694
- *
695
- * @param params The parameters for the app creation transaction
696
- * @example Basic example
697
- * ```typescript
698
- * const method = new ABIMethod({
699
- * name: 'method',
700
- * args: [{ name: 'arg1', type: 'string' }],
701
- * returns: { type: 'string' },
702
- * })
703
- * const result = await algorand.send.appCreateMethodCall({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE', method: method, args: ["arg1_value"] })
704
- * const createdAppId = result.appId
705
- * ```
706
- * @example Advanced example
707
- * ```typescript
708
- * const method = new ABIMethod({
709
- * name: 'method',
710
- * args: [{ name: 'arg1', type: 'string' }],
711
- * returns: { type: 'string' },
712
- * })
713
- * await algorand.send.appCreateMethodCall({
714
- * sender: 'CREATORADDRESS',
715
- * method: method,
716
- * args: ["arg1_value"],
717
- * approvalProgram: "TEALCODE",
718
- * clearStateProgram: "TEALCODE",
719
- * schema: {
720
- * globalInts: 1,
721
- * globalByteSlices: 2,
722
- * localInts: 3,
723
- * localByteSlices: 4
724
- * },
725
- * extraProgramPages: 1,
726
- * onComplete: OnApplicationComplete.OptIn,
727
- * args: [new Uint8Array(1, 2, 3, 4)]
728
- * accountReferences: ["ACCOUNT_1"]
729
- * appReferences: [123n, 1234n]
730
- * assetReferences: [12345n]
731
- * boxReferences: ["box1", {appId: 1234n, name: "box2"}]
732
- * accessReferences: [{ appId: 1234n }]
733
- * lease: 'lease',
734
- * note: 'note',
735
- * // You wouldn't normally set this field
736
- * firstValidRound: 1000n,
737
- * validityWindow: 10,
738
- * extraFee: (1000).microAlgo(),
739
- * staticFee: (1000).microAlgo(),
740
- * // Max fee doesn't make sense with extraFee AND staticFee
741
- * // already specified, but here for completeness
742
- * maxFee: (3000).microAlgo(),
743
- * rejectVersion: 1,
744
- * // Signer only needed if you want to provide one,
745
- * // generally you'd register it with AlgorandClient
746
- * // against the sender and not need to pass it in
747
- * signer: transactionSigner,
748
- * maxRoundsToWaitForConfirmation: 5,
749
- * suppressLog: true,
750
- *})
751
- * ```
752
- * @returns The result of the application ABI method create transaction and the transaction that was sent
753
- */
754
- appCreateMethodCall: (params: {
755
- signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
756
- sender: SendingAddress;
757
- rekeyTo?: ReadableAddress | undefined;
758
- note?: string | Uint8Array | undefined;
759
- lease?: string | Uint8Array | undefined;
760
- staticFee?: AlgoAmount | undefined;
761
- extraFee?: AlgoAmount | undefined;
762
- maxFee?: AlgoAmount | undefined;
763
- validityWindow?: number | bigint | undefined;
764
- firstValidRound?: bigint | undefined;
765
- lastValidRound?: bigint | undefined;
766
- appId?: 0 | undefined;
767
- onComplete?: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.UpdateApplication | OnApplicationComplete.DeleteApplication | undefined;
768
- accountReferences?: ReadableAddress[] | undefined;
769
- appReferences?: bigint[] | undefined;
770
- assetReferences?: bigint[] | undefined;
771
- boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
772
- accessReferences?: ResourceReference[] | undefined;
773
- rejectVersion?: number | undefined;
774
- approvalProgram: string | Uint8Array;
775
- clearStateProgram: string | Uint8Array;
776
- schema?: {
777
- globalInts: number;
778
- globalByteSlices: number;
779
- localInts: number;
780
- localByteSlices: number;
781
- } | undefined;
782
- extraProgramPages?: number | undefined;
783
- method: ABIMethod;
784
- args?: (Transaction | Promise<Transaction> | ABIValue | TransactionWithSigner | AppMethodCall<{
785
- signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
786
- sender: SendingAddress;
787
- rekeyTo?: ReadableAddress | undefined;
788
- note?: string | Uint8Array | undefined;
789
- lease?: string | Uint8Array | undefined;
790
- staticFee?: AlgoAmount | undefined;
791
- extraFee?: AlgoAmount | undefined;
792
- maxFee?: AlgoAmount | undefined;
793
- validityWindow?: number | bigint | undefined;
794
- firstValidRound?: bigint | undefined;
795
- lastValidRound?: bigint | undefined;
796
- onComplete?: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.UpdateApplication | OnApplicationComplete.DeleteApplication | undefined;
797
- args?: Uint8Array[] | undefined;
798
- accountReferences?: ReadableAddress[] | undefined;
799
- appReferences?: bigint[] | undefined;
800
- assetReferences?: bigint[] | undefined;
801
- boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
802
- accessReferences?: ResourceReference[] | undefined;
803
- rejectVersion?: number | undefined;
804
- appId?: 0 | undefined;
805
- approvalProgram: string | Uint8Array;
806
- clearStateProgram: string | Uint8Array;
807
- schema?: {
808
- globalInts: number;
809
- globalByteSlices: number;
810
- localInts: number;
811
- localByteSlices: number;
812
- } | undefined;
813
- extraProgramPages?: number | undefined;
814
- }> | AppMethodCall<{
815
- sender: SendingAddress;
816
- signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
817
- rekeyTo?: ReadableAddress | undefined;
818
- note?: string | Uint8Array | undefined;
819
- lease?: string | Uint8Array | undefined;
820
- staticFee?: AlgoAmount | undefined;
821
- extraFee?: AlgoAmount | undefined;
822
- maxFee?: AlgoAmount | undefined;
823
- validityWindow?: number | bigint | undefined;
824
- firstValidRound?: bigint | undefined;
825
- lastValidRound?: bigint | undefined;
826
- appId: bigint;
827
- onComplete?: OnApplicationComplete.UpdateApplication | undefined;
828
- args?: Uint8Array[] | undefined;
829
- accountReferences?: ReadableAddress[] | undefined;
830
- appReferences?: bigint[] | undefined;
831
- assetReferences?: bigint[] | undefined;
832
- boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
833
- accessReferences?: ResourceReference[] | undefined;
834
- rejectVersion?: number | undefined;
835
- approvalProgram: string | Uint8Array;
836
- clearStateProgram: string | Uint8Array;
837
- }> | AppMethodCall<AppMethodCallParams> | undefined)[] | undefined;
838
- } & SendParams) => Promise<SendAppCreateTransactionResult>;
839
- /**
840
- * Update a smart contract via an ABI method.
841
- *
842
- * Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality.
843
- *
844
- * @param params The parameters for the app update transaction
845
- * @example Basic example
846
- * ```typescript
847
- * const method = new ABIMethod({
848
- * name: 'method',
849
- * args: [{ name: 'arg1', type: 'string' }],
850
- * returns: { type: 'string' },
851
- * })
852
- * await algorand.send.appUpdateMethodCall({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE', method: method, args: ["arg1_value"] })
853
- * ```
854
- * @example Advanced example
855
- * ```typescript
856
- * const method = new ABIMethod({
857
- * name: 'method',
858
- * args: [{ name: 'arg1', type: 'string' }],
859
- * returns: { type: 'string' },
860
- * })
861
- * await algorand.send.appUpdateMethodCall({
862
- * sender: 'CREATORADDRESS',
863
- * method: method,
864
- * args: ["arg1_value"],
865
- * approvalProgram: "TEALCODE",
866
- * clearStateProgram: "TEALCODE",
867
- * onComplete: OnApplicationComplete.UpdateApplication,
868
- * args: [new Uint8Array(1, 2, 3, 4)]
869
- * accountReferences: ["ACCOUNT_1"]
870
- * appReferences: [123n, 1234n]
871
- * assetReferences: [12345n]
872
- * boxReferences: ["box1", {appId: 1234n, name: "box2"}]
873
- * accessReferences: [{ appId: 1234n }]
874
- * lease: 'lease',
875
- * note: 'note',
876
- * // You wouldn't normally set this field
877
- * firstValidRound: 1000n,
878
- * validityWindow: 10,
879
- * extraFee: (1000).microAlgo(),
880
- * staticFee: (1000).microAlgo(),
881
- * // Max fee doesn't make sense with extraFee AND staticFee
882
- * // already specified, but here for completeness
883
- * maxFee: (3000).microAlgo(),
884
- * rejectVersion: 1,
885
- * // Signer only needed if you want to provide one,
886
- * // generally you'd register it with AlgorandClient
887
- * // against the sender and not need to pass it in
888
- * signer: transactionSigner,
889
- * maxRoundsToWaitForConfirmation: 5,
890
- * suppressLog: true,
891
- *})
892
- * ```
893
- * @returns The result of the application ABI method update transaction and the transaction that was sent
894
- */
895
- appUpdateMethodCall: (params: {
896
- signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
897
- sender: SendingAddress;
898
- rekeyTo?: ReadableAddress | undefined;
899
- note?: string | Uint8Array | undefined;
900
- lease?: string | Uint8Array | undefined;
901
- staticFee?: AlgoAmount | undefined;
902
- extraFee?: AlgoAmount | undefined;
903
- maxFee?: AlgoAmount | undefined;
904
- validityWindow?: number | bigint | undefined;
905
- firstValidRound?: bigint | undefined;
906
- lastValidRound?: bigint | undefined;
907
- appId: bigint;
908
- onComplete?: OnApplicationComplete.UpdateApplication | undefined;
909
- accountReferences?: ReadableAddress[] | undefined;
910
- appReferences?: bigint[] | undefined;
911
- assetReferences?: bigint[] | undefined;
912
- boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
913
- accessReferences?: ResourceReference[] | undefined;
914
- rejectVersion?: number | undefined;
915
- approvalProgram: string | Uint8Array;
916
- clearStateProgram: string | Uint8Array;
917
- method: ABIMethod;
918
- args?: (Transaction | Promise<Transaction> | ABIValue | TransactionWithSigner | AppMethodCall<{
919
- signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
920
- sender: SendingAddress;
921
- rekeyTo?: ReadableAddress | undefined;
922
- note?: string | Uint8Array | undefined;
923
- lease?: string | Uint8Array | undefined;
924
- staticFee?: AlgoAmount | undefined;
925
- extraFee?: AlgoAmount | undefined;
926
- maxFee?: AlgoAmount | undefined;
927
- validityWindow?: number | bigint | undefined;
928
- firstValidRound?: bigint | undefined;
929
- lastValidRound?: bigint | undefined;
930
- onComplete?: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.UpdateApplication | OnApplicationComplete.DeleteApplication | undefined;
931
- args?: Uint8Array[] | undefined;
932
- accountReferences?: ReadableAddress[] | undefined;
933
- appReferences?: bigint[] | undefined;
934
- assetReferences?: bigint[] | undefined;
935
- boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
936
- accessReferences?: ResourceReference[] | undefined;
937
- rejectVersion?: number | undefined;
938
- appId?: 0 | undefined;
939
- approvalProgram: string | Uint8Array;
940
- clearStateProgram: string | Uint8Array;
941
- schema?: {
942
- globalInts: number;
943
- globalByteSlices: number;
944
- localInts: number;
945
- localByteSlices: number;
946
- } | undefined;
947
- extraProgramPages?: number | undefined;
948
- }> | AppMethodCall<{
949
- sender: SendingAddress;
950
- signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
951
- rekeyTo?: ReadableAddress | undefined;
952
- note?: string | Uint8Array | undefined;
953
- lease?: string | Uint8Array | undefined;
954
- staticFee?: AlgoAmount | undefined;
955
- extraFee?: AlgoAmount | undefined;
956
- maxFee?: AlgoAmount | undefined;
957
- validityWindow?: number | bigint | undefined;
958
- firstValidRound?: bigint | undefined;
959
- lastValidRound?: bigint | undefined;
960
- appId: bigint;
961
- onComplete?: OnApplicationComplete.UpdateApplication | undefined;
962
- args?: Uint8Array[] | undefined;
963
- accountReferences?: ReadableAddress[] | undefined;
964
- appReferences?: bigint[] | undefined;
965
- assetReferences?: bigint[] | undefined;
966
- boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
967
- accessReferences?: ResourceReference[] | undefined;
968
- rejectVersion?: number | undefined;
969
- approvalProgram: string | Uint8Array;
970
- clearStateProgram: string | Uint8Array;
971
- }> | AppMethodCall<AppMethodCallParams> | undefined)[] | undefined;
972
- } & SendParams) => Promise<SendAppUpdateTransactionResult>;
973
- /**
974
- * Delete a smart contract via an ABI method.
975
- *
976
- * Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality.
977
- *
978
- * @param params The parameters for the app deletion transaction
979
- * @example Basic example
980
- * ```typescript
981
- * const method = new ABIMethod({
982
- * name: 'method',
983
- * args: [{ name: 'arg1', type: 'string' }],
984
- * returns: { type: 'string' },
985
- * })
986
- * await algorand.send.appDeleteMethodCall({ sender: 'CREATORADDRESS', method: method, args: ["arg1_value"] })
987
- * ```
988
- * @example Advanced example
989
- * ```typescript
990
- * const method = new ABIMethod({
991
- * name: 'method',
992
- * args: [{ name: 'arg1', type: 'string' }],
993
- * returns: { type: 'string' },
994
- * })
995
- * await algorand.send.appDeleteMethodCall({
996
- * sender: 'CREATORADDRESS',
997
- * method: method,
998
- * args: ["arg1_value"],
999
- * onComplete: OnApplicationComplete.DeleteApplication,
1000
- * args: [new Uint8Array(1, 2, 3, 4)]
1001
- * accountReferences: ["ACCOUNT_1"]
1002
- * appReferences: [123n, 1234n]
1003
- * assetReferences: [12345n]
1004
- * boxReferences: ["box1", {appId: 1234n, name: "box2"}]
1005
- * accessReferences: [{ appId: 1234n }]
1006
- * lease: 'lease',
1007
- * note: 'note',
1008
- * // You wouldn't normally set this field
1009
- * firstValidRound: 1000n,
1010
- * validityWindow: 10,
1011
- * extraFee: (1000).microAlgo(),
1012
- * staticFee: (1000).microAlgo(),
1013
- * // Max fee doesn't make sense with extraFee AND staticFee
1014
- * // already specified, but here for completeness
1015
- * maxFee: (3000).microAlgo(),
1016
- * rejectVersion: 1,
1017
- * // Signer only needed if you want to provide one,
1018
- * // generally you'd register it with AlgorandClient
1019
- * // against the sender and not need to pass it in
1020
- * signer: transactionSigner,
1021
- * maxRoundsToWaitForConfirmation: 5,
1022
- * suppressLog: true,
1023
- *})
1024
- * ```
1025
- * @returns The result of the application ABI method delete transaction and the transaction that was sent
1026
- */
1027
- appDeleteMethodCall: (params: {
1028
- signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
1029
- sender: SendingAddress;
1030
- rekeyTo?: ReadableAddress | undefined;
1031
- note?: string | Uint8Array | undefined;
1032
- lease?: string | Uint8Array | undefined;
1033
- staticFee?: AlgoAmount | undefined;
1034
- extraFee?: AlgoAmount | undefined;
1035
- maxFee?: AlgoAmount | undefined;
1036
- validityWindow?: number | bigint | undefined;
1037
- firstValidRound?: bigint | undefined;
1038
- lastValidRound?: bigint | undefined;
1039
- appId: bigint;
1040
- onComplete?: OnApplicationComplete.DeleteApplication | undefined;
1041
- accountReferences?: ReadableAddress[] | undefined;
1042
- appReferences?: bigint[] | undefined;
1043
- assetReferences?: bigint[] | undefined;
1044
- boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
1045
- accessReferences?: ResourceReference[] | undefined;
1046
- rejectVersion?: number | undefined;
1047
- method: ABIMethod;
1048
- args?: (Transaction | Promise<Transaction> | ABIValue | TransactionWithSigner | AppMethodCall<{
1049
- signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
1050
- sender: SendingAddress;
1051
- rekeyTo?: ReadableAddress | undefined;
1052
- note?: string | Uint8Array | undefined;
1053
- lease?: string | Uint8Array | undefined;
1054
- staticFee?: AlgoAmount | undefined;
1055
- extraFee?: AlgoAmount | undefined;
1056
- maxFee?: AlgoAmount | undefined;
1057
- validityWindow?: number | bigint | undefined;
1058
- firstValidRound?: bigint | undefined;
1059
- lastValidRound?: bigint | undefined;
1060
- onComplete?: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.UpdateApplication | OnApplicationComplete.DeleteApplication | undefined;
1061
- args?: Uint8Array[] | undefined;
1062
- accountReferences?: ReadableAddress[] | undefined;
1063
- appReferences?: bigint[] | undefined;
1064
- assetReferences?: bigint[] | undefined;
1065
- boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
1066
- accessReferences?: ResourceReference[] | undefined;
1067
- rejectVersion?: number | undefined;
1068
- appId?: 0 | undefined;
1069
- approvalProgram: string | Uint8Array;
1070
- clearStateProgram: string | Uint8Array;
1071
- schema?: {
1072
- globalInts: number;
1073
- globalByteSlices: number;
1074
- localInts: number;
1075
- localByteSlices: number;
1076
- } | undefined;
1077
- extraProgramPages?: number | undefined;
1078
- }> | AppMethodCall<{
1079
- sender: SendingAddress;
1080
- signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
1081
- rekeyTo?: ReadableAddress | undefined;
1082
- note?: string | Uint8Array | undefined;
1083
- lease?: string | Uint8Array | undefined;
1084
- staticFee?: AlgoAmount | undefined;
1085
- extraFee?: AlgoAmount | undefined;
1086
- maxFee?: AlgoAmount | undefined;
1087
- validityWindow?: number | bigint | undefined;
1088
- firstValidRound?: bigint | undefined;
1089
- lastValidRound?: bigint | undefined;
1090
- appId: bigint;
1091
- onComplete?: OnApplicationComplete.UpdateApplication | undefined;
1092
- args?: Uint8Array[] | undefined;
1093
- accountReferences?: ReadableAddress[] | undefined;
1094
- appReferences?: bigint[] | undefined;
1095
- assetReferences?: bigint[] | undefined;
1096
- boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
1097
- accessReferences?: ResourceReference[] | undefined;
1098
- rejectVersion?: number | undefined;
1099
- approvalProgram: string | Uint8Array;
1100
- clearStateProgram: string | Uint8Array;
1101
- }> | AppMethodCall<AppMethodCallParams> | undefined)[] | undefined;
1102
- } & SendParams) => Promise<SendAppTransactionResult>;
1103
- /**
1104
- * Call a smart contract via an ABI method.
1105
- *
1106
- * Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality.
1107
- *
1108
- * @param params The parameters for the app call transaction
1109
- * @example Basic example
1110
- * ```typescript
1111
- * const method = new ABIMethod({
1112
- * name: 'method',
1113
- * args: [{ name: 'arg1', type: 'string' }],
1114
- * returns: { type: 'string' },
1115
- * })
1116
- * await algorand.send.appCallMethodCall({ sender: 'CREATORADDRESS', method: method, args: ["arg1_value"] })
1117
- * ```
1118
- * @example Advanced example
1119
- * ```typescript
1120
- * const method = new ABIMethod({
1121
- * name: 'method',
1122
- * args: [{ name: 'arg1', type: 'string' }],
1123
- * returns: { type: 'string' },
1124
- * })
1125
- * await algorand.send.appCallMethodCall({
1126
- * sender: 'CREATORADDRESS',
1127
- * method: method,
1128
- * args: ["arg1_value"],
1129
- * onComplete: OnApplicationComplete.OptIn,
1130
- * args: [new Uint8Array(1, 2, 3, 4)]
1131
- * accountReferences: ["ACCOUNT_1"]
1132
- * appReferences: [123n, 1234n]
1133
- * assetReferences: [12345n]
1134
- * boxReferences: ["box1", {appId: 1234n, name: "box2"}]
1135
- * accessReferences: [{ appId: 1234n }]
1136
- * lease: 'lease',
1137
- * note: 'note',
1138
- * // You wouldn't normally set this field
1139
- * firstValidRound: 1000n,
1140
- * validityWindow: 10,
1141
- * extraFee: (1000).microAlgo(),
1142
- * staticFee: (1000).microAlgo(),
1143
- * // Max fee doesn't make sense with extraFee AND staticFee
1144
- * // already specified, but here for completeness
1145
- * maxFee: (3000).microAlgo(),
1146
- * rejectVersion: 1,
1147
- * // Signer only needed if you want to provide one,
1148
- * // generally you'd register it with AlgorandClient
1149
- * // against the sender and not need to pass it in
1150
- * signer: transactionSigner,
1151
- * maxRoundsToWaitForConfirmation: 5,
1152
- * suppressLog: true,
1153
- *})
1154
- * ```
1155
- * @returns The result of the application ABI method call transaction and the transaction that was sent
1156
- */
1157
- appCallMethodCall: (params: {
1158
- signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
1159
- sender: SendingAddress;
1160
- rekeyTo?: ReadableAddress | undefined;
1161
- note?: string | Uint8Array | undefined;
1162
- lease?: string | Uint8Array | undefined;
1163
- staticFee?: AlgoAmount | undefined;
1164
- extraFee?: AlgoAmount | undefined;
1165
- maxFee?: AlgoAmount | undefined;
1166
- validityWindow?: number | bigint | undefined;
1167
- firstValidRound?: bigint | undefined;
1168
- lastValidRound?: bigint | undefined;
1169
- appId: bigint;
1170
- onComplete?: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.DeleteApplication | undefined;
1171
- accountReferences?: ReadableAddress[] | undefined;
1172
- appReferences?: bigint[] | undefined;
1173
- assetReferences?: bigint[] | undefined;
1174
- boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
1175
- accessReferences?: ResourceReference[] | undefined;
1176
- rejectVersion?: number | undefined;
1177
- method: ABIMethod;
1178
- args?: (Transaction | Promise<Transaction> | ABIValue | TransactionWithSigner | AppMethodCall<{
1179
- signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
1180
- sender: SendingAddress;
1181
- rekeyTo?: ReadableAddress | undefined;
1182
- note?: string | Uint8Array | undefined;
1183
- lease?: string | Uint8Array | undefined;
1184
- staticFee?: AlgoAmount | undefined;
1185
- extraFee?: AlgoAmount | undefined;
1186
- maxFee?: AlgoAmount | undefined;
1187
- validityWindow?: number | bigint | undefined;
1188
- firstValidRound?: bigint | undefined;
1189
- lastValidRound?: bigint | undefined;
1190
- onComplete?: OnApplicationComplete.NoOp | OnApplicationComplete.OptIn | OnApplicationComplete.CloseOut | OnApplicationComplete.UpdateApplication | OnApplicationComplete.DeleteApplication | undefined;
1191
- args?: Uint8Array[] | undefined;
1192
- accountReferences?: ReadableAddress[] | undefined;
1193
- appReferences?: bigint[] | undefined;
1194
- assetReferences?: bigint[] | undefined;
1195
- boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
1196
- accessReferences?: ResourceReference[] | undefined;
1197
- rejectVersion?: number | undefined;
1198
- appId?: 0 | undefined;
1199
- approvalProgram: string | Uint8Array;
1200
- clearStateProgram: string | Uint8Array;
1201
- schema?: {
1202
- globalInts: number;
1203
- globalByteSlices: number;
1204
- localInts: number;
1205
- localByteSlices: number;
1206
- } | undefined;
1207
- extraProgramPages?: number | undefined;
1208
- }> | AppMethodCall<{
1209
- sender: SendingAddress;
1210
- signer?: AddressWithTransactionSigner | TransactionSigner | undefined;
1211
- rekeyTo?: ReadableAddress | undefined;
1212
- note?: string | Uint8Array | undefined;
1213
- lease?: string | Uint8Array | undefined;
1214
- staticFee?: AlgoAmount | undefined;
1215
- extraFee?: AlgoAmount | undefined;
1216
- maxFee?: AlgoAmount | undefined;
1217
- validityWindow?: number | bigint | undefined;
1218
- firstValidRound?: bigint | undefined;
1219
- lastValidRound?: bigint | undefined;
1220
- appId: bigint;
1221
- onComplete?: OnApplicationComplete.UpdateApplication | undefined;
1222
- args?: Uint8Array[] | undefined;
1223
- accountReferences?: ReadableAddress[] | undefined;
1224
- appReferences?: bigint[] | undefined;
1225
- assetReferences?: bigint[] | undefined;
1226
- boxReferences?: (BoxReference | BoxIdentifier)[] | undefined;
1227
- accessReferences?: ResourceReference[] | undefined;
1228
- rejectVersion?: number | undefined;
1229
- approvalProgram: string | Uint8Array;
1230
- clearStateProgram: string | Uint8Array;
1231
- }> | AppMethodCall<AppMethodCallParams> | undefined)[] | undefined;
1232
- } & SendParams) => Promise<SendAppTransactionResult>;
1233
- /**
1234
- * Register an online key.
1235
- * @param params The parameters for the key registration transaction
1236
- * @example Basic example
1237
- * ```typescript
1238
- * const result = await algorand.send.onlineKeyRegistration({
1239
- * sender: 'SENDERADDRESS',
1240
- * voteKey: Uint8Array.from(Buffer.from("voteKeyBase64", 'base64')),
1241
- * selectionKey: Uint8Array.from(Buffer.from("selectionKeyBase64", 'base64')),
1242
- * stateProofKey: Uint8Array.from(Buffer.from("stateProofKeyBase64", 'base64')),
1243
- * voteFirst: 1n,
1244
- * voteLast: 1000n,
1245
- * voteKeyDilution: 1n,
1246
- * })
1247
- * ```
1248
- * @example Advanced example
1249
- * ```typescript
1250
- * const result = await algorand.send.onlineKeyRegistration({
1251
- * sender: 'SENDERADDRESS',
1252
- * voteKey: Uint8Array.from(Buffer.from("voteKeyBase64", 'base64')),
1253
- * selectionKey: Uint8Array.from(Buffer.from("selectionKeyBase64", 'base64')),
1254
- * stateProofKey: Uint8Array.from(Buffer.from("stateProofKeyBase64", 'base64')),
1255
- * voteFirst: 1n,
1256
- * voteLast: 1000n,
1257
- * voteKeyDilution: 1n,
1258
- * lease: 'lease',
1259
- * note: 'note',
1260
- * // Use this with caution, it's generally better to use algorand.account.rekeyAccount
1261
- * rekeyTo: 'REKEYTOADDRESS',
1262
- * // You wouldn't normally set this field
1263
- * firstValidRound: 1000n,
1264
- * validityWindow: 10,
1265
- * extraFee: (1000).microAlgo(),
1266
- * staticFee: (1000).microAlgo(),
1267
- * // Max fee doesn't make sense with extraFee AND staticFee
1268
- * // already specified, but here for completeness
1269
- * maxFee: (3000).microAlgo(),
1270
- * })
1271
- * ```
1272
- * @returns The result of the online key registration transaction and the transaction that was sent
1273
- */
1274
- onlineKeyRegistration: (params: CommonTransactionParams & {
1275
- voteKey: Uint8Array;
1276
- selectionKey: Uint8Array;
1277
- voteFirst: bigint;
1278
- voteLast: bigint;
1279
- voteKeyDilution: bigint;
1280
- stateProofKey: Uint8Array;
1281
- } & SendParams) => Promise<SendSingleTransactionResult>;
1282
- /**
1283
- * Register an offline key.
1284
- * @param params The parameters for the key registration transaction
1285
- * @example Basic example
1286
- * ```typescript
1287
- * const result = await algorand.send.offlineKeyRegistration({
1288
- * sender: 'SENDERADDRESS',
1289
- * })
1290
- * ```
1291
- * @example Advanced example
1292
- * ```typescript
1293
- * const result = await algorand.send.offlineKeyRegistration({
1294
- * sender: 'SENDERADDRESS',
1295
- * lease: 'lease',
1296
- * note: 'note',
1297
- * // Use this with caution, it's generally better to use algorand.account.rekeyAccount
1298
- * rekeyTo: 'REKEYTOADDRESS',
1299
- * // You wouldn't normally set this field
1300
- * firstValidRound: 1000n,
1301
- * validityWindow: 10,
1302
- * extraFee: (1000).microAlgo(),
1303
- * staticFee: (1000).microAlgo(),
1304
- * // Max fee doesn't make sense with extraFee AND staticFee
1305
- * // already specified, but here for completeness
1306
- * maxFee: (3000).microAlgo(),
1307
- * })
1308
- * ```
1309
- * @returns The result of the offline key registration transaction and the transaction that was sent
1310
- */
1311
- offlineKeyRegistration: (params: CommonTransactionParams & {
1312
- preventAccountFromEverParticipatingAgain?: boolean | undefined;
1313
- } & SendParams) => Promise<SendSingleTransactionResult>;
1314
- }
4
+ /** @deprecated Import from `@algorandfoundation/algokit-utils/algorand-client-transaction-sender` instead */
5
+ declare const AlgorandClientTransactionSender: typeof AlgorandClientTransactionSender$1;
6
+ /** @deprecated Import from `@algorandfoundation/algokit-utils/algorand-client-transaction-sender` instead */
7
+ type AlgorandClientTransactionSender = AlgorandClientTransactionSender$1;
1315
8
  //#endregion
1316
9
  export { AlgorandClientTransactionSender };
1317
10
  //# sourceMappingURL=algorand-client-transaction-sender.d.ts.map