feat!: @waku/relay #1316

danisharora099 · 2023-04-27T07:37:53Z

Problem

#1151

Solution

Moves relay functionality into a separate package of the monorepo

Notes

Resolves Extract Waku Relay from @waku/core #1151

danisharora099 · 2023-04-27T07:40:35Z

packages/core/package.json

@@ -74,7 +74,6 @@
    "node": ">=16"
  },
  "dependencies": {


removes libp2p-gossipsub dependency from core

Did you double check whether any other dependency can be removed such as @libp2p/interface-pubsub?

Good catch!

We could possibly use something like https://github.com/depcheck/depcheck to achieve receiving updates on unused dependency errors.

github-actions · 2023-04-27T07:55:31Z

size-limit report 📦

Path	Size	Loading time (3g)	Running time (snapdragon)	Total time
Waku core	28.78 KB (-76.44% 🔽)	576 ms (-76.44% 🔽)	658 ms (-25.27% 🔽)	1.3 s
Waku default setup	313.34 KB (-20.63% 🔽)	6.3 s (-20.63% 🔽)	2.2 s (+63.5% 🔺)	8.5 s
ECIES encryption	28.04 KB (+0.05% 🔺)	561 ms (+0.05% 🔺)	381 ms (-26.55% 🔽)	942 ms
Symmetric encryption	28.04 KB (+0.05% 🔺)	561 ms (+0.05% 🔺)	384 ms (+65.91% 🔺)	945 ms
DNS discovery	108.22 KB (-0.02% 🔽)	2.2 s (-0.02% 🔽)	611 ms (-48.96% 🔽)	2.8 s
Privacy preserving protocols	130.48 KB (+9.63% 🔺)	2.7 s (+9.63% 🔺)	1.1 s (+19.38% 🔺)	3.7 s
Light protocols	29.81 KB (-75.35% 🔽)	597 ms (-75.35% 🔽)	414 ms (-55.27% 🔽)	1.1 s
History retrieval protocols	29.66 KB (-75.48% 🔽)	594 ms (-75.48% 🔽)	450 ms (-45.05% 🔽)	1.1 s
Deterministic Message Hashing	5.78 KB (0%)	116 ms (0%)	149 ms (+30.24% 🔺)	265 ms

weboko

Looks good

fryorcraken

I don't really agree with some constant move. We don't want waku utils to become a dumping ground. Will provide a second review shortly.

fryorcraken · 2023-05-05T01:41:28Z

packages/core/package.json

@@ -74,7 +74,6 @@
    "node": ">=16"
  },
  "dependencies": {


Did you double check whether any other dependency can be removed such as @libp2p/interface-pubsub?

packages/core/src/index.ts

packages/core/src/lib/keep_alive_manager.ts

fryorcraken

I see some of the constant location as a potential issue/tech debt and would prefer to have it sorted with this PR.

packages/relay/package.json

fryorcraken · 2023-05-05T03:44:58Z

packages/relay/package.json

+    "fast-check": "^3.8.1"
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^24.1.0",


I would expect to see the @libp2p/interface-pubsub dependency here,no?

Correct, weird as the check/build did not fail. Encountered something similar the other day as well.
Worth opening an issue? We wrote a fix for this, correct?

(could be cool: https://github.com/depcheck/depcheck)

cc @weboko

That's indeed strange, I've been tracking that issue and checking similar scenarios that were caught by the eslint rule.
Added an issue with some description - #1337

packages/relay/src/index.ts

…package

fryorcraken · 2023-05-11T05:15:55Z

packages/core/src/constants/index.ts

Just make it constants.ts

Changed.

I had created a folder constants to future-proof in case we want to add more constant files in the future. But if a case like this arises, we can create the folder then :)

fryorcraken · 2023-05-11T05:17:20Z

packages/core/package.json

    }
  },
  "typesVersions": {
    "*": {
      "lib/*": [
        "dist/lib/*"
+      ],
+      "constants/*": [


Any reason why is constants out of the lib dir?

I said move it in the lib dir. We can remove the lib dir if it bothers you.

imo @waku/core/constants made it easier to read/import compared to importing directly from @waku/core
And @waku/core/lib/constants is a bigger import path and intuitively constants don't feel right to import from lib

I have removed it as a separate export path, and exporting directly out of @waku/core -- we can change this in the future if necessary :)

fryorcraken · 2023-05-11T05:17:58Z

packages/create/package.json

@@ -51,6 +51,7 @@
    "@chainsafe/libp2p-noise": "^11.0.0",
    "@libp2p/mplex": "^7.1.1",
    "@libp2p/websockets": "^5.0.3",
+    "@waku/relay": "^0.0.1",


@weboko didn't we say we would keep * for packages in the mono repo? I can see the other package have a specified version too.

I have addressed this as part of this PR: 41ffc35

I'm curious if we could possibly make this change automatically part of the pre-commit hook maybe

did some digging; tracking here: #1346

@fryorcraken , right now we have a mix: some are using asterisk and some version.

Honestly I can't remember on what we settled but it seems to me now we agreed that version will be changed / maintained by release-please to specific version instead of asterisk - last release.

@danisharora099 I believe the task is not needed except if we want to define versions to private packages, I think they won't be changed automatically by the release CI. That can be done manually it seems.

…package

danisharora099 added 3 commits April 27, 2023 13:03

move constants & core's func to @waku/utils

00145ec

setup @waku/relay

39667ed

use @waku/relay for create

cd9a482

danisharora099 commented Apr 27, 2023

View reviewed changes

danisharora099 added 2 commits April 27, 2023 13:15

address: principal review

dff2c45

fix: size-limit

5bcbcea

danisharora099 mentioned this pull request Apr 27, 2023

Extract Waku Relay from @waku/core #1151

Closed

danisharora099 force-pushed the feat/relay-package branch from 4ce6fd6 to 5bcbcea Compare May 2, 2023 05:11

danisharora099 marked this pull request as ready for review May 2, 2023 05:12

danisharora099 requested a review from fryorcraken as a code owner May 2, 2023 05:12

Merge branch 'master' into feat/relay-package

c593ce6

weboko approved these changes May 2, 2023

View reviewed changes

Merge branch 'master' into feat/relay-package

76df4cb

fryorcraken reviewed May 5, 2023

View reviewed changes

fryorcraken requested changes May 5, 2023

View reviewed changes

danisharora099 added 3 commits May 9, 2023 15:51

move all constants to @waku/core

522c161

move TopicOnlyDecoder to relay

9222587

merge: master

8646f7c

danisharora099 force-pushed the feat/relay-package branch from 6dcc445 to 8646f7c Compare May 9, 2023 13:21

danisharora099 added 2 commits May 9, 2023 18:52

Merge branch 'master' of github.com:waku-org/js-waku into feat/relay-…

4b0ce8b

…package

fix: tests

ab2fc55

danisharora099 requested a review from fryorcraken May 9, 2023 13:44

weboko mentioned this pull request May 9, 2023

chore: eslint dependency checker is not catching all issues #1337

Open

fryorcraken and others added 3 commits May 10, 2023 19:44

Move constants out of core (#1340)

d73bcf8

Merge branch 'master' of github.com:waku-org/js-waku into feat/relay-…

3021783

…package

update package.lock

907e30c

fryorcraken approved these changes May 11, 2023

View reviewed changes

danisharora099 added 2 commits May 11, 2023 13:26

change constants folder into a ts file

6e7a0f6

use dependency version as * instead of version number

41ffc35

danisharora099 and others added 3 commits May 11, 2023 13:35

Merge branch 'master' into feat/relay-package

0266041

add constants import from @waku/core

74b53e6

Merge branch 'master' of github.com:waku-org/js-waku into feat/relay-…

a61a5ca

…package

danisharora099 force-pushed the feat/relay-package branch from 3bdb71a to a61a5ca Compare May 11, 2023 08:23

danisharora099 changed the title ~~feat: @waku/relay~~ feat!: @waku/relay May 11, 2023

add empty changelog file for relay

5f33dbb

danisharora099 merged commit 50c2c25 into master May 11, 2023

danisharora099 deleted the feat/relay-package branch May 11, 2023 08:38

fryorcraken mentioned this pull request May 11, 2023

chore: release master #1343

Merged

weboko mentioned this pull request May 16, 2023

write a script to update package versions to * automatically #1346

Closed

fryorcraken mentioned this pull request Aug 2, 2023

chore: release master #1452

Closed

This was referenced Sep 11, 2023

chore: release master #1554

Closed

chore: release master #1555

Closed

chore: release master #1556

Closed

chore: release master #1558

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat!: @waku/relay #1316

feat!: @waku/relay #1316

danisharora099 commented Apr 27, 2023 •

edited

Loading

danisharora099 Apr 27, 2023

fryorcraken May 5, 2023

danisharora099 May 9, 2023 •

edited

Loading

github-actions bot commented Apr 27, 2023 •

edited

Loading

weboko left a comment

fryorcraken left a comment

fryorcraken May 5, 2023

fryorcraken left a comment

fryorcraken May 5, 2023

danisharora099 May 9, 2023 •

edited

Loading

weboko May 9, 2023

fryorcraken May 11, 2023

danisharora099 May 11, 2023

fryorcraken May 11, 2023

danisharora099 May 11, 2023 •

edited

Loading

fryorcraken May 11, 2023

danisharora099 May 11, 2023

danisharora099 May 11, 2023

weboko May 11, 2023

feat!: @waku/relay #1316

feat!: @waku/relay #1316

Conversation

danisharora099 commented Apr 27, 2023 • edited Loading

Problem

Solution

Notes

Choose a reason for hiding this comment

Choose a reason for hiding this comment

danisharora099 May 9, 2023 • edited Loading

Choose a reason for hiding this comment

github-actions bot commented Apr 27, 2023 • edited Loading

size-limit report 📦

weboko left a comment

Choose a reason for hiding this comment

fryorcraken left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fryorcraken left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

danisharora099 May 9, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

danisharora099 May 11, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

danisharora099 commented Apr 27, 2023 •

edited

Loading

danisharora099 May 9, 2023 •

edited

Loading

github-actions bot commented Apr 27, 2023 •

edited

Loading

danisharora099 May 9, 2023 •

edited

Loading

danisharora099 May 11, 2023 •

edited

Loading