algosdk 2.2.0 → 2.4.0

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

@@ -27,8 +27,17 @@ import { BaseHTTPClient } from '../../baseHTTPClient';
 import { AlgodTokenHeader, CustomTokenHeader } from '../../urlTokenBaseHTTPClient';
 import LightBlockHeaderProof from './lightBlockHeaderProof';
 import StateProof from './stateproof';
+import SetSyncRound from './setSyncRound';
+import GetSyncRound from './getSyncRound';
+import SetBlockOffsetTimestamp from './setBlockOffsetTimestamp';
+import GetBlockOffsetTimestamp from './getBlockOffsetTimestamp';
 import Disassemble from './disassemble';
 import SimulateRawTransactions from './simulateTransaction';
+import Ready from './ready';
+import UnsetSyncRound from './unsetSyncRound';
+import GetLedgerStateDeltaForTransactionGroup from './getLedgerStateDeltaForTransactionGroup';
+import GetLedgerStateDelta from './getLedgerStateDelta';
+import GetTransactionGroupLedgerStateDeltasForRound from './getTransactionGroupLedgerStateDeltasForRound';
 /**
  * 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.
  *
@@ -70,7 +79,7 @@ export default class AlgodClient extends ServiceClient {
      * const health = await algodClient.healthCheck().do();
      * ```
      *
-     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-health)
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-health)
      * @category GET
      */
     healthCheck(): HealthCheck;
@@ -82,7 +91,7 @@ export default class AlgodClient extends ServiceClient {
      * const versionsDetails = await algodClient.versionsCheck().do();
      * ```
      *
-     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-versions)
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-versions)
      * @category GET
      */
     versionsCheck(): Versions;
@@ -95,7 +104,7 @@ export default class AlgodClient extends ServiceClient {
      * const result = await waitForConfirmation(algodClient, txid, 3);
      * ```
      *
-     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#post-v2transactions)
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#post-v2transactions)
      *
      * @remarks
      * Often used with {@linkcode waitForConfirmation}
@@ -112,7 +121,7 @@ export default class AlgodClient extends ServiceClient {
      * const accountInfo = await algodClient.accountInformation(address).do();
      * ```
      *
-     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2accountsaddress)
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2accountsaddress)
      * @param account - The address of the account to look up.
      * @category GET
      */
@@ -127,7 +136,7 @@ export default class AlgodClient extends ServiceClient {
      * const accountAssetInfo = await algodClient.accountAssetInformation(address, index).do();
      * ```
      *
-     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2accountsaddress)
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2accountsaddress)
      * @param account - The address of the account to look up.
      * @param index - The asset ID to look up.
      * @category GET
@@ -143,7 +152,7 @@ export default class AlgodClient extends ServiceClient {
      * const accountInfo = await algodClient.accountApplicationInformation(address, index).do();
      * ```
      *
-     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2accountsaddress)
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2accountsaddress)
      * @param account - The address of the account to look up.
      * @param index - The application ID to look up.
      * @category GET
@@ -158,7 +167,7 @@ export default class AlgodClient extends ServiceClient {
      * const block = await algodClient.block(roundNumber).do();
      * ```
      *
-     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2blocksround)
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2blocksround)
      * @param roundNumber - The round number of the block to get.
      * @category GET
      */
@@ -172,7 +181,7 @@ export default class AlgodClient extends ServiceClient {
      * const block = await algodClient.getBlockHash(roundNumber).do();
      * ```
      *
-     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2blocksroundhash)
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2blocksroundhash)
      * @param roundNumber - The round number of the block to get.
      * @category GET
      */
@@ -186,7 +195,7 @@ export default class AlgodClient extends ServiceClient {
      * const pending = await algodClient.pendingTransactionInformation(txId).do();
      * ```
      *
-     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2transactionspendingtxid)
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2transactionspendingtxid)
      *
      * @remarks
      * <br><br>
