algosdk 1.11.1 → 1.13.0

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

@@ -1,5 +1,4 @@
 import ServiceClient from '../serviceClient';
-import { CustomTokenHeader, IndexerTokenHeader } from '../../client';
 import MakeHealthCheck from './makeHealthCheck';
 import LookupAssetBalances from './lookupAssetBalances';
 import LookupAssetTransactions from './lookupAssetTransactions';
@@ -9,70 +8,235 @@ import LookupTransactionByID from './lookupTransactionByID';
 import LookupAccountByID from './lookupAccountByID';
 import LookupAssetByID from './lookupAssetByID';
 import LookupApplications from './lookupApplications';
+import LookupApplicationLogs from './lookupApplicationLogs';
 import SearchAccounts from './searchAccounts';
 import SearchForTransactions from './searchForTransactions';
 import SearchForAssets from './searchForAssets';
 import SearchForApplications from './searchForApplications';
+import { BaseHTTPClient } from '../../baseHTTPClient';
+import { CustomTokenHeader, IndexerTokenHeader } from '../../urlTokenBaseHTTPClient';
+/**
+ * The Indexer provides a REST API interface of API calls to support searching the Algorand Blockchain.
+ *
+ * The Indexer REST APIs retrieve the blockchain data from a PostgreSQL compatible database that must be populated.
+ *
+ * This database is populated using the same indexer instance or a separate instance of the indexer which must connect to the algod process of a running Algorand node to read block data.
+ *
+ * This node must also be an Archival node to make searching the entire blockchain possible.
+ *
+ * #### Relevant Information
+ * [Learn more about Indexer](https://developer.algorand.org/docs/get-details/indexer/)
+ *
+ * [Run Indexer in Postman OAS3](https://developer.algorand.org/docs/rest-apis/restendpoints/#algod-indexer-and-kmd-rest-endpoints)
+ */
 export default class IndexerClient extends ServiceClient {
-    constructor(token: string | IndexerTokenHeader | CustomTokenHeader, baseServer?: string, port?: string | number, headers?: {});
+    /**
+     * Create an IndexerClient from
+     * * either a token, baseServer, port, and optional headers
+     * * or a base client server for interoperability with external dApp wallets
+     *
+     * #### Example
+     * ```typescript
+     * const token  = "";
+     * const server = "http://localhost";
+     * const port   = 8980;
+     * const indexerClient = new algosdk.Indexer(token, server, port);
+     * ```
+     * @remarks
+     * The above configuration is for a sandbox private network.
+     * For applications on production, you are encouraged to run your own node with indexer, or use an Algorand REST API provider with a dedicated API key.
+     *
+     * @param tokenOrBaseClient - The API token for the Indexer API
+     * @param baseServer - REST endpoint
+     * @param port - Port number if specifically configured by the server
+     * @param headers - Optional headers
+     */
+    constructor(tokenOrBaseClient: string | IndexerTokenHeader | CustomTokenHeader | BaseHTTPClient, baseServer?: string, port?: string | number, headers?: Record<string, string>);
     /**
      * Returns the health object for the service.
+     * Returns 200 if healthy.
+     *
+     * #### Example
+     * ```typescript
+     * const health = await indexerClient.makeHealthCheck().do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-health)
+     * @category GET
      */
     makeHealthCheck(): MakeHealthCheck;
     /**
-     * Returns holder balances for the given asset.
+     * Returns the list of accounts who hold the given asset and their balance.
+     *
+     * #### Example
+     * ```typescript
+     * const assetId = 163650;
+     * const assetBalances = await indexerClient.lookupAssetBalances(assetId).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2assetsasset-idbalances)
      * @param index - The asset ID to look up.
+     * @category GET
      */
     lookupAssetBalances(index: number): LookupAssetBalances;
     /**
      * Returns transactions relating to the given asset.
+     *
+     * #### Example
+     * ```typescript
+     * const assetId = 163650;
+     * const assetTxns = await indexerClient.lookupAssetTransactions(assetId).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2assetsasset-idtransactions)
      * @param index - The asset ID to look up.
+     * @category GET
      */
     lookupAssetTransactions(index: number): LookupAssetTransactions;
     /**
      * Returns transactions relating to the given account.
+     *
+     * #### Example
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient.lookupAccountTransactions(address).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2accountsaccount-idtransactions)
      * @param account - The address of the account.
+     * @category GET
      */
     lookupAccountTransactions(account: string): LookupAccountTransactions;
     /**
      * Returns the block for the passed round.
+     *
+     * #### Example
+     * ```typescript
+     * const targetBlock = 18309917;
+     * const blockInfo = await indexerClient.lookupBlock(targetBlock).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2blocksround-number)
      * @param round - The number of the round to look up.
+     * @category GET
      */
     lookupBlock(round: number): LookupBlock;
     /**
      * Returns information about the given transaction.
+     *
+     * #### Example
+     * ```typescript
+     * const txnId = "MEUOC4RQJB23CQZRFRKYEI6WBO73VTTPST5A7B3S5OKBUY6LFUDA";
+     * const txnInfo = await indexerClient.lookupTransactionByID(txnId).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2transactionstxid)
      * @param txID - The ID of the transaction to look up.
+     * @category GET
      */
     lookupTransactionByID(txID: string): LookupTransactionByID;
     /**
      * Returns information about the given account.
+     *
+     * #### Example
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountInfo = await indexerClient.lookupAccountByID(address).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2accountsaccount-id)
      * @param account - The address of the account to look up.
+     * @category GET
      */
     lookupAccountByID(account: string): LookupAccountByID;
     /**
      * Returns information about the passed asset.
+     *
+     * #### Example
+     * ```typescript
+     * const assetId = 163650;
+     * const assetInfo = await indexerClient.lookupAssetByID(assetId).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2assetsasset-id)
      * @param index - The ID of the asset ot look up.
+     * @category GET
      */
     lookupAssetByID(index: number): LookupAssetByID;
     /**
      * Returns information about the passed application.
+     *
+     * #### Example
+     * ```typescript
+     * const appId = 60553466;
+     * const appInfo = await indexerClient.lookupApplications(appId).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2applicationsapplication-id)
      * @param index - The ID of the application to look up.
+     * @category GET
      */
     lookupApplications(index: number): LookupApplications;
+    /**
+     * Returns log messages generated by the passed in application.
+     *
+     * #### Example
+     * ```typescript
+     * const appId = 60553466;
+     * const appLogs = await indexerClient.lookupApplicationLogs(appId).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2applicationsapplication-idlogs)
+     * @param appID - The ID of the application which generated the logs.
+     * @category GET
+     */
+    lookupApplicationLogs(appID: number): LookupApplicationLogs;
     /**
      * Returns information about indexed accounts.
+     *
+     * #### Example
+     * ```typescript
+     * const accounts = await indexerClient.searchAccounts().do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2accounts)
+     * @category GET
      */
     searchAccounts(): SearchAccounts;
     /**
      * 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
      */
     searchForTransactions(): SearchForTransactions;
     /**
      * 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
      */
     searchForAssets(): SearchForAssets;
     /**
      * 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
      */
     searchForApplications(): SearchForApplications;
 }

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

