envio 3.6.1 → 3.7.0-subgraph

package/src/sources/HyperSync.res.mjs

@@ -1,62 +1,89 @@
 // Generated by ReScript, PLEASE EDIT WITH CARE
 
-import * as Time from "../Time.res.mjs";
-import * as Utils from "../Utils.res.mjs";
 import * as Source from "./Source.res.mjs";
-import * as Logging from "../Logging.res.mjs";
 import * as Stdlib_Int from "@rescript/runtime/lib/es6/Stdlib_Int.js";
-import * as Performance from "../bindings/Performance.res.mjs";
 import * as Stdlib_JSON from "@rescript/runtime/lib/es6/Stdlib_JSON.js";
 import * as Stdlib_Array from "@rescript/runtime/lib/es6/Stdlib_Array.js";
 import * as Stdlib_JsExn from "@rescript/runtime/lib/es6/Stdlib_JsExn.js";
 import * as Stdlib_Option from "@rescript/runtime/lib/es6/Stdlib_Option.js";
-import * as Stdlib_Result from "@rescript/runtime/lib/es6/Stdlib_Result.js";
-import * as Stdlib_JsError from "@rescript/runtime/lib/es6/Stdlib_JsError.js";
 import * as Primitive_exceptions from "@rescript/runtime/lib/es6/Primitive_exceptions.js";
 
-function reraisIfRateLimited(exn) {
-  let e = Primitive_exceptions.internalToException(exn);
-  if (e.RE_EXN_ID !== "JsExn") {
-    return;
-  }
-  let msg = Stdlib_JsExn.message(e._1);
-  if (msg === undefined) {
-    return;
-  }
-  if (!msg.startsWith("RATE_LIMITED:")) {
-    return;
-  }
-  let resetMs = Stdlib_Option.getOr(Stdlib_Int.fromString(msg.slice(13, msg.length), undefined), 1000);
-  throw {
-    RE_EXN_ID: Source.RateLimited,
-    resetMs: resetMs,
-    Error: new Error()
-  };
-}
+let rateLimitedPrefix = "RATE_LIMITED:";
 
-let HyperSyncQueryError = /* @__PURE__ */Primitive_exceptions.create("HyperSync.HyperSyncQueryError");
+let behindHeadPrefix = "SOURCE_BEHIND_HEAD:";
 
