feat: js-peer-workshop

en/js/01-identity-and-swarm/app/Dockerfile

@@ -0,0 +1,10 @@
+FROM node:20-alpine as build
+WORKDIR /usr/src/app
+COPY package*.json ./
+RUN npm install
+COPY . .
+
+FROM node:20-alpine
+WORKDIR /usr/src/app
+COPY --from=build /usr/src/app /usr/src/app
+CMD ["node", "index.js"]

en/js/01-identity-and-swarm/app/index.js

@@ -0,0 +1,24 @@
+import { createLibp2p } from 'libp2p';
+import { tcp } from '@libp2p/tcp';
+import { noise } from '@chainsafe/libp2p-noise';
+import { yamux } from '@chainsafe/libp2p-yamux';
+
+const main = async () => {
+  const node = await createLibp2p({
+    addresses: {
+      listen: ['/ip4/0.0.0.0/tcp/0']
+    },
+    transports: [tcp()],
+    connectionEncrypters: [noise()],
+    streamMuxers: [yamux()]
+  });
+
+  await node.start();
+  console.log('PeerId:', node.peerId.toString());
+  console.log('Listening on:');
+  node.getMultiaddrs().forEach((addr) => {
+    console.log(addr.toString());
+  });
+};
+
+main().catch(console.error);

en/js/01-identity-and-swarm/check.py

@@ -0,0 +1,17 @@
+import sys
+import re
+
+SUCCESS = '\u2705'  # ✅
+FAILURE = '\u274C'  # ❌
+
+output = sys.stdin.read()
+
+peerid_match = re.search(r'PeerId: ([A-Za-z0-9]+)', output)
+listening_match = re.search(r'Listening on:\n(.+)', output, re.DOTALL)
+
+if peerid_match and listening_match and len(listening_match.group(1).strip().split('\n')) >= 1:
+    print(SUCCESS)
+    sys.exit(0)
+else:
+    print(FAILURE)
+    sys.exit(1)

en/js/01-identity-and-swarm/docker-compose.yaml

@@ -0,0 +1,10 @@
+version: '3.8'
+services:
+  app:
+    build: ./app
+    command: node index.js
+    working_dir: /usr/src/app
+    volumes:
+      - ./app:/usr/src/app
+    environment:
+      - NODE_ENV=development

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

@@ -0,0 +1,80 @@
+# Lesson 1: Identity & Swarm Basics
+
+Welcome to your first step in building a universal connectivity app with js-libp2p!
+
+## Objective
+- Generate a PeerId
+- Set up a minimal js-libp2p node with TCP transport
+- Print your PeerId and listening addresses
+- Observe basic node events
+
+---
+
+## Step-by-Step Instructions
+
+1. **Install Dependencies**
+   ```sh
+   npm install libp2p @libp2p/tcp @chainsafe/libp2p-noise @chainsafe/libp2p-yamux
+   ```
+
+2. **Generate a PeerId and Set Up Node**
+   - Create `index.js` in your `app/` directory.
+   - Use the following template to get started:
+
+   ```js
+   import { createLibp2p } from 'libp2p';
+   import { tcp } from '@libp2p/tcp';
+   import { noise } from '@chainsafe/libp2p-noise';
+   import { yamux } from '@chainsafe/libp2p-yamux';
+
+   const main = async () => {
+     const node = await createLibp2p({
+       addresses: {
+         listen: ['/ip4/0.0.0.0/tcp/0']
+       },
+       transports: [tcp()],
+       connectionEncrypters: [noise()],
+       streamMuxers: [yamux()]
+     });
+
+     await node.start();
+     console.log('PeerId:', node.peerId.toString());
+     console.log('Listening on:');
+     node.getMultiaddrs().forEach((addr) => {
+       console.log(addr.toString());
+     });
+   };
+
+   main().catch(console.error);
+   ```
+
+3. **Run Your Node**
+   ```sh
+   node app/index.js
+   ```
+   - You should see your PeerId and at least one listening address printed.
+
+---
+
+## Hints
+
+<details>
+<summary>Hint 1: How do I generate a PeerId?</summary>
+PeerId is generated automatically when you create a libp2p node with `createLibp2p`.
+</details>
+
+<details>
+<summary>Hint 2: What should I print?</summary>
+Print your PeerId using `node.peerId.toString()` and each address from `node.getMultiaddrs()`.
+</details>
+
+<details>
+<summary>Hint 3: Full Solution</summary>
+See the code template above. Make sure to install all dependencies and run the script from the correct directory.
+</details>
+
+---
+
+## Resources
+- [js-libp2p Getting Started Guide](https://docs.libp2p.io/guides/getting-started/javascript)
+- [js-libp2p API Docs](https://libp2p.github.io/js-libp2p/)

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

@@ -0,0 +1,17 @@
+title: Identity & Swarm Basics
+slug: identity-and-swarm
+language: javascript
+difficulty: beginner
+description: |
+  Learn how to generate a PeerId, set up a basic js-libp2p node, and print your PeerId and listening addresses.
+objectives:
+  - Generate a PeerId using js-libp2p
+  - Set up a minimal libp2p node with TCP transport
+  - Print PeerId and listening addresses
+  - Observe basic node events
+validation:
+  method: output
+  success_regex: 'PeerId: [A-Za-z0-9]+\nListening on: .+'
+  failure_message: 'Output must include a valid PeerId and at least one listening address.'
+  emoji_success: '\u2705' # ✅
+  emoji_failure: '\u274C' # ❌

en/js/02-tcp-transport/app/Dockerfile

@@ -0,0 +1,10 @@
+FROM node:20-alpine as build
+WORKDIR /usr/src/app
+COPY package*.json ./
+RUN npm install
+COPY . .
+
+FROM node:20-alpine
+WORKDIR /usr/src/app
+COPY --from=build /usr/src/app /usr/src/app
+CMD ["node", "index.js"]

en/js/02-tcp-transport/app/docker-compose.yaml

@@ -0,0 +1,10 @@
+version: '3.8'
+services:
+  app:
+    build: ./app
+    command: node index.js
+    working_dir: /usr/src/app
+    volumes:
+      - ./app:/usr/src/app
+    environment:
+      - NODE_ENV=development

en/js/02-tcp-transport/check.py

@@ -0,0 +1,16 @@
+import sys
+import re
+
+SUCCESS = '\u2705' 
+FAILURE = '\u274C'  
+
+output = sys.stdin.read()
+
+multiaddr_match = re.search(r'Listening on:.*(/ip4/.+/tcp/\d+/p2p/[A-Za-z0-9]+)', output, re.DOTALL)
+
+if multiaddr_match:
+    print(SUCCESS)
+    sys.exit(0)
+else:
+    print(FAILURE)
+    sys.exit(1)

en/js/02-tcp-transport/index.js

@@ -0,0 +1,40 @@
+import { createLibp2p } from 'libp2p';
+import { tcp } from '@libp2p/tcp';
+import { noise } from '@chainsafe/libp2p-noise';
+import { yamux } from '@chainsafe/libp2p-yamux';
+
+const main = async () => {
+  try {
+    const node = await createLibp2p({
+      addresses: {
+        listen: ['/ip4/0.0.0.0/tcp/0']
+      },
+      transports: [tcp()],
+      connectionEncrypters: [noise()],
+      streamMuxers: [yamux()]
+    });
+
+    node.addEventListener('peer:connect', (evt) => {
+      console.log('Connected to:', evt.detail.remotePeer.toString());
+    });
+
+    node.addEventListener('peer:disconnect', (evt) => {
+      console.log('Disconnected from:', evt.detail.remotePeer.toString());
+    });
+
+    node.addEventListener('error', (evt) => {
+      console.error('Node error:', evt.detail);
+    });
+
+    await node.start();
+    console.log('Listening on:');
+    node.getMultiaddrs().forEach((addr) => {
+      console.log(addr.toString());
+    });
+  } catch (err) {
+    console.error('Failed to start libp2p node:', err);
+    process.exit(1);
+  }
+};
+
+main();

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

@@ -0,0 +1,97 @@
+# Lesson 2: TCP Transport
+
+Welcome to Lesson 2! In this lesson, you'll set up TCP transport with Noise encryption and Yamux multiplexing in js-libp2p. You'll also learn to handle connection events and errors robustly.
+
+## Objective
+- Add TCP transport to your libp2p node
+- Add Noise encryption and Yamux multiplexing
+- Listen on a TCP address and print it
+- Handle connection and error events
+
+---
+
+## Step-by-Step Instructions
+
+1. **Install Dependencies**
+   (If you haven't already, run:)
+   ```sh
+   npm install libp2p @libp2p/tcp @chainsafe/libp2p-noise @chainsafe/libp2p-yamux
+   ```
+
+2. **Update Your Node Setup**
+   - In your `app/` directory, update or create `index.js` as follows:
+
+   ```js
+   import { createLibp2p } from 'libp2p';
+   import { tcp } from '@libp2p/tcp';
+   import { noise } from '@chainsafe/libp2p-noise';
+   import { yamux } from '@chainsafe/libp2p-yamux';
+
+   const main = async () => {
+     try {
+       const node = await createLibp2p({
+         addresses: {
+           listen: ['/ip4/0.0.0.0/tcp/0']
+         },
+         transports: [tcp()],
+         connectionEncrypters: [noise()],
+         streamMuxers: [yamux()]
+       });
+
+       node.addEventListener('peer:connect', (evt) => {
+         console.log('Connected to:', evt.detail.remotePeer.toString());
+       });
+
+       node.addEventListener('peer:disconnect', (evt) => {
+         console.log('Disconnected from:', evt.detail.remotePeer.toString());
+       });
+
+       node.addEventListener('error', (evt) => {
+         console.error('Node error:', evt.detail);
+       });
+
+       await node.start();
+       console.log('Listening on:');
+       node.getMultiaddrs().forEach((addr) => {
+         console.log(addr.toString());
+       });
+     } catch (err) {
+       console.error('Failed to start libp2p node:', err);
+       process.exit(1);
+     }
+   };
+
+   main();
+   ```
+
+3. **Run Your Node**
+   ```sh
+   node app/index.js
+   ```
+   - You should see at least one valid TCP multiaddr printed.
+   - Try connecting/disconnecting peers to see event logs (in later lessons).
+
+---
+
+## Hints
+
+<details>
+<summary>Hint 1: How do I handle connection events?</summary>
+Use `node.addEventListener('peer:connect', handler)` and similar for disconnects.
+</details>
+
+<details>
+<summary>Hint 2: How do I handle errors?</summary>
+Wrap your async code in try/catch and listen for the 'error' event on the node.
+</details>
+
+<details>
+<summary>Hint 3: Full Solution</summary>
+See the code template above. Ensure you handle errors and print all listening addresses.
+</details>
+
+---
+
+## Resources
+- [js-libp2p Getting Started Guide](https://docs.libp2p.io/guides/getting-started/javascript)
+- [js-libp2p API Docs](https://libp2p.github.io/js-libp2p/)

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

@@ -0,0 +1,17 @@
+title: TCP Transport
+slug: tcp-transport
+language: javascript
+difficulty: beginner
+description: |
+  Set up TCP transport with Noise encryption and Yamux multiplexing in js-libp2p. Learn to handle connection events and errors robustly.
+objectives:
+  - Add TCP transport to your libp2p node
+  - Add Noise encryption and Yamux multiplexing
+  - Listen on a TCP address and print it
+  - Handle connection and error events
+validation:
+  method: output
+  success_regex: 'Listening on: /ip4/.+/tcp/\d+/p2p/[A-Za-z0-9]+'
+  failure_message: 'Output must include at least one valid TCP multiaddr.'
+  emoji_success: '\u2705' # ✅
+  emoji_failure: '\u274C' # ❌