@aztec/blob-client 0.0.1-commit.c2eed6949 → 0.0.1-commit.c52d6e7

package/src/client/http.ts

@@ -30,6 +30,9 @@ export class HttpBlobClient implements BlobClientInterface {
   /** Cached beacon slot duration in seconds. Fetched once at startup. */
   private beaconSecondsPerSlot?: number;
 
+  /** Indexes of consensus hosts that serve blob sidecars (supernodes). Populated by testSources(). */
+  private superNodeHostIndexes?: Set<number>;
+
   constructor(
     config?: BlobClientConfig,
     private readonly opts: {
@@ -100,6 +103,8 @@ export class HttpBlobClient implements BlobClientInterface {
     let archiveSources = 0;
     let blobSinks = 0;
 
+    const detectedSuperNodes = new Set<number>();
+
     if (l1ConsensusHostUrls && l1ConsensusHostUrls.length > 0) {
       for (let l1ConsensusHostIndex = 0; l1ConsensusHostIndex < l1ConsensusHostUrls.length; l1ConsensusHostIndex++) {
         const l1ConsensusHostUrl = l1ConsensusHostUrls[l1ConsensusHostIndex];
@@ -134,9 +139,12 @@ export class HttpBlobClient implements BlobClientInterface {
             const blobRes = await this.fetch(blobUrl, blobOptions);
             if (blobRes.ok) {
               this.log.info(`L1 consensus host serves blob sidecars (supernode)`, { l1ConsensusHostUrl });
+              detectedSuperNodes.add(l1ConsensusHostIndex);
               consensusSuperNodes++;
             } else {
-              this.log.info(`L1 consensus host does not serve blob sidecars`, { l1ConsensusHostUrl });
+              this.log.info(`L1 consensus host does not serve blob sidecars, skipping for blob fetching`, {
+                l1ConsensusHostUrl,
+              });
               consensusNonSuperNodes++;
             }
           } else {
@@ -149,6 +157,8 @@ export class HttpBlobClient implements BlobClientInterface {
       }
     }
 
+    this.superNodeHostIndexes = detectedSuperNodes;
+
     if (this.archiveClient) {
       try {
         const latest = await this.archiveClient.getLatestBlock();
@@ -218,18 +228,15 @@ export class HttpBlobClient implements BlobClientInterface {
   }
 
   /**
-   * Get the blob sidecar
+   * Get the blob sidecar.
    *
-   * If requesting from the blob client, we send the blobkHash
-   * If requesting from the beacon node, we send the slot number
-   *
-   * Source ordering depends on sync state:
-   * - Historical sync: blob client → FileStore → L1 consensus → Archive
-   * - Near tip sync: blob client → FileStore → L1 consensus → FileStore (with retries) → Archive (eg blobscan)
+   * Alternates between two primary sources (consensus and filestore) in a retry loop,
+   * then falls back to archive if blobs are still missing. The order of the primary
+   * sources is configurable via `blobPreferFilestores`.
    *
    * @param blockHash - The block hash
    * @param blobHashes - The blob hashes to fetch
-   * @param opts - Options including isHistoricalSync flag
+   * @param opts - Options for slot resolution
    * @returns The blobs
    */
   public async getBlobSidecar(
@@ -242,12 +249,11 @@ export class HttpBlobClient implements BlobClientInterface {
       return [];
     }
 
-    const isHistoricalSync = opts?.isHistoricalSync ?? false;
     // Accumulate blobs across sources, preserving order and handling duplicates
     // resultBlobs[i] will contain the blob for blobHashes[i], or undefined if not yet found
     const resultBlobs: (Blob | undefined)[] = new Array(blobHashes.length).fill(undefined);
 
-    // Helper to get  missing blob hashes that we still need to fetch
+    // Helper to get missing blob hashes that we still need to fetch
     const getMissingBlobHashes = (): Buffer[] =>
       blobHashes
         .map((bh, i) => (resultBlobs[i] === undefined ? bh : undefined))
@@ -276,84 +282,60 @@ export class HttpBlobClient implements BlobClientInterface {
       return blobs;
     };
 
-    const { l1ConsensusHostUrls } = this.config;
-
     const ctx = { blockHash, blobHashes: blobHashes.map(bufferToHex) };
 
-    // Try filestore (quick, no retries) - useful for both historical and near-tip sync
-    if (this.fileStoreClients.length > 0 && getMissingBlobHashes().length > 0) {
-      await this.tryFileStores(getMissingBlobHashes, fillResults, ctx);
-      if (getMissingBlobHashes().length === 0) {
-        return returnWithCallback(getFilledBlobs());
+    // Lazily resolve the slot number — only resolved when consensus hosts are actually tried.
+    let slotNumber: number | undefined;
+    let slotResolved = false;
+    const getSlotNumber = async (): Promise<number | undefined> => {
+      if (!slotResolved) {
+        slotNumber = await this.resolveSlotNumber(blockHash, opts);
+        slotResolved = true;
       }
-    }
+      return slotNumber;
+    };
 
-    const missingAfterSink = getMissingBlobHashes();
-    if (missingAfterSink.length > 0 && l1ConsensusHostUrls && l1ConsensusHostUrls.length > 0) {
-      // The beacon api can query by slot number, so we get that first
-      const consensusCtx = { l1ConsensusHostUrls, ...ctx };
-      this.log.trace(`Attempting to get slot number for block hash`, consensusCtx);
-      const slotNumber = await this.getSlotNumber(blockHash, opts?.parentBeaconBlockRoot, opts?.l1BlockTimestamp);
-      this.log.debug(`Got slot number ${slotNumber} from consensus host for querying blobs`, consensusCtx);
-
-      if (slotNumber) {
-        let l1ConsensusHostUrl: string;
-        for (let l1ConsensusHostIndex = 0; l1ConsensusHostIndex < l1ConsensusHostUrls.length; l1ConsensusHostIndex++) {
-          const missingHashes = getMissingBlobHashes();
-          if (missingHashes.length === 0) {
-            break;
-          }
+    // Build the two source-try functions. The order depends on the config.
+    const tryConsensus = () => this.tryConsensusHosts(getSlotNumber, getMissingBlobHashes, fillResults, ctx);
+    const tryFilestores = () => this.tryFileStores(getMissingBlobHashes, fillResults, ctx);
 
-          l1ConsensusHostUrl = l1ConsensusHostUrls[l1ConsensusHostIndex];
-          this.log.trace(`Attempting to get ${missingHashes.length} blobs from consensus host`, {
-            slotNumber,
-            l1ConsensusHostUrl,
-            ...ctx,
-          });
-          const blobs = await this.getBlobsFromHost(
-            l1ConsensusHostUrl,
-            slotNumber,
-            l1ConsensusHostIndex,
-            getMissingBlobHashes(),
-          );
-          const result = await fillResults(blobs);
-          this.log.debug(
-            `Got ${blobs.length} blobs from consensus host (total: ${result.length}/${blobHashes.length})`,
-            { slotNumber, l1ConsensusHostUrl, ...ctx },
-          );
-          if (result.length === blobHashes.length) {
-            return returnWithCallback(result);
-          }
-        }
-      }
-    }
+    const preferFilestores = this.config.blobPreferFilestores ?? false;
+    const [trySourceA, trySourceB] = preferFilestores ? [tryFilestores, tryConsensus] : [tryConsensus, tryFilestores];
 
-    // For near-tip sync, retry filestores with backoff (eventual consistency)
-    // This handles the case where blobs are still being uploaded by other validators
-    if (!isHistoricalSync && this.fileStoreClients.length > 0 && getMissingBlobHashes().length > 0) {
-      try {
-        await retry(
-          async () => {
-            await this.tryFileStores(getMissingBlobHashes, fillResults, ctx);
-            if (getMissingBlobHashes().length > 0) {
-              throw new Error('Still missing blobs from filestores');
-            }
-          },
-          'filestore blob retrieval',
-          makeBackoff([1, 1, 2]),
-          this.log,
-          true, // failSilently - expected to fail during eventual consistency
-        );
-        return returnWithCallback(getFilledBlobs());
-      } catch {
-        // Exhausted retries, continue to archive fallback
-      }
+    // Historical sync: blobs should already exist, use shorter backoff for transient errors.
+    // Near-tip sync: blobs may still be uploading, use longer backoff for eventual consistency.
+    const isHistoricalSync = opts?.isHistoricalSync ?? false;
+    const backoff = isHistoricalSync ? [1, 1] : [1, 1, 1, 2, 2];
+
+    // Retry loop: alternate between the two primary sources with backoff.
+    try {
+      await retry(
+        async () => {
+          if (getMissingBlobHashes().length > 0) {
+            await trySourceA();
+          }
+          if (getMissingBlobHashes().length > 0) {
+            await trySourceB();
+          }
+          if (getMissingBlobHashes().length > 0) {
+            throw new Error('Still missing blobs after trying all primary sources');
+          }
+        },
+        'blob retrieval',
+        makeBackoff(backoff),
+        this.log,
+        true, // failSilently — expected during eventual consistency
+      );
+      return returnWithCallback(getFilledBlobs());
+    } catch {
+      // Exhausted retries, continue to archive fallback
     }
 
-    const missingAfterConsensus = getMissingBlobHashes();
-    if (missingAfterConsensus.length > 0 && this.archiveClient) {
+    // Archive fallback
+    const missingAfterPrimary = getMissingBlobHashes();
+    if (missingAfterPrimary.length > 0 && this.archiveClient) {
       const archiveCtx = { archiveUrl: this.archiveClient.getBaseUrl(), ...ctx };
-      this.log.trace(`Attempting to get ${missingAfterConsensus.length} blobs from archive`, archiveCtx);
+      this.log.trace(`Attempting to get ${missingAfterPrimary.length} blobs from archive`, archiveCtx);
       const allBlobs = await this.archiveClient.getBlobsFromBlock(blockHash);
       if (!allBlobs) {
         this.log.debug('No blobs found from archive client', archiveCtx);
@@ -375,7 +357,7 @@ export class HttpBlobClient implements BlobClientInterface {
       this.log.warn(
         `Failed to fetch all blobs for ${blockHash} from all blob sources (got ${result.length}/${blobHashes.length})`,
         {
-          l1ConsensusHostUrls,
+          l1ConsensusHostUrls: this.config.l1ConsensusHostUrls,
           archiveUrl: this.archiveClient?.getBaseUrl(),
           fileStoreUrls: this.fileStoreClients.map(c => c.getBaseUrl()),
         },
@@ -384,6 +366,71 @@ export class HttpBlobClient implements BlobClientInterface {
     return returnWithCallback(result);
   }
 
+  /** Resolves the beacon slot number for the given block hash. Returns undefined if no consensus hosts. */
+  private resolveSlotNumber(
+    blockHash: `0x${string}`,
+    opts?: GetBlobSidecarOptions,
+  ): Promise<number | undefined> | undefined {
+    const { l1ConsensusHostUrls } = this.config;
+    if (!l1ConsensusHostUrls || l1ConsensusHostUrls.length === 0) {
+      return undefined;
+    }
+    // If no supernodes, no point resolving the slot
+    if (this.superNodeHostIndexes && this.superNodeHostIndexes.size === 0) {
+      return undefined;
+    }
+    return this.getSlotNumber(blockHash, opts?.parentBeaconBlockRoot, opts?.l1BlockTimestamp);
+  }
+
+  /**
+   * Try all supernode consensus hosts for blob sidecars.
+   * Skips hosts that were detected as non-supernodes during testSources().
+   */
+  private async tryConsensusHosts(
+    getSlotNumber: () => Promise<number | undefined>,
+    getMissingBlobHashes: () => Buffer[],
+    fillResults: (blobs: BlobJson[]) => Promise<Blob[]>,
+    ctx: { blockHash: string; blobHashes: string[] },
+  ): Promise<void> {
+    const { l1ConsensusHostUrls } = this.config;
+    if (!l1ConsensusHostUrls || l1ConsensusHostUrls.length === 0) {
+      return;
+    }
+
+    const slotNumber = await getSlotNumber();
+    if (!slotNumber) {
+      return;
+    }
+
+    for (let l1ConsensusHostIndex = 0; l1ConsensusHostIndex < l1ConsensusHostUrls.length; l1ConsensusHostIndex++) {
+      const missingHashes = getMissingBlobHashes();
+      if (missingHashes.length === 0) {
+        break;
+      }
+
+      // Skip non-supernode hosts if we've already detected supernodes
+      if (this.superNodeHostIndexes && !this.superNodeHostIndexes.has(l1ConsensusHostIndex)) {
+        this.log.trace(`Skipping non-supernode consensus host`, {
+          l1ConsensusHostUrl: l1ConsensusHostUrls[l1ConsensusHostIndex],
+        });
+        continue;
+      }
+
+      const l1ConsensusHostUrl = l1ConsensusHostUrls[l1ConsensusHostIndex];
+      this.log.trace(`Attempting to get ${missingHashes.length} blobs from consensus host`, {
+        slotNumber,
+        l1ConsensusHostUrl,
+        ...ctx,
+      });
+      const blobs = await this.getBlobsFromHost(l1ConsensusHostUrl, slotNumber, l1ConsensusHostIndex, missingHashes);
+      const result = await fillResults(blobs);
+      this.log.debug(
+        `Got ${blobs.length} blobs from consensus host (total: ${result.length}/${ctx.blobHashes.length})`,
+        { slotNumber, l1ConsensusHostUrl, ...ctx },
+      );
+    }
+  }
+
   /**
    * Try all filestores once (shuffled for load distribution).
    * @param getMissingBlobHashes - Function to get remaining blob hashes to fetch
@@ -499,16 +546,17 @@ export class HttpBlobClient implements BlobClientInterface {
       baseUrl += `?${params.toString()}`;
     }
 
-    const { url, ...options } = getBeaconNodeFetchOptions(baseUrl, this.config, l1ConsensusHostIndex);
-    this.log.debug(`Fetching blob sidecar for ${blockHashOrSlot}`, { url, ...options });
-    return this.fetch(url, options);
+    const { url, logSafeUrl, ...options } = getBeaconNodeFetchOptions(baseUrl, this.config, l1ConsensusHostIndex);
+    this.log.debug(`Fetching blob sidecar for ${blockHashOrSlot}`, { url: logSafeUrl, ...options });
+    // No retry here — this is called inside the main retry loop in getBlobSidecar
+    return fetch(url, options);
   }
 
   private async getLatestSlotNumber(hostUrl: string, l1ConsensusHostIndex?: number): Promise<number | undefined> {
     try {
       const baseUrl = `${hostUrl}/eth/v1/beacon/headers/head`;
-      const { url, ...options } = getBeaconNodeFetchOptions(baseUrl, this.config, l1ConsensusHostIndex);
-      this.log.debug(`Fetching latest slot number`, { url, ...options });
+      const { url, logSafeUrl, ...options } = getBeaconNodeFetchOptions(baseUrl, this.config, l1ConsensusHostIndex);
+      this.log.debug(`Fetching latest slot number`, { url: logSafeUrl, ...options });
       const res = await this.fetch(url, options);
       if (res.ok) {
         const body = await res.json();
@@ -771,12 +819,16 @@ function getBeaconNodeFetchOptions(url: string, config: BlobClientConfig, l1Cons
     l1ConsensusHostApiKeyHeaders[l1ConsensusHostIndex];
 
   let formattedUrl = url;
+  let logSafeUrl = url;
   if (l1ConsensusHostApiKey && l1ConsensusHostApiKey.getValue() !== '' && !l1ConsensusHostApiKeyHeader) {
-    formattedUrl += `${formattedUrl.includes('?') ? '&' : '?'}key=${l1ConsensusHostApiKey.getValue()}`;
+    const separator = formattedUrl.includes('?') ? '&' : '?';
+    formattedUrl += `${separator}key=${l1ConsensusHostApiKey.getValue()}`;
+    logSafeUrl += `${separator}key=[REDACTED]`;
   }
 
   return {
     url: formattedUrl,
+    logSafeUrl,
     ...(l1ConsensusHostApiKey &&
       l1ConsensusHostApiKeyHeader && {
         headers: {

package/src/client/interface.ts

@@ -6,9 +6,7 @@ import type { Blob } from '@aztec/blob-lib';
 export interface GetBlobSidecarOptions {
   /**
    * True if the archiver is catching up (historical sync), false if near tip.
-   * This affects source ordering:
-   * - Historical: FileStore first (data should exist), then L1 consensus, then archive (eg. blobscan)
-   * - Near tip: FileStore first with no retries (data should exist), L1 consensus second (freshest data), then FileStore with retries, then archive (eg. blobscan)
+   * Historical sync uses a shorter retry backoff since blobs should already exist.
    */
   isHistoricalSync?: boolean;
   /**

package/src/filestore/factory.ts

@@ -1,6 +1,7 @@
 import { type Logger, createLogger } from '@aztec/foundation/log';
 import {
   type FileStore,
+  type HttpFileStoreOptions,
   type ReadOnlyFileStore,
   createFileStore,
   createReadOnlyFileStore,
@@ -44,16 +45,19 @@ export async function createReadOnlyFileStoreBlobClient(
   storeUrl: string,
   metadata: BlobFileStoreMetadata,
   logger?: Logger,
+  httpOptions?: HttpFileStoreOptions,
 ): Promise<FileStoreBlobClient>;
 export async function createReadOnlyFileStoreBlobClient(
   storeUrl: string | undefined,
   metadata: BlobFileStoreMetadata,
   logger?: Logger,
+  httpOptions?: HttpFileStoreOptions,
 ): Promise<FileStoreBlobClient | undefined>;
 export async function createReadOnlyFileStoreBlobClient(
   storeUrl: string | undefined,
   metadata: BlobFileStoreMetadata,
   logger?: Logger,
+  httpOptions?: HttpFileStoreOptions,
 ): Promise<FileStoreBlobClient | undefined> {
   if (!storeUrl) {
     return undefined;
@@ -64,7 +68,7 @@ export async function createReadOnlyFileStoreBlobClient(
 
   log.debug(`Creating read-only filestore blob client`, { storeUrl, basePath });
 
-  const store: ReadOnlyFileStore = await createReadOnlyFileStore(storeUrl, log);
+  const store: ReadOnlyFileStore = await createReadOnlyFileStore(storeUrl, log, httpOptions);
   return new FileStoreBlobClient(store, basePath, log);
 }
 
@@ -80,6 +84,7 @@ export async function createReadOnlyFileStoreBlobClients(
   storeUrls: string[] | undefined,
   metadata: BlobFileStoreMetadata,
   logger?: Logger,
+  httpOptions?: HttpFileStoreOptions,
 ): Promise<FileStoreBlobClient[]> {
   if (!storeUrls || storeUrls.length === 0) {
     return [];
@@ -90,7 +95,7 @@ export async function createReadOnlyFileStoreBlobClients(
 
   for (const storeUrl of storeUrls) {
     try {
-      const client = await createReadOnlyFileStoreBlobClient(storeUrl, metadata, log);
+      const client = await createReadOnlyFileStoreBlobClient(storeUrl, metadata, log, httpOptions);
       if (client) {
         clients.push(client);
       }