feat: enable TX debugging by djolertrk · Pull Request #1883 · 0xMiden/miden-client

djolertrk · 2026-03-10T08:37:13Z

Enable transaction debugging with Debugger Adapter Protocol.

djolertrk · 2026-03-10T17:08:39Z

Rebased on top of next now, since the PR for migration to new VM is merged.

juan518munoz · 2026-03-11T12:52:25Z

+[patch.crates-io]
+miden-protocol = { path = "../protocol/crates/miden-protocol" }
+miden-standards = { path = "../protocol/crates/miden-standards" }
+miden-testing = { path = "../protocol/crates/miden-testing" }
+miden-tx = { path = "../protocol/crates/miden-tx" }


This needs to be removed

juan518munoz · 2026-03-11T12:52:41Z

 miden-node-ntx-builder           = { version = "=0.14.0-alpha.4" }
 miden-node-proto                 = { version = "=0.14.0-alpha.4" }
-miden-node-proto-build           = { default-features = false, version = "=0.14.0-alpha.4" }
+miden-node-proto-build           = { default-features = false, path = "../node/proto", version = "=0.14.0-alpha.1" }


This also needs to be fixed.

Yes, sure. I should have marked this as a draft.

juan518munoz · 2026-03-11T13:10:46Z

Could you provide a more detailed description like screenshots and a sample debug flow?

djolertrk · 2026-03-11T20:00:45Z

Could you provide a more detailed description like screenshots and a sample debug flow?

Hi @juan518munoz, thanks for taking a look.

The main idea is to enhance debugger with support to debug programs executed under the transaction kernel, instead of only debugging standalone VM programs.

Please check:

0xMiden/miden-debug#29

0xMiden/miden-debug#41
0xMiden/protocol#2574

Within 0xMiden/miden-debug#29, I have described one of possible use cases, but I was able to add even an "offline" mode to this dap execution, so you just do:

run

# terminal 1

$  miden-client init --local --network localhost
$ miden-client new-wallet --offline
$ miden-client exec \
    --script-path /tmp/miden-no-node-client/nop.masm \
    --start-debug-adapter localhost:4711

and run debugger as:

# terminal 2
miden-debug --dap-connect localhost:4711

so, it starts the debugger in TUI mode, and you can step through the execution, and whenever you execute a command via DAP, it will be logged with the client -- see picture attached.

juan518munoz

Let's update the branch so we can run the CI

juan518munoz · 2026-03-16T19:56:40Z

+            client
+                .execute_program(account_id, tx_script, advice_inputs, BTreeSet::new())
+                .await
+        };
+
+        #[cfg(not(feature = "dap"))]
        let result = client
            .execute_program(account_id, tx_script, advice_inputs, BTreeSet::new())
            .await;


This is duplicated code. Maybe the best approach is not to split between feature = "dap" or not.

juan518munoz · 2026-03-16T19:59:00Z

 path = "src/main.rs"

+[features]
+dap = ["miden-client/dap", "dep:miden-debug"]


Should we gate behind a feature? Or have connection depend on an Optional argument?

I moved the CLI behavior toward the optional-argument model. The --start-debug-adapter is now always part of the CLI surface, and if the binary is built without DAP support it returns a clear runtime error. Furthermore, I kept the actual debugger wiring behind the dap feature because miden-debug currently requires a newer Rust version than the rest of the client workspace. So making it unconditional would raise the default build/toolchain requirements for miden-client. If that constraint goes away, we can simplify further and drop the feature gate.

juan518munoz · 2026-03-16T20:02:51Z

 use crate::store::{BlockRelevance, StoreError};
 use crate::{Client, ClientError};

+const OFFLINE_NATIVE_ASSET_FAUCET_ID: u128 = 0xab00_0000_0000_cd20_0000_ac00_0000_de00;


let's doc this

juan518munoz · 2026-03-16T20:08:36Z

The whole diff of this part seems to be caused due to not being on track with next. As we should already have solved them here.

Now rebased on top of next.

djolertrk · 2026-03-19T12:25:13Z

Let's update the branch so we can run the CI

protocol part 0xMiden/protocol#2574 -- went in, but I think we would need 0xMiden/miden-debug#41 (debugger part) to be merged, so we can get rid of ../miden-debug dependency...

juan518munoz · 2026-03-19T17:51:16Z

@djolertrk I've enabled CI runs on this PR. Let's wait for 0xMiden/miden-debug#41 as you said and update to it. Once it's done and the CI passes feel free to re-request reviews so we can merge this.

djolertrk · 2026-03-26T19:33:53Z

hey @juan518munoz, the PR in miden-debug (0xMiden/miden-debug#41) is merged! we can enable CI now. Thanks!

djolertrk · 2026-03-27T08:55:30Z

cc @bitwalker

juan518munoz

Thanks for updating the PR! Looks like it won't be hard to merge as there is no breaking change, but there are still some comments that need to be addressed.

juan518munoz · 2026-03-27T18:27:14Z

 path = "src/main.rs"

+[features]
+# Keep debugger integration optional while `miden-debug` requires a newer Rust version than the


I'm not sure by this is mandatory, why does one require a higher version than the other?

It is not the case anymore, the compiler is the same. Will remove the stale comment.

juan518munoz · 2026-03-27T18:28:20Z

 should_panic_without_expect = "allow" # We don't care about the specific panic message.
 # End of pedantic lints.
+
+[patch.crates-io]


This patches need to be removed before merging

In order to do it, we will need to wait for this to be published to creates.io

juan518munoz · 2026-03-27T18:28:29Z

+miden-utils-diagnostics = { git = "https://github.com/0xMiden/miden-vm.git", rev = "1b60fa4b54e60075cad7a761b593d5c00c6aaf46" }
+miden-utils-indexing    = { git = "https://github.com/0xMiden/miden-vm.git", rev = "1b60fa4b54e60075cad7a761b593d5c00c6aaf46" }
+
+[patch."https://github.com/0xMiden/miden-base"]


This as well

djolertrk · 2026-03-27T20:22:27Z

Thanks for updating the PR! Looks like it won't be hard to merge as there is no breaking change, but there are still some comments that need to be addressed.

Thanks a lot for the comments!

juan518munoz · 2026-03-31T18:04:24Z

+    /// Executes the provided transaction script with a DAP debug adapter listening for
+    /// connections, allowing interactive debugging via any DAP-compatible client.
+    #[cfg(feature = "dap")]
+    pub async fn execute_program_with_dap(


This function is almost to execute_program, can't we generalize it?

yes, good point, thank you

juan518munoz · 2026-03-31T18:35:53Z

    }
 }

