@miden-sdk/miden-sdk 0.14.5 → 0.15.0-alpha.4

package/js/utils.js

@@ -0,0 +1,232 @@
+/**
+ * Shared utility functions for the MidenClient resource classes.
+ * Each function accepts a `wasm` parameter (the WASM module) for constructing typed objects.
+ */
+
+/**
+ * Resolves an AccountRef (string | Account | AccountId) to an AccountId.
+ *
+ * - Strings starting with `0x`/`0X` are parsed as hex via `AccountId.fromHex()`.
+ * - Other strings are parsed as bech32 via `AccountId.fromBech32()`.
+ * - Objects with an `.id()` method (Account) are resolved by calling `.id()`.
+ * - Otherwise, the value is assumed to be an AccountId pass-through.
+ *
+ * @param {string | Account | AccountId} ref - The account reference to resolve.
+ * @param {object} wasm - The WASM module.
+ * @returns {AccountId} The resolved AccountId.
+ */
+export function resolveAccountRef(ref, wasm) {
+  if (ref == null) {
+    throw new Error("Account reference cannot be null or undefined");
+  }
+  if (typeof ref === "string") {
+    if (ref.startsWith("0x") || ref.startsWith("0X")) {
+      return wasm.AccountId.fromHex(ref);
+    }
+    return wasm.AccountId.fromBech32(ref);
+  }
+  if (ref && typeof ref.id === "function") {
+    return ref.id();
+  }
+  return ref;
+}
+
+/**
+ * Resolves an AccountRef to a WASM Address object.
+ *
+ * - Strings starting with bech32 prefixes (`m`) are parsed via `Address.fromBech32()`.
+ * - Strings starting with `0x`/`0X` are parsed as hex AccountId, then wrapped in Address.
+ * - Account objects are resolved via `.id()` then wrapped in Address.
+ * - AccountId objects are wrapped in Address directly.
+ *
+ * @param {string | Account | AccountId} ref - The account reference to resolve.
+ * @param {object} wasm - The WASM module.
+ * @returns {Address} The resolved Address.
+ */
+export function resolveAddress(ref, wasm) {
+  if (ref == null) {
+    throw new Error("Address reference cannot be null or undefined");
+  }
+  if (typeof ref === "string") {
+    if (ref.startsWith("0x") || ref.startsWith("0X")) {
+      const accountId = wasm.AccountId.fromHex(ref);
+      return wasm.Address.fromAccountId(accountId, undefined);
+    }
+    return wasm.Address.fromBech32(ref);
+  }
+  if (ref && typeof ref.id === "function") {
+    const accountId = ref.id();
+    return wasm.Address.fromAccountId(accountId, undefined);
+  }
+  return wasm.Address.fromAccountId(ref, undefined);
+}
+
+/**
+ * Resolves a NoteVisibility string to a WASM NoteType value.
+ *
+ * @param {string | undefined} type - "public" or "private". Defaults to "public".
+ * @param {object} wasm - The WASM module.
+ * @returns {number} The NoteType enum value.
+ */
+export function resolveNoteType(type, wasm) {
+  if (type === "private") {
+    return wasm.NoteType.Private;
+  }
+  if (type === "public" || type == null) {
+    return wasm.NoteType.Public;
+  }
+  throw new Error(
+    `Unknown note type: "${type}". Expected "public" or "private".`
+  );
+}
+
+/**
+ * Resolves a storage mode string to a WASM AccountStorageMode instance.
+ *
+ * @param {string | undefined} mode - "private", "public", or "network". Defaults to "private".
+ * @param {object} wasm - The WASM module.
+ * @returns {AccountStorageMode} The storage mode instance.
+ */
+export function resolveStorageMode(mode, wasm) {
+  switch (mode) {
+    case "public":
+      return wasm.AccountStorageMode.public();
+    case "network":
+      return wasm.AccountStorageMode.network();
+    case "private":
+    case undefined:
+    case null:
+      return wasm.AccountStorageMode.private();
+    default:
+      throw new Error(
+        `Unknown storage mode: "${mode}". Expected "private", "public", or "network".`
+      );
+  }
+}
+
+/**
+ * Resolves an auth scheme string to a WASM AuthScheme enum value.
+ *
+ * @param {string | undefined} scheme - "falcon" or "ecdsa". Defaults to "falcon".
+ * @param {object} wasm - The WASM module.
+ * @returns {number} The AuthScheme enum value.
+ */
+export function resolveAuthScheme(scheme, wasm) {
+  if (scheme === "ecdsa") {
+    return wasm.AuthScheme.AuthEcdsaK256Keccak;
+  }
+  if (scheme === "falcon" || scheme == null) {
+    return wasm.AuthScheme.AuthRpoFalcon512;
+  }
+  throw new Error(
+    `Unknown auth scheme: "${scheme}". Expected "falcon" or "ecdsa".`
+  );
+}
+
+/**
+ * Resolves an AccountType value to a boolean `mutable` flag
+ * for the underlying WASM `newWallet()` / `importPublicAccountFromSeed()` calls.
+ *
+ * Accepts the numeric WASM enum values (2 = immutable, 3 = mutable) or the
+ * legacy string aliases ("MutableWallet", "ImmutableWallet"). Defaults to
+ * mutable when undefined.
+ *
+ * @param {number | string | undefined} accountType
+ * @returns {boolean} Whether the account code is mutable.
+ */
+export function resolveAccountMutability(accountType) {
+  if (
+    accountType == null ||
+    accountType === "MutableWallet" ||
+    accountType === 3
+  ) {
+    return true;
+  }
+  if (accountType === "ImmutableWallet" || accountType === 2) {
+    return false;
+  }
+  throw new Error(
+    `Unknown wallet account type: "${accountType}". Expected AccountType.MutableWallet (3) or AccountType.ImmutableWallet (2).`
+  );
+}
+
+/**
+ * Resolves a NoteInput (string | NoteId | InputNoteRecord | Note) to a hex string.
+ *
+ * - Strings are passed through unchanged.
+ * - NoteId WASM objects are converted via `.toString()`.
+ * - InputNoteRecord and Note objects (with an `.id()` method) are resolved via `.id().toString()`.
+ *
+ * @param {string | object} input - The note reference to resolve.
+ * @returns {string} The hex note ID string.
+ */
+export function resolveNoteIdHex(input) {
+  if (input == null) {
+    throw new Error("Note ID cannot be null or undefined");
+  }
+  if (typeof input === "string") {
+    return input;
+  }
+  // NoteId WASM object — has toString() but not id() (unlike InputNoteRecord/Note).
+  // Check for constructor.fromHex to distinguish from plain objects (which also inherit toString).
+  if (
+    typeof input.toString === "function" &&
+    typeof input.id !== "function" &&
+    input.constructor?.fromHex !== undefined
+  ) {
+    return input.toString();
+  }
+  // InputNoteRecord, Note, or other object with id() returning NoteId
+  if (typeof input.id === "function") {
+    return input.id().toString();
+  }
+  throw new TypeError(
+    `Cannot resolve note ID: expected string, NoteId, InputNoteRecord, or Note, got ${typeof input}`
+  );
+}
+
+/**
+ * Resolves a TransactionId reference (string | TransactionId) to a hex string.
+ *
+ * - Strings are passed through unchanged.
+ * - TransactionId WASM objects are converted via `.toHex()`.
+ *
+ * @param {string | object} input - The transaction ID reference to resolve.
+ * @returns {string} The hex transaction ID string.
+ */
+export function resolveTransactionIdHex(input) {
+  if (input == null) {
+    throw new Error("Transaction ID cannot be null or undefined");
+  }
+  if (typeof input === "string") {
+    return input;
+  }
+  // TransactionId WASM object — toHex() returns hex
+  if (typeof input.toHex === "function") {
+    return input.toHex();
+  }
+  throw new TypeError(
+    `Cannot resolve transaction ID: expected string or TransactionId, got ${typeof input}`
+  );
+}
+
+/**
+ * Hashes a seed value. Strings are hashed via SHA-256 to produce a 32-byte Uint8Array.
+ * Uint8Array values are passed through unchanged.
+ *
+ * @param {string | Uint8Array} seed - The seed to hash.
+ * @returns {Promise<Uint8Array>} The hashed seed.
+ */
+export async function hashSeed(seed) {
+  if (seed instanceof Uint8Array) {
+    return seed;
+  }
+  if (typeof seed === "string") {
+    const encoded = new TextEncoder().encode(seed);
+    const hash = await crypto.subtle.digest("SHA-256", encoded);
+    return new Uint8Array(hash);
+  }
+  throw new TypeError(
+    `Invalid seed type: expected string or Uint8Array, got ${typeof seed}`
+  );
+}

