envio 3.3.0-alpha.8 → 3.3.0-rc.0

package/src/LogSelection.res.mjs

@@ -1,79 +1,28 @@
 // Generated by ReScript, PLEASE EDIT WITH CARE
 
 import * as Utils from "./Utils.res.mjs";
+import * as TopicFilter from "./TopicFilter.res.mjs";
 import * as Stdlib_Option from "@rescript/runtime/lib/es6/Stdlib_Option.js";
 import * as Stdlib_JsError from "@rescript/runtime/lib/es6/Stdlib_JsError.js";
 import * as Primitive_option from "@rescript/runtime/lib/es6/Primitive_option.js";
 import * as S$RescriptSchema from "rescript-schema/src/S.res.mjs";
 import * as Primitive_exceptions from "@rescript/runtime/lib/es6/Primitive_exceptions.js";
 
-let MissingRequiredTopic0 = /* @__PURE__ */Primitive_exceptions.create("LogSelection.MissingRequiredTopic0");
-
-function makeTopicSelection(topic0, topic1Opt, topic2Opt, topic3Opt) {
-  let topic1 = topic1Opt !== undefined ? topic1Opt : [];
-  let topic2 = topic2Opt !== undefined ? topic2Opt : [];
-  let topic3 = topic3Opt !== undefined ? topic3Opt : [];
-  if (Utils.$$Array.isEmpty(topic0)) {
-    return {
-      TAG: "Error",
-      _0: {
-        RE_EXN_ID: MissingRequiredTopic0
-      }
-    };
+function materializeTopicFilter(filter, addresses) {
+  if (filter.TAG === "Values") {
+    return filter._0;
   } else {
-    return {
-      TAG: "Ok",
-      _0: {
-        topic0: topic0,
-        topic1: topic1,
-        topic2: topic2,
-        topic3: topic3
-      }
-    };
+    return addresses.map(TopicFilter.fromAddress);
   }
 }
 
-function hasFilters(param) {
-  return Stdlib_Option.isSome([
-    param.topic1,
-    param.topic2,
-    param.topic3
-  ].find(topic => !Utils.$$Array.isEmpty(topic)));
-}
-
-function compressTopicSelections(topicSelections) {
-  let topic0sOfSelectionsWithoutFilters = [];
-  let selectionsWithFilters = [];
-  topicSelections.forEach(selection => {
-    if (hasFilters(selection)) {
-      selectionsWithFilters.push(selection);
-    } else {
-      selection.topic0.forEach(topic0 => {
-        topic0sOfSelectionsWithoutFilters.push(topic0);
-      });
-    }
-  });
-  if (topic0sOfSelectionsWithoutFilters.length === 0) {
-    return selectionsWithFilters;
-  }
-  let selectionWithoutFilters_topic1 = [];
-  let selectionWithoutFilters_topic2 = [];
-  let selectionWithoutFilters_topic3 = [];
-  let selectionWithoutFilters = {
-    topic0: topic0sOfSelectionsWithoutFilters,
-    topic1: selectionWithoutFilters_topic1,
-    topic2: selectionWithoutFilters_topic2,
-    topic3: selectionWithoutFilters_topic3
-  };
-  return [selectionWithoutFilters].concat(selectionsWithFilters);
-}
-
-function make(addresses, topicSelections) {
-  let topicSelections$1 = compressTopicSelections(topicSelections);
-  return {
-    addresses: addresses,
-    topicSelections: topicSelections$1
-  };
+function materializeTopicSelections(topicSelections, addresses) {
+  return topicSelections.map(param => ({
+    topic0: param.topic0,
+    topic1: materializeTopicFilter(param.topic1, addresses),
+    topic2: materializeTopicFilter(param.topic2, addresses),
+    topic3: materializeTopicFilter(param.topic3, addresses)
+  }));
 }
 
 let eventBlockRangeSchema = S$RescriptSchema.strict(S$RescriptSchema.object(s => ({
@@ -100,16 +49,7 @@ function extractStartBlock(where, onEventBlockFilterSchema, contractName) {
   }
 }
 
-function makeChainArg(contractName, chainId, addresses) {
-  let chainObj = {};
-  chainObj["id"] = chainId;
-  chainObj[contractName] = {
-    addresses: addresses
-  };
-  return chainObj;
-}
-
-function makeDetectionChainArg(contractName, chainId, getAddresses) {
+function makeChainArg(contractName, chainId, getAddresses) {
   let contractObj = Object.create(null);
   Object.defineProperty(contractObj, "addresses", {
     enumerable: true,
@@ -133,85 +73,78 @@ let makeAddressesProbe = (function (contractName) {
   return new Proxy([], {get: trap});
 });
 
-function extractAddressFilterGroupsOrThrow(result, probe, contractName) {
-  let groups = [];
-  let scanGroup = paramsObj => {
-    let names = [];
-    Utils.Dict.forEachWithKey(paramsObj, (value, key) => {
-      if (value === probe) {
-        names.push(key);
-        paramsObj[key] = [];
-        return;
-      }
-    });
-    if (!Utils.$$Array.isEmpty(names)) {
-      groups.push(names);
-      return;
-    }
-  };
-  if (typeof result === "object" && result !== null && !Array.isArray(result)) {
-    let match = result["params"];
-    if (match !== undefined) {
-      if (Array.isArray(match)) {
-        match.forEach(item => {
-          if (typeof item === "object" && item !== null && !Array.isArray(item)) {
-            return scanGroup(item);
-          }
-        });
-      } else {
-        switch (typeof match) {
-          case "object" :
-            scanGroup(match);
-            break;
-        }
-      }
-    }
-  }
-  if (Utils.$$Array.isEmpty(groups)) {
-    Stdlib_JsError.throwWithMessage(`Invalid where configuration for ` + contractName + `. The callback reads \`chain.` + contractName + `.addresses\` but doesn't use it as an indexed-param filter value. Use it directly, e.g. { params: { to: chain.` + contractName + `.addresses } }.`);
-  }
-  return groups;
-}
-
 let emptyTopics = [];
 
 function noopGetter(param) {
   return emptyTopics;
 }
 
-function parseEventFiltersOrThrow(eventFilters, sighash, params, contractName, probeChainId, onEventBlockFilterSchema, topic1Opt, topic2Opt, topic3Opt) {
+function parseWhereOrThrow(where, sighash, params, contractName, chainId, onEventBlockFilterSchema, topic1Opt, topic2Opt, topic3Opt) {
   let topic1 = topic1Opt !== undefined ? topic1Opt : noopGetter;
   let topic2 = topic2Opt !== undefined ? topic2Opt : noopGetter;
   let topic3 = topic3Opt !== undefined ? topic3Opt : noopGetter;
-  let filterByAddresses = {
+  let addressFilterParamGroups = [];
+  let readAddresses = {
     contents: false
   };
-  let addressFilterParamGroups = [];
-  let startBlock;
+  let addressesSentinel = makeAddressesProbe(contractName);
   let topic0 = [sighash];
+  let default_topic1 = {
+    TAG: "Values",
+    _0: emptyTopics
+  };
+  let default_topic2 = {
+    TAG: "Values",
+    _0: emptyTopics
+  };
+  let default_topic3 = {
+    TAG: "Values",
+    _0: emptyTopics
+  };
   let $$default = {
     topic0: topic0,
-    topic1: emptyTopics,
-    topic2: emptyTopics,
-    topic3: emptyTopics
+    topic1: default_topic1,
+    topic2: default_topic2,
+    topic3: default_topic3
   };
-  let paramsRecordToTopicSelection = paramsFilter => {
-    if (Utils.Dict.isEmpty(paramsFilter)) {
-      return $$default;
+  let topicFilterAt = (paramsFilter, index, getter) => {
+    let value = Stdlib_Option.flatMap(params[index], name => paramsFilter[name]);
+    if (value !== undefined && value === addressesSentinel) {
+      return {
+        TAG: "ContractAddresses",
+        contractName: contractName
+      };
     } else {
-      Utils.Dict.forEachWithKey(paramsFilter, (param, key) => {
-        if (!params.includes(key)) {
-          return Stdlib_JsError.throwWithMessage(`Invalid where configuration. The event doesn't have an indexed parameter "` + key + `" and can't use it for filtering`);
-        }
-      });
       return {
-        topic0: topic0,
-        topic1: topic1(paramsFilter),
-        topic2: topic2(paramsFilter),
-        topic3: topic3(paramsFilter)
+        TAG: "Values",
+        _0: getter(paramsFilter)
       };
     }
   };
+  let paramsRecordToTopicSelection = paramsFilter => {
+    if (Utils.Dict.isEmpty(paramsFilter)) {
+      return $$default;
+    }
+    let sentinelParamNames = [];
+    Utils.Dict.forEachWithKey(paramsFilter, (value, key) => {
+      if (!params.includes(key)) {
+        Stdlib_JsError.throwWithMessage(`Invalid where configuration. The event doesn't have an indexed parameter "` + key + `" and can't use it for filtering`);
+      }
+      if (value === addressesSentinel) {
+        sentinelParamNames.push(key);
+        return;
+      }
+    });
+    if (!Utils.$$Array.isEmpty(sentinelParamNames)) {
+      addressFilterParamGroups.push(sentinelParamNames);
+    }
+    return {
+      topic0: topic0,
+      topic1: topicFilterAt(paramsFilter, 0, topic1),
+      topic2: topicFilterAt(paramsFilter, 1, topic2),
+      topic3: topicFilterAt(paramsFilter, 2, topic3)
+    };
+  };
   let acceptedWhereKeys = [
     "params",
     "block"
@@ -258,73 +191,51 @@ function parseEventFiltersOrThrow(eventFilters, sighash, params, contractName, p
         return Stdlib_JsError.throwWithMessage("Invalid where configuration. Expected `params` to be an object or an array of objects");
     }
   };
-  let getEventFiltersOrThrow;
-  if (eventFilters !== undefined) {
-    if (typeof eventFilters === "function") {
-      let addressesProbe = makeAddressesProbe(contractName);
-      let chain = makeDetectionChainArg(contractName, probeChainId, () => {
-        filterByAddresses.contents = true;
-        return addressesProbe;
+  let match;
+  if (where !== undefined) {
+    let whereValue;
+    if (typeof where === "function") {
+      let chain = makeChainArg(contractName, chainId, () => {
+        readAddresses.contents = true;
+        return addressesSentinel;
       });
-      let probedResult = eventFilters({
+      whereValue = where({
         chain: chain
       });
-      if (filterByAddresses.contents) {
-        addressFilterParamGroups = extractAddressFilterGroupsOrThrow(probedResult, addressesProbe, contractName);
-      }
-      startBlock = extractStartBlock(probedResult, onEventBlockFilterSchema, contractName);
-      getEventFiltersOrThrow = filterByAddresses.contents ? chain => ({
-          TAG: "Dynamic",
-          _0: addresses => {
-            let chainArg = makeChainArg(contractName, chain, addresses);
-            return parse(eventFilters({
-              chain: chainArg
-            }));
-          }
-        }) : chain => {
-          let chainArg = makeDetectionChainArg(contractName, chain, () => Stdlib_JsError.throwWithMessage(`Invalid where configuration. Event callback for contract "` + contractName + `" read \`chain.` + contractName + `.addresses\` at runtime but the probe didn't detect the access on chainId ` + chain.toString() + `. Move the \`chain.` + contractName + `.addresses\` read above any \`chain.id\` branching so the probe picks up the dependency and switches to the dynamic fetch path.`));
-          return {
-            TAG: "Static",
-            _0: parse(eventFilters({
-              chain: chainArg
-            }))
-          };
-        };
     } else {
-      startBlock = extractStartBlock(eventFilters, onEventBlockFilterSchema, contractName);
-      let $$static = {
-        TAG: "Static",
-        _0: parse(eventFilters)
-      };
-      getEventFiltersOrThrow = param => $$static;
+      whereValue = where;
     }
+    let topicSelections = parse(whereValue);
+    if (readAddresses.contents && Utils.$$Array.isEmpty(addressFilterParamGroups)) {
+      Stdlib_JsError.throwWithMessage(`Invalid where configuration for ` + contractName + `. The callback reads \`chain.` + contractName + `.addresses\` but doesn't use it as an indexed-param filter value. Use it directly, e.g. { params: { to: chain.` + contractName + `.addresses } }.`);
+    }
+    match = [
+      topicSelections,
+      extractStartBlock(whereValue, onEventBlockFilterSchema, contractName)
+    ];
   } else {
-    let $$static$1 = {
-      TAG: "Static",
-      _0: [$$default]
-    };
-    getEventFiltersOrThrow = param => $$static$1;
+    match = [
+      [$$default],
+      undefined
+    ];
   }
   return {
-    getEventFiltersOrThrow: getEventFiltersOrThrow,
-    filterByAddresses: filterByAddresses.contents,
-    addressFilterParamGroups: addressFilterParamGroups,
-    startBlock: startBlock
+    resolvedWhere: {
+      topicSelections: match[0],
+      startBlock: match[1]
+    },
+    filterByAddresses: !Utils.$$Array.isEmpty(addressFilterParamGroups),
+    addressFilterParamGroups: addressFilterParamGroups
   };
 }
 
 export {
-  MissingRequiredTopic0,
-  makeTopicSelection,
-  hasFilters,
-  compressTopicSelections,
-  make,
+  materializeTopicFilter,
+  materializeTopicSelections,
   eventBlockRangeSchema,
   extractStartBlock,
   makeChainArg,
-  makeDetectionChainArg,
   makeAddressesProbe,
-  extractAddressFilterGroupsOrThrow,
-  parseEventFiltersOrThrow,
+  parseWhereOrThrow,
 }
 /* eventBlockRangeSchema Not a pure module */

package/src/Main.res

@@ -39,40 +39,24 @@ let stateSchema = S.union([
   })),
 ])
 
-// Shape of the user-returned `{_gte?, _lte?, _every?}` filter chunk after
-// the ecosystem-specific wrapper is stripped. Shared across all ecosystems —
-// the outer `block.number` / `block.height` / `slot` unwrap lives on each
-// ecosystem's `onBlockFilterSchema`, and the inner range fields are the
-// same everywhere.
-type blockRange = {
-  _gte: option<int>,
-  _lte: option<int>,
-  _every: int,
-}
-
-// `S.strict` rejects unknown fields so typos like `_gt` / `_evry` surface
-// with a readable schema error pointing at the offending key, instead of
-// silently registering a broken filter. `_every` defaults to 1 inside the
-// schema so the caller always sees a plain `int`, and `intMin(1)` rejects
-// zero/negative strides — `(blockNumber - startBlock) % 0` would crash and
-// any negative stride would never match.
-let blockRangeSchema: S.t<blockRange> = S.object(s => {
-  _gte: s.field("_gte", S.option(S.int)),
-  _lte: s.field("_lte", S.option(S.int)),
-  _every: s.field("_every", S.option(S.int->S.intMin(1))->S.Option.getOr(1)),
-})->S.strict
-
-let defaultBlockRange: blockRange = {_gte: None, _lte: None, _every: 1}
-
-let indexerStateRef: ref<option<IndexerState.t>> = ref(None)
+// Runtime state lives in the process-wide `EnvioGlobal` record (shared
+// across duplicate envio module instances); the slots are opaque there, so
+// cast them to the real types here.
+let getIndexerState = () =>
+  EnvioGlobal.value.indexerState->(Utils.magic: option<unknown> => option<IndexerState.t>)
+let setIndexerState = (state: IndexerState.t) =>
+  EnvioGlobal.value.indexerState = Some(state->(Utils.magic: IndexerState.t => unknown))
 
 // Persistence is set by Main.start before handler modules load, so that
 // the exported indexer value can lazily expose DB state (startBlock,
 // endBlock, isRealtime, dynamic contract addresses) once it's ready.
-let globalPersistenceRef: ref<option<Persistence.t>> = ref(None)
+let getGlobalPersistence = () =>
+  EnvioGlobal.value.persistence->(Utils.magic: option<unknown> => option<Persistence.t>)
+let setGlobalPersistence = (persistence: Persistence.t) =>
+  EnvioGlobal.value.persistence = Some(persistence->(Utils.magic: Persistence.t => unknown))
 
 let getInitialChainState = (~chainId: int): option<Persistence.initialChainState> => {
-  switch globalPersistenceRef.contents {
+  switch getGlobalPersistence() {
   | Some(persistence) =>
     switch persistence.storageStatus {
     | Ready(initialState) => initialState.chains->Array.find(c => c.id === chainId)
@@ -130,7 +114,7 @@ let buildChainsObject = (~config: Config.t) => {
       {
         enumerable: true,
         get: () => {
-          switch indexerStateRef.contents {
+          switch getIndexerState() {
           | Some(state) => state->IndexerState.isRealtime
           // Before the global state is available (eg during handler
           // module load after resume), derive from persistence: every chain
@@ -164,7 +148,7 @@ let buildChainsObject = (~config: Config.t) => {
         {
           enumerable: true,
           get: () => {
-            switch indexerStateRef.contents {
+            switch getIndexerState() {
             | Some(state) => {
                 let chain = ChainMap.Chain.makeUnsafe(~chainId=chainConfig.id)
                 let chainState = state->IndexerState.getChainState(~chain)
@@ -345,121 +329,24 @@ let getGlobalIndexer = (): 'indexer => {
     let _ = RollbackCommit.register(callback->(Utils.magic: 'a => RollbackCommit.callback))
   }
 
-  // Two-stage parse: first the ecosystem-specific outer schema unwraps the
-  // wrapper (`block.number` / `block.height` / `slot`) and surfaces the
-  // inner chunk as raw `unknown`; then the shared `blockRangeSchema`
-  // validates the `{_gte?, _lte?, _every?}` fields. Keeping the inner
-  // validation in one place means typos and shape mismatches surface with
-  // the same user-friendly error regardless of ecosystem.
-  let extractRange = (filter: unknown, ~name, ~ecosystem: Ecosystem.t): blockRange =>
-    try {
-      switch filter->S.parseOrThrow(ecosystem.onBlockFilterSchema) {
-      | None => defaultBlockRange
-      | Some(inner) => inner->S.parseOrThrow(blockRangeSchema)
-      }
-    } catch {
-    | S.Raised(exn) =>
-      JsError.throwWithMessage(
-        `\`indexer.${ecosystem.onBlockMethodName}("${name}")\` \`where\` returned an invalid filter: ${exn
-          ->Utils.prettifyExn
-          ->(Utils.magic: exn => string)}`,
-      )
-    }
-
-  // `where` is evaluated once per configured chain at registration time.
-  // Decoded ranges/stride feed directly into `HandlerRegister.registerOnBlock`
-  // so the fetcher's `(blockNumber - handlerStartBlock) % interval === 0`
-  // math at `FetchState.res:619` stays untouched.
   let onBlockFn = (rawOptions: 'a, handler: 'b) => {
     HandlerRegister.throwIfFinishedRegistration(~methodName="onBlock")
-    let config = Config.load()
-    let ecosystem = config.ecosystem
     let raw =
       rawOptions->(
         Utils.magic: 'a => {
           "name": string,
-          "where": option<Envio.onBlockWhereArgs<unknown> => unknown>,
+          "where": unknown,
         }
       )
-    let typedHandler = handler->(Utils.magic: 'b => Internal.onBlockArgs => promise<unit>)
-    let (chains, _) = buildChainsObject(~config)
-    let chainsDict = chains->(Utils.magic: {..} => dict<unknown>)
-    let name = raw["name"]
-    let logger = Logging.createChild(~params={"onBlock": name})
-
-    // `where` must be a function (unlike onEvent, which also accepts a static
-    // value). A static value would have to be evaluated against every chain
-    // independently, which has no useful semantic for block handlers.
-    // Normalize undefined/null to None up front so the per-chain loop below
-    // can't accidentally call `null` as a predicate (ReScript treats a JS
-    // `null` value as `Some(null)` when the field is typed as option).
-    let where = switch raw["where"]->(Utils.magic: option<'a> => unknown) {
-    | w if w === %raw(`undefined`) || w === %raw(`null`) => None
-    | w if typeof(w) === #function => Some(raw["where"]->Option.getUnsafe)
-    | w =>
-      JsError.throwWithMessage(
-        `\`indexer.${ecosystem.onBlockMethodName}("${name}")\` expected \`where\` to be a function or omitted, but got ${(typeof(
-            w,
-          ) :> string)}.`,
-      )
-    }
-
-    let matchedAny = ref(false)
-
-    config.chainMap
-    ->ChainMap.values
-    ->Array.forEach(chainConfig => {
-      let chainId = chainConfig.id
-      let chainObj = chainsDict->Dict.getUnsafe(chainId->Int.toString)
-
-      // Predicate returns `true` → match with no filter; `false` → skip;
-      // any plain object → structured filter. `undefined`/`null` returns
-      // are rejected — the TS type excludes `void`, so a missing return is
-      // a user bug we surface early rather than silently match-all.
-      let result = switch where {
-      | None => %raw(`true`)
-      | Some(predicate) => predicate({chain: chainObj})
-      }
-
-      let (shouldRegister, range) = if result === %raw(`true`) {
-        (true, defaultBlockRange)
-      } else if result === %raw(`false`) {
-        (false, defaultBlockRange)
-      } else if typeof(result) === #object && !(result->Array.isArray) && result !== %raw(`null`) {
-        (true, extractRange(result, ~name, ~ecosystem))
-      } else {
-        // Reject numbers, strings, functions, arrays, undefined, null —
-        // anything that isn't bool or a plain object would silently
-        // misregister.
-        JsError.throwWithMessage(
-          `\`indexer.${ecosystem.onBlockMethodName}("${name}")\` \`where\` predicate returned an invalid value of type ${(typeof(
-              result,
-            ) :> string)}. Expected boolean or a filter object.`,
-        )
-      }
-
-      if shouldRegister {
-        matchedAny := true
-        HandlerRegister.registerOnBlock(
-          ~name,
-          ~chainId,
-          ~interval=range._every,
-          ~startBlock=range._gte,
-          ~endBlock=range._lte,
-          ~handler=typedHandler,
-        )
-      }
-    })
-
-    // Catches misconfigured `where` predicates that return `false` for every
-    // configured chain — the handler would otherwise never fire with no hint.
-    // Includes the ecosystem-specific method name so SVM users see "onSlot"
-    // and don't get confused looking for a "Block handler" they never wrote.
-    if !matchedAny.contents {
-      logger->Logging.childWarn(
-        `\`indexer.${ecosystem.onBlockMethodName}\` matched 0 chains. Check the \`where\` predicate.`,
-      )
-    }
+    HandlerRegister.registerOnBlock(
+      ~name=raw["name"],
+      ~where=raw["where"],
+      ~handler=handler->(Utils.magic: 'b => Internal.onBlockArgs => promise<unit>),
+      ~getChainsObject=config => {
+        let (chains, _) = buildChainsObject(~config)
+        chains->(Utils.magic: {..} => dict<unknown>)
+      },
+    )
   }
 
   // Ecosystem-specific surface: EVM/Fuel expose event + block handlers; SVM
@@ -506,8 +393,7 @@ let getGlobalIndexer = (): 'indexer => {
   let get = (~prop: string) =>
     switch prop {
     | "name" => Config.load().name->(Utils.magic: string => unknown)
-    | "description" =>
-      Config.load().description->(Utils.magic: option<string> => unknown)
+    | "description" => Config.load().description->(Utils.magic: option<string> => unknown)
     | "chainIds" => {
         let (_, chainIds) = buildChainsObject(~config=Config.load())
         chainIds->(Utils.magic: array<int> => unknown)
@@ -616,7 +502,7 @@ let startServer = (~getState, ~persistence: Persistence.t, ~isDevelopmentMode: b
   app->get("/metrics", (_req, res) => {
     res->set("Content-Type", PromClient.defaultRegister->PromClient.getContentType)
     let _ =
-      Metrics.collect(~state=indexerStateRef.contents)->Promise.thenResolve(metrics =>
+      Metrics.collect(~state=getIndexerState())->Promise.thenResolve(metrics =>
         res->endWithData(metrics)
       )
   })
@@ -709,7 +595,7 @@ let start = async (
   | Some(p) => p
   | None => PgStorage.makePersistenceFromConfig(~config)
   }
-  globalPersistenceRef := Some(persistence)
+  setGlobalPersistence(persistence)
   await persistence->Persistence.init(
     ~reset,
     ~chainConfigs=config.chainMap->ChainMap.values,
@@ -756,7 +642,7 @@ let start = async (
 
   if !isTest {
     startServer(~persistence, ~isDevelopmentMode, ~getState=() =>
-      switch indexerStateRef.contents {
+      switch getIndexerState() {
       | None => Initializing({})
       | Some(state) => {
           let chains =
@@ -786,7 +672,7 @@ let start = async (
   if shouldUseTui {
     let _rerender = Tui.start(~getState=() => state)
   }
-  indexerStateRef := Some(state)
+  setIndexerState(state)
   state->IndexerLoop.start
   await runUntilFatalError
 }