+fn synthetic_offline_genesis_header() -> BlockHeader {


Correct me if wrong, but this functions seems redundant as we can achieve the same with MockChainBuilder

MockChainBuilder::new() .native_asset_id(some_id) .verification_base_fee(500) .build() .expect("mock chain build should be valid") .genesis_block_header()

Hmm, but we would need to mark the miden-testing a non-optional dependency

juan518munoz · 2026-03-31T18:38:17Z

    }
+
+    #[test]
+    fn synthetic_offline_genesis_header_matches_empty_chain_state() {


If the other comment applies, we should remove this.

Use miden-debug's DapExecutorFactory and DapConfig to let miden-client execute transaction scripts under a debug adapter via --start-debug-adapter.

djolertrk · 2026-04-04T09:15:47Z

Why did we delete the release/v0.14.0-beta?

Btw, we are waiting for the crates for miden-vm and debugger to be published, so we can update this PR not to rely to these dependencies by GitHub SHA. This is the last piece to enable real transaction debugging with our miden-debug debugger.

djolertrk force-pushed the pr/enable-tx-debugging-clean branch from e502fbb to ec3fa67 Compare March 10, 2026 17:08

juan518munoz reviewed Mar 11, 2026

View reviewed changes

djolertrk marked this pull request as draft March 13, 2026 10:47

juan518munoz reviewed Mar 16, 2026

View reviewed changes

juan518munoz changed the title ~~Enable TX debugging~~ feat: enable TX debugging Mar 16, 2026

djolertrk mentioned this pull request Mar 17, 2026

Enable debugging code in the client 0xMiden/miden-debug#29

Closed

djolertrk force-pushed the pr/enable-tx-debugging-clean branch from f33d10b to 5c75028 Compare March 19, 2026 12:25

bitwalker mentioned this pull request Mar 25, 2026

Implement LSP and DAP servers for MASM 0xMiden/miden-vm#1900

Closed

djolertrk force-pushed the pr/enable-tx-debugging-clean branch from c310c9c to 4a3fbf6 Compare March 26, 2026 18:51

djolertrk marked this pull request as ready for review March 26, 2026 19:33

djolertrk changed the base branch from next to release/v0.14.0-beta March 26, 2026 19:34

juan518munoz reviewed Mar 27, 2026

View reviewed changes

djolertrk force-pushed the pr/enable-tx-debugging-clean branch from 74204f3 to c5b6c4a Compare March 30, 2026 11:18

juan518munoz reviewed Mar 31, 2026

View reviewed changes

djolertrk added 7 commits April 1, 2026 12:15

feat: add DAP-backed transaction script execution

ea87a44

Use miden-debug's DapExecutorFactory and DapConfig to let miden-client execute transaction scripts under a debug adapter via --start-debug-adapter.

Add offline bootstrap mode for local exec

e982f70

Adapt client to direct tx executors

f7cb70e

fixup: pin protocol rev and update client for tx debugging

03578db

fixup: resolve next rebase API drift

a09c8fa

fixup: address client review follow-ups

081e289

fixup: adjust to the new DAP

cda6533

djolertrk added 7 commits April 1, 2026 12:15

fixup: adapt DAP patches for release/v0.14.0-beta base

07120b4

fixup: point miden-debug to merged upstream rev

7558c63

fixup: use SecretKey::with_rng for wasm compatibility

60f4178

fixup: cargo fmt

dcfb147

fixup: add changelog and fix .toml format

2b245bb

fixup: remove stale comment

3f9d54b

fixup: generalize execute_program, revert test assertion

f5ed3a7

djolertrk force-pushed the pr/enable-tx-debugging-clean branch from c5b6c4a to f5ed3a7 Compare April 1, 2026 13:01

igamigo deleted the branch 0xMiden:release/v0.14.0-beta April 4, 2026 02:29

igamigo closed this Apr 4, 2026

djolertrk mentioned this pull request Apr 6, 2026

feat: enable DAP-backed transaction script debugging #1959

Merged

Conversation

djolertrk commented Mar 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

djolertrk commented Mar 10, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

juan518munoz commented Mar 11, 2026

Uh oh!

djolertrk commented Mar 11, 2026

Uh oh!

juan518munoz left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

djolertrk commented Mar 19, 2026

Uh oh!

juan518munoz commented Mar 19, 2026

Uh oh!

djolertrk commented Mar 26, 2026

Uh oh!

djolertrk commented Mar 27, 2026

Uh oh!

juan518munoz left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

djolertrk commented Mar 27, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

djolertrk commented Apr 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

djolertrk commented Mar 10, 2026 •

edited

Loading

djolertrk commented Apr 4, 2026 •

edited

Loading