feat: js-peer-workshop #2

Nkovaturient · 2025-06-24T13:37:52Z

✨ Add Js-peer Workshop Lessons 1 & 2 with Robust Automation and Testing

Description

This PR introduces the first two lessons of the Js-peer Universal Connectivity Workshop. These lessons are designed to teach new developers how to build robust, event-driven peer-to-peer applications using js-libp2p. The structure, validation, and automation closely follow the standards set by the Rust workshop, ensuring a high-quality, reproducible learning experience.

Integration Highlights

Lesson 1: Identity & Swarm Basics
- Teaches PeerId generation, basic node setup, and printing listening addresses.
- Includes clear objectives, step-by-step instructions, and progressive hints.
- Robust validation using a custom check.py script and Docker Compose.
Lesson 2: TCP Transport
- Guides students through adding TCP transport, Noise encryption, and Yamux multiplexing.
- Emphasizes robust error handling and event-driven connection management.
- Includes detailed instructions, error handling best practices, and validation.
Automation & Testing
- Provided a reusable Bash script (test_lesson.sh) for automated lesson validation.
- Each lesson can be built, run, and validated in isolation using Docker Compose and the provided check scripts.
- Output is parsed for correctness, and results are clearly indicated with codes (✅/❌).
Structure & Consistency
- Lessons are organized under en/js/ with a clear, repeatable directory structure.
- All files (lesson.yaml, lesson.md, Dockerfile, index.js, check.py, docker-compose.yaml) are included and follow best practices.

Relevant Resources

dhuseby

Thank you for this PR! However, it is missing the en/js/setup.md file that explains the commands to run to start a new project that uses js-libp2p and the en/js/deps.py script that checks for all of the commands needed to create/compile/run a js project that uses js-libp2p. I can't test it any further until those are there.

Nkovaturient · 2025-06-25T04:33:15Z

Thank you for the review, working on it!

Nkovaturient · 2025-06-25T19:20:11Z

Hello @dhuseby

QnA

Need your help in correctly configuring the setup.md, ig for each workshop, the dir universal-connectivity is created and the subsequent rust/js/py lessons are setup, right? Can you look at the current setup.md for js-lessons and provide guidance on it.
How does Checkpoint lessons should be graded/implemented?scores? need clarification.

As for the latest commits inculcates following changes:

Scaffolded and implemented Lesson 1 (Identity & Swarm Basics) with Docker, npm, and robust validation
Scaffolded and implemented Lesson 2 (TCP Transport) with error handling, event-driven logic, and stack consistency
Scaffolded and implemented Lesson 3 (Ping Protocol, Checkpoint 1) with identify, ping, and direct-message protocols
Added direct-message.js: production-grade, event-driven, error-resilient direct message protocol implementation

Further TODOs

Scaffold and implement future lessons (Gossipsub, DHT, NAT traversal, etc.).
Add instructor checkpoint integration for live classroom validation.
Expand automated CI coverage for all lessons.

Console Output:

Lesson 1: (Identity & Swarm Basics)

Lesson 2 (TCP Transport)

Lesson 3 (Ping Protocol)

revamp lesson.md in a comprehensive way.

luu-alex · 2025-06-28T17:13:22Z

@Nkovaturient Hey there! I'll help create the set up/checks and deps for js. As well I think there is quite a bit of work needed for each lesson. Is there a chance you can split each lesson into its own seperate PR? it'll be easier to manage and review 😄
@dhuseby as well, will we need to add the js guide to workshops? Edit: looking at state.txt i understand the techincal implementations more. thanks!

luu-alex · 2025-06-29T01:35:11Z

Created a PR to edit the docker files and configs to structure for the workshop flow.
Nkovaturient#2
@dhuseby should all these files be added in /app? or is the user supposed to be creating this on their own project

Update/js peer workshop

…ectivity-workshop into feat/js-peer-workshop

Update lesson 2 dockerfiles

…nt/universal-connectivity-workshop into feat/js-peer-workshop

Nkovaturient · 2025-07-10T19:38:47Z

Updates

03-ping-protocol/check.py

Purpose: Validates the implementation of the ping protocol.
- Provides clear, actionable feedback for each step and prints a summary of what was achieved.

04-circuit-relay-v2

Demonstrates p2p connections between two peers where one(listener) peer is behind a NAT/firewall(unreachable) however can be connected via a circuit-relay-v2 reservations medium tht sends inbound connections from listener node to dialer node, facilitating communications.

05-identify-protocol

Implements identify protocol lesson tht facilitates exchange of info with other peers in the network, including addresses, public keys, and capabilities.

06-gossipsub-module

Lesson 6 implements extensible baseline pubsub protocol: gossipsub to clarify how p2p connections and messages are communicated between connected peers in a network.

General Setup/Pattern

Each lesson folder contains:
- A robust check.py script tailored to the protocol/module being taught.
- An app/ directory with the actual node implementations for the lesson.

Core features are setup just Lesson 4 and 5 are under active development ..🚧

…shop

Update/js peer workshop lesson 2

luu-alex · 2025-07-15T02:39:05Z

finished lesson 2, added more relevant info and fixed docker. added checker as well. Will continue fixing the next lessons

Update/js peer workshop lesson 3

update lesson 1

update lesson 2

dhuseby · 2025-07-31T18:31:41Z

perhaps this will help you figure out the structure of the content: https://github.com/libp2p/workshop/blob/main/WORKSHOP_AUTHORING.md

dhuseby

Still need to clean some stuff up.

en/js/setup.md

en/js/deps.py

en/js/01-identity-and-swarm/lesson.yaml

en/js/test/scripts.md

en/js/02-tcp-transport/lesson.yaml

en/js/03-ping-protocol/lesson.yaml

en/js/06-gossipsub-module/lesson.yaml

en/js/05-identify-protocol/lesson.yaml

en/js/04-circuit-relay-v2/lesson.yaml

…nt/universal-connectivity-workshop into feat/js-peer-workshop

Nkovaturient · 2025-08-01T07:04:55Z

Hey @dhuseby
I have revamped the js-lessons setup

Updated deps.py - Removed Docker and docker-compose checks, now only validates Node.js and npm
Modified setup.md - Added proper heading structure with ## 1. Project Setup for the directory creation section
Modified lesson.yaml - to include status indicators
Cleaned up structure - Removed test scripts

Thanks for the Workshop_Authoring_MD, will go through it.
Is there anything else to take care of?

Merge PR #8 from Nkovaturient/feat/lesson-3-fixes

* fix(l5): Identify-Protocol-checkpoint * feat: Add Lesson 5 (Identify Protocol) for JavaScript track - Complete lesson implementation with libp2p identify protocol - Fixed PeerId generation and private key handling - Added Docker containerization with proper networking - Included comprehensive validation with check.py - Updated workshop.yaml to support JavaScript lessons - All tests passing: Node.js direct, Docker Compose, Python checker Resolves: JavaScript Lesson 5 implementation Testing: Validated with multiple test methods * Add js-libp2p support and complete lesson paths for js in workshop.yaml * Revert "fix(l5): Identify-Protocol-checkpoint" This reverts commit 85ca2c3. --------- Co-authored-by: Hany Almnaem <[email protected]>

* Added Lesson 03 & 04 with dockerization * Updated peer-id generation logic * minor changes to lesson03 app/index.js

Nkovaturient · 2025-09-09T14:15:07Z

@dhuseby
I, Alex, Parth and Hany have so far completed this js-workshop lessons.
Patiently awaiting your review and further guidance on this.

…nt/universal-connectivity-workshop into addlesson6-on-workshop

…ovaturient/universal-connectivity-workshop into addlesson6-on-workshop" This reverts commit 6ab5765, reversing changes made to 669e5a9.

* feat: enhance GossipSub lesson with multi-peer demonstration Transform basic GossipSub lesson into comprehensive multi-peer demo: - Replace single-peer setup with realistic 2-peer network - Demonstrate actual peer-to-peer message exchange - Add professional educational documentation - Implement proper mesh formation and validation - Show bidirectional GossipSub messaging in action Educational improvements: - Students experience real decentralized messaging - See authentic libp2p peer discovery and connection - Understand GossipSub mesh topology formation - Validate actual pub/sub message propagation The lesson now demonstrates true GossipSub capabilities instead of basic topic subscription, providing realistic P2P learning. * feat: implement coordinated multi-peer GossipSub demonstration

Nkovaturient and others added 2 commits June 24, 2025 13:13

feat(js-peer): integrate-identity-and-tcp-lessons

c3ff17b

Update scripts.md

90c4d8b

dhuseby requested changes Jun 24, 2025

View reviewed changes

Nkovaturient added 2 commits June 26, 2025 00:05

feat(js-workshop): add lessons 1–3, deps.py + setup.md

6dc0b39

resolve-merge-conflicts

9e89754

luu-alex and others added 2 commits June 26, 2025 00:23

add to lesson

ee907a5

Merge pull request #1 from luu-alex/update/js-peer-workshop

46a0a47

revamp lesson.md in a comprehensive way.

luu-alex added 3 commits June 28, 2025 21:28

update docker files

73a1aca

update setup

96837d2

Merge branch 'feat/js-peer-workshop' into update/js-peer-workshop

31a61f3

Nkovaturient and others added 6 commits June 29, 2025 14:15

Merge pull request #2 from luu-alex/update/js-peer-workshop

7a9cd3e

Update/js peer workshop

Merge branch 'main' of https://github.com/Nkovaturient/universal-conn…

