Objective

Document how to use the dlv debugger in LocalNet.

Origin Document

The LocalNet CLI and logging are useful, but we need to be able to step through the code in unit tests and in a dev environment

Goals

• Anyone who spins up a V1 LocalNet should be able to easily use the debugger, regardless of whether they have experience with it in the past
• Support vscode and Goland as a first iteration

Deliverables

• Documentation on how to use the dlv debugger using vscode
• Documentation on how to use the dlv debugger using Goland
• A gif or video with an example of how the debugger works
• Modifications to the supporting tooling (config files, docker-compose files, etc if necessary)

Non-goals / Non-deliverables

• Modifying the core protocol implementation
• Enabling debugging in DevNet
• Introducing any new telemetry to the codebase

General issue deliverables

• Update the appropriate CHANGELOG
• Update any relevant READMEs (local and/or global)
• Update any relevant global documentation & references
• If applicable, update the source code tree explanation
• If applicable, add or update a state, sequence or flowchart diagram using mermaid

[Optional] Testing Methodology

• LocalNet: verify a LocalNet is still functioning correctly by following the instructions at docs/development/README.md

Creator: @Olshansk
Co-Owners: @andrewnguyen22