Enable zkProgram.compile() with cache in browsers #2404
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Register caml_fp_srs_get_lagrange_basis_ptr and _read_from_ptr functions - Register caml_fq_srs_get_lagrange_basis_ptr and _read_from_ptr functions - These enable zkProgram.compile() with cache writing in web environments - Follows existing pointer pattern used by lagrange_commitments_whole_domain - Phase 2 of 4: Worker spec registration complete
- Implement platform detection (Node.js vs Web) in getLagrangeBasis - Web environments use new pointer-based functions (_ptr + _read_from_ptr) - Node.js continues using original direct function call - Update TODO comment to reflect fixed functionality - Phase 3 of 4: TypeScript integration complete
This was referenced Sep 2, 2025
Trivo25
reviewed
Sep 18, 2025
CHANGELOG.md
Outdated
|
|
||
| - Internal o1js and protocol constants, hashes and prefixes are now exported via | ||
| the `Core´ namespace. https://github.com/o1-labs/o1js/pull/2421 | ||
| - Added `caml_fp_srs_get_lagrange_basis_ptr` and |
There was a problem hiding this comment.
This is an implementation detail, I don't think it belongs in a changelog
CHANGELOG.md
Outdated
| https://github.com/o1-labs/o1js/pull/2388 | ||
|
|
||
| - Fixed issue where `zkProgram.compile()` was not able to use a browser cache. | ||
| Previously, the `get_lagrange_basis` functions were disabled on the web |
There was a problem hiding this comment.
same here, this is an implementation detail. Maybe replace get_lagrange_basis with a generic reading from cache..
| @@ -1,1621 +1,4 @@ | |||
| // @generated this file is auto-generated - don't edit it directly | |||
There was a problem hiding this comment.
these files shouldn't be part of this PR
| args: [wasm.WasmFqSrs, undefined /* number */], | ||
| res: undefined /* number, ptr */, | ||
| }, | ||
| // New get_lagrange_basis pointer functions for web compatibility |
There was a problem hiding this comment.
Given this workaround, we should clean up caml_fp_srs_get_lagrange_basis a bit (see line 111 in this file)
src/bindings/crypto/bindings/srs.ts
Outdated
| if (cache.canWrite) { | ||
| // TODO: this code path will throw on the web since `caml_${f}_srs_get_lagrange_basis` is not properly implemented | ||
| // using a writable cache in the browser seems to be fairly uncommon though, so it's at least an 80/20 solution | ||
| // getLagrangeBasis now works on web via environment-aware pointer functions |
There was a problem hiding this comment.
nit: just removing the initial TODO comment here would have been enough to clarify this is now working on the web
src/bindings/crypto/bindings/srs.ts
Outdated
|
|
||
| if (isWeb) { | ||
| // Web: Use new pointer-based functions for worker compatibility | ||
| const ptr = wasm[`caml_${f}_srs_get_lagrange_basis_ptr`](srs, n); |
There was a problem hiding this comment.
nit: it's cleaner to keep using the patter above for wasm functions
let getLagrangeBasisPtr = ..
|
continuing the discussion on slack |
…tion working on web via environment-aware pointer functions
These files are auto-generated and only had formatting changes that shouldn't be included in the PR.
… readability and clarity
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Enables
ZkProgram.compile({ cache })to work in browsers. Previously, using a cache in web environments with aZkProgramwas disabled because the underlying lagrange basis functions were not compatible with the web worker API and would cause compilation to hang indefinitely.Background
The
ZkProgram.compile({ cache })functionality was broken in browsers because:WasmVectortypes incompatible with web worker transferworker-spec.jsto prevent hangingChanges
worker-spec.jssrs.tswith environment-awaregetLagrangeBasisfunctionRelated PRs
This is part 3 of 3 for the complete fix:
Testing
Manually tested in browser environment: