Skip to content

Document current local node testing workflow for client and web development #276

@BrianSeong99

Description

@BrianSeong99

Problem

There is no clear, supported guide for testing client and web-client code against a local Miden node.

Pioneer feedback describes the current process as requiring direct coordination with the Miden team, a localhost wallet from Wiktor, and custom frontend proxy setup to make browser code talk to node gRPC endpoints. Relying only on testnet slows development and makes debugging harder, especially when testnet does not expose enough failure detail.

There is ongoing work toward a more Foundry-like local development experience. This issue should not try to design or replace that product surface. It should document the current testing workflow that developers can use today, plus the known gaps.

Why this matters

Developers need a repeatable local loop:

  • start local node,
  • point web client at local RPC/prover/note transport,
  • create/import usable accounts,
  • run app flows,
  • debug failed transactions and network notes.

Without that loop, app teams use shared testnet as their development environment and become blocked on network state, rate limits, incomplete errors, or team-provided accounts.

Proposed scope

Add a docs guide for local node testing that covers the currently supported path:

  • how to start a local node with the currently supported tooling,
  • macOS and Linux prerequisites,
  • Docker/local-node expectations where applicable,
  • how Rust client tests target local node,
  • how WebClient / MidenClient.create(...) should be configured for local RPC/prover/note transport URLs,
  • browser/gRPC/proxy expectations and known limitations,
  • how to create or import local test accounts,
  • how to run a minimal smoke test,
  • how to inspect transaction errors and network-note status locally.

Keep this aligned with current node/midenup work, but do not make this issue responsible for implementing the future one-command local dev flow.

Acceptance criteria

  • A developer can follow one docs page to run the currently supported local-node testing setup.
  • The guide covers macOS and Linux prerequisites.
  • The guide states whether Docker is the supported default path today.
  • The guide includes a minimal Rust client local-node test path or command.
  • The guide includes a minimal MidenClient.create(...) local configuration example for web clients.
  • The guide documents browser/proxy limitations instead of implying they are solved.
  • The guide links to node/midenup local-dev tracking issues for future one-command UX work.

Related context

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions