chore!: discourage the use of relay in browsers #1778
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
size-limit report 📦
|
weboko
reviewed
Jan 10, 2024
packages/sdk/src/create.ts
Outdated
| @@ -80,6 +80,12 @@ export async function createLightNode( | |||
| /** | |||
| * Create a Waku node that uses Waku Relay to send and receive messages, | |||
| * enabling some privacy preserving properties. | |||
| * * @remarks | |||
There was a problem hiding this comment.
I think we should also remove direct export of it all together and hide it behind @waku/sdk/relay or something.
Another thing is that we should not have it mentioned on docs.waku.org. Couldn't find any but @LordGhostX can you confirm, please?
There was a problem hiding this comment.
Sure. Having it export it via @waku/sdk/relay discourages it more :D
There was a problem hiding this comment.
Yeah, I removed all references to relay a long time ago
There was a problem hiding this comment.
sounds good, thanks!
i'll move createRelayNode behind @waku/sdk/relay
adklempner
approved these changes
Jan 10, 2024
danisharora099
changed the title
Closed
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.
This PR:
createRelayNodebehind@waku/sdk/relayinstead of@waku/sdkcreateRelayNodediscouraging the use of Relay in browsers to library consumers.