feat: debugger package implementation (#1)

* chore: wip * chore: addressing pr comments * feat: debug utils package * chore: temp add pre build utils for CI tests * refactor: simplifying event handlers * docs: regen docs * chore: update src/index.ts Co-authored-by: Neil Campbell <[email protected]> * chore: addressing pr comments * refactor: apply suggestions from code review Co-authored-by: Neil Campbell <[email protected]> * chore: prerelease version of utils --------- Co-authored-by: Neil Campbell <[email protected]>
algorandfoundation · Sep 30, 2024 · 795b94a · 795b94a
1 parent 0a151ba
commit 795b94a
Show file tree

Hide file tree

Showing 30 changed files with 1,801 additions and 1,748 deletions.
diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml
@@ -19,19 +19,7 @@ jobs:
         pipx install algokit
         algokit localnet start
         npx --yes wait-on tcp:4001 -t 30000
-      audit-script: |
-        npm run audit
-  pull_request_debug_package:
-    uses: makerxstudio/shared-config/.github/workflows/node-ci.yml@main
-    with:
-      node-version: 18.x
-      working-directory: ./debug-utils
-      run-commit-lint: true
-      run-build: true
-      pre-test-script: |
-        pipx install algokit
-        algokit localnet start
-        npx --yes wait-on tcp:4001 -t 30000
+        npm install --no-package-lock
       audit-script: |
         npm run audit
   check_docs:

diff --git a/.prettierignore b/.prettierignore
@@ -12,5 +12,3 @@ coverage
 .idea
 # don't format auto generated code docs
 docs/code
-# don't format test contract artifacts
-tests/example-contracts/**/*.json
diff --git a/README.md b/README.md
@@ -1,54 +1,73 @@
-# AlgoKit TypeScript Utilities
+# AlgoKit TypeScript AVM Debugging Utilities
 
-A set of core Algorand utilities written in TypeScript and released via npm that make it easier to build solutions on Algorand. This project is part of [AlgoKit](https://github.com/algorandfoundation/algokit-cli).
+An optional addon package for [algokit-utils-ts](https://github.com/algorandfoundation/algokit-utils-ts) that provides **node** specific utilities that automatically gather artifacts required for instantiating [AlgoKit AVM VSCode Debugger Extension](https://github.com/algorandfoundation/algokit-avm-vscode-debugger). This project is part of [AlgoKit](https://github.com/algorandfoundation/algokit-cli).
 
-The goal of this library is to provide intuitive, productive utility functions that make it easier, quicker and safer to build applications on Algorand. Largely these functions wrap the underlying Algorand SDK, but provide a higher level interface with sensible defaults and capabilities for common tasks.
+Note: [Python's version of algokit-utils](https://github.com/algorandfoundation/algokit-utils-py) contains the same functionality without requiring a separate package install. Consider using that if you are building your AlgoKit project in Python.
 
-Note: If you prefer Python there's an equivalent [Python utility library](https://github.com/algorandfoundation/algokit-utils-py).
-
-[Install](#install) | [Documentation](docs/README.md)
+[Install](#install) | [Documentation](docs/code/README.md)
 
 ## Install
 
 This library can be installed from NPM using your favourite npm client, e.g.:
 
 ```
-npm install @algorandfoundation/algokit-utils
+npm install @algorandfoundation/algokit-utils-debug
 ```
 
-Then to import it:
+Then to import it and activate `utils-ts` debugging:
 
 ```typescript
-import { AlgorandClient, Config } from '@algorandfoundation/algokit-utils'
+import { Config } from '@algorandfoundation/algokit-utils'
+import { registerDebugHandlers } from '@algorandfoundation/algokit-utils-debug'
+
+Config.configure({
+  debug: true,
+  traceAll: true, // optional, defaults to false, ignoring simulate on successfull transactions.
+  projectRoot: '/path/to/project/root', // if not set, this package will try to find the project root automatically using either the 'ALGOKIT_PROJECT_ROOT' environment variable or by searching you project structure
+  traceBufferSizeMb: 256, // optional, defaults to 256 megabytes. When the output folder containing debug trace files exceeds the size, oldest files are removed to optimize for storage consumption. This is useful when you are running a long running application and want to keep the trace files for debugging purposes but also be mindful of storage consumption.
+  maxSearchDepth: 10, // optional, defaults to 10. The maximum depth to search for an `algokit` config file. By default it will traverse at most `10` folders searching for `.algokit.toml` file which will be used to determine the algokit compliant project root path. Ignored if `projectRoot` is provided directly or via `ALGOKIT_PROJECT_ROOT` environment variable.
+})
+registerDebugHandlers() // IMPORTANT: must be called before any transactions are submitted.
 ```
 
-See [usage](./docs/README.md#usage) for more.
+See [code documentation](./docs/code/README.md) for more details.
 
-## Guiding principles
+## Overview
 
-This library follows the [Guiding Principles of AlgoKit](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/algokit.md#guiding-principles).
+This library provides three main functions for debugging Algorand smart contracts:
+
+1. `registerDebugEventHandlers`: The primary function users need to call. It sets up listeners for debugging events emitted by `algokit-utils-ts` (see [AsyncEventEmitter](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/docs/capabilities/event-emitter.md) docs for more details). Must be called before submitting transactions and enabling debug mode in the `algokit-utils-ts` config.
+
+2. `writeTealDebugSourceMaps`: Generates and persists AlgoKit AVM Debugger-compliant sourcemaps. It processes an array of `PersistSourceMapInput` objects, which can contain either raw TEAL or pre-compiled TEAL from algokit.
+
+3. `writeAVMDebugTrace`: Simulates atomic transactions and saves the simulation response as an AlgoKit AVM Debugger-compliant JSON file. It uses the provided `AtomicTransactionComposer` and `Algodv2` client for simulation.
+
+### Default artifact folders
 
-## NextJS compatibility
+- `{ALGOKIT_PROJECT_ROOT}/.algokit/sources/*`: The folder containing the TEAL source maps and raw TEAL files.
+- `{ALGOKIT_PROJECT_ROOT}/debug_traces`: The folder containing the AVM debug traces.
 
-`algokit-utils-ts` has a set of `node` specific utilities used for simplifying aggregation of artifacts for [AlgoKit VSCode Debugger Extension](https://github.com/algorandfoundation/algokit-avm-vscode-debugger). Which causes Next.js based projects to fail on `fs` module not found. To fix this issue, you can add the following to your `next.config.js` file:
+> Note, TEAL source maps are suffixed with `.tok.map` | `.teal.map` file extension, while Algorand Python source maps are suffixed with `.puya.map`.
 
-```js
-  webpack: (config, { isServer }) => {
-    // Fix for Module not found: Can't resolve 'fs'
-    if (!isServer) {
-      config.resolve.fallback.fs = false;
-    }
-    return config;
-  },
+### Trace filename format
+
+The trace files generated are named in a specific format to provide useful information about the transactions they contain. The format is as follows:
+
+```ts
+;`${timestamp}_lr${lastRound}_${transactionTypes}.trace.avm.json`
 ```
 
-The root cause is due to the fact that, unlike many frameworks, Next.js allows you to import server-only (Node.js APIs that don't work in a browser) code into your page files. When Next.js builds your project, it removes server only code from your client-side bundle by checking which code exists inside one any of the following built-in methods (code splitting):
+Where:
+
+- `timestamp`: The time when the trace file was created, in ISO 8601 format, with colons and periods removed.
+- `lastRound`: The last round when the simulation was performed.
+- `transactionTypes`: A string representing the types and counts of transactions in the atomic group. Each transaction type is represented as `${count}#${type}`, and different transaction types are separated by underscores.
 
-- getServerSideProps
-- getStaticProps
-- getStaticPaths
+For example, a trace file might be named `20220301T123456Z_lr1000_2#pay_1#axfer.trace.avm.json`, indicating that the trace file was created at `2022-03-01T12:34:56Z`, the last round was `1000`, and the atomic group contained 2 payment transactions and 1 asset transfer transaction.
 
-The Module not found: can't resolve 'xyz' error happens when you try to use server only code outside of these methods. Despite `algokit-utils` lazy loading the node specific code dynamically, Next.js does not seem to correctly identify whether a dynamic import is specific to server or client side. Hence the above fix disables the fallback for `fs` module so it ignores polyfilling it on client side.
+## Guiding principles
+
+This library follows the [Guiding Principles of AlgoKit](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/algokit.md#guiding-principles).
 
 ## Contributing
 

diff --git a/docs/code/README.md b/docs/code/README.md
@@ -4,7 +4,90 @@
 
 ## Table of contents
 
-### Modules
+### Functions
 
-- [index](modules/index.md)
-- [types/debugging](modules/types_debugging.md)
+- [registerDebugEventHandlers](README.md#registerdebugeventhandlers)
+- [writeAVMDebugTrace](README.md#writeavmdebugtrace)
+- [writeTealDebugSourceMaps](README.md#writetealdebugsourcemaps)
+
+## Functions
+
+### registerDebugEventHandlers
+
+▸ **registerDebugEventHandlers**(): `void`
+
+Registers event handlers for debugging events in Algorand development.
+
+This function sets up handlers for the following events:
+- 'TxnGroupSimulated': Calls the `writeAVMDebugTrace` function to generate and persist an AVM debug trace.
+- 'AppCompiled': Calls the `writeTealDebugSourceMaps` function to generate and persist TEAL source maps.
+
+These handlers help in debugging Algorand smart contracts by providing detailed traces and source maps.
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[index.ts:17](https://github.com/algorandfoundation/algokit-utils-ts-debug/blob/main/src/index.ts#L17)
+
+___
+
+### writeAVMDebugTrace
+
+▸ **writeAVMDebugTrace**(`input`): `Promise`\<`void`\>
+
+Generates an AVM debug trace from the provided simulation response and persists it to a file.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `input` | `AVMTracesEventData` | The AVMTracesEventData containing the simulation response and other relevant information. |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+An object containing the output file path and the trace content as a string.
+
+**`Example`**
+
+```ts
+const eventData: AVMTracesEventData = {
+  simulateResponse: // ... simulation response object
+};
+
+const result = await writeAVMDebugTrace(eventData);
+console.log(`Debug trace saved to: ${result.outputPath}`);
+console.log(`Trace content: ${result.traceContent}`);
+```
+
+#### Defined in
+
+[debugging/writeAVMDebugTrace.ts:20](https://github.com/algorandfoundation/algokit-utils-ts-debug/blob/main/src/debugging/writeAVMDebugTrace.ts#L20)
+
+___
+
+### writeTealDebugSourceMaps
+
+▸ **writeTealDebugSourceMaps**(`input`): `Promise`\<`void`\>
+
+Generates a source map for the given Teal source code.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `input` | `TealSourcesDebugEventData` |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the source map has been generated.
+
+#### Defined in
+
+[debugging/writeTealDebugSourceMaps.ts:36](https://github.com/algorandfoundation/algokit-utils-ts-debug/blob/main/src/debugging/writeTealDebugSourceMaps.ts#L36)
diff --git a/docs/code/classes/types_debugging.AVMDebuggerSourceMap.md b/docs/code/classes/types_debugging.AVMDebuggerSourceMap.md