90caa7a

…ectivity-workshop into feat/js-peer-workshop

update check and docker files

313df97

Merge pull request #3 from luu-alex/update/js-peer-workshop

2e56d66

Update lesson 2 dockerfiles

feat(js-peer):setup lesson-4-to-6 + modify check.py

f625cd9

Merge branch 'feat/js-peer-workshop' of https://github.com/Nkovaturie…

33aa757

…nt/universal-connectivity-workshop into feat/js-peer-workshop

luu-alex added 5 commits July 13, 2025 13:22

update index.js

750e5b8

Merge remote-tracking branch 'upstream/main' into update/js-peer-work…

84b94b7

…shop

Merge branch 'feat/js-peer-workshop' into update/js-peer-workshop

ecbacc3

update, add more information to lesson and be compatible with docker

501848f

Merge pull request #4 from luu-alex/update/js-peer-workshop

9882456

Update/js peer workshop lesson 2

luu-alex added 3 commits July 21, 2025 09:55

update lesson three

2ae19ac

Merge pull request #5 from luu-alex/update/js-peer-workshop

5d19fe2

Update/js peer workshop lesson 3

update lesson 1

84da592

luu-alex added 3 commits July 23, 2025 20:24

Merge pull request #6 from luu-alex/update/js-peer-workshop

777568a

update lesson 1

update lesson 2

9bd4c79

Merge pull request #7 from luu-alex/update/js-peer-workshop

303b552

update lesson 2

dhuseby requested changes Jul 31, 2025

View reviewed changes

Nkovaturient and others added 3 commits August 1, 2025 12:16

Merge branch 'libp2p:main' into feat/js-peer-workshop

303323c

chore: update js workshop setup and remove test scripts

db29c68

Merge branch 'feat/js-peer-workshop' of https://github.com/Nkovaturie…

b63b134

…nt/universal-connectivity-workshop into feat/js-peer-workshop

parth-soni07 and others added 6 commits August 9, 2025 19:12

Lesson-3 Fixes

7e36f33

Minor fixes to console logs

e7dc904

fix: lesson-3

98c9956

Merge PR #8 from Nkovaturient/feat/lesson-3-fixes

chore(docker):L3+4 docker config and refactoring

87f657f

* Added Lesson 03 & 04 with dockerization * Updated peer-id generation logic * minor changes to lesson03 app/index.js

feat: add JavaScript Lesson 6 - GossipSub Pub/Sub

c71e1e9

Nkovaturient requested a review from dhuseby August 31, 2025 15:20

Hany-Almnaem and others added 4 commits September 12, 2025 18:07

Merge branch 'lesson-6-gossipsub' into addlesson6-on-workshop

669e5a9

Merge branch 'feat/js-peer-workshop' of https://github.com/Nkovaturie…

6ab5765

…nt/universal-connectivity-workshop into addlesson6-on-workshop

Revert "Merge branch 'feat/js-peer-workshop' of https://github.com/Nk…

064185d

…ovaturient/universal-connectivity-workshop into addlesson6-on-workshop" This reverts commit 6ab5765, reversing changes made to 669e5a9.

feat: js-peer-workshop #2

Are you sure you want to change the base?

feat: js-peer-workshop #2

Uh oh!

Conversation

Nkovaturient commented Jun 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✨ Add Js-peer Workshop Lessons 1 & 2 with Robust Automation and Testing

Description

Integration Highlights

Relevant Resources

Uh oh!

dhuseby left a comment

Choose a reason for hiding this comment

Uh oh!

Nkovaturient commented Jun 25, 2025

Uh oh!

Nkovaturient commented Jun 25, 2025

QnA

As for the latest commits inculcates following changes:

Further TODOs

Console Output:

Lesson 1: (Identity & Swarm Basics)

Lesson 2 (TCP Transport)

Lesson 3 (Ping Protocol)

Uh oh!

luu-alex commented Jun 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

luu-alex commented Jun 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Nkovaturient commented Jul 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Updates

03-ping-protocol/check.py

04-circuit-relay-v2

05-identify-protocol

06-gossipsub-module

General Setup/Pattern

Core features are setup just Lesson 4 and 5 are under active development ..🚧

Uh oh!

luu-alex commented Jul 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dhuseby commented Jul 31, 2025

Uh oh!

dhuseby left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Nkovaturient commented Aug 1, 2025

Uh oh!

Nkovaturient commented Sep 9, 2025

Uh oh!

Uh oh!

Nkovaturient commented Jun 24, 2025 •

edited

Loading

luu-alex commented Jun 28, 2025 •

edited

Loading

luu-alex commented Jun 29, 2025 •

edited

Loading

Nkovaturient commented Jul 10, 2025 •

edited

Loading

luu-alex commented Jul 15, 2025 •

edited

Loading