@aztec/p2p 0.84.0 → 0.85.0

package/src/testbench/worker_client_manager.ts

@@ -207,6 +207,8 @@ class WorkerClientManager {
         (_, ind) => ind !== clientIndex && ind < Math.min(this.peerEnrs.length, 10),
       );
 
+      this.logger.info(`Changing port for client ${clientIndex} to ${newPort} with other nodes `, otherNodes);
+
       const config = this.createClientConfig(clientIndex, newPort, otherNodes);
       const [childProcess, readySignal] = this.spawnWorkerProcess(config, clientIndex);
 
@@ -244,7 +246,7 @@ class WorkerClientManager {
         } catch (e) {
           this.logger.error(`Error force killing process ${index}:`, e);
         }
-      }, 10000); // 10 second timeout for graceful exit
+      }, 5000); // 5 second timeout for graceful exit
 
       // Listen for process exit
       process.once('exit', () => {
@@ -294,7 +296,7 @@ class WorkerClientManager {
               }
             });
             resolve();
-          }, 30000); // 30 second timeout for all processes
+          }, 10000); // 10 second timeout for all processes
         }),
       ]);
     } catch (error) {

package/src/util.ts

@@ -1,4 +1,5 @@
-import type { AztecAsyncKVStore } from '@aztec/kv-store';
+import type { Logger } from '@aztec/foundation/log';
+import type { AztecAsyncKVStore, AztecAsyncSingleton } from '@aztec/kv-store';
 import type { DataStoreConfig } from '@aztec/kv-store/config';
 
 import type { GossipSub } from '@chainsafe/libp2p-gossipsub';
@@ -7,10 +8,14 @@ import type { PeerId, PrivateKey } from '@libp2p/interface';
 import type { ConnectionManager } from '@libp2p/interface-internal';
 import { createFromPrivKey } from '@libp2p/peer-id-factory';
 import { resolve } from 'dns/promises';
+import { promises as fs } from 'fs';
 import type { Libp2p } from 'libp2p';
+import path from 'path';
 
 import type { P2PConfig } from './config.js';
 
+const PEER_ID_DATA_DIR_FILE = 'p2p-private-key';
+
 export interface PubSubLibp2p extends Libp2p {
   services: {
     pubsub: GossipSub;
@@ -93,29 +98,73 @@ export async function configureP2PClientAddresses(
  * Get the peer id private key
  *
  * 1. Check if we have a peer id private key in the config
- * 2. If not, check we have a peer id private key persisted in the node
- * 3. If not, create a new one, then persist it in the node
+ * 2. If not, check if we have a peer id private key persisted in a file
+ * 3. If no file path or data directory is provided, check if we have a peer id private key in the node's store
+ * 4. If not, create a new one, then persist it in a file if a file path or data directory is provided or in the node's store otherwise
  *
  */
 export async function getPeerIdPrivateKey(
-  config: { peerIdPrivateKey?: string },
+  config: { peerIdPrivateKey?: string; peerIdPrivateKeyPath?: string; dataDirectory?: string },
   store: AztecAsyncKVStore,
+  logger: Logger,
 ): Promise<string> {
-  const peerIdPrivateKeySingleton = store.openSingleton<string>('peerIdPrivateKey');
+  const peerIdPrivateKeyFilePath =
+    config.peerIdPrivateKeyPath ??
+    (config.dataDirectory ? path.join(config.dataDirectory, PEER_ID_DATA_DIR_FILE) : undefined);
+  let peerIdPrivateKeySingleton: AztecAsyncSingleton<string> | undefined;
+
+  const writePrivateKeyToFile = async (filePath: string, privateKey: string) => {
+    await fs.mkdir(path.dirname(filePath), { recursive: true });
+    await fs.writeFile(filePath, privateKey);
+  };
+
+  // If the peerIdPrivateKey is provided in the config, we use it and persist it in either a file or the node's store
   if (config.peerIdPrivateKey) {
-    await peerIdPrivateKeySingleton.set(config.peerIdPrivateKey);
+    if (peerIdPrivateKeyFilePath) {
+      await writePrivateKeyToFile(peerIdPrivateKeyFilePath, config.peerIdPrivateKey);
+    } else {
+      peerIdPrivateKeySingleton = store.openSingleton<string>('peerIdPrivateKey');
+      await peerIdPrivateKeySingleton.set(config.peerIdPrivateKey);
+    }
     return config.peerIdPrivateKey;
   }
 
-  const storedPeerIdPrivateKey = await peerIdPrivateKeySingleton.getAsync();
+  // Check to see if we have a peer id private key stored in a file or the node's store
+  let storedPeerIdPrivateKey: string | undefined;
+  const privateKeyFileExists =
+    peerIdPrivateKeyFilePath &&
+    (await fs
+      .access(peerIdPrivateKeyFilePath)
+      .then(() => true)
+      .catch(() => false));
+  if (peerIdPrivateKeyFilePath && privateKeyFileExists) {
+    await fs.access(peerIdPrivateKeyFilePath);
+    storedPeerIdPrivateKey = await fs.readFile(peerIdPrivateKeyFilePath, 'utf8');
+  } else {
+    peerIdPrivateKeySingleton = store.openSingleton<string>('peerIdPrivateKey');
+    storedPeerIdPrivateKey = await peerIdPrivateKeySingleton.getAsync();
+  }
   if (storedPeerIdPrivateKey) {
+    if (peerIdPrivateKeyFilePath && !privateKeyFileExists) {
+      logger.verbose(`Peer ID private key found in the node's store, persisting it to ${peerIdPrivateKeyFilePath}`);
+      await writePrivateKeyToFile(peerIdPrivateKeyFilePath, storedPeerIdPrivateKey);
+    }
     return storedPeerIdPrivateKey;
   }
 
+  // Generate and persist a new private key
   const newPeerIdPrivateKey = await generateKeyPair('secp256k1');
   const privateKeyString = Buffer.from(marshalPrivateKey(newPeerIdPrivateKey)).toString('hex');
+  if (peerIdPrivateKeyFilePath) {
+    logger.verbose(`Creating new peer ID private key and persisting it to ${peerIdPrivateKeyFilePath}`);
+    await writePrivateKeyToFile(peerIdPrivateKeyFilePath, privateKeyString);
+  } else {
+    logger.warn(
+      'Creating new peer ID private key and persisting it to the lmdb store. Key will be lost on rollup upgrade, specify the peer id private key path and restart the node to persist the peer id private key to a file',
+    );
+    await peerIdPrivateKeySingleton!.set(privateKeyString);
+  }
 
-  await peerIdPrivateKeySingleton.set(privateKeyString);
   return privateKeyString;
 }