algosdk 1.11.1 → 1.13.0

package/dist/types/src/client/urlTokenBaseHTTPClient.d.ts

@@ -0,0 +1,44 @@
+import { BaseHTTPClient, BaseHTTPClientResponse, Query } from './baseHTTPClient';
+export interface AlgodTokenHeader {
+    'X-Algo-API-Token': string;
+}
+export interface IndexerTokenHeader {
+    'X-Indexer-API-Token': string;
+}
+export interface KMDTokenHeader {
+    'X-KMD-API-Token': string;
+}
+export interface CustomTokenHeader {
+    [headerName: string]: string;
+}
+export declare type TokenHeader = AlgodTokenHeader | IndexerTokenHeader | KMDTokenHeader | CustomTokenHeader;
+/**
+ * Implementation of BaseHTTPClient that uses a URL and a token
+ * and make the REST queries using superagent.
+ * This is the default implementation of BaseHTTPClient.
+ */
+export declare class URLTokenBaseHTTPClient implements BaseHTTPClient {
+    private defaultHeaders;
+    private readonly baseURL;
+    private readonly tokenHeader;
+    constructor(tokenHeader: TokenHeader, baseServer: string, port?: string | number, defaultHeaders?: Record<string, any>);
+    /**
+     * Compute the URL for a path relative to the instance's address
+     * @param relativePath - A path string
+     * @returns A URL string
+     */
+    private addressWithPath;
+    /**
+     * Convert a superagent response to a valid BaseHTTPClientResponse
+     * Modify the superagent response
+     * @private
+     */
+    private static superagentToHTTPClientResponse;
+    /**
+     * Make a superagent error more readable. For more info, see https://github.com/visionmedia/superagent/issues/1074
+     */
+    private static formatSuperagentError;
+    get(relativePath: string, query?: Query<string>, requestHeaders?: Record<string, string>): Promise<BaseHTTPClientResponse>;
+    post(relativePath: string, data: Uint8Array, query?: Query<string>, requestHeaders?: Record<string, string>): Promise<BaseHTTPClientResponse>;
+    delete(relativePath: string, data: Uint8Array, query?: Query<string>, requestHeaders?: Record<string, string>): Promise<BaseHTTPClientResponse>;
+}

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

@@ -1,5 +1,4 @@
 import ServiceClient from '../serviceClient';
-import { AlgodTokenHeader, CustomTokenHeader } from '../../client';
 import * as modelsv2 from './models/types';
 import AccountInformation from './accountInformation';
 import Block from './block';
@@ -19,74 +18,329 @@ import Supply from './supply';
 import Versions from './versions';
 import Genesis from './genesis';
 import Proof from './proof';
+import { BaseHTTPClient } from '../../baseHTTPClient';
+import { AlgodTokenHeader, CustomTokenHeader } from '../../urlTokenBaseHTTPClient';
+/**
+ * Algod client connects an application to the Algorand blockchain. The algod client requires a valid algod REST endpoint IP address and algod token from an Algorand node that is connected to the network you plan to interact with.
+ *
+ * Algod is the main Algorand process for handling the blockchain. Messages between nodes are processed, the protocol steps are executed, and the blocks are written to disk. The algod process also exposes a REST API server that developers can use to communicate with the node and the network. Algod uses the data directory for storage and configuration information.
+ *
+ * #### Relevant Information
+ * [How do I obtain an algod address and token?](https://developer.algorand.org/docs/archive/build-apps/setup/?from_query=algod#how-do-i-obtain-an-algod-address-and-token)
+ *
+ * [Run Algod in Postman OAS3](https://developer.algorand.org/docs/rest-apis/restendpoints/?from_query=algod#algod-indexer-and-kmd-rest-endpoints)
+ */
 export default class AlgodClient extends ServiceClient {
-    constructor(token: string | AlgodTokenHeader | CustomTokenHeader, baseServer?: string, port?: string | number, headers?: {});
+    /**
+     * Create an AlgodClient from
+     * * either a token, baseServer, port, and optional headers
+     * * or a base client server for interoperability with external dApp wallets
+     *
+     * #### Example
+     * ```typescript
+     * const token  = "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa";
+     * const server = "http://localhost";
+     * const port   = 4001;
+     * const algodClient = new algosdk.Algodv2(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, or use an Algorand REST API provider with a dedicated API key.
+     *
+     * @param tokenOrBaseClient - The algod token from the Algorand node you are interacting with
+     * @param baseServer - REST endpoint
+     * @param port - Port number if specifically configured by the server
+     * @param headers - Optional headers
+     */
+    constructor(tokenOrBaseClient: string | AlgodTokenHeader | CustomTokenHeader | BaseHTTPClient, baseServer?: string, port?: string | number, headers?: Record<string, string>);
+    /**
+     * Returns OK if healthy.
+     *
+     * #### Example
+     * ```typescript
+     * const health = await algodClient.healthCheck().do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-health)
+     * @category GET
+     */
     healthCheck(): HealthCheck;
+    /**
+     * Retrieves the supported API versions, binary build versions, and genesis information.
+     *
+     * #### Example
+     * ```typescript
+     * const versionsDetails = await algodClient.versionsCheck().do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-versions)
+     * @category GET
+     */
     versionsCheck(): Versions;
+    /**
+     * Broadcasts a raw transaction to the network.
+     *
+     * #### Example
+     * ```typescript
+     * const { txId } = await algodClient.sendRawTransaction(signedTxns).do();
+     * const result = await waitForConfirmation(algodClient, txid, 3);
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#post-v2transactions)
+     *
+     * @remarks
+     * Often used with {@linkcode waitForConfirmation}
+     * @param stxOrStxs - Signed transactions
+     * @category POST
+     */
     sendRawTransaction(stxOrStxs: Uint8Array | Uint8Array[]): SendRawTransaction;
     /**
-     * Returns the given account's information.
+     * Returns the given account's status, balance and spendable amounts.
+     *
+     * #### Example
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountInfo = await algodClient.accountInformation(address).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2accountsaddress)
      * @param account - The address of the account to look up.
+     * @category GET
      */
     accountInformation(account: string): AccountInformation;
     /**
      * Gets the block info for the given round.
+     *
+     * #### Example
+     * ```typescript
+     * const roundNumber = 18038133;
+     * const block = await algodClient.block(roundNumber).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2blocksround)
      * @param roundNumber - The round number of the block to get.
+     * @category GET
      */
     block(roundNumber: number): Block;
     /**
      * Returns the transaction information for a specific pending transaction.
+     *
+     * #### Example
+     * ```typescript
+     * const txId = "DRJS6R745A7GFVMXEXWP4TGVDGKW7VILFTA7HC2BR2GRLHNY5CTA";
+     * const pending = await algodClient.pendingTransactionInformation(txId).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2transactionspendingtxid)
+     *
+     * @remarks
+     * <br><br>
+     * There are several cases when this might succeed:
+     * - transaction committed (committed round > 0)
+     * - transaction still in the pool (committed round = 0, pool error = "")
+     * - transaction removed from pool due to error (committed round = 0, pool error != "")
+     *
+     * Or the transaction may have happened sufficiently long ago that the node no longer remembers it, and this will return an error.
+     *
      * @param txid - The TxID string of the pending transaction to look up.
+     * @category GET
      */
     pendingTransactionInformation(txid: string): PendingTransactionInformation;
     /**
-     * Returns transactions that are pending in the pool.
+     * Returns the list of pending transactions in the pool, sorted by priority, in decreasing order, truncated at the end at MAX.
+     * If MAX = 0, returns all pending transactions.
+     *
+     * #### Example 1
+     * ```typescript
+     * const pendingTxns = await algodClient.pendingTransactionsInformation().do();
+     * ```
+     *
+     * #### Example 2
+     * ```typescript
+     * const maxTxns = 5;
+     * const pendingTxns = await algodClient
+     *     .pendingTransactionsInformation()
+     *     .max(maxTxns)
+     *     .do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2transactionspending)
+     * @category GET
      */
     pendingTransactionsInformation(): PendingTransactions;
     /**
-     * Returns transactions that are pending in the pool sent by a specific sender.
+     * Returns the list of pending transactions sent by the address, sorted by priority, in decreasing order, truncated at the end at MAX.
+     * If MAX = 0, returns all pending transactions.
+     *
+     * #### Example 1
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const pendingTxnsByAddr = await algodClient.pendingTransactionByAddress(address).do();
+     * ```
+     *
+     * #### Example 2
+     * ```typescript
+     * const maxTxns = 5;
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const pendingTxns = await algodClient
+     *     .pendingTransactionByAddress(address)
+     *     .max(maxTxns)
+     *     .do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2accountsaddresstransactionspending)
      * @param address - The address of the sender.
+     * @category GET
      */
     pendingTransactionByAddress(address: string): PendingTransactionsByAddress;
     /**
      * Retrieves the StatusResponse from the running node.
+     *
+     * #### Example
+     * ```typescript
+     * const status = await algodClient.status().do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2status)
+     * @category GET
      */
     status(): Status;
     /**
-     * Waits for a specific round to occur then returns the StatusResponse for that round.
+     * Waits for a specific round to occur then returns the `StatusResponse` for that round.
+     *
+     * #### Example
+     * ```typescript
+     * const round = 18038133;
+     * const statusAfterBlock = await algodClient.statusAfterBlock(round).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2statuswait-for-block-afterround)
      * @param round - The number of the round to wait for.
+     * @category GET
      */
     statusAfterBlock(round: number): StatusAfterBlock;
     /**
      * Returns the common needed parameters for a new transaction.
+     *
+     * #### Example
+     * ```typescript
+     * const suggestedParams = await algodClient.getTransactionParams().do();
+     * const amountInMicroAlgos = algosdk.algosToMicroalgos(2); // 2 Algos
+     * const unsignedTxn = algosdk.makePaymentTxnWithSuggestedParamsFromObject({
+     *   from: senderAddress,
+     *   to: receiverAddress,
+     *   amount: amountInMicroAlgos,
+     *   suggestedParams: suggestedParams,
+     * });
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2transactionsparams)
+     *
+     * @remarks
+     * Often used with
+     * {@linkcode makePaymentTxnWithSuggestedParamsFromObject}, {@linkcode algosToMicroalgos}
+     * @category GET
      */
     getTransactionParams(): SuggestedParams;
     /**
-     * Gets the supply details for the specified node's ledger.
+     * Returns the supply details for the specified node's ledger.
+     *
+     * #### Example
+     * ```typescript
+     * const supplyDetails = await algodClient.supply().do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2ledgersupply)
+     * @category GET
      */
     supply(): Supply;
+    /**
+     * Compiles TEAL source code to binary, returns base64 encoded program bytes and base32 SHA512_256 hash of program bytes (Address style).
+     *
+     * #### Example
+     * ```typescript
+     * const source = "TEAL SOURCE CODE";
+     * const compiledSmartContract = await algodClient.compile(source).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#post-v2tealcompile)
+     * @remarks
+     * This endpoint is only enabled when a node's configuration file sets `EnableDeveloperAPI` to true.
+     * @param source
+     * @category POST
+     */
     compile(source: string | Uint8Array): Compile;
+    /**
+     * Provides debugging information for a transaction (or group).
+     *
+     * Executes TEAL program(s) in context and returns debugging information about the execution. This endpoint is only enabled when a node's configureation file sets `EnableDeveloperAPI` to true.
+     *
+     * #### Example
+     * ```typescript
+     * const dryRunResult = await algodClient.dryrun(dr).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#post-v2tealdryrun)
+     * @param dr
+     * @category POST
+     */
     dryrun(dr: modelsv2.DryrunRequest): Dryrun;
     /**
      * Given an asset ID, return asset information including creator, name, total supply and
      * special addresses.
+     *
+     * #### Example
+     * ```typescript
+     * const asset_id = 163650;
+     * const asset = await algodClient.getAssetByID(asset_id).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2assetsasset-id)
      * @param index - The asset ID to look up.
+     * @category GET
      */
     getAssetByID(index: number): GetAssetByID;
     /**
-     * Given an application ID, it returns application information including creator, approval
+     * Given an application ID, return the application information including creator, approval
      * and clear programs, global and local schemas, and global state.
+     *
+     * #### Example
+     * ```typescript
+     * const index = 60553466;
+     * const app = await algodClient.getApplicationByID(index).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2applicationsapplication-id)
      * @param index - The application ID to look up.
+     * @category GET
      */
     getApplicationByID(index: number): GetApplicationByID;
     /**
      * Returns the entire genesis file.
+     *
+     * #### Example
+     * ```typescript
+     * const genesis = await algodClient.genesis().do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-genesis)
+     * @category GET
      */
     genesis(): Genesis;
     /**
-     * Get the proof for a given transaction in a round.
+     * Returns a Merkle proof for a given transaction in a block.
+     *
+     * #### Example
+     * ```typescript
+     * const round = 18038133;
+     * const txId = "MEUOC4RQJB23CQZRFRKYEI6WBO73VTTPST5A7B3S5OKBUY6LFUDA";
+     * const proof = await algodClient.getProof(round, txId).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2blocksroundtransactionstxidproof)
      * @param round - The round in which the transaction appears.
      * @param txID - The transaction ID for which to generate a proof.
+     * @category GET
      */
     getProof(round: number, txID: string): Proof;
 }

