Improve web worker interface #1045
Open
Conversation
This file contains 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
… in the UI package
…ation with web workers for improved performance and concurrency
…mmunication to clean up the file and improve readability
…orker's methods as if they were local
…mlink in constructor
…pi for better code organization and readability
…pdateTransaction method to use remoteApi with web worker
…emoteApi with web worker
…ove functionality and state management in Home component
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Skipped Deployment
|
…ly convert publicKey to base58 before fetching account data
… functions by directly passing PublicKey object instead of an object with publicKey58 property
…blicKey directly without converting it to base58, as it is already in the correct format
… set up initial state, handle account existence checks, create and send transactions, refresh current state, and create UI elements for the Home page.
…e rendering to optimize bundle size and improve performance
…g of gradient background pixels for better performance
…ic gradient background using canvas and react
… data using zkappWorkerClient
…le zkApp compilation and initialization
…r consistency and clarity
…to clean up code and improve readability
Trivo25
reviewed
Sep 25, 2024
| type Transaction = Awaited<ReturnType<typeof Mina.transaction>>; | ||
|
|
||
| const state = { | ||
| Add: null as null | typeof Add, |
There was a problem hiding this comment.
nit: maybe calling this AddContract and renaming zkapp to contractInstance makes this a bit clearer
There was a problem hiding this comment.
That's a good idea.
I will update the actual tutorial in a follow up PR. |
… 'o1js' library and return API object to ensure worker api is availble after import
querolita
reviewed
Sep 25, 2024
…ion link to clean up code and improve readability
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
This PR improves the implementation of integrating web workers in a UI with
o1js. The comlink package was introduced to simplify the communication with web workers by abstracting message passing, and making them appear like regular asynchronous functions without the complexity of managing postMessage.Impact
Currently web workers are necessary to build performant and usable UIs with
o1js. Integrating and managing web workers witho1jsis complex, and hard to manage according to many developers on discord. These developers have requested that we simplify the process. Integrating comlink simplifies the DX and allows more developers to build performant UIs with less complexity.Changes
zkappWorker.tsandzkappWorkerClient.tswere simplifiedNextJSpage routerto theapp routerFuture Plans
The long term goal is to eliminate the need for web workers with updates to
o1js. In the short term we are aiming to improve the DX of building UIs with changes like this one. This example implementation will be incrementally improved until we reach the longer term goal with improvements too1js.