@miden-sdk/node-linux-x64-musl 0.0.0-stage → 0.17.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/AGENTS.md ADDED
@@ -0,0 +1,53 @@
1
+ # @miden-sdk/node-linux-x64-musl - Agent Guide
2
+
3
+ **Audience: AI coding agents** that have landed in this directory and are
4
+ trying to work out what it is.
5
+
6
+ ## This is not the SDK
7
+
8
+ This package is one prebuilt native binary, `miden_client_web.node`, for
9
+ Linux x64 against musl (Alpine and other musl distributions). It carries no JavaScript, no type declarations and no public API.
10
+ There is nothing here to import, and nothing here to call.
11
+
12
+ The SDK is `@miden-sdk/miden-sdk`. Its guide, which is the one you want, is at
13
+ `node_modules/@miden-sdk/miden-sdk/AGENTS.md`.
14
+
15
+ ## Why it is installed
16
+
17
+ `@miden-sdk/miden-sdk` lists the native packages as `optionalDependencies`, so
18
+ your package manager installs only the one matching the current platform and
19
+ silently skips the rest. On Node.js the SDK's loader resolves the binary in
20
+ this order:
21
+
22
+ 1. `MIDEN_MODULE_PATH`, or an explicit `modulePath` option
23
+ 2. the platform package for `linux-x64` on a musl C library, which is this one
24
+ (on glibc it picks `@miden-sdk/node-linux-x64-gnu` instead)
25
+ 3. the SDK's own `prebuilds/` directory
26
+ 4. the repo `target/` directory, for local development
27
+
28
+ See `node_modules/@miden-sdk/miden-sdk/js/node/loader.js` for the
29
+ implementation.
30
+
31
+ ## If loading failed
32
+
33
+ Do not try to require this package directly, and do not add it to your
34
+ `dependencies` to force it. The SDK's error lists every resolution attempt and
35
+ why it failed; read it first. A failure here is almost always one of:
36
+
37
+ - **Platform mismatch.** The `os`, `cpu` and `libc` fields in this
38
+ `package.json` are what make npm and pnpm skip non-matching platforms. A
39
+ container built on one architecture or C library and run on another gets no
40
+ binary. Install on the target platform, or set `MIDEN_MODULE_PATH` to a
41
+ binary you supply.
42
+ With npm, an install for Linux from another OS (`npm install --os=linux
43
+ --cpu=x64`) must also pass `--libc=musl`; npm cannot detect the C library of
44
+ a foreign OS and otherwise skips this package.
45
+ - **`--no-optional`, or a lockfile pinned on another platform.** Optional
46
+ dependencies are how this is delivered; skipping them skips the binary.
47
+ - **An SDK release older than this package.** Versions of
48
+ `@miden-sdk/miden-sdk` published before this package existed do not list
49
+ it. Upgrade the SDK, use a glibc base image such as `node:22-bookworm-slim`,
50
+ or set `MIDEN_MODULE_PATH`.
51
+
52
+ In the browser none of this applies: the browser build runs WASM and never
53
+ loads a native module.
@@ -0,0 +1,4 @@
1
+ [diffend] Oversized file quarantined before diffing.
2
+ name: package/miden_client_web.node
3
+ size: 75101824 bytes
4
+ sha256: ec6c00b438e5571cf404251a3f42d3291d4ed517f3fc14e4651233487ea7def7
package/package.json CHANGED
@@ -1,6 +1,25 @@
1
1
  {
2
2
  "name": "@miden-sdk/node-linux-x64-musl",
3
- "version": "0.0.0-stage",
4
- "stub": true,
5
- "description": "Temporary package placeholder for staged publishing"
6
- }
3
+ "version": "0.17.4",
4
+ "description": "Miden Client SDK native module for Linux x64 (musl / Alpine)",
5
+ "os": [
6
+ "linux"
7
+ ],
8
+ "cpu": [
9
+ "x64"
10
+ ],
11
+ "libc": [
12
+ "musl"
13
+ ],
14
+ "main": "miden_client_web.node",
15
+ "files": [
16
+ "miden_client_web.node",
17
+ "AGENTS.md"
18
+ ],
19
+ "license": "MIT",
20
+ "repository": {
21
+ "type": "git",
22
+ "url": "git+https://github.com/0xMiden/web-sdk.git",
23
+ "directory": "packages/node-sdk-linux-x64-musl"
24
+ }
25
+ }
package/README.md DELETED
@@ -1,3 +0,0 @@
1
- # Temporary Holding Version
2
-
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.