algosdk 1.15.0 → 1.16.0

package/dist/types/src/client/v2/indexer/searchForApplications.d.ts

@@ -1,9 +1,110 @@
 import JSONRequest from '../jsonrequest';
+/**
+ * Returns information about indexed applications.
+ *
+ * #### Example
+ * ```typescript
+ * const apps = await indexerClient.searchForApplications().do();
+ * ```
+ *
+ * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2applications)
+ * @category GET
+ */
 export default class SearchForApplications extends JSONRequest {
+    /**
+     * @returns `/v2/applications`
+     */
     path(): string;
+    /**
+     * Application ID for filter, as int
+     *
+     * #### Example
+     * ```typescript
+     * const appId = 60553466;
+     * const apps = await indexerClient
+     *        .searchForApplications()
+     *        .index(appId)
+     *        .do();
+     * ```
+     * @remarks Alternatively, use `indexerClient.lookupApplications(appId).do()`
+     * @param index
+     * @category query
+     */
     index(index: number): this;
+    /**
+     * Creator for filter, as string
+     *
+     * #### Example
+     * ```typescript
+     * const creator = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const apps = await indexerClient
+     *        .searchForApplications()
+     *        .creator(creator)
+     *        .do();
+     * ```
+     * @param creator
+     * @category query
+     */
     creator(creator: string): this;
+    /**
+     * Specify the next page of results.
+     *
+     * #### Example
+     * ```typescript
+     * const maxResults = 20;
+     *
+     * const appsPage1 = await indexerClient
+     *        .searchForApplications()
+     *        .limit(maxResults)
+     *        .do();
+     *
+     * const appsPage2 = await indexerClient
+     *        .searchForApplications()
+     *        .limit(maxResults)
+     *        .nextToken(appsPage1["next-token"])
+     *        .do();
+     * ```
+     * @param nextToken - provided by the previous results.
+     * @category query
+     */
     nextToken(next: string): this;
+    /**
+     * Limit results for pagination.
+     *
+     * #### Example
+     * ```typescript
+     * const maxResults = 20;
+     * const apps = await indexerClient
+     *        .searchForApplications()
+     *        .limit(maxResults)
+     *        .do();
+     * ```
+     *
+     * @param limit - maximum number of results to return.
+     * @category query
+     */
     limit(limit: number): this;
+    /**
+     * Includes all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates
+     *
+     * #### Example 1
+     * ```typescript
+     * const apps = await indexerClient
+     *        .searchForApplications()
+     *        .includeAll(false)
+     *        .do();
+     * ```
+     *
+     * #### Example 2
+     * ```typescript
+     * const apps = await indexerClient
+     *        .searchForApplications()
+     *        .includeAll()
+     *        .do();
+     * ```
+     *
+     * @param value - default true when called without passing a value
+     * @category query
+     */
     includeAll(value?: boolean): this;
 }

package/dist/types/src/client/v2/indexer/searchForAssets.d.ts

@@ -1,11 +1,143 @@
 import JSONRequest from '../jsonrequest';
