@algorandfoundation/algokit-utils 9.2.0 → 9.2.1-beta.2

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 (340) hide show
  1. package/_virtual/_rolldown/runtime.js +33 -0
  2. package/_virtual/_rolldown/runtime.mjs +13 -0
  3. package/account/account.d.ts +25 -30
  4. package/account/account.js +151 -146
  5. package/account/account.js.map +1 -1
  6. package/account/account.mjs +149 -144
  7. package/account/account.mjs.map +1 -1
  8. package/account/get-account-config-from-environment.d.ts +7 -2
  9. package/account/get-account-config-from-environment.js +19 -21
  10. package/account/get-account-config-from-environment.js.map +1 -1
  11. package/account/get-account-config-from-environment.mjs +19 -19
  12. package/account/get-account-config-from-environment.mjs.map +1 -1
  13. package/account/get-account.d.ts +14 -12
  14. package/account/get-account.js +56 -59
  15. package/account/get-account.js.map +1 -1
  16. package/account/get-account.mjs +56 -57
  17. package/account/get-account.mjs.map +1 -1
  18. package/account/get-dispenser-account.d.ts +9 -5
  19. package/account/get-dispenser-account.js +20 -18
  20. package/account/get-dispenser-account.js.map +1 -1
  21. package/account/get-dispenser-account.mjs +20 -16
  22. package/account/get-dispenser-account.mjs.map +1 -1
  23. package/account/mnemonic-account.d.ts +7 -3
  24. package/account/mnemonic-account.js +17 -17
  25. package/account/mnemonic-account.js.map +1 -1
  26. package/account/mnemonic-account.mjs +15 -15
  27. package/account/mnemonic-account.mjs.map +1 -1
  28. package/amount.d.ts +40 -35
  29. package/amount.js +33 -34
  30. package/amount.js.map +1 -1
  31. package/amount.mjs +33 -32
  32. package/amount.mjs.map +1 -1
  33. package/app-client.d.ts +10 -6
  34. package/app-client.js +91 -86
  35. package/app-client.js.map +1 -1
  36. package/app-client.mjs +91 -84
  37. package/app-client.mjs.map +1 -1
  38. package/app-deploy.d.ts +26 -24
  39. package/app-deploy.js +235 -253
  40. package/app-deploy.js.map +1 -1
  41. package/app-deploy.mjs +233 -251
  42. package/app-deploy.mjs.map +1 -1
  43. package/app.d.ts +45 -46
  44. package/app.js +253 -271
  45. package/app.js.map +1 -1
  46. package/app.mjs +249 -267
  47. package/app.mjs.map +1 -1
  48. package/asset.d.ts +16 -12
  49. package/asset.js +116 -122
  50. package/asset.js.map +1 -1
  51. package/asset.mjs +116 -120
  52. package/asset.mjs.map +1 -1
  53. package/config.d.ts +7 -2
  54. package/config.js +5 -7
  55. package/config.js.map +1 -1
  56. package/config.mjs +5 -4
  57. package/config.mjs.map +1 -1
  58. package/debugging/debugging.d.ts +5 -1
  59. package/debugging/debugging.js +11 -11
  60. package/debugging/debugging.js.map +1 -1
  61. package/debugging/debugging.mjs +11 -9
  62. package/debugging/debugging.mjs.map +1 -1
  63. package/dispenser-client.d.ts +7 -2
  64. package/dispenser-client.js +23 -24
  65. package/dispenser-client.js.map +1 -1
  66. package/dispenser-client.mjs +23 -22
  67. package/dispenser-client.mjs.map +1 -1
  68. package/index.d.ts +27 -18
  69. package/index.js +140 -143
  70. package/index.mjs +27 -29
  71. package/indexer-lookup.d.ts +18 -11
  72. package/indexer-lookup.js +112 -120
  73. package/indexer-lookup.js.map +1 -1
  74. package/indexer-lookup.mjs +105 -118
  75. package/indexer-lookup.mjs.map +1 -1
  76. package/localnet/get-kmd-wallet-account.d.ts +9 -7
  77. package/localnet/get-kmd-wallet-account.js +28 -26
  78. package/localnet/get-kmd-wallet-account.js.map +1 -1
  79. package/localnet/get-kmd-wallet-account.mjs +28 -24
  80. package/localnet/get-kmd-wallet-account.mjs.map +1 -1
  81. package/localnet/get-localnet-dispenser-account.d.ts +7 -5
  82. package/localnet/get-localnet-dispenser-account.js +17 -15
  83. package/localnet/get-localnet-dispenser-account.js.map +1 -1
  84. package/localnet/get-localnet-dispenser-account.mjs +17 -13
  85. package/localnet/get-localnet-dispenser-account.mjs.map +1 -1
  86. package/localnet/get-or-create-kmd-wallet-account.d.ts +10 -8
  87. package/localnet/get-or-create-kmd-wallet-account.js +28 -26
  88. package/localnet/get-or-create-kmd-wallet-account.js.map +1 -1
  89. package/localnet/get-or-create-kmd-wallet-account.mjs +28 -24
  90. package/localnet/get-or-create-kmd-wallet-account.mjs.map +1 -1
  91. package/localnet/is-localnet.d.ts +7 -3
  92. package/localnet/is-localnet.js +9 -10
  93. package/localnet/is-localnet.js.map +1 -1
  94. package/localnet/is-localnet.mjs +9 -8
  95. package/localnet/is-localnet.mjs.map +1 -1
  96. package/network-client.d.ts +17 -15
  97. package/network-client.js +115 -116
  98. package/network-client.js.map +1 -1
  99. package/network-client.mjs +115 -114
  100. package/network-client.mjs.map +1 -1
  101. package/package.json +12 -3
  102. package/testing/account.d.ts +11 -9
  103. package/testing/account.js +31 -33
  104. package/testing/account.js.map +1 -1
  105. package/testing/account.mjs +29 -31
  106. package/testing/account.mjs.map +1 -1
  107. package/testing/fixtures/algokit-log-capture-fixture.d.ts +7 -2
  108. package/testing/fixtures/algokit-log-capture-fixture.js +36 -41
  109. package/testing/fixtures/algokit-log-capture-fixture.js.map +1 -1
  110. package/testing/fixtures/algokit-log-capture-fixture.mjs +36 -39
  111. package/testing/fixtures/algokit-log-capture-fixture.mjs.map +1 -1
  112. package/testing/fixtures/algorand-fixture.d.ts +9 -4
  113. package/testing/fixtures/algorand-fixture.js +67 -62
  114. package/testing/fixtures/algorand-fixture.js.map +1 -1
  115. package/testing/fixtures/algorand-fixture.mjs +66 -59
  116. package/testing/fixtures/algorand-fixture.mjs.map +1 -1
  117. package/testing/index.d.ts +7 -5
  118. package/testing/index.js +13 -18
  119. package/testing/index.mjs +7 -7
  120. package/testing/indexer.d.ts +5 -1
  121. package/testing/indexer.js +28 -37
  122. package/testing/indexer.js.map +1 -1
  123. package/testing/indexer.mjs +28 -35
  124. package/testing/indexer.mjs.map +1 -1
  125. package/testing/test-logger.d.ts +41 -36
  126. package/testing/test-logger.js +71 -76
  127. package/testing/test-logger.js.map +1 -1
  128. package/testing/test-logger.mjs +71 -74
  129. package/testing/test-logger.mjs.map +1 -1
  130. package/testing/transaction-logger.d.ts +30 -27
  131. package/testing/transaction-logger.js +77 -93
  132. package/testing/transaction-logger.js.map +1 -1
  133. package/testing/transaction-logger.mjs +74 -90
  134. package/testing/transaction-logger.mjs.map +1 -1
  135. package/transaction/legacy-bridge.js +100 -111
  136. package/transaction/legacy-bridge.js.map +1 -1
  137. package/transaction/legacy-bridge.mjs +97 -108
  138. package/transaction/legacy-bridge.mjs.map +1 -1
  139. package/transaction/perform-atomic-transaction-composer-simulate.d.ts +7 -5
  140. package/transaction/perform-atomic-transaction-composer-simulate.js +31 -36
  141. package/transaction/perform-atomic-transaction-composer-simulate.js.map +1 -1
  142. package/transaction/perform-atomic-transaction-composer-simulate.mjs +28 -33
  143. package/transaction/perform-atomic-transaction-composer-simulate.mjs.map +1 -1
  144. package/transaction/transaction.d.ts +34 -35
  145. package/transaction/transaction.js +716 -914
  146. package/transaction/transaction.js.map +1 -1
  147. package/transaction/transaction.mjs +713 -911
  148. package/transaction/transaction.mjs.map +1 -1
  149. package/transfer/transfer-algos.d.ts +9 -5
  150. package/transfer/transfer-algos.js +26 -27
  151. package/transfer/transfer-algos.js.map +1 -1
  152. package/transfer/transfer-algos.mjs +26 -25
  153. package/transfer/transfer-algos.mjs.map +1 -1
  154. package/transfer/transfer.d.ts +11 -8
  155. package/transfer/transfer.js +94 -100
  156. package/transfer/transfer.js.map +1 -1
  157. package/transfer/transfer.mjs +94 -98
  158. package/transfer/transfer.mjs.map +1 -1
  159. package/types/account-manager.d.ts +432 -429
  160. package/types/account-manager.js +591 -602
  161. package/types/account-manager.js.map +1 -1
  162. package/types/account-manager.mjs +587 -599
  163. package/types/account-manager.mjs.map +1 -1
  164. package/types/account.d.ts +192 -202
  165. package/types/account.js +91 -88
  166. package/types/account.js.map +1 -1
  167. package/types/account.mjs +88 -86
  168. package/types/account.mjs.map +1 -1
  169. package/types/algo-http-client-with-retry.d.ts +15 -10
  170. package/types/algo-http-client-with-retry.js +70 -92
  171. package/types/algo-http-client-with-retry.js.map +1 -1
  172. package/types/algo-http-client-with-retry.mjs +69 -90
  173. package/types/algo-http-client-with-retry.mjs.map +1 -1
  174. package/types/algorand-client-transaction-creator.d.ts +778 -771
  175. package/types/algorand-client-transaction-creator.js +733 -732
  176. package/types/algorand-client-transaction-creator.js.map +1 -1
  177. package/types/algorand-client-transaction-creator.mjs +732 -730
  178. package/types/algorand-client-transaction-creator.mjs.map +1 -1
  179. package/types/algorand-client-transaction-sender.d.ts +1090 -1360
  180. package/types/algorand-client-transaction-sender.js +930 -961
  181. package/types/algorand-client-transaction-sender.js.map +1 -1
  182. package/types/algorand-client-transaction-sender.mjs +927 -959
  183. package/types/algorand-client-transaction-sender.mjs.map +1 -1
  184. package/types/algorand-client.d.ts +239 -236
  185. package/types/algorand-client.js +322 -320
  186. package/types/algorand-client.js.map +1 -1
  187. package/types/algorand-client.mjs +321 -318
  188. package/types/algorand-client.mjs.map +1 -1
  189. package/types/amount.d.ts +47 -43
  190. package/types/amount.js +66 -70
  191. package/types/amount.js.map +1 -1
  192. package/types/amount.mjs +63 -68
  193. package/types/amount.mjs.map +1 -1
  194. package/types/app-arc56.d.ts +235 -272
  195. package/types/app-arc56.js +124 -170
  196. package/types/app-arc56.js.map +1 -1
  197. package/types/app-arc56.mjs +121 -168
  198. package/types/app-arc56.mjs.map +1 -1
  199. package/types/app-client.d.ts +1128 -2009
  200. package/types/app-client.js +1633 -1791
  201. package/types/app-client.js.map +1 -1
  202. package/types/app-client.mjs +1624 -1783
  203. package/types/app-client.mjs.map +1 -1
  204. package/types/app-deployer.d.ts +139 -141
  205. package/types/app-deployer.js +344 -384
  206. package/types/app-deployer.js.map +1 -1
  207. package/types/app-deployer.mjs +341 -382
  208. package/types/app-deployer.mjs.map +1 -1
  209. package/types/app-factory.d.ts +762 -932
  210. package/types/app-factory.js +496 -488
  211. package/types/app-factory.js.map +1 -1
  212. package/types/app-factory.mjs +491 -484
  213. package/types/app-factory.mjs.map +1 -1
  214. package/types/app-manager.d.ts +304 -310
  215. package/types/app-manager.js +422 -475
  216. package/types/app-manager.js.map +1 -1
  217. package/types/app-manager.mjs +419 -473
  218. package/types/app-manager.mjs.map +1 -1
  219. package/types/app-spec.d.ts +118 -117
  220. package/types/app-spec.js +125 -135
  221. package/types/app-spec.js.map +1 -1
  222. package/types/app-spec.mjs +121 -132
  223. package/types/app-spec.mjs.map +1 -1
  224. package/types/app.d.ts +229 -241
  225. package/types/app.js +36 -28
  226. package/types/app.js.map +1 -1
  227. package/types/app.mjs +33 -26
  228. package/types/app.mjs.map +1 -1
  229. package/types/asset-manager.d.ts +204 -199
  230. package/types/asset-manager.js +165 -174
  231. package/types/asset-manager.js.map +1 -1
  232. package/types/asset-manager.mjs +164 -172
  233. package/types/asset-manager.mjs.map +1 -1
  234. package/types/asset.d.ts +95 -91
  235. package/types/asset.js +0 -3
  236. package/types/asset.mjs +0 -2
  237. package/types/async-event-emitter.d.ts +18 -13
  238. package/types/async-event-emitter.js +37 -49
  239. package/types/async-event-emitter.js.map +1 -1
  240. package/types/async-event-emitter.mjs +36 -47
  241. package/types/async-event-emitter.mjs.map +1 -1
  242. package/types/client-manager.d.ts +453 -451
  243. package/types/client-manager.js +602 -598
  244. package/types/client-manager.js.map +1 -1
  245. package/types/client-manager.mjs +597 -594
  246. package/types/client-manager.mjs.map +1 -1
  247. package/types/composer.d.ts +1211 -1258
  248. package/types/composer.js +1436 -1498
  249. package/types/composer.js.map +1 -1
  250. package/types/composer.mjs +1430 -1493
  251. package/types/composer.mjs.map +1 -1
  252. package/types/config.d.ts +53 -48
  253. package/types/config.js +78 -77
  254. package/types/config.js.map +1 -1
  255. package/types/config.mjs +77 -75
  256. package/types/config.mjs.map +1 -1
  257. package/types/debugging.d.ts +25 -23
  258. package/types/debugging.js +9 -11
  259. package/types/debugging.js.map +1 -1
  260. package/types/debugging.mjs +8 -9
  261. package/types/debugging.mjs.map +1 -1
  262. package/types/dispenser-client.d.ts +57 -52
  263. package/types/dispenser-client.js +120 -141
  264. package/types/dispenser-client.js.map +1 -1
  265. package/types/dispenser-client.mjs +119 -139
  266. package/types/dispenser-client.mjs.map +1 -1
  267. package/types/expand.d.ts +5 -3
  268. package/types/expand.js +0 -3
  269. package/types/expand.mjs +0 -2
  270. package/types/indexer.d.ts +104 -100
  271. package/types/indexer.js +36 -31
  272. package/types/indexer.js.map +1 -1
  273. package/types/indexer.mjs +32 -30
  274. package/types/indexer.mjs.map +1 -1
  275. package/types/instance-of.d.ts +5 -3
  276. package/types/instance-of.js +0 -3
  277. package/types/instance-of.mjs +0 -2
  278. package/types/kmd-account-manager.d.ts +75 -70
  279. package/types/kmd-account-manager.js +150 -184
  280. package/types/kmd-account-manager.js.map +1 -1
  281. package/types/kmd-account-manager.mjs +147 -182
  282. package/types/kmd-account-manager.mjs.map +1 -1
  283. package/types/lifecycle-events.d.ts +13 -8
  284. package/types/lifecycle-events.js +10 -7
  285. package/types/lifecycle-events.js.map +1 -1
  286. package/types/lifecycle-events.mjs +9 -7
  287. package/types/lifecycle-events.mjs.map +1 -1
  288. package/types/logging.d.ts +15 -11
  289. package/types/logging.js +30 -31
  290. package/types/logging.js.map +1 -1
  291. package/types/logging.mjs +29 -29
  292. package/types/logging.mjs.map +1 -1
  293. package/types/logic-error.d.ts +33 -29
  294. package/types/logic-error.js +50 -49
  295. package/types/logic-error.js.map +1 -1
  296. package/types/logic-error.mjs +49 -47
  297. package/types/logic-error.mjs.map +1 -1
  298. package/types/network-client.d.ts +32 -27
  299. package/types/network-client.js +10 -9
  300. package/types/network-client.js.map +1 -1
  301. package/types/network-client.mjs +9 -7
  302. package/types/network-client.mjs.map +1 -1
  303. package/types/testing.d.ts +131 -132
  304. package/types/testing.js +0 -3
  305. package/types/testing.mjs +0 -2
  306. package/types/transaction.d.ts +110 -110
  307. package/types/transaction.js +0 -3
  308. package/types/transaction.mjs +0 -2
  309. package/types/transfer.d.ts +70 -66
  310. package/types/transfer.js +0 -3
  311. package/types/transfer.mjs +0 -2
  312. package/util.js +73 -118
  313. package/util.js.map +1 -1
  314. package/util.mjs +73 -116
  315. package/util.mjs.map +1 -1
  316. package/account/index.d.ts +0 -5
  317. package/debugging/index.d.ts +0 -1
  318. package/index.js.map +0 -1
  319. package/index.mjs.map +0 -1
  320. package/localnet/index.d.ts +0 -4
  321. package/testing/_asset.d.ts +0 -3
  322. package/testing/fixtures/index.d.ts +0 -2
  323. package/testing/index.js.map +0 -1
  324. package/testing/index.mjs.map +0 -1
  325. package/transaction/index.d.ts +0 -2
  326. package/transaction/legacy-bridge.d.ts +0 -35
  327. package/transfer/index.d.ts +0 -2
  328. package/types/asset.js.map +0 -1
  329. package/types/asset.mjs.map +0 -1
  330. package/types/expand.js.map +0 -1
  331. package/types/expand.mjs.map +0 -1
  332. package/types/instance-of.js.map +0 -1
  333. package/types/instance-of.mjs.map +0 -1
  334. package/types/testing.js.map +0 -1
  335. package/types/testing.mjs.map +0 -1
  336. package/types/transaction.js.map +0 -1
  337. package/types/transaction.mjs.map +0 -1
  338. package/types/transfer.js.map +0 -1
  339. package/types/transfer.mjs.map +0 -1
  340. package/util.d.ts +0 -48
