algosdk 1.20.0 → 1.22.0

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

@@ -1,16 +1,20 @@
+/** @deprecated v1 algod APIs are deprecated, please use the v2 client */
 export function Algod(token?: string, baseServer?: string, port?: number, headers?: {}): void;
 export class Algod {
+    /** @deprecated v1 algod APIs are deprecated, please use the v2 client */
     constructor(token?: string, baseServer?: string, port?: number, headers?: {});
     /**
      * status retrieves the StatusResponse from the running node
      * @param headerObj, optional
      * @returns {Promise<*>}
+     * @deprecated v1 algod APIs are deprecated, please use the v2 client
      */
     status: (headerObj?: {}) => Promise<any>;
     /**
      * healthCheck returns an empty object iff the node is running
      * @param headerObj, optional
      * @returns {Promise<*>}
+     * @deprecated v1 algod APIs are deprecated, please use the v2 client
      */
     healthCheck: (headerObj?: {}) => Promise<any>;
     /**
@@ -19,6 +23,7 @@ export class Algod {
      * @param roundNumber
      * @param headerObj, optional
      * @returns {Promise<*>}
+     * @deprecated v1 algod APIs are deprecated, please use the v2 client
      */
     statusAfterBlock: (roundNumber: any, headerObj?: {}) => Promise<any>;
     /**
@@ -27,18 +32,21 @@ export class Algod {
      * @param maxTxns - number
      * @param headerObj, optional
      * @returns {Promise<*>}
+     * @deprecated v1 algod APIs are deprecated, please use the v2 client
      */
     pendingTransactions: (maxTxns: any, headerObj?: {}) => Promise<any>;
     /**
      * versions retrieves the VersionResponse from the running node
      * @param headerObj, optional
      * @returns {Promise<*>}
+     * @deprecated v1 algod APIs are deprecated, please use the v2 client
      */
     versions: (headerObj?: {}) => Promise<any>;
     /**
      * LedgerSupply gets the supply details for the specified node's Ledger
      * @param headerObj, optional
      * @returns {Promise<*>}
+     * @deprecated v1 algod APIs are deprecated, please use the v2 client
      */
     ledgerSupply: (headerObj?: {}) => Promise<any>;
     /**
@@ -49,6 +57,7 @@ export class Algod {
      * @param maxTxns - number, optional
      * @param headers, optional
      * @returns {Promise<*>}
+     * @deprecated v1 algod APIs are deprecated, please use the v2 client
      */
     transactionByAddress: (addr: any, first?: any, last?: any, maxTxns?: any, headerObj?: {}) => Promise<any>;
     /**
@@ -60,6 +69,7 @@ export class Algod {
      * @param maxTxns - number, optional
      * @param headerObj, optional
      * @returns {Promise<*>}
+     * @deprecated v1 algod APIs are deprecated, please use the v2 client
      */
     transactionByAddressAndDate: (addr: any, fromDate: any, toDate: any, maxTxns?: any, headerObj?: {}) => Promise<any>;
     /**
@@ -68,6 +78,7 @@ export class Algod {
      * @param txid
      * @param headerObj, optional
      * @returns {Promise<*>}
+     * @deprecated v1 algod APIs are deprecated, please use the v2 client
      */
     transactionById: (txid: any, headerObj?: {}) => Promise<any>;
     /**
@@ -76,6 +87,7 @@ export class Algod {
      * @param txid
      * @param headerObj, optional
      * @returns {Promise<*>}
+     * @deprecated v1 algod APIs are deprecated, please use the v2 client
      */
     transactionInformation: (addr: any, txid: any, headerObj?: {}) => Promise<any>;
     /**
@@ -83,6 +95,7 @@ export class Algod {
      * @param txid
      * @param headerObj, optional
      * @returns {Promise<*>}
+     * @deprecated v1 algod APIs are deprecated, please use the v2 client
      */
     pendingTransactionInformation: (txid: any, headerObj?: {}) => Promise<any>;
     /**
@@ -90,6 +103,7 @@ export class Algod {
      * @param addr - string
      * @param headerObj, optional
      * @returns {Promise<*>}
+     * @deprecated v1 algod APIs are deprecated, please use the v2 client
      */
     accountInformation: (addr: any, headerObj?: {}) => Promise<any>;
     /**
@@ -97,12 +111,14 @@ export class Algod {
      * @param index - number
      * @param headerObj, optional
      * @returns {Promise<*>}
+     * @deprecated v1 algod APIs are deprecated, please use the v2 client
      */
     assetInformation: (index: any, headerObj?: {}) => Promise<any>;
     /**
      * suggestedFee gets the recommended transaction fee from the node
      * @param headerObj, optional
      * @returns {Promise<*>}
+     * @deprecated v1 algod APIs are deprecated, please use the v2 client
      */
     suggestedFee: (headerObj?: {}) => Promise<any>;
     /**
@@ -110,6 +126,7 @@ export class Algod {
      * @param txn - Uin8Array
      * @param headerObj, optional
      * @returns {Promise<*>}
+     * @deprecated v1 algod APIs are deprecated, please use the v2 client
      */
     sendRawTransaction: (txn: any, headerObj?: {}) => Promise<any>;
     /**
@@ -117,18 +134,21 @@ export class Algod {
      * @param txn - Array of Uin8Array
      * @param headerObj, optional
      * @returns {Promise<*>}
+     * @deprecated v1 algod APIs are deprecated, please use the v2 client
      */
     sendRawTransactions: (txns: any, headerObj?: {}) => Promise<any>;
     /**
      * getTransactionParams returns to common needed parameters for a new transaction
      * @param headerObj, optional
      * @returns {Promise<*>}
+     * @deprecated v1 algod APIs are deprecated, please use the v2 client
      */
     getTransactionParams: (headerObj?: {}) => Promise<any>;
     /**
      * suggestParams returns to common needed parameters for a new transaction, in a format the transaction builder expects
      * @param headerObj, optional
      * @returns {Object}
+     * @deprecated v1 algod APIs are deprecated, please use the v2 client
      */
     suggestParams: (headerObj?: {}) => any;
     /**
@@ -136,6 +156,7 @@ export class Algod {
      * @param roundNumber
      * @param headerObj, optional
      * @returns {Promise<*>}
+     * @deprecated v1 algod APIs are deprecated, please use the v2 client
      */
     block: (roundNumber: any, headerObj?: {}) => Promise<any>;
 }

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

