envio 3.2.1 → 3.3.0-alpha.1

package/src/db/InternalTable.res

@@ -571,33 +571,20 @@ GROUP BY "${(#chain_id: field :> string)}";`
 }
 
 module RawEvents = {
-  type t = {
-    @as("chain_id") chainId: int,
-    @as("event_id") eventId: bigint,
-    @as("event_name") eventName: string,
-    @as("contract_name") contractName: string,
-    @as("block_number") blockNumber: int,
-    @as("log_index") logIndex: int,
-    @as("src_address") srcAddress: Address.t,
-    @as("block_hash") blockHash: string,
-    @as("block_timestamp") blockTimestamp: int,
-    @as("block_fields") blockFields: JSON.t,
-    @as("transaction_fields") transactionFields: JSON.t,
-    params: JSON.t,
-  }
-
-  let schema = S.schema(s => {
-    chainId: s.matches(S.int),
-    eventId: s.matches(S.bigint),
-    eventName: s.matches(S.string),
-    contractName: s.matches(S.string),
-    blockNumber: s.matches(S.int),
-    logIndex: s.matches(S.int),
-    srcAddress: s.matches(Address.schema),
-    blockHash: s.matches(S.string),
-    blockTimestamp: s.matches(S.int),
-    blockFields: s.matches(S.json(~validate=false)),
-    transactionFields: s.matches(S.json(~validate=false)),
+  type t = Internal.rawEvent
+
+  let schema = S.schema((s): t => {
+    chain_id: s.matches(S.int),
+    event_id: s.matches(S.bigint),
+    event_name: s.matches(S.string),
+    contract_name: s.matches(S.string),
+    block_number: s.matches(S.int),
+    log_index: s.matches(S.int),
+    src_address: s.matches(Address.schema),
+    block_hash: s.matches(S.string),
+    block_timestamp: s.matches(S.int),
+    block_fields: s.matches(S.json(~validate=false)),
+    transaction_fields: s.matches(S.json(~validate=false)),
     params: s.matches(S.json(~validate=false)),
   })
 

package/src/sources/Evm.res

@@ -1,10 +1,25 @@
+// EVM's concrete item payload. Erased to `Internal.eventPayload` on the item
+// and recovered here via `toPayload`.
+type payload = {
+  contractName: string,
+  eventName: string,
+  params: Internal.eventParams,
+  chainId: int,
+  srcAddress: Address.t,
+  logIndex: int,
+  transaction: Internal.eventTransaction,
+  block: Internal.eventBlock,
+}
+external fromPayload: payload => Internal.eventPayload = "%identity"
+external toPayload: Internal.eventPayload => payload = "%identity"
+
 let cleanUpRawEventFieldsInPlace: JSON.t => unit = %raw(`fields => {
     delete fields.hash
     delete fields.number
     delete fields.timestamp
   }`)
 
-let ecosystem: Ecosystem.t = {
+let make = (~logger: Pino.t): Ecosystem.t => {
   name: Evm,
   blockFields: [
     "number",
@@ -90,4 +105,28 @@ let ecosystem: Ecosystem.t = {
   onEventBlockFilterSchema: S.object(s =>
     s.field("block", S.option(S.object(s2 => s2.field("number", S.unknown))))
   ),
+  logger,
+  toEvent: eventItem => eventItem.payload->Internal.payloadToEvent,
+  toEventLogger: eventItem =>
+    Logging.createChildFrom(
+      ~logger,
+      ~params={
+        "contract": eventItem.eventConfig.contractName,
+        "event": eventItem.eventConfig.name,
+        "chainId": eventItem.chain->ChainMap.Chain.toChainId,
+        "block": eventItem.blockNumber,
+        "logIndex": eventItem.logIndex,
+        "address": (eventItem.payload->toPayload).srcAddress,
+      },
+    ),
+  toRawEvent: eventItem => {
+    let payload = eventItem.payload->toPayload
+    eventItem->RawEvent.make(
+      ~block=payload.block,
+      ~transaction=payload.transaction,
+      ~params=payload.params,
+      ~srcAddress=payload.srcAddress,
+      ~cleanUpRawEventFieldsInPlace,
+    )
+  },
 }

package/src/sources/Evm.res.mjs

@@ -1,5 +1,7 @@
 // Generated by ReScript, PLEASE EDIT WITH CARE
 
+import * as Logging from "../Logging.res.mjs";
+import * as RawEvent from "../RawEvent.res.mjs";
 import * as S$RescriptSchema from "rescript-schema/src/S.res.mjs";
 
 let cleanUpRawEventFieldsInPlace = (fields => {
@@ -8,91 +10,99 @@ let cleanUpRawEventFieldsInPlace = (fields => {
     delete fields.timestamp
   });
 
-let ecosystem_blockFields = [
-  "number",
-  "timestamp",
-  "hash",
-  "parentHash",
-  "nonce",
-  "sha3Uncles",
-  "logsBloom",
-  "transactionsRoot",
-  "stateRoot",
-  "receiptsRoot",
-  "miner",
-  "difficulty",
-  "totalDifficulty",
-  "extraData",
-  "size",
-  "gasLimit",
-  "gasUsed",
-  "uncles",
-  "baseFeePerGas",
-  "blobGasUsed",
-  "excessBlobGas",
-  "parentBeaconBlockRoot",
-  "withdrawalsRoot",
-  "l1BlockNumber",
-  "sendCount",
-  "sendRoot",
-  "mixHash"
-];
-
-let ecosystem_transactionFields = [
-  "transactionIndex",
-  "hash",
-  "from",
-  "to",
-  "gas",
-  "gasPrice",
-  "maxPriorityFeePerGas",
-  "maxFeePerGas",
-  "cumulativeGasUsed",
-  "effectiveGasPrice",
-  "gasUsed",
-  "input",
-  "nonce",
-  "value",
-  "v",
-  "r",
-  "s",
-  "contractAddress",
-  "logsBloom",
-  "root",
-  "status",
-  "yParity",
-  "chainId",
-  "maxFeePerBlobGas",
-  "blobVersionedHashes",
-  "type",
-  "l1Fee",
-  "l1GasPrice",
-  "l1GasUsed",
-  "l1FeeScalar",
-  "gasUsedForL1",
-  "accessList",
-  "authorizationList"
-];
-
-let ecosystem_onBlockFilterSchema = S$RescriptSchema.object(s => s.f("block", S$RescriptSchema.option(S$RescriptSchema.object(s2 => s2.f("number", S$RescriptSchema.unknown)))));
-
-let ecosystem_onEventBlockFilterSchema = S$RescriptSchema.object(s => s.f("block", S$RescriptSchema.option(S$RescriptSchema.object(s2 => s2.f("number", S$RescriptSchema.unknown)))));
-
-let ecosystem = {
-  name: "evm",
-  blockFields: ecosystem_blockFields,
-  transactionFields: ecosystem_transactionFields,
-  blockNumberName: "number",
-  blockTimestampName: "timestamp",
-  blockHashName: "hash",
-  cleanUpRawEventFieldsInPlace: cleanUpRawEventFieldsInPlace,
-  onBlockMethodName: "onBlock",
-  onBlockFilterSchema: ecosystem_onBlockFilterSchema,
-  onEventBlockFilterSchema: ecosystem_onEventBlockFilterSchema
-};
+function make(logger) {
+  return {
+    name: "evm",
+    blockFields: [
+      "number",
+      "timestamp",
+      "hash",
+      "parentHash",
+      "nonce",
+      "sha3Uncles",
+      "logsBloom",
+      "transactionsRoot",
+      "stateRoot",
+      "receiptsRoot",
+      "miner",
+      "difficulty",
+      "totalDifficulty",
+      "extraData",
+      "size",
+      "gasLimit",
+      "gasUsed",
+      "uncles",
+      "baseFeePerGas",
+      "blobGasUsed",
+      "excessBlobGas",
+      "parentBeaconBlockRoot",
+      "withdrawalsRoot",
+      "l1BlockNumber",
+      "sendCount",
+      "sendRoot",
+      "mixHash"
+    ],
+    transactionFields: [
+      "transactionIndex",
+      "hash",
+      "from",
+      "to",
+      "gas",
+      "gasPrice",
+      "maxPriorityFeePerGas",
+      "maxFeePerGas",
+      "cumulativeGasUsed",
+      "effectiveGasPrice",
+      "gasUsed",
+      "input",
+      "nonce",
+      "value",
+      "v",
+      "r",
+      "s",
+      "contractAddress",
+      "logsBloom",
+      "root",
+      "status",
+      "yParity",
+      "chainId",
+      "maxFeePerBlobGas",
+      "blobVersionedHashes",
+      "type",
+      "l1Fee",
+      "l1GasPrice",
+      "l1GasUsed",
+      "l1FeeScalar",
+      "gasUsedForL1",
+      "accessList",
+      "authorizationList"
+    ],
+    blockNumberName: "number",
+    blockTimestampName: "timestamp",
+    blockHashName: "hash",
+    cleanUpRawEventFieldsInPlace: cleanUpRawEventFieldsInPlace,
+    onBlockMethodName: "onBlock",
+    onBlockFilterSchema: S$RescriptSchema.object(s => s.f("block", S$RescriptSchema.option(S$RescriptSchema.object(s2 => s2.f("number", S$RescriptSchema.unknown))))),
+    onEventBlockFilterSchema: S$RescriptSchema.object(s => s.f("block", S$RescriptSchema.option(S$RescriptSchema.object(s2 => s2.f("number", S$RescriptSchema.unknown))))),
+    logger: logger,
+    toEvent: eventItem => eventItem.payload,
+    toEventLogger: eventItem => Logging.createChildFrom(logger, {
+      contract: eventItem.eventConfig.contractName,
+      event: eventItem.eventConfig.name,
+      chainId: eventItem.chain,
+      block: eventItem.blockNumber,
+      logIndex: eventItem.logIndex,
+      address: eventItem.payload.srcAddress
+    }),
+    toRawEvent: eventItem => {
+      let payload = eventItem.payload;
+      return RawEvent.make(eventItem, payload.block, payload.transaction, payload.params, payload.srcAddress, cleanUpRawEventFieldsInPlace);
+    }
+  };
+}
 
 export {
   cleanUpRawEventFieldsInPlace,
-  ecosystem,
+  make,
 }
-/* ecosystem Not a pure module */
+/* Logging Not a pure module */

package/src/sources/Fuel.res

@@ -1,10 +1,25 @@
+// Fuel's concrete item payload. Erased to `Internal.eventPayload` on the item
+// and recovered here via `toPayload`.
+type payload = {
+  contractName: string,
+  eventName: string,
+  params: Internal.eventParams,
+  chainId: int,
+  srcAddress: Address.t,
+  logIndex: int,
+  transaction: Internal.eventTransaction,
+  block: Internal.eventBlock,
+}
+external fromPayload: payload => Internal.eventPayload = "%identity"
+external toPayload: Internal.eventPayload => payload = "%identity"
+
 let cleanUpRawEventFieldsInPlace: JSON.t => unit = %raw(`fields => {
     delete fields.id
     delete fields.height
     delete fields.time
   }`)
 
-let ecosystem: Ecosystem.t = {
+let make = (~logger: Pino.t): Ecosystem.t => {
   name: Fuel,
   blockFields: ["id", "height", "time"],
   transactionFields: ["id"],
@@ -25,4 +40,28 @@ let ecosystem: Ecosystem.t = {
   onEventBlockFilterSchema: S.object(s =>
     s.field("block", S.option(S.object(s2 => s2.field("height", S.unknown))))
   ),
+  logger,
+  toEvent: eventItem => eventItem.payload->Internal.payloadToEvent,
+  toEventLogger: eventItem =>
+    Logging.createChildFrom(
+      ~logger,
+      ~params={
+        "contract": eventItem.eventConfig.contractName,
+        "event": eventItem.eventConfig.name,
+        "chainId": eventItem.chain->ChainMap.Chain.toChainId,
+        "block": eventItem.blockNumber,
+        "logIndex": eventItem.logIndex,
+        "address": (eventItem.payload->toPayload).srcAddress,
+      },
+    ),
+  toRawEvent: eventItem => {
+    let payload = eventItem.payload->toPayload
+    eventItem->RawEvent.make(
+      ~block=payload.block,
+      ~transaction=payload.transaction,
+      ~params=payload.params,
+      ~srcAddress=payload.srcAddress,
+      ~cleanUpRawEventFieldsInPlace,
+    )
+  },
 }

package/src/sources/Fuel.res.mjs

@@ -1,5 +1,7 @@
 // Generated by ReScript, PLEASE EDIT WITH CARE
 
+import * as Logging from "../Logging.res.mjs";
+import * as RawEvent from "../RawEvent.res.mjs";
 import * as S$RescriptSchema from "rescript-schema/src/S.res.mjs";
 
 let cleanUpRawEventFieldsInPlace = (fields => {
@@ -8,33 +10,41 @@ let cleanUpRawEventFieldsInPlace = (fields => {
     delete fields.time
   });
 
-let ecosystem_blockFields = [
-  "id",
-  "height",
-  "time"
-];
-
-let ecosystem_transactionFields = ["id"];
-
-let ecosystem_onBlockFilterSchema = S$RescriptSchema.object(s => s.f("block", S$RescriptSchema.option(S$RescriptSchema.object(s2 => s2.f("height", S$RescriptSchema.unknown)))));
-
-let ecosystem_onEventBlockFilterSchema = S$RescriptSchema.object(s => s.f("block", S$RescriptSchema.option(S$RescriptSchema.object(s2 => s2.f("height", S$RescriptSchema.unknown)))));
-
-let ecosystem = {
-  name: "fuel",
-  blockFields: ecosystem_blockFields,
-  transactionFields: ecosystem_transactionFields,
-  blockNumberName: "height",
-  blockTimestampName: "time",
-  blockHashName: "id",
-  cleanUpRawEventFieldsInPlace: cleanUpRawEventFieldsInPlace,
-  onBlockMethodName: "onBlock",
-  onBlockFilterSchema: ecosystem_onBlockFilterSchema,
-  onEventBlockFilterSchema: ecosystem_onEventBlockFilterSchema
-};
+function make(logger) {
+  return {
+    name: "fuel",
+    blockFields: [
+      "id",
+      "height",
+      "time"
+    ],
+    transactionFields: ["id"],
+    blockNumberName: "height",
+    blockTimestampName: "time",
+    blockHashName: "id",
+    cleanUpRawEventFieldsInPlace: cleanUpRawEventFieldsInPlace,
+    onBlockMethodName: "onBlock",
+    onBlockFilterSchema: S$RescriptSchema.object(s => s.f("block", S$RescriptSchema.option(S$RescriptSchema.object(s2 => s2.f("height", S$RescriptSchema.unknown))))),
+    onEventBlockFilterSchema: S$RescriptSchema.object(s => s.f("block", S$RescriptSchema.option(S$RescriptSchema.object(s2 => s2.f("height", S$RescriptSchema.unknown))))),
+    logger: logger,
+    toEvent: eventItem => eventItem.payload,
+    toEventLogger: eventItem => Logging.createChildFrom(logger, {
+      contract: eventItem.eventConfig.contractName,
+      event: eventItem.eventConfig.name,
+      chainId: eventItem.chain,
+      block: eventItem.blockNumber,
+      logIndex: eventItem.logIndex,
+      address: eventItem.payload.srcAddress
+    }),
+    toRawEvent: eventItem => {
+      let payload = eventItem.payload;
+      return RawEvent.make(eventItem, payload.block, payload.transaction, payload.params, payload.srcAddress, cleanUpRawEventFieldsInPlace);
+    }
+  };
+}
 
 export {
   cleanUpRawEventFieldsInPlace,
-  ecosystem,
+  make,
 }
-/* ecosystem Not a pure module */
+/* Logging Not a pure module */

package/src/sources/HyperFuel.res

@@ -1,21 +1,3 @@
-//Manage clients in cache so we don't need to reinstantiate each time
-//Ideally client should be passed in as a param to the functions but
-//we are still sharing the same signature with eth archive query builder
-
-module CachedClients = {
-  let cache: dict<HyperFuelClient.t> = Dict.make()
-
-  let getClient = url => {
-    switch cache->Utils.Dict.dangerouslyGetNonOption(url) {
-    | Some(client) => client
-    | None =>
-      let newClient = HyperFuelClient.make({url: url})
-      cache->Dict.set(url, newClient)
-      newClient
-    }
-  }
-}
-
 type hyperSyncPage<'item> = {
   items: array<'item>,
   nextBlock: int,
@@ -36,29 +18,8 @@ type item = {
   block: block,
 }
 
-type blockNumberAndHash = {
-  blockNumber: int,
-  hash: string,
-}
-
 type logsQueryPage = hyperSyncPage<item>
 
-type missingParams = {
-  queryName: string,
-  missingParams: array<string>,
-}
-type queryError = UnexpectedMissingParams(missingParams)
-
-let queryErrorToMsq = (e: queryError): string => {
-  switch e {
-  | UnexpectedMissingParams({queryName, missingParams}) =>
-    `${queryName} query failed due to unexpected missing params on response:
-      ${missingParams->Array.joinUnsafe(", ")}`
-  }
-}
-
-type queryResponse<'a> = result<'a, queryError>
-
 module GetLogs = {
   type error =
     | UnexpectedMissingParams({missingParams: array<string>})
@@ -66,6 +27,31 @@ module GetLogs = {
 
   exception Error(error)
 
+  // Rust encodes structured failures as a JSON payload in the napi error's
+  // message: `{"kind":"MissingFields","fields":["receipt.txId", ...]}`.
+  // JSON.parse + shape check is the recovery protocol — no string-grepping
+  // on anyhow's Debug format.
+  let extractMissingParams = (exn: exn): option<array<string>> => {
+    let message = switch exn {
+    | JsExn(jsExn) => jsExn->JsExn.message
+    | _ => None
+    }
+    switch message {
+    | None => None
+    | Some(msg) =>
+      switch msg->JSON.parseOrThrow->JSON.Decode.object {
+      | exception _ => None
+      | None => None
+      | Some(obj) =>
+        switch (obj->Dict.get("kind"), obj->Dict.get("fields")) {
+        | (Some(String("MissingFields")), Some(Array(fields))) =>
+          Some(fields->Array.filterMap(JSON.Decode.string))
+        | _ => None
+        }
+      }
+    }
+  }
+
   let makeRequestBody = (
     ~fromBlock,
     ~toBlockInclusive,
@@ -121,9 +107,7 @@ module GetLogs = {
     let {receipts, blocks} = response_data
 
     let blocksDict = Dict.make()
-    blocks
-    ->(Utils.magic: option<'a> => 'a)
-    ->Array.forEach(block => {
+    blocks->Array.forEach(block => {
       blocksDict->Dict.set(block.height->(Utils.magic: int => string), block)
     })
 
@@ -166,93 +150,30 @@ module GetLogs = {
     page
   }
 
-  let query = async (~serverUrl, ~fromBlock, ~toBlock, ~recieptsSelection): logsQueryPage => {
+  let query = async (
+    ~client: HyperFuelClient.t,
+    ~fromBlock,
+    ~toBlock,
+    ~recieptsSelection,
+  ): logsQueryPage => {
     let query: HyperFuelClient.QueryTypes.query = makeRequestBody(
       ~fromBlock,
       ~toBlockInclusive=toBlock,
       ~recieptsSelection,
     )
 
-    let hyperFuelClient = CachedClients.getClient(serverUrl)
-
-    let res = await hyperFuelClient->HyperFuelClient.getSelectedData(query)
+    let res = switch await client->HyperFuelClient.getSelectedData(query) {
+    | res => res
+    | exception exn =>
+      switch exn->extractMissingParams {
+      | Some(missingParams) => throw(Error(UnexpectedMissingParams({missingParams: missingParams})))
+      | None => throw(exn)
+      }
+    }
     if res.nextBlock <= fromBlock {
-      // Might happen when /height response was from another instance of HyperSync
+      // Might happen when /height response was from another instance of HyperFuel
       throw(Error(WrongInstance))
     }
     res->convertResponse
   }
 }
-
-module BlockData = {
-  let convertResponse = (res: HyperFuelClient.queryResponseTyped): option<
-    ReorgDetection.blockDataWithTimestamp,
-  > => {
-    res.data.blocks->Option.flatMap(blocks => {
-      blocks
-      ->Array.get(0)
-      ->Option.map(block => {
-        switch block {
-        | {height: blockNumber, time: timestamp, id: blockHash} =>
-          (
-            {
-              blockTimestamp: timestamp,
-              blockNumber,
-              blockHash,
-            }: ReorgDetection.blockDataWithTimestamp
-          )
-        }
-      })
-    })
-  }
-
-  let rec queryBlockData = async (~serverUrl, ~blockNumber, ~logger): option<
-    ReorgDetection.blockDataWithTimestamp,
-  > => {
-    let query: HyperFuelClient.QueryTypes.query = {
-      fromBlock: blockNumber,
-      toBlockExclusive: blockNumber + 1,
-      // FIXME: Theoretically it should work without the outputs filter, but it doesn't for some reason
-      outputs: [%raw(`{}`)],
-      // FIXME: Had to add inputs {} as well, since it failed on block 1211599 during wildcard Call indexing
-      inputs: [%raw(`{}`)],
-      fieldSelection: {
-        block: [Height, Id, Time],
-      },
-      includeAllBlocks: true,
-    }
-
-    let hyperFuelClient = CachedClients.getClient(serverUrl)
-
-    let logger = Logging.createChildFrom(
-      ~logger,
-      ~params={"logType": "hypersync get blockhash query", "blockNumber": blockNumber},
-    )
-
-    let executeQuery = () => hyperFuelClient->HyperFuelClient.getSelectedData(query)
-
-    let res = await executeQuery->Time.retryAsyncWithExponentialBackOff(~logger)
-
-    // If the block is not found, retry the query. This can occur since replicas of hypersync might not hack caught up yet
-    if res.nextBlock <= blockNumber {
-      let logger = Logging.createChild(~params={"url": serverUrl})
-      let delayMilliseconds = 100
-      logger->Logging.childInfo(
-        `Block #${blockNumber->Int.toString} not found in HyperFuel. HyperFuel has multiple instances and it's possible that they drift independently slightly from the head. Indexing should continue correctly after retrying the query in ${delayMilliseconds->Int.toString}ms.`,
-      )
-      await Time.resolvePromiseAfterDelay(~delayMilliseconds)
-      await queryBlockData(~serverUrl, ~blockNumber, ~logger)
-    } else {
-      res->convertResponse
-    }
-  }
-}
-
-let queryBlockData = BlockData.queryBlockData
-
-let heightRoute = Rest.route(() => {
-  path: "/height",
-  method: Get,
-  input: _ => (),
-  responses: [s => s.field("height", S.int)],
-})