@algorandfoundation/algokit-utils 7.0.0-beta.1 → 7.0.0-beta.3

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 (133) hide show
  1. package/README.md +1 -1
  2. package/account/account.d.ts +7 -7
  3. package/account/account.js +7 -7
  4. package/account/account.mjs +7 -7
  5. package/account/get-account.d.ts +2 -2
  6. package/account/get-account.js +1 -1
  7. package/account/get-account.mjs +1 -1
  8. package/account/get-dispenser-account.d.ts +1 -1
  9. package/account/get-dispenser-account.js +1 -1
  10. package/account/get-dispenser-account.mjs +1 -1
  11. package/account/mnemonic-account.d.ts +1 -1
  12. package/account/mnemonic-account.js +1 -1
  13. package/account/mnemonic-account.mjs +1 -1
  14. package/app-deploy.d.ts +18 -1
  15. package/app-deploy.d.ts.map +1 -1
  16. package/app-deploy.js +142 -333
  17. package/app-deploy.js.map +1 -1
  18. package/app-deploy.mjs +145 -336
  19. package/app-deploy.mjs.map +1 -1
  20. package/app.d.ts +38 -1
  21. package/app.d.ts.map +1 -1
  22. package/app.js +113 -370
  23. package/app.js.map +1 -1
  24. package/app.mjs +114 -371
  25. package/app.mjs.map +1 -1
  26. package/asset.d.ts +5 -5
  27. package/asset.js +5 -5
  28. package/asset.mjs +5 -5
  29. package/debugging/debugging.js +2 -2
  30. package/debugging/debugging.js.map +1 -1
  31. package/debugging/debugging.mjs +2 -2
  32. package/debugging/debugging.mjs.map +1 -1
  33. package/index.d.ts +1 -1
  34. package/index.d.ts.map +1 -1
  35. package/index.js +12 -12
  36. package/index.mjs +1 -1
  37. package/localnet/get-kmd-wallet-account.d.ts +1 -1
  38. package/localnet/get-kmd-wallet-account.js +1 -1
  39. package/localnet/get-kmd-wallet-account.mjs +1 -1
  40. package/localnet/get-localnet-dispenser-account.d.ts +1 -1
  41. package/localnet/get-localnet-dispenser-account.js +1 -1
  42. package/localnet/get-localnet-dispenser-account.mjs +1 -1
  43. package/localnet/get-or-create-kmd-wallet-account.d.ts +1 -1
  44. package/localnet/get-or-create-kmd-wallet-account.js +1 -1
  45. package/localnet/get-or-create-kmd-wallet-account.mjs +1 -1
  46. package/localnet/is-localnet.d.ts +1 -1
  47. package/localnet/is-localnet.js +1 -1
  48. package/localnet/is-localnet.mjs +1 -1
  49. package/network-client.d.ts +2 -2
  50. package/network-client.d.ts.map +1 -1
  51. package/network-client.js +2 -2
  52. package/network-client.mjs +2 -2
  53. package/package.json +1 -1
  54. package/testing/fixtures/algorand-fixture.js +12 -12
  55. package/testing/fixtures/algorand-fixture.js.map +1 -1
  56. package/testing/fixtures/algorand-fixture.mjs +12 -12
  57. package/testing/fixtures/algorand-fixture.mjs.map +1 -1
  58. package/transaction/legacy-bridge.d.ts +31 -5
  59. package/transaction/legacy-bridge.d.ts.map +1 -1
  60. package/transaction/legacy-bridge.js +99 -5
  61. package/transaction/legacy-bridge.js.map +1 -1
  62. package/transaction/legacy-bridge.mjs +98 -7
  63. package/transaction/legacy-bridge.mjs.map +1 -1
  64. package/transfer/transfer-algos.d.ts +1 -1
  65. package/transfer/transfer-algos.js +1 -1
  66. package/transfer/transfer-algos.mjs +1 -1
  67. package/transfer/transfer.d.ts +1 -1
  68. package/transfer/transfer.js +1 -1
  69. package/transfer/transfer.mjs +1 -1
  70. package/types/account-manager.d.ts +1 -1
  71. package/types/account-manager.d.ts.map +1 -1
  72. package/types/algorand-client-transaction-creator.d.ts +450 -20
  73. package/types/algorand-client-transaction-creator.d.ts.map +1 -1
  74. package/types/algorand-client-transaction-creator.js +406 -22
  75. package/types/algorand-client-transaction-creator.js.map +1 -1
  76. package/types/algorand-client-transaction-creator.mjs +406 -22
  77. package/types/algorand-client-transaction-creator.mjs.map +1 -1
  78. package/types/algorand-client-transaction-sender.d.ts +750 -24
  79. package/types/algorand-client-transaction-sender.d.ts.map +1 -1
  80. package/types/algorand-client-transaction-sender.js +426 -12
  81. package/types/algorand-client-transaction-sender.js.map +1 -1
  82. package/types/algorand-client-transaction-sender.mjs +426 -12
  83. package/types/algorand-client-transaction-sender.mjs.map +1 -1
  84. package/types/algorand-client.d.ts +8 -0
  85. package/types/algorand-client.d.ts.map +1 -1
  86. package/types/algorand-client.js +14 -1
  87. package/types/algorand-client.js.map +1 -1
  88. package/types/algorand-client.mjs +14 -1
  89. package/types/algorand-client.mjs.map +1 -1
  90. package/types/app-client.d.ts +13 -1
  91. package/types/app-client.d.ts.map +1 -1
  92. package/types/app-client.js +8 -5
  93. package/types/app-client.js.map +1 -1
  94. package/types/app-client.mjs +9 -6
  95. package/types/app-client.mjs.map +1 -1
  96. package/types/app-deployer.d.ts +121 -0
  97. package/types/app-deployer.d.ts.map +1 -0
  98. package/types/app-deployer.js +354 -0
  99. package/types/app-deployer.js.map +1 -0
  100. package/types/app-deployer.mjs +352 -0
  101. package/types/app-deployer.mjs.map +1 -0
  102. package/types/app-manager.d.ts +235 -0
  103. package/types/app-manager.d.ts.map +1 -0
  104. package/types/app-manager.js +336 -0
  105. package/types/app-manager.js.map +1 -0
  106. package/types/app-manager.mjs +334 -0
  107. package/types/app-manager.mjs.map +1 -0
  108. package/types/app.d.ts +42 -7
  109. package/types/app.d.ts.map +1 -1
  110. package/types/app.js +1 -1
  111. package/types/app.js.map +1 -1
  112. package/types/app.mjs +1 -1
  113. package/types/app.mjs.map +1 -1
  114. package/types/client-manager.d.ts +2 -0
  115. package/types/client-manager.d.ts.map +1 -1
  116. package/types/client-manager.js +4 -0
  117. package/types/client-manager.js.map +1 -1
  118. package/types/client-manager.mjs +4 -0
  119. package/types/client-manager.mjs.map +1 -1
  120. package/types/composer.d.ts +150 -39
  121. package/types/composer.d.ts.map +1 -1
  122. package/types/composer.js +218 -62
  123. package/types/composer.js.map +1 -1
  124. package/types/composer.mjs +218 -62
  125. package/types/composer.mjs.map +1 -1
  126. package/types/expand.d.ts +8 -0
  127. package/types/expand.d.ts.map +1 -0
  128. package/types/expand.js +3 -0
  129. package/types/expand.js.map +1 -0
  130. package/types/expand.mjs +2 -0
  131. package/types/expand.mjs.map +1 -0
  132. package/types/transaction.d.ts +3 -0
  133. package/types/transaction.d.ts.map +1 -1
