algod REST API: Add support for algod /v2/teal/disassemble (#702)

* Add test for algod /v2/teal/disassemble

* Merge develop into PR (#736)

* ABI:  Refactor ABI encoding test to round-trip (#701)

* bump version and add to changelog

* update README.md for new version

* Packaging: Improve source map and browser usage for external bundlers (#707)

* bump version and add to changelog

* update README.md for new version

* v2: Make breaking changes from v1 to v2.0.0  (#717)

* bump version and add to changelog

* update README.md for new version

* remove enhancement section of recent changelog

* Enhancement: Add foreign array objects to ATC `addMethodCall` (#725)

* Add foreign array objects to ATC addmethodcall

* Copy array value so that inputs are not modified

Co-authored-by: Michael Diamant <[email protected]>
Co-authored-by: Lucky Baar <[email protected]>
Co-authored-by: Jason Paulos <[email protected]>
Co-authored-by: Jack Smith <[email protected]>
Co-authored-by: Barbara Poon <[email protected]>

* Explicitly import Buffer

* Revert test branch back to master

Co-authored-by: algochoi <[email protected]>
Co-authored-by: Lucky Baar <[email protected]>
Co-authored-by: Jason Paulos <[email protected]>
Co-authored-by: Jack Smith <[email protected]>
Co-authored-by: Barbara Poon <[email protected]>

.gitignore

@@ -1,6 +1,8 @@
 .DS_Store
 
 .idea/
+# Webstorm
+*.iml
 .vscode/*
 !.vscode/settings.json
 !.vscode/extensions.json

src/client/v2/algod/algod.ts

@@ -30,6 +30,7 @@ import {
 } from '../../urlTokenBaseHTTPClient';
 import LightBlockHeaderProof from './lightBlockHeaderProof';
 import StateProof from './stateproof';
+import Disassemble from './disassemble';
 
 /**
  * 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.
@@ -397,6 +398,22 @@ export default class AlgodClient extends ServiceClient {
     return new Compile(this.c, source);
   }
 
+  /**
+   * Given the program bytes, return the TEAL source code in plain text.
+   *
+   * #### Example
+   * ```typescript
+   * const bytecode = "TEAL bytecode";
+   * const disassembledSource = await algodClient.disassemble(bytecode).do();
+   * ```
+   *
+   * @remarks This endpoint is only enabled when a node's configuration file sets EnableDeveloperAPI to true.
+   * @param source
+   */
+  disassemble(source: string | Uint8Array) {
+    return new Disassemble(this.c, source);
+  }
+
   /**
    * Provides debugging information for a transaction (or group).
    *

src/client/v2/algod/disassemble.ts

@@ -0,0 +1,46 @@
+import { Buffer } from 'buffer';
+import JSONRequest from '../jsonrequest';
+import HTTPClient from '../../client';
+
+/**
+ * Sets the default header (if not previously set)
+ * @param headers - A headers object
+ */
+export function setHeaders(headers = {}) {
+  let hdrs = headers;
+  if (Object.keys(hdrs).every((key) => key.toLowerCase() !== 'content-type')) {
+    hdrs = { ...headers };
+    hdrs['Content-Type'] = 'text/plain';
+  }
+  return hdrs;
+}
+
+/**
+ * Executes disassemble
+ */
+export default class Disassemble extends JSONRequest {
+  constructor(c: HTTPClient, private source: string | Uint8Array) {
+    super(c);
+    this.source = source;
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+  path() {
+    return `/v2/teal/disassemble`;
+  }
+
+  /**
+   * Executes disassemble
+   * @param headers - A headers object
+   */
+  async do(headers = {}) {
+    const txHeaders = setHeaders(headers);
+    const res = await this.c.post(
+      this.path(),
+      Buffer.from(this.source),
+      txHeaders,
+      this.query
+    );
+    return res.body;
+  }
+}

tests/cucumber/integration.tags

@@ -6,6 +6,7 @@
 @auction
 @c2c
 @compile
+@compile.disassemble
 @compile.sourcemap
 @dryrun
 @kmd

tests/cucumber/steps/steps.js

@@ -4550,6 +4550,20 @@ module.exports = function getSteps(options) {
     }
   );
 
+  Then(
+    'disassembly of {string} matches {string}',
+    async function (bytecodeFilename, sourceFilename) {
+      const bytecode = await loadResource(bytecodeFilename);
+      const resp = await this.v2Client.disassemble(bytecode).do();
+      const expectedSource = await loadResource(sourceFilename);
+
+      assert.deepStrictEqual(
+        resp.result.toString('UTF-8'),
+        expectedSource.toString('UTF-8')
+      );
+    }
+  );
+
   When(
     'we make a GetLightBlockHeaderProof call for round {int}',
     async function (int) {