envio 3.0.0-alpha.2 → 3.0.0-alpha.20

package/src/sources/Evm.res.mjs

@@ -0,0 +1,105 @@
+// Generated by ReScript, PLEASE EDIT WITH CARE
+
+
+var cleanUpRawEventFieldsInPlace = (fields => {
+    delete fields.hash
+    delete fields.number
+    delete fields.timestamp
+  });
+
+var 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"
+];
+
+var 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"
+];
+
+function ecosystem_getNumber(prim) {
+  return prim.number;
+}
+
+function ecosystem_getTimestamp(prim) {
+  return prim.timestamp;
+}
+
+function ecosystem_getId(prim) {
+  return prim.hash;
+}
+
+var ecosystem = {
+  name: "evm",
+  blockFields: ecosystem_blockFields,
+  transactionFields: ecosystem_transactionFields,
+  blockNumberName: "number",
+  blockTimestampName: "timestamp",
+  blockHashName: "hash",
+  getNumber: ecosystem_getNumber,
+  getTimestamp: ecosystem_getTimestamp,
+  getId: ecosystem_getId,
+  cleanUpRawEventFieldsInPlace: cleanUpRawEventFieldsInPlace
+};
+
+export {
+  cleanUpRawEventFieldsInPlace ,
+  ecosystem ,
+}
+/* No side effect */

package/src/sources/EvmChain.res

@@ -0,0 +1,94 @@
+open Belt
+
+type rpc = {
+  url: string,
+  sourceFor: Source.sourceFor,
+  syncConfig?: Config.sourceSyncOptions,
+  ws?: string,
+}
+
+let getSyncConfig = (
+  {
+    ?initialBlockInterval,
+    ?backoffMultiplicative,
+    ?accelerationAdditive,
+    ?intervalCeiling,
+    ?backoffMillis,
+    ?queryTimeoutMillis,
+    ?fallbackStallTimeout,
+    ?pollingInterval,
+  }: Config.sourceSyncOptions,
+): Config.sourceSync => {
+  let queryTimeoutMillis = queryTimeoutMillis->Option.getWithDefault(20_000)
+  {
+    initialBlockInterval: Env.Configurable.SyncConfig.initialBlockInterval->Option.getWithDefault(
+      initialBlockInterval->Option.getWithDefault(10_000),
+    ),
+    // After an RPC error, how much to scale back the number of blocks requested at once
+    backoffMultiplicative: Env.Configurable.SyncConfig.backoffMultiplicative->Option.getWithDefault(
+      backoffMultiplicative->Option.getWithDefault(0.8),
+    ),
+    // Without RPC errors or timeouts, how much to increase the number of blocks requested by for the next batch
+    accelerationAdditive: Env.Configurable.SyncConfig.accelerationAdditive->Option.getWithDefault(
+      accelerationAdditive->Option.getWithDefault(500),
+    ),
+    // Do not further increase the block interval past this limit
+    intervalCeiling: Env.Configurable.SyncConfig.intervalCeiling->Option.getWithDefault(
+      intervalCeiling->Option.getWithDefault(10_000),
+    ),
+    // After an error, how long to wait before retrying
+    backoffMillis: backoffMillis->Option.getWithDefault(5000),
+    // How long to wait before cancelling an RPC request
+    queryTimeoutMillis,
+    fallbackStallTimeout: fallbackStallTimeout->Option.getWithDefault(queryTimeoutMillis / 2),
+    // How frequently to check for new blocks in realtime (default: 1000ms)
+    pollingInterval: pollingInterval->Option.getWithDefault(1000),
+  }
+}
+
+let makeSources = (
+  ~chain,
+  ~contracts: array<Internal.evmContractConfig>,
+  ~hyperSync,
+  ~allEventSignatures,
+  ~rpcs: array<rpc>,
+  ~lowercaseAddresses,
+) => {
+  let eventRouter =
+    contracts
+    ->Belt.Array.flatMap(contract => contract.events)
+    ->EventRouter.fromEvmEventModsOrThrow(~chain)
+
+  let sources = switch hyperSync {
+  | Some(endpointUrl) => [
+      HyperSyncSource.make({
+        chain,
+        endpointUrl,
+        allEventSignatures,
+        eventRouter,
+        apiToken: Env.envioApiToken,
+        clientMaxRetries: Env.hyperSyncClientMaxRetries,
+        clientTimeoutMillis: Env.hyperSyncClientTimeoutMillis,
+        lowercaseAddresses,
+        serializationFormat: Env.hypersyncClientSerializationFormat,
+        enableQueryCaching: Env.hypersyncClientEnableQueryCaching,
+      }),
+    ]
+  | _ => []
+  }
+  rpcs->Js.Array2.forEach(({?syncConfig, url, sourceFor, ?ws}) => {
+    let source = RpcSource.make({
+      chain,
+      sourceFor,
+      syncConfig: getSyncConfig(syncConfig->Option.getWithDefault({})),
+      url,
+      eventRouter,
+      allEventSignatures,
+      lowercaseAddresses,
+      ?ws,
+    })
+    let _ = sources->Js.Array2.push(source)
+  })
+
+  sources
+}

package/src/sources/EvmChain.res.mjs

@@ -0,0 +1,60 @@
+// Generated by ReScript, PLEASE EDIT WITH CARE
+
+import * as Env from "../Env.res.mjs";
+import * as RpcSource from "./RpcSource.res.mjs";
+import * as Belt_Array from "rescript/lib/es6/belt_Array.js";
+import * as Belt_Option from "rescript/lib/es6/belt_Option.js";
+import * as EventRouter from "./EventRouter.res.mjs";
+import * as HyperSyncSource from "./HyperSyncSource.res.mjs";
+
+function getSyncConfig(param) {
+  var queryTimeoutMillis = Belt_Option.getWithDefault(param.queryTimeoutMillis, 20000);
+  return {
+          initialBlockInterval: Belt_Option.getWithDefault(Env.Configurable.SyncConfig.initialBlockInterval, Belt_Option.getWithDefault(param.initialBlockInterval, 10000)),
+          backoffMultiplicative: Belt_Option.getWithDefault(Env.Configurable.SyncConfig.backoffMultiplicative, Belt_Option.getWithDefault(param.backoffMultiplicative, 0.8)),
+          accelerationAdditive: Belt_Option.getWithDefault(Env.Configurable.SyncConfig.accelerationAdditive, Belt_Option.getWithDefault(param.accelerationAdditive, 500)),
+          intervalCeiling: Belt_Option.getWithDefault(Env.Configurable.SyncConfig.intervalCeiling, Belt_Option.getWithDefault(param.intervalCeiling, 10000)),
+          backoffMillis: Belt_Option.getWithDefault(param.backoffMillis, 5000),
+          queryTimeoutMillis: queryTimeoutMillis,
+          fallbackStallTimeout: Belt_Option.getWithDefault(param.fallbackStallTimeout, queryTimeoutMillis / 2 | 0),
+          pollingInterval: Belt_Option.getWithDefault(param.pollingInterval, 1000)
+        };
+}
+
+function makeSources(chain, contracts, hyperSync, allEventSignatures, rpcs, lowercaseAddresses) {
+  var eventRouter = EventRouter.fromEvmEventModsOrThrow(Belt_Array.flatMap(contracts, (function (contract) {
+              return contract.events;
+            })), chain);
+  var sources = hyperSync !== undefined ? [HyperSyncSource.make({
+            chain: chain,
+            endpointUrl: hyperSync,
+            allEventSignatures: allEventSignatures,
+            eventRouter: eventRouter,
+            apiToken: Env.envioApiToken,
+            clientMaxRetries: Env.hyperSyncClientMaxRetries,
+            clientTimeoutMillis: Env.hyperSyncClientTimeoutMillis,
+            lowercaseAddresses: lowercaseAddresses,
+            serializationFormat: Env.hypersyncClientSerializationFormat,
+            enableQueryCaching: Env.hypersyncClientEnableQueryCaching
+          })] : [];
+  rpcs.forEach(function (param) {
+        var source = RpcSource.make({
+              sourceFor: param.sourceFor,
+              syncConfig: getSyncConfig(Belt_Option.getWithDefault(param.syncConfig, {})),
+              url: param.url,
+              chain: chain,
+              eventRouter: eventRouter,
+              allEventSignatures: allEventSignatures,
+              lowercaseAddresses: lowercaseAddresses,
+              ws: param.ws
+            });
+        sources.push(source);
+      });
+  return sources;
+}
+
+export {
+  getSyncConfig ,
+  makeSources ,
+}
+/* Env Not a pure module */