+/**
+ * Returns information about indexed assets.
+ *
+ * #### Example
+ * ```typescript
+ * const assets = await indexerClient.searchForAssets().do();
+ * ```
+ *
+ * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2assets)
+ * @category GET
+ */
 export default class SearchForAssets extends JSONRequest {
+    /**
+     * @returns `/v2/assets`
+     */
     path(): string;
+    /**
+     * Limit results for pagination.
+     *
+     * #### Example
+     * ```typescript
+     * const maxResults = 20;
+     * const assets = await indexerClient
+     *        .searchForAssets()
+     *        .limit(maxResults)
+     *        .do();
+     * ```
+     *
+     * @param limit - maximum number of results to return.
+     * @category query
+     */
     limit(limit: number): this;
+    /**
+     * Filter just assets with the given creator address.
+     *
+     * #### Example
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const assets = await indexerClient
+     *        .searchForAssets()
+     *        .creator(address)
+     *        .do();
+     * ```
+     *
+     * @param creator
+     * @category query
+     */
     creator(creator: string): this;
+    /**
+     * Filter just assets with the given name.
+     *
+     * #### Example
+     * ```typescript
+     * const name = "Test Token";
+     * const assets = await indexerClient
+     *        .searchForAssets()
+     *        .name(name)
+     *        .do();
+     * ```
+     *
+     * @param name
+     * @category query
+     */
     name(name: string): this;
+    /**
+     * Filter just assets with the given unit.
+     *
+     * #### Example
+     * ```typescript
+     * const unit = "test";
+     * const assets = await indexerClient
+     *        .searchForAssets()
+     *        .unit(unit)
+     *        .do();
+     * ```
+     *
+     * @param unit
+     * @category query
+     */
     unit(unit: string): this;
+    /**
+     * Asset ID for filter, as int.
+     *
+     * #### Example
+     * ```typescript
+     * const assetId = 163650;
+     * const assets = await indexerClient
+     *        .searchForAssets()
+     *        .index(assetId)
+     *        .do();
+     * ```
+     * @remarks Alternatively, use `indexerClient.lookupAssetByID(assetId).do();`
+     * @param index
+     * @category query
+     */
     index(index: number): this;
+    /**
+     * Specify the next page of results.
+     *
+     * #### Example
+     * ```typescript
+     * const maxResults = 20;
+     *
+     * const assetsPage1 = await indexerClient
+     *        .searchForAssets()
+     *        .limit(maxResults)
+     *        .do();
+     *
+     * const assetsPage2 = await indexerClient
+     *        .searchForAssets()
+     *        .limit(maxResults)
+     *        .nextToken(assetsPage1["next-token"])
+     *        .do();
+     * ```
+     * @param nextToken - provided by the previous results.
+     * @category query
+     */
     nextToken(nextToken: string): this;
+    /**
+     * Includes all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates
+     *
+     * #### Example 1
+     * ```typescript
+     * const assets = await indexerClient
+     *        .searchForAssets()
+     *        .includeAll(false)
+     *        .do();
+     * ```
+     *
+     * #### Example 2
+     * ```typescript
+     * const assets = await indexerClient
+     *        .searchForAssets()
+     *        .includeAll()
+     *        .do();
+     * ```
+     *
+     * @param value - default true when called without passing a value
+     * @category query
+     */
     includeAll(value?: boolean): this;
 }

package/dist/types/src/client/v2/indexer/searchForTransactions.d.ts

@@ -1,27 +1,354 @@
 import JSONRequest from '../jsonrequest';