-function queryErrorToMsq(e) {
-  let match = e._0;
-  return match.queryName + ` query failed due to unexpected missing params on response:
-      ` + match.missingParams.join(", ");
+function markerValue(msg, prefix) {
+  return Stdlib_Int.fromString(msg.slice(prefix.length, msg.length), undefined);
 }
 
-function mapExn(queryResponse) {
-  if (queryResponse.TAG === "Ok") {
-    return {
-      TAG: "Ok",
-      _0: queryResponse._0
-    };
+function mapNativeFailure(failure) {
+  let msg = failure.message;
+  if (msg !== undefined) {
+    if (msg.startsWith(rateLimitedPrefix)) {
+      return {
+        RE_EXN_ID: Source.RateLimited,
+        _1: {
+          resetMs: Stdlib_Option.getOr(markerValue(msg, rateLimitedPrefix), 1000),
+          requestStats: failure.requestStats
+        }
+      };
+    } else if (msg.startsWith(behindHeadPrefix)) {
+      return {
+        RE_EXN_ID: Source.SourceBehindHead,
+        blockNumber: Stdlib_Option.getOr(markerValue(msg, behindHeadPrefix), 0),
+        requestStats: failure.requestStats
+      };
+    } else {
+      return failure.cause;
+    }
   } else {
+    return failure.cause;
+  }
+}
+
+function mapNativeFailureExn(exn) {
+  return mapNativeFailure(Source.unpackNativeRequestFailure(exn));
+}
+
+function makeGetBlockHashes(query) {
+  return async (blockNumbers, param) => {
+    let match;
+    try {
+      let match$1 = await query(blockNumbers);
+      match = [
+        {
+          TAG: "Ok",
+          _0: match$1[0]
+        },
+        match$1[1]
+      ];
+    } catch (raw_exn) {
+      let exn = Primitive_exceptions.internalToException(raw_exn);
+      let failure = Source.unpackNativeRequestFailure(exn);
+      match = [
+        {
+          TAG: "Error",
+          _0: mapNativeFailure(failure)
+        },
+        failure.requestStats
+      ];
+    }
     return {
-      TAG: "Error",
-      _0: {
-        RE_EXN_ID: HyperSyncQueryError,
-        _1: queryResponse._0
-      }
+      result: match[0],
+      requestStats: match[1]
     };
+  };
+}
+
+function reraiseIfRecoverable(exn) {
+  let exn$1 = mapNativeFailure(Source.unpackNativeRequestFailure(exn));
+  if (exn$1.RE_EXN_ID === Source.RateLimited) {
+    throw exn$1;
+  }
+  if (exn$1.RE_EXN_ID !== Source.SourceBehindHead) {
+    return;
   }
+  throw exn$1;
 }
 
 let $$Error = /* @__PURE__ */Primitive_exceptions.create("HyperSync.GetLogs.Error");
@@ -95,7 +122,7 @@ async function query(client, fromBlock, toBlock, maxNumLogs, registrationIndexes
     match = await client.getEventItems(query$1, addressSet);
   } catch (raw_exn) {
     let exn = Primitive_exceptions.internalToException(raw_exn);
-    reraisIfRateLimited(exn);
+    reraiseIfRecoverable(exn);
     let missingParams = extractMissingParams(exn);
     if (missingParams !== undefined) {
       throw {
@@ -119,10 +146,8 @@ async function query(client, fromBlock, toBlock, maxNumLogs, registrationIndexes
   }
   return {
     items: res.items,
-    blocks: res.blocks,
     nextBlock: res.nextBlock,
     archiveHeight: Stdlib_Option.getOr(res.archiveHeight, 0),
-    rollbackGuard: res.rollbackGuard,
     transactionStore: match[1],
     blockStore: match[2]
   };
@@ -134,153 +159,11 @@ let GetLogs = {
   query: query
 };
 
-function makeRequestBody(fromBlock, toBlock) {
-  return {
-    fromBlock: fromBlock,
-    toBlock: toBlock + 1 | 0,
-    fieldSelection: {
-      block: [
-        "Number",
-        "Hash",
-        "Timestamp"
-      ]
-    },
-    includeAllBlocks: true
-  };
-}
-
-function convertResponse(res) {
-  return Utils.$$Array.transposeResults(res.data.blocks.map(block => {
-    let blockNumber = block.number;
-    if (blockNumber !== undefined) {
-      let blockHash = block.hash;
-      if (blockHash !== undefined) {
-        let blockTimestamp = block.timestamp;
-        if (blockTimestamp !== undefined) {
-          return {
-            TAG: "Ok",
-            _0: {
-              blockHash: blockHash,
-              blockNumber: blockNumber,
-              blockTimestamp: blockTimestamp
-            }
-          };
-        }
-      }
-    }
-    let missingParams = Stdlib_Array.filterMap([
-      Utils.Option.mapNone(block.number, "block.number"),
-      Utils.Option.mapNone(block.timestamp, "block.timestamp"),
-      Utils.Option.mapNone(block.hash, "block.hash")
-    ], p => p);
-    return {
-      TAG: "Error",
-      _0: {
-        TAG: "UnexpectedMissingParams",
-        _0: {
-          queryName: "query block data HyperSync",
-          missingParams: missingParams
-        }
-      }
-    };
-  }));
-}
-
-async function queryBlockData(client, fromBlock, toBlock, sourceName, chainId, logger, requestStats) {
-  let body = makeRequestBody(fromBlock, toBlock);
-  let logger$1 = Logging.createChildFrom(logger, {
-    logType: "HyperSync get block hash query",
-    fromBlock: fromBlock,
-    toBlock: toBlock
-  });
-  let timerRef = Performance.now();
-  let maybeSuccessfulRes;
-  let exit = 0;
-  let res;
-  try {
-    res = await client.get(body);
-    exit = 1;
-  } catch (raw_exn) {
-    let exn = Primitive_exceptions.internalToException(raw_exn);
-    reraisIfRateLimited(exn);
-    maybeSuccessfulRes = undefined;
-  }
-  if (exit === 1) {
-    maybeSuccessfulRes = res.nextBlock <= fromBlock ? undefined : res;
-  }
-  requestStats.push({
-    method: "getBlockHashes",
-    seconds: Performance.secondsSince(timerRef)
-  });
-  if (maybeSuccessfulRes !== undefined) {
-    let err = convertResponse(maybeSuccessfulRes);
-    if (err.TAG !== "Ok") {
-      return err;
-    }
-    if (maybeSuccessfulRes.nextBlock > toBlock) {
-      return err;
-    }
-    let datas = err._0;
-    let restRes = await queryBlockData(client, maybeSuccessfulRes.nextBlock, toBlock, sourceName, chainId, logger$1, requestStats);
-    return Stdlib_Result.map(restRes, rest => datas.concat(rest));
-  }
-  Logging.childInfo(logger$1, `Block #` + fromBlock.toString() + ` not found in HyperSync. HyperSync has multiple instances and it's possible that they drift independently slightly from the head. Indexing should continue correctly after retrying the query in ` + (100).toString() + `ms.`);
-  await Time.resolvePromiseAfterDelay(100);
-  return await queryBlockData(client, fromBlock, toBlock, sourceName, chainId, logger$1, requestStats);
-}
-
-async function queryBlockDataMulti(client, blockNumbers, sourceName, chainId, logger) {
-  let requestStats = [];
-  let firstBlock = blockNumbers[0];
-  let result;
-  if (firstBlock !== undefined) {
-    let fromBlock = firstBlock;
-    let toBlock = firstBlock;
-    let set = new Set();
-    for (let idx = 0, idx_finish = blockNumbers.length; idx < idx_finish; ++idx) {
-      let blockNumber = blockNumbers[idx];
-      if (blockNumber < fromBlock) {
-        fromBlock = blockNumber;
-      }
-      if (blockNumber > toBlock) {
-        toBlock = blockNumber;
-      }
-      set.add(blockNumber);
-    }
-    if ((toBlock - fromBlock | 0) > 1000) {
-      Stdlib_JsError.throwWithMessage(`Invalid block data request. Range of block numbers is too large. Max range is 1000. Requested range: ` + fromBlock.toString() + `-` + toBlock.toString());
-    }
-    let res = await queryBlockData(client, fromBlock, toBlock, sourceName, chainId, logger, requestStats);
-    let filtered = Stdlib_Result.map(res, datas => datas.filter(data => set.delete(data.blockNumber)));
-    if (set.size > 0) {
-      Stdlib_JsError.throwWithMessage(`Invalid response. Failed to get block data for block numbers: ` + Array.from(set).join(", "));
-    }
-    result = filtered;
-  } else {
-    result = {
-      TAG: "Ok",
-      _0: []
-    };
-  }
-  return [
-    result,
-    requestStats
-  ];
-}
-
-function queryBlockData$1(client, blockNumber, sourceName, chainId, logger) {
-  let requestStats = [];
-  return queryBlockData(client, blockNumber, blockNumber, sourceName, chainId, logger, requestStats).then(res => [
-    Stdlib_Result.map(res, res => res[0]),
-    requestStats
-  ]);
-}
-
 export {
-  queryErrorToMsq,
+  mapNativeFailure,
+  mapNativeFailureExn,
+  reraiseIfRecoverable,
+  makeGetBlockHashes,
   GetLogs,
-  queryBlockData$1 as queryBlockData,
-  queryBlockDataMulti,
-  mapExn,
 }
-/* Time Not a pure module */
+/* Source Not a pure module */

package/src/sources/HyperSync.resi

@@ -1,23 +1,23 @@
 type logsQueryPage = {
   items: array<HyperSyncClient.EventItems.item>,
-  blocks: array<HyperSyncClient.EventItems.blockHeader>,
   nextBlock: int,
   archiveHeight: int,
-  rollbackGuard: option<HyperSyncClient.ResponseTypes.rollbackGuard>,
   transactionStore: TransactionStore.t,
   blockStore: BlockStore.t,
 }
 
-type missingParams = {
-  queryName: string,
-  missingParams: array<string>,
-}
-
-type queryError = UnexpectedMissingParams(missingParams)
-
-let queryErrorToMsq: queryError => string
+// Map a native client's `PREFIX:<int>` failure marker onto the exception
+// SourceManager retries on (`RateLimited` / `SourceBehindHead`), falling back to
+// the original cause.
+let mapNativeFailure: Source.nativeRequestFailure => exn
+let mapNativeFailureExn: exn => exn
+let reraiseIfRecoverable: exn => unit
 
-type queryResponse<'a> = result<'a, queryError>
+// Wrap a native client's paginated block-hash query as a `Source.getBlockHashes`,
+// keeping the request timings whether it succeeds or fails.
+let makeGetBlockHashes: (
+  ~query: (~blockNumbers: array<int>) => promise<(BlockStore.t, array<Source.requestStat>)>,
+) => (~blockNumbers: array<int>, ~logger: Pino.t) => promise<Source.getBlockHashesResponse>
 
 module GetLogs: {
   type error =
@@ -38,27 +38,3 @@ module GetLogs: {
     ~clientFilteredContracts: option<array<string>>,
   ) => promise<logsQueryPage>
 }
-
-let queryBlockData: (
-  ~client: HyperSyncClient.t,
-  ~blockNumber: int,
-  ~sourceName: string,
-  ~chainId: ChainId.t,
-  ~logger: Pino.t,
-) => promise<(
-  queryResponse<option<ReorgDetection.blockDataWithTimestamp>>,
-  array<Source.requestStat>,
-)>
-
-let queryBlockDataMulti: (
-  ~client: HyperSyncClient.t,
-  ~blockNumbers: array<int>,
-  ~sourceName: string,
-  ~chainId: ChainId.t,
-  ~logger: Pino.t,
-) => promise<(
-  queryResponse<array<ReorgDetection.blockDataWithTimestamp>>,
-  array<Source.requestStat>,
-)>
-
-let mapExn: queryResponse<'a> => result<'a, exn>

package/src/sources/HyperSyncClient.res

@@ -15,7 +15,6 @@ type cfg = {
   /** Milliseconds to wait for a response before timing out. Default: 30000. */
   httpReqTimeoutMillis?: int,
   /** Number of retries to attempt before returning error. Default: 12. */
-  maxNumRetries?: int,
   /** Milliseconds that would be used for retry backoff increasing. Default: 500. */
   retryBackoffMs?: int,
   /** Initial wait time for request backoff. Default: 200. */
@@ -169,66 +168,8 @@ module QueryTypes = {
   }
 }
 
-module ResponseTypes = {
-  type withdrawal = {
-    index?: string,
-    validatorIndex?: string,
-    address?: Address.t,
-    amount?: string,
-  }
-
-  type block = {
-    number?: int,
-    hash?: string,
-    parentHash?: string,
-    nonce?: bigint,
-    sha3Uncles?: string,
-    logsBloom?: string,
-    transactionsRoot?: string,
-    stateRoot?: string,
-    receiptsRoot?: string,
-    miner?: Address.t,
-    difficulty?: bigint,
-    totalDifficulty?: bigint,
-    extraData?: string,
-    size?: bigint,
-    gasLimit?: bigint,
-    gasUsed?: bigint,
-    timestamp?: int,
-    uncles?: array<string>,
-    baseFeePerGas?: bigint,
-    blobGasUsed?: bigint,
-    excessBlobGas?: bigint,
-    parentBeaconBlockRoot?: string,
-    withdrawalsRoot?: string,
-    withdrawals?: array<withdrawal>,
-    l1BlockNumber?: int,
-    sendCount?: string,
-    sendRoot?: string,
-    mixHash?: string,
-  }
-
-  type rollbackGuard = {
-    blockNumber: int,
-    timestamp: int,
-    hash: string,
-    firstBlockNumber: int,
-    firstParentHash: string,
-  }
-}
-
 type query = QueryTypes.query
 
-type queryResponseData = {blocks: array<ResponseTypes.block>}
-
-type queryResponse = {
-  archiveHeight: option<int>,
-  nextBlock: int,
-  totalExecutionTime: int,
-  data: queryResponseData,
-  rollbackGuard: option<ResponseTypes.rollbackGuard>,
-}
-
 module Registration = {
   // One topic position of the resolved `where`: static topic values, or
   // `None` — the "currently registered addresses of this contract" marker,
@@ -295,12 +236,12 @@ module Registration = {
         }),
         // Capitalized to match the Rust BlockField/TransactionField string
         // enums.
-        blockFields: event.selectedBlockFields
+        blockFields: reg.fieldSelection.blockFields
         ->Utils.Set.toArray
-        ->Array.map(name => (name :> string)->Utils.String.capitalize),
-        transactionFields: event.selectedTransactionFields
+        ->Array.map(Utils.String.capitalize),
+        transactionFields: reg.fieldSelection.transactionFields
         ->Utils.Set.toArray
-        ->Array.map(name => (name :> string)->Utils.String.capitalize),
+        ->Array.map(Utils.String.capitalize),
       }
     })
   }
@@ -338,28 +279,19 @@ module EventItems = {
     params: Internal.eventParams,
   }
 
-  // The always-needed block fields, one per block number. The block's remaining
-  // fields live raw in the block store and are materialised on demand.
-  type blockHeader = {
-    number: int,
-    timestamp: int,
-    hash: string,
-  }
-
   type response = {
     archiveHeight: option<int>,
     nextBlock: int,
-    // 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>,
   }
 }
 
 type t = {
-  get: (~query: query) => promise<queryResponse>,
+  // Block-hash query construction and pagination live in Rust; only the
+  // aggregate response store crosses the boundary.
+  getBlockHashes: (
+    ~blockNumbers: array<int>,
+  ) => promise<(BlockStore.t, array<RequestStat.t>)>,
   // Returns the response plus page stores owning this page's raw transactions
   // and blocks.
   getEventItems: (
@@ -414,8 +346,6 @@ let make = (
       enableChecksumAddresses,
       apiToken,
       httpReqTimeoutMillis,
-      // Retries are handled internally by the indexer, not the binary client
-      maxNumRetries: 0,
       ?serializationFormat,
       ?enableQueryCaching,
       ?retryBaseMs,

package/src/sources/HyperSyncClient.res.mjs

@@ -34,8 +34,6 @@ let QueryTypes = {
   makeLogSelection: makeLogSelection
 };
 
-let ResponseTypes = {};
-
 function toTopicFilterInput(filter) {
   if (filter.TAG === "Values") {
     return filter._0;
@@ -61,8 +59,8 @@ function fromOnEventRegistrations(onEventRegistrations) {
         topic2: toTopicFilterInput(ts.topic2),
         topic3: toTopicFilterInput(ts.topic3)
       })),
-      blockFields: Array.from(event.selectedBlockFields).map(name => Utils.$$String.capitalize(name)),
-      transactionFields: Array.from(event.selectedTransactionFields).map(name => Utils.$$String.capitalize(name))
+      blockFields: Array.from(reg.fieldSelection.blockFields).map(Utils.$$String.capitalize),
+      transactionFields: Array.from(reg.fieldSelection.transactionFields).map(Utils.$$String.capitalize)
     };
   });
 }