package/src/sources/Fuel.res

@@ -1,37 +1,22 @@
-type receiptType =
-  | @as(0) Call
-  | @as(1) Return
-  | @as(2) ReturnData
-  | @as(3) Panic
-  | @as(4) Revert
-  | @as(5) Log
-  | @as(6) LogData
-  // Transfer is to another contract, TransferOut is to wallet address
-  | @as(7) Transfer
-  | @as(8) TransferOut
-  | @as(9) ScriptResult
-  | @as(10) MessageOut
-  | @as(11) Mint
-  | @as(12) Burn
+@get external getNumber: Internal.eventBlock => int = "height"
+@get external getTimestamp: Internal.eventBlock => int = "time"
+@get external getId: Internal.eventBlock => string = "id"
 
-@module("./vendored-fuel-abi-coder.js")
-external transpileAbi: Js.Json.t => Ethers.abi = "transpileAbi"
+let cleanUpRawEventFieldsInPlace: Js.Json.t => unit = %raw(`fields => {
+    delete fields.id
+    delete fields.height
+    delete fields.time
+  }`)
 
-@module("./vendored-fuel-abi-coder.js") @scope("AbiCoder")
-external getLogDecoder: (~abi: Ethers.abi, ~logId: string) => string => unknown = "getLogDecoder"
-
-module Receipt = {
-  @tag("receiptType")
-  type t =
-    | @as(0) Call({assetId: string, amount: bigint, to: string})
-    | @as(6) LogData({data: string, rb: bigint})
-    | @as(7) Transfer({amount: bigint, assetId: string, to: string})
-    | @as(8) TransferOut({amount: bigint, assetId: string, toAddress: string})
-    | @as(11) Mint({val: bigint, subId: string})
-    | @as(12) Burn({val: bigint, subId: string})
-
-  let getLogDataDecoder = (~abi: Ethers.abi, ~logId: string) => {
-    let decode = getLogDecoder(~abi, ~logId)
-    data => data->decode->Utils.magic
-  }
+let ecosystem: Ecosystem.t = {
+  name: Fuel,
+  blockFields: ["id", "height", "time"],
+  transactionFields: ["id"],
+  blockNumberName: "height",
+  blockTimestampName: "time",
+  blockHashName: "id",
+  getNumber,
+  getTimestamp,
+  getId,
+  cleanUpRawEventFieldsInPlace,
 }

package/src/sources/Fuel.res.mjs

@@ -1,29 +1,47 @@
 // Generated by ReScript, PLEASE EDIT WITH CARE
 
-import * as VendoredFuelAbiCoderJs from "./vendored-fuel-abi-coder.js";
 
-function transpileAbi(prim) {
-  return VendoredFuelAbiCoderJs.transpileAbi(prim);
+var cleanUpRawEventFieldsInPlace = (fields => {
+    delete fields.id
+    delete fields.height
+    delete fields.time
+  });
+
+var ecosystem_blockFields = [
+  "id",
+  "height",
+  "time"
+];
+
+var ecosystem_transactionFields = ["id"];
+
+function ecosystem_getNumber(prim) {
+  return prim.height;
 }
 
-function getLogDecoder(prim0, prim1) {
-  return VendoredFuelAbiCoderJs.AbiCoder.getLogDecoder(prim0, prim1);
+function ecosystem_getTimestamp(prim) {
+  return prim.time;
 }
 
-function getLogDataDecoder(abi, logId) {
-  var decode = VendoredFuelAbiCoderJs.AbiCoder.getLogDecoder(abi, logId);
-  return function (data) {
-    return decode(data);
-  };
+function ecosystem_getId(prim) {
+  return prim.id;
 }
 
-var Receipt = {
-  getLogDataDecoder: getLogDataDecoder
+var ecosystem = {
+  name: "fuel",
+  blockFields: ecosystem_blockFields,
+  transactionFields: ecosystem_transactionFields,
+  blockNumberName: "height",
+  blockTimestampName: "time",
+  blockHashName: "id",
+  getNumber: ecosystem_getNumber,
+  getTimestamp: ecosystem_getTimestamp,
+  getId: ecosystem_getId,
+  cleanUpRawEventFieldsInPlace: cleanUpRawEventFieldsInPlace
 };
 
 export {
-  transpileAbi ,
-  getLogDecoder ,
-  Receipt ,
+  cleanUpRawEventFieldsInPlace ,
+  ecosystem ,
 }
-/* ./vendored-fuel-abi-coder.js Not a pure module */
+/* No side effect */

package/src/sources/FuelSDK.res

@@ -0,0 +1,38 @@
+type receiptType =
+  | @as(0) Call
+  | @as(1) Return
+  | @as(2) ReturnData
+  | @as(3) Panic
+  | @as(4) Revert
+  | @as(5) Log
+  | @as(6) LogData
+  // Transfer is to another contract, TransferOut is to wallet address
+  | @as(7) Transfer
+  | @as(8) TransferOut
+  | @as(9) ScriptResult
+  | @as(10) MessageOut
+  | @as(11) Mint
+  | @as(12) Burn
+
+@module("./vendored-fuel-abi-coder.js")
+external transpileAbi: Js.Json.t => EvmTypes.Abi.t = "transpileAbi"
+
+@module("./vendored-fuel-abi-coder.js") @scope("AbiCoder")
+external getLogDecoder: (~abi: EvmTypes.Abi.t, ~logId: string) => string => unknown =
+  "getLogDecoder"
+
+module Receipt = {
+  @tag("receiptType")
+  type t =
+    | @as(0) Call({assetId: string, amount: bigint, to: string})
+    | @as(6) LogData({data: string, rb: bigint})
+    | @as(7) Transfer({amount: bigint, assetId: string, to: string})
+    | @as(8) TransferOut({amount: bigint, assetId: string, toAddress: string})
+    | @as(11) Mint({val: bigint, subId: string})
+    | @as(12) Burn({val: bigint, subId: string})
+
+  let getLogDataDecoder = (~abi: EvmTypes.Abi.t, ~logId: string) => {
+    let decode = getLogDecoder(~abi, ~logId)
+    data => data->decode->(Utils.magic: 'a => Internal.eventParams)
+  }
+}

package/src/sources/FuelSDK.res.mjs

@@ -0,0 +1,29 @@
+// Generated by ReScript, PLEASE EDIT WITH CARE
+
+import * as VendoredFuelAbiCoderJs from "./vendored-fuel-abi-coder.js";
+
+function transpileAbi(prim) {
+  return VendoredFuelAbiCoderJs.transpileAbi(prim);
+}
+
+function getLogDecoder(prim0, prim1) {
+  return VendoredFuelAbiCoderJs.AbiCoder.getLogDecoder(prim0, prim1);
+}
+
+function getLogDataDecoder(abi, logId) {
+  var decode = VendoredFuelAbiCoderJs.AbiCoder.getLogDecoder(abi, logId);
+  return function (data) {
+    return decode(data);
+  };
+}
+
+var Receipt = {
+  getLogDataDecoder: getLogDataDecoder
+};
+
+export {
+  transpileAbi ,
+  getLogDecoder ,
+  Receipt ,
+}
+/* ./vendored-fuel-abi-coder.js Not a pure module */

package/src/sources/HyperFuel.res

@@ -33,7 +33,7 @@ type block = {
 type item = {
   transactionId: string,
   contractId: Address.t,
-  receipt: Fuel.Receipt.t,
+  receipt: FuelSDK.Receipt.t,
   receiptIndex: int,
   block: block,
 }
@@ -148,7 +148,7 @@ module GetLogs = {
               time: block.time,
             },
             contractId,
-            receipt: receipt->(Utils.magic: HyperFuelClient.FuelTypes.receipt => Fuel.Receipt.t),
+            receipt: receipt->(Utils.magic: HyperFuelClient.FuelTypes.receipt => FuelSDK.Receipt.t),
             receiptIndex: receipt.receiptIndex,
           })
           ->ignore

package/src/sources/HyperFuel.resi

@@ -13,7 +13,7 @@ type block = {
 type item = {
   transactionId: string,
   contractId: Address.t,
-  receipt: Fuel.Receipt.t,
+  receipt: FuelSDK.Receipt.t,
   receiptIndex: int,
   block: block,
 }

package/src/sources/HyperFuelClient.res

@@ -106,7 +106,7 @@ module QueryTypes = {
     rootContractId?: array<Address.t>,
     toAddress?: array<string>,
     assetId?: array<string>,
-    receiptType?: array<Fuel.receiptType>,
+    receiptType?: array<FuelSDK.receiptType>,
     sender?: array<string>,
     recipient?: array<string>,
     contractId?: array<Address.t>,
@@ -290,7 +290,7 @@ module FuelTypes = {
     /** The length of the receipt. */
     len?: bigint,
     /** The type of receipt. */
-    receiptType: Fuel.receiptType,
+    receiptType: FuelSDK.receiptType,
     /** 0 if script exited successfully, any otherwise. */
     result?: int,
     /** The amount of gas consumed by the script. */

package/src/sources/HyperFuelSource.res

@@ -15,7 +15,7 @@ type selectionConfig = {
   eventRouter: EventRouter.t<Internal.fuelEventConfig>,
 }
 
-let logDataReceiptTypeSelection: array<Fuel.receiptType> = [LogData]
+let logDataReceiptTypeSelection: array<FuelSDK.receiptType> = [LogData]
 
 // only transactions with status 1 (success)
 let txStatusSelection = [1]
@@ -114,10 +114,10 @@ let getSelectionConfig = (selection: FetchState.selection, ~chain) => {
   let nonLogDataReceiptTypesByContract = Js.Dict.empty()
   let nonLogDataWildcardReceiptTypes = []
 
-  let addNonLogDataWildcardReceiptTypes = (receiptType: Fuel.receiptType) => {
+  let addNonLogDataWildcardReceiptTypes = (receiptType: FuelSDK.receiptType) => {
     nonLogDataWildcardReceiptTypes->Array.push(receiptType)->ignore
   }
-  let addNonLogDataReceiptType = (contractName, receiptType: Fuel.receiptType) => {
+  let addNonLogDataReceiptType = (contractName, receiptType: FuelSDK.receiptType) => {
     switch nonLogDataReceiptTypesByContract->Utils.Dict.dangerouslyGetNonOption(contractName) {
     | None => nonLogDataReceiptTypesByContract->Js.Dict.set(contractName, [receiptType])
     | Some(receiptTypes) => receiptTypes->Array.push(receiptType)->ignore // Duplication prevented by EventRouter
@@ -220,7 +220,7 @@ let make = ({chain, endpointUrl}: options): t => {
     ~toBlock,
     ~addressesByContractName,
     ~indexingContracts,
-    ~currentBlockHeight,
+    ~knownHeight,
     ~partitionId as _,
     ~selection: FetchState.selection,
     ~retry,
@@ -235,6 +235,11 @@ let make = ({chain, endpointUrl}: options): t => {
     let startFetchingBatchTimeRef = Hrtime.makeTimer()
 
     //fetch batch
+    Prometheus.SourceRequestCount.increment(
+      ~sourceName=name,
+      ~chainId=chain->ChainMap.Chain.toChainId,
+      ~method="getLogs",
+    )
     let pageUnsafe = try await HyperFuel.GetLogs.query(
       ~serverUrl=endpointUrl,
       ~fromBlock,
@@ -246,7 +251,7 @@ let make = ({chain, endpointUrl}: options): t => {
         Source.GetItemsError(
           Source.FailedGettingItems({
             exn: %raw(`null`),
-            attemptedToBlock: toBlock->Option.getWithDefault(currentBlockHeight),
+            attemptedToBlock: toBlock->Option.getWithDefault(knownHeight),
             retry: switch error {
             | WrongInstance =>
               let backoffMillis = switch retry {
@@ -272,7 +277,7 @@ let make = ({chain, endpointUrl}: options): t => {
         Source.GetItemsError(
           Source.FailedGettingItems({
             exn,
-            attemptedToBlock: toBlock->Option.getWithDefault(currentBlockHeight),
+            attemptedToBlock: toBlock->Option.getWithDefault(knownHeight),
             retry: WithBackoff({
               message: `Unexpected issue while fetching events from HyperFuel client. Attempt a retry.`,
               backoffMillis: switch retry {
@@ -285,11 +290,10 @@ let make = ({chain, endpointUrl}: options): t => {
       )
     }
 
-    let pageFetchTime =
-      startFetchingBatchTimeRef->Hrtime.timeSince->Hrtime.toMillis->Hrtime.intFromMillis
+    let pageFetchTime = startFetchingBatchTimeRef->Hrtime.timeSince->Hrtime.toSecondsFloat
 
     //set height and next from block
-    let currentBlockHeight = pageUnsafe.archiveHeight
+    let knownHeight = pageUnsafe.archiveHeight
 
     //The heighest (biggest) blocknumber that was accounted for in
     //Our query. Not necessarily the blocknumber of the last log returned
@@ -456,7 +460,7 @@ let make = ({chain, endpointUrl}: options): t => {
       })
     })
 
-    let parsingTimeElapsed = parsingTimeRef->Hrtime.timeSince->Hrtime.toMillis->Hrtime.intFromMillis
+    let parsingTimeElapsed = parsingTimeRef->Hrtime.timeSince->Hrtime.toSecondsFloat
 
     let rangeLastBlock = await lastBlockQueriedPromise
 
@@ -465,7 +469,7 @@ let make = ({chain, endpointUrl}: options): t => {
       prevRangeLastBlock: None,
     }
 
-    let totalTimeElapsed = totalTimeRef->Hrtime.timeSince->Hrtime.toMillis->Hrtime.intFromMillis
+    let totalTimeElapsed = totalTimeRef->Hrtime.timeSince->Hrtime.toSecondsFloat
 
     let stats = {
       totalTimeElapsed,
@@ -478,7 +482,7 @@ let make = ({chain, endpointUrl}: options): t => {
       parsedQueueItems,
       latestFetchedBlockNumber: rangeLastBlock.blockNumber,
       stats,
-      currentBlockHeight,
+      knownHeight,
       reorgGuard,
       fromBlockQueried: fromBlock,
     }
@@ -496,7 +500,23 @@ let make = ({chain, endpointUrl}: options): t => {
     getBlockHashes,
     pollingInterval: 100,
     poweredByHyperSync: true,
-    getHeightOrThrow: () => HyperFuel.heightRoute->Rest.fetch((), ~client=jsonApiClient),
+    getHeightOrThrow: async () => {
+      let timerRef = Hrtime.makeTimer()
+      let height = await HyperFuel.heightRoute->Rest.fetch((), ~client=jsonApiClient)
+      let seconds = timerRef->Hrtime.timeSince->Hrtime.toSecondsFloat
+      Prometheus.SourceRequestCount.increment(
+        ~sourceName=name,
+        ~chainId=chain->ChainMap.Chain.toChainId,
+        ~method="getHeight",
+      )
+      Prometheus.SourceRequestCount.addSeconds(
+        ~sourceName=name,
+        ~chainId=chain->ChainMap.Chain.toChainId,
+        ~method="getHeight",
+        ~seconds,
+      )
+      height
+    },
     getItemsOrThrow,
   }
 }