@algorandfoundation/algokit-utils 7.0.0-beta.9 → 8.0.0-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.
- package/LICENSE +21 -0
- package/README.md +21 -3
- package/account/account.d.ts +4 -1
- package/account/account.js +10 -7
- package/account/account.js.map +1 -1
- package/account/account.mjs +11 -8
- package/account/account.mjs.map +1 -1
- package/account/get-account-config-from-environment.js.map +1 -1
- package/account/get-account-config-from-environment.mjs.map +1 -1
- package/account/get-account.js.map +1 -1
- package/account/get-account.mjs.map +1 -1
- package/account/get-dispenser-account.d.ts +1 -1
- package/account/get-dispenser-account.js.map +1 -1
- package/account/get-dispenser-account.mjs.map +1 -1
- package/account/mnemonic-account.js.map +1 -1
- package/account/mnemonic-account.mjs.map +1 -1
- package/amount.d.ts +1 -0
- package/amount.js +3 -2
- package/amount.js.map +1 -1
- package/amount.mjs +3 -3
- package/amount.mjs.map +1 -1
- package/app-client.d.ts +4 -4
- package/app-client.js +4 -4
- package/app-client.js.map +1 -1
- package/app-client.mjs +4 -4
- package/app-client.mjs.map +1 -1
- package/app-deploy.js +25 -15
- package/app-deploy.js.map +1 -1
- package/app-deploy.mjs +27 -17
- package/app-deploy.mjs.map +1 -1
- package/app.d.ts +2 -2
- package/app.js +9 -6
- package/app.js.map +1 -1
- package/app.mjs +9 -6
- package/app.mjs.map +1 -1
- package/asset.js.map +1 -1
- package/asset.mjs.map +1 -1
- package/debugging/debugging.js.map +1 -1
- package/debugging/debugging.mjs.map +1 -1
- package/dispenser-client.js.map +1 -1
- package/dispenser-client.mjs.map +1 -1
- package/index.d.ts +1 -0
- package/index.js +7 -1
- package/index.js.map +1 -1
- package/index.mjs +3 -2
- package/index.mjs.map +1 -1
- package/indexer-lookup.d.ts +10 -8
- package/indexer-lookup.js +14 -10
- package/indexer-lookup.js.map +1 -1
- package/indexer-lookup.mjs +14 -10
- package/indexer-lookup.mjs.map +1 -1
- package/localnet/get-kmd-wallet-account.js.map +1 -1
- package/localnet/get-kmd-wallet-account.mjs.map +1 -1
- package/localnet/get-localnet-dispenser-account.js.map +1 -1
- package/localnet/get-localnet-dispenser-account.mjs.map +1 -1
- package/localnet/get-or-create-kmd-wallet-account.js.map +1 -1
- package/localnet/get-or-create-kmd-wallet-account.mjs.map +1 -1
- package/localnet/is-localnet.js.map +1 -1
- package/localnet/is-localnet.mjs.map +1 -1
- package/network-client.d.ts +1 -7
- package/network-client.js +2 -9
- package/network-client.js.map +1 -1
- package/network-client.mjs +2 -9
- package/network-client.mjs.map +1 -1
- package/package.json +5 -5
- package/testing/_asset.d.ts +2 -1
- package/testing/account.d.ts +4 -3
- package/testing/account.js +8 -2
- package/testing/account.js.map +1 -1
- package/testing/account.mjs +9 -3
- package/testing/account.mjs.map +1 -1
- package/testing/fixtures/algokit-log-capture-fixture.js.map +1 -1
- package/testing/fixtures/algokit-log-capture-fixture.mjs.map +1 -1
- package/testing/fixtures/algorand-fixture.js +5 -6
- package/testing/fixtures/algorand-fixture.js.map +1 -1
- package/testing/fixtures/algorand-fixture.mjs +5 -6
- package/testing/fixtures/algorand-fixture.mjs.map +1 -1
- package/testing/indexer.js.map +1 -1
- package/testing/indexer.mjs.map +1 -1
- package/testing/test-logger.js +7 -1
- package/testing/test-logger.js.map +1 -1
- package/testing/test-logger.mjs +7 -1
- package/testing/test-logger.mjs.map +1 -1
- package/testing/transaction-logger.js.map +1 -1
- package/testing/transaction-logger.mjs.map +1 -1
- package/transaction/legacy-bridge.js +2 -2
- package/transaction/legacy-bridge.js.map +1 -1
- package/transaction/legacy-bridge.mjs +3 -3
- package/transaction/legacy-bridge.mjs.map +1 -1
- package/transaction/perform-atomic-transaction-composer-simulate.d.ts +4 -1
- package/transaction/perform-atomic-transaction-composer-simulate.js +14 -9
- package/transaction/perform-atomic-transaction-composer-simulate.js.map +1 -1
- package/transaction/perform-atomic-transaction-composer-simulate.mjs +15 -10
- package/transaction/perform-atomic-transaction-composer-simulate.mjs.map +1 -1
- package/transaction/transaction.d.ts +13 -22
- package/transaction/transaction.js +164 -110
- package/transaction/transaction.js.map +1 -1
- package/transaction/transaction.mjs +163 -109
- package/transaction/transaction.mjs.map +1 -1
- package/transfer/transfer-algos.js.map +1 -1
- package/transfer/transfer-algos.mjs.map +1 -1
- package/transfer/transfer.js +3 -1
- package/transfer/transfer.js.map +1 -1
- package/transfer/transfer.mjs +3 -1
- package/transfer/transfer.mjs.map +1 -1
- package/types/account-manager.d.ts +20 -20
- package/types/account-manager.js +36 -27
- package/types/account-manager.js.map +1 -1
- package/types/account-manager.mjs +38 -29
- package/types/account-manager.mjs.map +1 -1
- package/types/account.d.ts +17 -8
- package/types/account.js +2 -2
- package/types/account.js.map +1 -1
- package/types/account.mjs +3 -3
- package/types/account.mjs.map +1 -1
- package/types/algo-http-client-with-retry.d.ts +1 -2
- package/types/algo-http-client-with-retry.js +33 -3
- package/types/algo-http-client-with-retry.js.map +1 -1
- package/types/algo-http-client-with-retry.mjs +32 -2
- package/types/algo-http-client-with-retry.mjs.map +1 -1
- package/types/algorand-client-interface.d.ts +2 -2
- package/types/algorand-client-transaction-creator.d.ts +16 -14
- package/types/algorand-client-transaction-creator.js +3 -1
- package/types/algorand-client-transaction-creator.js.map +1 -1
- package/types/algorand-client-transaction-creator.mjs +3 -1
- package/types/algorand-client-transaction-creator.mjs.map +1 -1
- package/types/algorand-client-transaction-sender.d.ts +109 -105
- package/types/algorand-client-transaction-sender.js +6 -2
- package/types/algorand-client-transaction-sender.js.map +1 -1
- package/types/algorand-client-transaction-sender.mjs +6 -2
- package/types/algorand-client-transaction-sender.mjs.map +1 -1
- package/types/algorand-client.d.ts +6 -7
- package/types/algorand-client.js +3 -6
- package/types/algorand-client.js.map +1 -1
- package/types/algorand-client.mjs +5 -5
- package/types/algorand-client.mjs.map +1 -1
- package/types/amount.js.map +1 -1
- package/types/amount.mjs.map +1 -1
- package/types/app-arc56.d.ts +31 -20
- package/types/app-arc56.js.map +1 -1
- package/types/app-arc56.mjs.map +1 -1
- package/types/app-client.d.ts +298 -286
- package/types/app-client.js +148 -41
- package/types/app-client.js.map +1 -1
- package/types/app-client.mjs +147 -40
- package/types/app-client.mjs.map +1 -1
- package/types/app-deployer.d.ts +4 -4
- package/types/app-deployer.js +23 -24
- package/types/app-deployer.js.map +1 -1
- package/types/app-deployer.mjs +25 -26
- package/types/app-deployer.mjs.map +1 -1
- package/types/app-factory.d.ts +130 -130
- package/types/app-factory.js +4 -5
- package/types/app-factory.js.map +1 -1
- package/types/app-factory.mjs +5 -6
- package/types/app-factory.mjs.map +1 -1
- package/types/app-manager.d.ts +5 -5
- package/types/app-manager.js +116 -38
- package/types/app-manager.js.map +1 -1
- package/types/app-manager.mjs +117 -39
- package/types/app-manager.mjs.map +1 -1
- package/types/app-spec.js +8 -2
- package/types/app-spec.js.map +1 -1
- package/types/app-spec.mjs +8 -2
- package/types/app-spec.mjs.map +1 -1
- package/types/app.d.ts +12 -11
- package/types/app.js.map +1 -1
- package/types/app.mjs.map +1 -1
- package/types/asset-manager.d.ts +9 -9
- package/types/asset-manager.js +10 -13
- package/types/asset-manager.js.map +1 -1
- package/types/asset-manager.mjs +10 -13
- package/types/asset-manager.mjs.map +1 -1
- package/types/async-event-emitter.d.ts +1 -10
- package/types/async-event-emitter.js +0 -5
- package/types/async-event-emitter.js.map +1 -1
- package/types/async-event-emitter.mjs +1 -6
- package/types/async-event-emitter.mjs.map +1 -1
- package/types/client-manager.d.ts +2 -9
- package/types/client-manager.js +11 -21
- package/types/client-manager.js.map +1 -1
- package/types/client-manager.mjs +11 -21
- package/types/client-manager.mjs.map +1 -1
- package/types/composer.d.ts +58 -46
- package/types/composer.js +154 -105
- package/types/composer.js.map +1 -1
- package/types/composer.mjs +156 -105
- package/types/composer.mjs.map +1 -1
- package/types/config.js.map +1 -1
- package/types/config.mjs.map +1 -1
- package/types/debugging.d.ts +1 -1
- package/types/debugging.js +1 -1
- package/types/debugging.js.map +1 -1
- package/types/debugging.mjs +1 -1
- package/types/debugging.mjs.map +1 -1
- package/types/dispenser-client.d.ts +2 -1
- package/types/dispenser-client.js +5 -1
- package/types/dispenser-client.js.map +1 -1
- package/types/dispenser-client.mjs +5 -1
- package/types/dispenser-client.mjs.map +1 -1
- package/types/indexer.d.ts +74 -755
- package/types/indexer.js.map +1 -1
- package/types/indexer.mjs.map +1 -1
- package/types/kmd-account-manager.d.ts +2 -2
- package/types/kmd-account-manager.js +1 -1
- package/types/kmd-account-manager.js.map +1 -1
- package/types/kmd-account-manager.mjs +2 -2
- package/types/kmd-account-manager.mjs.map +1 -1
- package/types/lifecycle-events.d.ts +10 -0
- package/types/lifecycle-events.js +8 -0
- package/types/lifecycle-events.js.map +1 -0
- package/types/lifecycle-events.mjs +8 -0
- package/types/lifecycle-events.mjs.map +1 -0
- package/types/logging.js.map +1 -1
- package/types/logging.mjs.map +1 -1
- package/types/logic-error.d.ts +2 -3
- package/types/logic-error.js +3 -3
- package/types/logic-error.js.map +1 -1
- package/types/logic-error.mjs +3 -3
- package/types/logic-error.mjs.map +1 -1
- package/types/network-client.d.ts +1 -1
- package/types/network-client.js.map +1 -1
- package/types/network-client.mjs.map +1 -1
- package/types/testing.d.ts +6 -7
- package/util.js.map +1 -1
- package/util.mjs.map +1 -1
- package/types/urlTokenBaseHTTPClient.d.ts +0 -40
- package/types/urlTokenBaseHTTPClient.js +0 -153
- package/types/urlTokenBaseHTTPClient.js.map +0 -1
- package/types/urlTokenBaseHTTPClient.mjs +0 -151
- package/types/urlTokenBaseHTTPClient.mjs.map +0 -1
package/types/indexer.d.ts
CHANGED
|
@@ -1,284 +1,39 @@
|
|
|
1
1
|
import algosdk from 'algosdk';
|
|
2
|
-
import
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
/** Indexer result for an
|
|
14
|
-
export
|
|
15
|
-
/** Round at which the results were computed. */
|
|
16
|
-
'current-round': number;
|
|
17
|
-
/** The returned account */
|
|
18
|
-
account: AccountResult;
|
|
19
|
-
}
|
|
20
|
-
/** Indexer result for an account's asset holdings, https://developer.algorand.org/docs/rest-apis/indexer/#get-v2accountsaccount-idassets */
|
|
21
|
-
export interface AssetsLookupResult {
|
|
22
|
-
/** Round at which the results were computed. */
|
|
23
|
-
'current-round': number;
|
|
24
|
-
/** Used for pagination, when making another request provide this token with the next parameter. */
|
|
25
|
-
'next-token': string;
|
|
26
|
-
/** The returned asset holdings */
|
|
27
|
-
assets: AssetHolding[];
|
|
28
|
-
}
|
|
29
|
-
/** Indexer result for an account's created assets, https://developer.algorand.org/docs/rest-apis/indexer/#get-v2accountsaccount-idcreated-assets */
|
|
30
|
-
export interface AssetsCreatedLookupResult {
|
|
31
|
-
/** Round at which the results were computed. */
|
|
32
|
-
'current-round': number;
|
|
33
|
-
/** Used for pagination, when making another request provide this token with the next parameter. */
|
|
34
|
-
'next-token': string;
|
|
35
|
-
/** The returned assets */
|
|
36
|
-
assets: AssetResult[];
|
|
37
|
-
}
|
|
38
|
-
/** Indexer result for an account's created applications, https://developer.algorand.org/docs/rest-apis/indexer/#get-v2accountsaccount-idcreated-applications */
|
|
39
|
-
export interface ApplicationCreatedLookupResult {
|
|
40
|
-
/** Round at which the results were computed. */
|
|
41
|
-
'current-round': number;
|
|
42
|
-
/** Used for pagination, when making another request provide this token with the next parameter. */
|
|
43
|
-
'next-token': string;
|
|
44
|
-
/** The returned applications */
|
|
45
|
-
applications: ApplicationResult[];
|
|
46
|
-
}
|
|
47
|
-
/** Indexer result for an asset lookup, https://developer.algorand.org/docs/rest-apis/indexer/#get-v2assetsasset-id */
|
|
48
|
-
export interface AssetLookupResult {
|
|
49
|
-
/** Round at which the results were computed. */
|
|
50
|
-
'current-round': number;
|
|
51
|
-
/** The returned asset */
|
|
52
|
-
asset: AssetResult;
|
|
53
|
-
}
|
|
2
|
+
import indexerModels = algosdk.indexerModels;
|
|
3
|
+
/** @deprecated Use `algosdk.indexerModels.TransactionsResponse`. Indexer result for a transaction search, https://developer.algorand.org/docs/rest-apis/indexer/#get-v2transactions */
|
|
4
|
+
export type TransactionSearchResults = indexerModels.TransactionsResponse;
|
|
5
|
+
/** @deprecated Use `algosdk.indexerModels.AccountResponse`. Indexer result for an account lookup, https://developer.algorand.org/docs/rest-apis/indexer/#get-v2accountsaccount-id */
|
|
6
|
+
export type AccountLookupResult = indexerModels.AccountResponse;
|
|
7
|
+
/** @deprecated Use `algosdk.indexerModels.AssetHoldingsResponse`. Indexer result for an account's asset holdings, https://developer.algorand.org/docs/rest-apis/indexer/#get-v2accountsaccount-idassets */
|
|
8
|
+
export type AssetsLookupResult = indexerModels.AssetHoldingsResponse;
|
|
9
|
+
/** @deprecated Use `algosdk.indexerModels.AssetsResponse`. Indexer result for an account's created assets, https://developer.algorand.org/docs/rest-apis/indexer/#get-v2accountsaccount-idcreated-assets */
|
|
10
|
+
export type AssetsCreatedLookupResult = indexerModels.AssetsResponse;
|
|
11
|
+
/** @deprecated Use `algosdk.indexerModels.ApplicationsResponse`. Indexer result for an account's created applications, https://developer.algorand.org/docs/rest-apis/indexer/#get-v2accountsaccount-idcreated-applications */
|
|
12
|
+
export type ApplicationCreatedLookupResult = indexerModels.ApplicationsResponse;
|
|
13
|
+
/** @deprecated Use `algosdk.indexerModels.AssetResponse`. Indexer result for an asset lookup, https://developer.algorand.org/docs/rest-apis/indexer/#get-v2assetsasset-id */
|
|
14
|
+
export type AssetLookupResult = indexerModels.AssetResponse;
|
|
54
15
|
/** Options when looking up an asset's account holdings, https://developer.algorand.org/docs/rest-apis/indexer/#get-v2assetsasset-idbalances */
|
|
55
16
|
export interface LookupAssetHoldingsOptions {
|
|
56
17
|
/** Results should have a decimal units amount less than this value. */
|
|
57
|
-
currencyLessThan?: number;
|
|
18
|
+
currencyLessThan?: number | bigint;
|
|
58
19
|
/** Results should have a decimal units amount greater than this value. */
|
|
59
|
-
currencyGreaterThan?: number;
|
|
20
|
+
currencyGreaterThan?: number | bigint;
|
|
60
21
|
/** Include all items including closed accounts and opted-out asset holdings. */
|
|
61
22
|
includeAll?: boolean;
|
|
62
23
|
}
|
|
63
|
-
/** Indexer result for an asset's account holdings, https://developer.algorand.org/docs/rest-apis/indexer/#get-v2assetsasset-idbalances */
|
|
64
|
-
export
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
/** The returned transaction */
|
|
77
|
-
transaction: TransactionResult;
|
|
78
|
-
}
|
|
79
|
-
/** Indexer result for an application lookup, https://developer.algorand.org/docs/rest-apis/indexer/#get-v2applicationsapplication-id */
|
|
80
|
-
export interface ApplicationLookupResult {
|
|
81
|
-
/** Round at which the results were computed. */
|
|
82
|
-
'current-round': number;
|
|
83
|
-
/** The returned application */
|
|
84
|
-
application: ApplicationResult;
|
|
85
|
-
}
|
|
86
|
-
/** Indexer result for a transaction, https://developer.algorand.org/docs/rest-apis/indexer/#transaction */
|
|
87
|
-
export interface TransactionResult extends Record<string, any> {
|
|
88
|
-
/** Transaction ID */
|
|
89
|
-
id: string;
|
|
90
|
-
/** [type] Indicates what type of transaction this is. Different types have different fields.
|
|
91
|
-
* Valid types, and where their fields are stored:
|
|
92
|
-
* * [pay] payment-transaction
|
|
93
|
-
* * [keyreg] keyreg-transaction
|
|
94
|
-
* * [acfg] asset-config-transaction
|
|
95
|
-
* * [axfer] asset-transfer-transaction
|
|
96
|
-
* * [afrz] asset-freeze-transaction
|
|
97
|
-
* * [appl] application-transaction
|
|
98
|
-
* * [stpf] state-proof-transaction
|
|
99
|
-
*/
|
|
100
|
-
'tx-type': TransactionType;
|
|
101
|
-
/** [fee] Transaction fee. */
|
|
102
|
-
fee: number;
|
|
103
|
-
/** [snd] Sender's address. */
|
|
104
|
-
sender: string;
|
|
105
|
-
/** [fv] First valid round for this transaction. */
|
|
106
|
-
'first-valid': number;
|
|
107
|
-
/** [lv] Last valid round for this transaction. */
|
|
108
|
-
'last-valid': number;
|
|
109
|
-
/** Round when the transaction was confirmed. */
|
|
110
|
-
'confirmed-round'?: number;
|
|
111
|
-
/** [grp] Base64 encoded byte array of a sha512/256 digest.
|
|
112
|
-
*
|
|
113
|
-
* When present indicates that this transaction is part of a transaction group
|
|
114
|
-
* and the value is the sha512/256 hash of the transactions in that group.
|
|
115
|
-
*
|
|
116
|
-
* *Pattern:* `"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$"`
|
|
117
|
-
*/
|
|
118
|
-
group?: string;
|
|
119
|
-
/**
|
|
120
|
-
* [note] Free form data.
|
|
121
|
-
*
|
|
122
|
-
* *Pattern:* `"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$"`
|
|
123
|
-
*/
|
|
124
|
-
note?: string;
|
|
125
|
-
/** [lg] Logs for the application being executed by this transaction. */
|
|
126
|
-
logs?: string[];
|
|
127
|
-
/** Time when the block this transaction is in was confirmed. */
|
|
128
|
-
'round-time'?: number;
|
|
129
|
-
/** Offset into the round where this transaction was confirmed. */
|
|
130
|
-
'intra-round-offset'?: number;
|
|
131
|
-
/** Signature of the transaction */
|
|
132
|
-
signature?: TransactionSignature;
|
|
133
|
-
/** If the transaction is an `appl` transaction this will be populated see `tx-type` */
|
|
134
|
-
'application-transaction'?: ApplicationTransactionResult;
|
|
135
|
-
/** If the transaction is an `appl` transaction that resulted in an application creation then this
|
|
136
|
-
* specifies the application index (ID) of that application.
|
|
137
|
-
*/
|
|
138
|
-
'created-application-index'?: number;
|
|
139
|
-
/** If the transaction is an `acfg` transaction this will be populated see `tx-type` */
|
|
140
|
-
'asset-config-transaction'?: AssetConfigTransactionResult;
|
|
141
|
-
/** If the transaction is an `acfg` transaction that resulted in an asset creation then this
|
|
142
|
-
* specifies the asset index (ID) of that asset.
|
|
143
|
-
*/
|
|
144
|
-
'created-asset-index'?: number;
|
|
145
|
-
/** If the transaction is an `afrz` transaction this will be populated see `tx-type` */
|
|
146
|
-
'asset-freeze-transaction'?: AssetFreezeTransactionResult;
|
|
147
|
-
/** If the transaction is an `axfer` transaction this will be populated see `tx-type` */
|
|
148
|
-
'asset-transfer-transaction'?: AssetTransferTransactionResult;
|
|
149
|
-
/** If the transaction is a `keyreg` transaction this will be populated see `tx-type` */
|
|
150
|
-
'keyreg-transaction'?: KeyRegistrationTransactionResult;
|
|
151
|
-
/** If the transaction is a `pay` transaction this will be populated see `tx-type` */
|
|
152
|
-
'payment-transaction'?: PaymentTransactionResult;
|
|
153
|
-
/** If the transaction is a `stpf` transaction this will be populated see `tx-type` */
|
|
154
|
-
'state-proof-transaction'?: StateProofTransactionResult;
|
|
155
|
-
/** [sgnr] this is included with signed transactions when the signing address does not equal the sender.
|
|
156
|
-
* The backend can use this to ensure that auth addr is equal to the accounts auth addr.
|
|
157
|
-
*/
|
|
158
|
-
'auth-addr'?: string;
|
|
159
|
-
/** [ca] closing amount for transaction. */
|
|
160
|
-
'closing-amount'?: number;
|
|
161
|
-
/** [gh] Hash of genesis block.
|
|
162
|
-
*
|
|
163
|
-
* *Pattern:* `"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$"`
|
|
164
|
-
*/
|
|
165
|
-
'genesis-hash'?: string;
|
|
166
|
-
/** [gen] genesis block ID. */
|
|
167
|
-
'genesis-id'?: string;
|
|
168
|
-
/** Inner transactions produced by application execution. */
|
|
169
|
-
'inner-txns'?: TransactionResult[];
|
|
170
|
-
/** [rekey] when included in a valid transaction, the accounts auth addr will be updated with
|
|
171
|
-
* this value and future signatures must be signed with the key represented by this address.
|
|
172
|
-
*/
|
|
173
|
-
'rekey-to'?: string;
|
|
174
|
-
/** [lx] Base64 encoded 32-byte array. Lease enforces mutual exclusion of transactions.
|
|
175
|
-
*
|
|
176
|
-
* If this field is nonzero, then once the transaction is confirmed, it acquires the lease
|
|
177
|
-
* identified by the (Sender, Lease) pair of the transaction until the LastValid round passes.
|
|
178
|
-
*
|
|
179
|
-
* While this transaction possesses the lease, no other transaction specifying this lease can be confirmed.
|
|
180
|
-
*
|
|
181
|
-
* *Pattern:* `"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$"`
|
|
182
|
-
*/
|
|
183
|
-
lease?: string;
|
|
184
|
-
/** [ld] Local state key/value changes for the application being executed by this transaction. */
|
|
185
|
-
'local-state-delta'?: AccountStateDelta[];
|
|
186
|
-
/** [gd] Global state key/value changes for the application being executed by this transaction. */
|
|
187
|
-
'global-state-delta'?: StateDelta;
|
|
188
|
-
/** [rr] rewards applied to receiver account. */
|
|
189
|
-
'receiver-rewards'?: number;
|
|
190
|
-
/** [rs] rewards applied to sender account. */
|
|
191
|
-
'sender-rewards'?: number;
|
|
192
|
-
/** [rc] rewards applied to close-remainder-to account. */
|
|
193
|
-
'close-rewards'?: number;
|
|
194
|
-
}
|
|
195
|
-
/** Account information at a given round https://developer.algorand.org/docs/rest-apis/indexer/#account */
|
|
196
|
-
export interface AccountResult extends Record<string, any> {
|
|
197
|
-
/** the account public key */
|
|
198
|
-
address: string;
|
|
199
|
-
/** [algo] total number of µAlgo in the account */
|
|
200
|
-
amount: number;
|
|
201
|
-
/** specifies the amount of µAlgo in the account, without the pending rewards. */
|
|
202
|
-
'amount-without-pending-rewards': number;
|
|
203
|
-
/** [appl] applications local data stored in this account.
|
|
204
|
-
*
|
|
205
|
-
* Note the raw object uses map[int] -> AppLocalState for this type.
|
|
206
|
-
*/
|
|
207
|
-
'apps-local-state'?: AppLocalState[];
|
|
208
|
-
/** [teap] the sum of all extra application program pages for this account. */
|
|
209
|
-
'apps-total-extra-pages'?: number;
|
|
210
|
-
/** [tsch] stores the sum of all of the local schemas and global schemas in this account.
|
|
211
|
-
*
|
|
212
|
-
* Note: the raw account uses StateSchema for this type.
|
|
213
|
-
*/
|
|
214
|
-
'apps-total-schema'?: StateSchema;
|
|
215
|
-
/** [asset] assets held by this account.
|
|
216
|
-
*
|
|
217
|
-
* Note the raw object uses map[int] -> AssetHolding for this type.
|
|
218
|
-
*/
|
|
219
|
-
assets?: AssetHolding[];
|
|
220
|
-
/** [spend] the address against which signing should be checked.
|
|
221
|
-
*
|
|
222
|
-
* If empty, the address of the current account is used.
|
|
223
|
-
*
|
|
224
|
-
* This field can be updated in any transaction by setting the RekeyTo field.
|
|
225
|
-
*/
|
|
226
|
-
'auth-addr'?: string;
|
|
227
|
-
/** Round during which this account was most recently closed. */
|
|
228
|
-
'closed-at-round'?: number;
|
|
229
|
-
/** [appp] parameters of applications created by this account including app global data.
|
|
230
|
-
*
|
|
231
|
-
* Note: the raw account uses map[int] -> AppParams for this type.
|
|
232
|
-
*/
|
|
233
|
-
'created-apps'?: ApplicationResult[];
|
|
234
|
-
/** [apar] parameters of assets created by this account.
|
|
235
|
-
*
|
|
236
|
-
* Note: the raw account uses map[int] -> Asset for this type.
|
|
237
|
-
*/
|
|
238
|
-
'created-assets'?: AssetResult[];
|
|
239
|
-
/** Round during which this account first appeared in a transaction. */
|
|
240
|
-
'created-at-round'?: number;
|
|
241
|
-
/** Whether or not this account is currently closed. */
|
|
242
|
-
deleted?: boolean;
|
|
243
|
-
/** If participating in consensus, the parameters used by this account in the consensus protocol. */
|
|
244
|
-
participation?: AccountParticipation;
|
|
245
|
-
/** amount of µAlgo of pending rewards in this account. */
|
|
246
|
-
'pending-rewards': number;
|
|
247
|
-
/** [ebase] used as part of the rewards computation. Only applicable to accounts which are participating. */
|
|
248
|
-
'reward-base'?: number;
|
|
249
|
-
/** [ern] total rewards of µAlgo the account has received, including pending rewards. */
|
|
250
|
-
rewards: number;
|
|
251
|
-
/** The round for which this information is relevant. */
|
|
252
|
-
round: number;
|
|
253
|
-
/** Indicates what type of signature is used by this account */
|
|
254
|
-
'sig-type': SignatureType;
|
|
255
|
-
/** [onl] delegation status of the account's µAlgo */
|
|
256
|
-
status: AccountStatus;
|
|
257
|
-
/** The count of all applications that have been opted in, equivalent to the count of application local data (AppLocalState objects) stored in this account. */
|
|
258
|
-
'total-apps-opted-in': number;
|
|
259
|
-
/** The count of all assets that have been opted in, equivalent to the count of AssetHolding objects held by this account. */
|
|
260
|
-
'total-assets-opted-in': number;
|
|
261
|
-
/** For app-accounts only. The total number of bytes allocated for the keys and values of boxes which belong to the associated application. */
|
|
262
|
-
'total-box-bytes': number;
|
|
263
|
-
/** For app-accounts only. The total number of boxes which belong to the associated application. */
|
|
264
|
-
'total-boxes': number;
|
|
265
|
-
/** The count of all apps (AppParams objects) created by this account. */
|
|
266
|
-
'total-created-apps': number;
|
|
267
|
-
/** The count of all assets (AssetParams objects) created by this account. */
|
|
268
|
-
'total-created-assets': number;
|
|
269
|
-
}
|
|
270
|
-
/** Fields for a payment transaction https://developer.algorand.org/docs/rest-apis/indexer/#transactionpayment */
|
|
271
|
-
export interface PaymentTransactionResult {
|
|
272
|
-
/** [amt] number of µAlgo intended to be transferred. */
|
|
273
|
-
amount: number;
|
|
274
|
-
/** Number of µAlgo that were sent to the close-remainder-to address when closing the sender account. */
|
|
275
|
-
'close-amount'?: number;
|
|
276
|
-
/** [close] when set, indicates that the sending account should be closed and all remaining funds be transferred to this address. */
|
|
277
|
-
'close-remainder-to'?: string;
|
|
278
|
-
/** [rcv] receiver's address. */
|
|
279
|
-
receiver: string;
|
|
280
|
-
}
|
|
281
|
-
/** Fields for a state proof transaction https://developer.algorand.org/docs/rest-apis/indexer/#transactionstateproof.
|
|
24
|
+
/** @deprecated Use `algosdk.indexerModels.AssetBalancesResponse`. Indexer result for an asset's account holdings, https://developer.algorand.org/docs/rest-apis/indexer/#get-v2assetsasset-idbalances */
|
|
25
|
+
export type AssetBalancesLookupResult = indexerModels.AssetBalancesResponse;
|
|
26
|
+
/** @deprecated Use `algosdk.indexerModels.TransactionResponse`. Indexer result for a transaction lookup, https://developer.algorand.org/docs/rest-apis/indexer/#get-v2transactionstxid */
|
|
27
|
+
export type TransactionLookupResult = indexerModels.TransactionResponse;
|
|
28
|
+
/** @deprecated Use `algosdk.indexerModels.ApplicationResponse`. Indexer result for an application lookup, https://developer.algorand.org/docs/rest-apis/indexer/#get-v2applicationsapplication-id */
|
|
29
|
+
export type ApplicationLookupResult = indexerModels.ApplicationResponse;
|
|
30
|
+
/** @deprecated Use `algosdk.indexerModels.Transaction`. Indexer result for a transaction, https://developer.algorand.org/docs/rest-apis/indexer/#transaction */
|
|
31
|
+
export type TransactionResult = indexerModels.Transaction;
|
|
32
|
+
/** @deprecated Use `algosdk.indexerModels.Account`. Indexer Account information at a given round https://developer.algorand.org/docs/rest-apis/indexer/#account */
|
|
33
|
+
export type AccountResult = indexerModels.Account;
|
|
34
|
+
/** @deprecated Use `algosdk.indexerModels.TransactionPayment`. Indexer Fields for a payment transaction https://developer.algorand.org/docs/rest-apis/indexer/#transactionpayment */
|
|
35
|
+
export type PaymentTransactionResult = indexerModels.TransactionPayment;
|
|
36
|
+
/** @deprecated Use `algosdk.indexerModels.TransactionStateProof`. Indexer Fields for a state proof transaction https://developer.algorand.org/docs/rest-apis/indexer/#transactionstateproof.
|
|
282
37
|
*
|
|
283
38
|
* See also https://developer.algorand.org/docs/get-details/stateproofs/,
|
|
284
39
|
* https://developer.algorand.org/docs/get-details/stateproofs/light_client/,
|
|
@@ -287,113 +42,8 @@ export interface PaymentTransactionResult {
|
|
|
287
42
|
* https://github.com/algorand/go-algorand/blob/master/data/stateproofmsg/message.go, and
|
|
288
43
|
* https://developer.algorand.org/docs/rest-apis/algod/#stateproof.
|
|
289
44
|
*/
|
|
290
|
-
export
|
|
291
|
-
|
|
292
|
-
*
|
|
293
|
-
* Message represents the message that the state proofs are attesting to. This message can be
|
|
294
|
-
* used by lightweight client and gives it the ability to verify proofs on the Algorand's state.
|
|
295
|
-
*
|
|
296
|
-
* In addition to that proof, this message also contains fields that
|
|
297
|
-
* are needed in order to verify the next state proofs (VotersCommitment and LnProvenWeight).
|
|
298
|
-
*/
|
|
299
|
-
message: {
|
|
300
|
-
/** [b] BlockHeadersCommitment contains a commitment on all light block headers within a state proof interval. */
|
|
301
|
-
'block-headers-commitment': string;
|
|
302
|
-
/** [f] First round the message attests to */
|
|
303
|
-
'first-attested-round': number;
|
|
304
|
-
/** [l] Last round the message attests to */
|
|
305
|
-
'latest-attested-round': number;
|
|
306
|
-
/** [P] An integer value representing the natural log of the proven weight with 16 bits of precision. This value would be used to verify the next state proof. */
|
|
307
|
-
'ln-proven-weight': number | bigint;
|
|
308
|
-
/** [v] The vector commitment root of the top N accounts to sign the next StateProof.
|
|
309
|
-
*
|
|
310
|
-
* Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" */
|
|
311
|
-
'voters-commitment': string;
|
|
312
|
-
};
|
|
313
|
-
/** [sp] a proof on Algorand's state */
|
|
314
|
-
'state-proof': {
|
|
315
|
-
/** [P] Part proofs that make up the overall proof */
|
|
316
|
-
'part-proofs': MerkleArrayProof;
|
|
317
|
-
/** [pr] The positions that are revealed */
|
|
318
|
-
'positions-to-reveal': number[];
|
|
319
|
-
/** [r] Reveals is a sparse map from the position being revealed
|
|
320
|
-
* to the corresponding elements from the sigs and participants
|
|
321
|
-
* arrays.
|
|
322
|
-
*/
|
|
323
|
-
reveals: {
|
|
324
|
-
/** The position being revealed */
|
|
325
|
-
position: number;
|
|
326
|
-
/** [p] Participant
|
|
327
|
-
*
|
|
328
|
-
* A Participant corresponds to an account whose AccountData.Status
|
|
329
|
-
* is Online, and for which the expected sigRound satisfies
|
|
330
|
-
* AccountData.VoteFirstValid <= sigRound <= AccountData.VoteLastValid.
|
|
331
|
-
*
|
|
332
|
-
* In the Algorand ledger, it is possible for multiple accounts to have
|
|
333
|
-
* the same PK. Thus, the PK is not necessarily unique among Participants.
|
|
334
|
-
* However, each account will produce a unique Participant struct, to avoid
|
|
335
|
-
* potential DoS attacks where one account claims to have the same VoteID PK
|
|
336
|
-
* as another account.
|
|
337
|
-
*/
|
|
338
|
-
participant: {
|
|
339
|
-
/** [p] PK is the identifier used to verify the signature for a specific participant
|
|
340
|
-
*
|
|
341
|
-
* Verifier is used to verify a merklesignature.Signature produced by merklesignature.Secrets.
|
|
342
|
-
*/
|
|
343
|
-
verifier: {
|
|
344
|
-
/** [cmt] Commitment represents the root of the vector commitment tree built upon the MSS keys. */
|
|
345
|
-
commitment: string;
|
|
346
|
-
/** [lf] The lifetime of the key */
|
|
347
|
-
'key-lifetime': number;
|
|
348
|
-
};
|
|
349
|
-
/** [w] Weight is AccountData.MicroAlgos. */
|
|
350
|
-
weight: number | bigint;
|
|
351
|
-
};
|
|
352
|
-
/** [s] A sigslotCommit is a single slot in the sigs array that forms the state proof. */
|
|
353
|
-
'sig-slot': {
|
|
354
|
-
/** [l] L is the total weight of signatures in lower-numbered slots.
|
|
355
|
-
* This is initialized once the builder has collected a sufficient
|
|
356
|
-
* number of signatures.
|
|
357
|
-
*/
|
|
358
|
-
'lower-sig-weight': number | bigint;
|
|
359
|
-
/** [s] Sig is a signature by the participant on the expected message.
|
|
360
|
-
*
|
|
361
|
-
* Signature represents a signature in the Merkle signature scheme using falcon signatures as an underlying crypto scheme.
|
|
362
|
-
* It consists of an ephemeral public key, a signature, a Merkle verification path and an index.
|
|
363
|
-
* The Merkle signature considered valid only if the Signature is verified under the ephemeral public key and
|
|
364
|
-
* the Merkle verification path verifies that the ephemeral public key is located at the given index of the tree
|
|
365
|
-
* (for the root given in the long-term public key).
|
|
366
|
-
* More details can be found on Algorand's spec
|
|
367
|
-
*/
|
|
368
|
-
signature: {
|
|
369
|
-
/** [sig] Signature in the Merkle signature scheme using falcon signatures */
|
|
370
|
-
'falcon-signature': string;
|
|
371
|
-
/** [idx] Merkle array index */
|
|
372
|
-
'merkle-array-index': number;
|
|
373
|
-
/** [prf] Merkle verification path */
|
|
374
|
-
proof: MerkleArrayProof;
|
|
375
|
-
/** [vkey] Falcon verifier key */
|
|
376
|
-
'verifying-key': string;
|
|
377
|
-
};
|
|
378
|
-
};
|
|
379
|
-
}[];
|
|
380
|
-
/** [v] Merkle signature salt version */
|
|
381
|
-
'salt-version': number;
|
|
382
|
-
/** [c] Digest of the signature commit */
|
|
383
|
-
'sig-commit': string;
|
|
384
|
-
/** [S] Proofs for the signature */
|
|
385
|
-
'sig-proofs': MerkleArrayProof;
|
|
386
|
-
/** [w] The combined weight of the signatures */
|
|
387
|
-
'signed-weight': number | bigint;
|
|
388
|
-
};
|
|
389
|
-
/** [sptype] State proof type, per https://github.com/algorand/go-algorand/blob/master/protocol/stateproof.go#L24
|
|
390
|
-
*
|
|
391
|
-
* * 0: StateProofBasic is our initial state proof setup. using falcon keys and subset-sum hash
|
|
392
|
-
*/
|
|
393
|
-
'state-proof-type': number;
|
|
394
|
-
}
|
|
395
|
-
/**
|
|
396
|
-
* Merkle array Proof.
|
|
45
|
+
export type StateProofTransactionResult = indexerModels.TransactionStateProof;
|
|
46
|
+
/** @deprecated Use `algosdk.indexerModels.MerkleArrayProof`. Indexer Merkle array Proof.
|
|
397
47
|
*
|
|
398
48
|
* Proof is used to convince a verifier about membership of leaves: h0,h1...hn
|
|
399
49
|
* at indexes i0,i1...in on a tree. The verifier has a trusted value of the tree
|
|
@@ -429,243 +79,57 @@ export interface StateProofTransactionResult {
|
|
|
429
79
|
* . len(hints) = 2^4/2
|
|
430
80
|
* ```
|
|
431
81
|
*/
|
|
432
|
-
export
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
'hash-type': number;
|
|
437
|
-
};
|
|
438
|
-
/** [pth] Path is bounded by MaxNumLeavesOnEncodedTree since there could be multiple reveals, and
|
|
439
|
-
* given the distribution of the elt positions and the depth of the tree,
|
|
440
|
-
* the path length can increase up to 2^MaxEncodedTreeDepth / 2
|
|
441
|
-
*/
|
|
442
|
-
path: string[];
|
|
443
|
-
/** [td] TreeDepth represents the depth of the tree that is being proven.
|
|
444
|
-
* It is the number of edges from the root to a leaf.
|
|
445
|
-
*/
|
|
446
|
-
'tree-depth': number;
|
|
447
|
-
}
|
|
448
|
-
/** Fields for an application transaction https://developer.algorand.org/docs/rest-apis/indexer/#transactionapplication */
|
|
449
|
-
export interface ApplicationTransactionResult extends Omit<ApplicationParams, 'creator' | 'global-state'> {
|
|
450
|
-
/** [apat] List of accounts in addition to the sender that may be accessed from the application's approval-program and clear-state-program. */
|
|
451
|
-
accounts?: string[];
|
|
452
|
-
/** [apaa] transaction specific arguments accessed from the application's approval-program and clear-state-program. */
|
|
453
|
-
'application-args'?: string[];
|
|
454
|
-
/** [apid] ID of the application being configured or empty if creating. */
|
|
455
|
-
'application-id': number;
|
|
456
|
-
/** [apfa] Lists the applications in addition to the application-id whose global states may be accessed by this application's approval-program and clear-state-program. The access is read-only. */
|
|
457
|
-
'foreign-apps'?: number[];
|
|
458
|
-
/** [apas] lists the assets whose parameters may be accessed by this application's ApprovalProgram and ClearStateProgram. The access is read-only. */
|
|
459
|
-
'foreign-assets'?: number[];
|
|
460
|
-
/** [apan] defines the what additional actions occur with the transaction. */
|
|
461
|
-
'on-completion': ApplicationOnComplete;
|
|
462
|
-
}
|
|
463
|
-
/** Fields for asset allocation, re-configuration, and destruction.
|
|
82
|
+
export type MerkleArrayProof = indexerModels.MerkleArrayProof;
|
|
83
|
+
/** @deprecated Use `algosdk.indexerModels.TransactionApplication`. Indexer Fields for an application transaction https://developer.algorand.org/docs/rest-apis/indexer/#transactionapplication */
|
|
84
|
+
export type ApplicationTransactionResult = indexerModels.TransactionApplication;
|
|
85
|
+
/** @deprecated Use `algosdk.indexerModels.TransactionAssetConfig`. Indexer Fields for asset allocation, re-configuration, and destruction.
|
|
464
86
|
* https://developer.algorand.org/docs/rest-apis/indexer/#transactionassetconfig
|
|
465
87
|
*
|
|
466
88
|
* A zero value for asset-id indicates asset creation. A zero value for the params indicates asset destruction.
|
|
467
89
|
*/
|
|
468
|
-
export
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
/** [faid] ID of the asset being frozen or thawed. */
|
|
479
|
-
'asset-id': number;
|
|
480
|
-
/** [afrz] The new freeze status. */
|
|
481
|
-
'new-freeze-status': boolean;
|
|
482
|
-
}
|
|
483
|
-
/** Fields for an asset transfer transaction. https://developer.algorand.org/docs/rest-apis/indexer/#transactionassettransfer */
|
|
484
|
-
export interface AssetTransferTransactionResult {
|
|
485
|
-
/** [aamt] Amount of asset to transfer. A zero amount transferred to self allocates that asset in the account's Assets map. */
|
|
486
|
-
amount: number | bigint;
|
|
487
|
-
/** [xaid] ID of the asset being transferred. */
|
|
488
|
-
'asset-id': number;
|
|
489
|
-
/** Number of assets transfered to the close-to account as part of the transaction. */
|
|
490
|
-
'close-amount'?: number | bigint;
|
|
491
|
-
/** [aclose] Indicates that the asset should be removed from the account's Assets map, and specifies where the remaining asset holdings should be transferred. It's always valid to transfer remaining asset holdings to the creator account. */
|
|
492
|
-
'close-to'?: string;
|
|
493
|
-
/** [arcv] Recipient address of the transfer. */
|
|
494
|
-
receiver: string;
|
|
495
|
-
/** [asnd] The effective sender during a clawback transactions. If this is not a zero value, the real transaction sender must be the Clawback address from the AssetParams. */
|
|
496
|
-
sender?: string;
|
|
497
|
-
}
|
|
498
|
-
/** Fields for a `keyreg` transaction https://developer.algorand.org/docs/rest-apis/indexer/#transactionkeyreg */
|
|
499
|
-
export interface KeyRegistrationTransactionResult {
|
|
500
|
-
/** [nonpart] Mark the account as participating or non-participating. */
|
|
501
|
-
'non-participation'?: boolean;
|
|
502
|
-
/** [selkey] Public key used with the Verified Random Function (VRF) result during committee selection.
|
|
503
|
-
*
|
|
504
|
-
* *Pattern:* `"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$"`
|
|
505
|
-
*/
|
|
506
|
-
'selection-participation-key'?: string;
|
|
507
|
-
/** [selkey] Public key used with the Verified Random Function (VRF) result during committee selection.
|
|
508
|
-
*
|
|
509
|
-
* *Pattern:* `"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$"`
|
|
510
|
-
*/
|
|
511
|
-
'state-proof-key'?: string;
|
|
512
|
-
/** [votefst] First round this participation key is valid. */
|
|
513
|
-
'vote-first-valid'?: number;
|
|
514
|
-
/** [votekd] Number of subkeys in each batch of participation keys. */
|
|
515
|
-
'vote-key-dilution'?: number;
|
|
516
|
-
/** [votelst] Last round this participation key is valid. */
|
|
517
|
-
'vote-last-valid'?: number;
|
|
518
|
-
/** [votekey] Participation public key used in key registration transactions.
|
|
519
|
-
*
|
|
520
|
-
* *Pattern:* `"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$"`
|
|
521
|
-
*/
|
|
522
|
-
'vote-participation-key'?: string;
|
|
523
|
-
}
|
|
524
|
-
/** Specifies both the unique identifier and the parameters for an asset. https://developer.algorand.org/docs/rest-apis/indexer/#asset */
|
|
525
|
-
export interface AssetResult {
|
|
526
|
-
/** Unique asset identifier. */
|
|
527
|
-
index: number;
|
|
528
|
-
/** Whether or not this asset is currently deleted. */
|
|
529
|
-
deleted?: boolean;
|
|
530
|
-
/** Round during which this asset was created. */
|
|
531
|
-
'created-at-round'?: number;
|
|
532
|
-
/** Round during which this asset was destroyed. */
|
|
533
|
-
'destroyed-at-round'?: number;
|
|
534
|
-
/** The parameters for the asset */
|
|
535
|
-
params: AssetParams;
|
|
536
|
-
}
|
|
537
|
-
/**
|
|
538
|
-
* The result of looking up an application
|
|
90
|
+
export type AssetConfigTransactionResult = indexerModels.TransactionAssetConfig;
|
|
91
|
+
/** @deprecated Use `algosdk.indexerModels.TransactionAssetFreeze`. Indexer Fields for an asset freeze transaction. https://developer.algorand.org/docs/rest-apis/indexer/#transactionassetfreeze */
|
|
92
|
+
export type AssetFreezeTransactionResult = indexerModels.TransactionAssetFreeze;
|
|
93
|
+
/** @deprecated Use `algosdk.indexerModels.TransactionAssetTransfer`. Indexer Fields for an asset transfer transaction. https://developer.algorand.org/docs/rest-apis/indexer/#transactionassettransfer */
|
|
94
|
+
export type AssetTransferTransactionResult = indexerModels.TransactionAssetTransfer;
|
|
95
|
+
/** @deprecated Use `algosdk.indexerModels.TransactionKeyreg`. Indexer Fields for a `keyreg` transaction https://developer.algorand.org/docs/rest-apis/indexer/#transactionkeyreg */
|
|
96
|
+
export type KeyRegistrationTransactionResult = indexerModels.TransactionKeyreg;
|
|
97
|
+
/** @deprecated Use `algosdk.indexerModels.Asset`. Indexer Fields to specify both the unique identifier and the parameters for an asset. https://developer.algorand.org/docs/rest-apis/indexer/#asset */
|
|
98
|
+
export type AssetResult = indexerModels.Asset;
|
|
99
|
+
/** @deprecated Use `algosdk.indexerModels.Application`. Indexer result of looking up an application
|
|
539
100
|
*/
|
|
540
|
-
export
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
deleted?: boolean;
|
|
545
|
-
'deleted-at-round'?: number;
|
|
546
|
-
}
|
|
547
|
-
/** Validation signature associated with some data. Only one of the signatures should be provided. https://developer.algorand.org/docs/rest-apis/indexer/#transactionsignature */
|
|
548
|
-
export interface TransactionSignature {
|
|
549
|
-
/** Logicsig signature */
|
|
550
|
-
logicsig?: LogicTransactionSignature;
|
|
551
|
-
/** Multisig signature */
|
|
552
|
-
multisig?: MultisigTransactionSignature;
|
|
553
|
-
/** [sig] Standard ed25519 signature.
|
|
554
|
-
*
|
|
555
|
-
* *Pattern:* `"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$"`
|
|
556
|
-
*/
|
|
557
|
-
sig?: string;
|
|
558
|
-
}
|
|
559
|
-
/** [lsig] Programatic transaction signature.
|
|
101
|
+
export type ApplicationResult = indexerModels.Application;
|
|
102
|
+
/** @deprecated Use `algosdk.indexerModels.TransactionSignature`. Indexer Validation signature associated with some data. Only one of the signatures should be provided. https://developer.algorand.org/docs/rest-apis/indexer/#transactionsignature */
|
|
103
|
+
export type TransactionSignature = indexerModels.TransactionSignature;
|
|
104
|
+
/** @deprecated Use `algosdk.indexerModels.TransactionSignatureLogicsig`. Indexer [lsig] Programatic transaction signature.
|
|
560
105
|
*
|
|
561
106
|
* https://developer.algorand.org/docs/rest-apis/indexer/#transactionsignaturelogicsig
|
|
562
107
|
*
|
|
563
108
|
* https://developer.algorand.org/docs/get-details/transactions/signatures/#logic-signatures
|
|
564
109
|
*/
|
|
565
|
-
export
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
/** The signature of the multisig the logic signature delegating the logicsig. https://developer.algorand.org/docs/get-details/dapps/smart-contracts/smartsigs/modes/#delegated-approval */
|
|
576
|
-
'multisig-signature'?: MultisigTransactionSignature;
|
|
577
|
-
/** [sig] Standard ed25519 signature delegating the logicsig. https://developer.algorand.org/docs/get-details/dapps/smart-contracts/smartsigs/modes/#delegated-approval
|
|
578
|
-
*
|
|
579
|
-
* *Pattern:* `"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$"`
|
|
580
|
-
*/
|
|
581
|
-
signature?: string;
|
|
582
|
-
}
|
|
583
|
-
/** [msig] structure holding multiple subsignatures. https://developer.algorand.org/docs/rest-apis/indexer/#transactionsignaturemultisig */
|
|
584
|
-
export interface MultisigTransactionSignature {
|
|
585
|
-
/** [subsig] Holds pairs of public key and signatures. */
|
|
586
|
-
subsignature: MultisigTransactionSubSignature[];
|
|
587
|
-
/** [thr] The threshold of signatures required for the multisig */
|
|
588
|
-
threshold: number;
|
|
589
|
-
/** [v] The version of the multisig */
|
|
590
|
-
version: number;
|
|
591
|
-
}
|
|
592
|
-
/** Sub-signature for a multisig signature https://developer.algorand.org/docs/rest-apis/indexer/#transactionsignaturemultisigsubsignature */
|
|
593
|
-
export interface MultisigTransactionSubSignature {
|
|
594
|
-
/** [pk] The public key of the account making the signature
|
|
595
|
-
*
|
|
596
|
-
* *Pattern:* `"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$"`
|
|
597
|
-
*/
|
|
598
|
-
'public-key': string;
|
|
599
|
-
/** [s] The signature
|
|
600
|
-
*
|
|
601
|
-
* *Pattern:* `"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$"`
|
|
602
|
-
*/
|
|
603
|
-
signature?: string;
|
|
604
|
-
}
|
|
605
|
-
export interface EvalDeltaKeyValue {
|
|
606
|
-
key: string;
|
|
607
|
-
value: EvalDelta;
|
|
608
|
-
}
|
|
609
|
-
export interface AccountStateDelta {
|
|
610
|
-
address: string;
|
|
611
|
-
delta: StateDelta;
|
|
612
|
-
}
|
|
110
|
+
export type LogicTransactionSignature = indexerModels.TransactionSignatureLogicsig;
|
|
111
|
+
/** @deprecated Use `algosdk.indexerModels.TransactionSignatureMultisig`. Indexer [msig] structure holding multiple subsignatures. https://developer.algorand.org/docs/rest-apis/indexer/#transactionsignaturemultisig */
|
|
112
|
+
export type MultisigTransactionSignature = indexerModels.TransactionSignatureMultisig;
|
|
113
|
+
/** @deprecated Use `algosdk.indexerModels.TransactionSignatureMultisigSubsignature`. Indexer Sub-signature for a multisig signature https://developer.algorand.org/docs/rest-apis/indexer/#transactionsignaturemultisigsubsignature */
|
|
114
|
+
export type MultisigTransactionSubSignature = indexerModels.TransactionSignatureMultisigSubsignature;
|
|
115
|
+
/** @deprecated Use `algosdk.indexerModels.EvalDeltaKeyValue`. */
|
|
116
|
+
export type EvalDeltaKeyValue = indexerModels.EvalDeltaKeyValue;
|
|
117
|
+
/** @deprecated Use `algosdk.indexerModels.AccountStateDelta`. */
|
|
118
|
+
export type AccountStateDelta = indexerModels.AccountStateDelta;
|
|
119
|
+
/** @deprecated Use `algosdk.indexerModels.EvalDeltaKeyValue[]`. */
|
|
613
120
|
export type StateDelta = EvalDeltaKeyValue[];
|
|
614
|
-
/** Represents a TEAL value delta. https://developer.algorand.org/docs/rest-apis/indexer/#evaldelta */
|
|
615
|
-
export
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
bytes?: string;
|
|
620
|
-
/** [ui] uint value. */
|
|
621
|
-
uint?: number;
|
|
622
|
-
}
|
|
623
|
-
/** Stores the global information associated with an application https://developer.algorand.org/docs/rest-apis/indexer/#applicationparams */
|
|
624
|
-
export interface ApplicationParams {
|
|
625
|
-
/** The address that created this application. This is the address where the parameters and global state for this application can be found. */
|
|
626
|
-
creator: string;
|
|
627
|
-
/**
|
|
628
|
-
* [apap]/[approv] Logic executed for every application transaction, except when on-completion is set to "clear".
|
|
629
|
-
*
|
|
630
|
-
* It can read and write global state for the application, as well as account-specific local state.
|
|
631
|
-
*
|
|
632
|
-
* Approval programs may reject the transaction.
|
|
633
|
-
*
|
|
634
|
-
* *Pattern:* `"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$"`
|
|
635
|
-
*/
|
|
636
|
-
'approval-program': string;
|
|
637
|
-
/**
|
|
638
|
-
* [apsu]/[clearp] Logic executed for application transactions with on-completion set to "clear".
|
|
639
|
-
*
|
|
640
|
-
* It can read and write global state for the application, as well as account-specific local state.
|
|
641
|
-
*
|
|
642
|
-
* Clear state programs cannot reject the transaction.
|
|
643
|
-
*
|
|
644
|
-
* *Pattern:* `"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$"`
|
|
645
|
-
*/
|
|
646
|
-
'clear-state-program': string;
|
|
647
|
-
/** [epp] the amount of extra program pages available to this app. */
|
|
648
|
-
'extra-program-pages'?: number;
|
|
649
|
-
/** [gs] global schema */
|
|
650
|
-
'global-state': modelsv2.TealKeyValue[];
|
|
651
|
-
/** [gsch] global schema */
|
|
652
|
-
'global-state-schema'?: StateSchema;
|
|
653
|
-
/** [lsch] local schema */
|
|
654
|
-
'local-state-schema'?: StateSchema;
|
|
655
|
-
}
|
|
656
|
-
/** Represents a [apls] local-state or [apgs] global-state schema.
|
|
121
|
+
/** @deprecated Use `algosdk.indexerModels.EvalDelta`. Indexer Represents a TEAL value delta. https://developer.algorand.org/docs/rest-apis/indexer/#evaldelta */
|
|
122
|
+
export type EvalDelta = indexerModels.EvalDelta;
|
|
123
|
+
/** @deprecated Use `algosdk.indexerModels.ApplicationParams`. Indexer Stores the global information associated with an application https://developer.algorand.org/docs/rest-apis/indexer/#applicationparams */
|
|
124
|
+
export type ApplicationParams = indexerModels.ApplicationParams;
|
|
125
|
+
/** @deprecated Use `algosdk.indexerModels.StateSchema`. Indexer Represents a [apls] local-state or [apgs] global-state schema.
|
|
657
126
|
* https://developer.algorand.org/docs/rest-apis/indexer/#stateschema
|
|
658
127
|
*
|
|
659
128
|
* These schemas determine how much storage may be used in a local-state or global-state for an application.
|
|
660
129
|
*
|
|
661
130
|
* The more space used, the larger minimum balance must be maintained in the account holding the data.
|
|
662
131
|
*/
|
|
663
|
-
export
|
|
664
|
-
/** Maximum number of TEAL byte slices that may be stored in the key/value store. */
|
|
665
|
-
'num-byte-slice': number;
|
|
666
|
-
/** Maximum number of TEAL uints that may be stored in the key/value store. */
|
|
667
|
-
'num-uint': number;
|
|
668
|
-
}
|
|
132
|
+
export type StateSchema = indexerModels.StateSchema;
|
|
669
133
|
/** Defines the what additional actions occur with the transaction https://developer.algorand.org/docs/rest-apis/indexer/#oncompletion */
|
|
670
134
|
export declare enum ApplicationOnComplete {
|
|
671
135
|
noop = "noop",
|
|
@@ -675,80 +139,8 @@ export declare enum ApplicationOnComplete {
|
|
|
675
139
|
update = "update",
|
|
676
140
|
delete = "delete"
|
|
677
141
|
}
|
|
678
|
-
/** AssetParams specifies the parameters for an asset. https://developer.algorand.org/docs/rest-apis/indexer/#assetparams */
|
|
679
|
-
export
|
|
680
|
-
/**
|
|
681
|
-
* The address that created this asset. This is the address where the parameters
|
|
682
|
-
* for this asset can be found, and also the address where unwanted asset units can
|
|
683
|
-
* be sent in the worst case.
|
|
684
|
-
*/
|
|
685
|
-
creator: string;
|
|
686
|
-
/**
|
|
687
|
-
* (dc) The number of digits to use after the decimal point when displaying this
|
|
688
|
-
* asset. If 0, the asset is not divisible. If 1, the base unit of the asset is in
|
|
689
|
-
* tenths. If 2, the base unit of the asset is in hundredths, and so on. This value
|
|
690
|
-
* must be between 0 and 19 (inclusive).
|
|
691
|
-
*/
|
|
692
|
-
decimals: number | bigint;
|
|
693
|
-
/**
|
|
694
|
-
* (t) The total number of units of this asset.
|
|
695
|
-
*/
|
|
696
|
-
total: number | bigint;
|
|
697
|
-
/**
|
|
698
|
-
* (c) Address of account used to clawback holdings of this asset. If empty,
|
|
699
|
-
* clawback is not permitted.
|
|
700
|
-
*/
|
|
701
|
-
clawback?: string;
|
|
702
|
-
/**
|
|
703
|
-
* (df) Whether holdings of this asset are frozen by default.
|
|
704
|
-
*/
|
|
705
|
-
'default-frozen'?: boolean;
|
|
706
|
-
/**
|
|
707
|
-
* (f) Address of account used to freeze holdings of this asset. If empty, freezing
|
|
708
|
-
* is not permitted.
|
|
709
|
-
*/
|
|
710
|
-
freeze?: string;
|
|
711
|
-
/**
|
|
712
|
-
* (m) Address of account used to manage the keys of this asset and to destroy it.
|
|
713
|
-
*/
|
|
714
|
-
manager?: string;
|
|
715
|
-
/**
|
|
716
|
-
* (am) A commitment to some unspecified asset metadata. The format of this
|
|
717
|
-
* metadata is up to the application.
|
|
718
|
-
*/
|
|
719
|
-
'metadata-hash'?: Uint8Array;
|
|
720
|
-
/**
|
|
721
|
-
* (an) Name of this asset, as supplied by the creator. Included only when the
|
|
722
|
-
* asset name is composed of printable utf-8 characters.
|
|
723
|
-
*/
|
|
724
|
-
name?: string;
|
|
725
|
-
/**
|
|
726
|
-
* Base64 encoded name of this asset, as supplied by the creator.
|
|
727
|
-
*/
|
|
728
|
-
'name-b64'?: Uint8Array;
|
|
729
|
-
/**
|
|
730
|
-
* (r) Address of account holding reserve (non-minted) units of this asset.
|
|
731
|
-
*/
|
|
732
|
-
reserve?: string;
|
|
733
|
-
/**
|
|
734
|
-
* (un) Name of a unit of this asset, as supplied by the creator. Included only
|
|
735
|
-
* when the name of a unit of this asset is composed of printable utf-8 characters.
|
|
736
|
-
*/
|
|
737
|
-
'unit-name'?: string;
|
|
738
|
-
/**
|
|
739
|
-
* Base64 encoded name of a unit of this asset, as supplied by the creator.
|
|
740
|
-
*/
|
|
741
|
-
'unit-name-b64'?: Uint8Array;
|
|
742
|
-
/**
|
|
743
|
-
* (au) URL where more information about the asset can be retrieved. Included only
|
|
744
|
-
* when the URL is composed of printable utf-8 characters.
|
|
745
|
-
*/
|
|
746
|
-
url?: string;
|
|
747
|
-
/**
|
|
748
|
-
* Base64 encoded URL where more information about the asset can be retrieved.
|
|
749
|
-
*/
|
|
750
|
-
'url-b64'?: Uint8Array;
|
|
751
|
-
}
|
|
142
|
+
/** @deprecated Use `algosdk.indexerModels.AssetParams`. Indexer AssetParams specifies the parameters for an asset. https://developer.algorand.org/docs/rest-apis/indexer/#assetparams */
|
|
143
|
+
export type AssetParams = indexerModels.AssetParams;
|
|
752
144
|
/** Type of signature used by an account */
|
|
753
145
|
export declare enum SignatureType {
|
|
754
146
|
/** Normal signature */
|
|
@@ -767,84 +159,11 @@ export declare enum AccountStatus {
|
|
|
767
159
|
/** Indicates that the associated account is neither a delegator nor a delegate */
|
|
768
160
|
NotParticipating = "NotParticipating"
|
|
769
161
|
}
|
|
770
|
-
/** AccountParticipation describes the parameters used by this account in consensus protocol. https://developer.algorand.org/docs/rest-apis/indexer/#accountparticipation */
|
|
771
|
-
export
|
|
772
|
-
|
|
773
|
-
|
|
774
|
-
|
|
775
|
-
|
|
776
|
-
|
|
777
|
-
|
|
778
|
-
*
|
|
779
|
-
* *Pattern:* `"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$"`
|
|
780
|
-
*/
|
|
781
|
-
'state-proof-key'?: string;
|
|
782
|
-
/** [voteFst] First round for which this participation is valid. */
|
|
783
|
-
'vote-first-valid': number;
|
|
784
|
-
/** [voteKD] Number of subkeys in each batch of participation keys. */
|
|
785
|
-
'vote-key-dilution': number;
|
|
786
|
-
/** [voteLst] Last round for which this participation is valid. */
|
|
787
|
-
'vote-last-valid': number;
|
|
788
|
-
/** [vote] root participation public key (if any) currently registered for this round.
|
|
789
|
-
*
|
|
790
|
-
* *Pattern:* `"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$"`
|
|
791
|
-
*/
|
|
792
|
-
'vote-participation-key': string;
|
|
793
|
-
}
|
|
794
|
-
/** Stores local state associated with an application. https://developer.algorand.org/docs/rest-apis/indexer/#applicationlocalstate */
|
|
795
|
-
export interface AppLocalState {
|
|
796
|
-
/** Round when account closed out of the application. */
|
|
797
|
-
'closed-out-at-round'?: number;
|
|
798
|
-
/** Whether or not the application local state is currently deleted from its account. */
|
|
799
|
-
deleted?: boolean;
|
|
800
|
-
/** The application which this local state is for. */
|
|
801
|
-
id: number;
|
|
802
|
-
/** [tkv] storage. */
|
|
803
|
-
'key-value'?: modelsv2.TealKeyValue[];
|
|
804
|
-
/** Round when the account opted into the application. */
|
|
805
|
-
'opted-in-at-round'?: number;
|
|
806
|
-
/** [hsch] schema. */
|
|
807
|
-
schema: StateSchema;
|
|
808
|
-
}
|
|
809
|
-
/** Describes an asset held by an account. https://developer.algorand.org/docs/rest-apis/indexer/#assetholding */
|
|
810
|
-
export interface AssetHolding {
|
|
811
|
-
/**
|
|
812
|
-
* (a) number of units held.
|
|
813
|
-
*/
|
|
814
|
-
amount: number | bigint;
|
|
815
|
-
/**
|
|
816
|
-
* Asset ID of the holding.
|
|
817
|
-
*/
|
|
818
|
-
'asset-id': number;
|
|
819
|
-
/** Whether or not the asset holding is currently deleted from its account. */
|
|
820
|
-
deleted?: boolean;
|
|
821
|
-
/**
|
|
822
|
-
* [f] whether or not the holding is frozen.
|
|
823
|
-
*/
|
|
824
|
-
'is-frozen': boolean;
|
|
825
|
-
/** Round during which the account opted into this asset holding. */
|
|
826
|
-
'opted-in-at-round': number;
|
|
827
|
-
/** Round during which the account opted out of this asset holding. */
|
|
828
|
-
'opted-out-at-round': number;
|
|
829
|
-
}
|
|
830
|
-
/** Describes an asset holding for an account of a known asset. https://developer.algorand.org/docs/rest-apis/indexer/#miniassetholding */
|
|
831
|
-
export interface MiniAssetHolding {
|
|
832
|
-
/**
|
|
833
|
-
* Address of the account that holds the asset.
|
|
834
|
-
*/
|
|
835
|
-
address: string;
|
|
836
|
-
/**
|
|
837
|
-
* (a) number of units held.
|
|
838
|
-
*/
|
|
839
|
-
amount: number | bigint;
|
|
840
|
-
/** Whether or not the asset holding is currently deleted from its account. */
|
|
841
|
-
deleted?: boolean;
|
|
842
|
-
/**
|
|
843
|
-
* [f] whether or not the holding is frozen.
|
|
844
|
-
*/
|
|
845
|
-
'is-frozen': boolean;
|
|
846
|
-
/** Round during which the account opted into this asset holding. */
|
|
847
|
-
'opted-in-at-round'?: number;
|
|
848
|
-
/** Round during which the account opted out of this asset holding. */
|
|
849
|
-
'opted-out-at-round'?: number;
|
|
850
|
-
}
|
|
162
|
+
/** @deprecated Use `algosdk.indexerModels.AccountParticipation`. Indexer AccountParticipation describes the parameters used by this account in consensus protocol. https://developer.algorand.org/docs/rest-apis/indexer/#accountparticipation */
|
|
163
|
+
export type AccountParticipation = indexerModels.AccountParticipation;
|
|
164
|
+
/** @deprecated Use `algosdk.indexerModels.ApplicationLocalState`. Indexer Stores local state associated with an application. https://developer.algorand.org/docs/rest-apis/indexer/#applicationlocalstate */
|
|
165
|
+
export type AppLocalState = indexerModels.ApplicationLocalState;
|
|
166
|
+
/** @deprecated Use `algosdk.indexerModels.AssetHolding`. Indexer Describes an asset held by an account. https://developer.algorand.org/docs/rest-apis/indexer/#assetholding */
|
|
167
|
+
export type AssetHolding = indexerModels.AssetHolding;
|
|
168
|
+
/** @deprecated Use `algosdk.indexerModels.MiniAssetHolding`. Indexer Describes an asset holding for an account of a known asset. https://developer.algorand.org/docs/rest-apis/indexer/#miniassetholding */
|
|
169
|
+
export type MiniAssetHolding = indexerModels.MiniAssetHolding;
|