refactor: move stores to crates (0xMiden#1253)

Author: igamigo

.github/workflows/enforce-web-client-version-bump.yml

@@ -1,7 +1,7 @@
-# This workflow checks if the version number in the `package.json` file of the `web-client` 
-# package has been bumped when there are changes in the `web-client` or `web_store` 
-# directories. If the version number has not been bumped, it fails the workflow with 
-# an error message.
+# This workflow checks if the version number in the `package.json` file of the `web-client` 
+# package has been bumped when there are changes in the `web-client` or `idxdb-store` 
+# directories. If the version number has not been bumped, it fails the workflow with 
+# an error message.
 
 name: Enforce SDK Version Bump
 
@@ -68,7 +68,7 @@ jobs:
           steps.base.outputs.version == steps.head.outputs.version &&
           steps.skip.outputs.bypass != 'true'
         run: |
-          echo "::error ::You modified code under web-client or web_store but did not bump the version in crates/web-client/package.json. Bump the version or add the 'bypass-sdk-version-bump' label to the PR."
+          echo "::error ::You modified code under web-client or idxdb-store but did not bump the version in crates/web-client/package.json. Bump the version or add the 'bypass-sdk-version-bump' label to the PR."
           echo "::error ::Base and head version are both '${{ steps.head.outputs.version }}'."
           exit 1
 

.github/workflows/test.yml

@@ -81,7 +81,7 @@ jobs:
 
       - name: Check TSC output equals commited JS
         run: |
-          cd ./crates/rust-client/src/store/web_store
+          cd ./crates/idxdb-store/src/
           yarn
           yarn tsc --outDir ci_test_folder
           diff -bur js ci_test_folder

.prettierignore

@@ -3,4 +3,4 @@
 *.yaml
 
 # Generated JS (codegen)
-crates/rust-client/src/store/web_store/js/**
+crates/idxdb-store/src/js/**

.typos.toml

@@ -1,3 +1,3 @@
 # Config file for typos. For more information, see: https://github.com/crate-ci/typos
 [files]
-extend-exclude = ["*.d.ts", "*.json", "*.lock", "*.map", "crates/rust-client/src/store/web_store/js", "dist"]
+extend-exclude = ["*.d.ts", "*.json", "*.lock", "*.map", "crates/idxdb-store/src/js", "dist"]

CHANGELOG.md

@@ -9,9 +9,9 @@
 ### Changes
 
 * [BREAKING] Incremented MSRV to 1.89.
-* Bumped web-client version in package.json after merging main into next.
 * Added support for getting specific vault and storage elements from `Store` along with their proofs ([#1164](https://github.com/0xMiden/miden-client/pull/1164)).
 * Modified the RPC client to avoid reconnection when setting commitment header ([#1166](https://github.com/0xMiden/miden-client/pull/1166)).
+* [BREAKING] Moved `SqliteStore` and `WebStore` into their own separate crates ([#1253](https://github.com/0xMiden/miden-client/pull/1253)).
 
 ## 0.11.3 (2025-09-08)
 

Cargo.lock

@@ -4,7 +4,10 @@ resolver = "2"
 members = [
   "bin/integration-tests",
   "bin/miden-cli",
+  "crates/idxdb-store",
   "crates/rust-client",
+  "crates/sqlite-store",
+  "crates/testing/miden-client-tests",
   "crates/testing/node-builder",
   "crates/testing/prover",
   "crates/web-client",
@@ -40,7 +43,9 @@ miden-tx = { branch = "next", default-features = false, git = "https://github.co
 
 # External dependencies
 anyhow      = { default-features = false, version = "1.0" }
-async-trait = "0.1"
+async-trait = { version = "0.1" }
+chrono      = { version = "0.4" }
+hex         = { version = "0.4" }
 miette      = { features = ["fancy"], version = "7.6" }
 rand        = { version = "0.9" }
 serde       = { features = ["derive"], version = "1.0" }

Cargo.toml

@@ -18,25 +18,29 @@ PROVER_DIR="crates/testing/prover"
 WEB_CLIENT_DIR=crates/web-client
 RUST_CLIENT_DIR=crates/rust-client
 
+EXCLUDE_WASM_PACKAGES=--exclude miden-client-web --exclude miden-idxdb-store
+
 # --- Linting -------------------------------------------------------------------------------------
 
 .PHONY: clippy
 clippy: ## Run Clippy with configs. We need two separate commands because the `testing-remote-prover` cannot be built along with the rest of the workspace. This is because they use different versions of the `miden-tx` crate which aren't compatible with each other.
-	cargo clippy --workspace --exclude miden-client-web --exclude testing-remote-prover --all-targets -- -D warnings
+	cargo clippy --workspace $(EXCLUDE_WASM_PACKAGES) --exclude testing-remote-prover --all-targets -- -D warnings
 	cargo clippy --package testing-remote-prover --all-targets -- -D warnings
 
 .PHONY: clippy-wasm
-clippy-wasm: rust-client-ts-build ## Run Clippy for the miden-client-web package
+clippy-wasm: rust-client-ts-build ## Run Clippy for the wasm packages (web client and idxdb store)
 	cargo clippy --package miden-client-web --target wasm32-unknown-unknown --all-targets -- -D warnings
+	cargo clippy --package miden-idxdb-store --target wasm32-unknown-unknown --all-targets -- -D warnings
 
 .PHONY: fix
-fix: ## Run Fix with configs. We need two separate commands because the `testing-remote-prover` cannot be built along with the rest of the workspace. This is because they use different versions of the `miden-tx` crate which aren't compatible with each other.
-	cargo +nightly fix --workspace --exclude miden-client-web --exclude testing-remote-prover --allow-staged --allow-dirty --all-targets
+fix: ## Run Fix with configs, building tests with proper features to avoid type split.
+	cargo +nightly fix --workspace $(EXCLUDE_WASM_PACKAGES) --exclude testing-remote-prover --features "testing std" --all-targets --allow-staged --allow-dirty
 	cargo +nightly fix --package testing-remote-prover --all-targets --allow-staged --allow-dirty
 
 .PHONY: fix-wasm
-fix-wasm: ## Run Fix for the miden-client-web package
+fix-wasm: ## Run Fix for the wasm packages (web client and idxdb store)
 	cargo +nightly fix --package miden-client-web --target wasm32-unknown-unknown --allow-staged --allow-dirty --all-targets
+	cargo +nightly fix --package miden-idxdb-store --target wasm32-unknown-unknown --allow-staged --allow-dirty --all-targets
 
 .PHONY: format
 format: ## Run format using nightly toolchain
@@ -63,7 +67,7 @@ typos-check: ## Run typos to check for spelling mistakes
 
 .PHONY: rust-client-ts-lint
 rust-client-ts-lint:
-	cd $(RUST_CLIENT_DIR)/src/store/web_store && yarn && yarn lint
+	cd crates/idxdb-store/src/ && yarn && yarn lint
 
 # --- Documentation -------------------------------------------------------------------------------
 
@@ -87,7 +91,7 @@ typedoc: rust-client-ts-build ## Generate web client package documentation.
 
 .PHONY: test
 test: ## Run tests
-	cargo nextest run --workspace --exclude miden-client-web --exclude testing-remote-prover --release --lib $(FEATURES_CLIENT)
+	cargo nextest run --workspace $(EXCLUDE_WASM_PACKAGES) --exclude testing-remote-prover --release --lib $(FEATURES_CLIENT)
 
 .PHONY: test-docs
 test-docs: ## Run documentation tests
@@ -110,7 +114,7 @@ stop-node: ## Stop the testing node server
 
 .PHONY: integration-test
 integration-test: ## Run integration tests
-	cargo nextest run --workspace --exclude miden-client-web --exclude testing-remote-prover --release --test=integration
+	cargo nextest run --workspace $(EXCLUDE_WASM_PACKAGES) --exclude testing-remote-prover --release --test=integration
 
 .PHONY: integration-test-web-client
 SHARD_PARAMETER ?= ""
@@ -127,8 +131,8 @@ integration-test-remote-prover-web-client: ## Run integration tests for the web
 
 .PHONY: integration-test-full
 integration-test-full: ## Run the integration test binary with ignored tests included
-	cargo nextest run --workspace --exclude miden-client-web --exclude testing-remote-prover --release --test=integration
-	cargo nextest run --workspace --exclude miden-client-web --exclude testing-remote-prover --release --test=integration --run-ignored ignored-only -- import_genesis_accounts_can_be_used_for_transactions
+	cargo nextest run --workspace $(EXCLUDE_WASM_PACKAGES) --exclude testing-remote-prover --release --test=integration
+	cargo nextest run --workspace $(EXCLUDE_WASM_PACKAGES) --exclude testing-remote-prover --release --test=integration --run-ignored ignored-only -- import_genesis_accounts_can_be_used_for_transactions
 
 .PHONY: integration-test-binary
 integration-test-binary: ## Run the integration tests using the standalone binary
@@ -158,25 +162,27 @@ install-tests: ## Install the tests binary
 # --- Building ------------------------------------------------------------------------------------
 
 build: ## Build the CLI binary, client library and tests binary in release mode
-	CODEGEN=1 cargo build --workspace --exclude miden-client-web --exclude testing-remote-prover --release --locked
+	CODEGEN=1 cargo build --workspace $(EXCLUDE_WASM_PACKAGES) --exclude testing-remote-prover --release --locked
 	cargo build --package testing-remote-prover --release --locked
 
-build-wasm: rust-client-ts-build ## Build the client library for wasm32
+build-wasm: rust-client-ts-build ## Build the wasm packages (web client and idxdb store)
 	CODEGEN=1 cargo build --package miden-client-web --target wasm32-unknown-unknown --locked
+	cargo build --package miden-idxdb-store --target wasm32-unknown-unknown --locked
 
 .PHONY: rust-client-ts-build
 rust-client-ts-build:
-	cd $(RUST_CLIENT_DIR)/src/store/web_store && yarn && yarn build
+	cd crates/idxdb-store/src && yarn && yarn build
 
 # --- Check ---------------------------------------------------------------------------------------
 
 .PHONY: check
 check: ## Build the CLI binary and client library in release mode
-	cargo check --workspace --exclude miden-client-web --exclude testing-remote-prover --release
+	cargo check --workspace $(EXCLUDE_WASM_PACKAGES) --exclude testing-remote-prover --release
 
 .PHONY: check-wasm
-check-wasm: ## Build the client library for wasm32
+check-wasm: ## Check the wasm packages (web client and idxdb store)
 	cargo check --package miden-client-web --target wasm32-unknown-unknown
+	cargo check --package miden-idxdb-store --target wasm32-unknown-unknown
 
 ## --- Setup --------------------------------------------------------------------------------------
 
@@ -200,7 +206,7 @@ install-tools: ## Installs Rust + Node tools required by the Makefile
 	# Web-related
 	command -v yarn >/dev/null 2>&1 || npm install -g yarn
 	yarn --cwd $(WEB_CLIENT_DIR) --silent  # installs prettier, eslint, typedoc, etc.
-	yarn --cwd $(RUST_CLIENT_DIR)/src/store/web_store --silent
+	yarn --cwd crates/idxdb-store/src --silent
 	yarn --silent
 	yarn
 	@echo "Development tools installation complete!"

Makefile

@@ -19,7 +19,8 @@ path = "tests/integration.rs"
 
 [dependencies]
 # Workspace dependencies
-miden-client = { features = ["sqlite", "std", "testing", "tonic"], path = "../../crates/rust-client", version = "0.12" }
+miden-client              = { features = ["std", "testing", "tonic"], path = "../../crates/rust-client", version = "0.12" }
+miden-client-sqlite-store = { package = "miden-client-sqlite-store", path = "../../crates/sqlite-store", version = "0.12" }
 
 # External dependencies
 anyhow      = { features = ["std"], workspace = true }

bin/integration-tests/Cargo.toml

@@ -27,6 +27,7 @@ use miden_client::transaction::{
     TransactionStatus,
     TransactionWitness,
 };
+use miden_client_sqlite_store::SqliteStore;
 
 use crate::tests::config::ClientConfig;
 
@@ -35,12 +36,12 @@ pub async fn test_client_builder_initializes_client_with_endpoint(
 ) -> Result<()> {
     let (endpoint, _, store_config, auth_path) = client_config.as_parts();
 
+    let sqlite_store = SqliteStore::new(store_config).await?;
+
     let mut client = ClientBuilder::<FilesystemKeyStore<_>>::new()
         .tonic_rpc_client(&endpoint, Some(10_000))
         .filesystem_keystore(auth_path.to_str().context("failed to convert auth path to string")?)
-        .sqlite_store(
-            store_config.to_str().context("failed to convert store config path to string")?,
-        )
+        .store(Arc::new(sqlite_store))
         .in_debug_mode(miden_client::DebugMode::Enabled)
         .build()
         .await?;