package/README.md CHANGED
@@ -13,7 +13,7 @@ Note: If you prefer Python there's an equivalent [Python utility library](https:
13
13
  This library can be installed from NPM using your favourite npm client, e.g.:
14
14
 
15
15
  ```
16
- npm install @algorandfoundation/algokit-utils
16
+ npm install algosdk@2 @algorandfoundation/algokit-utils
17
17
  ```
18
18
 
19
19
  Then to import it:
@@ -9,7 +9,7 @@ import MultisigMetadata = algosdk.MultisigMetadata;
9
9
  import TransactionSigner = algosdk.TransactionSigner;
10
10
  import AccountInformationModel = algosdk.modelsv2.Account;
11
11
  /**
12
- * @deprecated Use `algorandClient.account.multisig(multisigParams, signingAccounts)` or `new MultisigAccount(multisigParams, signingAccounts)` instead.
12
+ * @deprecated Use `algorand.account.multisig(multisigParams, signingAccounts)` or `new MultisigAccount(multisigParams, signingAccounts)` instead.
13
13
  *
14
14
  * Returns an account wrapper that supports partial or full multisig signing.
15
15
  * @param multisigParams The parameters that define the multisig account
@@ -18,7 +18,7 @@ import AccountInformationModel = algosdk.modelsv2.Account;
18
18
  */
19
19
  export declare function multisigAccount(multisigParams: MultisigMetadata, signingAccounts: (Account | SigningAccount)[]): MultisigAccount;
20
20
  /**
21
- * @deprecated Use `algorandClient.account.rekeyed(sender, account)` or `new SigningAccount(account, sender)` instead.
21
+ * @deprecated Use `algorand.account.rekeyed(sender, account)` or `new SigningAccount(account, sender)` instead.
22
22
  *
23
23
  * Returns an account wrapper that supports a rekeyed account.
24
24
  * @param signer The account, with private key loaded, that is signing
@@ -27,7 +27,7 @@ export declare function multisigAccount(multisigParams: MultisigMetadata, signin
27
27
  */
