@miden-sdk/miden-sdk 0.14.4 → 0.15.0-alpha.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/LICENSE +21 -0
- package/README.md +9 -9
- package/dist/{Cargo-Bwjf7IkR.js → Cargo-CVlXCH_2.js} +7105 -6141
- package/dist/Cargo-CVlXCH_2.js.map +1 -0
- package/dist/api-types.d.ts +17 -47
- package/dist/assets/miden_client_web.wasm +0 -0
- package/dist/crates/miden_client_web.d.ts +122 -76
- package/dist/docs-entry.d.ts +5 -2
- package/dist/eager.js +7 -4
- package/dist/eager.js.map +1 -1
- package/dist/index.d.ts +107 -7
- package/dist/index.js +534 -355
- package/dist/index.js.map +1 -1
- package/dist/wasm.js +1 -1
- package/dist/workers/{Cargo-Bwjf7IkR-Cz54YuXA.js → Cargo-CVlXCH_2-CWA-5vlh.js} +7105 -6141
- package/dist/workers/Cargo-CVlXCH_2-CWA-5vlh.js.map +1 -0
- package/dist/workers/assets/miden_client_web.wasm +0 -0
- package/dist/workers/web-client-methods-worker.js +7129 -6159
- package/dist/workers/web-client-methods-worker.js.map +1 -1
- package/dist/workers/web-client-methods-worker.module.js +23 -19
- package/dist/workers/web-client-methods-worker.module.js.map +1 -1
- package/js/client.js +327 -0
- package/js/node/client-factory.js +117 -0
- package/js/node/loader.js +138 -0
- package/js/node/napi-compat.js +238 -0
- package/js/node-index.js +195 -0
- package/js/resources/accounts.js +224 -0
- package/js/resources/compiler.js +74 -0
- package/js/resources/keystore.js +54 -0
- package/js/resources/notes.js +124 -0
- package/js/resources/settings.js +30 -0
- package/js/resources/tags.js +31 -0
- package/js/resources/transactions.js +533 -0
- package/js/standalone.js +109 -0
- package/js/utils.js +232 -0
- package/lazy/package.json +4 -0
- package/package.json +62 -40
- package/dist/Cargo-Bwjf7IkR.js.map +0 -1
- package/dist/workers/Cargo-Bwjf7IkR-Cz54YuXA.js.map +0 -1
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Miden
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -46,7 +46,7 @@ npm i @miden-sdk/miden-sdk
|
|
|
46
46
|
Or using Yarn:
|
|
47
47
|
|
|
48
48
|
```javascript
|
|
49
|
-
|
|
49
|
+
pnpm add @miden-sdk/miden-sdk
|
|
50
50
|
```
|
|
51
51
|
|
|
52
52
|
### Pre-release ("next") Version
|
|
@@ -60,7 +60,7 @@ npm i @miden-sdk/miden-sdk@next
|
|
|
60
60
|
Or with Yarn:
|
|
61
61
|
|
|
62
62
|
```javascript
|
|
63
|
-
|
|
63
|
+
pnpm add @miden-sdk/miden-sdk@next
|
|
64
64
|
```
|
|
65
65
|
|
|
66
66
|
> **Note:** The `next` version of the SDK must be used in conjunction with a locally running Miden node built from the `next` branch of the `miden-node` repository. This is necessary because the public testnet runs the stable `main` branch, which may not be compatible with the latest development features in `next`. Instructions to run a local node can be found [here](https://github.com/0xMiden/miden-node/tree/next) on the `next` branch of the `miden-node` repository. Additionally, if you plan to leverage delegated proving in your application, you may need to run a local prover (see [Remote prover instructions](https://github.com/0xMiden/miden-node/tree/next/bin/remote-prover)).
|
|
@@ -156,8 +156,8 @@ Use `/lazy` from anywhere inside a Capacitor iOS/Android host (the main WKWebVie
|
|
|
156
156
|
If you're interested in contributing to the web client and need to build it locally, you can do so via:
|
|
157
157
|
|
|
158
158
|
```
|
|
159
|
-
|
|
160
|
-
|
|
159
|
+
pnpm install
|
|
160
|
+
pnpm build
|
|
161
161
|
```
|
|
162
162
|
|
|
163
163
|
This will:
|
|
@@ -170,7 +170,7 @@ This will:
|
|
|
170
170
|
To run integration tests after building, use:
|
|
171
171
|
|
|
172
172
|
```
|
|
173
|
-
|
|
173
|
+
pnpm test
|
|
174
174
|
```
|
|
175
175
|
|
|
176
176
|
This runs a suite of integration tests to verify the SDK’s functionality in a web context.
|
|
@@ -184,12 +184,12 @@ Follow the steps below to produce the contents that get published to npm (`dist/
|
|
|
184
184
|
- Install Node.js ≥18 and Yarn.
|
|
185
185
|
2. **Install dependencies**
|
|
186
186
|
```bash
|
|
187
|
-
|
|
187
|
+
pnpm install
|
|
188
188
|
```
|
|
189
189
|
This installs both the JavaScript tooling and the `@wasm-tool/rollup-plugin-rust` dependency that compiles the Rust crate.
|
|
190
190
|
3. **Build the package**
|
|
191
191
|
```bash
|
|
192
|
-
|
|
192
|
+
pnpm build
|
|
193
193
|
```
|
|
194
194
|
The `build` script (see `package.json`) performs the following:
|
|
195
195
|
- Removes the previous `dist/` directory (`rimraf dist`).
|
|
@@ -202,14 +202,14 @@ Follow the steps below to produce the contents that get published to npm (`dist/
|
|
|
202
202
|
- `dist/index.d.ts` and the rest of the `.d.ts` files provide the TypeScript surface.
|
|
203
203
|
Use `npm pack` if you want to preview the exact tarball that would be published.
|
|
204
204
|
|
|
205
|
-
> Tip: during development you can set `MIDEN_WEB_DEV=true` before running `
|
|
205
|
+
> Tip: during development you can set `MIDEN_WEB_DEV=true` before running `pnpm build` (or run `npm run build-dev`) to skip the clean step and keep extra debugging metadata in the bundled output. This debugging metadata also includes debug symbols for the generated wasm binary
|
|
206
206
|
|
|
207
207
|
### Checking the generated TypeScript bindings
|
|
208
208
|
|
|
209
209
|
The script at `crates/web-client/scripts/check-bindgen-types.js` verifies that every type exported by the generated wasm bindings (`dist/crates/miden_client_web.d.ts`) is re-exported from the public declarations (`js/types/index.d.ts`). Run it after a build with:
|
|
210
210
|
|
|
211
211
|
```
|
|
212
|
-
|
|
212
|
+
pnpm check:wasm-types
|
|
213
213
|
```
|
|
214
214
|
|
|
215
215
|
`WebClient` is intentionally excluded because the wrapper defines its own implementation. If the check reports missing exports, update `js/types/index.d.ts` so consumers get the full generated surface.
|