@@ -108,7 +106,6 @@ function make(url, apiToken, httpReqTimeoutMillis, eventRegistrations, enableChe
     url: url,
     apiToken: apiToken,
     httpReqTimeoutMillis: httpReqTimeoutMillis,
-    maxNumRetries: 0,
     retryBackoffMs: retryBackoffMs,
     retryBaseMs: retryBaseMs,
     retryCeilingMs: retryCeilingMs,
@@ -122,7 +119,6 @@ function make(url, apiToken, httpReqTimeoutMillis, eventRegistrations, enableChe
 export {
   serializationFormatSchema,
   QueryTypes,
-  ResponseTypes,
   Registration,
   EventItems,
   makeWithAgent,

package/src/sources/RequestStat.res

@@ -0,0 +1,5 @@
+// A single backend request a source method made, with the time it took. Kept
+// in its own leaf module (rather than on `Source`) so the client FFI bindings
+// can name it without importing `Source` — which would form a dependency cycle
+// through `Env → HyperSyncClient → Source → FetchState → Env`.
+type t = {method: string, seconds: float}

package/src/sources/RequestStat.res.mjs

@@ -0,0 +1,2 @@
+// Generated by ReScript, PLEASE EDIT WITH CARE
+/* This output is empty. Its source's type definitions, externals and/or unused code got optimized away. */