@@ -0,0 +1,20 @@
+import JSONRequest from '../jsonrequest';
+import HTTPClient from '../../client';
+import IntDecoding from '../../../types/intDecoding';
+export default class LookupApplicationLogs extends JSONRequest {
+    private appID;
+    constructor(c: HTTPClient, intDecoding: IntDecoding, appID: number);
+    path(): string;
+    /** limit for filter, as int */
+    limit(limit: number): this;
+    /** min round to filter with, as int */
+    minRound(round: number): this;
+    /** max round to filter with, as int */
+    maxRound(round: number): this;
+    /** used for pagination */
+    nextToken(nextToken: string): this;
+    /** only include transactions with this sender address */
+    sender(senderAddress: string): this;
+    /** txid to filter with, as string */
+    txid(txid: string): this;
+}

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

@@ -3,12 +3,110 @@ import HTTPClient from '../../client';
 import IntDecoding from '../../../types/intDecoding';
 export default class LookupAssetBalances extends JSONRequest {
     private index;
+    /**
+     * Returns the list of accounts which hold the given asset and their balance.
+     *
+     * #### Example
+     * ```typescript
+     * const assetId = 163650;
+     * const assetBalances = await indexerClient.lookupAssetBalances(assetId).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2assetsasset-idbalances)
+     * @param index - The asset ID to look up.
+     */
     constructor(c: HTTPClient, intDecoding: IntDecoding, index: number);
     path(): string;
+    /**
+     * Add a limit for filter.
+     *
+     * #### Example
+     * ```typescript
+     * const assetId = 163650;
+     * const maxResults = 20;
+     * const assetBalances = await indexerClient
+     *        .lookupAssetBalances(assetId)
+     *        .limit(maxResults)
+     *        .do();
+     * ```
+     *
+     * @param limit - maximum number of results to return.
+     */
     limit(limit: number): this;
+    /**
+     * Specify round to filter with.
+     *
+     * #### Example
+     * ```typescript
+     * const assetId = 163650;
+     * const targetBlock = 18309917;
+     * const assetBalances = await indexerClient
+     *        .lookupAssetBalances(assetId)
+     *        .round(targetBlock)
+     *        .do();
+     * ```
+     * @param round
+     */
     round(round: number): this;
+    /**
+     * Filtered results should have an asset balance greater than this value.
+     *
+     * #### Example
+     * ```typescript
+     * const assetId = 163650;
+     * const minBalance = 1000000;
+     * const assetBalances = await indexerClient
+     *        .lookupAssetBalances(assetId)
+     *        .currencyGreaterThan(minBalance)
+     *        .do();
+     * ```
+     * @param greater
+     */
     currencyGreaterThan(greater: number): this;
+    /**
+     * Filtered results should have an asset balance less than this value.
+     *
+     * #### Example
+     * ```typescript
+     * const assetId = 163650;
+     * const maxBalance = 2000000;
+     * const assetBalances = await indexerClient
+     *        .lookupAssetBalances(assetId)
+     *        .currencyLessThan(maxBalance)
+     *        .do();
+     * ```
+     * @param lesser
+     */
     currencyLessThan(lesser: number): this;
+    /**
+     * Specify the next page of results.
+     *
+     * #### Example
+     * ```typescript
+     * const assetId = 163650;
+     * const maxResults = 20;
+     * const nextToken = "APA6C7C3NCANRPIBUWQOF7WSKLJMK6RPQUVFLLDV4U5WCQE4DEF26D4E3E";
+     * const assetBalances = await indexerClient
+     *        .lookupAssetBalances(assetId)
+     *        .limit(maxResults)
+     *        .next(nextToken)
+     *        .do();
+     * ```
+     * @param nextToken - provided by the previous results.
+     */
     nextToken(nextToken: string): this;
+    /**
+     * Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates
+     *
+     * #### Example
+     * ```typescript
+     * const assetId = 163650;
+     * const assetBalances = await indexerClient
+     *        .lookupAssetBalances(assetId)
+     *        .includeAll(false)
+     *        .do();
+     * ```
+     * @param value
+     */
     includeAll(value?: boolean): this;
 }

package/dist/types/src/client/v2/serviceClient.d.ts

@@ -1,13 +1,17 @@
-import HTTPClient, { TokenHeader } from '../client';
+import HTTPClient from '../client';
 import IntDecoding from '../../types/intDecoding';
+import { BaseHTTPClient } from '../baseHTTPClient';
+import { TokenHeader } from '../urlTokenBaseHTTPClient';
 export declare type TokenHeaderIdentifier = 'X-Indexer-API-Token' | 'X-KMD-API-Token' | 'X-Algo-API-Token' | string;
 /**
  * Abstract service client to encapsulate shared AlgodClient and IndexerClient logic
  */
 export default abstract class ServiceClient {
+    /** @ignore */
     c: HTTPClient;
+    /** @ignore */
     intDecoding: IntDecoding;
-    constructor(tokenHeaderIdentifier: TokenHeaderIdentifier, tokenHeaderOrStr: string | TokenHeader, baseServer: string, port?: string | number, defaultHeaders?: Record<string, any>);
+    constructor(tokenHeaderIdentifier: TokenHeaderIdentifier, tokenHeaderOrStrOrBaseClient: string | TokenHeader | BaseHTTPClient, baseServer: string, port?: string | number, defaultHeaders?: Record<string, any>);
     /**
      * Set the default int decoding method for all JSON requests this client creates.
      * @param method - \{"default" | "safe" | "mixed" | "bigint"\} method The method to use when parsing the

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

@@ -0,0 +1,160 @@
+import { ABIValue, ABIMethod } from './abi';
+import Algodv2 from './client/v2/algod/algod';
+import { TransactionSigner, TransactionWithSigner } from './signer';
+import { OnApplicationComplete, SuggestedParams } from './types/transactions/base';
+export declare type ABIArgument = ABIValue | TransactionWithSigner;
+/** Represents the output from a successful ABI method call. */
+export interface ABIResult {
+    /** The TxID of the transaction that invoked the ABI method call. */
+    txID: string;
+    /**
+     * The raw bytes of the return value from the ABI method call. This will be empty if the method
+     * does not return a value (return type "void").
+     */
+    rawReturnValue: Uint8Array;
+    /**
+     * The return value from the ABI method call. This will be undefined if the method does not return
+     * a value (return type "void"), or if the SDK was unable to decode the returned value.
+     */
+    returnValue?: ABIValue;
+    /** If the SDK was unable to decode a return value, the error will be here. */
+    decodeError?: Error;
+}
+export declare enum AtomicTransactionComposerStatus {
+    /** The atomic group is still under construction. */
+    BUILDING = 0,
+    /** The atomic group has been finalized, but not yet signed. */
+    BUILT = 1,
+    /** The atomic group has been finalized and signed, but not yet submitted to the network. */
+    SIGNED = 2,
+    /** The atomic group has been finalized, signed, and submitted to the network. */
+    SUBMITTED = 3,
+    /** The atomic group has been finalized, signed, submitted, and successfully committed to a block. */
+    COMMITTED = 4
+}
+/** A class used to construct and execute atomic transaction groups */
+export declare class AtomicTransactionComposer {
+    /** The maximum size of an atomic transaction group. */
+    static MAX_GROUP_SIZE: number;
+    private status;
+    private transactions;
+    private methodCalls;
+    private signedTxns;
+    private txIDs;
+    /**
+     * Get the status of this composer's transaction group.
+     */
+    getStatus(): AtomicTransactionComposerStatus;
+    /**
+     * Get the number of transactions currently in this atomic group.
+     */
+    count(): number;
+    /**
+     * Create a new composer with the same underlying transactions. The new composer's status will be
+     * BUILDING, so additional transactions may be added to it.
+     */
+    clone(): AtomicTransactionComposer;
+    /**
+     * Add a transaction to this atomic group.
+     *
+     * An error will be thrown if the transaction has a nonzero group ID, the composer's status is
+     * not BUILDING, or if adding this transaction causes the current group to exceed MAX_GROUP_SIZE.
+     */
+    addTransaction(txnAndSigner: TransactionWithSigner): void;
+    /**
+     * Add a smart contract method call to this atomic group.
+     *
+     * An error will be thrown if the composer's status is not BUILDING, if adding this transaction
+     * causes the current group to exceed MAX_GROUP_SIZE, or if the provided arguments are invalid
+     * for the given method.
+     */
+    addMethodCall({ appID, method, methodArgs, sender, suggestedParams, onComplete, approvalProgram, clearProgram, numGlobalInts, numGlobalByteSlices, numLocalInts, numLocalByteSlices, extraPages, note, lease, rekeyTo, signer, }: {
+        /** The ID of the smart contract to call. Set this to 0 to indicate an application creation call. */
+        appID: number;
+        /** The method to call on the smart contract */
+        method: ABIMethod;
+        /** The arguments to include in the method call. If omitted, no arguments will be passed to the method. */
+        methodArgs?: ABIArgument[];
+        /** The address of the sender of this application call */
+        sender: string;
+        /** Transactions params to use for this application call */
+        suggestedParams: SuggestedParams;
+        /** The OnComplete action to take for this application call. If omitted, OnApplicationComplete.NoOpOC will be used. */
+        onComplete?: OnApplicationComplete;
+        /** The approval program for this application call. Only set this if this is an application creation call, or if onComplete is OnApplicationComplete.UpdateApplicationOC */
+        approvalProgram?: Uint8Array;
+        /** The clear program for this application call. Only set this if this is an application creation call, or if onComplete is OnApplicationComplete.UpdateApplicationOC */
+        clearProgram?: Uint8Array;
+        /** The global integer schema size. Only set this if this is an application creation call. */
+        numGlobalInts?: number;
+        /** The global byte slice schema size. Only set this if this is an application creation call. */
+        numGlobalByteSlices?: number;
+        /** The local integer schema size. Only set this if this is an application creation call. */
+        numLocalInts?: number;
+        /** The local byte slice schema size. Only set this if this is an application creation call. */
+        numLocalByteSlices?: number;
+        /** The number of extra pages to allocate for the application's programs. Only set this if this is an application creation call. If omitted, defaults to 0. */
+        extraPages?: number;
+        /** The note value for this application call */
+        note?: Uint8Array;
+        /** The lease value for this application call */
+        lease?: Uint8Array;
+        /** If provided, the address that the sender will be rekeyed to at the conclusion of this application call */
+        rekeyTo?: string;
+        /** A transaction signer that can authorize this application call from sender */
+        signer: TransactionSigner;
+    }): void;
+    /**
+     * Finalize the transaction group and returned the finalized transactions.
+     *
+     * The composer's status will be at least BUILT after executing this method.
+     */
+    buildGroup(): TransactionWithSigner[];
+    /**
+     * Obtain signatures for each transaction in this group. If signatures have already been obtained,
+     * this method will return cached versions of the signatures.
+     *
+     * The composer's status will be at least SIGNED after executing this method.
+     *
+     * An error will be thrown if signing any of the transactions fails.
+     *
+     * @returns A promise that resolves to an array of signed transactions.
+     */
+    gatherSignatures(): Promise<Uint8Array[]>;
+    /**
+     * Send the transaction group to the network, but don't wait for it to be committed to a block. An
+     * error will be thrown if submission fails.
+     *
+     * The composer's status must be SUBMITTED or lower before calling this method. If submission is
+     * successful, this composer's status will update to SUBMITTED.
+     *
+     * Note: a group can only be submitted again if it fails.
+     *
+     * @param client - An Algodv2 client
+     *
+     * @returns A promise that, upon success, resolves to a list of TxIDs of the submitted transactions.
+     */
+    submit(client: Algodv2): Promise<string[]>;
+    /**
+     * Send the transaction group to the network and wait until it's committed to a block. An error
+     * will be thrown if submission or execution fails.
+     *
+     * The composer's status must be SUBMITTED or lower before calling this method, since execution is
+     * only allowed once. If submission is successful, this composer's status will update to SUBMITTED.
+     * If the execution is also successful, this composer's status will update to COMMITTED.
+     *
+     * Note: a group can only be submitted again if it fails.
+     *
+     * @param client - An Algodv2 client
+     * @param waitRounds - The maximum number of rounds to wait for transaction confirmation
+     *
+     * @returns A promise that, upon success, resolves to an object containing the confirmed round for
+     *   this transaction, the txIDs of the submitted transactions, and an array of results containing
+     *   one element for each method call transaction in this group.
+     */
+    execute(client: Algodv2, waitRounds: number): Promise<{
+        confirmedRound: number;
+        txIDs: string[];
+        methodResults: ABIResult[];
+    }>;
+}

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

@@ -0,0 +1,20 @@
+import AlgodClient from './client/v2/algod/algod';
+import { DryrunRequest, DryrunSource } from './client/v2/algod/models/types';
+import { SignedTransaction } from './transaction';
+/**
+ * createDryrun takes an Algod Client (from algod.AlgodV2Client) and an array of Signed Transactions
+ * from (transaction.SignedTransaction) and creates a DryrunRequest object with relevant balances
+ * @param client - the AlgodClient to make requests against
+ * @param txns - the array of SignedTransaction to use for generating the DryrunRequest object
+ * @param protocolVersion - the string representing the protocol version to use
+ * @param latestTimestamp - the timestamp
+ * @returns the DryrunRequest object constructed from the SignedTransactions passed
+ */
+export declare function createDryrun({ client, txns, protocolVersion, latestTimestamp, round, sources, }: {
+    client: AlgodClient;
+    txns: SignedTransaction[];
+    protocolVersion?: string;
+    latestTimestamp?: number | bigint;
+    round?: number | bigint;
+    sources?: DryrunSource[];
+}): Promise<DryrunRequest>;

package/dist/types/src/encoding/address.d.ts

@@ -49,3 +49,9 @@ export declare function fromMultisigPreImgAddrs({ version, threshold, addrs, }:
     threshold: number;
     addrs: string[];
 }): string;
+/**
+ * Get the escrow address of an application.
+ * @param appID - The ID of the application.
+ * @returns The address corresponding to that application's escrow account.
+ */
+export declare function getApplicationAddress(appID: number | bigint): string;

package/dist/types/src/encoding/bigint.d.ts

@@ -0,0 +1,14 @@
+/**
+ * bigIntToBytes converts a BigInt to a big-endian Uint8Array for encoding.
+ * @param bi - The bigint to convert.
+ * @param size - The size of the resulting byte array.
+ * @returns A byte array containing the big-endian encoding of the input bigint
+ */
+export declare function bigIntToBytes(bi: bigint | number, size: number): Uint8Array;
+/**
+ * bytesToBigInt produces a bigint from a binary representation.
+ *
+ * @param bytes - The Uint8Array to convert.
+ * @returns The bigint that was encoded in the input data.
+ */
+export declare function bytesToBigInt(bytes: Uint8Array): bigint;