package/lazy/package.json

@@ -0,0 +1,4 @@
+{
+  "main": "../dist/index.js",
+  "types": "../dist/index.d.ts"
+}

package/package.json

@@ -1,7 +1,16 @@
 {
   "name": "@miden-sdk/miden-sdk",
-  "version": "0.14.5",
+  "version": "0.15.0-alpha.4",
   "description": "Miden Wasm SDK",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/0xMiden/web-sdk",
+    "directory": "crates/web-client"
+  },
+  "bugs": {
+    "url": "https://github.com/0xMiden/web-sdk/issues"
+  },
   "collaborators": [
     "Miden"
   ],
@@ -11,69 +20,82 @@
   "types": "./dist/index.d.ts",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
-      "default": "./dist/eager.js"
+      "node": {
+        "types": "./dist/index.d.ts",
+        "default": "./js/node-index.js"
+      },
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/eager.js"
+      }
     },
     "./lazy": {
-      "types": "./dist/index.d.ts",
-      "default": "./dist/index.js"
-    }
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    },
+    "./package.json": "./package.json"
   },
   "files": [
     "dist",
+    "lazy",
+    "js/node-index.js",
+    "js/node",
+    "js/client.js",
+    "js/standalone.js",
+    "js/utils.js",
+    "js/resources",
     "../LICENSE.md"
   ],
