envio 3.5.0-alpha.0 → 3.5.0-alpha.2

package/src/sources/EvmHyperSyncSource.res

@@ -1,6 +1,5 @@
 open Source
 
-
 // Surfaced by HyperSyncClient.getHeight (Rust) when HyperSync rejects the API
 // token. The corrupted-token test feeds the real server error through this
 // check so it can't silently drift away from what getHeightOrThrow guards on.
@@ -17,6 +16,8 @@ type options = {
   serializationFormat: HyperSyncClient.serializationFormat,
   enableQueryCaching: bool,
   logLevel: HyperSyncClient.logLevel,
+  // The chain's address index; the client reads it while routing.
+  addressStore: AddressStore.t,
 }
 
 let make = (
@@ -30,6 +31,7 @@ let make = (
     serializationFormat,
     enableQueryCaching,
     logLevel,
+    addressStore,
   }: options,
 ): t => {
   let name = "HyperSync"
@@ -46,13 +48,12 @@ Learn more or get a free Envio API token at: https://envio.dev/app/api-tokens`)
     ~url=endpointUrl,
     ~apiToken,
     ~httpReqTimeoutMillis=clientTimeoutMillis,
-    ~eventRegistrations=HyperSyncClient.Registration.fromOnEventRegistrations(
-      onEventRegistrations,
-    ),
+    ~eventRegistrations=HyperSyncClient.Registration.fromOnEventRegistrations(onEventRegistrations),
     ~enableChecksumAddresses=!lowercaseAddresses,
     ~serializationFormat,
     ~enableQueryCaching,
     ~logLevel,
+    ~addressStore,
   ) {
   | client => client
   | exception exn =>
@@ -89,8 +90,7 @@ Learn more or get a free Envio API token at: https://envio.dev/app/api-tokens`)
   let getItemsOrThrow = async (
     ~fromBlock,
     ~toBlock,
-    ~addressesByContractName,
-    ~contractNameByAddress as _,
+    ~addressSet,
     ~knownHeight,
     ~partitionId as _,
     ~selection: FetchState.selection,
@@ -109,7 +109,8 @@ Learn more or get a free Envio API token at: https://envio.dev/app/api-tokens`)
       ~toBlock,
       ~maxNumLogs=itemsTarget,
       ~registrationIndexes=selection.onEventRegistrations->Array.map(reg => reg.index),
-      ~addressesByContractName,
+      ~addressSet,
+      ~clientFilteredContracts=selection.clientFilteredContracts,
     ) catch {
     | HyperSync.GetLogs.Error(error) =>
       throw(
@@ -180,8 +181,7 @@ Learn more or get a free Envio API token at: https://envio.dev/app/api-tokens`)
     let getBlock = blockNumber => blocksByNumber->Utils.Map.unsafeGet(blockNumber)
 
     pageUnsafe.items->Array.forEach(item => {
-      let onEventRegistration =
-        onEventRegistrations->Array.getUnsafe(item.onEventRegistrationIndex)
+      let onEventRegistration = onEventRegistrations->Array.getUnsafe(item.onEventRegistrationIndex)
       parsedQueueItems
       ->Array.push(makeEventBatchQueueItem(item, ~onEventRegistration))
       ->ignore

package/src/sources/EvmHyperSyncSource.res.mjs

@@ -28,7 +28,7 @@ Set the ENVIO_API_TOKEN environment variable in your .env file.
 Learn more or get a free Envio API token at: https://envio.dev/app/api-tokens`);
   let client;
   try {
-    client = HyperSyncClient.make(endpointUrl, apiToken$1, param.clientTimeoutMillis, HyperSyncClient.Registration.fromOnEventRegistrations(onEventRegistrations), !param.lowercaseAddresses, param.serializationFormat, param.enableQueryCaching, undefined, undefined, undefined, param.logLevel);
+    client = HyperSyncClient.make(endpointUrl, apiToken$1, param.clientTimeoutMillis, HyperSyncClient.Registration.fromOnEventRegistrations(onEventRegistrations), !param.lowercaseAddresses, param.serializationFormat, param.enableQueryCaching, undefined, undefined, undefined, param.logLevel, param.addressStore);
   } catch (raw_exn) {
     let exn = Primitive_exceptions.internalToException(raw_exn);
     client = ErrorHandling.mkLogAndRaise(undefined, "Failed to instantiate the hypersync client, please double check your ABI", exn);
@@ -52,12 +52,12 @@ Learn more or get a free Envio API token at: https://envio.dev/app/api-tokens`);
       }
     };
   };
-  let getItemsOrThrow = async (fromBlock, toBlock, addressesByContractName, param, knownHeight, param$1, selection, itemsTarget, retry, param$2) => {
+  let getItemsOrThrow = async (fromBlock, toBlock, addressSet, knownHeight, param, selection, itemsTarget, retry, param$1) => {
     let totalTimeRef = Performance.now();
     let startFetchingBatchTimeRef = Performance.now();
     let pageUnsafe;
     try {
-      pageUnsafe = await HyperSync.GetLogs.query(client, fromBlock, toBlock, itemsTarget, selection.onEventRegistrations.map(reg => reg.index), addressesByContractName);
+      pageUnsafe = await HyperSync.GetLogs.query(client, fromBlock, toBlock, itemsTarget, selection.onEventRegistrations.map(reg => reg.index), addressSet, selection.clientFilteredContracts);
     } catch (raw_error) {
       let error = Primitive_exceptions.internalToException(raw_error);
       if (error.RE_EXN_ID === HyperSync.GetLogs.$$Error) {

package/src/sources/EvmRpcClient.res

@@ -26,7 +26,10 @@ type nextPageParams = {
   // selections and the routing index are derived on the Rust side from the
   // registrations passed at construction.
   registrationIndexes: array<int>,
-  addressesByContractName: dict<array<Address.t>>,
+  // Contract names to fetch address-free even though their registrations
+  // depend on addresses (client-side filtering). None/empty means
+  // every address-dependent contract is filtered server-side.
+  clientFilteredContracts: option<array<string>>,
 }
 
 type nextPageResponse = {
@@ -38,7 +41,7 @@ type nextPageResponse = {
 // The caller provides a range; Rust decides the actual `toBlock` and returns it.
 type t = {
   getHeight: unit => promise<int>,
-  getNextPage: nextPageParams => promise<nextPageResponse>,
+  getNextPage: (nextPageParams, AddressSet.t) => promise<nextPageResponse>,
 }
 
 @send
@@ -47,6 +50,7 @@ external classNew: (
   cfg,
   array<HyperSyncClient.Registration.input>,
   ~checksumAddresses: bool,
+  ~addressStore: AddressStore.t,
 ) => t = "new"
 
 // Rust encodes JSON-RPC errors as a JSON payload in the napi error's
@@ -85,6 +89,7 @@ let make = (
   ~httpReqTimeoutMillis=?,
   ~headers=?,
   ~eventRegistrations=[],
+  ~addressStore,
 ) => {
   let client = Core.getAddon().evmRpcClient->classNew(
     {
@@ -100,9 +105,11 @@ let make = (
     },
     eventRegistrations,
     ~checksumAddresses,
+    ~addressStore,
   )
   {
     getHeight: () => client.getHeight()->Promise.catch(coerceErrorOrThrow),
-    getNextPage: params => client.getNextPage(params)->Promise.catch(coerceErrorOrThrow),
+    getNextPage: (params, addressSet) =>
+      client.getNextPage(params, addressSet)->Promise.catch(coerceErrorOrThrow),
   }
 }

package/src/sources/EvmRpcClient.res.mjs

@@ -46,7 +46,7 @@ function coerceErrorOrThrow(exn) {
   throw exn;
 }
 
-function make(url, checksumAddresses, syncConfig, httpReqTimeoutMillis, headers, eventRegistrationsOpt) {
+function make(url, checksumAddresses, syncConfig, httpReqTimeoutMillis, headers, eventRegistrationsOpt, addressStore) {
   let eventRegistrations = eventRegistrationsOpt !== undefined ? eventRegistrationsOpt : [];
   let client = Core.getAddon().EvmRpcClient.new({
     url: url,
@@ -58,10 +58,10 @@ function make(url, checksumAddresses, syncConfig, httpReqTimeoutMillis, headers,
     intervalCeiling: syncConfig.intervalCeiling,
     backoffMillis: syncConfig.backoffMillis,
     queryTimeoutMillis: syncConfig.queryTimeoutMillis
-  }, eventRegistrations, checksumAddresses);
+  }, eventRegistrations, checksumAddresses, addressStore);
   return {
     getHeight: () => Stdlib_Promise.$$catch(client.getHeight(), coerceErrorOrThrow),
-    getNextPage: params => Stdlib_Promise.$$catch(client.getNextPage(params), coerceErrorOrThrow)
+    getNextPage: (params, addressSet) => Stdlib_Promise.$$catch(client.getNextPage(params, addressSet), coerceErrorOrThrow)
   };
 }
 

package/src/sources/FuelHyperSync.res

@@ -43,16 +43,17 @@ module GetLogs = {
     ~fromBlock,
     ~toBlock,
     ~registrationIndexes,
-    ~addressesByContractName,
+    ~addressSet,
+    ~clientFilteredContracts,
   ): logsQueryPage => {
     let query: FuelHyperSyncClient.EventItems.query = {
       fromBlock,
       toBlock,
       registrationIndexes,
-      addressesByContractName,
+      clientFilteredContracts,
     }
 
-    let res = switch await client->FuelHyperSyncClient.getEventItems(query) {
+    let res = switch await client->FuelHyperSyncClient.getEventItems(query, addressSet) {
     | res => res
     | exception exn =>
       switch exn->extractMissingParams {

package/src/sources/FuelHyperSync.res.mjs

@@ -29,16 +29,16 @@ function extractMissingParams(exn) {
   }
 }
 
-async function query(client, fromBlock, toBlock, registrationIndexes, addressesByContractName) {
+async function query(client, fromBlock, toBlock, registrationIndexes, addressSet, clientFilteredContracts) {
   let query$1 = {
     fromBlock: fromBlock,
     toBlock: toBlock,
     registrationIndexes: registrationIndexes,
-    addressesByContractName: addressesByContractName
+    clientFilteredContracts: clientFilteredContracts
   };
   let res;
   try {
-    res = await client.getEventItems(query$1);
+    res = await client.getEventItems(query$1, addressSet);
   } catch (raw_exn) {
     let exn = Primitive_exceptions.internalToException(raw_exn);
     let missingParams = extractMissingParams(exn);

package/src/sources/FuelHyperSync.resi

@@ -17,6 +17,7 @@ module GetLogs: {
     ~fromBlock: int,
     ~toBlock: option<int>,
     ~registrationIndexes: array<int>,
-    ~addressesByContractName: dict<array<Address.t>>,
+    ~addressSet: AddressSet.t,
+    ~clientFilteredContracts: option<array<string>>,
   ) => promise<logsQueryPage>
 }

package/src/sources/FuelHyperSyncClient.res

@@ -52,15 +52,18 @@ module Registration = {
 }
 
 module EventItems = {
-  // The whole per-query input: block range, the partition's registration
-  // selection (by index), and its current addresses. Receipt selections,
-  // field selection, and routing are derived on the Rust side.
+  // The whole per-query input beside the partition's address set: block range
+  // and the registration selection (by index). Receipt selections, field
+  // selection, and routing are derived on the Rust side.
   type query = {
     fromBlock: int,
     // Inclusive; None queries to the end of available data.
     toBlock: option<int>,
     registrationIndexes: array<int>,
-    addressesByContractName: dict<array<Address.t>>,
+    // Contract names to fetch address-free even though their registrations
+    // depend on addresses (client-side filtering). None/empty means every
+    // address-dependent contract is filtered server-side.
+    clientFilteredContracts: option<array<string>>,
   }
 
   // One routed receipt with its kind-specific columns flattened: LogData
@@ -102,19 +105,22 @@ external classNew: (
   cfg,
   ~userAgent: string,
   array<Registration.input>,
+  AddressStore.t,
 ) => t = "new"
 
-let make = (cfg: cfg, ~eventRegistrations) => {
+let make = (cfg: cfg, ~eventRegistrations, ~addressStore) => {
   let envioVersion = Utils.EnvioPackage.value.version
   Core.getAddon().fuelHyperSyncClient->classNew(
     cfg,
     ~userAgent=`hyperindex/${envioVersion}`,
     eventRegistrations,
+    addressStore,
   )
 }
 
 @send
-external getEventItems: (t, EventItems.query) => promise<EventItems.response> = "getEventItems"
+external getEventItems: (t, EventItems.query, AddressSet.t) => promise<EventItems.response> =
+  "getEventItems"
 
 @send
 external getHeight: t => promise<int> = "getHeight"

package/src/sources/FuelHyperSyncClient.res.mjs

@@ -58,9 +58,9 @@ let Registration = {
 
 let EventItems = {};
 
-function make(cfg, eventRegistrations) {
+function make(cfg, eventRegistrations, addressStore) {
   let envioVersion = Utils.EnvioPackage.value.version;
-  return Core.getAddon().FuelHyperSyncClient.new(cfg, `hyperindex/` + envioVersion, eventRegistrations);
+  return Core.getAddon().FuelHyperSyncClient.new(cfg, `hyperindex/` + envioVersion, eventRegistrations, addressStore);
 }
 
 export {

package/src/sources/FuelHyperSyncSource.res

@@ -8,9 +8,11 @@ type options = {
   apiToken: option<string>,
   // The chain's registrations, indexed by their sequential `index`.
   onEventRegistrations: array<Internal.fuelOnEventRegistration>,
+  // The chain's address index; the client reads it while routing.
+  addressStore: AddressStore.t,
 }
 
-let make = ({chain, endpointUrl, apiToken, onEventRegistrations}: options): t => {
+let make = ({chain, endpointUrl, apiToken, onEventRegistrations, addressStore}: options): t => {
   let name = "HyperFuel"
 
   let apiToken = switch apiToken {
@@ -24,6 +26,7 @@ Learn more or get a free Envio API token at: https://envio.dev/app/api-tokens`)
   let client = switch FuelHyperSyncClient.make(
     {url: endpointUrl, apiToken},
     ~eventRegistrations=FuelHyperSyncClient.Registration.fromOnEventRegistrations(onEventRegistrations),
+    ~addressStore,
   ) {
   | client => client
   | exception exn =>
@@ -33,8 +36,7 @@ Learn more or get a free Envio API token at: https://envio.dev/app/api-tokens`)
   let getItemsOrThrow = async (
     ~fromBlock,
     ~toBlock,
-    ~addressesByContractName,
-    ~contractNameByAddress as _,
+    ~addressSet,
     ~knownHeight,
     ~partitionId as _,
     ~selection: FetchState.selection,
@@ -52,7 +54,8 @@ Learn more or get a free Envio API token at: https://envio.dev/app/api-tokens`)
       ~fromBlock,
       ~toBlock,
       ~registrationIndexes=selection.onEventRegistrations->Array.map(reg => reg.index),
-      ~addressesByContractName,
+      ~addressSet,
+      ~clientFilteredContracts=selection.clientFilteredContracts,
     ) catch {
     | FuelHyperSync.GetLogs.Error(error) =>
       throw(

package/src/sources/FuelHyperSyncSource.res.mjs

@@ -27,17 +27,17 @@ Learn more or get a free Envio API token at: https://envio.dev/app/api-tokens`);
     client = FuelHyperSyncClient.make({
       url: param.endpointUrl,
       apiToken: apiToken$1
-    }, FuelHyperSyncClient.Registration.fromOnEventRegistrations(onEventRegistrations));
+    }, FuelHyperSyncClient.Registration.fromOnEventRegistrations(onEventRegistrations), param.addressStore);
   } catch (raw_exn) {
     let exn = Primitive_exceptions.internalToException(raw_exn);
     client = ErrorHandling.mkLogAndRaise(undefined, "Failed to instantiate the HyperFuel client", exn);
   }
-  let getItemsOrThrow = async (fromBlock, toBlock, addressesByContractName, param, knownHeight, param$1, selection, param$2, retry, logger) => {
+  let getItemsOrThrow = async (fromBlock, toBlock, addressSet, knownHeight, param, selection, param$1, retry, logger) => {
     let totalTimeRef = Performance.now();
     let startFetchingBatchTimeRef = Performance.now();
     let pageUnsafe;
     try {
-      pageUnsafe = await FuelHyperSync.GetLogs.query(client, fromBlock, toBlock, selection.onEventRegistrations.map(reg => reg.index), addressesByContractName);
+      pageUnsafe = await FuelHyperSync.GetLogs.query(client, fromBlock, toBlock, selection.onEventRegistrations.map(reg => reg.index), addressSet, selection.clientFilteredContracts);
     } catch (raw_error) {
       let error = Primitive_exceptions.internalToException(raw_error);
       if (error.RE_EXN_ID === FuelHyperSync.GetLogs.$$Error) {

package/src/sources/HyperSync.res

@@ -16,7 +16,7 @@ let reraisIfRateLimited = exn =>
 
 type logsQueryPage = {
   items: array<HyperSyncClient.EventItems.item>,
-  // Block headers referenced by `items`, deduplicated by block number.
+  // Headers for every returned block, deduplicated by block number.
   blocks: array<HyperSyncClient.EventItems.blockHeader>,
   nextBlock: int,
   archiveHeight: int,
@@ -92,17 +92,21 @@ module GetLogs = {
     ~toBlock,
     ~maxNumLogs,
     ~registrationIndexes,
-    ~addressesByContractName,
+    ~addressSet,
+    ~clientFilteredContracts,
   ): logsQueryPage => {
     let query: HyperSyncClient.EventItems.query = {
       fromBlock,
       toBlock,
-      maxNumLogs,
+      ?maxNumLogs,
       registrationIndexes,
-      addressesByContractName,
+      clientFilteredContracts,
     }
 
-    let (res, transactionStore, blockStore) = switch await client.getEventItems(~query) {
+    let (res, transactionStore, blockStore) = switch await client.getEventItems(
+      ~query,
+      ~addressSet,
+    ) {
     | res => res
     | exception exn =>
       reraisIfRateLimited(exn)

package/src/sources/HyperSync.res.mjs

@@ -82,17 +82,17 @@ function extractMissingParams(exn) {
   }
 }
 
-async function query(client, fromBlock, toBlock, maxNumLogs, registrationIndexes, addressesByContractName) {
+async function query(client, fromBlock, toBlock, maxNumLogs, registrationIndexes, addressSet, clientFilteredContracts) {
   let query$1 = {
     fromBlock: fromBlock,
     toBlock: toBlock,
     maxNumLogs: maxNumLogs,
     registrationIndexes: registrationIndexes,
-    addressesByContractName: addressesByContractName
+    clientFilteredContracts: clientFilteredContracts
   };
   let match;
   try {
-    match = await client.getEventItems(query$1);
+    match = await client.getEventItems(query$1, addressSet);
   } catch (raw_exn) {
     let exn = Primitive_exceptions.internalToException(raw_exn);
     reraisIfRateLimited(exn);

package/src/sources/HyperSync.resi

@@ -32,9 +32,10 @@ module GetLogs: {
     ~client: HyperSyncClient.t,
     ~fromBlock: int,
     ~toBlock: option<int>,
-    ~maxNumLogs: int,
+    ~maxNumLogs: option<int>,
     ~registrationIndexes: array<int>,
-    ~addressesByContractName: dict<array<Address.t>>,
+    ~addressSet: AddressSet.t,
+    ~clientFilteredContracts: option<array<string>>,
   ) => promise<logsQueryPage>
 }
 

package/src/sources/HyperSyncClient.res

@@ -302,16 +302,20 @@ module Registration = {
 }
 
 module EventItems = {
-  // The whole per-query input: block range, the partition's registration
-  // selection (by id), and its current addresses. Log selections, field
-  // selection, and the routing index are derived on the Rust side.
+  // The whole per-query input beside the partition's address set: block range
+  // and the registration selection (by id). Log selections, field selection,
+  // and the routing index are derived on the Rust side.
   type query = {
     fromBlock: int,
     // Inclusive; None queries to the end of available data.
     toBlock: option<int>,
-    maxNumLogs: int,
+    // Absent means no server-side cap on the number of logs returned.
+    maxNumLogs?: int,
     registrationIndexes: array<int>,
-    addressesByContractName: dict<array<Address.t>>,
+    // Contract names to fetch address-free even though their registrations
+    // depend on addresses (client-side filtering). None/empty means
+    // every address-dependent contract is filtered server-side.
+    clientFilteredContracts: option<array<string>>,
   }
 
   type item = {
@@ -340,7 +344,9 @@ module EventItems = {
   type response = {
     archiveHeight: option<int>,
     nextBlock: int,
-    // One header per block number referenced by `items`.
+    // One header per returned block number, including blocks no item
+    // references — reorg detection reads them all. The block store keeps only
+    // the ones items reference.
     blocks: array<blockHeader>,
     items: array<item>,
     rollbackGuard: option<ResponseTypes.rollbackGuard>,
@@ -353,16 +359,22 @@ type t = {
   // and blocks.
   getEventItems: (
     ~query: EventItems.query,
+    ~addressSet: AddressSet.t,
   ) => promise<(EventItems.response, TransactionStore.t, BlockStore.t)>,
   getHeight: unit => promise<int>,
 }
 
 @send
-external classNew: (Core.evmHyperSyncClientCtor, cfg, string, array<Registration.input>) => t =
-  "new"
+external classNew: (
+  Core.evmHyperSyncClientCtor,
+  cfg,
+  string,
+  array<Registration.input>,
+  AddressStore.t,
+) => t = "new"
 
-let makeWithAgent = (cfg, ~userAgent, ~eventRegistrations) =>
-  Core.getAddon().evmHyperSyncClient->classNew(cfg, userAgent, eventRegistrations)
+let makeWithAgent = (cfg, ~userAgent, ~eventRegistrations, ~addressStore) =>
+  Core.getAddon().evmHyperSyncClient->classNew(cfg, userAgent, eventRegistrations, addressStore)
 
 type logLevel = [#trace | #debug | #info | #warn | #error]
 let logLevelSchema: S.t<logLevel> = S.enum([#trace, #debug, #info, #warn, #error])
@@ -388,6 +400,7 @@ let make = (
   ~retryBackoffMs=?,
   ~retryCeilingMs=?,
   ~logLevel=#info,
+  ~addressStore,
 ) => {
   let envioVersion = Utils.EnvioPackage.value.version
   makeWithAgent(
@@ -407,5 +420,6 @@ let make = (
     },
     ~userAgent=`hyperindex/${envioVersion}`,
     ~eventRegistrations,
+    ~addressStore,
   )
 }

package/src/sources/HyperSyncClient.res.mjs

@@ -73,8 +73,8 @@ let Registration = {
 
 let EventItems = {};
 
-function makeWithAgent(cfg, userAgent, eventRegistrations) {
-  return Core.getAddon().EvmHyperSyncClient.new(cfg, userAgent, eventRegistrations);
+function makeWithAgent(cfg, userAgent, eventRegistrations, addressStore) {
+  return Core.getAddon().EvmHyperSyncClient.new(cfg, userAgent, eventRegistrations, addressStore);
 }
 
 let logLevelSchema = S$RescriptSchema.$$enum([
@@ -99,7 +99,7 @@ function logLevelToString(level) {
   }
 }
 
-function make(url, apiToken, httpReqTimeoutMillis, eventRegistrations, enableChecksumAddressesOpt, serializationFormat, enableQueryCaching, retryBaseMs, retryBackoffMs, retryCeilingMs, logLevelOpt) {
+function make(url, apiToken, httpReqTimeoutMillis, eventRegistrations, enableChecksumAddressesOpt, serializationFormat, enableQueryCaching, retryBaseMs, retryBackoffMs, retryCeilingMs, logLevelOpt, addressStore) {
   let enableChecksumAddresses = enableChecksumAddressesOpt !== undefined ? enableChecksumAddressesOpt : true;
   let logLevel = logLevelOpt !== undefined ? logLevelOpt : "info";
   let envioVersion = Utils.EnvioPackage.value.version;
@@ -115,7 +115,7 @@ function make(url, apiToken, httpReqTimeoutMillis, eventRegistrations, enableChe
     serializationFormat: serializationFormat,
     enableQueryCaching: enableQueryCaching,
     logLevel: logLevelToString(logLevel)
-  }, `hyperindex/` + envioVersion, eventRegistrations);
+  }, `hyperindex/` + envioVersion, eventRegistrations, addressStore);
 }
 
 export {