@aztec/blob-client 0.0.1-commit.023c3e5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (96) hide show
  1. package/README.md +71 -0
  2. package/dest/archive/blobscan_archive_client.d.ts +146 -0
  3. package/dest/archive/blobscan_archive_client.d.ts.map +1 -0
  4. package/dest/archive/blobscan_archive_client.js +138 -0
  5. package/dest/archive/config.d.ts +7 -0
  6. package/dest/archive/config.d.ts.map +1 -0
  7. package/dest/archive/config.js +11 -0
  8. package/dest/archive/factory.d.ts +4 -0
  9. package/dest/archive/factory.d.ts.map +1 -0
  10. package/dest/archive/factory.js +7 -0
  11. package/dest/archive/index.d.ts +3 -0
  12. package/dest/archive/index.d.ts.map +1 -0
  13. package/dest/archive/index.js +2 -0
  14. package/dest/archive/instrumentation.d.ts +11 -0
  15. package/dest/archive/instrumentation.d.ts.map +1 -0
  16. package/dest/archive/instrumentation.js +33 -0
  17. package/dest/archive/interface.d.ts +13 -0
  18. package/dest/archive/interface.d.ts.map +1 -0
  19. package/dest/archive/interface.js +1 -0
  20. package/dest/blobstore/blob_store_test_suite.d.ts +3 -0
  21. package/dest/blobstore/blob_store_test_suite.d.ts.map +1 -0
  22. package/dest/blobstore/blob_store_test_suite.js +133 -0
  23. package/dest/blobstore/index.d.ts +3 -0
  24. package/dest/blobstore/index.d.ts.map +1 -0
  25. package/dest/blobstore/index.js +2 -0
  26. package/dest/blobstore/interface.d.ts +12 -0
  27. package/dest/blobstore/interface.d.ts.map +1 -0
  28. package/dest/blobstore/interface.js +1 -0
  29. package/dest/blobstore/memory_blob_store.d.ts +8 -0
  30. package/dest/blobstore/memory_blob_store.d.ts.map +1 -0
  31. package/dest/blobstore/memory_blob_store.js +24 -0
  32. package/dest/client/bin/index.d.ts +3 -0
  33. package/dest/client/bin/index.d.ts.map +1 -0
  34. package/dest/client/bin/index.js +30 -0
  35. package/dest/client/config.d.ts +54 -0
  36. package/dest/client/config.d.ts.map +1 -0
  37. package/dest/client/config.js +60 -0
  38. package/dest/client/factory.d.ts +40 -0
  39. package/dest/client/factory.d.ts.map +1 -0
  40. package/dest/client/factory.js +56 -0
  41. package/dest/client/http.d.ts +79 -0
  42. package/dest/client/http.d.ts.map +1 -0
  43. package/dest/client/http.js +567 -0
  44. package/dest/client/index.d.ts +6 -0
  45. package/dest/client/index.d.ts.map +1 -0
  46. package/dest/client/index.js +5 -0
  47. package/dest/client/interface.d.ts +28 -0
  48. package/dest/client/interface.d.ts.map +1 -0
  49. package/dest/client/interface.js +1 -0
  50. package/dest/client/local.d.ts +13 -0
  51. package/dest/client/local.d.ts.map +1 -0
  52. package/dest/client/local.js +19 -0
  53. package/dest/client/tests.d.ts +11 -0
  54. package/dest/client/tests.d.ts.map +1 -0
  55. package/dest/client/tests.js +51 -0
  56. package/dest/encoding/index.d.ts +15 -0
  57. package/dest/encoding/index.d.ts.map +1 -0
  58. package/dest/encoding/index.js +19 -0
  59. package/dest/filestore/factory.d.ts +50 -0
  60. package/dest/filestore/factory.d.ts.map +1 -0
  61. package/dest/filestore/factory.js +67 -0
  62. package/dest/filestore/filestore_blob_client.d.ts +67 -0
  63. package/dest/filestore/filestore_blob_client.d.ts.map +1 -0
  64. package/dest/filestore/filestore_blob_client.js +115 -0
  65. package/dest/filestore/healthcheck.d.ts +5 -0
  66. package/dest/filestore/healthcheck.d.ts.map +1 -0
  67. package/dest/filestore/healthcheck.js +3 -0
  68. package/dest/filestore/index.d.ts +3 -0
  69. package/dest/filestore/index.d.ts.map +1 -0
  70. package/dest/filestore/index.js +2 -0
  71. package/package.json +94 -0
  72. package/src/archive/blobscan_archive_client.ts +176 -0
  73. package/src/archive/config.ts +14 -0
  74. package/src/archive/factory.ts +11 -0
  75. package/src/archive/fixtures/blobscan_get_blob_data.json +1 -0
  76. package/src/archive/fixtures/blobscan_get_block.json +56 -0
  77. package/src/archive/index.ts +2 -0
  78. package/src/archive/instrumentation.ts +50 -0
  79. package/src/archive/interface.ts +9 -0
  80. package/src/blobstore/blob_store_test_suite.ts +110 -0
  81. package/src/blobstore/index.ts +2 -0
  82. package/src/blobstore/interface.ts +12 -0
  83. package/src/blobstore/memory_blob_store.ts +31 -0
  84. package/src/client/bin/index.ts +35 -0
  85. package/src/client/config.ts +127 -0
  86. package/src/client/factory.ts +93 -0
  87. package/src/client/http.ts +662 -0
  88. package/src/client/index.ts +5 -0
  89. package/src/client/interface.ts +29 -0
  90. package/src/client/local.ts +30 -0
  91. package/src/client/tests.ts +62 -0
  92. package/src/encoding/index.ts +21 -0
  93. package/src/filestore/factory.ts +145 -0
  94. package/src/filestore/filestore_blob_client.ts +149 -0
  95. package/src/filestore/healthcheck.ts +5 -0
  96. package/src/filestore/index.ts +2 -0
