Skip to content

feat(docs): add TypeDoc API reference links for web SDK #1625

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
avorylli wants to merge 3 commits into
base: next
Choose a base branch
from
Open

feat(docs): add TypeDoc API reference links for web SDK #1625

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7cce616
Update README.md
avorylli Dec 18, 2025
feafdba
Update Miden Web SDK documentation
avorylli Dec 18, 2025
b06049c
Update CHANGELOG for version 0.13.0
avorylli Dec 18, 2025
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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

## 0.13.0 (TBD)

* Added TypeDoc API reference links for web SDK in main README and Docusaurus documentation ([#1356](https://github.com/0xMiden/miden-client/issues/1356)).
* [BREAKING] Removed `getRpoFalcon512PublicKeyAsWord` and `getEcdsaK256KeccakPublicKeyAsWord` in `AuthSecretKey`
* Improved auth scheme handling across the Rust and web clients (typed `build_wallet_id`, unified transaction tests, new shared `getPublicKeyAsWord` binding, and refreshed typedoc output) ([#1556](https://github.com/0xMiden/miden-client/pull/1556)).
* [BREAKING] Typed the `auth_scheme` plumbing across the Rust WebClient ID-building helpers and aligned the WebClient bindings with the native enum to avoid passing raw identifiers ([#1546](https://github.com/0xMiden/miden-client/pull/1546)).
Expand Down
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,11 @@ The Miden client is still under heavy development and the project can be conside

## Overview

The Miden client currently consists of two components:
The Miden client currently consists of three components:

- `miden-client` library, which can be used by other project to programmatically interact with the Miden rollup. You can find more information about the library in the [Rust client Library](./crates/rust-client/README.md) section.
- `miden-client-cli`, which is a wrapper around the library exposing its functionality via a simple command-line interface (CLI). You can find more information about the CLI in the [Miden client CLI](./bin/miden-cli/README.md) section.
- `@demox-labs/miden-sdk` (web client), which is a browser-focused SDK for interacting with the Miden rollup from web applications. You can find more information about the web client in the [Web Client README](./crates/web-client/README.md) section.

The client's main responsibility is to maintain a partial view of the blockchain which allows for locally executing and proving transactions. It keeps a local store of various entities that periodically get updated by syncing with the node.

Expand Down
4 changes: 4 additions & 0 deletions docs/external/src/web-client/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,3 +38,7 @@ yarn add @demox-labs/miden-sdk
```

See the [README](https://github.com/0xMiden/miden-client/blob/main/crates/web-client/README) for full installation instructions and some usage instructions, including code examples for wallet creation, transaction execution, and syncing state.

## API Reference

For complete API documentation, see the [TypeDoc API Reference](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/README.md).