@allbridge/bridge-core-sdk 3.27.0-alpha.1 → 3.27.0-alpha.10

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 (76) hide show
  1. package/dist/browser/index.js +3 -3
  2. package/dist/browser/index.js.map +4 -4
  3. package/dist/cjs/index.js +3 -3
  4. package/dist/cjs/index.js.map +4 -4
  5. package/dist/esm/index.js +3 -3
  6. package/dist/esm/index.js.map +4 -4
  7. package/dist/src/chains/chain.enums.d.ts +7 -2
  8. package/dist/src/chains/chain.enums.js +5 -0
  9. package/dist/src/chains/chain.enums.js.map +1 -1
  10. package/dist/src/chains/index.js +6 -0
  11. package/dist/src/chains/index.js.map +1 -1
  12. package/dist/src/client/core-api/core-api-mapper.js +1 -0
  13. package/dist/src/client/core-api/core-api-mapper.js.map +1 -1
  14. package/dist/src/client/core-api/core-api.model.d.ts +1 -0
  15. package/dist/src/client/core-api/core-api.model.js.map +1 -1
  16. package/dist/src/configs/mainnet.js +1 -0
  17. package/dist/src/configs/mainnet.js.map +1 -1
  18. package/dist/src/index.d.ts +6 -4
  19. package/dist/src/index.js +5 -11
  20. package/dist/src/index.js.map +1 -1
  21. package/dist/src/services/bridge/alg/index.d.ts +1 -0
  22. package/dist/src/services/bridge/alg/index.js +62 -38
  23. package/dist/src/services/bridge/alg/index.js.map +1 -1
  24. package/dist/src/services/bridge/index.js +5 -0
  25. package/dist/src/services/bridge/index.js.map +1 -1
  26. package/dist/src/services/bridge/models/bridge.model.d.ts +1 -0
  27. package/dist/src/services/bridge/models/bridge.model.js.map +1 -1
  28. package/dist/src/services/bridge/stx/index.d.ts +16 -0
  29. package/dist/src/services/bridge/stx/index.js +127 -0
  30. package/dist/src/services/bridge/stx/index.js.map +1 -0
  31. package/dist/src/services/bridge/utils.d.ts +3 -1
  32. package/dist/src/services/bridge/utils.js +23 -0
  33. package/dist/src/services/bridge/utils.js.map +1 -1
  34. package/dist/src/services/liquidity-pool/alg/index.js +10 -17
  35. package/dist/src/services/liquidity-pool/alg/index.js.map +1 -1
  36. package/dist/src/services/liquidity-pool/index.js +5 -0
  37. package/dist/src/services/liquidity-pool/index.js.map +1 -1
  38. package/dist/src/services/liquidity-pool/stx/index.d.ts +21 -0
  39. package/dist/src/services/liquidity-pool/stx/index.js +141 -0
  40. package/dist/src/services/liquidity-pool/stx/index.js.map +1 -0
  41. package/dist/src/services/models/alg/BridgeClient.d.ts +158 -133
  42. package/dist/src/services/models/alg/BridgeClient.js +182 -130
  43. package/dist/src/services/models/alg/BridgeClient.js.map +1 -1
  44. package/dist/src/services/models/alg/PaddingUtilClient.d.ts +639 -0
  45. package/dist/src/services/models/alg/PaddingUtilClient.js +425 -0
  46. package/dist/src/services/models/alg/PaddingUtilClient.js.map +1 -0
  47. package/dist/src/services/models/alg/PoolClient.d.ts +204 -201
  48. package/dist/src/services/models/alg/PoolClient.js +234 -215
  49. package/dist/src/services/models/alg/PoolClient.js.map +1 -1
  50. package/dist/src/services/models/index.d.ts +2 -1
  51. package/dist/src/services/models/index.js.map +1 -1
  52. package/dist/src/services/models/stx/clarigen-types.d.ts +657 -0
  53. package/dist/src/services/models/stx/clarigen-types.js +2296 -0
  54. package/dist/src/services/models/stx/clarigen-types.js.map +1 -0
  55. package/dist/src/services/token/index.js +5 -0
  56. package/dist/src/services/token/index.js.map +1 -1
  57. package/dist/src/services/token/stx/index.d.ts +20 -0
  58. package/dist/src/services/token/stx/index.js +59 -0
  59. package/dist/src/services/token/stx/index.js.map +1 -0
  60. package/dist/src/services/utils/alg/index.d.ts +1 -10
  61. package/dist/src/services/utils/alg/index.js +0 -20
  62. package/dist/src/services/utils/alg/index.js.map +1 -1
  63. package/dist/src/services/utils/stx/get-token-name.d.ts +2 -0
  64. package/dist/src/services/utils/stx/get-token-name.js +15 -0
  65. package/dist/src/services/utils/stx/get-token-name.js.map +1 -0
  66. package/dist/src/services/utils/stx/post-conditions.d.ts +3 -0
  67. package/dist/src/services/utils/stx/post-conditions.js +27 -0
  68. package/dist/src/services/utils/stx/post-conditions.js.map +1 -0
  69. package/dist/src/services/yield/index.js +4 -0
  70. package/dist/src/services/yield/index.js.map +1 -1
  71. package/dist/src/tokens-info/tokens-info.model.d.ts +4 -0
  72. package/dist/src/tokens-info/tokens-info.model.js.map +1 -1
  73. package/dist/src/version.d.ts +1 -1
  74. package/dist/src/version.js +1 -1
  75. package/dist/src/version.js.map +1 -1
  76. package/package.json +6 -2
@@ -0,0 +1,639 @@
1
+ /**
2
+ * This file was automatically generated by @algorandfoundation/algokit-client-generator.
3
+ * DO NOT MODIFY IT BY HAND.
4
+ * requires: @algorandfoundation/algokit-utils: ^7
5
+ */
6
+ import { type AlgorandClient } from "@algorandfoundation/algokit-utils/types/algorand-client";
7
+ import { ABIReturn } from "@algorandfoundation/algokit-utils/types/app";
8
+ import { Arc56Contract } from "@algorandfoundation/algokit-utils/types/app-arc56";
9
+ import { AppClient as _AppClient, AppClientMethodCallParams, AppClientParams, AppClientBareCallParams, AppClientCompilationParams, ResolveAppClientByCreatorAndName, ResolveAppClientByNetwork, CloneAppClientParams } from "@algorandfoundation/algokit-utils/types/app-client";
10
+ import { AppFactory as _AppFactory, AppFactoryAppClientParams, AppFactoryResolveAppClientByCreatorAndNameParams, AppFactoryDeployParams, AppFactoryParams, CreateSchema } from "@algorandfoundation/algokit-utils/types/app-factory";
11
+ import { TransactionComposer, AppMethodCallTransactionArgument, RawSimulateOptions, SkipSignaturesSimulateOptions } from "@algorandfoundation/algokit-utils/types/composer";
12
+ import { SendParams, SendAtomicTransactionComposerResults } from "@algorandfoundation/algokit-utils/types/transaction";
13
+ import { Address, modelsv2, OnApplicationComplete, Transaction, TransactionSigner } from "algosdk";
14
+ export declare const APP_SPEC: Arc56Contract;
15
+ /**
16
+ * A state record containing binary data
17
+ */
18
+ export interface BinaryState {
19
+ /**
20
+ * Gets the state value as a Uint8Array
21
+ */
22
+ asByteArray(): Uint8Array | undefined;
23
+ /**
24
+ * Gets the state value as a string
25
+ */
26
+ asString(): string | undefined;
27
+ }
28
+ /**
29
+ * Expands types for IntelliSense so they are more human readable
30
+ * See https://stackoverflow.com/a/69288824
31
+ */
32
+ export type Expand<T> = T extends (...args: infer A) => infer R ? (...args: Expand<A>) => Expand<R> : T extends infer O ? {
33
+ [K in keyof O]: O[K];
34
+ } : never;
35
+ /**
36
+ * The argument types for the PaddingUtil contract
37
+ */
38
+ export type PaddingUtilArgs = {
39
+ /**
40
+ * The object representation of the arguments for each method
41
+ */
42
+ obj: {
43
+ "createApplication()void": Record<string, never>;
44
+ };
45
+ /**
46
+ * The tuple representation of the arguments for each method
47
+ */
48
+ tuple: {
49
+ "createApplication()void": [];
50
+ };
51
+ };
52
+ /**
53
+ * The return type for each method
54
+ */
55
+ export type PaddingUtilReturns = {
56
+ "createApplication()void": void;
57
+ };
58
+ /**
59
+ * Defines the types of available calls and state of the PaddingUtil smart contract.
60
+ */
61
+ export type PaddingUtilTypes = {
62
+ /**
63
+ * Maps method signatures / names to their argument and return types.
64
+ */
65
+ methods: Record<"createApplication()void" | "createApplication", {
66
+ argsObj: PaddingUtilArgs["obj"]["createApplication()void"];
67
+ argsTuple: PaddingUtilArgs["tuple"]["createApplication()void"];
68
+ returns: PaddingUtilReturns["createApplication()void"];
69
+ }>;
70
+ };
71
+ /**
72
+ * Defines the possible abi call signatures.
73
+ */
74
+ export type PaddingUtilSignatures = keyof PaddingUtilTypes["methods"];
75
+ /**
76
+ * Defines the possible abi call signatures for methods that return a non-void value.
77
+ */
78
+ export type PaddingUtilNonVoidMethodSignatures = keyof PaddingUtilTypes["methods"] extends infer T ? T extends keyof PaddingUtilTypes["methods"] ? MethodReturn<T> extends void ? never : T : never : never;
79
+ /**
80
+ * Defines an object containing all relevant parameters for a single call to the contract.
81
+ */
82
+ export type CallParams<TArgs> = Expand<Omit<AppClientMethodCallParams, "method" | "args" | "onComplete"> & {
83
+ /** The args for the ABI method call, either as an ordered array or an object */
84
+ args: Expand<TArgs>;
85
+ }>;
86
+ /**
87
+ * Maps a method signature from the PaddingUtil smart contract to the method's arguments in either tuple or struct form
88
+ */
89
+ export type MethodArgs<TSignature extends PaddingUtilSignatures> = PaddingUtilTypes["methods"][TSignature]["argsObj" | "argsTuple"];
90
+ /**
91
+ * Maps a method signature from the PaddingUtil smart contract to the method's return type
92
+ */
93
+ export type MethodReturn<TSignature extends PaddingUtilSignatures> = PaddingUtilTypes["methods"][TSignature]["returns"];
94
+ /**
95
+ * Defines supported create method params for this smart contract
96
+ */
97
+ export type PaddingUtilCreateCallParams = Expand<CallParams<PaddingUtilArgs["obj"]["createApplication()void"] | PaddingUtilArgs["tuple"]["createApplication()void"]> & {
98
+ method: "createApplication";
99
+ } & {
100
+ onComplete?: OnApplicationComplete.NoOpOC;
101
+ } & CreateSchema> | Expand<CallParams<PaddingUtilArgs["obj"]["createApplication()void"] | PaddingUtilArgs["tuple"]["createApplication()void"]> & {
102
+ method: "createApplication()void";
103
+ } & {
104
+ onComplete?: OnApplicationComplete.NoOpOC;
105
+ } & CreateSchema>;
106
+ /**
107
+ * Defines arguments required for the deploy method.
108
+ */
109
+ export type PaddingUtilDeployParams = Expand<Omit<AppFactoryDeployParams, "createParams" | "updateParams" | "deleteParams"> & {
110
+ /**
111
+ * Create transaction parameters to use if a create needs to be issued as part of deployment; use `method` to define ABI call (if available) or leave out for a bare call (if available)
112
+ */
113
+ createParams?: PaddingUtilCreateCallParams;
114
+ }>;
115
+ /**
116
+ * Exposes methods for constructing `AppClient` params objects for ABI calls to the PaddingUtil smart contract
117
+ */
118
+ export declare abstract class PaddingUtilParamsFactory {
119
+ /**
120
+ * Gets available create ABI call param factories
121
+ */
122
+ static get create(): {
123
+ _resolveByMethod<TParams extends PaddingUtilCreateCallParams & {
124
+ method: string;
125
+ }>(params: TParams): {
126
+ signer?: (TransactionSigner | import("@algorandfoundation/algokit-utils/types/account").TransactionSignerAccount) | undefined;
127
+ rekeyTo?: (string | Address) | undefined;
128
+ note?: (Uint8Array | string) | undefined;
129
+ lease?: (Uint8Array | string) | undefined;
130
+ staticFee?: import("@algorandfoundation/algokit-utils/types/amount").AlgoAmount | undefined;
131
+ extraFee?: import("@algorandfoundation/algokit-utils/types/amount").AlgoAmount | undefined;
132
+ maxFee?: import("@algorandfoundation/algokit-utils/types/amount").AlgoAmount | undefined;
133
+ validityWindow?: (number | bigint) | undefined;
134
+ firstValidRound?: bigint | undefined;
135
+ lastValidRound?: bigint | undefined;
136
+ onComplete?: OnApplicationComplete | undefined;
137
+ accountReferences?: (string | Address)[] | undefined;
138
+ appReferences?: bigint[] | undefined;
139
+ assetReferences?: bigint[] | undefined;
140
+ boxReferences?: (import("@algorandfoundation/algokit-utils/types/app-manager").BoxReference | import("@algorandfoundation/algokit-utils/types/app-manager").BoxIdentifier)[] | undefined;
141
+ sender?: (Address | string) | undefined;
142
+ method: string;
143
+ args?: (import("algosdk").ABIValue | import("@algorandfoundation/algokit-utils/types/app-arc56").ABIStruct | AppMethodCallTransactionArgument | undefined)[] | undefined;
144
+ } & AppClientCompilationParams & {
145
+ onComplete?: OnApplicationComplete.NoOpOC;
146
+ };
147
+ /**
148
+ * Constructs create ABI call params for the PaddingUtil smart contract using the createApplication()void ABI method
149
+ *
150
+ * @param params Parameters for the call
151
+ * @returns An `AppClientMethodCallParams` object for the call
152
+ */
153
+ createApplication(params: CallParams<PaddingUtilArgs["obj"]["createApplication()void"] | PaddingUtilArgs["tuple"]["createApplication()void"]> & AppClientCompilationParams & {
154
+ onComplete?: OnApplicationComplete.NoOpOC;
155
+ }): AppClientMethodCallParams & AppClientCompilationParams & {
156
+ onComplete?: OnApplicationComplete.NoOpOC;
157
+ };
158
+ };
159
+ }
160
+ /**
161
+ * A factory to create and deploy one or more instance of the PaddingUtil smart contract and to create one or more app clients to interact with those (or other) app instances
162
+ */
163
+ export declare class PaddingUtilFactory {
164
+ /**
165
+ * The underlying `AppFactory` for when you want to have more flexibility
166
+ */
167
+ readonly appFactory: _AppFactory;
168
+ /**
169
+ * Creates a new instance of `PaddingUtilFactory`
170
+ *
171
+ * @param params The parameters to initialise the app factory with
172
+ */
173
+ constructor(params: Omit<AppFactoryParams, "appSpec">);
174
+ /** The name of the app (from the ARC-32 / ARC-56 app spec or override). */
175
+ get appName(): string;
176
+ /** The ARC-56 app spec being used */
177
+ get appSpec(): Arc56Contract;
178
+ /** A reference to the underlying `AlgorandClient` this app factory is using. */
179
+ get algorand(): AlgorandClient;
180
+ /**
181
+ * Returns a new `AppClient` client for an app instance of the given ID.
182
+ *
183
+ * Automatically populates appName, defaultSender and source maps from the factory
184
+ * if not specified in the params.
185
+ * @param params The parameters to create the app client
186
+ * @returns The `AppClient`
187
+ */
188
+ getAppClientById(params: AppFactoryAppClientParams): PaddingUtilClient;
189
+ /**
190
+ * Returns a new `AppClient` client, resolving the app by creator address and name
191
+ * using AlgoKit app deployment semantics (i.e. looking for the app creation transaction note).
192
+ *
193
+ * Automatically populates appName, defaultSender and source maps from the factory
194
+ * if not specified in the params.
195
+ * @param params The parameters to create the app client
196
+ * @returns The `AppClient`
197
+ */
198
+ getAppClientByCreatorAndName(params: AppFactoryResolveAppClientByCreatorAndNameParams): Promise<PaddingUtilClient>;
199
+ /**
200
+ * Idempotently deploys the PaddingUtil smart contract.
201
+ *
202
+ * @param params The arguments for the contract calls and any additional parameters for the call
203
+ * @returns The deployment result
204
+ */
205
+ deploy(params?: PaddingUtilDeployParams): Promise<{
206
+ result: {
207
+ return: import("algosdk").ABIValue | import("@algorandfoundation/algokit-utils/types/app-arc56").ABIStruct | undefined;
208
+ deleteReturn: import("algosdk").ABIValue | import("@algorandfoundation/algokit-utils/types/app-arc56").ABIStruct | undefined;
209
+ compiledApproval?: import("@algorandfoundation/algokit-utils/types/app").CompiledTeal | undefined;
210
+ compiledClear?: import("@algorandfoundation/algokit-utils/types/app").CompiledTeal | undefined;
211
+ operationPerformed: "create";
212
+ version: string;
213
+ name: string;
214
+ createdRound: bigint;
215
+ updatedRound: bigint;
216
+ createdMetadata: import("@algorandfoundation/algokit-utils/types/app").AppDeployMetadata;
217
+ deleted: boolean;
218
+ deletable?: boolean | undefined;
219
+ updatable?: boolean | undefined;
220
+ groupId: string;
221
+ txIds: string[];
222
+ returns?: import("@algorandfoundation/algokit-utils/types/app").ABIReturn[] | undefined;
223
+ confirmations: modelsv2.PendingTransactionResponse[];
224
+ transactions: Transaction[];
225
+ confirmation: modelsv2.PendingTransactionResponse;
226
+ transaction: Transaction;
227
+ appId: bigint;
228
+ appAddress: Address;
229
+ } | {
230
+ return: import("algosdk").ABIValue | import("@algorandfoundation/algokit-utils/types/app-arc56").ABIStruct | undefined;
231
+ deleteReturn: import("algosdk").ABIValue | import("@algorandfoundation/algokit-utils/types/app-arc56").ABIStruct | undefined;
232
+ compiledApproval?: import("@algorandfoundation/algokit-utils/types/app").CompiledTeal | undefined;
233
+ compiledClear?: import("@algorandfoundation/algokit-utils/types/app").CompiledTeal | undefined;
234
+ operationPerformed: "update";
235
+ appId: bigint;
236
+ appAddress: Address;
237
+ createdRound: bigint;
238
+ updatedRound: bigint;
239
+ createdMetadata: import("@algorandfoundation/algokit-utils/types/app").AppDeployMetadata;
240
+ deleted: boolean;
241
+ name: string;
242
+ version: string;
243
+ deletable?: boolean | undefined;
244
+ updatable?: boolean | undefined;
245
+ groupId: string;
246
+ txIds: string[];
247
+ returns?: import("@algorandfoundation/algokit-utils/types/app").ABIReturn[] | undefined;
248
+ confirmations: modelsv2.PendingTransactionResponse[];
249
+ transactions: Transaction[];
250
+ confirmation: modelsv2.PendingTransactionResponse;
251
+ transaction: Transaction;
252
+ } | {
253
+ return: import("algosdk").ABIValue | import("@algorandfoundation/algokit-utils/types/app-arc56").ABIStruct | undefined;
254
+ deleteReturn: import("algosdk").ABIValue | import("@algorandfoundation/algokit-utils/types/app-arc56").ABIStruct | undefined;
255
+ compiledApproval?: import("@algorandfoundation/algokit-utils/types/app").CompiledTeal | undefined;
256
+ compiledClear?: import("@algorandfoundation/algokit-utils/types/app").CompiledTeal | undefined;
257
+ operationPerformed: "replace";
258
+ version: string;
259
+ name: string;
260
+ createdRound: bigint;
261
+ updatedRound: bigint;
262
+ createdMetadata: import("@algorandfoundation/algokit-utils/types/app").AppDeployMetadata;
263
+ deleted: boolean;
264
+ deletable?: boolean | undefined;
265
+ updatable?: boolean | undefined;
266
+ groupId: string;
267
+ txIds: string[];
268
+ returns?: import("@algorandfoundation/algokit-utils/types/app").ABIReturn[] | undefined;
269
+ confirmations: modelsv2.PendingTransactionResponse[];
270
+ transactions: Transaction[];
271
+ confirmation: modelsv2.PendingTransactionResponse;
272
+ transaction: Transaction;
273
+ appId: bigint;
274
+ appAddress: Address;
275
+ deleteResult: import("@algorandfoundation/algokit-utils/types/transaction").ConfirmedTransactionResult;
276
+ } | {
277
+ return: import("algosdk").ABIValue | import("@algorandfoundation/algokit-utils/types/app-arc56").ABIStruct | undefined;
278
+ deleteReturn: import("algosdk").ABIValue | import("@algorandfoundation/algokit-utils/types/app-arc56").ABIStruct | undefined;
279
+ compiledApproval?: import("@algorandfoundation/algokit-utils/types/app").CompiledTeal | undefined;
280
+ compiledClear?: import("@algorandfoundation/algokit-utils/types/app").CompiledTeal | undefined;
281
+ operationPerformed: "nothing";
282
+ appId: bigint;
283
+ appAddress: Address;
284
+ createdRound: bigint;
285
+ updatedRound: bigint;
286
+ createdMetadata: import("@algorandfoundation/algokit-utils/types/app").AppDeployMetadata;
287
+ deleted: boolean;
288
+ name: string;
289
+ version: string;
290
+ deletable?: boolean | undefined;
291
+ updatable?: boolean | undefined;
292
+ };
293
+ appClient: PaddingUtilClient;
294
+ }>;
295
+ /**
296
+ * Get parameters to create transactions (create and deploy related calls) for the current app. A good mental model for this is that these parameters represent a deferred transaction creation.
297
+ */
298
+ readonly params: {
299
+ /**
300
+ * Gets available create methods
301
+ */
302
+ create: {
303
+ /**
304
+ * Creates a new instance of the PaddingUtil smart contract using the createApplication()void ABI method.
305
+ *
306
+ * @param params The params for the smart contract call
307
+ * @returns The create params
308
+ */
309
+ createApplication: (params?: CallParams<PaddingUtilArgs["obj"]["createApplication()void"] | PaddingUtilArgs["tuple"]["createApplication()void"]> & AppClientCompilationParams & CreateSchema & {
310
+ onComplete?: OnApplicationComplete.NoOpOC;
311
+ }) => Promise<{
312
+ deployTimeParams: import("@algorandfoundation/algokit-utils/types/app").TealTemplateParams | undefined;
313
+ schema: {
314
+ globalInts: number;
315
+ globalByteSlices: number;
316
+ localInts: number;
317
+ localByteSlices: number;
318
+ };
319
+ approvalProgram: Uint8Array;
320
+ clearStateProgram: Uint8Array;
321
+ maxFee?: import("@algorandfoundation/algokit-utils/types/amount").AlgoAmount | undefined;
322
+ note?: string | Uint8Array | undefined;
323
+ signer?: TransactionSigner | import("@algorandfoundation/algokit-utils/types/account").TransactionSignerAccount | undefined;
324
+ onComplete?: OnApplicationComplete.NoOpOC | OnApplicationComplete.OptInOC | OnApplicationComplete.CloseOutOC | OnApplicationComplete.UpdateApplicationOC | OnApplicationComplete.DeleteApplicationOC | undefined;
325
+ lease?: string | Uint8Array | undefined;
326
+ rekeyTo?: string | Address | undefined;
327
+ staticFee?: import("@algorandfoundation/algokit-utils/types/amount").AlgoAmount | undefined;
328
+ extraFee?: import("@algorandfoundation/algokit-utils/types/amount").AlgoAmount | undefined;
329
+ validityWindow?: number | bigint | undefined;
330
+ firstValidRound?: bigint | undefined;
331
+ lastValidRound?: bigint | undefined;
332
+ accountReferences?: (string | Address)[] | undefined;
333
+ appReferences?: bigint[] | undefined;
334
+ assetReferences?: bigint[] | undefined;
335
+ boxReferences?: (import("@algorandfoundation/algokit-utils/types/app-manager").BoxIdentifier | import("@algorandfoundation/algokit-utils/types/app-manager").BoxReference)[] | undefined;
336
+ sender?: string | Address | undefined;
337
+ method: string;
338
+ args?: (import("algosdk").ABIValue | AppMethodCallTransactionArgument | import("@algorandfoundation/algokit-utils/types/app-arc56").ABIStruct | undefined)[] | undefined;
339
+ updatable?: boolean | undefined;
340
+ deletable?: boolean | undefined;
341
+ extraProgramPages?: number | undefined;
342
+ } & {
343
+ sender: Address;
344
+ signer: TransactionSigner | import("@algorandfoundation/algokit-utils/types/account").TransactionSignerAccount | undefined;
345
+ method: import("@algorandfoundation/algokit-utils/types/app-arc56").Arc56Method;
346
+ args: (Transaction | import("algosdk").ABIValue | import("algosdk").TransactionWithSigner | Promise<Transaction> | import("@algorandfoundation/algokit-utils/types/composer").AppMethodCall<{
347
+ sender: string | Address;
348
+ maxFee?: import("@algorandfoundation/algokit-utils/types/amount").AlgoAmount | undefined;
349
+ note?: string | Uint8Array | undefined;
350
+ args?: Uint8Array[] | undefined;
351
+ signer?: TransactionSigner | import("@algorandfoundation/algokit-utils/types/account").TransactionSignerAccount | undefined;
352
+ onComplete?: OnApplicationComplete.NoOpOC | OnApplicationComplete.OptInOC | OnApplicationComplete.CloseOutOC | OnApplicationComplete.UpdateApplicationOC | OnApplicationComplete.DeleteApplicationOC | undefined;
353
+ lease?: string | Uint8Array | undefined;
354
+ rekeyTo?: string | Address | undefined;
355
+ staticFee?: import("@algorandfoundation/algokit-utils/types/amount").AlgoAmount | undefined;
356
+ extraFee?: import("@algorandfoundation/algokit-utils/types/amount").AlgoAmount | undefined;
357
+ validityWindow?: number | bigint | undefined;
358
+ firstValidRound?: bigint | undefined;
359
+ lastValidRound?: bigint | undefined;
360
+ accountReferences?: (string | Address)[] | undefined;
361
+ appReferences?: bigint[] | undefined;
362
+ assetReferences?: bigint[] | undefined;
363
+ boxReferences?: (import("@algorandfoundation/algokit-utils/types/app-manager").BoxIdentifier | import("@algorandfoundation/algokit-utils/types/app-manager").BoxReference)[] | undefined;
364
+ approvalProgram: string | Uint8Array;
365
+ clearStateProgram: string | Uint8Array;
366
+ schema?: {
367
+ globalInts: number;
368
+ globalByteSlices: number;
369
+ localInts: number;
370
+ localByteSlices: number;
371
+ } | undefined;
372
+ extraProgramPages?: number | undefined;
373
+ }> | import("@algorandfoundation/algokit-utils/types/composer").AppMethodCall<{
374
+ sender: string | Address;
375
+ signer?: TransactionSigner | import("@algorandfoundation/algokit-utils/types/account").TransactionSignerAccount | undefined;
376
+ rekeyTo?: string | Address | undefined;
377
+ note?: string | Uint8Array | undefined;
378
+ lease?: string | Uint8Array | undefined;
379
+ staticFee?: import("@algorandfoundation/algokit-utils/types/amount").AlgoAmount | undefined;
380
+ extraFee?: import("@algorandfoundation/algokit-utils/types/amount").AlgoAmount | undefined;
381
+ maxFee?: import("@algorandfoundation/algokit-utils/types/amount").AlgoAmount | undefined;
382
+ validityWindow?: number | bigint | undefined;
383
+ firstValidRound?: bigint | undefined;
384
+ lastValidRound?: bigint | undefined;
385
+ appId: bigint;
386
+ onComplete?: OnApplicationComplete.UpdateApplicationOC | undefined;
387
+ args?: Uint8Array[] | undefined;
388
+ accountReferences?: (string | Address)[] | undefined;
389
+ appReferences?: bigint[] | undefined;
390
+ assetReferences?: bigint[] | undefined;
391
+ boxReferences?: (import("@algorandfoundation/algokit-utils/types/app-manager").BoxIdentifier | import("@algorandfoundation/algokit-utils/types/app-manager").BoxReference)[] | undefined;
392
+ approvalProgram: string | Uint8Array;
393
+ clearStateProgram: string | Uint8Array;
394
+ }> | import("@algorandfoundation/algokit-utils/types/composer").AppMethodCall<import("@algorandfoundation/algokit-utils/types/composer").AppMethodCallParams> | undefined)[] | undefined;
395
+ onComplete: OnApplicationComplete.NoOpOC | OnApplicationComplete.OptInOC | OnApplicationComplete.CloseOutOC | OnApplicationComplete.UpdateApplicationOC | OnApplicationComplete.DeleteApplicationOC;
396
+ }>;
397
+ };
398
+ };
399
+ /**
400
+ * Create transactions for the current app
401
+ */
402
+ readonly createTransaction: {
403
+ /**
404
+ * Gets available create methods
405
+ */
406
+ create: {
407
+ /**
408
+ * Creates a new instance of the PaddingUtil smart contract using the createApplication()void ABI method.
409
+ *
410
+ * @param params The params for the smart contract call
411
+ * @returns The create transaction
412
+ */
413
+ createApplication: (params?: CallParams<PaddingUtilArgs["obj"]["createApplication()void"] | PaddingUtilArgs["tuple"]["createApplication()void"]> & AppClientCompilationParams & CreateSchema & {
414
+ onComplete?: OnApplicationComplete.NoOpOC;
415
+ }) => Promise<{
416
+ transactions: Transaction[];
417
+ methodCalls: Map<number, import("algosdk").ABIMethod>;
418
+ signers: Map<number, TransactionSigner>;
419
+ }>;
420
+ };
421
+ };
422
+ /**
423
+ * Send calls to the current app
424
+ */
425
+ readonly send: {
426
+ /**
427
+ * Gets available create methods
428
+ */
429
+ create: {
430
+ /**
431
+ * Creates a new instance of the PaddingUtil smart contract using an ABI method call using the createApplication()void ABI method.
432
+ *
433
+ * @param params The params for the smart contract call
434
+ * @returns The create result
435
+ */
436
+ createApplication: (params?: CallParams<PaddingUtilArgs["obj"]["createApplication()void"] | PaddingUtilArgs["tuple"]["createApplication()void"]> & AppClientCompilationParams & CreateSchema & SendParams & {
437
+ onComplete?: OnApplicationComplete.NoOpOC;
438
+ }) => Promise<{
439
+ result: {
440
+ return: undefined | PaddingUtilReturns["createApplication()void"];
441
+ compiledApproval?: import("@algorandfoundation/algokit-utils/types/app").CompiledTeal | undefined;
442
+ compiledClear?: import("@algorandfoundation/algokit-utils/types/app").CompiledTeal | undefined;
443
+ appId: bigint;
444
+ groupId: string;
445
+ txIds: string[];
446
+ returns?: import("@algorandfoundation/algokit-utils/types/app").ABIReturn[] | undefined;
447
+ confirmations: modelsv2.PendingTransactionResponse[];
448
+ transactions: Transaction[];
449
+ confirmation: modelsv2.PendingTransactionResponse;
450
+ transaction: Transaction;
451
+ appAddress: Address;
452
+ };
453
+ appClient: PaddingUtilClient;
454
+ }>;
455
+ };
456
+ };
457
+ }
458
+ /**
459
+ * A client to make calls to the PaddingUtil smart contract
460
+ */
461
+ export declare class PaddingUtilClient {
462
+ /**
463
+ * The underlying `AppClient` for when you want to have more flexibility
464
+ */
465
+ readonly appClient: _AppClient;
466
+ /**
467
+ * Creates a new instance of `PaddingUtilClient`
468
+ *
469
+ * @param appClient An `AppClient` instance which has been created with the PaddingUtil app spec
470
+ */
471
+ constructor(appClient: _AppClient);
472
+ /**
473
+ * Creates a new instance of `PaddingUtilClient`
474
+ *
475
+ * @param params The parameters to initialise the app client with
476
+ */
477
+ constructor(params: Omit<AppClientParams, "appSpec">);
478
+ /**
479
+ * Checks for decode errors on the given return value and maps the return value to the return type for the given method
480
+ * @returns The typed return value or undefined if there was no value
481
+ */
482
+ decodeReturnValue<TSignature extends PaddingUtilNonVoidMethodSignatures>(method: TSignature, returnValue: ABIReturn | undefined): MethodReturn<TSignature> | undefined;
483
+ /**
484
+ * Returns a new `PaddingUtilClient` client, resolving the app by creator address and name
485
+ * using AlgoKit app deployment semantics (i.e. looking for the app creation transaction note).
486
+ * @param params The parameters to create the app client
487
+ */
488
+ static fromCreatorAndName(params: Omit<ResolveAppClientByCreatorAndName, "appSpec">): Promise<PaddingUtilClient>;
489
+ /**
490
+ * Returns an `PaddingUtilClient` instance for the current network based on
491
+ * pre-determined network-specific app IDs specified in the ARC-56 app spec.
492
+ *
493
+ * If no IDs are in the app spec or the network isn't recognised, an error is thrown.
494
+ * @param params The parameters to create the app client
495
+ */
496
+ static fromNetwork(params: Omit<ResolveAppClientByNetwork, "appSpec">): Promise<PaddingUtilClient>;
497
+ /** The ID of the app instance this client is linked to. */
498
+ get appId(): bigint;
499
+ /** The app address of the app instance this client is linked to. */
500
+ get appAddress(): Address;
501
+ /** The name of the app. */
502
+ get appName(): string;
503
+ /** The ARC-56 app spec being used */
504
+ get appSpec(): Arc56Contract;
505
+ /** A reference to the underlying `AlgorandClient` this app client is using. */
506
+ get algorand(): AlgorandClient;
507
+ /**
508
+ * Get parameters to create transactions for the current app. A good mental model for this is that these parameters represent a deferred transaction creation.
509
+ */
510
+ readonly params: {
511
+ /**
512
+ * Makes a clear_state call to an existing instance of the PaddingUtil smart contract.
513
+ *
514
+ * @param params The params for the bare (raw) call
515
+ * @returns The clearState result
516
+ */
517
+ clearState: (params?: Expand<AppClientBareCallParams>) => import("@algorandfoundation/algokit-utils/types/composer").AppCallParams;
518
+ /**
519
+ * Makes a call to the PaddingUtil smart contract using a bare call.
520
+ *
521
+ * @param params The params for the bare (raw) call
522
+ * @returns The call result
523
+ */
524
+ bare: (params?: Expand<AppClientBareCallParams & {
525
+ onComplete?: OnApplicationComplete.NoOpOC;
526
+ }>) => import("@algorandfoundation/algokit-utils/types/composer").AppCallParams;
527
+ };
528
+ /**
529
+ * Create transactions for the current app
530
+ */
531
+ readonly createTransaction: {
532
+ /**
533
+ * Makes a clear_state call to an existing instance of the PaddingUtil smart contract.
534
+ *
535
+ * @param params The params for the bare (raw) call
536
+ * @returns The clearState result
537
+ */
538
+ clearState: (params?: Expand<AppClientBareCallParams>) => Promise<Transaction>;
539
+ /**
540
+ * Makes a call to the PaddingUtil smart contract using a bare call.
541
+ *
542
+ * @param params The params for the bare (raw) call
543
+ * @returns The call result
544
+ */
545
+ bare: (params?: Expand<AppClientBareCallParams & {
546
+ onComplete?: OnApplicationComplete.NoOpOC;
547
+ }>) => Promise<Transaction>;
548
+ };
549
+ /**
550
+ * Send calls to the current app
551
+ */
552
+ readonly send: {
553
+ /**
554
+ * Makes a clear_state call to an existing instance of the PaddingUtil smart contract.
555
+ *
556
+ * @param params The params for the bare (raw) call
557
+ * @returns The clearState result
558
+ */
559
+ clearState: (params?: Expand<AppClientBareCallParams & SendParams>) => Promise<{
560
+ groupId: string;
561
+ txIds: string[];
562
+ returns?: ABIReturn[] | undefined;
563
+ confirmations: modelsv2.PendingTransactionResponse[];
564
+ transactions: Transaction[];
565
+ confirmation: modelsv2.PendingTransactionResponse;
566
+ transaction: Transaction;
567
+ return?: ABIReturn | undefined;
568
+ }>;
569
+ /**
570
+ * Makes a call to the PaddingUtil smart contract using a bare call.
571
+ *
572
+ * @param params The params for the bare (raw) call
573
+ * @returns The call result
574
+ */
575
+ bare: (params?: Expand<AppClientBareCallParams & SendParams & {
576
+ onComplete?: OnApplicationComplete.NoOpOC;
577
+ }>) => Promise<{
578
+ groupId: string;
579
+ txIds: string[];
580
+ returns?: ABIReturn[] | undefined;
581
+ confirmations: modelsv2.PendingTransactionResponse[];
582
+ transactions: Transaction[];
583
+ confirmation: modelsv2.PendingTransactionResponse;
584
+ transaction: Transaction;
585
+ return?: ABIReturn | undefined;
586
+ }>;
587
+ };
588
+ /**
589
+ * Clone this app client with different params
590
+ *
591
+ * @param params The params to use for the the cloned app client. Omit a param to keep the original value. Set a param to override the original value. Setting to undefined will clear the original value.
592
+ * @returns A new app client with the altered params
593
+ */
594
+ clone(params: CloneAppClientParams): PaddingUtilClient;
595
+ /**
596
+ * Methods to access state for the current PaddingUtil app
597
+ */
598
+ state: {};
599
+ newGroup(): PaddingUtilComposer;
600
+ }
601
+ export type PaddingUtilComposer<TReturns extends [...any[]] = []> = {
602
+ /**
603
+ * Makes a clear_state call to an existing instance of the PaddingUtil smart contract.
604
+ *
605
+ * @param args The arguments for the bare call
606
+ * @returns The typed transaction composer so you can fluently chain multiple calls or call execute to execute all queued up transactions
607
+ */
608
+ clearState(params?: AppClientBareCallParams): PaddingUtilComposer<[...TReturns, undefined]>;
609
+ /**
610
+ * Adds a transaction to the composer
611
+ *
612
+ * @param txn A transaction to add to the transaction group
613
+ * @param signer The optional signer to use when signing this transaction.
614
+ */
615
+ addTransaction(txn: Transaction, signer?: TransactionSigner): PaddingUtilComposer<TReturns>;
616
+ /**
617
+ * Returns the underlying AtomicTransactionComposer instance
618
+ */
619
+ composer(): Promise<TransactionComposer>;
620
+ /**
621
+ * Simulates the transaction group and returns the result
622
+ */
623
+ simulate(): Promise<PaddingUtilComposerResults<TReturns> & {
624
+ simulateResponse: modelsv2.SimulateResponse;
625
+ }>;
626
+ simulate(options: SkipSignaturesSimulateOptions): Promise<PaddingUtilComposerResults<TReturns> & {
627
+ simulateResponse: modelsv2.SimulateResponse;
628
+ }>;
629
+ simulate(options: RawSimulateOptions): Promise<PaddingUtilComposerResults<TReturns> & {
630
+ simulateResponse: modelsv2.SimulateResponse;
631
+ }>;
632
+ /**
633
+ * Sends the transaction group to the network and returns the results
634
+ */
635
+ send(params?: SendParams): Promise<PaddingUtilComposerResults<TReturns>>;
636
+ };
637
+ export type PaddingUtilComposerResults<TReturns extends [...any[]]> = Expand<SendAtomicTransactionComposerResults & {
638
+ returns: TReturns;
639
+ }>;