+/**
+ * Returns information about indexed transactions.
+ *
+ * #### Example
+ * ```typescript
+ * const txns = await indexerClient.searchForTransactions().do();
+ * ```
+ *
+ * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2transactions)
+ * @category GET
+ */
 export default class SearchForTransactions extends JSONRequest {
+    /**
+     * @returns `/v2/transactions`
+     */
     path(): string;
     /**
-     * notePrefix to filter with
+     * Specifies a prefix which must be contained in the note field.
+     *
+     * #### Example
+     * ```typescript
+     * const notePrefixBase64Encoded = "Y3JlYXRl";
+     * const txns = await indexerClient
+     *        .searchForTransactions()
+     *        .notePrefix(notePrefixBase64Encoded)
+     *        .do();
+     * ```
+     *
      * @param prefix - base64 string or uint8array
+     * @category query
      */
     notePrefix(prefix: Uint8Array | string): this;
+    /**
+     * Type of transaction to filter with.
+     *
+     * #### Example
+     * ```typescript
+     * const txns = await indexerClient
+     *        .searchForTransactions()
+     *        .txType("keyreg")
+     *        .do();
+     * ```
+     *
+     * @param type - one of `pay`, `keyreg`, `acfg`, `axfer`, `afrz`, `appl`
+     * @category query
+     */
     txType(type: string): this;
+    /**
+     * Type of signature to filter with.
+     * - sig: Standard
+     * - msig: MultiSig
+     * - lsig: LogicSig
+     *
+     * #### Example
+     * ```typescript
+     * const txns = await indexerClient
+     *        .searchForTransactions()
+     *        .sigType("sig")
+     *        .do();
+     * ```
+     *
+     * @param type - one of `sig`, `msig`, `lsig`
+     * @category query
+     */
     sigType(type: string): this;
+    /**
+     * Lookup the specific transaction by ID.
+     *
+     * #### Example
+     * ```typescript
+     * const txId = "MEUOC4RQJB23CQZRFRKYEI6WBO73VTTPST5A7B3S5OKBUY6LFUDA";
+     * const txns = await indexerClient
+     *        .searchForTransactions()
+     *        .txid(txId)
+     *        .do();
+     * ```
+     * @remarks Alternatively, use `indexerClient.lookupTransactionByID(txnId).do()`
+     * @param txid
+     * @category query
+     */
     txid(txid: string): this;
+    /**
+     * Include results for the specified round.
+     *
+     * #### Example
+     * ```typescript
+     * const targetBlock = 18309917;
+     * const txns = await indexerClient
+     *        .searchForTransactions()
+     *        .round(targetBlock)
+     *        .do();
+     * ```
+     * @remarks Alternatively, use `indexerClient.lookupBlock(targetBlock).do()`
+     * @param round
+     * @category query
+     */
     round(round: number): this;
+    /**
+     * Include results at or after the specified min-round.
+     *
+     * #### Example
+     * ```typescript
+     * const minRound = 18309917;
+     * const txns = await indexerClient
+     *        .searchForTransactions()
+     *        .minRound(minRound)
+     *        .do();
+     * ```
+     *
+     * @param round
+     * @category query
+     */
     minRound(round: number): this;
+    /**
+     * Include results at or before the specified max-round.
+     *
+     * #### Example
+     * ```typescript
+     * const maxRound = 18309917;
+     * const txns = await indexerClient
+     *        .searchForTransactions()
+     *        .maxRound(maxRound)
+     *        .do();
+     * ```
+     *
+     * @param round
+     * @category query
+     */
     maxRound(round: number): this;
+    /**
+     * Asset ID to filter with.
+     *
+     * #### Example
+     * ```typescript
+     * const assetID = 163650;
+     * const txns = await indexerClient
+     *        .searchForTransactions()
+     *        .assetID(assetID)
+     *        .do();
+     * ```
+     * @remarks Alternatively, use `indexerClient.lookupAssetTransactions(assetId).do()`
+     * @param id
+     * @category query
+     */
     assetID(id: number): this;
+    /**
+     * Maximum number of results to return.
+     *
+     * #### Example
+     * ```typescript
+     * const maxResults = 25;
+     * const txns = await indexerClient
+     *        .searchForTransactions()
+     *        .limit(maxResults)
+     *        .do();
+     * ```
+     *
+     * @param limit
+     * @category query
+     */
     limit(limit: number): this;
+    /**
+     * Include results before the given time.
+     *
+     * #### Example
+     * ```typescript
+     * const beforeTime = "2022-02-02T20:20:22.02Z";
+     * const txns = await indexerClient
+     *        .searchForTransactions()
+     *        .beforeTime(beforeTime)
+     *        .do();
+     * ```
+     *
+     * @param before - rfc3339 string
+     * @category query
+     */
     beforeTime(before: string): this;
+    /**
+     * Include results after the given time.
+     *
+     * #### Example
+     * ```typescript
+     * const afterTime = "2022-10-21T00:00:11.55Z";
+     * const txns = await indexerClient
+     *        .searchForTransactions()
+     *        .afterTime(afterTime)
+     *        .do();
+     * ```
+     *
+     * @param after - rfc3339 string
+     * @category query
+     */
     afterTime(after: string): this;
+    /**
+     * Filtered results should have an amount greater than this value, as int, representing microAlgos, unless an asset-id is provided, in which case units are in the asset's units.
+     *
+     * #### Example 1
+     * ```typescript
+     * const minBalance = 300000;
+     * const txns = await indexerClient
+     *        .searchForTransactions()
+     *        .currencyGreaterThan(minBalance - 1)
+     *        .do();
+     * ```
+     *
+     * #### Example 2
+     * ```typescript
+     * const assetID = 163650;
+     * const minBalance = 300000;
+     * const txns = await indexerClient
+     *        .searchForTransactions()
+     *        .assetID(assetID)
+     *        .currencyGreaterThan(minBalance - 1)
+     *        .do();
+     * ```
+     * @remarks
+     * If you are looking for transactions with the currency amount greater than 0, simply construct the query without `currencyGreaterThan` because it doesn't accept `-1`, and passing the `0` `currency-greater-than` value would exclude transactions with a 0 amount.
+     *
+     * @param greater
+     * @category query
+     */
     currencyGreaterThan(greater: number): this;
+    /**
+     * Filtered results should have an amount less than this value, as int, representing microAlgos, unless an asset-id is provided, in which case units are in the asset's units.
+     *
+     * #### Example 1
+     * ```typescript
+     * const maxBalance = 500000;
+     * const txns = await indexerClient
+     *        .searchForTransactions()
+     *        .currencyLessThan(maxBalance + 1)
+     *        .do();
+     * ```
+     *
+     * #### Example 2
+     * ```typescript
+     * const assetID = 163650;
+     * const maxBalance = 500000;
+     * const txns = await indexerClient
+     *        .searchForTransactions()
+     *        .assetID(assetID)
+     *        .currencyLessThan(maxBalance + 1)
+     *        .do();
+     * ```
+     *
+     * @param lesser
+     * @category query
+     */
     currencyLessThan(lesser: number): this;
+    /**
+     * Combined with address, defines what address to filter on, as string.
+     *
+     * #### Example
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const role = "freeze-target";
+     * const txns = await indexerClient
+     *        .searchForTransactions()
+     *        .address(address)
+     *        .addressRole(role)
+     *        .do();
+     * ```
+     *
+     * @param role - one of `sender`, `receiver`, `freeze-target`
+     * @category query
+     */
     addressRole(role: string): this;
+    /**
+     * Only include transactions with this address in one of the transaction fields.
+     *
+     * #### Example
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const txns = await indexerClient
+     *        .searchForTransactions()
+     *        .address(address)
+     *        .do();
+     * ```
+     * @remarks Alternatively, use `indexerClient.lookupAccountTransactions(address).do()`
+     * @param address
+     * @category query
+     */
     address(address: string): this;
+    /**
+     * Whether or not to consider the `close-to` field as a receiver when filtering transactions, as bool. Set to `true` to ignore `close-to`.
+     *
+     * #### Example
+     * ```typescript
+     * const txns = await indexerClient
+     *        .searchForTransactions()
+     *        .excludeCloseTo(true)
+     *        .do();
+     * ```
+     *
+     * @param exclude
+     * @category query
+     */
     excludeCloseTo(exclude: boolean): this;
+    /**
+     * The next page of results.
+     *
+     * #### Example
+     * ```typescript
+     * const maxResults = 25;
+     *
+     * const txnsPage1 = await indexerClient
+     *        .searchForTransactions()
+     *        .limit(maxResults)
+     *        .do();
+     *
+     * const txnsPage2 = await indexerClient
+     *        .searchForTransactions()
+     *        .limit(maxResults)
+     *        .nextToken(txnsPage1["next-token"])
+     *        .do();
+     * ```
+     *
+     * @param nextToken - provided by the previous results
+     * @category query
+     */
     nextToken(nextToken: string): this;
+    /**
+     * Whether or not to include rekeying transactions.
+     *
+     * #### Example
+     * ```typescript
+     * const txns = await indexerClient
+     *        .searchForTransactions()
+     *        .rekeyTo(false)
+     *        .do();
+     * ```
+     *
+     * @param rekeyTo
+     * @category query
+     */
     rekeyTo(rekeyTo: boolean): this;
+    /**
+     * Filter for this application.
+     *
+     * #### Example
+     * ```typescript
+     * const appId = 60553466;
+     * const txns = await indexerClient
+     *        .searchForTransactions()
+     *        .applicationID(appId)
+     *        .do();
+     * ```
+     *
+     * @param applicationID
+     * @category query
+     */
     applicationID(applicationID: number): this;
 }