28
28
  export declare function rekeyedAccount(signer: Account, sender: string): SigningAccount;
29
29
  /**
30
- * @deprecated Use `algorandClient.account.getSigner(sender)` (after previously registering the signer with `setSigner`) or `{ addr: sender, signer }` instead.
30
+ * @deprecated Use `algorand.account.getSigner(sender)` (after previously registering the signer with `setSigner`) or `{ addr: sender, signer }` instead.
31
31
  *
32
32
  * Returns an account wrapper that supports a transaction signer with associated sender address.
33
33
  * @param signer The transaction signer
@@ -36,7 +36,7 @@ export declare function rekeyedAccount(signer: Account, sender: string): Signing
36
36
  */
37
37
  export declare function transactionSignerAccount(signer: TransactionSigner, sender: string): TransactionSignerAccount;
38
38
  /**
39
- * @deprecated Use `algorandClient.account.random()` or `algosdk.generateAccount()` instead.
39
+ * @deprecated Use `algorand.account.random()` or `algosdk.generateAccount()` instead.
40
40
  *
41
41
  * Returns a new, random Algorand account with secret key loaded.
42
42
  *
@@ -45,7 +45,7 @@ export declare function transactionSignerAccount(signer: TransactionSigner, send
45
45
  */
46
46
  export declare function randomAccount(): Account;
47
47
  /**
48
- * @deprecated Use `algorandClient.account.fromEnvironment(name, fundWith)` or `new AccountManager(clientManager).fromEnvironment()` instead.
48
+ * @deprecated Use `algorand.account.fromEnvironment(name, fundWith)` or `new AccountManager(clientManager).fromEnvironment()` instead.
49
49
  *
50
50
  * Returns an Algorand account with private key loaded by convention from environment variables based on the given name identifier.
51
51
  *
@@ -103,7 +103,7 @@ type ToNumberIfExtends<K, E> = K extends E ? number : K;
103
103
  /** @deprecated Account information at a given round. */
104
104
  export type AccountInformation = Omit<NumberConverter<AccountInformationModel>, 'get_obj_for_encoding'>;
105
105
  /**
106
- * @deprecated Use `algorandClient.account.getInformation(sender)` or `new AccountManager(clientManager).getInformation(sender)` instead.
106
+ * @deprecated Use `algorand.account.getInformation(sender)` or `new AccountManager(clientManager).getInformation(sender)` instead.
107
107
  *
108
108
  * Returns the given sender account's current status, balance and spendable amounts.
109
109
  *
@@ -120,7 +120,7 @@ export type AccountInformation = Omit<NumberConverter<AccountInformationModel>,
120
120
  */
121
121
  export declare function getAccountInformation(sender: string | SendTransactionFrom, algod: Algodv2): Promise<AccountInformation>;
122
122
  /**
123
- * @deprecated Use `algorandClient.asset.getAccountInformation(sender, assetId)` or `new AssetManager(...).getAccountInformation(sender, assetId)` instead.
123
+ * @deprecated Use `algorand.asset.getAccountInformation(sender, assetId)` or `new AssetManager(...).getAccountInformation(sender, assetId)` instead.
124
124
  *
125
125
  * Returns the given sender account's asset holding for a given asset.
126
126
  *
@@ -9,7 +9,7 @@ var types_clientManager = require('../types/client-manager.js');
9
9
 
10
10
  var AccountInformationModel = algosdk.modelsv2.Account;
11
11
  /**
12
- * @deprecated Use `algorandClient.account.multisig(multisigParams, signingAccounts)` or `new MultisigAccount(multisigParams, signingAccounts)` instead.
12
+ * @deprecated Use `algorand.account.multisig(multisigParams, signingAccounts)` or `new MultisigAccount(multisigParams, signingAccounts)` instead.
13
13
  *
14
14
  * Returns an account wrapper that supports partial or full multisig signing.
15
15
  * @param multisigParams The parameters that define the multisig account
@@ -20,7 +20,7 @@ function multisigAccount(multisigParams, signingAccounts) {
20
20
  return new types_account.MultisigAccount(multisigParams, signingAccounts);
21
21
  }
22
22
  /**
23
- * @deprecated Use `algorandClient.account.rekeyed(sender, account)` or `new SigningAccount(account, sender)` instead.
23
+ * @deprecated Use `algorand.account.rekeyed(sender, account)` or `new SigningAccount(account, sender)` instead.
24
24
  *
25
25
  * Returns an account wrapper that supports a rekeyed account.
26
26
  * @param signer The account, with private key loaded, that is signing
@@ -31,7 +31,7 @@ function rekeyedAccount(signer, sender) {
31
31
  return new types_account.SigningAccount(signer, sender);
32
32
  }
33
33
  /**
34
- * @deprecated Use `algorandClient.account.getSigner(sender)` (after previously registering the signer with `setSigner`) or `{ addr: sender, signer }` instead.
34
+ * @deprecated Use `algorand.account.getSigner(sender)` (after previously registering the signer with `setSigner`) or `{ addr: sender, signer }` instead.
35
35
  *
36
36
  * Returns an account wrapper that supports a transaction signer with associated sender address.
37
37
  * @param signer The transaction signer
@@ -42,7 +42,7 @@ function transactionSignerAccount(signer, sender) {
42
42
  return { addr: sender, signer };
43
43
  }
44
44
  /**
45
- * @deprecated Use `algorandClient.account.random()` or `algosdk.generateAccount()` instead.
45
+ * @deprecated Use `algorand.account.random()` or `algosdk.generateAccount()` instead.
46
46
  *
47
47
  * Returns a new, random Algorand account with secret key loaded.
48
48
  *
@@ -54,7 +54,7 @@ function randomAccount() {
54
54
  return algosdk.generateAccount();
55
55
  }
56
56
  /**
57
- * @deprecated Use `algorandClient.account.fromEnvironment(name, fundWith)` or `new AccountManager(clientManager).fromEnvironment()` instead.
57
+ * @deprecated Use `algorand.account.fromEnvironment(name, fundWith)` or `new AccountManager(clientManager).fromEnvironment()` instead.
58
58
  *
59
59
  * Returns an Algorand account with private key loaded by convention from environment variables based on the given name identifier.
60
60
  *
@@ -109,7 +109,7 @@ function getAccountAddressAsString(addressEncodedInB64) {
109
109
  return algosdk.encodeAddress(Buffer.from(addressEncodedInB64, 'base64'));
110
110
  }
111
111
  /**
112
- * @deprecated Use `algorandClient.account.getInformation(sender)` or `new AccountManager(clientManager).getInformation(sender)` instead.
112
+ * @deprecated Use `algorand.account.getInformation(sender)` or `new AccountManager(clientManager).getInformation(sender)` instead.
113
113
  *
114
114
  * Returns the given sender account's current status, balance and spendable amounts.
115
115
  *
@@ -146,7 +146,7 @@ async function getAccountInformation(sender, algod) {
146
146
  };
147
147
  }
148
148
  /**
149
- * @deprecated Use `algorandClient.asset.getAccountInformation(sender, assetId)` or `new AssetManager(...).getAccountInformation(sender, assetId)` instead.
149
+ * @deprecated Use `algorand.asset.getAccountInformation(sender, assetId)` or `new AssetManager(...).getAccountInformation(sender, assetId)` instead.
150
150
  *
151
151
  * Returns the given sender account's asset holding for a given asset.
152
152
  *
@@ -7,7 +7,7 @@ import { ClientManager } from '../types/client-manager.mjs';
7
7
 
8
8
  var AccountInformationModel = algosdk.modelsv2.Account;
9
9
  /**
10
- * @deprecated Use `algorandClient.account.multisig(multisigParams, signingAccounts)` or `new MultisigAccount(multisigParams, signingAccounts)` instead.
10
+ * @deprecated Use `algorand.account.multisig(multisigParams, signingAccounts)` or `new MultisigAccount(multisigParams, signingAccounts)` instead.
11
11
  *
12
12
  * Returns an account wrapper that supports partial or full multisig signing.
13
13
  * @param multisigParams The parameters that define the multisig account
@@ -18,7 +18,7 @@ function multisigAccount(multisigParams, signingAccounts) {
18
18
  return new MultisigAccount(multisigParams, signingAccounts);
19
19
  }
20
20
  /**
21
- * @deprecated Use `algorandClient.account.rekeyed(sender, account)` or `new SigningAccount(account, sender)` instead.
21
+ * @deprecated Use `algorand.account.rekeyed(sender, account)` or `new SigningAccount(account, sender)` instead.
22
22
  *
23
23
  * Returns an account wrapper that supports a rekeyed account.
24
24
  * @param signer The account, with private key loaded, that is signing
@@ -29,7 +29,7 @@ function rekeyedAccount(signer, sender) {
29
29
  return new SigningAccount(signer, sender);
30
30
  }
31
31
  /**
32
- * @deprecated Use `algorandClient.account.getSigner(sender)` (after previously registering the signer with `setSigner`) or `{ addr: sender, signer }` instead.
32
+ * @deprecated Use `algorand.account.getSigner(sender)` (after previously registering the signer with `setSigner`) or `{ addr: sender, signer }` instead.
33
33
  *
34
34
  * Returns an account wrapper that supports a transaction signer with associated sender address.
35
35
  * @param signer The transaction signer
@@ -40,7 +40,7 @@ function transactionSignerAccount(signer, sender) {
40
40
  return { addr: sender, signer };
41
41
  }
42
42
  /**
43
- * @deprecated Use `algorandClient.account.random()` or `algosdk.generateAccount()` instead.
43
+ * @deprecated Use `algorand.account.random()` or `algosdk.generateAccount()` instead.
44
44
  *
45
45
  * Returns a new, random Algorand account with secret key loaded.
46
46
  *
@@ -52,7 +52,7 @@ function randomAccount() {
52
52
  return algosdk.generateAccount();
53
53
  }
54
54
  /**
55
- * @deprecated Use `algorandClient.account.fromEnvironment(name, fundWith)` or `new AccountManager(clientManager).fromEnvironment()` instead.
55
+ * @deprecated Use `algorand.account.fromEnvironment(name, fundWith)` or `new AccountManager(clientManager).fromEnvironment()` instead.
56
56
  *
57
57
  * Returns an Algorand account with private key loaded by convention from environment variables based on the given name identifier.
58
58
  *
@@ -107,7 +107,7 @@ function getAccountAddressAsString(addressEncodedInB64) {
107
107
  return algosdk.encodeAddress(Buffer.from(addressEncodedInB64, 'base64'));
108
108
  }
109
109
  /**
110
- * @deprecated Use `algorandClient.account.getInformation(sender)` or `new AccountManager(clientManager).getInformation(sender)` instead.
110
+ * @deprecated Use `algorand.account.getInformation(sender)` or `new AccountManager(clientManager).getInformation(sender)` instead.
111
111
  *
112
112
  * Returns the given sender account's current status, balance and spendable amounts.
113
113
  *
@@ -144,7 +144,7 @@ async function getAccountInformation(sender, algod) {
144
144
  };
145
145
  }
146
146
  /**
147
- * @deprecated Use `algorandClient.asset.getAccountInformation(sender, assetId)` or `new AssetManager(...).getAccountInformation(sender, assetId)` instead.
147
+ * @deprecated Use `algorand.asset.getAccountInformation(sender, assetId)` or `new AssetManager(...).getAccountInformation(sender, assetId)` instead.
148
148
  *
149
149
  * Returns the given sender account's asset holding for a given asset.
150
150
  *
@@ -4,7 +4,7 @@ import { AlgoAmount } from '../types/amount';
4
4
  import Account = algosdk.Account;
5
5
  import Algodv2 = algosdk.Algodv2;
6
6
  import Kmd = algosdk.Kmd;
7
- /** @deprecated use `algorandClient.account.fromEnvironment()` instead
7
+ /** @deprecated use `algorand.account.fromEnvironment()` instead
8
8
  *
9
9
  * Returns an Algorand account with private key loaded by convention based on the given name identifier.
10
10
  *
@@ -38,7 +38,7 @@ export declare function getAccount(account: {
38
38
  name: string;
39
39
  fundWith?: AlgoAmount;
40
40
  } | string, algod: Algodv2, kmdClient?: Kmd): Promise<Account | SigningAccount>;
41
- /** @deprecated use `algorandClient.account.fromEnvironment()` instead
41
+ /** @deprecated use `algorand.account.fromEnvironment()` instead
42
42
  * Returns an Algorand account with private key loaded by convention based on the given name identifier.
43
43
  *
44
44
  * Note: This function expects to run in a Node.js environment.
@@ -4,7 +4,7 @@ var types_accountManager = require('../types/account-manager.js');
4
4
  var types_clientManager = require('../types/client-manager.js');
5
5
  var getAccountConfigFromEnvironment = require('./get-account-config-from-environment.js');
6
6
 
7
- /** @deprecated use `algorandClient.account.fromEnvironment()` instead
7
+ /** @deprecated use `algorand.account.fromEnvironment()` instead
8
8
  * Returns an Algorand account with private key loaded by convention based on the given name identifier.
9
9
  *
10
10
  * Note: This function expects to run in a Node.js environment.
@@ -2,7 +2,7 @@ import { AccountManager } from '../types/account-manager.mjs';
2
2
  import { ClientManager } from '../types/client-manager.mjs';
3
3
  import { getAccountConfigFromEnvironment } from './get-account-config-from-environment.mjs';
4
4
 
5
- /** @deprecated use `algorandClient.account.fromEnvironment()` instead
5
+ /** @deprecated use `algorand.account.fromEnvironment()` instead
6
6
  * Returns an Algorand account with private key loaded by convention based on the given name identifier.
7
7
  *
8
8
  * Note: This function expects to run in a Node.js environment.
@@ -2,7 +2,7 @@ import algosdk from 'algosdk';
2
2
  import Algodv2 = algosdk.Algodv2;
3
3
  import Kmd = algosdk.Kmd;
4
4
  /**
5
- * @deprecated Use `algorandClient.account.dispenserFromEnvironment()` or `new AccountManager(clientManager).dispenserFromEnvironment()` instead
5
+ * @deprecated Use `algorand.account.dispenserFromEnvironment()` or `new AccountManager(clientManager).dispenserFromEnvironment()` instead
6
6
  *
7
7
  * Returns an account (with private key loaded) that can act as a dispenser
8
8
  *
@@ -4,7 +4,7 @@ var types_accountManager = require('../types/account-manager.js');
4
4
  var types_clientManager = require('../types/client-manager.js');
5
5
 
6
6
  /**
7
- * @deprecated Use `algorandClient.account.dispenserFromEnvironment()` or `new AccountManager(clientManager).dispenserFromEnvironment()` instead
7
+ * @deprecated Use `algorand.account.dispenserFromEnvironment()` or `new AccountManager(clientManager).dispenserFromEnvironment()` instead
8
8
  *
9
9
  * Returns an account (with private key loaded) that can act as a dispenser
10
10
  *
@@ -2,7 +2,7 @@ import { AccountManager } from '../types/account-manager.mjs';
2
2
  import { ClientManager } from '../types/client-manager.mjs';
3
3
 
4
4
  /**
5
- * @deprecated Use `algorandClient.account.dispenserFromEnvironment()` or `new AccountManager(clientManager).dispenserFromEnvironment()` instead
5
+ * @deprecated Use `algorand.account.dispenserFromEnvironment()` or `new AccountManager(clientManager).dispenserFromEnvironment()` instead
6
6
  *
7
7
  * Returns an account (with private key loaded) that can act as a dispenser
8
8
  *
@@ -1,7 +1,7 @@
1
1
  import algosdk from 'algosdk';
2
2
  import Account = algosdk.Account;
3
3
  /**
4
- * @deprecated Use `algorandClient.account.fromMnemonic(mnemonicSecret)` or `algosdk.mnemonicToSecretKey(mnemonicSecret)` instead.
4
+ * @deprecated Use `algorand.account.fromMnemonic(mnemonicSecret)` or `algosdk.mnemonicToSecretKey(mnemonicSecret)` instead.
5
5
  *
6
6
  * Returns an Algorand account with secret key loaded (i.e. that can sign transactions) by taking the mnemonic secret.
7
7
  *
@@ -3,7 +3,7 @@
3
3
  var algosdk = require('algosdk');
4
4
 
5
5
  /**
6
- * @deprecated Use `algorandClient.account.fromMnemonic(mnemonicSecret)` or `algosdk.mnemonicToSecretKey(mnemonicSecret)` instead.
6
+ * @deprecated Use `algorand.account.fromMnemonic(mnemonicSecret)` or `algosdk.mnemonicToSecretKey(mnemonicSecret)` instead.
7
7
  *
8
8
  * Returns an Algorand account with secret key loaded (i.e. that can sign transactions) by taking the mnemonic secret.
9
9
  *
@@ -1,7 +1,7 @@
1
1
  import algosdk from 'algosdk';
2
2
 
3
3
  /**
4
- * @deprecated Use `algorandClient.account.fromMnemonic(mnemonicSecret)` or `algosdk.mnemonicToSecretKey(mnemonicSecret)` instead.
4
+ * @deprecated Use `algorand.account.fromMnemonic(mnemonicSecret)` or `algosdk.mnemonicToSecretKey(mnemonicSecret)` instead.
5
5
  *
6
6
  * Returns an Algorand account with secret key loaded (i.e. that can sign transactions) by taking the mnemonic secret.
7
7
  *
package/app-deploy.d.ts CHANGED
@@ -5,6 +5,8 @@ import Algodv2 = algosdk.Algodv2;
5
5
  import Indexer = algosdk.Indexer;
6
6
  import modelsv2 = algosdk.modelsv2;
7
7
  /**
8
+ * @deprecated Use `algorand.appDeployer.deploy` instead.
9
+ *
8
10
  * Idempotently deploy (create, update/delete if changed) an app against the given name via the given creator account, including deploy-time template placeholder substitutions.
9
11
  *
10
12
  * To understand the architecture decisions behind this functionality please see https://github.com/algorandfoundation/algokit-cli/blob/main/docs/architecture-decisions/2023-01-12_smart-contract-deployment.md
@@ -30,7 +32,10 @@ export declare function deployApp(deployment: AppDeploymentParams, algod: Algodv
30
32
  }) | (AppMetadata & {
31
33
  operationPerformed: 'nothing';
32
34
  }))>;
33
- /** Returns true is there is a breaking change in the application state schema from before to after.
35
+ /**
36
+ * @deprecated Use `before.numByteSlice < after.numByteSlice || before.numUint < after.numUint` instead.
37
+ *
38
+ * Returns true is there is a breaking change in the application state schema from before to after.
34
39
  * i.e. if the schema becomes larger, since applications can't ask for more schema after creation.
35
40
  * Otherwise, there is no error, the app just doesn't store data in the extra schema :(
36
41
  *
@@ -40,6 +45,8 @@ export declare function deployApp(deployment: AppDeploymentParams, algod: Algodv
40
45
  */