@@ -219,7 +228,7 @@ export default class AlgodClient extends ServiceClient {
      *     .do();
      * ```
      *
-     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2transactionspending)
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2transactionspending)
      * @category GET
      */
     pendingTransactionsInformation(): PendingTransactions;
@@ -243,7 +252,7 @@ export default class AlgodClient extends ServiceClient {
      *     .do();
      * ```
      *
-     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2accountsaddresstransactionspending)
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2accountsaddresstransactionspending)
      * @param address - The address of the sender.
      * @category GET
      */
@@ -256,7 +265,7 @@ export default class AlgodClient extends ServiceClient {
      * const status = await algodClient.status().do();
      * ```
      *
-     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2status)
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2status)
      * @category GET
      */
     status(): Status;
@@ -269,7 +278,7 @@ export default class AlgodClient extends ServiceClient {
      * 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)
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2statuswait-for-block-afterround)
      * @param round - The number of the round to wait for.
      * @category GET
      */
@@ -289,7 +298,7 @@ export default class AlgodClient extends ServiceClient {
      * });
      * ```
      *
-     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2transactionsparams)
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2transactionsparams)
      *
      * @remarks
      * Often used with
@@ -305,7 +314,7 @@ export default class AlgodClient extends ServiceClient {
      * const supplyDetails = await algodClient.supply().do();
      * ```
      *
-     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2ledgersupply)
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2ledgersupply)
      * @category GET
      */
     supply(): Supply;
@@ -318,7 +327,7 @@ export default class AlgodClient extends ServiceClient {
      * const compiledSmartContract = await algodClient.compile(source).do();
      * ```
      *
-     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#post-v2tealcompile)
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#post-v2tealcompile)
      * @remarks
      * This endpoint is only enabled when a node's configuration file sets `EnableDeveloperAPI` to true.
      * @param source
@@ -348,7 +357,7 @@ export default class AlgodClient extends ServiceClient {
      * const dryRunResult = await algodClient.dryrun(dr).do();
      * ```
      *
-     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#post-v2tealdryrun)
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#post-v2tealdryrun)
      * @param dr
      * @category POST
      */
@@ -363,7 +372,7 @@ export default class AlgodClient extends ServiceClient {
      * const asset = await algodClient.getAssetByID(asset_id).do();
      * ```
      *
-     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2assetsasset-id)
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2assetsasset-id)
      * @param index - The asset ID to look up.
      * @category GET
      */
@@ -378,7 +387,7 @@ export default class AlgodClient extends ServiceClient {
      * const app = await algodClient.getApplicationByID(index).do();
      * ```
      *
-     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2applicationsapplication-id)
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2applicationsapplication-id)
      * @param index - The application ID to look up.
      * @category GET
      */
@@ -394,7 +403,7 @@ export default class AlgodClient extends ServiceClient {
      * const boxValue = boxResponse.value;
      * ```
      *
-     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2applicationsapplication-idbox)
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2applicationsapplication-idbox)
      * @param index - The application ID to look up.
      * @category GET
      */
@@ -409,7 +418,7 @@ export default class AlgodClient extends ServiceClient {
      * const boxNames = boxesResponse.boxes.map(box => box.name);
      * ```
      *
-     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2applicationsapplication-idboxes)
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2applicationsapplication-idboxes)
      * @param index - The application ID to look up.
      * @category GET
      */
@@ -422,7 +431,7 @@ export default class AlgodClient extends ServiceClient {
      * const genesis = await algodClient.genesis().do();
      * ```
      *
-     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-genesis)
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-genesis)
      * @category GET
      */
     genesis(): Genesis;
