algosdk 1.23.2 → 1.24.1

package/src/client/v2/algod/dryrun.ts

@@ -0,0 +1,33 @@
+import JSONRequest from '../jsonrequest';
+import HTTPClient from '../../client';
+import * as modelsv2 from './models/types';
+import * as encoding from '../../../encoding/encoding';
+import { setHeaders } from './compile';
+
+export default class Dryrun extends JSONRequest {
+  private blob: Uint8Array;
+
+  constructor(c: HTTPClient, dr: modelsv2.DryrunRequest) {
+    super(c);
+    this.blob = encoding.encode(dr.get_obj_for_encoding(true));
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+  path() {
+    return '/v2/teal/dryrun';
+  }
+
+  /**
+   * Executes dryrun
+   * @param headers - A headers object
+   */
+  async do(headers = {}) {
+    const txHeaders = setHeaders(headers);
+    const res = await this.c.post(
+      this.path(),
+      Buffer.from(this.blob),
+      txHeaders
+    );
+    return res.body;
+  }
+}

package/src/client/v2/algod/genesis.ts

@@ -0,0 +1,8 @@
+import JSONRequest from '../jsonrequest';
+
+export default class Genesis extends JSONRequest {
+  // eslint-disable-next-line class-methods-use-this
+  path() {
+    return '/genesis';
+  }
+}

package/src/client/v2/algod/getApplicationBoxByName.ts

@@ -0,0 +1,49 @@
+import JSONRequest from '../jsonrequest';
+import HTTPClient from '../../client';
+import IntDecoding from '../../../types/intDecoding';
+import { Box } from './models/types';
+
+/**
+ * Given an application ID and the box name (key), return the value stored in the box.
+ *
+ * #### Example
+ * ```typescript
+ * const index = 60553466;
+ * const boxName = Buffer.from("foo");
+ * const boxResponse = await algodClient.getApplicationBoxByName(index, boxName).do();
+ * const boxValue = boxResponse.value;
+ * ```
+ *
+ * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2applicationsapplication-idbox)
+ * @param index - The application ID to look up.
+ * @category GET
+ */
+export default class GetApplicationBoxByName extends JSONRequest<
+  Box,
+  Record<string, any>
+> {
+  constructor(
+    c: HTTPClient,
+    intDecoding: IntDecoding,
+    private index: number,
+    name: Uint8Array
+  ) {
+    super(c, intDecoding);
+    this.index = index;
+    // Encode name in base64 format and append the encoding prefix.
+    const encodedName = Buffer.from(name).toString('base64');
+    this.query.name = encodeURI(`b64:${encodedName}`);
+  }
+
+  /**
+   * @returns `/v2/applications/${index}/box`
+   */
+  path() {
+    return `/v2/applications/${this.index}/box`;
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+  prepare(body: Record<string, any>): Box {
+    return Box.from_obj_for_encoding(body);
+  }
+}

package/src/client/v2/algod/getApplicationBoxes.ts

@@ -0,0 +1,61 @@
+import JSONRequest from '../jsonrequest';
+import HTTPClient from '../../client';
+import IntDecoding from '../../../types/intDecoding';
+import { BoxesResponse } from './models/types';
+
+/**
+ * Given an application ID, return all the box names associated with the app.
+ *
+ * #### Example
+ * ```typescript
+ * const index = 60553466;
+ * const boxesResponse = await algodClient.getApplicationBoxes(index).max(3).do();
+ * const boxNames = boxesResponse.boxes.map(box => box.name);
+ * ```
+ *
+ * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2applicationsapplication-idboxes)
+ * @param index - The application ID to look up.
+ * @category GET
+ */
+export default class GetApplicationBoxes extends JSONRequest<
+  BoxesResponse,
+  Record<string, any>
+> {
+  constructor(c: HTTPClient, intDecoding: IntDecoding, private index: number) {
+    super(c, intDecoding);
+    this.index = index;
+    this.query.max = 0;
+  }
+
+  /**
+   * @returns `/v2/applications/${index}/boxes`
+   */
+  path() {
+    return `/v2/applications/${this.index}/boxes`;
+  }
+
+  /**
+   * Limit results for pagination.
+   *
+   * #### Example
+   * ```typescript
+   * const maxResults = 20;
+   * const boxesResult = await algodClient
+   *        .GetApplicationBoxes(1234)
+   *        .limit(maxResults)
+   *        .do();
+   * ```
+   *
+   * @param limit - maximum number of results to return.
+   * @category query
+   */
+  max(max: number) {
+    this.query.max = max;
+    return this;
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+  prepare(body: Record<string, any>): BoxesResponse {
+    return BoxesResponse.from_obj_for_encoding(body);
+  }
+}

package/src/client/v2/algod/getApplicationByID.ts

@@ -0,0 +1,14 @@
+import JSONRequest from '../jsonrequest';
+import HTTPClient from '../../client';
+import IntDecoding from '../../../types/intDecoding';
+
+export default class GetApplicationByID extends JSONRequest {
+  constructor(c: HTTPClient, intDecoding: IntDecoding, private index: number) {
+    super(c, intDecoding);
+    this.index = index;
+  }
+
+  path() {
+    return `/v2/applications/${this.index}`;
+  }
+}

package/src/client/v2/algod/getAssetByID.ts

@@ -0,0 +1,14 @@
+import JSONRequest from '../jsonrequest';
+import HTTPClient from '../../client';
+import IntDecoding from '../../../types/intDecoding';
+
+export default class GetAssetByID extends JSONRequest {
+  constructor(c: HTTPClient, intDecoding: IntDecoding, private index: number) {
+    super(c, intDecoding);
+    this.index = index;
+  }
+
+  path() {
+    return `/v2/assets/${this.index}`;
+  }
+}

package/src/client/v2/algod/getBlockHash.ts

@@ -0,0 +1,18 @@
+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) {
+    super(c, intDecoding);
+    if (!Number.isInteger(roundNumber))
+      throw Error('roundNumber should be an integer');
+    this.round = roundNumber;
+  }
+
+  path() {
+    return `/v2/blocks/${this.round}/hash`;
+  }
+}

package/src/client/v2/algod/getTransactionProof.ts

@@ -0,0 +1,43 @@
+import JSONRequest from '../jsonrequest';
+import HTTPClient from '../../client';
+import IntDecoding from '../../../types/intDecoding';
+
+export default class GetTransactionProof extends JSONRequest {
+  constructor(
+    c: HTTPClient,
+    intDecoding: IntDecoding,
+    private round: number,
+    private txID: string
+  ) {
+    super(c, intDecoding);
+
+    this.round = round;
+    this.txID = txID;
+  }
+
+  path() {
+    return `/v2/blocks/${this.round}/transactions/${this.txID}/proof`;
+  }
+
+  /**
+   * Exclude assets and application data from results
+   * The type of hash function used to create the proof, must be one of: "sha512_256", "sha256"
+   *
+   * #### Example
+   * ```typescript
+   * const hashType = "sha256";
+   * const round = 123456;
+   * const txId = "abc123;
+   * const txProof = await algodClient.getTransactionProof(round, txId)
+   *        .hashType(hashType)
+   *        .do();
+   * ```
+   *
+   * @param hashType
+   * @category query
+   */
+  hashType(hashType: string) {
+    this.query.hashtype = hashType;
+    return this;
+  }
+}

package/src/client/v2/algod/healthCheck.ts

@@ -0,0 +1,19 @@
+import JSONRequest from '../jsonrequest';
+
+/**
+ * healthCheck returns an empty object iff the node is running
+ */
+export default class HealthCheck extends JSONRequest {
+  // eslint-disable-next-line class-methods-use-this
+  path() {
+    return '/health';
+  }
+
+  async do(headers = {}) {
+    const res = await this.c.get(this.path(), {}, headers);
+    if (!res.ok) {
+      throw new Error(`Health response: ${res.status}`);
+    }
+    return {};
+  }
+}

package/src/client/v2/algod/lightBlockHeaderProof.ts

@@ -0,0 +1,15 @@
+import JSONRequest from '../jsonrequest';
+import HTTPClient from '../../client';
+import IntDecoding from '../../../types/intDecoding';
+
+export default class LightBlockHeaderProof extends JSONRequest {
+  constructor(c: HTTPClient, intDecoding: IntDecoding, private round: number) {
+    super(c, intDecoding);
+
+    this.round = round;
+  }
+
+  path() {
+    return `/v2/blocks/${this.round}/lightheader/proof`;
+  }
+}