fix: switch randombytes for iso-random-stream for browser compatibility #53
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
The `randombytes` package depends on `safe-buffer` which uses the
built-in `buffer` module from node core without declaring the polyfill
as a dep.
If you have this installed as a transitive dependency you will be fine
but if not you'll see errors like:
```
dex.js:12 Uncaught TypeError: Cannot read properties of undefined (reading 'from')
at node_modules/safe-buffer/index.js (index.js:12:12)
at __require2 (chunk-LFBQMW2U.js?v=930a8016:19:50)
at node_modules/randombytes/browser.js (browser.js:15:14)
at __require2 (chunk-LFBQMW2U.js?v=930a8016:19:50)
at node_modules/k-bucket/index.js (index.js:31:21)
at __require2 (chunk-LFBQMW2U.js?v=930a8016:19:50)
at index.ts:2:19
```
This PR switches `randombytes` for `iso-random-stream` which does not
have this problem and uses the native random bytes functionality in
both node and browsers.
It also adds a dependency on the `events` polyfill in case you don't
have that as a transitive dependency either.
achingbrain
added a commit
to libp2p/js-libp2p-kad-dht
that referenced
this pull request
May 9, 2023
Removes the k-bucket dep and imports the code here since the random bytes dep it uses doesn't work in browsers. This PR can be reverted if tristanls/k-bucket#53 is ever merged.
achingbrain
added a commit
to libp2p/js-libp2p-kad-dht
that referenced
this pull request
May 9, 2023
Removes the k-bucket dep and imports the code here since the random bytes dep it uses doesn't work in browsers. This PR can be reverted if tristanls/k-bucket#53 is ever merged.
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.
The
randombytespackage depends onsafe-bufferwhich uses the built-inbuffermodule from node core without declaring the polyfill as a dep.If you have this installed accidentally as a dependency of another dep you will be fine but if not you'll see errors like this in the browser:
This PR switches
randombytesforiso-random-streamwhich does not have this problem and uses the native random bytes functionality in both node and browsers.It also adds a dependency on the
eventspolyfill in case you don't have that as a transitive dependency either.