algosdk 1.13.1 → 1.15.0-beta.1

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

@@ -9,25 +9,304 @@ import IntDecoding from '../../../types/intDecoding';
 export declare function base64StringFunnel(data: Uint8Array | string): string;
 export default class LookupAccountTransactions extends JSONRequest {
     private account;
+    /**
+     * 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.
+     */
     constructor(c: HTTPClient, intDecoding: IntDecoding, account: string);
+    /**
+     * @returns /v2/accounts/`${account}`/transactions
+     */
     path(): string;
     /**
-     * notePrefix to filter with
+     * Specifies a prefix which must be contained in the note field
+     *
+     * #### Example
+     * ```typescript
+     * const notePrefixBase64Encoded = "Y3JlYXRl";
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .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 address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .txType("appl")
+     *        .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 address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .sigType("msig")
+     *        .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 address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .txid(txId)
+     *        .do();
+     * ```
+     *
+     * @param txid
+     * @category query
+     */
     txid(txid: string): this;
+    /**
+     * Include results for the specified round
+     *
+     * #### Example
+     * ```typescript
+     * const targetBlock = 18309917;
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .round(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 address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .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 address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .maxRound(maxRound)
+     *        .do();
+     * ```
+     *
+     * @param round
+     * @category query
+     */
     maxRound(round: number): this;
+    /**
+     * Asset ID to filter with
+     *
+     * #### Example
+     * ```typescript
+     * const assetID = 163650;
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .assetID(assetID)
+     *        .do();
+     * ```
+     *
+     * @param id
+     * @category query
+     */
     assetID(id: number): this;
+    /**
+     * Maximum number of results to return
+     *
+     * #### Example
+     * ```typescript
+     * const limit = 25;
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .limit(limit)
+     *        .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 address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .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 address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .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 address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .currencyGreaterThan(minBalance - 1)
+     *        .do();
+     * ```
+     *
+     * #### Example 2
+     * ```typescript
+     * const assetID = 163650;
+     * const minBalance = 300000;
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .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 address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .currencyLessThan(maxBalance + 1)
+     *        .do();
+     * ```
+     *
+     * #### Example 2
+     * ```typescript
+     * const assetID = 163650;
+     * const maxBalance = 500000;
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .assetID(assetID)
+     *        .currencyLessThan(maxBalance + 1)
+     *        .do();
+     * ```
+     *
+     * @param lesser
+     * @category query
+     */
     currencyLessThan(lesser: number): this;
+    /**
+     * The next page of results. Use the next token provided by the previous results.
+     *
+     * #### Example
+     * ```typescript
+     * const limit = 25;
+     * const nextToken = "the next token returned in the previous query response";
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .limit(limit)
+     *        .nextToken(nextToken)
+     *        .do();
+     * ```
+     *
+     * @param nextToken
+     * @category query
+     */
     nextToken(nextToken: string): this;
+    /**
+     * Include results which include the rekey-to field
+     *
+     * #### Example
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .rekeyTo(false)
+     *        .do();
+     * ```
+     *
+     * @param rekeyTo
+     * @category query
+     */
     rekeyTo(rekeyTo: boolean): this;
 }

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

