@aztec/p2p 0.1.0-alpha22 → 0.1.0-alpha39

package/src/client/index.ts

@@ -1,4 +1,5 @@
 import { L2BlockSource } from '@aztec/types';
+
 import { LibP2PService, P2PClient, P2PConfig, TxPool } from '../index.js';
 import { DummyP2PService } from '../service/dummy_service.js';
 

package/src/client/mocks.ts

@@ -1,3 +1,4 @@
+import { EthAddress } from '@aztec/circuits.js';
 import { L2Block, L2BlockSource } from '@aztec/types';
 
 /**
@@ -13,6 +14,14 @@ export class MockBlockSource implements L2BlockSource {
     }
   }
 
+  /**
+   * Method to fetch the rollup contract address at the base-layer.
+   * @returns The rollup address.
+   */
+  getRollupAddress(): Promise<EthAddress> {
+    return Promise.resolve(EthAddress.random());
+  }
+
   /**
    * Gets the number of the latest L2 block processed by the block source implementation.
    * @returns In this mock instance, returns the number of L2 blocks that we've mocked.
@@ -22,13 +31,22 @@ export class MockBlockSource implements L2BlockSource {
   }
 
   /**
-   * Gets the `take` amount of L2 blocks starting from `from`.
+   * Gets an l2 block.
+   * @param number - The block number to return (inclusive).
+   * @returns The requested L2 block.
+   */
+  public getL2Block(number: number) {
+    return Promise.resolve(this.l2Blocks[number]);
+  }
+
+  /**
+   * Gets up to `limit` amount of L2 blocks starting from `from`.
    * @param from - Number of the first block to return (inclusive).
-   * @param take - The number of blocks to return.
+   * @param limit - The maximum number of blocks to return.
    * @returns The requested mocked L2 blocks.
    */