41
46
  export declare function isSchemaIsBroken(before: modelsv2.ApplicationStateSchema, after: modelsv2.ApplicationStateSchema): boolean;
42
47
  /**
48
+ * @deprecated Use `algorand.appDeployer.getCreatorAppsByName` instead.
49
+ *
43
50
  * Returns a lookup of name => app metadata (id, address, ...metadata) for all apps created by the given account that have an `AppDeployNote` in the transaction note of the creation transaction.
44
51
  *
45
52
  * **Note:** It's recommended this is only called once and then stored since it's a somewhat expensive operation (multiple indexer calls).
@@ -50,12 +57,16 @@ export declare function isSchemaIsBroken(before: modelsv2.ApplicationStateSchema
50
57
  */
51
58
  export declare function getCreatorAppsByName(creatorAccount: SendTransactionFrom | string, indexer: Indexer): Promise<AppLookup>;
52
59
  /**
60
+ * @deprecated Use `{ dAppName: APP_DEPLOY_NOTE_DAPP, data: metadata, format: 'j' }` instead.
61
+ *
53
62
  * Return the transaction note for an app deployment.
54
63
  * @param metadata The metadata of the deployment
55
64
  * @returns The transaction note as a utf-8 string
56
65
  */
57
66
  export declare function getAppDeploymentTransactionNote(metadata: AppDeployMetadata): Arc2TransactionNote;