@@ -33,21 +33,6 @@ export default class LookupAssetBalances extends JSONRequest {
      * @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.
      *

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

@@ -3,7 +3,44 @@ import HTTPClient from '../../client';
 import IntDecoding from '../../../types/intDecoding';
 export default class LookupAssetByID extends JSONRequest {
     private index;
+    /**
+     * Returns asset information of the queried 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 asset ID to look up.
+     */
     constructor(c: HTTPClient, intDecoding: IntDecoding, index: number);
+    /**
+     * @returns `/v2/assets/${index}`
+     */
     path(): string;
+    /**
+     * Includes all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates
+     *
+     * #### Example 1
+     * ```typescript
+     * const assetInfo = await indexerClient
+     *        .lookupAssetByID(assetId)
+     *        .includeAll(false)
+     *        .do();
+     * ```
+     *
+     * #### Example 2
+     * ```typescript
+     * const assetInfo = await indexerClient
+     *        .lookupAssetByID(assetId)
+     *        .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/searchAccounts.d.ts

@@ -10,4 +10,5 @@ export default class SearchAccounts extends JSONRequest {
     authAddr(authAddr: string): this;
     applicationID(applicationID: number): this;
     includeAll(value?: boolean): this;
+    exclude(exclude: string): this;
 }

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

@@ -2,6 +2,7 @@ import JSONRequest from '../jsonrequest';
 export default class SearchForApplications extends JSONRequest {
     path(): string;
     index(index: number): this;
+    creator(index: number): this;
     nextToken(next: string): this;
     limit(limit: number): this;
     includeAll(value?: boolean): this;

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

@@ -20,6 +20,7 @@ export default abstract class JSONRequest<Data = Record<string, any>, Body = Dat
     constructor(client: HTTPClient, intDecoding?: IntDecoding);
     /**
      * @returns The path of this request.
+     * @category JSONRequest
      */
     abstract path(): string;
     /**
@@ -28,12 +29,14 @@ export default abstract class JSONRequest<Data = Record<string, any>, Body = Dat
      * Use this method to change and restructure response
      * data as needed after receiving it from the `do()` method.
      * @param body - Response body received
+     * @category JSONRequest
      */
     prepare(body: Body): Data;
     /**
      * Execute the request.
      * @param headers - Additional headers to send in the request. Optional.
      * @returns A promise which resolves to the response data.
+     * @category JSONRequest
      */
     do(headers?: Record<string, any>): Promise<Data>;
     /**
@@ -50,6 +53,7 @@ export default abstract class JSONRequest<Data = Record<string, any>, Body = Dat
      *
      * @param method - The method to use when parsing the
      *   response for this request. Must be one of "default", "safe", "mixed", or "bigint".
+     * @category JSONRequest
      */
     setIntDecoding(method: IntDecoding): this;
 }

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

@@ -19,6 +19,8 @@ export interface ABIResult {
     returnValue?: ABIValue;
     /** If the SDK was unable to decode a return value, the error will be here. */
     decodeError?: Error;
+    /** The pending transaction information from the method transaction */
+    txInfo?: Record<string, any>;
 }
 export declare enum AtomicTransactionComposerStatus {
     /** The atomic group is still under construction. */

package/dist/types/src/logicTemplates/dynamicfee.d.ts

@@ -4,6 +4,8 @@ export class DynamicFee {
      * specifying the fee. The fee will be determined at the moment of
      * transfer.
      *
+     * @deprecated This feature will be removed in v2.
+     *
      * Constructor Parameters:
      * @param {string} receiver: address to receive the assets
      * @param {int} amount: amount of assets to transfer
@@ -31,6 +33,9 @@ export class DynamicFee {
  * getDynamicFeeTransactions creates and signs the secondary dynamic fee transaction, updates
  * transaction fields, and signs as the fee payer; it returns both
  * transactions as bytes suitable for sendRaw.
+ *
+ * @deprecated This feature will be removed in v2.
+ *
  * Parameters:
  * @param {dict} txn - main transaction from payer's signDynamicFee output (a dict of constructor arguments, NOT a transaction.Transaction)
  * @param {LogicSig} lsig - the signed logic received from the payer's signDynamicFee output
@@ -43,6 +48,9 @@ export function getDynamicFeeTransactions(txn: any, lsig: any, privateKey: Uint8
 /**
  * signDynamicFee returns the main transaction and signed logic needed to complete the transfer.
  * These should be sent to the fee payer, who can use GetDynamicFeeTransactions
+ *
+ * @deprecated This feature will be removed in v2.
+ *
  * @param {Uint8Array} contract: the bytearray representing the contract
  * @param {Uint8Array} secretKey: the secret key for building the logic sig
  * @param {string} genesisHash: the genesisHash to use for the txn

package/dist/types/src/logicTemplates/htlc.d.ts

@@ -10,6 +10,8 @@ export class HTLC {
      * 2. To owner if txn.FirstValid > expiry_round
      * ...
      *
+     * @deprecated This feature will be removed in v2.
+     *
      *Parameters
      *----------
      * @param {string} owner: an address that can receive the asset after the expiry round
@@ -36,6 +38,9 @@ export class HTLC {
 }
 /**
  *  signTransactionWithHTLCUnlock accepts a transaction, such as a payment, and builds the HTLC-unlocking signature around that transaction
+ *
+ * @deprecated This feature will be removed in v2.
+ *
  * @param {Uint8Array} contract : byte representation of the HTLC
  * @param {Object} txn dictionary containing constructor arguments for a transaction
  * @param {string} preImageAsBase64 : preimage of the hash as base64 string

package/dist/types/src/logicTemplates/limitorder.d.ts

@@ -19,6 +19,9 @@ export class LimitOrder {
      *
      * close-out case:
      * txn alone, close out value after timeout
+     *
+     * @deprecated This class will be removed in v2.
+     *
      * Constructor Parameters:
      * @param {string} owner: the address to refund funds to on timeout
      * @param {int} assetid: the ID of the transferred asset
@@ -47,6 +50,9 @@ export class LimitOrder {
 }
 /**
  * returns a group transactions array which transfer funds according to the contract's ratio
+ *
+ * @deprecated This feature will be removed in v2.
+ *
  * @param {Uint8Array} contract: byteform of the contract from the payer
  * @param {int} assetAmount: the amount of assets to be sent
  * @param {int} microAlgoAmount: number of microAlgos to transfer

package/dist/types/src/logicTemplates/periodicpayment.d.ts

@@ -10,6 +10,8 @@ export class PeriodicPayment {
      * After expiryRound, all remaining funds in the escrow
      * are available to receiver.
      *
+     * @deprecated This class will be removed in v2.
+     *
      * Constructor Parameters:
      * @param {string} receiver: address which is authorized to receive withdrawals
      * @param {int} amount: the amount to send each period
@@ -43,6 +45,9 @@ export class PeriodicPayment {
 }
 /**
  * getPeriodicPaymentWithdrawalTransaction returns a signed transaction extracting funds form the contract
+ *
+ * @deprecated This feature will be removed in v2.
+ *
  * @param {Uint8Array} contract: the bytearray defining the contract, received from the payer
  * @param {int} fee: the fee per byte for the transaction
  * @param {int} firstValid: the first round on which the txn will be valid

package/dist/types/src/logicTemplates/split.d.ts

@@ -13,6 +13,9 @@ export class Split {
      * (CloseRemainderTo must be zero.)
      *
      * After expiryRound passes, all funds can be refunded to owner.
+     *
+     * @deprecated This feature will be removed in v2.
+     *
      * Constructor Parameters:
      * @param {string} owner: the address to refund funds to on timeout
      * @param {string} receiverOne: the first recipient in the split account
@@ -40,6 +43,9 @@ export class Split {
 }
 /**
  * returns a group transactions array which transfer funds according to the contract's ratio
+ *
+ * @deprecated This feature will be removed in v2.
+ *
  * @param {Uint8Array} contract: bytes representing the contract in question
  * @param {int} amount: the amount to be transferred
  * @param {int} firstRound: the first round on which the transaction group will be valid

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

@@ -69,6 +69,7 @@ export { default as Indexer } from './client/v2/indexer/indexer';
 export { BaseHTTPClient, BaseHTTPClientResponse, BaseHTTPClientError, } from './client/baseHTTPClient';
 export { waitForConfirmation } from './wait';
 export { isValidAddress, encodeAddress, decodeAddress, getApplicationAddress, } from './encoding/address';
+export { bytesToBigInt, bigIntToBytes } from './encoding/bigint';
 export { encodeUint64, decodeUint64 } from './encoding/uint64';
 export { default as generateAccount } from './account';
 export * as modelsv2 from './client/v2/algod/models/types';