diff --git a/.github/workflows/cut-versions.yml b/.github/workflows/cut-versions.yml index cc0d84a9..563d661e 100644 --- a/.github/workflows/cut-versions.yml +++ b/.github/workflows/cut-versions.yml @@ -4,7 +4,7 @@ # # v0.4 Information Architecture: # - Reference docs (protocol, miden-vm, compiler, node) → docs/reference/ -# - Builder docs (tutorials, miden-client) → docs/builder/tutorials/, docs/builder/tools/client/ +# - Builder docs (tutorials, rust-sdk) → docs/builder/tutorials/, docs/builder/tools/client/ # # Workflow responsibilities: # 1. Check out external repos at pinned refs @@ -30,7 +30,7 @@ on: miden_node_ref: { required: false } miden_vm_ref: { required: false } miden_base_ref: { required: false } - miden_client_ref: { required: false } + rust_sdk_ref: { required: false } compiler_ref: { required: false } miden_tutorials_ref: { required: false } @@ -50,7 +50,7 @@ jobs: REPO_NODE: 0xMiden/node REPO_VM: 0xMiden/miden-vm REPO_BASE: 0xMiden/protocol - REPO_CLIENT: 0xMiden/miden-client + REPO_RUST_SDK: 0xMiden/rust-sdk REPO_COMPILER: 0xMiden/compiler REPO_TUTORIALS: 0xMiden/tutorials steps: @@ -91,7 +91,7 @@ jobs: miden_node_ref: getRef(process.env.INPUT_MIDEN_NODE_REF, refs['node']), miden_vm_ref: getRef(process.env.INPUT_MIDEN_VM_REF, refs['miden-vm']), miden_base_ref: getRef(process.env.INPUT_MIDEN_BASE_REF, refs['protocol']), - miden_client_ref: getRef(process.env.INPUT_MIDEN_CLIENT_REF, refs['miden-client']), + rust_sdk_ref: getRef(process.env.INPUT_RUST_SDK_REF, refs['rust-sdk']), compiler_ref: getRef(process.env.INPUT_COMPILER_REF, refs['compiler']), miden_tutorials_ref: getRef(process.env.INPUT_MIDEN_TUTORIALS_REF, refs['tutorials']), }; @@ -121,7 +121,7 @@ jobs: validate "${REPO_NODE}" "${{ steps.manifest.outputs.miden_node_ref }}" validate "${REPO_VM}" "${{ steps.manifest.outputs.miden_vm_ref }}" validate "${REPO_BASE}" "${{ steps.manifest.outputs.miden_base_ref }}" - validate "${REPO_CLIENT}" "${{ steps.manifest.outputs.miden_client_ref }}" + validate "${REPO_RUST_SDK}" "${{ steps.manifest.outputs.rust_sdk_ref }}" validate "${REPO_COMPILER}" "${{ steps.manifest.outputs.compiler_ref }}" validate "${REPO_TUTORIALS}" "${{ steps.manifest.outputs.miden_tutorials_ref }}" @@ -137,7 +137,7 @@ jobs: checkout_ref "${REPO_NODE}" "${{ steps.manifest.outputs.miden_node_ref }}" vendor/node checkout_ref "${REPO_VM}" "${{ steps.manifest.outputs.miden_vm_ref }}" vendor/miden-vm checkout_ref "${REPO_BASE}" "${{ steps.manifest.outputs.miden_base_ref }}" vendor/protocol - checkout_ref "${REPO_CLIENT}" "${{ steps.manifest.outputs.miden_client_ref }}" vendor/miden-client + checkout_ref "${REPO_RUST_SDK}" "${{ steps.manifest.outputs.rust_sdk_ref }}" vendor/rust-sdk checkout_ref "${REPO_COMPILER}" "${{ steps.manifest.outputs.compiler_ref }}" vendor/compiler checkout_ref "${REPO_TUTORIALS}" "${{ steps.manifest.outputs.miden_tutorials_ref }}" vendor/tutorials @@ -249,20 +249,20 @@ jobs: echo "Synced tutorials (miden-bank, components, img, theme, miden_node_setup.md, recipes/rust, recipes/web) → docs/builder/tutorials" fi - if [ -d "vendor/miden-client/docs/external/src" ]; then + if [ -d "vendor/rust-sdk/docs/external/src" ]; then mkdir -p docs/builder/tools/clients - # Selective ingestion: only subdirs/files we still auto-sync from miden-client. + # Selective ingestion: only subdirs/files we still auto-sync from rust-sdk. # web-client/, react-sdk/, and top-level index.md are locally authored in the docs repo # — they are preserved through this clean/ingest cycle. for name in rust-client img theme; do - src="vendor/miden-client/docs/external/src/$name" + src="vendor/rust-sdk/docs/external/src/$name" [ -d "$src" ] && cp -r "$src" docs/builder/tools/clients/ done for name in common-errors.md _category_.yml; do - src="vendor/miden-client/docs/external/src/$name" + src="vendor/rust-sdk/docs/external/src/$name" [ -f "$src" ] && cp "$src" docs/builder/tools/clients/ done - echo "Synced miden-client (rust-client, img, theme, common-errors, _category_) → docs/builder/tools/clients" + echo "Synced rust-sdk (rust-client, img, theme, common-errors, _category_) → docs/builder/tools/clients" fi echo "Content aggregation complete. Final docs structure:" diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml index 21a58a83..4c205ba4 100644 --- a/.github/workflows/deploy-docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -12,8 +12,8 @@ on: miden_tutorials_ref: description: "Ref for 0xMiden/tutorials" required: false - miden_client_ref: - description: "Ref for 0xMiden/miden-client" + rust_sdk_ref: + description: "Ref for 0xMiden/rust-sdk" required: false miden_node_ref: description: "Ref for 0xMiden/node" @@ -74,9 +74,9 @@ jobs: [ -z "$tutorials_ref" ] && tutorials_ref="$tutorials_def" echo "MIDEN_TUTORIALS_REF=$tutorials_ref" >> $GITHUB_OUTPUT - client_ref='${{ inputs.miden_client_ref }}' - [ -z "$client_ref" ] && client_ref="$def" - echo "MIDEN_CLIENT_REF=$client_ref" >> $GITHUB_OUTPUT + rust_sdk_ref='${{ inputs.rust_sdk_ref }}' + [ -z "$rust_sdk_ref" ] && rust_sdk_ref="$def" + echo "RUST_SDK_REF=$rust_sdk_ref" >> $GITHUB_OUTPUT node_ref='${{ inputs.miden_node_ref }}' [ -z "$node_ref" ] && node_ref="$def" @@ -97,7 +97,7 @@ jobs: echo "Resolved refs:" echo " protocol: $base_ref" echo " tutorials: $tutorials_ref" - echo " miden-client: $client_ref" + echo " rust-sdk: $rust_sdk_ref" echo " node: $node_ref" echo " note-transport: $note_transport_ref" echo " miden-vm: $vm_ref" @@ -118,12 +118,12 @@ jobs: ref: ${{ steps.refs.outputs.MIDEN_TUTORIALS_REF }} path: vendor/tutorials - - name: Checkout 0xMiden/miden-client + - name: Checkout 0xMiden/rust-sdk uses: actions/checkout@v4 with: - repository: 0xMiden/miden-client - ref: ${{ steps.refs.outputs.MIDEN_CLIENT_REF }} - path: vendor/miden-client + repository: 0xMiden/rust-sdk + ref: ${{ steps.refs.outputs.RUST_SDK_REF }} + path: vendor/rust-sdk - name: Checkout 0xMiden/node uses: actions/checkout@v4 @@ -156,7 +156,7 @@ jobs: # ============================================================ # v0.4 IA: Aggregate into nested structure # - Reference docs (protocol, miden-vm, compiler, node) → docs/reference/ - # - Builder docs (tutorials, miden-client) → docs/builder/ + # - Builder docs (tutorials, rust-sdk) → docs/builder/ # ============================================================ - name: Aggregate docs into single docs tree run: | @@ -282,20 +282,20 @@ jobs: echo "Synced tutorials (miden-bank, components, img, theme, miden_node_setup.md, recipes/rust, recipes/web) → docs/builder/tutorials" fi - if [ -d "vendor/miden-client/docs/external/src" ]; then + if [ -d "vendor/rust-sdk/docs/external/src" ]; then mkdir -p docs/builder/tools/clients - # Selective ingestion: only subdirs/files we still auto-sync from miden-client. + # Selective ingestion: only subdirs/files we still auto-sync from rust-sdk. # web-client/, react-sdk/, and top-level index.md are locally authored in the docs repo # — they are preserved through this clean/ingest cycle. for name in rust-client img theme; do - src="vendor/miden-client/docs/external/src/$name" + src="vendor/rust-sdk/docs/external/src/$name" [ -d "$src" ] && cp -r "$src" docs/builder/tools/clients/ done for name in common-errors.md _category_.yml; do - src="vendor/miden-client/docs/external/src/$name" + src="vendor/rust-sdk/docs/external/src/$name" [ -f "$src" ] && cp "$src" docs/builder/tools/clients/ done - echo "Synced miden-client (rust-client, img, theme, common-errors, _category_) → docs/builder/tools/clients" + echo "Synced rust-sdk (rust-client, img, theme, common-errors, _category_) → docs/builder/tools/clients" fi if [ -d "vendor/note-transport-service/docs/external/src" ]; then diff --git a/.release/release-manifest.yml b/.release/release-manifest.yml index 24a1f63b..1f5e439e 100644 --- a/.release/release-manifest.yml +++ b/.release/release-manifest.yml @@ -2,7 +2,7 @@ version: "0.14" # the label to snapshot (used if no manual override) refs: # exact, immutable refs per source repo (tags or release branches) protocol: "refs/tags/v0.14.6" node: "refs/tags/v0.14.10" - miden-client: "refs/tags/v0.14.8" + rust-sdk: "refs/tags/v0.14.8" tutorials: "refs/heads/main" miden-vm: "refs/tags/v0.22.3" compiler: "refs/tags/v0.8.1" diff --git a/README.md b/README.md index c860fb18..e4ba52ed 100644 --- a/README.md +++ b/README.md @@ -51,7 +51,7 @@ flowchart TD MidenVM["0xMiden/miden-vm"] MidenNode["0xMiden/node"] Compiler["0xMiden/compiler"] - MidenClient["0xMiden/miden-client"] + MidenClient["0xMiden/rust-sdk"] MidenTutorials["0xMiden/tutorials"] end @@ -145,7 +145,7 @@ refs: miden-vm: refs/tags/v0.22.1 node: refs/tags/v0.14.9 compiler: refs/tags/v0.8.1 - miden-client: refs/tags/v0.14.4 + rust-sdk: refs/tags/v0.14.4 tutorials: refs/heads/main # Or specific commit/tag ``` @@ -221,7 +221,7 @@ The build uses: | Edit Protocol docs | `0xMiden/protocol` repo → cut new version | | Edit VM docs | `0xMiden/miden-vm` repo → cut new version | | Edit Tutorials | `0xMiden/tutorials` repo → cut new version | -| Edit Client docs | `0xMiden/miden-client` repo → cut new version | +| Edit Client docs | `0xMiden/rust-sdk` repo → cut new version | | Create new release | Update `.release/release-manifest.yml` → run `cut-versions.yml` | --- diff --git a/docs/builder/migration/index.md b/docs/builder/migration/index.md index fab7ccca..149106b5 100644 --- a/docs/builder/migration/index.md +++ b/docs/builder/migration/index.md @@ -169,5 +169,5 @@ If your project builds and all tests pass, you've successfully migrated to v0.15 ## Need Help? - **Discord:** [Miden Discord](https://discord.gg/0xMiden) — the `#dev-support` channel. -- **GitHub issues:** file against the relevant repo — [`miden-client`](https://github.com/0xMiden/miden-client/issues), [`web-sdk`](https://github.com/0xMiden/web-sdk/issues), [`protocol`](https://github.com/0xMiden/protocol/issues), or [`miden-vm`](https://github.com/0xMiden/miden-vm/issues). +- **GitHub issues:** file against the relevant repo — [`rust-sdk`](https://github.com/0xMiden/rust-sdk/issues), [`web-sdk`](https://github.com/0xMiden/web-sdk/issues), [`protocol`](https://github.com/0xMiden/protocol/issues), or [`miden-vm`](https://github.com/0xMiden/miden-vm/issues). - **Changelogs:** the per-repo `CHANGELOG.md` files carry the full list of changes, including non-breaking features and fixes omitted from this guide. diff --git a/docs/builder/tools/clients/local-node-testing.md b/docs/builder/tools/clients/local-node-testing.md index 798d005e..95495367 100644 --- a/docs/builder/tools/clients/local-node-testing.md +++ b/docs/builder/tools/clients/local-node-testing.md @@ -17,7 +17,7 @@ Use a local node when a test needs real node state: public accounts, block commi | Private note delivery | A separate Miden Note Transport node | | Future one-command local dev | Track [node#1874](https://github.com/0xMiden/node/issues/1874) and [midenup#180](https://github.com/0xMiden/midenup/issues/180) | -Docker Compose is the supported default path for running the current local node stack. The miden-client repo also has a `make start-node` helper for its own integration tests, but that helper runs the test node directly with Cargo and is not the operator-facing Docker workflow. +Docker Compose is the supported default path for running the current local node stack. The rust-sdk repo also has a `make start-node` helper for its own integration tests, but that helper runs the test node directly with Cargo and is not the operator-facing Docker workflow. ## Prerequisites @@ -154,11 +154,11 @@ If the frontend itself runs inside Docker, `localhost` is the frontend container ## Rust client smoke test -The miden-client integration test binary uses the same local network preset: +The rust-sdk integration test binary uses the same local network preset: ```bash -git clone https://github.com/0xMiden/miden-client.git -cd miden-client +git clone https://github.com/0xMiden/rust-sdk.git +cd rust-sdk TEST_MIDEN_NETWORK=localhost \ cargo run --package miden-client-integration-tests --release --locked -- \ diff --git a/docs/builder/tools/clients/react-sdk/account-state-and-balances.md b/docs/builder/tools/clients/react-sdk/account-state-and-balances.md index 26faf5e5..bfe84ead 100644 --- a/docs/builder/tools/clients/react-sdk/account-state-and-balances.md +++ b/docs/builder/tools/clients/react-sdk/account-state-and-balances.md @@ -22,7 +22,7 @@ The important boundary is: - **`useExecuteProgram()`** runs locally and does not prove, submit, or change state. For the full package README and source-level examples, see -[`miden-client/packages/react-sdk/README.md`](https://github.com/0xMiden/miden-client/blob/v0.14.5/packages/react-sdk/README.md). +[`web-sdk/packages/react-sdk/README.md`](https://github.com/0xMiden/web-sdk/blob/main/packages/react-sdk/README.md). ## Provider setup diff --git a/docs/builder/tools/clients/web-client/index.md b/docs/builder/tools/clients/web-client/index.md index efec157e..12a29cd0 100644 --- a/docs/builder/tools/clients/web-client/index.md +++ b/docs/builder/tools/clients/web-client/index.md @@ -35,7 +35,7 @@ The Web SDK is the browser-focused toolkit for the Miden network. It wraps the R └────────────────────────────────────────────────┘ ``` -The SDK is built from the `web-client` Rust crate in [0xMiden/miden-client](https://github.com/0xMiden/miden-client), compiled with `wasm-bindgen`, and bundled with the WASM module, JavaScript bindings, and a dedicated Web Worker script. +The SDK is built from the `web-client` Rust crate in [0xMiden/web-sdk](https://github.com/0xMiden/web-sdk), compiled with `wasm-bindgen`, and bundled with the WASM module, JavaScript bindings, and a dedicated Web Worker script. ## Resource management diff --git a/sidebars.ts b/sidebars.ts index ee06fb49..c921749c 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -230,7 +230,7 @@ const sidebars: SidebarsConfig = { "builder/tools/clients/rust-client/library", "builder/tools/clients/rust-client/api-docs", // NOTE: debugging.md exists in v0.14.4 (and the v0.14 - // snapshot) but was removed on miden-client's `next` + // snapshot) but was removed on rust-sdk's `next` // branch. The live /next/ build ingests from `next`, // so listing it here would fail sidebar validation. // Re-add if a future miden-vNN release brings the page diff --git a/static/skill.md b/static/skill.md index c72dc695..172dd098 100644 --- a/static/skill.md +++ b/static/skill.md @@ -2,7 +2,7 @@ name: miden-architecture description: > Miden protocol, SDK, and documentation knowledge. Use when working on Miden - docs or source repositories, especially protocol, miden-client, node, + docs or source repositories, especially protocol, rust-sdk, web-sdk, node, miden-vm, compiler, tutorials, and application templates. compatibility: Designed for AI coding assistants. metadata: @@ -78,7 +78,8 @@ Miden is a privacy-preserving blockchain where accounts are programmable smart c - Docs: https://github.com/0xMiden/docs - Protocol: https://github.com/0xMiden/protocol - Miden VM and assembler: https://github.com/0xMiden/miden-vm -- Client SDKs: https://github.com/0xMiden/miden-client +- Rust client SDK: https://github.com/0xMiden/rust-sdk +- Web SDK: https://github.com/0xMiden/web-sdk - Node: https://github.com/0xMiden/node - Compiler: https://github.com/0xMiden/compiler - Tutorials: https://github.com/0xMiden/tutorials