@@ -0,0 +1 @@
1
+ {"version":3,"file":"tests.d.ts","sourceRoot":"","sources":["../../src/client/tests.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAE1D;;;;GAIG;AACH,wBAAgB,kBAAkB,CAChC,YAAY,EAAE,MAAM,OAAO,CAAC;IAAE,MAAM,EAAE,mBAAmB,CAAC;IAAC,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;CAAE,CAAC,QAiD3F"}
@@ -0,0 +1,51 @@
1
+ import { makeRandomBlob } from '@aztec/blob-lib/testing';
2
+ /**
3
+ * Shared test suite for blob clients
4
+ * @param createClient - Function that creates a client instance for testing
5
+ * @param cleanup - Optional cleanup function to run after each test
6
+ */ export function runBlobClientTests(createClient) {
7
+ let blockId;
8
+ let client;
9
+ let cleanup;
10
+ beforeEach(async ()=>{
11
+ blockId = '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef';
12
+ const setup = await createClient();
13
+ client = setup.client;
14
+ cleanup = setup.cleanup;
15
+ });
16
+ afterEach(async ()=>{
17
+ await cleanup();
18
+ });
19
+ it('should send and retrieve blobs by hash', async ()=>{
20
+ const blob = makeRandomBlob(5);
21
+ const blobHash = blob.getEthVersionedBlobHash();
22
+ await client.sendBlobsToFilestore([
23
+ blob
24
+ ]);
25
+ const retrievedBlobs = await client.getBlobSidecar(blockId, [
26
+ blobHash
27
+ ]);
28
+ expect(retrievedBlobs).toHaveLength(1);
29
+ expect(retrievedBlobs[0]).toEqual(blob);
30
+ });
31
+ it('should handle multiple blobs', async ()=>{
32
+ const blobs = Array.from({
33
+ length: 3
34
+ }, ()=>makeRandomBlob(7));
35
+ const blobHashes = blobs.map((blob)=>blob.getEthVersionedBlobHash());
36
+ await client.sendBlobsToFilestore(blobs);
37
+ const retrievedBlobs = await client.getBlobSidecar(blockId, blobHashes);
38
+ expect(retrievedBlobs.length).toBe(3);
39
+ for(let i = 0; i < blobs.length; i++){
40
+ expect(retrievedBlobs[i]).toEqual(blobs[i]);
41
+ }
42
+ });
43
+ it('should return empty array for non-existent blob hash', async ()=>{
44
+ const nonExistentHash = Buffer.alloc(32);
45
+ nonExistentHash.fill(0xff);
46
+ const retrievedBlobs = await client.getBlobSidecar(blockId, [
47
+ nonExistentHash
48
+ ]);
49
+ expect(retrievedBlobs).toEqual([]);
50
+ });
51
+ }
@@ -0,0 +1,15 @@
1
+ /**
2
+ * Snappy decompress the blob buffer
3
+ *
4
+ * @param data - The blob buffer
5
+ * @returns The decompressed blob buffer
6
+ */
7
+ export declare function inboundTransform(data: Buffer): Buffer;
8
+ /**
9
+ * Snappy compress the blob buffer
10
+ *
11
+ * @param data - The blob buffer
12
+ * @returns The compressed blob buffer
13
+ */
14
+ export declare function outboundTransform(data: Buffer): Buffer;
15
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9lbmNvZGluZy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFFQTs7Ozs7R0FLRztBQUNILHdCQUFnQixnQkFBZ0IsQ0FBQyxJQUFJLEVBQUUsTUFBTSxHQUFHLE1BQU0sQ0FFckQ7QUFFRDs7Ozs7R0FLRztBQUNILHdCQUFnQixpQkFBaUIsQ0FBQyxJQUFJLEVBQUUsTUFBTSxHQUFHLE1BQU0sQ0FFdEQifQ==
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/encoding/index.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAErD;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAEtD"}
@@ -0,0 +1,19 @@
1
+ import { compressSync, uncompressSync } from 'snappy';
2
+ /**
3
+ * Snappy decompress the blob buffer
4
+ *
5
+ * @param data - The blob buffer
6
+ * @returns The decompressed blob buffer
7
+ */ export function inboundTransform(data) {
8
+ return Buffer.from(uncompressSync(data, {
9
+ asBuffer: true
10
+ }));
11
+ }
12
+ /**
13
+ * Snappy compress the blob buffer
14
+ *
15
+ * @param data - The blob buffer
16
+ * @returns The compressed blob buffer
17
+ */ export function outboundTransform(data) {
18
+ return Buffer.from(compressSync(data));
19
+ }
@@ -0,0 +1,50 @@
1
+ import { type Logger } from '@aztec/foundation/log';
2
+ import { FileStoreBlobClient } from './filestore_blob_client.js';
3
+ /**
4
+ * Metadata required to construct the base path for blob storage.
5
+ * Path format: aztec-{l1ChainId}-{rollupVersion}-{rollupAddress}/
6
+ */
7
+ export interface BlobFileStoreMetadata {
8
+ /** The L1 chain ID */
9
+ l1ChainId: number;
10
+ /** The rollup version */
11
+ rollupVersion: number;
12
+ /** The rollup contract address (with or without 0x prefix) */
13
+ rollupAddress: string;
14
+ }
15
+ /**
16
+ * Constructs the base path for blob storage.
17
+ * Format: aztec-{l1ChainId}-{rollupVersion}-{rollupAddress}
18
+ */
19
+ export declare function makeBlobBasePath(metadata: BlobFileStoreMetadata): string;
20
+ /**
21
+ * Creates a read-only FileStoreBlobClient for fetching blobs.
22
+ *
23
+ * @param storeUrl - The URL of the filestore (s3://, gs://, file://, https://)
24
+ * @param metadata - Chain metadata for constructing the base path
25
+ * @param logger - Optional logger
26
+ * @returns A FileStoreBlobClient for reading blobs, or undefined if storeUrl is undefined
27
+ */
28
+ export declare function createReadOnlyFileStoreBlobClient(storeUrl: string, metadata: BlobFileStoreMetadata, logger?: Logger): Promise<FileStoreBlobClient>;
29
+ export declare function createReadOnlyFileStoreBlobClient(storeUrl: string | undefined, metadata: BlobFileStoreMetadata, logger?: Logger): Promise<FileStoreBlobClient | undefined>;
30
+ /**
31
+ * Creates multiple read-only FileStoreBlobClients from an array of URLs.
32
+ *
33
+ * @param storeUrls - Array of filestore URLs
34
+ * @param metadata - Chain metadata for constructing the base path
35
+ * @param logger - Optional logger
36
+ * @returns Array of FileStoreBlobClients (excludes any that failed to create)
37
+ */
38
+ export declare function createReadOnlyFileStoreBlobClients(storeUrls: string[] | undefined, metadata: BlobFileStoreMetadata, logger?: Logger): Promise<FileStoreBlobClient[]>;
39
+ /**
40
+ * Creates a writable FileStoreBlobClient for uploading blobs.
41
+ * Note: https:// URLs are not supported for upload, only s3://, gs://, or file://.
42
+ *
43
+ * @param storeUrl - The URL of the filestore (s3://, gs://, file://)
44
+ * @param metadata - Chain metadata for constructing the base path
45
+ * @param logger - Optional logger
46
+ * @returns A writable FileStoreBlobClient, or undefined if storeUrl is undefined
47
+ */
48
+ export declare function createWritableFileStoreBlobClient(storeUrl: string, metadata: BlobFileStoreMetadata, logger?: Logger): Promise<FileStoreBlobClient>;
49
+ export declare function createWritableFileStoreBlobClient(storeUrl: string | undefined, metadata: BlobFileStoreMetadata, logger?: Logger): Promise<FileStoreBlobClient | undefined>;
50
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZmFjdG9yeS5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2ZpbGVzdG9yZS9mYWN0b3J5LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxLQUFLLE1BQU0sRUFBZ0IsTUFBTSx1QkFBdUIsQ0FBQztBQVFsRSxPQUFPLEVBQUUsbUJBQW1CLEVBQUUsTUFBTSw0QkFBNEIsQ0FBQztBQUVqRTs7O0dBR0c7QUFDSCxNQUFNLFdBQVcscUJBQXFCO0lBQ3BDLHNCQUFzQjtJQUN0QixTQUFTLEVBQUUsTUFBTSxDQUFDO0lBQ2xCLHlCQUF5QjtJQUN6QixhQUFhLEVBQUUsTUFBTSxDQUFDO0lBQ3RCLDhEQUE4RDtJQUM5RCxhQUFhLEVBQUUsTUFBTSxDQUFDO0NBQ3ZCO0FBRUQ7OztHQUdHO0FBQ0gsd0JBQWdCLGdCQUFnQixDQUFDLFFBQVEsRUFBRSxxQkFBcUIsR0FBRyxNQUFNLENBS3hFO0FBRUQ7Ozs7Ozs7R0FPRztBQUNILHdCQUFzQixpQ0FBaUMsQ0FDckQsUUFBUSxFQUFFLE1BQU0sRUFDaEIsUUFBUSxFQUFFLHFCQUFxQixFQUMvQixNQUFNLENBQUMsRUFBRSxNQUFNLEdBQ2QsT0FBTyxDQUFDLG1CQUFtQixDQUFDLENBQUM7QUFDaEMsd0JBQXNCLGlDQUFpQyxDQUNyRCxRQUFRLEVBQUUsTUFBTSxHQUFHLFNBQVMsRUFDNUIsUUFBUSxFQUFFLHFCQUFxQixFQUMvQixNQUFNLENBQUMsRUFBRSxNQUFNLEdBQ2QsT0FBTyxDQUFDLG1CQUFtQixHQUFHLFNBQVMsQ0FBQyxDQUFDO0FBbUI1Qzs7Ozs7OztHQU9HO0FBQ0gsd0JBQXNCLGtDQUFrQyxDQUN0RCxTQUFTLEVBQUUsTUFBTSxFQUFFLEdBQUcsU0FBUyxFQUMvQixRQUFRLEVBQUUscUJBQXFCLEVBQy9CLE1BQU0sQ0FBQyxFQUFFLE1BQU0sR0FDZCxPQUFPLENBQUMsbUJBQW1CLEVBQUUsQ0FBQyxDQW9CaEM7QUFFRDs7Ozs7Ozs7R0FRRztBQUNILHdCQUFzQixpQ0FBaUMsQ0FDckQsUUFBUSxFQUFFLE1BQU0sRUFDaEIsUUFBUSxFQUFFLHFCQUFxQixFQUMvQixNQUFNLENBQUMsRUFBRSxNQUFNLEdBQ2QsT0FBTyxDQUFDLG1CQUFtQixDQUFDLENBQUM7QUFDaEMsd0JBQXNCLGlDQUFpQyxDQUNyRCxRQUFRLEVBQUUsTUFBTSxHQUFHLFNBQVMsRUFDNUIsUUFBUSxFQUFFLHFCQUFxQixFQUMvQixNQUFNLENBQUMsRUFBRSxNQUFNLEdBQ2QsT0FBTyxDQUFDLG1CQUFtQixHQUFHLFNBQVMsQ0FBQyxDQUFDIn0=
@@ -0,0 +1 @@
1
+ {"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../../src/filestore/factory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAgB,MAAM,uBAAuB,CAAC;AAQlE,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AAEjE;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,sBAAsB;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,yBAAyB;IACzB,aAAa,EAAE,MAAM,CAAC;IACtB,8DAA8D;IAC9D,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,qBAAqB,GAAG,MAAM,CAKxE;AAED;;;;;;;GAOG;AACH,wBAAsB,iCAAiC,CACrD,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,qBAAqB,EAC/B,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,mBAAmB,CAAC,CAAC;AAChC,wBAAsB,iCAAiC,CACrD,QAAQ,EAAE,MAAM,GAAG,SAAS,EAC5B,QAAQ,EAAE,qBAAqB,EAC/B,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,mBAAmB,GAAG,SAAS,CAAC,CAAC;AAmB5C;;;;;;;GAOG;AACH,wBAAsB,kCAAkC,CACtD,SAAS,EAAE,MAAM,EAAE,GAAG,SAAS,EAC/B,QAAQ,EAAE,qBAAqB,EAC/B,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAoBhC;AAED;;;;;;;;GAQG;AACH,wBAAsB,iCAAiC,CACrD,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,qBAAqB,EAC/B,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,mBAAmB,CAAC,CAAC;AAChC,wBAAsB,iCAAiC,CACrD,QAAQ,EAAE,MAAM,GAAG,SAAS,EAC5B,QAAQ,EAAE,qBAAqB,EAC/B,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,mBAAmB,GAAG,SAAS,CAAC,CAAC"}
@@ -0,0 +1,67 @@
1
+ import { createLogger } from '@aztec/foundation/log';
2
+ import { createFileStore, createReadOnlyFileStore } from '@aztec/stdlib/file-store';
3
+ import { FileStoreBlobClient } from './filestore_blob_client.js';
4
+ /**
5
+ * Constructs the base path for blob storage.
6
+ * Format: aztec-{l1ChainId}-{rollupVersion}-{rollupAddress}
7
+ */ export function makeBlobBasePath(metadata) {
8
+ const { l1ChainId, rollupVersion, rollupAddress } = metadata;
9
+ // Normalize rollup address to lowercase without 0x prefix for consistency
10
+ const normalizedAddress = rollupAddress.toLowerCase().replace(/^0x/, '');
11
+ return `aztec-${l1ChainId}-${rollupVersion}-0x${normalizedAddress}`;
12
+ }
13
+ export async function createReadOnlyFileStoreBlobClient(storeUrl, metadata, logger) {
14
+ if (!storeUrl) {
15
+ return undefined;
16
+ }
17
+ const log = logger ?? createLogger('blob-client:filestore-factory');
18
+ const basePath = makeBlobBasePath(metadata);
19
+ log.debug(`Creating read-only filestore blob client`, {
20
+ storeUrl,
21
+ basePath
22
+ });
23
+ const store = await createReadOnlyFileStore(storeUrl, log);
24
+ return new FileStoreBlobClient(store, basePath, log);
25
+ }
26
+ /**
27
+ * Creates multiple read-only FileStoreBlobClients from an array of URLs.
28
+ *
29
+ * @param storeUrls - Array of filestore URLs
30
+ * @param metadata - Chain metadata for constructing the base path
31
+ * @param logger - Optional logger
32
+ * @returns Array of FileStoreBlobClients (excludes any that failed to create)
33
+ */ export async function createReadOnlyFileStoreBlobClients(storeUrls, metadata, logger) {
34
+ if (!storeUrls || storeUrls.length === 0) {
35
+ return [];
36
+ }
37
+ const log = logger ?? createLogger('blob-client:filestore-factory');
38
+ const clients = [];
39
+ for (const storeUrl of storeUrls){
40
+ try {
41
+ const client = await createReadOnlyFileStoreBlobClient(storeUrl, metadata, log);
42
+ if (client) {
43
+ clients.push(client);
44
+ }
45
+ } catch (err) {
46
+ log.error(`Failed to create read-only filestore blob client for ${storeUrl}`, err);
47
+ }
48
+ }
49
+ return clients;
50
+ }
51
+ export async function createWritableFileStoreBlobClient(storeUrl, metadata, logger) {
52
+ if (!storeUrl) {
53
+ return undefined;
54
+ }
55
+ const log = logger ?? createLogger('blob-client:filestore-factory');
56
+ const basePath = makeBlobBasePath(metadata);
57
+ log.debug(`Creating writable filestore blob client`, {
58
+ storeUrl,
59
+ basePath
60
+ });
61
+ const store = await createFileStore(storeUrl, log);
62
+ if (!store) {
63
+ log.warn(`Failed to create writable filestore for ${storeUrl}`);
64
+ return undefined;
65
+ }
66
+ return new FileStoreBlobClient(store, basePath, log);
67
+ }
@@ -0,0 +1,67 @@
1
+ import { Blob, type BlobJson } from '@aztec/blob-lib';
2
+ import { type Logger } from '@aztec/foundation/log';
3
+ import type { FileStore, ReadOnlyFileStore } from '@aztec/stdlib/file-store';
4
+ /**
5
+ * A blob client that uses a FileStore (S3/GCS/local) as the data source.
6
+ * Blobs are stored as JSON files keyed by their versioned blob hash.
7
+ */
8
+ export declare class FileStoreBlobClient {
9
+ private readonly store;
10
+ private readonly basePath;
11
+ private readonly log;
12
+ constructor(store: ReadOnlyFileStore | FileStore, basePath: string, logger?: Logger);
13
+ /**
14
+ * Get the path for a blob file.
15
+ * Format: basePath/blobs/{versionedBlobHash}.data
16
+ */
17
+ private blobPath;
18
+ /**
19
+ * Get the path for the healthcheck file.
20
+ * Format: basePath/.healthcheck
21
+ */
22
+ private healthcheckPath;
23
+ /**
24
+ * Fetch blobs by their versioned hashes.
25
+ * @param blobHashes - Array of versioned blob hashes (0x-prefixed hex strings)
26
+ * @returns Array of BlobJson objects for found blobs
27
+ */
28
+ getBlobsByHashes(blobHashes: string[]): Promise<BlobJson[]>;
29
+ /**
30
+ * Check if a blob exists in the store.
31
+ * @param versionedBlobHash - The versioned blob hash (0x-prefixed hex string)
32
+ */
33
+ exists(versionedBlobHash: string): Promise<boolean>;
34
+ /**
35
+ * Save a single blob to the store.
36
+ * @param blob - The blob to save
37
+ * @param skipIfExists - Skip saving if blob already exists (default: true)
38
+ * @throws Error if the store is read-only
39
+ */
40
+ saveBlob(blob: Blob, skipIfExists?: boolean): Promise<void>;
41
+ /**
42
+ * Save multiple blobs to the store in parallel.
43
+ * @param blobs - The blobs to save
44
+ * @param skipIfExists - Skip saving if blob already exists (default: true)
45
+ */
46
+ saveBlobs(blobs: Blob[], skipIfExists?: boolean): Promise<void>;
47
+ /**
48
+ * Get the base URL/path of the filestore.
49
+ */
50
+ getBaseUrl(): string;
51
+ /**
52
+ * Test if the filestore connection is working by checking for healthcheck file.
53
+ * The healthcheck file is uploaded periodically by writable clients via HttpBlobClient.start().
54
+ * This provides a uniform connection test across all store types (S3/GCS/Local/HTTP).
55
+ */
56
+ testConnection(): Promise<boolean>;
57
+ /**
58
+ * Upload the healthcheck file if it doesn't already exist.
59
+ * This enables read-only clients (HTTP) to verify connectivity.
60
+ */
61
+ uploadHealthcheck(): Promise<void>;
62
+ /**
63
+ * Check if the store supports write operations.
64
+ */
65
+ private isWritable;
66
+ }
67
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZmlsZXN0b3JlX2Jsb2JfY2xpZW50LmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvZmlsZXN0b3JlL2ZpbGVzdG9yZV9ibG9iX2NsaWVudC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsSUFBSSxFQUFFLEtBQUssUUFBUSxFQUErQixNQUFNLGlCQUFpQixDQUFDO0FBQ25GLE9BQU8sRUFBRSxLQUFLLE1BQU0sRUFBZ0IsTUFBTSx1QkFBdUIsQ0FBQztBQUNsRSxPQUFPLEtBQUssRUFBRSxTQUFTLEVBQUUsaUJBQWlCLEVBQUUsTUFBTSwwQkFBMEIsQ0FBQztBQUs3RTs7O0dBR0c7QUFDSCxxQkFBYSxtQkFBbUI7SUFJNUIsT0FBTyxDQUFDLFFBQVEsQ0FBQyxLQUFLO0lBQ3RCLE9BQU8sQ0FBQyxRQUFRLENBQUMsUUFBUTtJQUozQixPQUFPLENBQUMsUUFBUSxDQUFDLEdBQUcsQ0FBUztJQUU3QixZQUNtQixLQUFLLEVBQUUsaUJBQWlCLEdBQUcsU0FBUyxFQUNwQyxRQUFRLEVBQUUsTUFBTSxFQUNqQyxNQUFNLENBQUMsRUFBRSxNQUFNLEVBR2hCO0lBRUQ7OztPQUdHO0lBQ0gsT0FBTyxDQUFDLFFBQVE7SUFJaEI7OztPQUdHO0lBQ0gsT0FBTyxDQUFDLGVBQWU7SUFJdkI7Ozs7T0FJRztJQUNHLGdCQUFnQixDQUFDLFVBQVUsRUFBRSxNQUFNLEVBQUUsR0FBRyxPQUFPLENBQUMsUUFBUSxFQUFFLENBQUMsQ0FtQmhFO0lBRUQ7OztPQUdHO0lBQ0gsTUFBTSxDQUFDLGlCQUFpQixFQUFFLE1BQU0sR0FBRyxPQUFPLENBQUMsT0FBTyxDQUFDLENBRWxEO0lBRUQ7Ozs7O09BS0c7SUFDRyxRQUFRLENBQUMsSUFBSSxFQUFFLElBQUksRUFBRSxZQUFZLFVBQU8sR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLENBa0I3RDtJQUVEOzs7O09BSUc7SUFDRyxTQUFTLENBQUMsS0FBSyxFQUFFLElBQUksRUFBRSxFQUFFLFlBQVksVUFBTyxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FFakU7SUFFRDs7T0FFRztJQUNILFVBQVUsSUFBSSxNQUFNLENBRW5CO0lBRUQ7Ozs7T0FJRztJQUNHLGNBQWMsSUFBSSxPQUFPLENBQUMsT0FBTyxDQUFDLENBT3ZDO0lBRUQ7OztPQUdHO0lBQ0csaUJBQWlCLElBQUksT0FBTyxDQUFDLElBQUksQ0FBQyxDQVF2QztJQUVEOztPQUVHO0lBQ0gsT0FBTyxDQUFDLFVBQVU7Q0FHbkIifQ==
@@ -0,0 +1 @@
1
+ {"version":3,"file":"filestore_blob_client.d.ts","sourceRoot":"","sources":["../../src/filestore/filestore_blob_client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,KAAK,QAAQ,EAA+B,MAAM,iBAAiB,CAAC;AACnF,OAAO,EAAE,KAAK,MAAM,EAAgB,MAAM,uBAAuB,CAAC;AAClE,OAAO,KAAK,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAK7E;;;GAGG;AACH,qBAAa,mBAAmB;IAI5B,OAAO,CAAC,QAAQ,CAAC,KAAK;IACtB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IAJ3B,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAS;IAE7B,YACmB,KAAK,EAAE,iBAAiB,GAAG,SAAS,EACpC,QAAQ,EAAE,MAAM,EACjC,MAAM,CAAC,EAAE,MAAM,EAGhB;IAED;;;OAGG;IACH,OAAO,CAAC,QAAQ;IAIhB;;;OAGG;IACH,OAAO,CAAC,eAAe;IAIvB;;;;OAIG;IACG,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,CAmBhE;IAED;;;OAGG;IACH,MAAM,CAAC,iBAAiB,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAElD;IAED;;;;;OAKG;IACG,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,YAAY,UAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAkB7D;IAED;;;;OAIG;IACG,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,YAAY,UAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAEjE;IAED;;OAEG;IACH,UAAU,IAAI,MAAM,CAEnB;IAED;;;;OAIG;IACG,cAAc,IAAI,OAAO,CAAC,OAAO,CAAC,CAOvC;IAED;;;OAGG;IACG,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,CAQvC;IAED;;OAEG;IACH,OAAO,CAAC,UAAU;CAGnB"}
@@ -0,0 +1,115 @@
1
+ import { computeEthVersionedBlobHash } from '@aztec/blob-lib';
2
+ import { createLogger } from '@aztec/foundation/log';
3
+ import { inboundTransform, outboundTransform } from '../encoding/index.js';
4
+ import { HEALTHCHECK_CONTENT, HEALTHCHECK_FILENAME } from './healthcheck.js';
5
+ /**
6
+ * A blob client that uses a FileStore (S3/GCS/local) as the data source.
7
+ * Blobs are stored as JSON files keyed by their versioned blob hash.
8
+ */ export class FileStoreBlobClient {
9
+ store;
10
+ basePath;
11
+ log;
12
+ constructor(store, basePath, logger){
13
+ this.store = store;
14
+ this.basePath = basePath;
15
+ this.log = logger ?? createLogger('blob-client:filestore-client');
16
+ }
17
+ /**
18
+ * Get the path for a blob file.
19
+ * Format: basePath/blobs/{versionedBlobHash}.data
20
+ */ blobPath(versionedBlobHash) {
21
+ return `${this.basePath}/blobs/${versionedBlobHash}.data`;
22
+ }
23
+ /**
24
+ * Get the path for the healthcheck file.
25
+ * Format: basePath/.healthcheck
26
+ */ healthcheckPath() {
27
+ return `${this.basePath}/${HEALTHCHECK_FILENAME}`;
28
+ }
29
+ /**
30
+ * Fetch blobs by their versioned hashes.
31
+ * @param blobHashes - Array of versioned blob hashes (0x-prefixed hex strings)
32
+ * @returns Array of BlobJson objects for found blobs
33
+ */ async getBlobsByHashes(blobHashes) {
34
+ const blobs = [];
35
+ for(let i = 0; i < blobHashes.length; i++){
36
+ try {
37
+ const path = this.blobPath(blobHashes[i]);
38
+ if (!await this.store.exists(path)) {
39
+ continue;
40
+ }
41
+ const data = await this.store.read(path);
42
+ const json = JSON.parse(inboundTransform(data).toString());
43
+ blobs.push(json);
44
+ } catch (err) {
45
+ this.log.warn(`Failed to read blob ${blobHashes[i]} from filestore`, err);
46
+ }
47
+ }
48
+ return blobs;
49
+ }
50
+ /**
51
+ * Check if a blob exists in the store.
52
+ * @param versionedBlobHash - The versioned blob hash (0x-prefixed hex string)
53
+ */ exists(versionedBlobHash) {
54
+ return this.store.exists(this.blobPath(versionedBlobHash));
55
+ }
56
+ /**
57
+ * Save a single blob to the store.
58
+ * @param blob - The blob to save
59
+ * @param skipIfExists - Skip saving if blob already exists (default: true)
60
+ * @throws Error if the store is read-only
61
+ */ async saveBlob(blob, skipIfExists = true) {
62
+ if (!this.isWritable()) {
63
+ throw new Error('FileStore is read-only');
64
+ }
65
+ const versionedHash = `0x${computeEthVersionedBlobHash(blob.commitment).toString('hex')}`;
66
+ if (skipIfExists && await this.store.exists(this.blobPath(versionedHash))) {
67
+ this.log.trace(`Blob ${versionedHash} already exists, skipping`);
68
+ return;
69
+ }
70
+ const json = blob.toJSON();
71
+ await this.store.save(this.blobPath(versionedHash), outboundTransform(Buffer.from(JSON.stringify(json))));
72
+ this.log.debug(`Saved blob ${versionedHash} to filestore`);
73
+ }
74
+ /**
75
+ * Save multiple blobs to the store in parallel.
76
+ * @param blobs - The blobs to save
77
+ * @param skipIfExists - Skip saving if blob already exists (default: true)
78
+ */ async saveBlobs(blobs, skipIfExists = true) {
79
+ await Promise.all(blobs.map((blob)=>this.saveBlob(blob, skipIfExists)));
80
+ }
81
+ /**
82
+ * Get the base URL/path of the filestore.
83
+ */ getBaseUrl() {
84
+ return this.basePath;
85
+ }
86
+ /**
87
+ * Test if the filestore connection is working by checking for healthcheck file.
88
+ * The healthcheck file is uploaded periodically by writable clients via HttpBlobClient.start().
89
+ * This provides a uniform connection test across all store types (S3/GCS/Local/HTTP).
90
+ */ async testConnection() {
91
+ try {
92
+ return await this.store.exists(this.healthcheckPath());
93
+ } catch (err) {
94
+ this.log.warn(`Connection test failed: ${err?.message ?? String(err)}`);
95
+ return false;
96
+ }
97
+ }
98
+ /**
99
+ * Upload the healthcheck file if it doesn't already exist.
100
+ * This enables read-only clients (HTTP) to verify connectivity.
101
+ */ async uploadHealthcheck() {
102
+ if (!this.isWritable()) {
103
+ this.log.trace('Cannot upload healthcheck: store is read-only');
104
+ return;
105
+ }
106
+ const path = this.healthcheckPath();
107
+ await this.store.save(path, Buffer.from(HEALTHCHECK_CONTENT));
108
+ this.log.debug(`Uploaded healthcheck file to ${path}`);
109
+ }
110
+ /**
111
+ * Check if the store supports write operations.
112
+ */ isWritable() {
113
+ return 'save' in this.store;
114
+ }
115
+ }
@@ -0,0 +1,5 @@
1
+ /** Constants for healthcheck file used to test file store connectivity. */
2
+ export declare const HEALTHCHECK_FILENAME = ".healthcheck";
3
+ export declare const HEALTHCHECK_CONTENT = "ok";
4
+ export declare const DEFAULT_HEALTHCHECK_UPLOAD_INTERVAL_MINUTES = 60;
5
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaGVhbHRoY2hlY2suZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9maWxlc3RvcmUvaGVhbHRoY2hlY2sudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsMkVBQTJFO0FBRTNFLGVBQU8sTUFBTSxvQkFBb0IsaUJBQWlCLENBQUM7QUFDbkQsZUFBTyxNQUFNLG1CQUFtQixPQUFPLENBQUM7QUFDeEMsZUFBTyxNQUFNLDJDQUEyQyxLQUFLLENBQUMifQ==
@@ -0,0 +1 @@
1
+ {"version":3,"file":"healthcheck.d.ts","sourceRoot":"","sources":["../../src/filestore/healthcheck.ts"],"names":[],"mappings":"AAAA,2EAA2E;AAE3E,eAAO,MAAM,oBAAoB,iBAAiB,CAAC;AACnD,eAAO,MAAM,mBAAmB,OAAO,CAAC;AACxC,eAAO,MAAM,2CAA2C,KAAK,CAAC"}
@@ -0,0 +1,3 @@
1
+ /** Constants for healthcheck file used to test file store connectivity. */ export const HEALTHCHECK_FILENAME = '.healthcheck';
2
+ export const HEALTHCHECK_CONTENT = 'ok';
3
+ export const DEFAULT_HEALTHCHECK_UPLOAD_INTERVAL_MINUTES = 60; // 1 hour
@@ -0,0 +1,3 @@
1
+ export * from './filestore_blob_client.js';
2
+ export * from './factory.js';
3
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9maWxlc3RvcmUvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsY0FBYyw0QkFBNEIsQ0FBQztBQUMzQyxjQUFjLGNBQWMsQ0FBQyJ9
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/filestore/index.ts"],"names":[],"mappings":"AAAA,cAAc,4BAA4B,CAAC;AAC3C,cAAc,cAAc,CAAC"}
@@ -0,0 +1,2 @@
1
+ export * from './filestore_blob_client.js';
2
+ export * from './factory.js';
package/package.json ADDED
@@ -0,0 +1,94 @@
1
+ {
2
+ "name": "@aztec/blob-client",
3
+ "version": "0.0.1-commit.023c3e5",
4
+ "type": "module",
5
+ "bin": "./dest/client/bin/index.js",
6
+ "exports": {
7
+ "./client": "./dest/client/index.js",
8
+ "./client/config": "./dest/client/config.js",
9
+ "./encoding": "./dest/encoding/index.js",
10
+ "./filestore": "./dest/filestore/index.js"
11
+ },
12
+ "inherits": [
13
+ "../package.common.json"
14
+ ],
15
+ "scripts": {
16
+ "build": "yarn clean && ../scripts/tsc.sh",
17
+ "build:dev": "../scripts/tsc.sh --watch",
18
+ "clean": "rm -rf ./dest .tsbuildinfo",
19
+ "test": "NODE_NO_WARNINGS=1 node --experimental-vm-modules ../node_modules/.bin/jest --passWithNoTests --maxWorkers=${JEST_MAX_WORKERS:-8}"
20
+ },
21
+ "jest": {
22
+ "moduleNameMapper": {
23
+ "^(\\.{1,2}/.*)\\.[cm]?js$": "$1"
24
+ },
25
+ "testRegex": "./src/.*\\.test\\.(js|mjs|ts)$",
26
+ "rootDir": "./src",
27
+ "transform": {
28
+ "^.+\\.tsx?$": [
29
+ "@swc/jest",
30
+ {
31
+ "jsc": {
32
+ "parser": {
33
+ "syntax": "typescript",
34
+ "decorators": true
35
+ },
36
+ "transform": {
37
+ "decoratorVersion": "2022-03"
38
+ }
39
+ }
40
+ }
41
+ ]
42
+ },
43
+ "extensionsToTreatAsEsm": [
44
+ ".ts"
45
+ ],
46
+ "reporters": [
47
+ "default"
48
+ ],
49
+ "testTimeout": 120000,
50
+ "setupFiles": [
51
+ "../../foundation/src/jest/setup.mjs"
52
+ ],
53
+ "testEnvironment": "../../foundation/src/jest/env.mjs",
54
+ "setupFilesAfterEnv": [
55
+ "../../foundation/src/jest/setupAfterEnv.mjs"
56
+ ]
57
+ },
58
+ "dependencies": {
59
+ "@aztec/blob-lib": "0.0.1-commit.023c3e5",
60
+ "@aztec/ethereum": "0.0.1-commit.023c3e5",
61
+ "@aztec/foundation": "0.0.1-commit.023c3e5",
62
+ "@aztec/kv-store": "0.0.1-commit.023c3e5",
63
+ "@aztec/stdlib": "0.0.1-commit.023c3e5",
64
+ "@aztec/telemetry-client": "0.0.1-commit.023c3e5",
65
+ "express": "^4.21.2",
66
+ "snappy": "^7.2.2",
67
+ "source-map-support": "^0.5.21",
68
+ "tslib": "^2.4.0",
69
+ "viem": "npm:@aztec/viem@2.38.2",
70
+ "zod": "^3.23.8"
71
+ },
72
+ "devDependencies": {
73
+ "@jest/globals": "^30.0.0",
74
+ "@types/jest": "^30.0.0",
75
+ "@types/node": "^22.15.17",
76
+ "@types/source-map-support": "^0.5.10",
77
+ "@types/supertest": "^6.0.2",
78
+ "@typescript/native-preview": "7.0.0-dev.20260113.1",
79
+ "jest": "^30.0.0",
80
+ "jest-mock-extended": "^4.0.0",
81
+ "supertest": "^7.0.0",
82
+ "ts-node": "^10.9.1",
83
+ "typescript": "^5.3.3"
84
+ },
85
+ "files": [
86
+ "dest",
87
+ "src",
88
+ "!*.test.*"
89
+ ],
90
+ "types": "./dest/index.d.ts",
91
+ "engines": {
92
+ "node": ">=20.10"
93
+ }
94
+ }