-  public getL2Blocks(from: number, take: number) {
-    return Promise.resolve(this.l2Blocks.slice(from, from + take));
+  public getL2Blocks(from: number, limit: number) {
+    return Promise.resolve(this.l2Blocks.slice(from, from + limit));
   }
 
   /**

package/src/client/p2p_client.test.ts

@@ -1,10 +1,11 @@
-import { expect, jest } from '@jest/globals';
 import { L2BlockSource, mockTx } from '@aztec/types';
 
-import { P2PClient } from './p2p_client.js';
+import { expect, jest } from '@jest/globals';
+
+import { P2PService } from '../index.js';
 import { TxPool } from '../tx_pool/index.js';
 import { MockBlockSource } from './mocks.js';
-import { P2PService } from '../index.js';
+import { P2PClient } from './p2p_client.js';
 
 /**
  * Mockify helper for testing purposes.

package/src/client/p2p_client.ts

@@ -1,10 +1,9 @@
-import { L2Block, L2BlockContext, L2BlockDownloader, L2BlockSource } from '@aztec/types';
-import { Tx, TxHash } from '@aztec/types';
+import { createDebugLogger } from '@aztec/foundation/log';
+import { L2Block, L2BlockContext, L2BlockDownloader, L2BlockSource, Tx, TxHash } from '@aztec/types';
 
-import { TxPool } from '../tx_pool/index.js';
 import { getP2PConfigEnvVars } from '../config.js';
-import { createDebugLogger } from '@aztec/foundation/log';
 import { P2PService } from '../service/service.js';
+import { TxPool } from '../tx_pool/index.js';
 
 /**
  * Enum defining the possible states of the p2p client.
@@ -36,12 +35,14 @@ export interface P2PSyncState {
 export interface P2P {
   /**
    * Verifies the 'tx' and, if valid, adds it to local tx pool and forwards it to other peers.
+   * @param tx - The transaction.
    **/
   sendTx(tx: Tx): Promise<void>;
 
   /**
    * Deletes 'txs' from the pool, given hashes.
    * NOT used if we use sendTx as reconcileTxPool will handle this.
+   * @param txHashes - Hashes to check.
    **/
   deleteTxs(txHashes: TxHash[]): Promise<void>;
 
@@ -53,6 +54,7 @@ export interface P2P {
 
   /**
    * Returns a transaction in the transaction pool by its hash.
+   * @param txHash  - Hash of tx to return.
    * @returns A single tx or undefined.
    */
   getTxByhash(txHash: TxHash): Promise<Tx | undefined>;
@@ -75,7 +77,7 @@ export interface P2P {
    */
   isReady(): Promise<boolean>;
 
-  /*
+  /**
    * Returns the current status of the p2p client.
    */
   getStatus(): Promise<P2PSyncState>;
@@ -123,7 +125,7 @@ export class P2PClient implements P2P {
     private p2pService: P2PService,
     private log = createDebugLogger('aztec:p2p'),
   ) {
-    const { checkInterval, l2QueueSize } = getP2PConfigEnvVars();
+    const { p2pBlockCheckIntervalMS: checkInterval, l2QueueSize } = getP2PConfigEnvVars();
     this.blockDownloader = new L2BlockDownloader(l2BlockSource, l2QueueSize, checkInterval);
   }
 

package/src/config.ts

@@ -10,7 +10,7 @@ export interface P2PConfig {
   /**
    * The frequency in which to check.
    */
-  checkInterval: number;
+  p2pBlockCheckIntervalMS: number;
 
   /**
    * Size of queue of L2 blocks to store.
@@ -80,7 +80,7 @@ export interface P2PConfig {
 export function getP2PConfigEnvVars(): P2PConfig {
   const {
     P2P_ENABLED,
-    P2P_CHECK_INTERVAL,
+    P2P_BLOCK_CHECK_INTERVAL_MS,
     P2P_L2_BLOCK_QUEUE_SIZE,
     P2P_TCP_LISTEN_PORT,
     P2P_TCP_LISTEN_IP,
@@ -95,7 +95,7 @@ export function getP2PConfigEnvVars(): P2PConfig {
   } = process.env;
   const envVars: P2PConfig = {
     p2pEnabled: P2P_ENABLED === 'true',
-    checkInterval: P2P_CHECK_INTERVAL ? +P2P_CHECK_INTERVAL : 100,
+    p2pBlockCheckIntervalMS: P2P_BLOCK_CHECK_INTERVAL_MS ? +P2P_BLOCK_CHECK_INTERVAL_MS : 100,
     l2QueueSize: P2P_L2_BLOCK_QUEUE_SIZE ? +P2P_L2_BLOCK_QUEUE_SIZE : 1000,
     tcpListenPort: P2P_TCP_LISTEN_PORT ? +P2P_TCP_LISTEN_PORT : 0,
     tcpListenIp: P2P_TCP_LISTEN_IP ? P2P_TCP_LISTEN_IP : '0.0.0.0',

package/src/service/dummy_service.ts

@@ -1,4 +1,5 @@
 import { Tx, TxHash } from '@aztec/types';
+
 import { P2PService } from './service.js';
 
 /**

package/src/service/known_txs.test.ts

@@ -1,9 +1,11 @@
+import { randomBytes } from '@aztec/foundation/crypto';
+import { TxHash } from '@aztec/types';
+
 import { expect } from '@jest/globals';
+import { Ed25519PeerId, PeerId } from '@libp2p/interface-peer-id';
 import { mock } from 'jest-mock-extended';
-import { PeerId, Ed25519PeerId } from '@libp2p/interface-peer-id';
+
 import { KnownTxLookup } from './known_txs.js';
-import { TxHash } from '@aztec/types';
-import { randomBytes } from '@aztec/foundation/crypto';
 
 const createMockPeerId = (peerId: string): PeerId => {
   return mock<Ed25519PeerId>({

package/src/service/libp2p_service.ts

@@ -1,20 +1,26 @@
-import { Libp2p, Libp2pOptions, ServiceFactoryMap, createLibp2p } from 'libp2p';
-import { tcp } from '@libp2p/tcp';
+import { SerialQueue } from '@aztec/foundation/fifo';
+import { createDebugLogger } from '@aztec/foundation/log';
+import { Tx, TxHash } from '@aztec/types';
+
 import { noise } from '@chainsafe/libp2p-noise';
 import { yamux } from '@chainsafe/libp2p-yamux';
-import { mplex } from '@libp2p/mplex';
 import { bootstrap } from '@libp2p/bootstrap';
-import { DualKadDHT, kadDHT } from '@libp2p/kad-dht';
-import { createEd25519PeerId, createFromProtobuf, exportToProtobuf } from '@libp2p/peer-id-factory';
 import type { ServiceMap } from '@libp2p/interface-libp2p';
 import { PeerId } from '@libp2p/interface-peer-id';
 import { IncomingStreamData } from '@libp2p/interface-registrar';
-import { P2PService } from './service.js';
-import { createDebugLogger } from '@aztec/foundation/log';
-import { SerialQueue } from '@aztec/foundation/fifo';
-import { P2PConfig } from '../config.js';
-import { Tx, TxHash } from '@aztec/types';
+import { DualKadDHT, kadDHT } from '@libp2p/kad-dht';
+import { mplex } from '@libp2p/mplex';
+import { createEd25519PeerId, createFromProtobuf, exportToProtobuf } from '@libp2p/peer-id-factory';
+import { tcp } from '@libp2p/tcp';
 import { pipe } from 'it-pipe';
+import { Libp2p, Libp2pOptions, ServiceFactoryMap, createLibp2p } from 'libp2p';
+import { autoNATService } from 'libp2p/autonat';
+import { identifyService } from 'libp2p/identify';
+
+import { P2PConfig } from '../config.js';
+import { TxPool } from '../index.js';
+import { KnownTxLookup } from './known_txs.js';
+import { P2PService } from './service.js';
 import {
   Messages,
   createGetTransactionsRequestMessage,
@@ -25,10 +31,6 @@ import {
   decodeTransactionsMessage,
   getEncodedMessage,
 } from './tx_messages.js';
-import { KnownTxLookup } from './known_txs.js';
-import { TxPool } from '../index.js';
-import { autoNATService } from 'libp2p/autonat';
-import { identifyService } from 'libp2p/identify';
 
 const INITIAL_PEER_REFRESH_INTERVAL = 20000;
 

package/src/service/tx_messages.test.ts

@@ -1,9 +1,11 @@
 import { MAX_PUBLIC_CALL_STACK_LENGTH_PER_TX, Proof } from '@aztec/circuits.js';
 import { makeKernelPublicInputs, makePublicCallRequest } from '@aztec/circuits.js/factories';
 import { EncodedContractFunction, Tx, TxHash, TxL2Logs } from '@aztec/types';
+
 import { expect } from '@jest/globals';
 import { randomBytes } from 'crypto';
 import times from 'lodash.times';
+
 import {
   Messages,
   createGetTransactionsRequestMessage,

package/src/tx_pool/tx_pool.test.ts

@@ -1,4 +1,5 @@
 import { mockTx } from '@aztec/types';
+
 import { InMemoryTxPool } from './index.js';
 
 describe('In-Memory TX pool', () => {