@aztec/p2p-bootstrap 0.0.0-test.0

package/README.md

@@ -0,0 +1,11 @@
+# P2P Bootstrap
+
+This package provides an implementation of a 'Bootstrap' P2P node. It's purpose is to assist new network participants in acquiring peers.
+
+To build the package simply type `yarn build`, to start the boot node, simply type `yarn start`.
+
+The node will require a number of environment variables:
+
+P2P_UDP_LISTEN_ADDR - The address on which to listen for connections.
+PEER_ID_PRIVATE_KEY - The private key to be used by the peer for secure communications with other peers. This key will also be used to derive the Peer ID.
+P2P_UDP_ANNOUNCE_ADDR - The address that other peers should use to connect to this node, this may be different to P2P_TCP_LISTEN_ADDR if e.g. the node is behind a NAT.

package/dest/index.d.ts

@@ -0,0 +1,8 @@
+import { type BootnodeConfig } from '@aztec/p2p';
+import { type TelemetryClient } from '@aztec/telemetry-client';
+/**
+ * The application entry point.
+ */
+declare function main(config: BootnodeConfig, telemetryClient?: TelemetryClient, logger?: import("@aztec/foundation/log").Logger): Promise<void>;
+export default main;
+//# sourceMappingURL=index.d.ts.map

package/dest/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,cAAc,EAAiB,MAAM,YAAY,CAAC;AAChE,OAAO,EAAE,KAAK,eAAe,EAAsB,MAAM,yBAAyB,CAAC;AASnF;;GAEG;AACH,iBAAe,IAAI,CACjB,MAAM,EAAE,cAAc,EACtB,eAAe,GAAE,eAAsC,EACvD,MAAM,yCAAc,iBA6BrB;AAED,eAAe,IAAI,CAAC"}

package/dest/index.js

@@ -0,0 +1,36 @@
+import { createLogger } from '@aztec/foundation/log';
+import { createStore } from '@aztec/kv-store/lmdb-v2';
+import { BootstrapNode } from '@aztec/p2p';
+import { getTelemetryClient } from '@aztec/telemetry-client';
+import Koa from 'koa';
+import Router from 'koa-router';
+const debugLogger = createLogger('p2p-bootstrap:bootstrap_node');
+const { HTTP_PORT } = process.env;
+/**
+ * The application entry point.
+ */ async function main(config, telemetryClient = getTelemetryClient(), logger = debugLogger) {
+    const store = await createStore('p2p-bootstrap', 1, config, logger);
+    const bootstrapNode = new BootstrapNode(store, telemetryClient, logger);
+    await bootstrapNode.start(config);
+    logger.info('DiscV5 Bootnode started');
+    const httpApp = new Koa();
+    const router = new Router();
+    router.get('/health', (ctx)=>{
+        ctx.status = 200;
+    });
+    httpApp.use(router.routes()).use(router.allowedMethods());
+    httpApp.listen(HTTP_PORT, ()=>{
+        logger.info(`HTTP server listening on port ${HTTP_PORT}`);
+    });
+    const stop = async ()=>{
+        logger.debug('Stopping bootstrap node...');
+        await bootstrapNode.stop();
+        logger.info('Node stopped');
+        process.exit(0);
+    };
+    // eslint-disable-next-line @typescript-eslint/no-misused-promises
+    process.on('SIGTERM', stop);
+    // eslint-disable-next-line @typescript-eslint/no-misused-promises
+    process.on('SIGINT', stop);
+}
+export default main;

package/package.json

@@ -0,0 +1,88 @@
+{
+  "name": "@aztec/p2p-bootstrap",
+  "version": "0.0.0-test.0",
+  "type": "module",
+  "exports": "./dest/index.js",
+  "typedocOptions": {
+    "entryPoints": [
+      "./src/index.ts"
+    ],
+    "name": "P2P Bootstrap",
+    "tsconfig": "./tsconfig.json"
+  },
+  "scripts": {
+    "build": "yarn clean && tsc -b",
+    "build:dev": "tsc -b --watch",
+    "clean": "rm -rf ./dest .tsbuildinfo",
+    "formatting": "run -T prettier --check ./src && run -T eslint ./src",
+    "formatting:fix": "run -T eslint --fix ./src && run -T prettier -w ./src",
+    "start:dev": "tsc-watch -p tsconfig.json --onSuccess 'yarn start'",
+    "start": "node ./dest/index.js",
+    "test": "NODE_NO_WARNINGS=1 node --experimental-vm-modules ../node_modules/.bin/jest --passWithNoTests --maxWorkers=${JEST_MAX_WORKERS:-8}"
+  },
+  "inherits": [
+    "../package.common.json"
+  ],
+  "dependencies": {
+    "@aztec/foundation": "0.0.0-test.0",
+    "@aztec/kv-store": "0.0.0-test.0",
+    "@aztec/p2p": "0.0.0-test.0",
+    "@aztec/telemetry-client": "0.0.0-test.0",
+    "dotenv": "^16.0.3",
+    "koa": "^2.15.3",
+    "koa-router": "^12.0.1",
+    "tslib": "^2.4.0"
+  },
+  "devDependencies": {
+    "@jest/globals": "^29.5.0",
+    "@types/jest": "^29.5.0",
+    "@types/koa": "^2.15.0",
+    "@types/koa-router": "^7.4.8",
+    "@types/node": "^18.14.6",
+    "jest": "^29.5.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.0.4"
+  },
+  "files": [
+    "dest",
+    "src",
+    "!*.test.*"
+  ],
+  "types": "./dest/index.d.ts",
+  "jest": {
+    "moduleNameMapper": {
+      "^(\\.{1,2}/.*)\\.[cm]?js$": "$1"
+    },
+    "testRegex": "./src/.*\\.test\\.(js|mjs|ts)$",
+    "rootDir": "./src",
+    "transform": {
+      "^.+\\.tsx?$": [
+        "@swc/jest",
+        {
+          "jsc": {
+            "parser": {
+              "syntax": "typescript",
+              "decorators": true
+            },
+            "transform": {
+              "decoratorVersion": "2022-03"
+            }
+          }
+        }
+      ]
+    },
+    "extensionsToTreatAsEsm": [
+      ".ts"
+    ],
+    "reporters": [
+      "default"
+    ],
+    "testTimeout": 120000,
+    "setupFiles": [
+      "../../foundation/src/jest/setup.mjs"
+    ]
+  },
+  "engines": {
+    "node": ">=18"
+  }
+}

package/src/index.ts

@@ -0,0 +1,50 @@
+import { createLogger } from '@aztec/foundation/log';
+import { createStore } from '@aztec/kv-store/lmdb-v2';
+import { type BootnodeConfig, BootstrapNode } from '@aztec/p2p';
+import { type TelemetryClient, getTelemetryClient } from '@aztec/telemetry-client';
+
+import Koa from 'koa';
+import Router from 'koa-router';
+
+const debugLogger = createLogger('p2p-bootstrap:bootstrap_node');
+
+const { HTTP_PORT } = process.env;
+
+/**
+ * The application entry point.
+ */
+async function main(
+  config: BootnodeConfig,
+  telemetryClient: TelemetryClient = getTelemetryClient(),
+  logger = debugLogger,
+) {
+  const store = await createStore('p2p-bootstrap', 1, config, logger);
+
+  const bootstrapNode = new BootstrapNode(store, telemetryClient, logger);
+  await bootstrapNode.start(config);
+  logger.info('DiscV5 Bootnode started');
+
+  const httpApp = new Koa();
+  const router = new Router();
+  router.get('/health', (ctx: Koa.Context) => {
+    ctx.status = 200;
+  });
+
+  httpApp.use(router.routes()).use(router.allowedMethods());
+  httpApp.listen(HTTP_PORT, () => {
+    logger.info(`HTTP server listening on port ${HTTP_PORT}`);
+  });
+
+  const stop = async () => {
+    logger.debug('Stopping bootstrap node...');
+    await bootstrapNode.stop();
+    logger.info('Node stopped');
+    process.exit(0);
+  };
+  // eslint-disable-next-line @typescript-eslint/no-misused-promises
+  process.on('SIGTERM', stop);
+  // eslint-disable-next-line @typescript-eslint/no-misused-promises
+  process.on('SIGINT', stop);
+}
+
+export default main;