-  "scripts": {
-    "build-rust-client-js": "cd ../idxdb-store/src/ && yarn && yarn build",
-    "build": "rimraf dist && npm run build-rust-client-js && cross-env RUSTFLAGS=\"--cfg getrandom_backend=\\\"wasm_js\\\"\" rollup -c rollup.config.js && cpr js/types dist && node clean.js",
-    "build-dev": "npm install && MIDEN_WEB_DEV=true npm run build",
-    "check:wasm-types": "node ./scripts/check-bindgen-types.js",
-    "check:method-classification": "node ./scripts/check-method-classification.js",
-    "check:standalone-types": "node ./scripts/check-standalone-types.js",
-    "test": "yarn playwright install --with-deps && yarn playwright test",
-    "test:ci": "yarn playwright install --with-deps chromium && yarn playwright test",
-    "test:ci:remote_prover": "yarn playwright install --with-deps && cross-env TEST_MIDEN_PROVER_URL=localhost yarn playwright test -g 'with remote prover'",
-    "test:devnet": "cross-env TEST_MIDEN_NETWORK=devnet yarn test",
-    "test:testnet": "cross-env TEST_MIDEN_NETWORK=testnet yarn test",
-    "test:remote_prover": "yarn install && yarn playwright install --with-deps && cross-env MIDEN_WEB_DEV=true yarn run build && cross-env TEST_MIDEN_PROVER_URL=localhost yarn playwright test -g 'with remote prover' ",
-    "test:remote_prover:devnet": "cross-env TEST_MIDEN_NETWORK=devnet TEST_MIDEN_PROVER_URL=devnet yarn run test:remote_prover",
-    "test:remote_prover:testnet": "cross-env TEST_MIDEN_NETWORK=testnet TEST_MIDEN_PROVER_URL=testnet yarn run test:remote_prover",
-    "test:clean": "yarn install && yarn playwright install --with-deps && MIDEN_WEB_DEV=true yarn run build && yarn playwright test ",
-    "test:clean:opt": "yarn install && yarn playwright install --with-deps && yarn run build && yarn playwright test ",
-    "typedoc": "typedoc"
-  },
   "devDependencies": {
     "@playwright/test": "^1.55.0",
     "@rollup/plugin-commonjs": "^25.0.7",
     "@rollup/plugin-node-resolve": "^15.2.3",
     "@types/node": "^24.9.2",
+    "@vitest/coverage-v8": "^3.0.0",
     "@wasm-tool/rollup-plugin-rust": "^3.0.3",
     "binaryen": "^129.0.0",
-    "chai": "^5.1.1",
     "cpr": "^3.0.1",
     "cross-env": "^7.0.3",
-    "esm": "^3.2.25",
-    "http-server": "^14.1.1",
-    "mocha": "^10.7.3",
-    "puppeteer": "^23.1.0",
     "rimraf": "^6.0.1",
     "rollup": "^4.59.0",
     "rollup-plugin-copy": "^3.5.0",
-    "ts-node": "^10.9.2",
     "typedoc": "^0.28.1",
     "typedoc-plugin-markdown": "^4.8.1",
-    "typescript": "^5.5.4"
+    "typescript": "^5.5.4",
+    "vitest": "^3.0.0"
   },
   "dependencies": {
-    "@rollup/plugin-typescript": "^12.3.0",
     "dexie": "^4.0.1",
     "glob": "^11.0.0"
   },
-  "resolutions": {
-    "rollup": ">=4.59.0",
-    "basic-ftp": ">=5.2.0",
-    "tar": ">=7.5.8",
-    "qs": ">=6.14.1",
-    "minimatch": ">=10.2.1"
+  "optionalDependencies": {
+    "@miden-sdk/node-darwin-arm64": "0.15.0-alpha.4",
+    "@miden-sdk/node-darwin-x64": "0.15.0-alpha.4",
+    "@miden-sdk/node-linux-x64-gnu": "0.15.0-alpha.4"
+  },
+  "scripts": {
+    "build-rust-client-js": "pnpm --filter web_store run build",
+    "build": "rimraf dist && pnpm run build-rust-client-js && cross-env RUSTFLAGS=\"--cfg getrandom_backend=\\\"wasm_js\\\"\" rollup -c rollup.config.js && cpr js/types dist && node clean.js && node ./scripts/post-build.js",
+    "build-dev": "pnpm install && MIDEN_WEB_DEV=true pnpm run build",
+    "check:wasm-types": "node ./scripts/check-bindgen-types.js",
+    "check:method-classification": "node ./scripts/check-method-classification.js",
+    "check:standalone-types": "node ./scripts/check-standalone-types.js",
+    "test:install": "pnpm exec playwright install --with-deps",
+    "test:install:ci": "pnpm exec playwright install --with-deps chromium",
+    "test": "pnpm exec playwright test",
+    "test:ci": "pnpm exec playwright test",
+    "test:ci:remote_prover": "cross-env TEST_MIDEN_PROVER_URL=localhost pnpm exec playwright test --project=chromium -g 'with remote prover'",
+    "test:devnet": "cross-env TEST_MIDEN_NETWORK=devnet pnpm exec playwright test",
+    "test:testnet": "cross-env TEST_MIDEN_NETWORK=testnet pnpm exec playwright test",
+    "test:remote_prover": "cross-env TEST_MIDEN_PROVER_URL=localhost pnpm exec playwright test -g 'with remote prover'",
+    "test:remote_prover:devnet": "cross-env TEST_MIDEN_NETWORK=devnet TEST_MIDEN_PROVER_URL=devnet pnpm exec playwright test -g 'with remote prover'",
+    "test:remote_prover:testnet": "cross-env TEST_MIDEN_NETWORK=testnet TEST_MIDEN_PROVER_URL=testnet pnpm exec playwright test -g 'with remote prover'",
+    "test:clean": "pnpm exec playwright test",
+    "test:clean:opt": "pnpm exec playwright test",
+    "test:unit": "vitest run",
+    "test:coverage": "vitest run --coverage",
+    "typedoc": "typedoc"
   }
-}
+}