@@ -436,7 +445,7 @@ export default class AlgodClient extends ServiceClient {
      * const proof = await algodClient.getTransactionProof(round, txId).do();
      * ```
      *
-     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2blocksroundtransactionstxidproof)
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2blocksroundtransactionstxidproof)
      * @param round - The round in which the transaction appears.
      * @param txID - The transaction ID for which to generate a proof.
      * @category GET
@@ -473,12 +482,169 @@ export default class AlgodClient extends ServiceClient {
      *
      * #### Example
      * ```typescript
+     * const txn1 = algosdk.makePaymentTxnWithSuggestedParamsFromObject(txn1Params);
+     * const txn2 = algosdk.makePaymentTxnWithSuggestedParamsFromObject(txn2Params);
+     * const txgroup = algosdk.assignGroupID([txn1, txn2]);
+     *
+     * // Actually sign the first transaction
+     * const signedTxn1 = txgroup[0].signTxn(senderSk).blob;
+     * // Simulate does not require signed transactions -- use this method to encode an unsigned transaction
+     * const signedTxn2 = algosdk.encodeUnsignedSimulateTransaction(txgroup[1]);
+     *
      * const resp = await client.simulateRawTransactions([signedTxn1, signedTxn2]).do();
      * ```
      *
-     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#post-v2transactionssimulate)
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#post-v2transactionssimulate)
      * @param stxOrStxs
      * @category POST
      */
     simulateRawTransactions(stxOrStxs: Uint8Array | Uint8Array[]): SimulateRawTransactions;
+    /**
+     * Simulate transactions being sent to the network.
+     *
+     * #### Example
+     * ```typescript
+     * const txn1 = algosdk.makePaymentTxnWithSuggestedParamsFromObject(txn1Params);
+     * const txn2 = algosdk.makePaymentTxnWithSuggestedParamsFromObject(txn2Params);
+     * const txgroup = algosdk.assignGroupID([txn1, txn2]);
+     *
+     * // Actually sign the first transaction
+     * const signedTxn1 = txgroup[0].signTxn(senderSk).blob;
+     * // Simulate does not require signed transactions -- use this method to encode an unsigned transaction
+     * const signedTxn2 = algosdk.encodeUnsignedSimulateTransaction(txgroup[1]);
+     *
+     * const request = new modelsv2.SimulateRequest({
+     *  txnGroups: [
+     *    new modelsv2.SimulateRequestTransactionGroup({
+     *       // Must decode the signed txn bytes into an object
+     *       txns: [algosdk.decodeObj(signedTxn1), algosdk.decodeObj(signedTxn2)]
+     *     }),
+     *   ],
+     * });
+     * const resp = await client.simulateRawTransactions(request).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#post-v2transactionssimulate)
+     * @param request
+     * @category POST
+     */
+    simulateTransactions(request: modelsv2.SimulateRequest): SimulateRawTransactions;
+    /**
+     * Set the offset (in seconds) applied to the block timestamp when creating new blocks in devmode.
+     *
+     *  #### Example
+     *  ```typesecript
+     *  const offset = 60
+     *  await client.setBlockOffsetTimestamp(offset).do();
+     *  ```
+     *
+     [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#post-v2devmodeblocksoffsetoffset)
+     * @param offset
+     * @category POST
+     */
+    setBlockOffsetTimestamp(offset: number): SetBlockOffsetTimestamp;
+    /**
+     * Get the offset (in seconds) applied to the block timestamp when creating new blocks in devmode.
+     *
+     *  #### Example
+     *  ```typesecript
+     *  const currentOffset = await client.getBlockOffsetTimestamp().do();
+     *  ```
+     *
+     [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2devmodeblocksoffset)
+     * @category GET
+     */
+    getBlockOffsetTimestamp(): GetBlockOffsetTimestamp;
+    /**
+     * Set the sync round on the ledger (algod must have EnableFollowMode: true), restricting catchup.
+     *
+     *  #### Example
+     *  ```typesecript
+     *  const round = 10000
+     *  await client.setSyncRound(round).do();
+     *  ```
+     *
+     [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#post-v2ledgersyncround)
+     * @param round
+     * @category POST
+     */
+    setSyncRound(round: number): SetSyncRound;
+    /**
+     * Un-Set the sync round on the ledger (algod must have EnableFollowMode: true), removing the restriction on catchup.
+     *
+     *  #### Example
+     *  ```typesecript
+     *  await client.unsetSyncRound().do();
+     *  ```
+     *
+     [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#delete-v2ledgersync)
+     * @category DELETE
+     */
+    unsetSyncRound(): UnsetSyncRound;
+    /**
+     * Get the current sync round on the ledger (algod must have EnableFollowMode: true).
+     *
+     *  #### Example
+     *  ```typesecript
+     *  const currentSyncRound = await client.getSyncRound().do();
+     *  ```
+     *
+     [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2ledgersync)
+     * @category GET
+     */
+    getSyncRound(): GetSyncRound;
+    /**
+     * Ready check which returns 200 OK if algod is healthy and caught up
+     *
+     *  #### Example
+     *  ```typesecript
+     *  await client.ready().do();
+     *  ```
+     *
+     [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-ready)
+     * @category GET
+     */
+    ready(): Ready;
+    /**
+     * GetLedgerStateDeltaForTransactionGroup returns the ledger delta for the txn group identified by id
+     *
+     * #### Example
+     * ```typescript
+     * const id = "ABC123";
+     * await client.getLedgerStateDeltaForTransactionGroup(id).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2deltastxngroupid)
+     * @param id txn ID or group ID to be searched for
+     * @category GET
+     */
+    getLedgerStateDeltaForTransactionGroup(id: string): GetLedgerStateDeltaForTransactionGroup;
+    /**
+     * GetLedgerStateDelta returns the ledger delta for the entire round
+     *
+     * #### Example
+     * ```typescript
+     * const round = 12345;
+     * await client.getLedgerStateDelta(round).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2deltasround)
+     * @param round the round number to be searched for
+     * @category GET
+     */
+    getLedgerStateDelta(round: bigint): GetLedgerStateDelta;
+    /**
+     * GetTransactionGroupLedgerStateDeltasForRound returns all ledger deltas for txn groups in the provided round
+     *
+     * #### Example
+     * ```typescript
+     * const round = 12345;
+     * await client.getTransactionGroupLedgerStateDeltasForRound(round).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2deltasroundtxngroup)
+     * @param round the round number to be searched for
+     * @category GET
+     */
+    getTransactionGroupLedgerStateDeltasForRound(round: bigint): GetTransactionGroupLedgerStateDeltasForRound;
 }

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

