@algorandfoundation/algokit-utils 9.2.1 → 9.2.2-beta.1

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 (75) hide show
  1. package/account/account.d.ts +28 -23
  2. package/account/get-account-config-from-environment.d.ts +2 -7
  3. package/account/get-account.d.ts +12 -14
  4. package/account/get-dispenser-account.d.ts +5 -9
  5. package/account/index.d.ts +5 -0
  6. package/account/mnemonic-account.d.ts +3 -7
  7. package/amount.d.ts +35 -40
  8. package/app-client.d.ts +6 -10
  9. package/app-deploy.d.ts +23 -25
  10. package/app.d.ts +46 -45
  11. package/asset.d.ts +12 -16
  12. package/config.d.ts +2 -7
  13. package/debugging/debugging.d.ts +1 -5
  14. package/debugging/index.d.ts +1 -0
  15. package/dispenser-client.d.ts +2 -7
  16. package/index.d.ts +18 -27
  17. package/indexer-lookup.d.ts +11 -18
  18. package/localnet/get-kmd-wallet-account.d.ts +7 -9
  19. package/localnet/get-localnet-dispenser-account.d.ts +5 -7
  20. package/localnet/get-or-create-kmd-wallet-account.d.ts +8 -10
  21. package/localnet/index.d.ts +4 -0
  22. package/localnet/is-localnet.d.ts +3 -7
  23. package/network-client.d.ts +15 -17
  24. package/package.json +1 -1
  25. package/testing/_asset.d.ts +3 -0
  26. package/testing/account.d.ts +9 -11
  27. package/testing/fixtures/algokit-log-capture-fixture.d.ts +2 -7
  28. package/testing/fixtures/algorand-fixture.d.ts +4 -9
  29. package/testing/fixtures/index.d.ts +2 -0
  30. package/testing/index.d.ts +5 -7
  31. package/testing/indexer.d.ts +1 -5
  32. package/testing/test-logger.d.ts +36 -41
  33. package/testing/transaction-logger.d.ts +27 -30
  34. package/transaction/index.d.ts +2 -0
  35. package/transaction/legacy-bridge.d.ts +35 -0
  36. package/transaction/perform-atomic-transaction-composer-simulate.d.ts +5 -7
  37. package/transaction/resolve-signed-transactions.d.ts +16 -0
  38. package/transaction/transaction.d.ts +35 -34
  39. package/transfer/index.d.ts +2 -0
  40. package/transfer/transfer-algos.d.ts +5 -9
  41. package/transfer/transfer.d.ts +8 -11
  42. package/types/account-manager.d.ts +429 -432
  43. package/types/account.d.ts +202 -192
  44. package/types/algo-http-client-with-retry.d.ts +10 -15
  45. package/types/algorand-client-transaction-creator.d.ts +771 -778
  46. package/types/algorand-client-transaction-sender.d.ts +1085 -1090
  47. package/types/algorand-client.d.ts +236 -239
  48. package/types/amount.d.ts +43 -47
  49. package/types/app-arc56.d.ts +272 -235
  50. package/types/app-client.d.ts +1151 -1128
  51. package/types/app-deployer.d.ts +141 -139
  52. package/types/app-factory.d.ts +783 -762
  53. package/types/app-manager.d.ts +310 -304
  54. package/types/app-spec.d.ts +117 -118
  55. package/types/app.d.ts +241 -229
  56. package/types/asset-manager.d.ts +199 -204
  57. package/types/asset.d.ts +91 -95
  58. package/types/async-event-emitter.d.ts +13 -18
  59. package/types/client-manager.d.ts +451 -453
  60. package/types/composer.d.ts +1257 -1210
  61. package/types/config.d.ts +48 -53
  62. package/types/debugging.d.ts +23 -25
  63. package/types/dispenser-client.d.ts +52 -57
  64. package/types/expand.d.ts +3 -5
  65. package/types/indexer.d.ts +66 -70
  66. package/types/instance-of.d.ts +3 -5
  67. package/types/kmd-account-manager.d.ts +70 -75
  68. package/types/lifecycle-events.d.ts +8 -13
  69. package/types/logging.d.ts +11 -15
  70. package/types/logic-error.d.ts +29 -33
  71. package/types/network-client.d.ts +27 -32
  72. package/types/testing.d.ts +132 -131
  73. package/types/transaction.d.ts +110 -110
  74. package/types/transfer.d.ts +66 -70
  75. package/util.d.ts +48 -0
@@ -1,9 +1,13 @@
1
- import { AlgoAmount } from "../types/amount.js";
2
- import { AccountAssetInformation, MultisigAccount, SigningAccount, TransactionSignerAccount } from "../types/account.js";
3
- import { SendTransactionFrom } from "../types/transaction.js";
4
- import algosdk from "algosdk";
5
-
6
- //#region src/account/account.d.ts
1
+ import algosdk from 'algosdk';
2
+ import { AccountAssetInformation, MultisigAccount, SigningAccount, TransactionSignerAccount } from '../types/account';
3
+ import { AlgoAmount } from '../types/amount';
4
+ import { SendTransactionFrom } from '../types/transaction';
5
+ import Account = algosdk.Account;
6
+ import Algodv2 = algosdk.Algodv2;
7
+ import Kmd = algosdk.Kmd;
8
+ import MultisigMetadata = algosdk.MultisigMetadata;
9
+ import TransactionSigner = algosdk.TransactionSigner;
10
+ import AccountInformationModel = algosdk.modelsv2.Account;
7
11
  /**
8
12
  * @deprecated Use `algorand.account.multisig(multisigParams, signingAccounts)` or `new MultisigAccount(multisigParams, signingAccounts)` instead.
9
13
  *
@@ -12,7 +16,7 @@ import algosdk from "algosdk";
12
16
  * @param signingAccounts The signers that are currently present
13
17
  * @returns A multisig account wrapper
14
18
  */
15
- declare function multisigAccount(multisigParams: MultisigMetadata, signingAccounts: (Account | SigningAccount)[]): MultisigAccount;
19
+ export declare function multisigAccount(multisigParams: MultisigMetadata, signingAccounts: (Account | SigningAccount)[]): MultisigAccount;
16
20
  /**
17
21
  * @deprecated Use `algorand.account.rekeyed(sender, account)` or `new SigningAccount(account, sender)` instead.
18
22
  *
@@ -21,7 +25,7 @@ declare function multisigAccount(multisigParams: MultisigMetadata, signingAccoun
21
25
  * @param sender The address of the rekeyed account that will act as a sender
22
26
  * @returns The SigningAccount wrapper
23
27
  */
24
- declare function rekeyedAccount(signer: Account, sender: string): SigningAccount;
28
+ export declare function rekeyedAccount(signer: Account, sender: string): SigningAccount;
25
29
  /**
26
30
  * @deprecated Use `algorand.account.getSigner(sender)` (after previously registering the signer with `setSigner`) or `{ addr: sender, signer }` instead.
27
31
  *
@@ -30,7 +34,7 @@ declare function rekeyedAccount(signer: Account, sender: string): SigningAccount
30
34
  * @param sender The address of sender account
31
35
  * @returns The SigningAccount wrapper
32
36
  */
33
- declare function transactionSignerAccount(signer: TransactionSigner, sender: string): TransactionSignerAccount;
37
+ export declare function transactionSignerAccount(signer: TransactionSigner, sender: string): TransactionSignerAccount;
34
38
  /**
35
39
  * @deprecated Use `algorand.account.random()` or `algosdk.generateAccount()` instead.
36
40
  *
@@ -39,7 +43,7 @@ declare function transactionSignerAccount(signer: TransactionSigner, sender: str
39
43
  * This is a wrapper around algosdk.generateAccount to provide a more friendly/obvious name.
40
44
  *
41
45
  */
42
- declare function randomAccount(): Account;
46
+ export declare function randomAccount(): Account;
43
47
  /**
44
48
  * @deprecated Use `algorand.account.fromEnvironment(name, fundWith)` or `new AccountManager(clientManager).fromEnvironment()` instead.
45
49
  *
@@ -72,9 +76,9 @@ declare function randomAccount(): Account;
72
76
  * @param kmdClient An optional KMD client to use to create an account (when targeting LocalNet), if not specified then a default KMD client will be loaded from environment variables
73
77
  * @returns The requested account with private key loaded from the environment variables or when targeting LocalNet from KMD (idempotently creating and funding the account)
74
78
  */
