feat: add support for browser bundle for lightclient #6673
Merged
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
Performance Report✔️ no performance regression detected Full benchmark results
|
jeluard
reviewed
Apr 16, 2024
jeluard
reviewed
Apr 16, 2024
|
|
||
| NOTE: Due to `top-level-await` used in one of dependent library, the package will not be available right after the load. You have to use a hack to clear up that await from the event loop. | ||
|
|
||
| ```html |
There was a problem hiding this comment.
Would be nice to find a way to remove the need for this
There was a problem hiding this comment.
It's in the bls library. @matthewkeil is working on a newer version. Hope that will solve this problem.
There was a problem hiding this comment.
it will not. there will always be a top level await in esm because the bindings path is programmatic so its not imported it looked up and then await import(bindingLocation)
There was a problem hiding this comment.
i suppose it would be possible in bls to use hard imports and then null-loader from weback to not include the other version for web. But for blst if we make it esm it will always have the top-level await for the import
There was a problem hiding this comment.
It's possible avoid top-level-import, but then would have to leave upto user of the library to init where appropriate.
There was a problem hiding this comment.
it will not. there will always be a top level await in esm because the bindings path is programmatic so its not imported it looked up and then await import(bindingLocation)
I think there is a difference between using top-level await and a ESM module without it. Eg. Node 22 will ship a new feature to require ES modules with the exception of the ones that use top-level await (see nodejs/node#51977).
In any case, we might wanna avoid top-level await in packages that are used by others.
There was a problem hiding this comment.
I made the top-level await go away in blst fyi. so might be able to also do something similar in bls...
nazarhussain
force-pushed
the
nh/lightclient-browser-build
branch
from
d0f348f
to
21e9c50
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## unstable #6673 +/- ##
============================================
+ Coverage 61.86% 61.87% +0.01%
============================================
Files 557 562 +5
Lines 59219 59301 +82
Branches 1915 1916 +1
============================================
+ Hits 36635 36695 +60
- Misses 22541 22563 +22
Partials 43 43 |
nazarhussain
changed the title
wemeetagain
reviewed
Apr 17, 2024
| }, | ||
| resolve: { | ||
| alias: { | ||
| "@chainsafe/bls/types": "@chainsafe/bls/types", |
There was a problem hiding this comment.
Yes we need it otherwise @chainsafe/bls/types map to @chainsafe/bls/herumi/types which is not available.
jeluard
reviewed
Apr 17, 2024
| "@chainsafe/bls": "@chainsafe/bls/herumi", | ||
| // This is just used to generate `privateKey` which is not used in the browser. | ||
| "@chainsafe/bls-keygen": path.join(polyfillsDir, "bls-keygen.js"), | ||
| "@chainsafe/blst": emptyModulePath, |
There was a problem hiding this comment.
Shouldn't be there in the first place? Something to look after in a separate issue.
| "@chainsafe/blst": emptyModulePath, | ||
| "@chainsafe/bls-hd-key": emptyModulePath, | ||
| crypto: emptyModulePath, | ||
| "node:crypto": emptyModulePath, |
There was a problem hiding this comment.
What does emptyModulePath do? Disable the whole thing?
There was a problem hiding this comment.
It just replace an empty export export default {} in the bundle JS.
matthewkeil
reviewed
Apr 18, 2024
There was a problem hiding this comment.
a lot of this is duplicated with what i did yesterday to get the tests to pass. would love to spend a few minutes deeper diving so this is where that work happens. instead of #6616
Underlaying One other solution would be to have our own implementation for |
Yes that's what I was mentioning in our discussion yesterday that I am working on web bundle, that's doing exactly what we need to pass browser tests. |
matthewkeil
reviewed
Apr 19, 2024
Please check this thread #6673 (comment) Hope that will cover the point you are looking for. |
wemeetagain
previously approved these changes
Apr 19, 2024
nflaig
reviewed
Apr 19, 2024
Co-authored-by: Nico Flaig <[email protected]>
matthewkeil
previously approved these changes
Apr 26, 2024
There was a problem hiding this comment.
Looks really good!!! Approving but want to highlight to @wemeetagain and @philknows that we are broadcasting our actual beacon node URL in this PR.... not sure if that is a good idea or not. I would respectfully ask that they answer that before merging
packages/light-client/README.md
Outdated
| @@ -48,7 +48,7 @@ lodestar lightclient \ | |||
|
|
|||
| ## Light-Client Programmatic Example | |||
|
|
|||
| For this example we will assume there is a running beacon node at `https://beacon-node.your-domain.com` | |||
| For this example we will assume there is a running beacon node at `https://lodestar-mainnet.chainsafe.io` | |||
There was a problem hiding this comment.
Are we sure we want to broadcast this URL? @philknows @wemeetagain
There was a problem hiding this comment.
These URLs are already been shown and used in the light client demo, so if one want's to use they would have already gotten it from the demo page.
If anyone have different opinion we can revert it in other PR.
packages/light-client/README.md
Outdated
|
|
||
| const config = getChainForkConfigFromNetwork("mainnet"); | ||
| const logger = getConsoleLogger({logDebug: Boolean(process.env.DEBUG)}); | ||
| const api = getApiFromUrl({urls: ["https://lodestar-mainnet.chainsafe.io"]}, {config}); |
There was a problem hiding this comment.
Same question about using our real URL
There was a problem hiding this comment.
I wanted to have an example which people can run by just copying the code. We have similar pattern in the prover already but pointing to sepolia url.
There was a problem hiding this comment.
I think that is a fine idea.... just not our mainnet nodes
wemeetagain
added a commit
that referenced
this pull request
Jun 7, 2024
* chore: n-historical state - track state persist count per epoch (#6699) * feat: add lodestar binaries to release (#6666) * feat: added binaries creation support * feat: added sanity checks * chore: define reusable workflow * chore: fix sanity check,; disable arm64 * chore: added workflow_dispatch * fix: needs cleanup * chore: update old space size Co-authored-by: Nico Flaig <[email protected]> * chore: address comments * chore: address comments * chore: fixed typo * chore: typo Co-authored-by: Nico Flaig <[email protected]> * chore: address comments * chore: wording Co-authored-by: Nico Flaig <[email protected]> * chore: use frozen lock file Co-authored-by: Nico Flaig <[email protected]> --------- Co-authored-by: Nico Flaig <[email protected]> * feat: switch bls to napi rebuild (#6616) * chore: update package.json deps and run yarn * feat: remove unused blst config from vitest.browser.*.config.ts * test: move G2@INF test to base blst repo. No longer exported. * fix: add Uint8Array.from for Buffer return value in unit test so type matches for toEqual * refactor: update imports of CoordType to use bls instead of blst * feat: add blsAddVerificationRandomness cli option * feat: add randomBytesNonZero to utils * feat: implement verification randomness for same message * feat: implement napi blst and switch to libuv worker pool * chore: lint * fix: update comments for availableParallelism * feat: set UV_THREADPOOL_SIZE for perf tests * feat: set UV_THREADPOOL_SIZE=$(nproc) in lodestar entrance script * feat: remove case for serialized PublicKey in deserializeSet * feat: add back workBusy count logic to canAcceptWork * feat: automatically set threadpool size in beaconHandler * refactor: rename flag to disableSameMessageVerificationRandomness * fix: remove UV_THREADPOOL_SIZE from ./lodestar * docs: add TODO about updating metrics * fix: make benchmark multi threading cross-compatible * chore: add [email protected] * feat: default to added randomness * feat: add warning for no same message randomness * fix: passing to updated bls functions * feat: add blst peerDep * fix: default to same message randomness * chore: update yarn.lock * chore: remove unused function to clear lint * feat: break out setThreadPoolSize * docs: update packages/cli/src/cmds/beacon/setThreadPoolSize.ts Co-authored-by: Nico Flaig <[email protected]> * chore: update location for blst dep * chore: run lint again * fix: remove peerDep from light-client * test: fix browser based tests * fix: bad relative imports * docs: add note to readme about switchable bls * docs: typo * chore: lint readme * fix: light-client unit tests * fix: light-client e2e test * feat: remove disableSameMessageVerificationRandomness * refactor: remove unused type * docs: update wordlist * fix: e2e tests * Lint package.json * Revert "fix: e2e tests" This reverts commit f71acd7. * Revert "fix: light-client e2e test" This reverts commit 23c11f0. * Revert "fix: light-client unit tests" This reverts commit fa7893e. * Revert "test: fix browser based tests" This reverts commit 98d04ab. * docs: update readme to remove switchable bls argument * fix: replace optimizeDeps in vitest.browser.config * chore: updated to bls 8.1.0 * feat: move setting threadpool size and warnings to applyPreset.ts * fix: remove setThreadpoolSize from beacon handler * feat: move libuv size logging into handler to use logger * refactor: rename applyPreset to preInitialization * refactor: logging about pool size * Update packages/cli/src/options/globalOptions.ts Co-authored-by: Nico Flaig <[email protected]> * refactor: rename prover applyPreset * docs: change comment in cli/index * fix: update logging for * fix: throw error for invalid uvThreadpoolSize * Update packages/cli/src/preInitialization.ts Co-authored-by: Nico Flaig <[email protected]> * Fix lint issues * Remove unused import * refactor: move bls pool logging back to multithread.ts * fix: log of threadcount --------- Co-authored-by: Nico Flaig <[email protected]> * chore: update references to consensus spec to v1.4.0 (#6704) * chore: update references to consensus spec to v1.4.0 * Remove unintended formatting changes * chore: update consensus spec version in README (#6705) * docs: correct plausible url (#6709) fix: correct plausible url * docs: incorrect scripts location (#6710) fix: incorrect scripts location * docs: no more broken images (#6708) * fix: no more broken images * fix: incorrect paths * feat: check aggregationBits length of `SignedAggregateAndProof` in gossip validation (#6700) * Add unit test * Update packages/beacon-node/src/chain/validation/aggregateAndProof.ts Co-authored-by: Nico Flaig <[email protected]> --------- Co-authored-by: Nico Flaig <[email protected]> * feat: add and track blob source for metrics (#6628) * feat: add and track blob source for metrics * adding blobsSource for blobsPromise * address feedback * apply feedback * updates * only allow non blobspromise blocks to be imported * feat: add support for browser bundle for lightclient (#6673) * Reorganize the code so it is accessible from one package * Add support for browser build for lightclient * Update the build config * Improve the bls vite plugin * Restructure the vite and vitest scripts * Simplify vite config * Remove unused polyfill * Fix the doc lint error * Add support for bundle test * Update the package json files * Add dist build to default build task * Fix spelling in the docs * Fix the lint error * Fix type error * Disable eslint errors * Increase the timeout for bundle test * Fix eslint bundle * Fix lint warning * Remove the unused config * Add the default export to bundle * Enable compression on th build * Update packages/light-client/README.md Co-authored-by: Nico Flaig <[email protected]> * Increase timeout for one test * Optimize package build task * Update the readme --------- Co-authored-by: Nico Flaig <[email protected]> * docs: fix plausible domain (#6712) * ci: add paths-ignore to workflows (#6713) * chore: added paths-ignore * chore: address comments * feat: add arm64 binary support (#6707) * feat: add arm64 binary support * chore: workaround yarn * chore: add comment * chore: workaround runner limitations * ci: publish binaries for release candidates (#6714) * feat: add types support to esm bundle for lightclient (#6685) * Add vite dts plugin * Restructure types export * Update vite build config * Remove unused file * Update the build process * Fix doc formatting * Build the dist for type tests * chore: update vitest (#6718) Update vitest * chore: do not build all binaries atomically (#6719) * feat: update libp2p deps (#6711) * feat: update libp2p deps * chore: fix linter/type errors * chore(deps): bump ejs from 3.1.9 to 3.1.10 (#6721) Bumps [ejs](https://github.com/mde/ejs) from 3.1.9 to 3.1.10. - [Release notes](https://github.com/mde/ejs/releases) - [Commits](mde/ejs@v3.1.9...v3.1.10) --- updated-dependencies: - dependency-name: ejs dependency-type: indirect ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore: revert "ci: add paths-ignore to workflows (#6713)" (#6730) Revert "ci: add paths-ignore to workflows (#6713)" This reverts commit e460bb1. * docs: restore docs pages lost during docusaurus migration (#6725) * ci: fix incorrect build caching (#6731) fix: incorrect build caching * fix: build error log during esm bundle build (#6737) Fix build error * chore: update fastify to v4.27.0 (#6740) * deps: upgrade vitest minor version (#6745) Upgrade vitest * chore: warn when heap limit is too low (#6722) * chore: warn when heap limit is too low * chore: units Co-authored-by: Nico Flaig <[email protected]> * chore: address comments * chore: added faq element * chore: address comments Co-authored-by: Nico Flaig <[email protected]> * chore: address comments Co-authored-by: Nico Flaig <[email protected]> * chore: address comments --------- Co-authored-by: Nico Flaig <[email protected]> * feat: disable flood publish (#6755) * feat: disable flood publish * feat: add network.disableFloodPublish cli flag * chore: address PR comments * test: allow compact diff for test failures (#6783) * Allow the compact diff for tests * Update the doc * Update docs/pages/contribution/testing/index.md Co-authored-by: Julien <[email protected]> * Fix linting on docs * Fix linting --------- Co-authored-by: Julien <[email protected]> * chore: upgrade classic-level (#6793) * chore: upgrade classic-level * chore: address comments * feat(prover): support non-mutated verification provider in prover (#6727) * Restructure the assertions * Add an inspector to run the logic to detect providers * Update web3 provdier logic to use inspetor * Fix the types for proxy * Make the default type for mutation * Rename elrpc to elrpcprovider * Apply suggestions from code review Co-authored-by: Julien <[email protected]> * Fix build error * Update the readme doc * Apply suggestions from code review Co-authored-by: Julien <[email protected]> * Fix the docs linting * Add missing words --------- Co-authored-by: Julien <[email protected]> * docs: added debugging section (#6743) * docs: added debugging section * chore: spell checks * chore: added extra docs * chore: address comments * chore: added extra configuration * chore: updated docs * chore: added extra configuration * chore: fix lint * chore: fix typos * chore: .gitignore * chore: address comments * chore: address comments * chore: review debugging section PR (#6807) * chore: update the naming conventions used in sim tests (#6805) * Rename simulation test to crucible * Rename SimulationEnvironment to Simulation * Use consistent function names * Update readme * Rename interfaces for consistent pattern * Fix lint error * feat: recognize grandine from agentVersion (#6808) * Add grandine * add grandine to wordlist * chore: refactor event loop interactions (#6806) * chore: refactor sleep(0) usage * chore: refactor setTimeout * chore: address comments * chore: cleanup * Apply suggestions from code review --------- Co-authored-by: Cayman <[email protected]> * chore: fix broken docker (#6813) * chore: log newPayload engine api (#6810) * chore: add `get_proposer_head` check in fork choice spec test (#6814) * Check get_proposer_head * Fix enum typo * lint * chore: consolidate classic-level usage (#6795) * chore: do not rely on leveldown * chore: replace level with classic-level * chore: added docker support for osx (#6696) * chore: added docker support for osx * chore: address comments * chore: address comments * Update docker-compose.yml Co-authored-by: Nico Flaig <[email protected]> * chore: address comments --------- Co-authored-by: Nico Flaig <[email protected]> * chore: fix vitest performance with spec tests artifacts in place (#6817) Fix vitest performance with spec tests in place * chore: clean up yarn lockfile (#6816) * feat: disable flood publish by default (#6815) * feat: use @chainsafe/blst directly (#6706) * feat: use @chainsafe/blst directly * chore: update to [email protected] * refactor: remove randomBytesNonZero and user blst exported version * chore: update blst references * test: catch invalid deserialization in spec tests and return false * feat: create signatureFromBytes and signatureFromBytesNoCheck in utils package * feat: implement signatureFromBytes from utils package * feat: implement signatureFromBytes everywhere * fix: light-client empty module for blst --------- Co-authored-by: matthewkeil <[email protected]> * fix: avoid Buffer.from copies (#6723) * fix: avoid Buffer.from copies * chore: simplify shuffling * fix: use subarray instead of slice in shuffling * chore: remove unnecessary devDependencies * chore: rely on fastify 4.x behavior * chore: avoid copy in verifyMerkleBranch * use toBase64 * relax assertions in shuffle function * Update packages/state-transition/src/util/shuffle.ts Co-authored-by: twoeths <[email protected]> --------- Co-authored-by: twoeths <[email protected]> * chore: update nodejs to latest 22 (#6729) * Upgrade node js version to 22 * Update node types * Revert action config * Add package from git hash * Fix the build error * Update the docs for node-22 * Update docker version for Nodejs to 22 * Update package.json * Update package.json Co-authored-by: Nico Flaig <[email protected]> * Update readme docs * Add word in dictionary * Add word in dictionary --------- Co-authored-by: Cayman <[email protected]> Co-authored-by: Nico Flaig <[email protected]> * deps: update systeminformation to 5.22.9 (#6823) * chore: add distutils to build phase of Dockerfile (#6845) * test: increase timeout of keystore tests (#6846) * test: increase timeout of keystore cache tests * Increase hook timeout * Consistent number formatting * chore: only log warning if media type is not supported (415) (#6847) * fix: revert napi bls (#6853) * Revert "feat: use @chainsafe/blst directly (#6706)" This reverts commit 66fe753. * Revert "feat: switch bls to napi rebuild (#6616)" This reverts commit 97d9aa8. * chore: bump package versions to 1.19.0 * chore: bump @chainsafe/blst to v0.2.11 (#6856) * fix: arm64 binaries creation issue (#6858) --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: tuyennhv <[email protected]> Co-authored-by: Julien <[email protected]> Co-authored-by: Nico Flaig <[email protected]> Co-authored-by: Matthew Keil <[email protected]> Co-authored-by: NC <[email protected]> Co-authored-by: g11tech <[email protected]> Co-authored-by: Nazar Hussain <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
|
🎉 This PR is included in v1.19.0 🎉 |
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.
Motivation
Make the lightclient more accessible.
Description
Steps to test or reproduce