Implement peer package to send messages between peers (#279)

* Initial implementation of class and discoving other peers * Implement peer connection and sending messages between peers * Add react app and use peer package for broadcasting * Maintain stream for each remote peer * Refactor code in peer package * Add serve package for react-app * Add readme for running react app * Add peer package readme * Add logs for events with details * Add a chat CLI using peer package (#280) * Add a flag to instantiate Peer for nodejs * Add a basic chat CLI using peer * Add a signal server arg to chat CLI * Add instructions for chat CLI * Fix typescript and ESM issues after adding peer package (#282) * Fix build issues in util package * Update eslint TS plugins * Scope react app package name * Convert cli package back to CJS and dynamically import ESM * Upgrade ts-node version * Fix tests * Setup a relay node and pubsub based discovery (#284) * Add a script to setup a relay node * Use pubsub based peer discovery * Add peer multiaddr to connection log * Catch relay node dial errors * Increase discovery interval and dial all mutiaddr * Add UI to display self peer ID and multiaddrs * Add UI for displaying live remote connections * Send js objects in peer broadcast messages * Add react-peer package for using peer in react app * Reduce disconnect frequency between peers (#287) * Restrict number of max concurrent dials per peer * Increase hop relay timeout to 1 day * Self review changes * Review changes * Increase pubsub discovery interval and add steps to create a peer id (#290) * Increase pubsub discovery interval * Disable autodial to avoid peer dials without protocol on a reconnect * Add steps to create a peer id and use for relay node * Add back dependency to run signalling server * Avoid bootstrapping and dial to relay node directly Co-authored-by: prathamesh0 <42446521+prathamesh0@users.noreply.github.com> Co-authored-by: prathamesh0 <prathamesh.musale0@gmail.com>
2026-09-08 16:54:08 +00:00 · 2023-01-10 20:10:27 +05:30
parent aa4a954330
commit cd29b47ecc
82 changed files with 17136 additions and 2475 deletions
@@ -0,0 +1,56 @@
+# cli
+
+## chat
+
+A basic CLI to pass messages between peers using `stdin`/`stdout`
+
+* Install dependencies:
+
+  ```bash
+  yarn install
+  ```
+
+* Build the `peer` package:
+
+  ```
+  cd packages/peer
+  yarn build
+  ```
+
+* (Optional) Run a local signalling server:
+
+  ```bash
+  # In packages/peer
+  yarn signal-server
+  ```
+
+* (Optional) Create and export a peer id for the relay node:
+
+  ```bash
+  # In packages/peer
+  yarn create-peer --file [PEER_ID_FILE_PATH]
+  ```
+
+  * `file (f)`: file path to export the peer id to (json)
+
+* (Optional) Run a local relay node:
+
+  ```bash
+  # In packages/peer
+  yarn relay-node --signal-server [SIGNAL_SERVER_URL] --peer-id-file [PEER_ID_FILE_PATH]
+  ```
+
+  * `signal-server`: multiaddr of a signalling server (default: local signalling server multiaddr)
+  * `peer-id-file`: file path for peer id to be used (json)
+
+* Start the node:
+
+  ```bash
+  # In packages/cli
+  yarn chat --signal-server [SIGNAL_SERVER_URL] --relay-node [RELAY_NODE_URL]
+  ```
+
+  * `signal-server`: multiaddr of a signalling server (default: local signalling server multiaddr)
+  * `relay-node`: multiaddr of a hop enabled relay node
+
+* The process starts reading from `stdin` and outputs messages from others peers to `stdout`.
@@ -7,13 +7,16 @@
    "lint": "eslint .",
    "build": "yarn clean && tsc && yarn copy-assets",
    "clean": "rm -rf ./dist",
-    "copy-assets": "copyfiles -u 1 src/**/*.gql dist/"
+    "copy-assets": "copyfiles -u 1 src/**/*.gql dist/",
+    "chat": "node dist/chat.js"
  },
  "dependencies": {
+    "@cerc-io/peer": "^0.2.18",
    "@cerc-io/util": "^0.2.18",
    "@ethersproject/providers": "^5.4.4",
    "@graphql-tools/utils": "^9.1.1",
-    "@ipld/dag-cbor": "^6.0.12",
+    "@ipld/dag-cbor": "^8.0.0",
+    "@libp2p/interface-peer-id": "^1.1.2",
    "apollo-server-express": "^3.11.1",
    "debug": "^4.3.1",
    "express": "^4.18.2",
@@ -24,13 +27,15 @@
  },
  "devDependencies": {
    "@types/express": "^4.17.14",
-    "@typescript-eslint/eslint-plugin": "^4.25.0",
-    "@typescript-eslint/parser": "^4.25.0",
+    "@types/node": "16.11.7",
+    "@typescript-eslint/eslint-plugin": "^5.47.1",
+    "@typescript-eslint/parser": "^5.47.1",
    "eslint-config-semistandard": "^15.0.1",
    "eslint-config-standard": "^5.0.0",
    "eslint-plugin-import": "^2.23.3",
    "eslint-plugin-node": "^11.1.0",
    "eslint-plugin-promise": "^5.1.0",
-    "eslint-plugin-standard": "^5.0.0"
+    "eslint-plugin-standard": "^5.0.0",
+    "typescript": "^4.9.4"
  }
 }