58
67
  /**
68
+ * @deprecated Use `AppManager.replaceTealTemplateDeployTimeControlParams` instead
69
+ *
59
70
  * Replaces deploy-time deployment control parameters within the given teal code.
60
71
  *
61
72
  * * `TMPL_UPDATABLE` for updatability / immutability control
@@ -73,6 +84,8 @@ export declare function replaceDeployTimeControlParams(tealCode: string, params:
73
84
  deletable?: boolean;
74
85
  }): string;
75
86
  /**
87
+ * @deprecated Use `AppManager.replaceTealTemplateParams` instead
88
+ *
76
89
  * Performs template substitution of a teal file.
77
90
  *
78
91
  * Looks for `TMPL_{parameter}` for template replacements.
@@ -83,6 +96,8 @@ export declare function replaceDeployTimeControlParams(tealCode: string, params:
83
96
  */
84
97
  export declare function performTemplateSubstitution(tealCode: string, templateParams?: TealTemplateParams): string;
85
98
  /**
99
+ * @deprecated Use `algorand.appManager.compileTealTemplate` instead.
100
+ *
86
101
  * Performs template substitution of a teal file and compiles it, returning the compiled result.
87
102
  *
88
103
  * Looks for `TMPL_{parameter}` for template replacements.
@@ -95,6 +110,8 @@ export declare function performTemplateSubstitution(tealCode: string, templatePa
95
110
  */