package/dist/types/src/dryrun.d.ts

@@ -1,5 +1,5 @@
 import AlgodClient from './client/v2/algod/algod';
-import { DryrunRequest, DryrunSource } from './client/v2/algod/models/types';
+import { AccountStateDelta, DryrunRequest, DryrunSource, EvalDeltaKeyValue, TealValue } from './client/v2/algod/models/types';
 import { SignedTransaction } from './transaction';
 /**
  * createDryrun takes an Algod Client (from algod.AlgodV2Client) and an array of Signed Transactions
@@ -18,3 +18,83 @@ export declare function createDryrun({ client, txns, protocolVersion, latestTime
     round?: number | bigint;
     sources?: DryrunSource[];
 }): Promise<DryrunRequest>;
+interface StackValueResponse {
+    type: number;
+    bytes: string;
+    uint: number;
+}
+declare class DryrunStackValue {
+    type: number;
+    bytes: string;
+    uint: number;
+    constructor(sv: StackValueResponse);
+    toString(): string;
+}
+interface DryrunTraceLineResponse {
+    error: string;
+    line: number;
+    pc: number;
+    scratch: TealValue[];
+    stack: StackValueResponse[];
+}
+declare class DryrunTraceLine {
+    error: string;
+    line: number;
+    pc: number;
+    scratch: TealValue[];
+    stack: DryrunStackValue[];
+    constructor(line: DryrunTraceLineResponse);
+}
+declare class DryrunTrace {
+    trace: DryrunTraceLine[];
+    constructor(t: DryrunTraceLineResponse[]);
+}
+interface DryrunTransactionResultResponse {
+    disassembly: string[];
+    appCallMessages: string[] | undefined;
+    localDeltas: AccountStateDelta[] | undefined;
+    globalDelta: EvalDeltaKeyValue[] | undefined;
+    cost: number | undefined;
+    logicSigMessages: string[] | undefined;
+    logicSigDisassembly: string[] | undefined;
+    logs: string[] | undefined;
+    appCallTrace: DryrunTrace | undefined;
+    logicSigTrace: DryrunTrace | undefined;
+}
+interface StackPrinterConfig {
+    maxValueWidth: number | undefined;
+    topOfStackFirst: boolean | undefined;
+}
+declare class DryrunTransactionResult {
+    disassembly: string[];
+    appCallMessages: string[] | undefined;
+    localDeltas: AccountStateDelta[] | undefined;
+    globalDelta: EvalDeltaKeyValue[] | undefined;
+    cost: number | undefined;
+    logicSigMessages: string[] | undefined;
+    logicSigDisassembly: string[] | undefined;
+    logs: string[] | undefined;
+    appCallTrace: DryrunTrace | undefined;
+    logicSigTrace: DryrunTrace | undefined;
+    required: string[];
+    optionals: string[];
+    traces: string[];
+    constructor(dtr: DryrunTransactionResultResponse);
+    appCallRejected(): boolean;
+    logicSigRejected(): boolean;
+    static trace(drt: DryrunTrace, disassembly: string[], spc: StackPrinterConfig): string;
+    appTrace(spc?: StackPrinterConfig): string;
+    lsigTrace(spc?: StackPrinterConfig): string;
+}
+interface DryrunResultResponse {
+    ['error']: string;
+    ['protocol-version']: string;
+    ['txns']: DryrunTransactionResultResponse[];
+}
+export declare class DryrunResult {
+    error: string;
+    protocolVersion: string;
+    txns: DryrunTransactionResult[];
+    constructor(drrResp: DryrunResultResponse);
+}
+export {};