@@ -9,6 +9,7 @@ import Dryrun from './dryrun';
 import Genesis from './genesis';
 import GetAssetByID from './getAssetByID';
 import GetApplicationByID from './getApplicationByID';
+import GetBlockHash from './getBlockHash';
 import HealthCheck from './healthCheck';
 import PendingTransactionInformation from './pendingTransactionInformation';
 import PendingTransactions from './pendingTransactions';
@@ -158,6 +159,20 @@ export default class AlgodClient extends ServiceClient {
      * @category GET
      */
     block(roundNumber: number): Block;
+    /**
+     * Get the block hash for the block on the given round.
+     *
+     * #### Example
+     * ```typescript
+     * const roundNumber = 18038133;
+     * const block = await algodClient.getBlockHash(roundNumber).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2blocksroundhash)
+     * @param roundNumber - The round number of the block to get.
+     * @category GET
+     */
+    getBlockHash(roundNumber: number): GetBlockHash;
     /**
      * Returns the transaction information for a specific pending transaction.
      *

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

@@ -0,0 +1,8 @@
+import JSONRequest from '../jsonrequest';
+import HTTPClient from '../../client';
+import IntDecoding from '../../../types/intDecoding';
+export default class GetBlockHash extends JSONRequest {
+    round: number;
+    constructor(c: HTTPClient, intDecoding: IntDecoding, roundNumber: number);
+    path(): string;
+}

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

@@ -21,4 +21,9 @@ export default class LookupBlock extends JSONRequest {
      * @returns `/v2/blocks/${round}`
      */
     path(): string;
+    /**
+     * Header only flag. When this is set to true, returned block does not contain the
+     * transactions.
+     */
+    headerOnly(headerOnly: boolean): this;
 }

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

@@ -38,7 +38,7 @@ export default class SearchAccounts extends JSONRequest {
      *        .do();
      * ```
      * @remarks
-     * If you are looking for accounts 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.
+     * If you are looking for accounts 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 accounts with a 0 amount.
      *
      * @param greater
      * @category query

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "algosdk",
-  "version": "1.20.0",
+  "version": "1.22.0",
   "description": "The official JavaScript SDK for Algorand",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",