75
- declare function mnemonicAccountFromEnvironment(account: string | {
76
- name: string;
77
- fundWith?: AlgoAmount;
79
+ export declare function mnemonicAccountFromEnvironment(account: string | {
80
+ name: string;
81
+ fundWith?: AlgoAmount;
78
82
  }, algod: Algodv2, kmdClient?: Kmd): Promise<Account | SigningAccount>;
79
83
  /**
80
84
  * @deprecated Use `algosdk.decodeAddress` instead.
@@ -83,7 +87,7 @@ declare function mnemonicAccountFromEnvironment(account: string | {
83
87
  *
84
88
  * @param account Either an account (with private key loaded) or the string address of an account
85
89
  */
86
- declare function getAccountAddressAsUint8Array(account: SendTransactionFrom | string): Uint8Array<ArrayBufferLike>;
90
+ export declare function getAccountAddressAsUint8Array(account: SendTransactionFrom | string): Uint8Array<ArrayBufferLike>;
87
91
  /**
88
92
  * @deprecated Use `algosdk.encodeAddress` instead.
89
93
  *
@@ -91,12 +95,15 @@ declare function getAccountAddressAsUint8Array(account: SendTransactionFrom | st
91
95
  *
92
96
  * @param addressEncodedInB64 The base64 encoded version of the underlying byte array of the address public key
93
97
  */
94
- declare function getAccountAddressAsString(addressEncodedInB64: string): string;
95
- type NumberConverter<T extends AccountInformationModel> = { [key in keyof T]: ToNumberIfExtends<T[key], number | bigint> };
98
+ export declare function getAccountAddressAsString(addressEncodedInB64: string): string;
99
+ export type NumberConverter<T extends AccountInformationModel> = {
100
+ [key in keyof T]: ToNumberIfExtends<T[key], number | bigint>;
101
+ };
96
102
  type ToNumberIfExtends<K, E> = K extends E ? number : K;
97
103
  /** @deprecated Account information at a given round. */
98
- type AccountInformation = Omit<NumberConverter<AccountInformationModel>, 'getEncodingSchema' | 'toEncodingData' | 'authAddr'> & {
99
- /** (spend) the address against which signing should be checked. If empty, the address of the current account is used. This field can be updated in any transaction by setting the RekeyTo field. */authAddr?: string;
104
+ export type AccountInformation = Omit<NumberConverter<AccountInformationModel>, 'getEncodingSchema' | 'toEncodingData' | 'authAddr'> & {
105
+ /** (spend) the address against which signing should be checked. If empty, the address of the current account is used. This field can be updated in any transaction by setting the RekeyTo field. */
106
+ authAddr?: string;
100
107
  };
101
108
  /**
102
109
  * @deprecated Use `algorand.account.getInformation(sender)` or `new AccountManager(clientManager).getInformation(sender)` instead.
@@ -114,7 +121,7 @@ type AccountInformation = Omit<NumberConverter<AccountInformationModel>, 'getEnc
114
121
  * @param algod The algod instance
115
122
  * @returns The account information
116
123
  */
117
- declare function getAccountInformation(sender: string | SendTransactionFrom, algod: Algodv2): Promise<AccountInformation>;
124
+ export declare function getAccountInformation(sender: string | SendTransactionFrom, algod: Algodv2): Promise<AccountInformation>;
118
125
  /**
119
126
  * @deprecated Use `algorand.asset.getAccountInformation(sender, assetId)` or `new AssetManager(...).getAccountInformation(sender, assetId)` instead.
120
127
  *
@@ -133,7 +140,5 @@ declare function getAccountInformation(sender: string | SendTransactionFrom, alg
133
140
  * @param algod The algod instance
134
141
  * @returns The account asset holding information
135
142
  */
136
- declare function getAccountAssetInformation(sender: string | SendTransactionFrom, assetId: number | bigint, algod: Algodv2): Promise<AccountAssetInformation>;
137
- //#endregion
138
- export { AccountInformation, NumberConverter, getAccountAddressAsString, getAccountAddressAsUint8Array, getAccountAssetInformation, getAccountInformation, mnemonicAccountFromEnvironment, multisigAccount, randomAccount, rekeyedAccount, transactionSignerAccount };
139
- //# sourceMappingURL=account.d.ts.map
143
+ export declare function getAccountAssetInformation(sender: string | SendTransactionFrom, assetId: number | bigint, algod: Algodv2): Promise<AccountAssetInformation>;
144
+ export {};
@@ -1,6 +1,4 @@
1
- import { AccountConfig } from "../types/account.js";
2
-
3
- //#region src/account/get-account-config-from-environment.d.ts
1
+ import { AccountConfig } from '../types/account';
4
2
  /** @deprecated Use algokit.mnemonicAccountFromEnvironment, which doesn't need this function
5
3
  * Returns the Account configuration from environment variables
6
4
  *
@@ -11,7 +9,4 @@ import { AccountConfig } from "../types/account.js";
11
9
  * {accountName}_SENDER
12
10
  *
13
11
  */
14
- declare function getAccountConfigFromEnvironment(accountName: string): AccountConfig;
15
- //#endregion
16
- export { getAccountConfigFromEnvironment };
17
- //# sourceMappingURL=get-account-config-from-environment.d.ts.map
12
+ export declare function getAccountConfigFromEnvironment(accountName: string): AccountConfig;
@@ -1,8 +1,9 @@
1
- import { AlgoAmount } from "../types/amount.js";
2
- import { AccountConfig, SigningAccount } from "../types/account.js";
3
- import algosdk from "algosdk";
4
-
5
- //#region src/account/get-account.d.ts
1
+ import algosdk from 'algosdk';
2
+ import { AccountConfig, SigningAccount } from '../types/account';
3
+ import { AlgoAmount } from '../types/amount';
4
+ import Account = algosdk.Account;
5
+ import Algodv2 = algosdk.Algodv2;
6
+ import Kmd = algosdk.Kmd;
6
7
  /** @deprecated use `algorand.account.fromEnvironment()` instead
7
8
  *
8
9
  * Returns an Algorand account with private key loaded by convention based on the given name identifier.
@@ -33,9 +34,9 @@ import algosdk from "algosdk";
33
34
  * @param kmdClient An optional KMD client to use to create an account (when targeting LocalNet), if not specified then a default KMD client will be loaded from environment variables
34
35
  * @returns The requested account with private key loaded from the environment variables or when targeting LocalNet from KMD (idempotently creating and funding the account)
35
36
  */
36
- declare function getAccount(account: {
37
- name: string;
38
- fundWith?: AlgoAmount;
37
+ export declare function getAccount(account: {
38
+ name: string;
39
+ fundWith?: AlgoAmount;
39
40
  } | string, algod: Algodv2, kmdClient?: Kmd): Promise<Account | SigningAccount>;
40
41
  /** @deprecated use `algorand.account.fromEnvironment()` instead
41
42
  * Returns an Algorand account with private key loaded by convention based on the given name identifier.
@@ -58,10 +59,7 @@ declare function getAccount(account: {
58
59
  * @param kmdClient An optional KMD client to use to create an account (when targeting LocalNet), if not specified then a default KMD client will be loaded from environment variables
59
60
  * @returns The requested account with private key loaded from the environment variables or when targeting LocalNet from KMD (idempotently creating and funding the account)
60
61
  */
61
- declare function getAccount(account: {
62
- config: AccountConfig;
63
- fundWith?: AlgoAmount;
62
+ export declare function getAccount(account: {
63
+ config: AccountConfig;
64
+ fundWith?: AlgoAmount;
64
65
  }, algod: Algodv2, kmdClient?: Kmd): Promise<Account | SigningAccount>;
65
- //#endregion
66
- export { getAccount };
67
- //# sourceMappingURL=get-account.d.ts.map
@@ -1,7 +1,6 @@
1
- import { SigningAccount, TransactionSignerAccount } from "../types/account.js";
2
- import algosdk from "algosdk";
3
-
4
- //#region src/account/get-dispenser-account.d.ts
1
+ import algosdk from 'algosdk';
2
+ import Algodv2 = algosdk.Algodv2;
3
+ import Kmd = algosdk.Kmd;
5
4
  /**
6
5
  * @deprecated Use `algorand.account.dispenserFromEnvironment()` or `new AccountManager(clientManager).dispenserFromEnvironment()` instead
7
6
  *
@@ -13,9 +12,6 @@ import algosdk from "algosdk";
13
12
  * @param algod An algod client
14
13
  * @param kmd A KMD client, if not specified then a default KMD client will be loaded from environment variables
15
14
  */
16
- declare function getDispenserAccount(algod: Algodv2, kmd?: Kmd): Promise<algosdk.Address & TransactionSignerAccount & {
17
- account: SigningAccount;
15
+ export declare function getDispenserAccount(algod: Algodv2, kmd?: Kmd): Promise<algosdk.Address & import("../types/account").TransactionSignerAccount & {
16
+ account: import("../types/account").SigningAccount;
18
17
  }>;
19
- //#endregion
20
- export { getDispenserAccount };
21
- //# sourceMappingURL=get-dispenser-account.d.ts.map
@@ -0,0 +1,5 @@
1
+ export * from './account';
2
+ export * from './get-account';
3
+ export * from './get-account-config-from-environment';
4
+ export * from './get-dispenser-account';
5
+ export * from './mnemonic-account';
@@ -1,6 +1,5 @@
1
- import algosdk from "algosdk";
2
-
3
- //#region src/account/mnemonic-account.d.ts
1
+ import algosdk from 'algosdk';
2
+ import Account = algosdk.Account;
4
3
  /**
5
4
  * @deprecated Use `algorand.account.fromMnemonic(mnemonicSecret)` or `algosdk.mnemonicToSecretKey(mnemonicSecret)` instead.
6
5
  *
@@ -11,7 +10,4 @@ import algosdk from "algosdk";
11
10
  * @param mnemonicSecret The mnemonic secret representing the private key of an account; **Note: Be careful how the mnemonic is handled**,
12
11
  * never commit it into source control and ideally load it from the environment (ideally via a secret storage service) rather than the file system.
13
12
  */
14
- declare function mnemonicAccount(mnemonicSecret: string): Account;
15
- //#endregion
16
- export { mnemonicAccount };
17
- //# sourceMappingURL=mnemonic-account.d.ts.map
13
+ export declare function mnemonicAccount(mnemonicSecret: string): Account;
package/amount.d.ts CHANGED
@@ -1,57 +1,52 @@
1
- import { AlgoAmount } from "./types/amount.js";
2
-
3
- //#region src/amount.d.ts
1
+ import { AlgoAmount } from './types/amount';
4
2
  declare global {
5
- interface Number {
6
- /**
7
- * Returns an `AlgoAmount` using this number of microAlgo.
8
- */
9
- microAlgos(this: number): AlgoAmount;
10
- /**
11
- * Returns an `AlgoAmount` using this number of Algo.
12
- */
13
- algos(this: number): AlgoAmount;
14
- /**
15
- * Returns an `AlgoAmount` using this number of microAlgo.
16
- */
17
- microAlgo(this: number): AlgoAmount;
18
- /**
19
- * Returns an `AlgoAmount` using this number of Algo.
20
- */
21
- algo(this: number): AlgoAmount;
22
- }
23
- interface BigInt {
24
- /**
25
- * Returns an `AlgoAmount` using this number of microAlgo.
26
- */
27
- microAlgo(this: bigint): AlgoAmount;
28
- /**
29
- * Returns an `AlgoAmount` using this number of Algo.
30
- */
31
- algo(this: bigint): AlgoAmount;
32
- }
3
+ interface Number {
4
+ /**
5
+ * Returns an `AlgoAmount` using this number of microAlgo.
6
+ */
7
+ microAlgos(this: number): AlgoAmount;
8
+ /**
9
+ * Returns an `AlgoAmount` using this number of Algo.
10
+ */
11
+ algos(this: number): AlgoAmount;
12
+ /**
13
+ * Returns an `AlgoAmount` using this number of microAlgo.
14
+ */
15
+ microAlgo(this: number): AlgoAmount;
16
+ /**
17
+ * Returns an `AlgoAmount` using this number of Algo.
18
+ */
19
+ algo(this: number): AlgoAmount;
20
+ }
21
+ interface BigInt {
22
+ /**
23
+ * Returns an `AlgoAmount` using this number of microAlgo.
24
+ */
25
+ microAlgo(this: bigint): AlgoAmount;
26
+ /**
27
+ * Returns an `AlgoAmount` using this number of Algo.
28
+ */
29
+ algo(this: bigint): AlgoAmount;
30
+ }
33
31
  }
34
32
  /** Returns an amount of Algo using AlgoAmount
35
33
  * @param algos The amount of Algo
36
34
  */
37
- declare const algos: (algos: number | bigint) => AlgoAmount;
35
+ export declare const algos: (algos: number | bigint) => AlgoAmount;
38
36
  /** Returns an amount of Algo using AlgoAmount
39
37
  * @param algos The amount of Algo
40
38
  */
41
- declare const algo: (algos: number | bigint) => AlgoAmount;
39
+ export declare const algo: (algos: number | bigint) => AlgoAmount;
42
40
  /** Returns an amount of µAlgo using AlgoAmount
43
41
  * @param microAlgos The amount of µAlgo
44
42
  */
45
- declare const microAlgos: (microAlgos: number | bigint) => AlgoAmount;
43
+ export declare const microAlgos: (microAlgos: number | bigint) => AlgoAmount;
46
44
  /** Returns an amount of µAlgo using AlgoAmount
47
45
  * @param microAlgos The amount of µAlgo
48
46
  */
49
- declare const microAlgo: (microAlgos: number | bigint) => AlgoAmount;
47
+ export declare const microAlgo: (microAlgos: number | bigint) => AlgoAmount;
50
48
  /** Returns an amount of µAlgo to cover standard fees for the given number of transactions using AlgoAmount
51
49
  * @param numberOfTransactions The of standard transaction fees to return the amount of Algo
52
50
  */
53
- declare const transactionFees: (numberOfTransactions: number) => AlgoAmount;
54
- declare const ALGORAND_MIN_TX_FEE: AlgoAmount;
55
- //#endregion
56
- export { ALGORAND_MIN_TX_FEE, algo, algos, microAlgo, microAlgos, transactionFees };
57
- //# sourceMappingURL=amount.d.ts.map
51
+ export declare const transactionFees: (numberOfTransactions: number) => AlgoAmount;
52
+ export declare const ALGORAND_MIN_TX_FEE: AlgoAmount;
package/app-client.d.ts CHANGED
@@ -1,7 +1,6 @@
1
- import { AppSpecAppDetails, AppSpecAppDetailsByCreatorAndName, AppSpecAppDetailsById, ApplicationClient } from "./types/app-client.js";
2
- import algosdk from "algosdk";
3
-
4
- //#region src/app-client.d.ts
1
+ import algosdk from 'algosdk';
2
+ import { AppSpecAppDetails, AppSpecAppDetailsByCreatorAndName, AppSpecAppDetailsById, ApplicationClient } from './types/app-client';
3
+ import Algodv2 = algosdk.Algodv2;
5
4
  /**
6
5
  * @deprecated Use `AppClient` instead e.g. via `algorand.client.getAppClientById` or
7
6
  * `algorand.client.getAppClientByCreatorAndName`.
@@ -37,7 +36,7 @@ import algosdk from "algosdk";
37
36
  *
38
37
  * @returns The application client
39
38
  */
40
- declare function getAppClient(appDetails: AppSpecAppDetails, algod: Algodv2): ApplicationClient;
39
+ export declare function getAppClient(appDetails: AppSpecAppDetails, algod: Algodv2): ApplicationClient;
41
40
  /**
42
41
  * @deprecated Use `AppClient` instead e.g. via `algorand.client.getAppClientById`.
43
42
  * If you want to `create` or `deploy` then use `AppFactory` e.g. via `algorand.client.getAppFactory`,
@@ -60,7 +59,7 @@ declare function getAppClient(appDetails: AppSpecAppDetails, algod: Algodv2): Ap
60
59
  *
61
60
  * @returns The application client
62
61
  */
63
- declare function getAppClientById(appDetails: AppSpecAppDetailsById, algod: Algodv2): ApplicationClient;
62
+ export declare function getAppClientById(appDetails: AppSpecAppDetailsById, algod: Algodv2): ApplicationClient;
64
63
  /**
65
64
  * @deprecated Use `AppClient` instead e.g. via `algorand.client.getAppClientByCreatorAndName`.
66
65
  * If you want to `create` or `deploy` then use `AppFactory` e.g. via `algorand.client.getAppFactory`,
@@ -84,7 +83,4 @@ declare function getAppClientById(appDetails: AppSpecAppDetailsById, algod: Algo
84
83
  *
85
84
  * @returns The application client
86
85
  */
87
- declare function getAppClientByCreatorAndName(appDetails: AppSpecAppDetailsByCreatorAndName, algod: Algodv2): ApplicationClient;
88
- //#endregion
89
- export { getAppClient, getAppClientByCreatorAndName, getAppClientById };
90
- //# sourceMappingURL=app-client.d.ts.map
86
+ export declare function getAppClientByCreatorAndName(appDetails: AppSpecAppDetailsByCreatorAndName, algod: Algodv2): ApplicationClient;
package/app-deploy.d.ts CHANGED
@@ -1,8 +1,9 @@
1
- import { ABIReturn, AppCompilationResult, AppDeployMetadata, AppDeploymentParams, AppLookup, AppMetadata, CompiledTeal, TealTemplateParams } from "./types/app.js";
2
- import { Arc2TransactionNote, ConfirmedTransactionResult, ConfirmedTransactionResults, SendTransactionFrom } from "./types/transaction.js";
3
- import algosdk from "algosdk";
4
-
5
- //#region src/app-deploy.d.ts
1
+ import algosdk from 'algosdk';
2
+ import { ABIReturn, AppCompilationResult, AppDeployMetadata, AppDeploymentParams, AppLookup, AppMetadata, CompiledTeal, TealTemplateParams } from './types/app';
3
+ import { Arc2TransactionNote, ConfirmedTransactionResult, ConfirmedTransactionResults, SendTransactionFrom } from './types/transaction';
4
+ import Algodv2 = algosdk.Algodv2;
5
+ import Indexer = algosdk.Indexer;
6
+ import modelsv2 = algosdk.modelsv2;
6
7
  /**
7
8
  * @deprecated Use `algorand.appDeployer.deploy` instead.
8
9
  *
@@ -20,16 +21,16 @@ import algosdk from "algosdk";
20
21
  * @param indexer An indexer client, needed if `existingDeployments` not passed in
21
22
  * @returns The app reference of the new/existing app
22
23
  */
23
- declare function deployApp(deployment: AppDeploymentParams, algod: Algodv2, indexer?: Indexer): Promise<Partial<AppCompilationResult> & ((ConfirmedTransactionResults & AppMetadata & {
24
- return?: ABIReturn;
25
- operationPerformed: 'create' | 'update';
24
+ export declare function deployApp(deployment: AppDeploymentParams, algod: Algodv2, indexer?: Indexer): Promise<Partial<AppCompilationResult> & ((ConfirmedTransactionResults & AppMetadata & {
25
+ return?: ABIReturn;
26
+ operationPerformed: 'create' | 'update';
26
27
  }) | (ConfirmedTransactionResults & AppMetadata & {
27
- return?: ABIReturn;
28
- deleteReturn?: ABIReturn;
29
- deleteResult: ConfirmedTransactionResult;
30
- operationPerformed: 'replace';
28
+ return?: ABIReturn;
29
+ deleteReturn?: ABIReturn;
30
+ deleteResult: ConfirmedTransactionResult;
31
+ operationPerformed: 'replace';
31
32
  }) | (AppMetadata & {
32
- operationPerformed: 'nothing';
33
+ operationPerformed: 'nothing';
33
34
  }))>;
34
35
  /**
35
36
  * @deprecated Use `before.numByteSlice < after.numByteSlice || before.numUint < after.numUint` instead.
@@ -42,7 +43,7 @@ declare function deployApp(deployment: AppDeploymentParams, algod: Algodv2, inde
42
43
  * @param after The new schema
43
44
  * @returns Whether or not there is a breaking change
44
45
  */
45
- declare function isSchemaIsBroken(before: modelsv2.ApplicationStateSchema, after: modelsv2.ApplicationStateSchema): boolean;
46
+ export declare function isSchemaIsBroken(before: modelsv2.ApplicationStateSchema, after: modelsv2.ApplicationStateSchema): boolean;
46
47
  /**
47
48
  * @deprecated Use `algorand.appDeployer.getCreatorAppsByName` instead.
48
49
  *
@@ -54,7 +55,7 @@ declare function isSchemaIsBroken(before: modelsv2.ApplicationStateSchema, after
54
55
  * @param indexer An indexer client
55
56
  * @returns A name-based lookup of the app information (id, address)
56
57
  */
57
- declare function getCreatorAppsByName(creatorAccount: SendTransactionFrom | string, indexer: Indexer): Promise<AppLookup>;
58
+ export declare function getCreatorAppsByName(creatorAccount: SendTransactionFrom | string, indexer: Indexer): Promise<AppLookup>;
58
59
  /**
59
60
  * @deprecated Use `{ dAppName: APP_DEPLOY_NOTE_DAPP, data: metadata, format: 'j' }` instead.
60
61
  *
@@ -62,7 +63,7 @@ declare function getCreatorAppsByName(creatorAccount: SendTransactionFrom | stri
62
63
  * @param metadata The metadata of the deployment
63
64
  * @returns The transaction note as a utf-8 string
64
65
  */
65
- declare function getAppDeploymentTransactionNote(metadata: AppDeployMetadata): Arc2TransactionNote;
66
+ export declare function getAppDeploymentTransactionNote(metadata: AppDeployMetadata): Arc2TransactionNote;
66
67
  /**
67
68
  * @deprecated Use `AppManager.replaceTealTemplateDeployTimeControlParams` instead
68
69
  *
@@ -78,9 +79,9 @@ declare function getAppDeploymentTransactionNote(metadata: AppDeployMetadata): A
78
79
  * @param params The deploy-time deployment control parameter value to replace
79
80
  * @returns The replaced TEAL code
80
81
  */
81
- declare function replaceDeployTimeControlParams(tealCode: string, params: {
82
- updatable?: boolean;
83
- deletable?: boolean;
82
+ export declare function replaceDeployTimeControlParams(tealCode: string, params: {
83
+ updatable?: boolean;
84
+ deletable?: boolean;
84
85
  }): string;
85
86
  /**
86
87
  * @deprecated Use `AppManager.replaceTealTemplateParams` instead
@@ -93,7 +94,7 @@ declare function replaceDeployTimeControlParams(tealCode: string, params: {
93
94
  * @param templateParams Any parameters to replace in the .teal file before compiling
94
95
  * @returns The TEAL code with replacements
95
96
  */
96
- declare function performTemplateSubstitution(tealCode: string, templateParams?: TealTemplateParams): string;
97
+ export declare function performTemplateSubstitution(tealCode: string, templateParams?: TealTemplateParams): string;
97
98
  /**
98
99
  * @deprecated Use `algorand.appManager.compileTealTemplate` instead.
99
100
  *
@@ -107,7 +108,7 @@ declare function performTemplateSubstitution(tealCode: string, templateParams?:
107
108
  * @param deploymentMetadata The deployment metadata the app will be deployed with
108
109
  * @returns The information about the compiled code
109
110
  */
110
- declare function performTemplateSubstitutionAndCompile(tealCode: string, algod: Algodv2, templateParams?: TealTemplateParams, deploymentMetadata?: AppDeployMetadata): Promise<CompiledTeal>;
111
+ export declare function performTemplateSubstitutionAndCompile(tealCode: string, algod: Algodv2, templateParams?: TealTemplateParams, deploymentMetadata?: AppDeployMetadata): Promise<CompiledTeal>;
111
112
  /**
112
113
  * @deprecated Use `AppManager.stripTealComments` instead.
113
114
  *
@@ -116,7 +117,4 @@ declare function performTemplateSubstitutionAndCompile(tealCode: string, algod:
116
117
  * @param tealCode The TEAL logic to compile
117
118
  * @returns The TEAL without comments
118
119
  */
119
- declare function stripTealComments(tealCode: string): string;
120
- //#endregion
121
- export { deployApp, getAppDeploymentTransactionNote, getCreatorAppsByName, isSchemaIsBroken, performTemplateSubstitution, performTemplateSubstitutionAndCompile, replaceDeployTimeControlParams, stripTealComments };
122
- //# sourceMappingURL=app-deploy.d.ts.map
120
+ export declare function stripTealComments(tealCode: string): string;