@@ -1,42 +1,43 @@
1
- import algosdk, { Address } from 'algosdk';
2
- import { TransactionSignerAccount } from './account';
3
- import { BoxName, type ABIReturn, type AppState, type CompiledTeal, type TealTemplateParams } from './app';
4
- import modelsv2 = algosdk.modelsv2;
1
+ import { TransactionSignerAccount } from "./account.js";
2
+ import { ABIReturn, AppState, BoxName, CompiledTeal, TealTemplateParams } from "./app.js";
3
+ import algosdk, { Address } from "algosdk";
4
+
5
+ //#region src/types/app-manager.d.ts
5
6
  /** Information about an app. */
6
- export interface AppInformation {
7
- /** The ID of the app. */
8
- appId: bigint;
9
- /** The escrow address that the app operates with. */
10
- appAddress: Address;
11
- /**
12
- * Approval program.
13
- */
14
- approvalProgram: Uint8Array;
15
- /**
16
- * Clear state program.
17
- */
18
- clearStateProgram: Uint8Array;
19
- /**
20
- * The address that created this application. This is the address where the
21
- * parameters and global state for this application can be found.
22
- */
23
- creator: Address;
24
- /**
25
- * Current global state values.
26
- */
27
- globalState: AppState;
28
- /** The number of allocated ints in per-user local state. */
29
- localInts: number;
30
- /** The number of allocated byte slices in per-user local state. */
31
- localByteSlices: number;
32
- /** The number of allocated ints in global state. */
33
- globalInts: number;
34
- /** The number of allocated byte slices in global state. */
35
- globalByteSlices: number;
36
- /** Any extra pages that are needed for the smart contract. */
37
- extraProgramPages?: number;
38
- /** The number of updates to the application programs */
39
- version?: number;
7
+ interface AppInformation {
8
+ /** The ID of the app. */
9
+ appId: bigint;
10
+ /** The escrow address that the app operates with. */
11
+ appAddress: Address;
12
+ /**
13
+ * Approval program.
14
+ */
15
+ approvalProgram: Uint8Array;
16
+ /**
17
+ * Clear state program.
18
+ */
19
+ clearStateProgram: Uint8Array;
20
+ /**
21
+ * The address that created this application. This is the address where the
22
+ * parameters and global state for this application can be found.
23
+ */
24
+ creator: Address;
25
+ /**
26
+ * Current global state values.
27
+ */
28
+ globalState: AppState;
29
+ /** The number of allocated ints in per-user local state. */
30
+ localInts: number;
31
+ /** The number of allocated byte slices in per-user local state. */
32
+ localByteSlices: number;
33
+ /** The number of allocated ints in global state. */
34
+ globalInts: number;
35
+ /** The number of allocated byte slices in global state. */
36
+ globalByteSlices: number;
37
+ /** Any extra pages that are needed for the smart contract. */
38
+ extraProgramPages?: number;
39
+ /** The number of updates to the application programs */
40
+ version?: number;
40
41
  }
41
42
  /**
42
43
  * Something that identifies an app box name - either a:
@@ -45,301 +46,294 @@ export interface AppInformation {
45
46
  * * `TransactionSignerAccount` (that will be encoded into the
46
47
  * public key address of the corresponding account)
47
48
  */
48
- export type BoxIdentifier = string | Uint8Array | TransactionSignerAccount;
49
+ type BoxIdentifier = string | Uint8Array | TransactionSignerAccount;
49
50
  /**
50
51
  * A grouping of the app ID and name identifier to reference an app box.
51
52
  */
52
- export interface BoxReference {
53
- /**
54
- * A unique application id
55
- */
56
- appId: bigint;
57
- /**
58
- * Identifier for a box name
59
- */
60
- name: BoxIdentifier;
53
+ interface BoxReference {
54
+ /**
55
+ * A unique application id
56
+ */
57
+ appId: bigint;
58
+ /**
59
+ * Identifier for a box name
60
+ */
61
+ name: BoxIdentifier;
61
62
  }
62
63
  /**
63
64
  * Parameters to get and decode a box value as an ABI type.
64
65
  */
65
- export interface BoxValueRequestParams {
66
- /** The ID of the app return box names for */
67
- appId: bigint;
68
- /** The name of the box to return either as a string, binary array or `BoxName` */
69
- boxName: BoxIdentifier;
70
- /** The ABI type to decode the value using */
71
- type: algosdk.ABIType;
66
+ interface BoxValueRequestParams {
67
+ /** The ID of the app return box names for */
68
+ appId: bigint;
69
+ /** The name of the box to return either as a string, binary array or `BoxName` */
70
+ boxName: BoxIdentifier;
71
+ /** The ABI type to decode the value using */
72
+ type: algosdk.ABIType;
72
73
  }
73
74
  /**
74
75
  * Parameters to get and decode a box value as an ABI type.
75
76
  */
76
- export interface BoxValuesRequestParams {
77
- /** The ID of the app return box names for */
78
- appId: bigint;
79
- /** The names of the boxes to return either as a string, binary array or BoxName` */
80
- boxNames: BoxIdentifier[];
81
- /** The ABI type to decode the value using */
82
- type: algosdk.ABIType;
77
+ interface BoxValuesRequestParams {
78
+ /** The ID of the app return box names for */
79
+ appId: bigint;
80
+ /** The names of the boxes to return either as a string, binary array or BoxName` */
81
+ boxNames: BoxIdentifier[];
82
+ /** The ABI type to decode the value using */
83
+ type: algosdk.ABIType;
83
84
  }
84
85
  /**
85
86
  * Defines a holding by referring to an Address and Asset it belongs to.
86
87
  */
87
- export type HoldingReference = {
88
- /** Asset ID for asset in access list. */
89
- assetId: bigint;
90
- /** Address in access list, or the sender of the transaction. */
91
- address: Address;
88
+ type HoldingReference = {
89
+ /** Asset ID for asset in access list. */assetId: bigint; /** Address in access list, or the sender of the transaction. */
90
+ address: Address;
92
91
  };
93
92
  /**
94
93
  * Defines a local state by referring to an Address and App it belongs to.
95
94
  */
96
- export type LocalsReference = {
97
- /** Application ID for app in access list, or zero if referring to the called application. */
98
- appId: bigint;
99
- /** Address in access list, or the sender of the transaction. */
100
- address: Address;
95
+ type LocalsReference = {
96
+ /** Application ID for app in access list, or zero if referring to the called application. */appId: bigint; /** Address in access list, or the sender of the transaction. */
97
+ address: Address;
101
98
  };
102
99
  /**
103
100
  * Names a single resource reference. Only one of the fields should be set.
104
101
  */
105
- export type ResourceReference = {
106
- /** Any account addresses whose balance record is accessible by the executing ApprovalProgram or ClearStateProgram. */
107
- address?: Address;
108
- /** Application ID whose GlobalState may be read by the executing ApprovalProgram or ClearStateProgram. */
109
- appId?: bigint;
110
- /** Asset ID whose AssetParams may be read by the executing ApprovalProgram or ClearStateProgram. */
111
- assetId?: bigint;
112
- /** Defines a holding by referring to an Address and Asset it belongs to. */
113
- holding?: HoldingReference;
114
- /** Defines a local state by referring to an Address and App it belongs to. */
115
- locals?: LocalsReference;
116
- /** Defines a box by its name and the application ID it belongs to. */
117
- box?: BoxReference;
102
+ type ResourceReference = {
103
+ /** Any account addresses whose balance record is accessible by the executing ApprovalProgram or ClearStateProgram. */address?: Address; /** Application ID whose GlobalState may be read by the executing ApprovalProgram or ClearStateProgram. */
104
+ appId?: bigint; /** Asset ID whose AssetParams may be read by the executing ApprovalProgram or ClearStateProgram. */
105
+ assetId?: bigint; /** Defines a holding by referring to an Address and Asset it belongs to. */
106
+ holding?: HoldingReference; /** Defines a local state by referring to an Address and App it belongs to. */
107
+ locals?: LocalsReference; /** Defines a box by its name and the application ID it belongs to. */
108
+ box?: BoxReference;
118
109
  };
119
110
  /** Allows management of application information. */
120
- export declare class AppManager {
121
- private _algod;
122
- private _compilationResults;
123
- /**
124
- * Creates an `AppManager`
125
- * @param algod An algod instance
126
- */
127
- constructor(algod: algosdk.Algodv2);
128
- /**
129
- * Compiles the given TEAL using algod and returns the result, including source map.
130
- *
131
- * The result of this compilation is also cached keyed by the TEAL
132
- * code so it can be retrieved via `getCompilationResult`.
133
- *
134
- * This function is re-entrant; it will only compile the same code once.
135
- *
136
- * @param tealCode The TEAL code
137
- * @returns The information about the compiled file
138
- * @example
139
- * ```typescript
140
- * const compiled = await appManager.compileTeal(tealProgram)
141
- * ```
142
- */
143
- compileTeal(tealCode: string): Promise<CompiledTeal>;
144
- /**
145
- * Performs template substitution of a teal template and compiles it, returning the compiled result.
146
- *
147
- * Looks for `TMPL_{parameter}` for template replacements and replaces AlgoKit deploy-time control parameters
148
- * if deployment metadata is specified.
149
- *
150
- * * `TMPL_UPDATABLE` for updatability / immutability control
151
- * * `TMPL_DELETABLE` for deletability / permanence control
152
- *
153
- * @param tealTemplateCode The TEAL logic to compile
154
- * @param templateParams Any parameters to replace in the .teal file before compiling
155
- * @param deploymentMetadata The deployment metadata the app will be deployed with
156
- * @returns The information about the compiled code
157
- * @example
158
- * ```typescript
159
- * const compiled = await appManager.compileTealTemplate(tealTemplate, { TMPL_APP_ID: 12345n }, { updatable: true, deletable: false })
160
- * ```
161
- */
162
- compileTealTemplate(tealTemplateCode: string, templateParams?: TealTemplateParams, deploymentMetadata?: {
163
- updatable?: boolean;
164
- deletable?: boolean;
165
- }): Promise<CompiledTeal>;
166
- /**
167
- * Returns a previous compilation result.
168
- * @param tealCode The TEAL code
169
- * @returns The information about the previously compiled file
170
- * or `undefined` if that TEAL code wasn't previously compiled
171
- * @example
172
- * ```typescript
173
- * const compiled = appManager.getCompilationResult(tealProgram)
174
- * ```
175
- */
176
- getCompilationResult(tealCode: string): CompiledTeal | undefined;
177
- /**
178
- * Returns the current app information for the app with the given ID.
179
- *
180
- * @example
181
- * ```typescript
182
- * const appInfo = await appManager.getById(12353n);
183
- * ```
184
- *
185
- * @param appId The ID of the app
186
- * @returns The app information
187
- */
188
- getById(appId: bigint): Promise<AppInformation>;
189
- /**
190
- * Returns the current global state values for the given app ID and account address
191
- *
192
- * @param appId The ID of the app to return global state for
193
- * @returns The current global state for the given app
194
- * @example
195
- * ```typescript
196
- * const globalState = await appManager.getGlobalState(12353n);
197
- * ```
198
- */
199
- getGlobalState(appId: bigint): Promise<AppState>;
200
- /**
201
- * Returns the current local state values for the given app ID and account address
202
- *
203
- * @param appId The ID of the app to return local state for
204
- * @param address The string address of the account to get local state for the given app
205
- * @returns The current local state for the given (app, account) combination
206
- * @example
207
- * ```typescript
208
- * const localState = await appManager.getLocalState(12353n, 'ACCOUNTADDRESS');
209
- * ```
210
- */
211
- getLocalState(appId: bigint, address: Address | string): Promise<AppState>;
212
- /**
213
- * Returns the names of the current boxes for the given app.
214
- * @param appId The ID of the app return box names for
215
- * @returns The current box names
216
- * @example
217
- * ```typescript
218
- * const boxNames = await appManager.getBoxNames(12353n);
219
- * ```
220
- */
221
- getBoxNames(appId: bigint): Promise<BoxName[]>;
222
- /**
223
- * Returns the value of the given box name for the given app.
224
- * @param appId The ID of the app return box names for
225
- * @param boxName The name of the box to return either as a string, binary array or `BoxName`
226
- * @returns The current box value as a byte array
227
- * @example
228
- * ```typescript
229
- * const boxValue = await appManager.getBoxValue(12353n, 'boxName');
230
- * ```
231
- */
232
- getBoxValue(appId: bigint, boxName: BoxIdentifier | BoxName): Promise<Uint8Array>;
233
- /**
234
- * Returns the value of the given box names for the given app.
235
- * @param appId The ID of the app return box names for
236
- * @param boxNames The names of the boxes to return either as a string, binary array or `BoxName`
237
- * @returns The current box values as a byte array in the same order as the passed in box names
238
- * @example
239
- * ```typescript
240
- * const boxValues = await appManager.getBoxValues(12353n, ['boxName1', 'boxName2']);
241
- * ```
242
- */
243
- getBoxValues(appId: bigint, boxNames: (BoxIdentifier | BoxName)[]): Promise<Uint8Array[]>;
244
- /**
245
- * Returns the value of the given box name for the given app decoded based on the given ABI type.
246
- * @param request The parameters for the box value request
247
- * @returns The current box value as an ABI value
248
- * @example
249
- * ```typescript
250
- * const boxValue = await appManager.getBoxValueFromABIType({ appId: 12353n, boxName: 'boxName', type: new ABIUintType(32) });
251
- * ```
252
- */
253
- getBoxValueFromABIType(request: BoxValueRequestParams): Promise<algosdk.ABIValue>;
254
- /**
255
- * Returns the value of the given box names for the given app decoded based on the given ABI type.
256
- * @param request The parameters for the box value request
257
- * @returns The current box values as an ABI value in the same order as the passed in box names
258
- * @example
259
- * ```typescript
260
- * const boxValues = await appManager.getBoxValuesFromABIType({ appId: 12353n, boxNames: ['boxName1', 'boxName2'], type: new ABIUintType(32) });
261
- * ```
262
- */
263
- getBoxValuesFromABIType(request: BoxValuesRequestParams): Promise<algosdk.ABIValue[]>;
264
- /**
265
- * Returns a `algosdk.BoxReference` given a `BoxIdentifier` or `BoxReference`.
266
- * @param boxId The box to return a reference for
267
- * @returns The box reference ready to pass into a `algosdk.Transaction`
268
- * @example
269
- * ```typescript
270
- * const boxRef = AppManager.getBoxReference('boxName');
271
- * ```
272
- */
273
- static getBoxReference(boxId: BoxIdentifier | BoxReference): algosdk.BoxReference;
274
- /**
275
- * Converts an array of global/local state values from the algod api to a more friendly
276
- * generic object keyed by the UTF-8 value of the key.
277
- * @param state A `global-state`, `local-state`, `global-state-deltas` or `local-state-deltas`
278
- * @returns An object keyeed by the UTF-8 representation of the key with various parsings of the values
279
- * @example
280
- * ```typescript
281
- * const stateValues = AppManager.decodeAppState(state);
282
- * ```
283
- */
284
- static decodeAppState(state: {
285
- key: Uint8Array;
286
- value: modelsv2.TealValue | modelsv2.EvalDelta;
287
- }[]): AppState;
288
- /**
289
- * Returns any ABI return values for the given app call arguments and transaction confirmation.
290
- * @param confirmation The transaction confirmation from algod
291
- * @param method The ABI method
292
- * @returns The return value for the method call
293
- * @example
294
- * ```typescript
295
- * const returnValue = AppManager.getABIReturn(confirmation, ABIMethod.fromSignature('hello(string)void'));
296
- * ```
297
- */
298
- static getABIReturn(confirmation: modelsv2.PendingTransactionResponse | undefined, method: algosdk.ABIMethod | undefined): ABIReturn | undefined;
299
- /**
300
- * Replaces AlgoKit deploy-time deployment control parameters within the given TEAL template code.
301
- *
302
- * * `TMPL_UPDATABLE` for updatability / immutability control
303
- * * `TMPL_DELETABLE` for deletability / permanence control
304
- *
305
- * Note: If these values are defined, but the corresponding `TMPL_*` value
306
- * isn't in the teal code it will throw an exception.
307
- *
308
- * @param tealTemplateCode The TEAL template code to substitute
309
- * @param params The deploy-time deployment control parameter value to replace
310
- * @returns The replaced TEAL code
311
- * @example
312
- * ```typescript
313
- * const tealCode = AppManager.replaceTealTemplateDeployTimeControlParams(tealTemplate, { updatable: true, deletable: false });
314
- * ```
315
- */
316
- static replaceTealTemplateDeployTimeControlParams(tealTemplateCode: string, params: {
317
- updatable?: boolean;
318
- deletable?: boolean;
319
- }): string;
320
- /**
321
- * Performs template substitution of a teal file.
322
- *
323
- * Looks for `TMPL_{parameter}` for template replacements.
324
- *
325
- * @param tealTemplateCode The TEAL template code to make parameter replacements in
326
- * @param templateParams Any parameters to replace in the teal code
327
- * @returns The TEAL code with replacements
328
- * @example
329
- * ```typescript
330
- * const tealCode = AppManager.replaceTealTemplateParams(tealTemplate, { TMPL_APP_ID: 12345n });
331
- * ```
332
- */
333
- static replaceTealTemplateParams(tealTemplateCode: string, templateParams?: TealTemplateParams): string;
334
- /**
335
- * Remove comments from TEAL code (useful to reduce code size before compilation).
336
- *
337
- * @param tealCode The TEAL logic to strip
338
- * @returns The TEAL without comments
339
- * @example
340
- * ```typescript
341
- * const stripped = AppManager.stripTealComments(tealProgram);
342
- * ```
343
- */
344
- static stripTealComments(tealCode: string): string;
111
+ declare class AppManager {
112
+ private _algod;
113
+ private _compilationResults;
114
+ /**
115
+ * Creates an `AppManager`
116
+ * @param algod An algod instance
117
+ */
118
+ constructor(algod: algosdk.Algodv2);
119
+ /**
120
+ * Compiles the given TEAL using algod and returns the result, including source map.
121
+ *
122
+ * The result of this compilation is also cached keyed by the TEAL
123
+ * code so it can be retrieved via `getCompilationResult`.
124
+ *
125
+ * This function is re-entrant; it will only compile the same code once.
126
+ *
127
+ * @param tealCode The TEAL code
128
+ * @returns The information about the compiled file
129
+ * @example
130
+ * ```typescript
131
+ * const compiled = await appManager.compileTeal(tealProgram)
132
+ * ```
133
+ */
134
+ compileTeal(tealCode: string): Promise<CompiledTeal>;
135
+ /**
136
+ * Performs template substitution of a teal template and compiles it, returning the compiled result.
137
+ *
138
+ * Looks for `TMPL_{parameter}` for template replacements and replaces AlgoKit deploy-time control parameters
139
+ * if deployment metadata is specified.
140
+ *
141
+ * * `TMPL_UPDATABLE` for updatability / immutability control
142
+ * * `TMPL_DELETABLE` for deletability / permanence control
143
+ *
144
+ * @param tealTemplateCode The TEAL logic to compile
145
+ * @param templateParams Any parameters to replace in the .teal file before compiling
146
+ * @param deploymentMetadata The deployment metadata the app will be deployed with
147
+ * @returns The information about the compiled code
148
+ * @example
149
+ * ```typescript
150
+ * const compiled = await appManager.compileTealTemplate(tealTemplate, { TMPL_APP_ID: 12345n }, { updatable: true, deletable: false })
151
+ * ```
152
+ */
153
+ compileTealTemplate(tealTemplateCode: string, templateParams?: TealTemplateParams, deploymentMetadata?: {
154
+ updatable?: boolean;
155
+ deletable?: boolean;
156
+ }): Promise<CompiledTeal>;
157
+ /**
158
+ * Returns a previous compilation result.
159
+ * @param tealCode The TEAL code
160
+ * @returns The information about the previously compiled file
161
+ * or `undefined` if that TEAL code wasn't previously compiled
162
+ * @example
163
+ * ```typescript
164
+ * const compiled = appManager.getCompilationResult(tealProgram)
165
+ * ```
166
+ */
167
+ getCompilationResult(tealCode: string): CompiledTeal | undefined;
168
+ /**
169
+ * Returns the current app information for the app with the given ID.
170
+ *
171
+ * @example
172
+ * ```typescript
173
+ * const appInfo = await appManager.getById(12353n);
174
+ * ```
175
+ *
176
+ * @param appId The ID of the app
177
+ * @returns The app information
178
+ */
179
+ getById(appId: bigint): Promise<AppInformation>;
180
+ /**
181
+ * Returns the current global state values for the given app ID and account address
182
+ *
183
+ * @param appId The ID of the app to return global state for
184
+ * @returns The current global state for the given app
185
+ * @example
186
+ * ```typescript
187
+ * const globalState = await appManager.getGlobalState(12353n);
188
+ * ```
189
+ */
190
+ getGlobalState(appId: bigint): Promise<AppState>;
191
+ /**
192
+ * Returns the current local state values for the given app ID and account address
193
+ *
194
+ * @param appId The ID of the app to return local state for
195
+ * @param address The string address of the account to get local state for the given app
196
+ * @returns The current local state for the given (app, account) combination
197
+ * @example
198
+ * ```typescript
199
+ * const localState = await appManager.getLocalState(12353n, 'ACCOUNTADDRESS');
200
+ * ```
201
+ */
202
+ getLocalState(appId: bigint, address: Address | string): Promise<AppState>;
203
+ /**
204
+ * Returns the names of the current boxes for the given app.
205
+ * @param appId The ID of the app return box names for
206
+ * @returns The current box names
207
+ * @example
208
+ * ```typescript
209
+ * const boxNames = await appManager.getBoxNames(12353n);
210
+ * ```
211
+ */
212
+ getBoxNames(appId: bigint): Promise<BoxName[]>;
213
+ /**
214
+ * Returns the value of the given box name for the given app.
215
+ * @param appId The ID of the app return box names for
216
+ * @param boxName The name of the box to return either as a string, binary array or `BoxName`
217
+ * @returns The current box value as a byte array
218
+ * @example
219
+ * ```typescript
220
+ * const boxValue = await appManager.getBoxValue(12353n, 'boxName');
221
+ * ```
222
+ */
223
+ getBoxValue(appId: bigint, boxName: BoxIdentifier | BoxName): Promise<Uint8Array>;
224
+ /**
225
+ * Returns the value of the given box names for the given app.
226
+ * @param appId The ID of the app return box names for
227
+ * @param boxNames The names of the boxes to return either as a string, binary array or `BoxName`
228
+ * @returns The current box values as a byte array in the same order as the passed in box names
229
+ * @example
230
+ * ```typescript
231
+ * const boxValues = await appManager.getBoxValues(12353n, ['boxName1', 'boxName2']);
232
+ * ```
233
+ */
234
+ getBoxValues(appId: bigint, boxNames: (BoxIdentifier | BoxName)[]): Promise<Uint8Array[]>;
235
+ /**
236
+ * Returns the value of the given box name for the given app decoded based on the given ABI type.
237
+ * @param request The parameters for the box value request
238
+ * @returns The current box value as an ABI value
239
+ * @example
240
+ * ```typescript
241
+ * const boxValue = await appManager.getBoxValueFromABIType({ appId: 12353n, boxName: 'boxName', type: new ABIUintType(32) });
242
+ * ```
243
+ */
244
+ getBoxValueFromABIType(request: BoxValueRequestParams): Promise<algosdk.ABIValue>;
245
+ /**
246
+ * Returns the value of the given box names for the given app decoded based on the given ABI type.
247
+ * @param request The parameters for the box value request
248
+ * @returns The current box values as an ABI value in the same order as the passed in box names
249
+ * @example
250
+ * ```typescript
251
+ * const boxValues = await appManager.getBoxValuesFromABIType({ appId: 12353n, boxNames: ['boxName1', 'boxName2'], type: new ABIUintType(32) });
252
+ * ```
253
+ */
254
+ getBoxValuesFromABIType(request: BoxValuesRequestParams): Promise<algosdk.ABIValue[]>;
255
+ /**
256
+ * Returns a `algosdk.BoxReference` given a `BoxIdentifier` or `BoxReference`.
257
+ * @param boxId The box to return a reference for
258
+ * @returns The box reference ready to pass into a `algosdk.Transaction`
259
+ * @example
260
+ * ```typescript
261
+ * const boxRef = AppManager.getBoxReference('boxName');
262
+ * ```
263
+ */
264
+ static getBoxReference(boxId: BoxIdentifier | BoxReference): algosdk.BoxReference;
265
+ /**
266
+ * Converts an array of global/local state values from the algod api to a more friendly
267
+ * generic object keyed by the UTF-8 value of the key.
268
+ * @param state A `global-state`, `local-state`, `global-state-deltas` or `local-state-deltas`
269
+ * @returns An object keyeed by the UTF-8 representation of the key with various parsings of the values
270
+ * @example
271
+ * ```typescript
272
+ * const stateValues = AppManager.decodeAppState(state);
273
+ * ```
274
+ */
275
+ static decodeAppState(state: {
276
+ key: Uint8Array;
277
+ value: modelsv2.TealValue | modelsv2.EvalDelta;
278
+ }[]): AppState;
279
+ /**
280
+ * Returns any ABI return values for the given app call arguments and transaction confirmation.
281
+ * @param confirmation The transaction confirmation from algod
282
+ * @param method The ABI method
283
+ * @returns The return value for the method call
284
+ * @example
285
+ * ```typescript
286
+ * const returnValue = AppManager.getABIReturn(confirmation, ABIMethod.fromSignature('hello(string)void'));
287
+ * ```
288
+ */
289
+ static getABIReturn(confirmation: modelsv2.PendingTransactionResponse | undefined, method: algosdk.ABIMethod | undefined): ABIReturn | undefined;
290
+ /**
291
+ * Replaces AlgoKit deploy-time deployment control parameters within the given TEAL template code.
292
+ *
293
+ * * `TMPL_UPDATABLE` for updatability / immutability control
294
+ * * `TMPL_DELETABLE` for deletability / permanence control
295
+ *
296
+ * Note: If these values are defined, but the corresponding `TMPL_*` value
297
+ * isn't in the teal code it will throw an exception.
298
+ *
299
+ * @param tealTemplateCode The TEAL template code to substitute
300
+ * @param params The deploy-time deployment control parameter value to replace
301
+ * @returns The replaced TEAL code
302
+ * @example
303
+ * ```typescript
304
+ * const tealCode = AppManager.replaceTealTemplateDeployTimeControlParams(tealTemplate, { updatable: true, deletable: false });
305
+ * ```
306
+ */
307
+ static replaceTealTemplateDeployTimeControlParams(tealTemplateCode: string, params: {
308
+ updatable?: boolean;
309
+ deletable?: boolean;
310
+ }): string;
311
+ /**
312
+ * Performs template substitution of a teal file.
313
+ *
314
+ * Looks for `TMPL_{parameter}` for template replacements.
315
+ *
316
+ * @param tealTemplateCode The TEAL template code to make parameter replacements in
317
+ * @param templateParams Any parameters to replace in the teal code
318
+ * @returns The TEAL code with replacements
319
+ * @example
320
+ * ```typescript
321
+ * const tealCode = AppManager.replaceTealTemplateParams(tealTemplate, { TMPL_APP_ID: 12345n });
322
+ * ```
323
+ */
324
+ static replaceTealTemplateParams(tealTemplateCode: string, templateParams?: TealTemplateParams): string;
325
+ /**
326
+ * Remove comments from TEAL code (useful to reduce code size before compilation).
327
+ *
328
+ * @param tealCode The TEAL logic to strip
329
+ * @returns The TEAL without comments
330
+ * @example
331
+ * ```typescript
332
+ * const stripped = AppManager.stripTealComments(tealProgram);
333
+ * ```
334
+ */
335
+ static stripTealComments(tealCode: string): string;
345
336
  }
337
+ //#endregion
338
+ export { AppInformation, AppManager, BoxIdentifier, BoxReference, BoxValueRequestParams, BoxValuesRequestParams, HoldingReference, LocalsReference, ResourceReference };
339
+ //# sourceMappingURL=app-manager.d.ts.map