@@ -13,7 +13,7 @@ import { Box } from './models/types';
  * const boxValue = boxResponse.value;
  * ```
  *
- * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2applicationsapplication-idbox)
+ * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2applicationsapplication-idbox)
  * @param index - The application ID to look up.
  * @category GET
  */

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

@@ -12,7 +12,7 @@ import { BoxesResponse } from './models/types';
  * const boxNames = boxesResponse.boxes.map(box => box.name);
  * ```
  *
- * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2applicationsapplication-idboxes)
+ * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2applicationsapplication-idboxes)
  * @param index - The application ID to look up.
  * @category GET
  */

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

@@ -0,0 +1,6 @@
+import JSONRequest from '../jsonrequest';
+import { GetBlockTimeStampOffsetResponse } from './models/types';
+export default class GetBlockOffsetTimestamp extends JSONRequest<GetBlockTimeStampOffsetResponse, Record<string, any>> {
+    path(): string;
+    prepare(body: Record<string, any>): GetBlockTimeStampOffsetResponse;
+}

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

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

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

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

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

@@ -0,0 +1,6 @@
+import JSONRequest from '../jsonrequest';
+import { GetSyncRoundResponse } from './models/types';
+export default class GetSyncRound extends JSONRequest<GetSyncRoundResponse, Record<string, any>> {
+    path(): string;
+    prepare(body: Record<string, any>): GetSyncRoundResponse;
+}

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

@@ -0,0 +1,10 @@
+import JSONRequest from '../jsonrequest';
+import { TransactionGroupLedgerStateDeltasForRoundResponse } from './models/types';
+import HTTPClient from '../../client';
+import IntDecoding from '../../../types/intDecoding';
+export default class GetTransactionGroupLedgerStateDeltasForRound extends JSONRequest<TransactionGroupLedgerStateDeltasForRoundResponse, Record<string, any>> {
+    private round;
+    constructor(c: HTTPClient, intDecoding: IntDecoding, round: bigint);
+    path(): string;
+    prepare(body: Record<string, any>): TransactionGroupLedgerStateDeltasForRoundResponse;
+}