package/dist/types/src/client/v2/algod/models/types.d.ts

@@ -286,7 +286,7 @@ export declare class ApplicationParams extends BaseModel {
      */
     globalState?: TealKeyValue[];
     /**
-     * [\lsch) global schema
+     * [\gsch) global schema
      */
     globalStateSchema?: ApplicationStateSchema;
     /**
@@ -301,7 +301,7 @@ export declare class ApplicationParams extends BaseModel {
      * parameters and global state for this application can be found.
      * @param extraProgramPages - (epp) the amount of extra program pages available to this app.
      * @param globalState - [\gs) global schema
-     * @param globalStateSchema - [\lsch) global schema
+     * @param globalStateSchema - [\gsch) global schema
      * @param localStateSchema - [\lsch) local schema
      */
     constructor({ approvalProgram, clearStateProgram, creator, extraProgramPages, globalState, globalStateSchema, localStateSchema, }: {
@@ -746,6 +746,10 @@ export declare class DryrunTxnResult extends BaseModel {
     disassembly: string[];
     appCallMessages?: string[];
     appCallTrace?: DryrunState[];
+    /**
+     * Execution cost of app call transaction
+     */
+    cost?: number | bigint;
     /**
      * Application state delta.
      */
@@ -753,27 +757,29 @@ export declare class DryrunTxnResult extends BaseModel {
     localDeltas?: AccountStateDelta[];
     logicSigMessages?: string[];
     logicSigTrace?: DryrunState[];
-    logs?: LogItem[];
+    logs?: Uint8Array[];
     /**
      * Creates a new `DryrunTxnResult` object.
      * @param disassembly - Disassembled program line by line.
      * @param appCallMessages -
      * @param appCallTrace -
+     * @param cost - Execution cost of app call transaction
      * @param globalDelta - Application state delta.
      * @param localDeltas -
      * @param logicSigMessages -
      * @param logicSigTrace -
      * @param logs -
      */
-    constructor({ disassembly, appCallMessages, appCallTrace, globalDelta, localDeltas, logicSigMessages, logicSigTrace, logs, }: {
+    constructor({ disassembly, appCallMessages, appCallTrace, cost, globalDelta, localDeltas, logicSigMessages, logicSigTrace, logs, }: {
         disassembly: string[];
         appCallMessages?: string[];
         appCallTrace?: DryrunState[];
+        cost?: number | bigint;
         globalDelta?: EvalDeltaKeyValue[];
         localDeltas?: AccountStateDelta[];
         logicSigMessages?: string[];
         logicSigTrace?: DryrunState[];
-        logs?: LogItem[];
+        logs?: Uint8Array[];
     });
 }
 /**
@@ -829,25 +835,6 @@ export declare class EvalDeltaKeyValue extends BaseModel {
      */
     constructor(key: string, value: EvalDelta);
 }
-/**
- * Application Log
- */
-export declare class LogItem extends BaseModel {
-    /**
-     * unique application identifier
-     */
-    id: number | bigint;
-    /**
-     * base64 encoded log message
-     */
-    value: string;
-    /**
-     * Creates a new `LogItem` object.
-     * @param id - unique application identifier
-     * @param value - base64 encoded log message
-     */
-    constructor(id: number | bigint, value: string);
-}
 /**
  *
  */
@@ -961,14 +948,8 @@ export declare class NodeStatusResponse extends BaseModel {
     });
 }
 /**
- * Given a transaction id of a recently submitted transaction, it returns
- * information about it. There are several cases when this might succeed:
- * - transaction committed (committed round > 0)
- * - transaction still in the pool (committed round = 0, pool error = "")
- * - transaction removed from pool due to error (committed round = 0, pool error !=
- * "")
- * Or the transaction may have happened sufficiently long ago that the node no
- * longer remembers it, and this will return an error.
+ * Details about a pending transaction. If the transaction was recently confirmed,
+ * includes confirmation details like the round and reward details.
  */
 export declare class PendingTransactionResponse extends BaseModel {
     /**
@@ -1011,6 +992,10 @@ export declare class PendingTransactionResponse extends BaseModel {
      * transaction.
      */
     globalStateDelta?: EvalDeltaKeyValue[];
+    /**
+     * Inner transactions produced by application execution.
+     */
+    innerTxns?: PendingTransactionResponse[];
     /**
      * (ld) Local state key/value changes for the application being executed by this
      * transaction.
@@ -1019,7 +1004,7 @@ export declare class PendingTransactionResponse extends BaseModel {
     /**
      * (lg) Logs for the application being executed by this transaction.
      */
-    logs?: LogItem[];
+    logs?: Uint8Array[];
     /**
      * Rewards in microalgos applied to the receiver account.
      */
@@ -1043,13 +1028,14 @@ export declare class PendingTransactionResponse extends BaseModel {
      * @param confirmedRound - The round where this transaction was confirmed, if present.
      * @param globalStateDelta - (gd) Global state key/value changes for the application being executed by this
      * transaction.
+     * @param innerTxns - Inner transactions produced by application execution.
      * @param localStateDelta - (ld) Local state key/value changes for the application being executed by this
      * transaction.
      * @param logs - (lg) Logs for the application being executed by this transaction.
      * @param receiverRewards - Rewards in microalgos applied to the receiver account.
      * @param senderRewards - Rewards in microalgos applied to the sender account.
      */
-    constructor({ poolError, txn, applicationIndex, assetClosingAmount, assetIndex, closeRewards, closingAmount, confirmedRound, globalStateDelta, localStateDelta, logs, receiverRewards, senderRewards, }: {
+    constructor({ poolError, txn, applicationIndex, assetClosingAmount, assetIndex, closeRewards, closingAmount, confirmedRound, globalStateDelta, innerTxns, localStateDelta, logs, receiverRewards, senderRewards, }: {
         poolError: string;
         txn: EncodedSignedTransaction;
         applicationIndex?: number | bigint;
@@ -1059,8 +1045,9 @@ export declare class PendingTransactionResponse extends BaseModel {
         closingAmount?: number | bigint;
         confirmedRound?: number | bigint;
         globalStateDelta?: EvalDeltaKeyValue[];
+        innerTxns?: PendingTransactionResponse[];
         localStateDelta?: AccountStateDelta[];
-        logs?: LogItem[];
+        logs?: Uint8Array[];
         receiverRewards?: number | bigint;
         senderRewards?: number | bigint;
     });
@@ -1169,7 +1156,7 @@ export declare class TealKeyValue extends BaseModel {
  */
 export declare class TealValue extends BaseModel {
     /**
-     * (tt) value type.
+     * (tt) value type. Value `1` refers to **bytes**, value `2` refers to **uint**
      */
     type: number | bigint;
     /**
@@ -1182,7 +1169,7 @@ export declare class TealValue extends BaseModel {
     uint: number | bigint;
     /**
      * Creates a new `TealValue` object.
-     * @param type - (tt) value type.
+     * @param type - (tt) value type. Value `1` refers to **bytes**, value `2` refers to **uint**
      * @param bytes - (tb) bytes value.
      * @param uint - (ui) uint value.
      */