Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,18 @@
# Soroban Testkit Interface

A visual companion to [Soroban Testkit](https://github.com/soroban-testkit/testkit-blockchain). It documents the library's focused testing modules and provides a command builder for the supported CLI workflows.
A visual companion to [Soroban Testkit](https://github.com/soroban-testkit/testkit-blockchain). It documents the library's focused testing modules and provides an accessible, validated command builder for supported CLI workflows (`coverage`, `limits`, `audit`).

The interface does not execute contracts in the browser. Generated commands run locally through `soroban-testkit`, keeping contract tests deterministic and offline as required by the core project.

## Features

- **CLI Workbench**: Switch between `coverage`, `limits`, and `audit` command builders with instant command generation and argument quoting.
- **Accessible Workflow Navigation**: Compliant with WAI-ARIA tab pattern (`role="tablist"`, `role="tab"`, `role="tabpanel"`). Navigate workflows using keyboard arrow keys (`ArrowRight`, `ArrowLeft`), `Home`, and `End` with roving `tabIndex`.
- **Form Controls & Labels**: Explicit association of labels and form controls (`htmlFor` / `id`), enabling assistive technology support.
- **Input Validation**: Real-time validation for required contract paths and limits identifiers (`fn` and `ramp` verified as valid Rust identifiers). Displays inline `role="alert"` messages linked with `aria-invalid` and `aria-describedby`, safely disabling clipboard copy while inputs are invalid.
- **Default Reset**: Quickly restore customized inputs back to canonical workflow defaults via the `Reset` action.
- **Clipboard Feedback & Status**: Copy commands with visual and screen-reader status announcements via `aria-live="polite"`. Handles clipboard success (`Copied`) as well as graceful error recovery on failure (`Failed`).

## Development

```sh
Expand Down
Loading