@@ -0,0 +1,63 @@
+//
+// Copyright 2022 Vulcanize, Inc.
+//
+
+import * as readline from 'readline';
+import { hideBin } from 'yargs/helpers';
+import yargs from 'yargs';
+
+// @ts-expect-error https://github.com/microsoft/TypeScript/issues/49721#issuecomment-1319854183
+import { PeerId } from '@libp2p/interface-peer-id';
+
+interface Arguments {
+  signalServer: string;
+  relayNode: string;
+}
+
+async function main (): Promise<void> {
+  const argv: Arguments = _getArgv();
+  if (!argv.signalServer) {
+    console.log('Using the default signalling server URL');
+  }
+
+  // https://adamcoster.com/blog/commonjs-and-esm-importexport-compatibility-examples#importing-esm-into-commonjs-cjs
+  const { Peer } = await import('@cerc-io/peer');
+  const peer = new Peer(true);
+  await peer.init(argv.signalServer, argv.relayNode);
+
+  peer.subscribeMessage((peerId: PeerId, message: string) => {
+    console.log(`> ${peerId.toString()} > ${message}`);
+  });
+
+  console.log(`Peer ID: ${peer.peerId?.toString()}`);
+
+  const rl = readline.createInterface({
+    input: process.stdin,
+    output: process.stdout
+  });
+
+  rl.on('line', (input: string) => {
+    peer.broadcastMessage(input);
+  });
+
+  console.log('Reading input...');
+}
+
+function _getArgv (): any {
+  return yargs(hideBin(process.argv)).parserConfiguration({
+    'parse-numbers': false
+  }).options({
+    signalServer: {
+      type: 'string',
+      describe: 'Signalling server URL'
+    },
+    relayNode: {
+      type: 'string',
+      describe: 'Relay node URL'
+    }
+  }).argv;
+}
+
+main().catch(err => {
+  console.log(err);
+});
@@ -22,7 +22,6 @@ import {
  GraphWatcherInterface,
  Config
 } from '@cerc-io/util';
-import * as codec from '@ipld/dag-cbor';

 import { BaseCmd } from './base';

@@ -164,6 +163,7 @@ export class ExportStateCmd {
    }

    if (this._argv.exportFile) {
+      const codec = await import('@ipld/dag-cbor');
      const encodedExportData = codec.encode(exportData);

      const filePath = path.resolve(this._argv.exportFile);
@@ -25,7 +25,6 @@ import {
  updateEntitiesFromState,
  Config
 } from '@cerc-io/util';
-import * as codec from '@ipld/dag-cbor';

 import { BaseCmd } from './base';

@@ -112,6 +111,7 @@ export class ImportStateCmd {
    // Import data.
    const importFilePath = path.resolve(this._argv.importFile);
    const encodedImportData = fs.readFileSync(importFilePath);
+    const codec = await import('@ipld/dag-cbor');
    const importData = codec.decode(Buffer.from(encodedImportData)) as any;

    // Fill the snapshot block.
@@ -5,7 +5,7 @@
    /* Basic Options */
    // "incremental": true,                         /* Enable incremental compilation */
    "target": "es5",                                /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', 'ES2021', or 'ESNEXT'. */
-    "module": "commonjs",                           /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
+    "module": "CommonJS",                           /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
    "lib": [ "ES5", "ES6", "ES2020" ],              /* Specify library files to be included in the compilation. */
    // "allowJs": true,                             /* Allow javascript files to be compiled. */
    // "checkJs": true,                             /* Report errors in .js files. */
@@ -44,13 +44,11 @@
    // "noPropertyAccessFromIndexSignature": true,  /* Require undeclared properties from index signatures to use element accesses. */

    /* Module Resolution Options */
-    "moduleResolution": "node",                  /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+    "moduleResolution": "Node16",                  /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
    // "baseUrl": "./",                             /* Base directory to resolve non-absolute module names. */
    // "paths": {},                                 /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
    // "rootDirs": [],                              /* List of root folders whose combined content represents the structure of the project at runtime. */
-    "typeRoots": [
-      "./src/types"
-    ],                                              /* List of folders to include type definitions from. */
+    "typeRoots": [],                                /* List of folders to include type definitions from. */
    // "types": [],                                 /* Type declaration files to be included in compilation. */
    // "allowSyntheticDefaultImports": true,        /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
    "esModuleInterop": true,                        /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */