envio 3.7.0 → 3.9.0-resolvers.0

package/src/ContractMapping.res

@@ -0,0 +1,66 @@
+// The contract name <-> id mapping every stored address row references: a
+// name's position in `names` is the id `envio_contracts` holds and
+// `envio_addresses.contract_id` points at. Ids must mean the same thing on
+// every chain and across restarts, so a mapping is built once — from the whole
+// config, never from a filtered subset — and read everywhere else.
+type t = {
+  // Id order. Index i is the name of contract id i.
+  names: array<string>,
+  idByName: dict<int>,
+}
+
+let indexNames = (names: array<string>): t => {
+  let idByName = Dict.make()
+  names->Array.forEachWithIndex((name, id) => idByName->Dict.set(name, id))
+  {names, idByName}
+}
+
+// Ids are 0-based positions in a smallint column, so 32768 contracts fit.
+let maxContracts = 32768
+
+// Names in any order; the codec puts them in byte order so the ids never depend
+// on the order contracts happen to be declared in.
+let make = (~names: array<string>): t => {
+  let canonical = Core.getAddon().canonicalContractNames(names)
+  if canonical->Array.length > maxContracts {
+    JsError.throwWithMessage(
+      `The indexer declares ${canonical
+        ->Array.length
+        ->Int.toString} contracts, more than the ${maxContracts->Int.toString} a smallint contract id can hold.`,
+    )
+  }
+  indexNames(canonical)
+}
+
+// What a storage holds before it has been initialized: no contract has an id
+// yet, so every lookup fails rather than resolving against a stale mapping.
+let empty = indexNames([])
+
+// A mapping read back from storage. Taken verbatim: the stored order *is* the
+// id order the stored rows were written against, so re-canonicalizing it would
+// paper over a mapping that no longer matches those rows.
+let fromStoredNames = indexNames
+
+let names = (mapping: t) => mapping.names
+
+let idOfOrThrow = (mapping: t, name, ~context="") =>
+  switch mapping.idByName->Utils.Dict.dangerouslyGetNonOption(name) {
+  | Some(id) => id
+  | None =>
+    JsError.throwWithMessage(
+      `Contract "${name}"${context} is missing from the indexer's contract list.`,
+    )
+  }
+
+let nameOfOrThrow = (mapping: t, id) =>
+  switch mapping.names->Array.get(id) {
+  | Some(name) => name
+  | None =>
+    JsError.throwWithMessage(
+      `Contract id ${id->Int.toString} is outside the indexer's contract list.`,
+    )
+  }
+
+let isEqual = (a: t, b: t) =>
+  a.names->Array.length === b.names->Array.length &&
+    a.names->Array.everyWithIndex((name, idx) => b.names->Array.getUnsafe(idx) === name)

package/src/ContractMapping.res.mjs

@@ -0,0 +1,73 @@
+// Generated by ReScript, PLEASE EDIT WITH CARE
+
+import * as Core from "./Core.res.mjs";
+import * as Stdlib_JsError from "@rescript/runtime/lib/es6/Stdlib_JsError.js";
+
+function indexNames(names) {
+  let idByName = {};
+  names.forEach((name, id) => {
+    idByName[name] = id;
+  });
+  return {
+    names: names,
+    idByName: idByName
+  };
+}
+
+function make(names) {
+  let canonical = Core.getAddon().canonicalContractNames(names);
+  if (canonical.length > 32768) {
+    Stdlib_JsError.throwWithMessage(`The indexer declares ` + canonical.length.toString() + ` contracts, more than the ` + (32768).toString() + ` a smallint contract id can hold.`);
+  }
+  return indexNames(canonical);
+}
+
+let empty = indexNames([]);
+
+function names(mapping) {
+  return mapping.names;
+}
+
+function idOfOrThrow(mapping, name, contextOpt) {
+  let context = contextOpt !== undefined ? contextOpt : "";
+  let id = mapping.idByName[name];
+  if (id !== undefined) {
+    return id;
+  } else {
+    return Stdlib_JsError.throwWithMessage(`Contract "` + name + `"` + context + ` is missing from the indexer's contract list.`);
+  }
+}
+
+function nameOfOrThrow(mapping, id) {
+  let name = mapping.names[id];
+  if (name !== undefined) {
+    return name;
+  } else {
+    return Stdlib_JsError.throwWithMessage(`Contract id ` + id.toString() + ` is outside the indexer's contract list.`);
+  }
+}
+
+function isEqual(a, b) {
+  if (a.names.length === b.names.length) {
+    return a.names.every((name, idx) => b.names[idx] === name);
+  } else {
+    return false;
+  }
+}
+
+let maxContracts = 32768;
+
+let fromStoredNames = indexNames;
+
+export {
+  indexNames,
+  maxContracts,
+  make,
+  empty,
+  fromStoredNames,
+  names,
+  idOfOrThrow,
+  nameOfOrThrow,
+  isEqual,
+}
+/* empty Not a pure module */

package/src/Core.res

@@ -10,6 +10,7 @@ type svmHyperSyncClientCtor
 type fuelHyperSyncClientCtor
 type transactionStoreCtor
 type blockStoreCtor
+type clickHouseSinkCtor
 type addressStoreCtor
 // Test-only: a local HyperSync server, bound by MockHyperSyncServer in envio-tests.
 type mockHyperSyncServerCtor
@@ -29,6 +30,7 @@ type fromUserApiResult = {
 type addon = {
   getConfigJson: (~configPath: Null.t<string>, ~directory: Null.t<string>) => string,
   encodeIndexedTopic: (~abiType: string, ~value: unknown) => EvmTypes.Hex.t,
+  isSvmPubkey: (~value: string) => bool,
   fromUserApi: (string, fromUserApiOptions) => fromUserApiResult,
   runCli: (~args: array<string>, ~envioPackageDir: Null.t<string>) => promise<Null.t<string>>,
   @as("EvmHyperSyncClient")
@@ -45,8 +47,26 @@ type addon = {
   blockStore: blockStoreCtor,
   @as("AddressStore")
   addressStore: addressStoreCtor,
+  @as("ClickHouseSink")
+  clickHouseSink: clickHouseSinkCtor,
   @as("MockHyperSyncServer")
   mockHyperSyncServer: mockHyperSyncServerCtor,
+  encodeAddresses: (~ecosystem: string, ~addresses: array<Address.t>) => array<NodeJs.Buffer.t>,
+  renderAddresses: (
+    ~ecosystem: string,
+    ~shouldChecksum: bool,
+    ~bytes: NodeJs.Buffer.t,
+    ~lengths: array<int>,
+  ) => array<Address.t>,
+  renderContractAddresses: (
+    ~ecosystem: string,
+    ~shouldChecksum: bool,
+    ~bytes: NodeJs.Buffer.t,
+    ~lengths: array<int>,
+    ~contractIds: array<int>,
+    ~contractId: int,
+  ) => array<Address.t>,
+  canonicalContractNames: array<string> => array<string>,
   // Ordered transaction-field names exposed for the field-code contract test
   // (the ReScript `transactionFields` arrays must match the Rust ordinals).
   evmTransactionFieldNames: unit => array<string>,
@@ -84,6 +104,10 @@ let loadDevAddon: ({..}, string) => addon = %raw(`function(req, envioDir) {
   var path = Nodepath;
   var fs = Nodefs;
 
+  // Vitest test.env points workers at the addon globalSetup already built.
+  var preBuilt = process.env.ENVIO_DEV_ADDON;
+  if (preBuilt && fs.existsSync(preBuilt)) return req(preBuilt);
+
   var repoRoot = null;
   var dir = path.resolve(envioDir);
   for (var i = 0; i < 10; i++) {

package/src/Core.res.mjs

@@ -26,6 +26,10 @@ let loadDevAddon = (function(req, envioDir) {
   var path = Nodepath;
   var fs = Nodefs;
 
+  // Vitest test.env points workers at the addon globalSetup already built.
+  var preBuilt = process.env.ENVIO_DEV_ADDON;
+  if (preBuilt && fs.existsSync(preBuilt)) return req(preBuilt);
+
   var repoRoot = null;
   var dir = path.resolve(envioDir);
   for (var i = 0; i < 10; i++) {

package/src/Ecosystem.res

@@ -10,6 +10,11 @@ type t = {
       for SVM. Centralised here so adding a new ecosystem only requires a
       new ecosystem record, not another switch in `Main.res`. */
   onBlockMethodName: string,
+  /** What the ecosystem calls a contract and one of its events, for
+      registration errors that are shared across ecosystems — "contract" /
+      "event" on EVM and Fuel, "program" / "instruction" on SVM. */
+  contractNoun: string,
+  eventNoun: string,
   /** Schema that unwraps the ecosystem-specific outer wrapper around the
       user's `where`-returned filter (`block.number` on EVM, `block.height`
       on Fuel, `slot` on SVM) and surfaces the raw inner `{_gte?, _lte?,
@@ -23,8 +28,8 @@ type t = {
       `option<unknown>`. Separate from `onBlockFilterSchema` because event
       block filters support only `_gte` (→ per-event `startBlock`) — `_lte`
       and `_every` are rejected by the inner `eventBlockRangeSchema` in
-      `LogSelection.res`. SVM does not support event handlers, so its
-      schema always surfaces `None`. */
+      `LogSelection.res`. SVM parses its own `where` (including the
+      `block.slot` chunk), so its schema always surfaces `None`. */
   onEventBlockFilterSchema: S.t<option<unknown>>,
   /** Base logger injected at construction. Used to build per-item child
       loggers (see `getItemLogger`). */

package/src/Env.res

@@ -163,6 +163,128 @@ module ClickHouse = {
   let databaseEngine = () => read("ENVIO_CLICKHOUSE_DATABASE_ENGINE")
 }
 
+// The resolver process runs on its own, so its database connection comes from
+// the same ENVIO_PG_* vars the indexer's does -- point them wherever reads
+// should go. Only what genuinely differs from the indexer's shape gets a var
+// of its own.
+//
+// Read at call time rather than module load, for the same reason ClickHouse's
+// are: `envio dev` injects them after this module has been evaluated.
+module Resolvers = {
+  %%private(
+    let read: string => option<string> = %raw(`(k) => {
+      const v = process.env[k];
+      return v === undefined || v === "" ? undefined : v;
+    }`)
+
+    // `Int.fromString` is `parseInt`: it takes the leading digits and drops the
+    // rest, so "60s" reads as 60 and "1e3" as 1. For a duration that is a
+    // thousandfold error in the quiet direction -- "60s" meaning a minute
+    // becomes a 60ms loop -- so the parse only accepts what it can write back
+    // unchanged.
+    let parseWhole = raw => {
+      let trimmed = raw->String.trim
+      switch trimmed->Int.fromString {
+      | Some(value) if trimmed === value->Int.toString => Some(value)
+      | _ => None
+      }
+    }
+
+    let readInt = (key, ~fallback) =>
+      switch read(key) {
+      | None => fallback
+      | Some(raw) =>
+        switch raw->parseWhole {
+        | Some(value) if value > 0 => value
+        | _ =>
+          JsError.throwWithMessage(
+            `Invalid ${key} value: "${raw}". Expected a positive whole number.`,
+          )
+        }
+      }
+  )
+
+  let port = () =>
+    switch readInt("ENVIO_RESOLVERS_PORT", ~fallback=9900) {
+    | value if value <= 65535 => value
+    | value =>
+      // `readInt` only rejects zero and below, so an out-of-range port reached
+      // `listen` and failed there instead, naming neither the variable nor why.
+      JsError.throwWithMessage(
+        `Invalid ENVIO_RESOLVERS_PORT value: "${value->Int.toString}". A TCP port is 1 to 65535.`,
+      )
+    }
+
+  // Sized as concurrent heavy requests x per-request fan-out, not as the
+  // indexer's two long-lived connections: one resolver request can hold four
+  // at once.
+  let poolSize = () => readInt("ENVIO_RESOLVERS_POOL_SIZE", ~fallback=25)
+
+  let poolWaitTimeoutMs = () => readInt("ENVIO_RESOLVERS_POOL_WAIT_TIMEOUT_MS", ~fallback=10_000)
+
+  // `envio dev` sets this on the resolver process it spawns: locally the
+  // caller is the person who wrote the resolver, so an unexpected error's own
+  // message is what they need. Deployed, the caller may be the public internet
+  // and the message can carry a connection string.
+  let exposeErrors = () =>
+    switch read("ENVIO_RESOLVERS_EXPOSE_ERRORS") {
+    | None
+    | Some("false") => false
+    | Some("true") => true
+    | Some(other) =>
+      // Refused rather than read as false: a typo here silently keeps a
+      // resolver's own error messages off the wire, which is the opposite of
+      // what the person who set it wanted, and nothing would say so.
+      JsError.throwWithMessage(
+        `Invalid ENVIO_RESOLVERS_EXPOSE_ERRORS value: "${other}". Expected "true" or "false".`,
+      )
+    }
+
+  // The URL *Hasura* posts to, which is not the address this process binds:
+  // it is baked into every action, so Hasura has no other way to reach the
+  // resolvers.
+  let publicUrl = () => read("ENVIO_RESOLVERS_PUBLIC_URL")
+
+  // How often the metadata is re-asserted. 0 disables it, for a deployment
+  // where something else owns Hasura's metadata.
+  let metadataIntervalMs = () =>
+    switch read("ENVIO_RESOLVERS_METADATA_INTERVAL_MS") {
+    | None => 60_000
+    | Some(raw) =>
+      switch raw->parseWhole {
+      | Some(value) if value >= 0 => value
+      | _ =>
+        JsError.throwWithMessage(
+          `Invalid ENVIO_RESOLVERS_METADATA_INTERVAL_MS value: "${raw}". Expected a whole number of milliseconds, or 0 to disable.`,
+        )
+      }
+    }
+
+  // Required on every request to either route. Unset, the service cannot tell
+  // its callers apart from anything else that reaches the socket, and both
+  // routes take the role from the request body -- so anyone can claim `admin`.
+  let actionSecret = () => read("ENVIO_RESOLVERS_ACTION_SECRET")
+
+  // Read raw rather than through `Env.Hasura`, whose dev fallbacks would have
+  // this process apply metadata to a localhost Hasura nobody asked for. Only
+  // an endpoint someone set means "there is a Hasura to register with".
+  let hasuraEndpoint = () => read("HASURA_GRAPHQL_ENDPOINT")
+  let hasuraAdminSecret = () => read("HASURA_GRAPHQL_ADMIN_SECRET")
+
+  // Set where a transaction-mode pooler is the only way in. Those reject
+  // named prepared statements, so this gives up plan reuse.
+  let poolerBacked = () =>
+    switch read("ENVIO_RESOLVERS_POOLER_BACKED") {
+    | None
+    | Some("false") => false
+    | Some("true") => true
+    | Some(other) =>
+      JsError.throwWithMessage(
+        `Invalid ENVIO_RESOLVERS_POOLER_BACKED value: "${other}". Expected "true" or "false".`,
+      )
+    }
+}
+
 module Hasura = {
   // Disable it on HS indexer run, since we don't have Hasura credentials anyways
   // Also, it might be useful for some users who don't care about Hasura
@@ -180,7 +302,12 @@ module Hasura = {
       ~devFallback="http://localhost:8080/v1/metadata",
     )
 
-  let url = graphqlEndpoint->String.slice(~start=0, ~end=-("/v1/metadata"->String.length))
+  // Lazy on purpose. `graphqlEndpoint` is required in production, and a missing
+  // one arrives here as undefined -- slicing it threw a bare TypeError at import
+  // and killed the process before `EnvSafe.close` could say which variable was
+  // missing. Only the dev TUI reads this, so there is nothing to compute up
+  // front.
+  let url = () => graphqlEndpoint->String.slice(~start=0, ~end=-("/v1/metadata"->String.length))
 
   let role = envSafe->EnvSafe.get("HASURA_GRAPHQL_ROLE", S.string, ~devFallback="admin")
 

package/src/Env.res.mjs

@@ -3,6 +3,7 @@
 import * as EnvSafe from "./EnvSafe.res.mjs";
 import * as Logging from "./Logging.res.mjs";
 import * as Postgres from "./bindings/Postgres.res.mjs";
+import * as Stdlib_Int from "@rescript/runtime/lib/es6/Stdlib_Int.js";
 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 HyperSyncClient from "./sources/HyperSyncClient.res.mjs";
@@ -147,6 +148,124 @@ let ClickHouse = {
   databaseEngine: databaseEngine
 };
 
+let read$1 = ((k) => {
+      const v = process.env[k];
+      return v === undefined || v === "" ? undefined : v;
+    });
+
+function parseWhole(raw) {
+  let trimmed = raw.trim();
+  let value = Stdlib_Int.fromString(trimmed, undefined);
+  if (value !== undefined && trimmed === value.toString()) {
+    return value;
+  }
+}
+
+function readInt(key, fallback) {
+  let raw = read$1(key);
+  if (raw === undefined) {
+    return fallback;
+  }
+  let value = parseWhole(raw);
+  if (value !== undefined && value > 0) {
+    return value;
+  }
+  return Stdlib_JsError.throwWithMessage(`Invalid ` + key + ` value: "` + raw + `". Expected a positive whole number.`);
+}
+
+function port$1() {
+  let value = readInt("ENVIO_RESOLVERS_PORT", 9900);
+  if (value <= 65535) {
+    return value;
+  } else {
+    return Stdlib_JsError.throwWithMessage(`Invalid ENVIO_RESOLVERS_PORT value: "` + value.toString() + `". A TCP port is 1 to 65535.`);
+  }
+}
+
+function poolSize() {
+  return readInt("ENVIO_RESOLVERS_POOL_SIZE", 25);
+}
+
+function poolWaitTimeoutMs() {
+  return readInt("ENVIO_RESOLVERS_POOL_WAIT_TIMEOUT_MS", 10000);
+}
+
+function exposeErrors() {
+  let other = read$1("ENVIO_RESOLVERS_EXPOSE_ERRORS");
+  if (other === undefined) {
+    return false;
+  }
+  switch (other) {
+    case "false" :
+      return false;
+    case "true" :
+      return true;
+    default:
+      return Stdlib_JsError.throwWithMessage(`Invalid ENVIO_RESOLVERS_EXPOSE_ERRORS value: "` + other + `". Expected "true" or "false".`);
+  }
+}
+
+function publicUrl() {
+  return read$1("ENVIO_RESOLVERS_PUBLIC_URL");
+}
+
+function metadataIntervalMs() {
+  let raw = read$1("ENVIO_RESOLVERS_METADATA_INTERVAL_MS");
+  if (raw === undefined) {
+    return 60000;
+  }
+  let value = parseWhole(raw);
+  if (value !== undefined) {
+    if (value >= 0) {
+      return value;
+    } else {
+      return Stdlib_JsError.throwWithMessage(`Invalid ENVIO_RESOLVERS_METADATA_INTERVAL_MS value: "` + raw + `". Expected a whole number of milliseconds, or 0 to disable.`);
+    }
+  } else {
+    return Stdlib_JsError.throwWithMessage(`Invalid ENVIO_RESOLVERS_METADATA_INTERVAL_MS value: "` + raw + `". Expected a whole number of milliseconds, or 0 to disable.`);
+  }
+}
+
+function actionSecret() {
+  return read$1("ENVIO_RESOLVERS_ACTION_SECRET");
+}
+
+function hasuraEndpoint() {
+  return read$1("HASURA_GRAPHQL_ENDPOINT");
+}
+
+function hasuraAdminSecret() {
+  return read$1("HASURA_GRAPHQL_ADMIN_SECRET");
+}
+
+function poolerBacked() {
+  let other = read$1("ENVIO_RESOLVERS_POOLER_BACKED");
+  if (other === undefined) {
+    return false;
+  }
+  switch (other) {
+    case "false" :
+      return false;
+    case "true" :
+      return true;
+    default:
+      return Stdlib_JsError.throwWithMessage(`Invalid ENVIO_RESOLVERS_POOLER_BACKED value: "` + other + `". Expected "true" or "false".`);
+  }
+}
+
+let Resolvers = {
+  port: port$1,
+  poolSize: poolSize,
+  poolWaitTimeoutMs: poolWaitTimeoutMs,
+  exposeErrors: exposeErrors,
+  publicUrl: publicUrl,
+  metadataIntervalMs: metadataIntervalMs,
+  actionSecret: actionSecret,
+  hasuraEndpoint: hasuraEndpoint,
+  hasuraAdminSecret: hasuraAdminSecret,
+  poolerBacked: poolerBacked
+};
+
 let enabled = EnvSafe.get(envSafe, "ENVIO_HASURA", S$RescriptSchema.bool, undefined, true, undefined, undefined);
 
 let s = EnvSafe.get(envSafe, "ENVIO_HASURA_RESPONSE_LIMIT", S$RescriptSchema.option(S$RescriptSchema.int), undefined, undefined, undefined, undefined);
@@ -155,7 +274,9 @@ let responseLimit = s !== undefined ? s : EnvSafe.get(envSafe, "HASURA_RESPONSE_
 
 let graphqlEndpoint = EnvSafe.get(envSafe, "HASURA_GRAPHQL_ENDPOINT", S$RescriptSchema.string, undefined, undefined, "http://localhost:8080/v1/metadata", undefined);
 
-let url = graphqlEndpoint.slice(0, -"/v1/metadata".length | 0);
+function url() {
+  return graphqlEndpoint.slice(0, -"/v1/metadata".length | 0);
+}
 
 let role = EnvSafe.get(envSafe, "HASURA_GRAPHQL_ROLE", S$RescriptSchema.string, undefined, undefined, "admin", undefined);
 
@@ -240,6 +361,7 @@ export {
   logStrategy,
   Db,
   ClickHouse,
+  Resolvers,
   Hasura,
   Configurable,
   ThrottleWrites,