@algorandfoundation/algokit-utils 9.2.1-beta.3 → 9.2.2-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/account/account.d.ts +28 -23
- package/account/get-account-config-from-environment.d.ts +2 -7
- package/account/get-account.d.ts +12 -14
- package/account/get-dispenser-account.d.ts +5 -9
- package/account/index.d.ts +5 -0
- package/account/mnemonic-account.d.ts +3 -7
- package/amount.d.ts +35 -40
- package/app-client.d.ts +6 -10
- package/app-deploy.d.ts +23 -25
- package/app.d.ts +46 -45
- package/asset.d.ts +12 -16
- package/config.d.ts +2 -7
- package/debugging/debugging.d.ts +1 -5
- package/debugging/index.d.ts +1 -0
- package/dispenser-client.d.ts +2 -7
- package/index.d.ts +18 -27
- package/indexer-lookup.d.ts +11 -18
- package/localnet/get-kmd-wallet-account.d.ts +7 -9
- package/localnet/get-localnet-dispenser-account.d.ts +5 -7
- package/localnet/get-or-create-kmd-wallet-account.d.ts +8 -10
- package/localnet/index.d.ts +4 -0
- package/localnet/is-localnet.d.ts +3 -7
- package/network-client.d.ts +15 -17
- package/package.json +1 -1
- package/testing/_asset.d.ts +3 -0
- package/testing/account.d.ts +9 -11
- package/testing/fixtures/algokit-log-capture-fixture.d.ts +2 -7
- package/testing/fixtures/algorand-fixture.d.ts +4 -9
- package/testing/fixtures/index.d.ts +2 -0
- package/testing/index.d.ts +5 -7
- package/testing/indexer.d.ts +1 -5
- package/testing/test-logger.d.ts +36 -41
- package/testing/transaction-logger.d.ts +27 -30
- package/transaction/index.d.ts +2 -0
- package/transaction/legacy-bridge.d.ts +35 -0
- package/transaction/perform-atomic-transaction-composer-simulate.d.ts +5 -7
- package/transaction/resolve-signed-transactions.d.ts +16 -0
- package/transaction/transaction.d.ts +35 -34
- package/transfer/index.d.ts +2 -0
- package/transfer/transfer-algos.d.ts +5 -9
- package/transfer/transfer.d.ts +8 -11
- package/types/account-manager.d.ts +429 -432
- package/types/account.d.ts +202 -192
- package/types/algo-http-client-with-retry.d.ts +10 -15
- package/types/algorand-client-transaction-creator.d.ts +771 -778
- package/types/algorand-client-transaction-sender.d.ts +1085 -1090
- package/types/algorand-client.d.ts +236 -239
- package/types/amount.d.ts +43 -47
- package/types/app-arc56.d.ts +272 -235
- package/types/app-client.d.ts +1151 -1128
- package/types/app-deployer.d.ts +141 -139
- package/types/app-factory.d.ts +783 -762
- package/types/app-manager.d.ts +310 -304
- package/types/app-spec.d.ts +117 -118
- package/types/app.d.ts +241 -229
- package/types/asset-manager.d.ts +199 -204
- package/types/asset.d.ts +91 -95
- package/types/async-event-emitter.d.ts +13 -18
- package/types/client-manager.d.ts +451 -453
- package/types/composer.d.ts +1257 -1210
- package/types/config.d.ts +48 -53
- package/types/debugging.d.ts +23 -25
- package/types/dispenser-client.d.ts +52 -57
- package/types/expand.d.ts +3 -5
- package/types/indexer.d.ts +66 -70
- package/types/instance-of.d.ts +3 -5
- package/types/kmd-account-manager.d.ts +70 -75
- package/types/lifecycle-events.d.ts +8 -13
- package/types/logging.d.ts +11 -15
- package/types/logic-error.d.ts +29 -33
- package/types/network-client.d.ts +27 -32
- package/types/testing.d.ts +132 -131
- package/types/transaction.d.ts +110 -110
- package/types/transfer.d.ts +66 -70
- package/util.d.ts +48 -0
package/types/config.d.ts
CHANGED
|
@@ -1,57 +1,52 @@
|
|
|
1
|
-
import { AsyncEventEmitter } from
|
|
2
|
-
import { Logger } from
|
|
3
|
-
|
|
4
|
-
//#region src/types/config.d.ts
|
|
1
|
+
import { AsyncEventEmitter } from './async-event-emitter';
|
|
2
|
+
import { Logger } from './logging';
|
|
5
3
|
/** The AlgoKit configuration type */
|
|
6
|
-
interface Config {
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
4
|
+
export interface Config {
|
|
5
|
+
/** Logger */
|
|
6
|
+
logger: Logger;
|
|
7
|
+
/** Whether or not debug mode is enabled */
|
|
8
|
+
debug: boolean;
|
|
9
|
+
/** The path to the project root directory */
|
|
10
|
+
projectRoot: string | null;
|
|
11
|
+
/** Indicates whether to trace all operations */
|
|
12
|
+
traceAll: boolean;
|
|
13
|
+
/** The size of the trace buffer in megabytes */
|
|
14
|
+
traceBufferSizeMb: number;
|
|
15
|
+
/** The maximum depth to search for a specific file */
|
|
16
|
+
maxSearchDepth: number;
|
|
17
|
+
/**
|
|
18
|
+
* Whether to enable populateAppCallResources in sendParams by default.
|
|
19
|
+
* Default value is false.
|
|
20
|
+
*/
|
|
21
|
+
populateAppCallResources: boolean;
|
|
22
|
+
events: AsyncEventEmitter;
|
|
25
23
|
}
|
|
26
24
|
/** Updatable AlgoKit config */
|
|
27
|
-
declare class UpdatableConfig implements Readonly<Config> {
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
25
|
+
export declare class UpdatableConfig implements Readonly<Config> {
|
|
26
|
+
private config;
|
|
27
|
+
get populateAppCallResources(): boolean;
|
|
28
|
+
get logger(): Logger;
|
|
29
|
+
get debug(): boolean;
|
|
30
|
+
get projectRoot(): string | null;
|
|
31
|
+
get traceAll(): boolean;
|
|
32
|
+
get traceBufferSizeMb(): number;
|
|
33
|
+
get maxSearchDepth(): number;
|
|
34
|
+
get events(): AsyncEventEmitter;
|
|
35
|
+
/**
|
|
36
|
+
* Returns the current logger, or the null logger if true is passed in to `returnNullLogger`
|
|
37
|
+
* @param returnNullLogger Whether or not to return the null logger
|
|
38
|
+
* @returns The requested logger
|
|
39
|
+
*/
|
|
40
|
+
getLogger(returnNullLogger?: boolean): Logger;
|
|
41
|
+
/**
|
|
42
|
+
* Temporarily run with debug set to true.
|
|
43
|
+
* @param lambda A lambda expression with code to run with debug config set to true
|
|
44
|
+
*/
|
|
45
|
+
withDebug(lambda: () => unknown): void;
|
|
46
|
+
constructor();
|
|
47
|
+
/**
|
|
48
|
+
* Update the AlgoKit configuration with your own configuration settings
|
|
49
|
+
* @param newConfig Partial or complete config to replace
|
|
50
|
+
*/
|
|
51
|
+
configure(newConfig: Partial<Config>): void;
|
|
54
52
|
}
|
|
55
|
-
//#endregion
|
|
56
|
-
export { Config, UpdatableConfig };
|
|
57
|
-
//# sourceMappingURL=config.d.ts.map
|
package/types/debugging.d.ts
CHANGED
|
@@ -1,42 +1,40 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
1
|
+
/**
|
|
2
|
+
* An asynchronous event listener
|
|
3
|
+
*/
|
|
4
|
+
import algosdk from 'algosdk';
|
|
5
|
+
import { CompiledTeal } from './app';
|
|
5
6
|
/** The directory name for AlgoKit project related files */
|
|
6
|
-
declare const ALGOKIT_DIR = ".algokit";
|
|
7
|
+
export declare const ALGOKIT_DIR = ".algokit";
|
|
7
8
|
/** The directory name for debug source files */
|
|
8
|
-
declare const SOURCES_DIR = "sources";
|
|
9
|
+
export declare const SOURCES_DIR = "sources";
|
|
9
10
|
/** The file extension for TEAL files */
|
|
10
|
-
declare const TEAL_FILE_EXT = ".teal";
|
|
11
|
+
export declare const TEAL_FILE_EXT = ".teal";
|
|
11
12
|
/** The file extension for TEAL source map files */
|
|
12
|
-
declare const TEAL_SOURCEMAP_EXT = ".teal.map";
|
|
13
|
+
export declare const TEAL_SOURCEMAP_EXT = ".teal.map";
|
|
13
14
|
/** The default maximum search depth for file operations */
|
|
14
|
-
declare const DEFAULT_MAX_SEARCH_DEPTH = 10;
|
|
15
|
+
export declare const DEFAULT_MAX_SEARCH_DEPTH = 10;
|
|
15
16
|
/**
|
|
16
17
|
* Represents the data for a single TEAL source
|
|
17
18
|
*/
|
|
18
|
-
interface TealSourceDebugEventData {
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
19
|
+
export interface TealSourceDebugEventData {
|
|
20
|
+
/** The name of the application */
|
|
21
|
+
appName: string;
|
|
22
|
+
/** The name of the file */
|
|
23
|
+
fileName: string;
|
|
24
|
+
/** The compiled TEAL code */
|
|
25
|
+
compiledTeal: CompiledTeal;
|
|
25
26
|
}
|
|
26
27
|
/**
|
|
27
28
|
* Represents the data for multiple TEAL sources debug events emitted whenever an app is compiled as part of a deploy in debug mode
|
|
28
29
|
*/
|
|
29
|
-
interface TealSourcesDebugEventData {
|
|
30
|
-
|
|
31
|
-
|
|
30
|
+
export interface TealSourcesDebugEventData {
|
|
31
|
+
/** An array of TEAL source debug event data */
|
|
32
|
+
sources: TealSourceDebugEventData[];
|
|
32
33
|
}
|
|
33
34
|
/**
|
|
34
35
|
* Represents the data for AVM traces debug events emitted whenever a transaction is simulated in debug mode
|
|
35
36
|
*/
|
|
36
|
-
interface AVMTracesEventData {
|
|
37
|
-
|
|
38
|
-
|
|
37
|
+
export interface AVMTracesEventData {
|
|
38
|
+
/** The simulation response from Algod */
|
|
39
|
+
simulateResponse: algosdk.modelsv2.SimulateResponse;
|
|
39
40
|
}
|
|
40
|
-
//#endregion
|
|
41
|
-
export { ALGOKIT_DIR, AVMTracesEventData, DEFAULT_MAX_SEARCH_DEPTH, SOURCES_DIR, TEAL_FILE_EXT, TEAL_SOURCEMAP_EXT, TealSourceDebugEventData, TealSourcesDebugEventData };
|
|
42
|
-
//# sourceMappingURL=debugging.d.ts.map
|
|
@@ -1,24 +1,22 @@
|
|
|
1
|
-
import { Address } from
|
|
2
|
-
|
|
3
|
-
//#region src/types/dispenser-client.d.ts
|
|
1
|
+
import { Address } from 'algosdk';
|
|
4
2
|
/** The TestNet Dispenser API response when funding. */
|
|
5
|
-
interface DispenserFundResponse {
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
3
|
+
export interface DispenserFundResponse {
|
|
4
|
+
/** The ID of the transaction that was issued to fund the account. */
|
|
5
|
+
txId: string;
|
|
6
|
+
/** The number of µAlgo that was funded. */
|
|
7
|
+
amount: number;
|
|
10
8
|
}
|
|
11
9
|
/** The TestNet Dispenser API response when getting the current limit. */
|
|
12
|
-
interface DispenserLimitResponse {
|
|
13
|
-
|
|
14
|
-
|
|
10
|
+
export interface DispenserLimitResponse {
|
|
11
|
+
/** The limit, in µAlgo, that you can currently fund. */
|
|
12
|
+
amount: number;
|
|
15
13
|
}
|
|
16
14
|
/** The parameters to construct a TestNet Dispenser API client. */
|
|
17
|
-
interface TestNetDispenserApiClientParams {
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
15
|
+
export interface TestNetDispenserApiClientParams {
|
|
16
|
+
/** The API auth token */
|
|
17
|
+
authToken: string;
|
|
18
|
+
/** The request timeout in seconds */
|
|
19
|
+
requestTimeout?: number;
|
|
22
20
|
}
|
|
23
21
|
/**
|
|
24
22
|
* `TestNetDispenserApiClient` is a class that provides methods to interact with the [Algorand TestNet Dispenser API](https://github.com/algorandfoundation/algokit/blob/main/docs/testnet_api.md).
|
|
@@ -46,45 +44,42 @@ interface TestNetDispenserApiClientParams {
|
|
|
46
44
|
*
|
|
47
45
|
* @throws {Error} If neither the environment variable 'ALGOKIT_DISPENSER_ACCESS_TOKEN' nor the authToken parameter were provided.
|
|
48
46
|
*/
|
|
49
|
-
declare class TestNetDispenserApiClient {
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
47
|
+
export declare class TestNetDispenserApiClient {
|
|
48
|
+
private _authToken;
|
|
49
|
+
private _requestTimeout;
|
|
50
|
+
constructor(params?: TestNetDispenserApiClientParams);
|
|
51
|
+
get authToken(): string;
|
|
52
|
+
get requestTimeout(): number;
|
|
53
|
+
/**
|
|
54
|
+
* Processes a dispenser API request.
|
|
55
|
+
*
|
|
56
|
+
* @param authToken - The authentication token.
|
|
57
|
+
* @param urlSuffix - The URL suffix for the API request.
|
|
58
|
+
* @param body - The request body.
|
|
59
|
+
* @param method - The HTTP method.
|
|
60
|
+
*
|
|
61
|
+
* @returns The API response.
|
|
62
|
+
*/
|
|
63
|
+
private processDispenserRequest;
|
|
64
|
+
/**
|
|
65
|
+
* Sends a funding request to the dispenser API to fund the specified address with the given amount of Algo.
|
|
66
|
+
*
|
|
67
|
+
* @param address - The address to fund.
|
|
68
|
+
* @param amount - The amount of µAlgo to fund.
|
|
69
|
+
*
|
|
70
|
+
* @returns DispenserFundResponse: An object containing the transaction ID and funded amount.
|
|
71
|
+
*/
|
|
72
|
+
fund(address: string | Address, amount: number | bigint): Promise<DispenserFundResponse>;
|
|
73
|
+
/**
|
|
74
|
+
* Sends a refund request to the dispenser API for the specified refundTxnId.
|
|
75
|
+
*
|
|
76
|
+
* @param refundTxnId - The transaction ID to refund.
|
|
77
|
+
*/
|
|
78
|
+
refund(refundTxnId: string): Promise<void>;
|
|
79
|
+
/**
|
|
80
|
+
* Sends a request to the dispenser API to get the funding limit for the Algo asset.
|
|
81
|
+
*
|
|
82
|
+
* @returns DispenserLimitResponse: An object containing the funding limit amount.
|
|
83
|
+
*/
|
|
84
|
+
getLimit(): Promise<DispenserLimitResponse>;
|
|
87
85
|
}
|
|
88
|
-
//#endregion
|
|
89
|
-
export { DispenserFundResponse, DispenserLimitResponse, TestNetDispenserApiClient, TestNetDispenserApiClientParams };
|
|
90
|
-
//# sourceMappingURL=dispenser-client.d.ts.map
|
package/types/expand.d.ts
CHANGED
|
@@ -1,9 +1,7 @@
|
|
|
1
|
-
//#region src/types/expand.d.ts
|
|
2
1
|
/**
|
|
3
2
|
* Expands types for IntelliSense so they are more human readable
|
|
4
3
|
* See https://stackoverflow.com/a/69288824
|
|
5
4
|
*/
|
|
6
|
-
type Expand<T> = T extends (
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
//# sourceMappingURL=expand.d.ts.map
|
|
5
|
+
export type Expand<T> = T extends (...args: infer A) => infer R ? (...args: Expand<A>) => Expand<R> : T extends infer O ? {
|
|
6
|
+
[K in keyof O]: O[K];
|
|
7
|
+
} : never;
|
package/types/indexer.d.ts
CHANGED
|
@@ -1,39 +1,38 @@
|
|
|
1
|
-
import algosdk from
|
|
2
|
-
|
|
3
|
-
//#region src/types/indexer.d.ts
|
|
1
|
+
import algosdk from 'algosdk';
|
|
2
|
+
import indexerModels = algosdk.indexerModels;
|
|
4
3
|
/** @deprecated Use `algosdk.indexerModels.TransactionsResponse`. Indexer result for a transaction search, https://dev.algorand.co/reference/rest-api/indexer#get-v2transactions */
|
|
5
|
-
type TransactionSearchResults = indexerModels.TransactionsResponse;
|
|
4
|
+
export type TransactionSearchResults = indexerModels.TransactionsResponse;
|
|
6
5
|
/** @deprecated Use `algosdk.indexerModels.AccountResponse`. Indexer result for an account lookup, https://dev.algorand.co/reference/rest-api/indexer#get-v2accountsaccount-id */
|
|
7
|
-
type AccountLookupResult = indexerModels.AccountResponse;
|
|
6
|
+
export type AccountLookupResult = indexerModels.AccountResponse;
|
|
8
7
|
/** @deprecated Use `algosdk.indexerModels.AssetHoldingsResponse`. Indexer result for an account's asset holdings, https://dev.algorand.co/reference/rest-api/indexer#get-v2accountsaccount-idassets */
|
|
9
|
-
type AssetsLookupResult = indexerModels.AssetHoldingsResponse;
|
|
8
|
+
export type AssetsLookupResult = indexerModels.AssetHoldingsResponse;
|
|
10
9
|
/** @deprecated Use `algosdk.indexerModels.AssetsResponse`. Indexer result for an account's created assets, https://dev.algorand.co/reference/rest-api/indexer#get-v2accountsaccount-idcreated-assets */
|
|
11
|
-
type AssetsCreatedLookupResult = indexerModels.AssetsResponse;
|
|
10
|
+
export type AssetsCreatedLookupResult = indexerModels.AssetsResponse;
|
|
12
11
|
/** @deprecated Use `algosdk.indexerModels.ApplicationsResponse`. Indexer result for an account's created applications, https://dev.algorand.co/reference/rest-api/indexer#get-v2accountsaccount-idcreated-applications */
|
|
13
|
-
type ApplicationCreatedLookupResult = indexerModels.ApplicationsResponse;
|
|
12
|
+
export type ApplicationCreatedLookupResult = indexerModels.ApplicationsResponse;
|
|
14
13
|
/** @deprecated Use `algosdk.indexerModels.AssetResponse`. Indexer result for an asset lookup, https://dev.algorand.co/reference/rest-api/indexer#get-v2assetsasset-id */
|
|
15
|
-
type AssetLookupResult = indexerModels.AssetResponse;
|
|
14
|
+
export type AssetLookupResult = indexerModels.AssetResponse;
|
|
16
15
|
/** Options when looking up an asset's account holdings, https://dev.algorand.co/reference/rest-api/indexer#get-v2assetsasset-idbalances */
|
|
17
|
-
interface LookupAssetHoldingsOptions {
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
16
|
+
export interface LookupAssetHoldingsOptions {
|
|
17
|
+
/** Results should have a decimal units amount less than this value. */
|
|
18
|
+
currencyLessThan?: number | bigint;
|
|
19
|
+
/** Results should have a decimal units amount greater than this value. */
|
|
20
|
+
currencyGreaterThan?: number | bigint;
|
|
21
|
+
/** Include all items including closed accounts and opted-out asset holdings. */
|
|
22
|
+
includeAll?: boolean;
|
|
24
23
|
}
|
|
25
24
|
/** @deprecated Use `algosdk.indexerModels.AssetBalancesResponse`. Indexer result for an asset's account holdings, https://dev.algorand.co/reference/rest-api/indexer#get-v2assetsasset-idbalances */
|
|
26
|
-
type AssetBalancesLookupResult = indexerModels.AssetBalancesResponse;
|
|
25
|
+
export type AssetBalancesLookupResult = indexerModels.AssetBalancesResponse;
|
|
27
26
|
/** @deprecated Use `algosdk.indexerModels.TransactionResponse`. Indexer result for a transaction lookup, https://dev.algorand.co/reference/rest-api/indexer#get-v2transactionstxid */
|
|
28
|
-
type TransactionLookupResult = indexerModels.TransactionResponse;
|
|
27
|
+
export type TransactionLookupResult = indexerModels.TransactionResponse;
|
|
29
28
|
/** @deprecated Use `algosdk.indexerModels.ApplicationResponse`. Indexer result for an application lookup, https://dev.algorand.co/reference/rest-api/indexer#get-v2applicationsapplication-id */
|
|
30
|
-
type ApplicationLookupResult = indexerModels.ApplicationResponse;
|
|
29
|
+
export type ApplicationLookupResult = indexerModels.ApplicationResponse;
|
|
31
30
|
/** @deprecated Use `algosdk.indexerModels.Transaction`. Indexer result for a transaction, https://dev.algorand.co/reference/rest-api/indexer#transaction */
|
|
32
|
-
type TransactionResult = indexerModels.Transaction;
|
|
31
|
+
export type TransactionResult = indexerModels.Transaction;
|
|
33
32
|
/** @deprecated Use `algosdk.indexerModels.Account`. Indexer Account information at a given round https://dev.algorand.co/reference/rest-api/indexer#account */
|
|
34
|
-
type AccountResult = indexerModels.Account;
|
|
33
|
+
export type AccountResult = indexerModels.Account;
|
|
35
34
|
/** @deprecated Use `algosdk.indexerModels.TransactionPayment`. Indexer Fields for a payment transaction https://dev.algorand.co/reference/rest-api/indexer#transactionpayment */
|
|
36
|
-
type PaymentTransactionResult = indexerModels.TransactionPayment;
|
|
35
|
+
export type PaymentTransactionResult = indexerModels.TransactionPayment;
|
|
37
36
|
/** @deprecated Use `algosdk.indexerModels.TransactionStateProof`. Indexer Fields for a state proof transaction https://dev.algorand.co/reference/rest-api/indexer#transactionstateproof.
|
|
38
37
|
*
|
|
39
38
|
* See also https://dev.algorand.co/concepts/protocol/state-proofs/,
|
|
@@ -42,7 +41,7 @@ type PaymentTransactionResult = indexerModels.TransactionPayment;
|
|
|
42
41
|
* https://github.com/algorand/go-algorand/blob/master/data/stateproofmsg/message.go, and
|
|
43
42
|
* https://dev.algorand.co/reference/rest-api/algod/operations/getstateproof/.
|
|
44
43
|
*/
|
|
45
|
-
type StateProofTransactionResult = indexerModels.TransactionStateProof;
|
|
44
|
+
export type StateProofTransactionResult = indexerModels.TransactionStateProof;
|
|
46
45
|
/** @deprecated Use `algosdk.indexerModels.MerkleArrayProof`. Indexer Merkle array Proof.
|
|
47
46
|
*
|
|
48
47
|
* Proof is used to convince a verifier about membership of leaves: h0,h1...hn
|
|
@@ -79,49 +78,49 @@ type StateProofTransactionResult = indexerModels.TransactionStateProof;
|
|
|
79
78
|
* . len(hints) = 2^4/2
|
|
80
79
|
* ```
|
|
81
80
|
*/
|
|
82
|
-
type MerkleArrayProof = indexerModels.MerkleArrayProof;
|
|
81
|
+
export type MerkleArrayProof = indexerModels.MerkleArrayProof;
|
|
83
82
|
/** @deprecated Use `algosdk.indexerModels.TransactionApplication`. Indexer Fields for an application transaction https://dev.algorand.co/reference/rest-api/indexer#transactionapplication */
|
|
84
|
-
type ApplicationTransactionResult = indexerModels.TransactionApplication;
|
|
83
|
+
export type ApplicationTransactionResult = indexerModels.TransactionApplication;
|
|
85
84
|
/** @deprecated Use `algosdk.indexerModels.TransactionAssetConfig`. Indexer Fields for asset allocation, re-configuration, and destruction.
|
|
86
85
|
* https://dev.algorand.co/reference/rest-api/indexer#transactionassetconfig
|
|
87
86
|
*
|
|
88
87
|
* A zero value for asset-id indicates asset creation. A zero value for the params indicates asset destruction.
|
|
89
88
|
*/
|
|
90
|
-
type AssetConfigTransactionResult = indexerModels.TransactionAssetConfig;
|
|
89
|
+
export type AssetConfigTransactionResult = indexerModels.TransactionAssetConfig;
|
|
91
90
|
/** @deprecated Use `algosdk.indexerModels.TransactionAssetFreeze`. Indexer Fields for an asset freeze transaction. https://dev.algorand.co/reference/rest-api/indexer#transactionassetfreeze */
|
|
92
|
-
type AssetFreezeTransactionResult = indexerModels.TransactionAssetFreeze;
|
|
91
|
+
export type AssetFreezeTransactionResult = indexerModels.TransactionAssetFreeze;
|
|
93
92
|
/** @deprecated Use `algosdk.indexerModels.TransactionAssetTransfer`. Indexer Fields for an asset transfer transaction. https://dev.algorand.co/reference/rest-api/indexer#transactionassettransfer */
|
|
94
|
-
type AssetTransferTransactionResult = indexerModels.TransactionAssetTransfer;
|
|
93
|
+
export type AssetTransferTransactionResult = indexerModels.TransactionAssetTransfer;
|
|
95
94
|
/** @deprecated Use `algosdk.indexerModels.TransactionKeyreg`. Indexer Fields for a `keyreg` transaction https://dev.algorand.co/reference/rest-api/indexer#transactionkeyreg */
|
|
96
|
-
type KeyRegistrationTransactionResult = indexerModels.TransactionKeyreg;
|
|
95
|
+
export type KeyRegistrationTransactionResult = indexerModels.TransactionKeyreg;
|
|
97
96
|
/** @deprecated Use `algosdk.indexerModels.Asset`. Indexer Fields to specify both the unique identifier and the parameters for an asset. https://dev.algorand.co/reference/rest-api/indexer#asset */
|
|
98
|
-
type AssetResult = indexerModels.Asset;
|
|
97
|
+
export type AssetResult = indexerModels.Asset;
|
|
99
98
|
/** @deprecated Use `algosdk.indexerModels.Application`. Indexer result of looking up an application
|
|
100
99
|
*/
|
|
101
|
-
type ApplicationResult = indexerModels.Application;
|
|
100
|
+
export type ApplicationResult = indexerModels.Application;
|
|
102
101
|
/** @deprecated Use `algosdk.indexerModels.TransactionSignature`. Indexer Validation signature associated with some data. Only one of the signatures should be provided. https://dev.algorand.co/reference/rest-api/indexer#transactionsignature */
|
|
103
|
-
type TransactionSignature = indexerModels.TransactionSignature;
|
|
102
|
+
export type TransactionSignature = indexerModels.TransactionSignature;
|
|
104
103
|
/** @deprecated Use `algosdk.indexerModels.TransactionSignatureLogicsig`. Indexer [lsig] Programatic transaction signature.
|
|
105
104
|
*
|
|
106
105
|
* https://dev.algorand.co/reference/rest-api/indexer#transactionsignaturelogicsig
|
|
107
106
|
*
|
|
108
107
|
* https://dev.algorand.co/concepts/smart-contracts/logic-sigs
|
|
109
108
|
*/
|
|
110
|
-
type LogicTransactionSignature = indexerModels.TransactionSignatureLogicsig;
|
|
109
|
+
export type LogicTransactionSignature = indexerModels.TransactionSignatureLogicsig;
|
|
111
110
|
/** @deprecated Use `algosdk.indexerModels.TransactionSignatureMultisig`. Indexer [msig] structure holding multiple subsignatures. https://dev.algorand.co/reference/rest-api/indexer#transactionsignaturemultisig */
|
|
112
|
-
type MultisigTransactionSignature = indexerModels.TransactionSignatureMultisig;
|
|
111
|
+
export type MultisigTransactionSignature = indexerModels.TransactionSignatureMultisig;
|
|
113
112
|
/** @deprecated Use `algosdk.indexerModels.TransactionSignatureMultisigSubsignature`. Indexer Sub-signature for a multisig signature https://dev.algorand.co/reference/rest-api/indexer#transactionsignaturemultisigsubsignature */
|
|
114
|
-
type MultisigTransactionSubSignature = indexerModels.TransactionSignatureMultisigSubsignature;
|
|
113
|
+
export type MultisigTransactionSubSignature = indexerModels.TransactionSignatureMultisigSubsignature;
|
|
115
114
|
/** @deprecated Use `algosdk.indexerModels.EvalDeltaKeyValue`. */
|
|
116
|
-
type EvalDeltaKeyValue = indexerModels.EvalDeltaKeyValue;
|
|
115
|
+
export type EvalDeltaKeyValue = indexerModels.EvalDeltaKeyValue;
|
|
117
116
|
/** @deprecated Use `algosdk.indexerModels.AccountStateDelta`. */
|
|
118
|
-
type AccountStateDelta = indexerModels.AccountStateDelta;
|
|
117
|
+
export type AccountStateDelta = indexerModels.AccountStateDelta;
|
|
119
118
|
/** @deprecated Use `algosdk.indexerModels.EvalDeltaKeyValue[]`. */
|
|
120
|
-
type StateDelta = EvalDeltaKeyValue[];
|
|
119
|
+
export type StateDelta = EvalDeltaKeyValue[];
|
|
121
120
|
/** @deprecated Use `algosdk.indexerModels.EvalDelta`. Indexer Represents a TEAL value delta. https://dev.algorand.co/reference/rest-api/indexer#evaldelta */
|
|
122
|
-
type EvalDelta = indexerModels.EvalDelta;
|
|
121
|
+
export type EvalDelta = indexerModels.EvalDelta;
|
|
123
122
|
/** @deprecated Use `algosdk.indexerModels.ApplicationParams`. Indexer Stores the global information associated with an application https://dev.algorand.co/reference/rest-api/indexer#applicationparams */
|
|
124
|
-
type ApplicationParams = indexerModels.ApplicationParams;
|
|
123
|
+
export type ApplicationParams = indexerModels.ApplicationParams;
|
|
125
124
|
/** @deprecated Use `algosdk.indexerModels.StateSchema`. Indexer Represents a [apls] local-state or [apgs] global-state schema.
|
|
126
125
|
* https://dev.algorand.co/reference/rest-api/indexer#stateschema
|
|
127
126
|
*
|
|
@@ -129,44 +128,41 @@ type ApplicationParams = indexerModels.ApplicationParams;
|
|
|
129
128
|
*
|
|
130
129
|
* The more space used, the larger minimum balance must be maintained in the account holding the data.
|
|
131
130
|
*/
|
|
132
|
-
type StateSchema = indexerModels.StateSchema;
|
|
131
|
+
export type StateSchema = indexerModels.StateSchema;
|
|
133
132
|
/** Defines the what additional actions occur with the transaction https://dev.algorand.co/reference/rest-api/indexer/#oncompletion */
|
|
134
|
-
declare enum ApplicationOnComplete {
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
133
|
+
export declare enum ApplicationOnComplete {
|
|
134
|
+
noop = "noop",
|
|
135
|
+
optin = "optin",
|
|
136
|
+
closeout = "closeout",
|
|
137
|
+
clear = "clear",
|
|
138
|
+
update = "update",
|
|
139
|
+
delete = "delete"
|
|
141
140
|
}
|
|
142
141
|
/** @deprecated Use `algosdk.indexerModels.AssetParams`. Indexer AssetParams specifies the parameters for an asset. https://dev.algorand.co/reference/rest-api/indexer#assetparams */
|
|
143
|
-
type AssetParams = indexerModels.AssetParams;
|
|
142
|
+
export type AssetParams = indexerModels.AssetParams;
|
|
144
143
|
/** Type of signature used by an account */
|
|
145
|
-
declare enum SignatureType {
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
144
|
+
export declare enum SignatureType {
|
|
145
|
+
/** Normal signature */
|
|
146
|
+
sig = "sig",
|
|
147
|
+
/** Multisig */
|
|
148
|
+
msig = "msig",
|
|
149
|
+
/** Logic signature */
|
|
150
|
+
lsig = "lsig"
|
|
152
151
|
}
|
|
153
152
|
/** Delegation status of the account */
|
|
154
|
-
declare enum AccountStatus {
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
153
|
+
export declare enum AccountStatus {
|
|
154
|
+
/** Indicates that the associated account is delegated */
|
|
155
|
+
Offline = "Offline",
|
|
156
|
+
/** Indicates that the associated account used as part of the delegation pool */
|
|
157
|
+
Online = "Online",
|
|
158
|
+
/** Indicates that the associated account is neither a delegator nor a delegate */
|
|
159
|
+
NotParticipating = "NotParticipating"
|
|
161
160
|
}
|
|
162
161
|
/** @deprecated Use `algosdk.indexerModels.AccountParticipation`. Indexer AccountParticipation describes the parameters used by this account in consensus protocol. https://dev.algorand.co/reference/rest-api/indexer#accountparticipation */
|
|
163
|
-
type AccountParticipation = indexerModels.AccountParticipation;
|
|
162
|
+
export type AccountParticipation = indexerModels.AccountParticipation;
|
|
164
163
|
/** @deprecated Use `algosdk.indexerModels.ApplicationLocalState`. Indexer Stores local state associated with an application. https://dev.algorand.co/reference/rest-api/indexer#applicationlocalstate */
|
|
165
|
-
type AppLocalState = indexerModels.ApplicationLocalState;
|
|
164
|
+
export type AppLocalState = indexerModels.ApplicationLocalState;
|
|
166
165
|
/** @deprecated Use `algosdk.indexerModels.AssetHolding`. Indexer Describes an asset held by an account. https://dev.algorand.co/reference/rest-api/indexer#assetholding */
|
|
167
|
-
type AssetHolding = indexerModels.AssetHolding;
|
|
166
|
+
export type AssetHolding = indexerModels.AssetHolding;
|
|
168
167
|
/** @deprecated Use `algosdk.indexerModels.MiniAssetHolding`. Indexer Describes an asset holding for an account of a known asset. https://dev.algorand.co/reference/rest-api/indexer#miniassetholding */
|
|
169
|
-
type MiniAssetHolding = indexerModels.MiniAssetHolding;
|
|
170
|
-
//#endregion
|
|
171
|
-
export { AccountLookupResult, AccountParticipation, AccountResult, AccountStateDelta, AccountStatus, AppLocalState, ApplicationCreatedLookupResult, ApplicationLookupResult, ApplicationOnComplete, ApplicationParams, ApplicationResult, ApplicationTransactionResult, AssetBalancesLookupResult, AssetConfigTransactionResult, AssetFreezeTransactionResult, AssetHolding, AssetLookupResult, AssetParams, AssetResult, AssetTransferTransactionResult, AssetsCreatedLookupResult, AssetsLookupResult, EvalDelta, EvalDeltaKeyValue, KeyRegistrationTransactionResult, LogicTransactionSignature, LookupAssetHoldingsOptions, MerkleArrayProof, MiniAssetHolding, MultisigTransactionSignature, MultisigTransactionSubSignature, PaymentTransactionResult, SignatureType, StateDelta, StateProofTransactionResult, StateSchema, TransactionLookupResult, TransactionResult, TransactionSearchResults, TransactionSignature };
|
|
172
|
-
//# sourceMappingURL=indexer.d.ts.map
|
|
168
|
+
export type MiniAssetHolding = indexerModels.MiniAssetHolding;
|
package/types/instance-of.d.ts
CHANGED
|
@@ -1,8 +1,6 @@
|
|
|
1
|
-
//#region src/types/instance-of.d.ts
|
|
2
1
|
/**
|
|
3
2
|
* A type that represents the interface of the class given as the generic parameter
|
|
4
3
|
*/
|
|
5
|
-
type InterfaceOf<ClassType> = {
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
//# sourceMappingURL=instance-of.d.ts.map
|
|
4
|
+
export type InterfaceOf<ClassType> = {
|
|
5
|
+
[Member in keyof ClassType]: ClassType[Member];
|
|
6
|
+
};
|