96
111
  export declare function performTemplateSubstitutionAndCompile(tealCode: string, algod: Algodv2, templateParams?: TealTemplateParams, deploymentMetadata?: AppDeployMetadata): Promise<CompiledTeal>;
97
112
  /**
113
+ * @deprecated Use `AppManager.stripTealComments` instead.
114
+ *
98
115
  * Remove comments from TEAL Code
99
116
  *
100
117
  * @param tealCode The TEAL logic to compile
@@ -1 +1 @@
1
- {"version":3,"file":"app-deploy.d.ts","sourceRoot":"","sources":["../src/app-deploy.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAA;AAK7B,OAAO,EACL,SAAS,EAET,oBAAoB,EACpB,iBAAiB,EACjB,mBAAmB,EACnB,SAAS,EACT,WAAW,EACX,YAAY,EAIZ,kBAAkB,EAEnB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,mBAAmB,EAAE,0BAA0B,EAAE,2BAA2B,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AACvI,OAAO,OAAO,GAAG,OAAO,CAAC,OAAO,CAAA;AAGhC,OAAO,OAAO,GAAG,OAAO,CAAC,OAAO,CAAA;AAChC,OAAO,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAA;AAGlC;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,SAAS,CAC7B,UAAU,EAAE,mBAAmB,EAC/B,KAAK,EAAE,OAAO,EACd,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CACR,OAAO,CAAC,oBAAoB,CAAC,GAC3B,CACI,CAAC,2BAA2B,GAAG,WAAW,GAAG;IAAE,MAAM,CAAC,EAAE,SAAS,CAAC;IAAC,kBAAkB,EAAE,QAAQ,GAAG,QAAQ,CAAA;CAAE,CAAC,GAC7G,CAAC,2BAA2B,GAC1B,WAAW,GAAG;IACZ,MAAM,CAAC,EAAE,SAAS,CAAA;IAClB,YAAY,CAAC,EAAE,SAAS,CAAA;IACxB,YAAY,EAAE,0BAA0B,CAAA;IACxC,kBAAkB,EAAE,SAAS,CAAA;CAC9B,CAAC,GACJ,CAAC,WAAW,GAAG;IAAE,kBAAkB,EAAE,SAAS,CAAA;CAAE,CAAC,CACpD,CACJ,CAuVA;AAED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,QAAQ,CAAC,sBAAsB,EAAE,KAAK,EAAE,QAAQ,CAAC,sBAAsB,WAE/G;AAED;;;;;;;;GAQG;AACH,wBAAsB,oBAAoB,CAAC,cAAc,EAAE,mBAAmB,GAAG,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC,CAoG7H;AAED;;;;GAIG;AACH,wBAAgB,+BAA+B,CAAC,QAAQ,EAAE,iBAAiB,GAAG,mBAAmB,CAMhG;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,8BAA8B,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE;IAAE,SAAS,CAAC,EAAE,OAAO,CAAC;IAAC,SAAS,CAAC,EAAE,OAAO,CAAA;CAAE,UAoBpH;AAED;;;;;;;;GAQG;AACH,wBAAgB,2BAA2B,CAAC,QAAQ,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,kBAAkB,UA0BhG;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,qCAAqC,CACzD,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,OAAO,EACd,cAAc,CAAC,EAAE,kBAAkB,EACnC,kBAAkB,CAAC,EAAE,iBAAiB,GACrC,OAAO,CAAC,YAAY,CAAC,CAUvB;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,MAAM,UAYjD"}
1
+ {"version":3,"file":"app-deploy.d.ts","sourceRoot":"","sources":["../src/app-deploy.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAA;AAK7B,OAAO,EACL,SAAS,EAET,oBAAoB,EACpB,iBAAiB,EACjB,mBAAmB,EACnB,SAAS,EACT,WAAW,EACX,YAAY,EACZ,kBAAkB,EACnB,MAAM,aAAa,CAAA;AAYpB,OAAO,EAAE,mBAAmB,EAAE,0BAA0B,EAAE,2BAA2B,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AACvI,OAAO,OAAO,GAAG,OAAO,CAAC,OAAO,CAAA;AAChC,OAAO,OAAO,GAAG,OAAO,CAAC,OAAO,CAAA;AAChC,OAAO,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAA;AAElC;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,SAAS,CAC7B,UAAU,EAAE,mBAAmB,EAC/B,KAAK,EAAE,OAAO,EACd,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CACR,OAAO,CAAC,oBAAoB,CAAC,GAC3B,CACI,CAAC,2BAA2B,GAAG,WAAW,GAAG;IAAE,MAAM,CAAC,EAAE,SAAS,CAAC;IAAC,kBAAkB,EAAE,QAAQ,GAAG,QAAQ,CAAA;CAAE,CAAC,GAC7G,CAAC,2BAA2B,GAC1B,WAAW,GAAG;IACZ,MAAM,CAAC,EAAE,SAAS,CAAA;IAClB,YAAY,CAAC,EAAE,SAAS,CAAA;IACxB,YAAY,EAAE,0BAA0B,CAAA;IACxC,kBAAkB,EAAE,SAAS,CAAA;CAC9B,CAAC,GACJ,CAAC,WAAW,GAAG;IAAE,kBAAkB,EAAE,SAAS,CAAA;CAAE,CAAC,CACpD,CACJ,CAyIA;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,QAAQ,CAAC,sBAAsB,EAAE,KAAK,EAAE,QAAQ,CAAC,sBAAsB,WAE/G;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,oBAAoB,CAAC,cAAc,EAAE,mBAAmB,GAAG,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC,CAY7H;AAED;;;;;;GAMG;AACH,wBAAgB,+BAA+B,CAAC,QAAQ,EAAE,iBAAiB,GAAG,mBAAmB,CAMhG;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,8BAA8B,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE;IAAE,SAAS,CAAC,EAAE,OAAO,CAAC;IAAC,SAAS,CAAC,EAAE,OAAO,CAAA;CAAE,UAEpH;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,2BAA2B,CAAC,QAAQ,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,kBAAkB,UAEhG;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,qCAAqC,CACzD,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,OAAO,EACd,cAAc,CAAC,EAAE,kBAAkB,EACnC,kBAAkB,CAAC,EAAE,iBAAiB,GACrC,OAAO,CAAC,YAAY,CAAC,CAUvB;AAED;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,MAAM,UAYjD"}