envio 3.9.0-resolvers.0 → 3.10.0

package/evm.schema.json

@@ -29,13 +29,6 @@
         "null"
       ]
     },
-    "resolvers": {
-      "description": "Optional relative path to the custom GraphQL resolvers, either a single module (e.g. 'src/Resolvers.ts') or a directory (e.g. 'src/resolvers'), in which case every .js/.mjs/.ts file beneath it is loaded, tests excluded. The resolvers they export are served as additional root fields on the indexer's GraphQL endpoint.",
-      "type": [
-        "string",
-        "null"
-      ]
-    },
     "full_batch_size": {
       "description": "Target number of events to be processed per batch. Set it to smaller number if you have many Effect API calls which are slow to resolve and can't be batched. (Default: 5000)",
       "type": [
@@ -133,6 +126,17 @@
           "type": "null"
         }
       ]
+    },
+    "bytes_type": {
+      "description": "How the `Bytes` scalar in schema.graphql is represented. `hex` keeps 0x-prefixed hex strings stored as text, `uint8array` exposes `Uint8Array` values in handlers and stores raw bytes (BYTEA in Postgres, String in ClickHouse). (default: hex)",
+      "anyOf": [
+        {
+          "$ref": "#/$defs/BytesType"
+        },
+        {
+          "type": "null"
+        }
+      ]
     }
   },
   "additionalProperties": false,
@@ -765,6 +769,21 @@
         "checksum",
         "lowercase"
       ]
+    },
+    "BytesType": {
+      "description": "How the schema.graphql `Bytes` scalar reaches handlers and storage.",
+      "oneOf": [
+        {
+          "description": "`0x`-prefixed hex strings, stored as text.",
+          "type": "string",
+          "const": "hex"
+        },
+        {
+          "description": "`Uint8Array` values, stored as raw bytes (`BYTEA` in Postgres, `String` in ClickHouse).",
+          "type": "string",
+          "const": "uint8array"
+        }
+      ]
     }
   }
 }

package/fuel.schema.json

@@ -29,13 +29,6 @@
         "null"
       ]
     },
-    "resolvers": {
-      "description": "Optional relative path to the custom GraphQL resolvers, either a single module (e.g. 'src/Resolvers.ts') or a directory (e.g. 'src/resolvers'), in which case every .js/.mjs/.ts file beneath it is loaded, tests excluded. The resolvers they export are served as additional root fields on the indexer's GraphQL endpoint.",
-      "type": [
-        "string",
-        "null"
-      ]
-    },
     "full_batch_size": {
       "description": "Target number of events to be processed per batch. Set it to smaller number if you have many Effect API calls which are slow to resolve and can't be batched. (Default: 5000)",
       "type": [
@@ -90,6 +83,17 @@
         "boolean",
         "null"
       ]
+    },
+    "bytes_type": {
+      "description": "How the `Bytes` scalar in schema.graphql is represented. `hex` keeps 0x-prefixed hex strings stored as text, `uint8array` exposes `Uint8Array` values in handlers and stores raw bytes (BYTEA in Postgres, String in ClickHouse). (default: hex)",
+      "anyOf": [
+        {
+          "$ref": "#/$defs/BytesType"
+        },
+        {
+          "type": "null"
+        }
+      ]
     }
   },
   "additionalProperties": false,
@@ -471,6 +475,21 @@
           }
         }
       ]
+    },
+    "BytesType": {
+      "description": "How the schema.graphql `Bytes` scalar reaches handlers and storage.",
+      "oneOf": [
+        {
+          "description": "`0x`-prefixed hex strings, stored as text.",
+          "type": "string",
+          "const": "hex"
+        },
+        {
+          "description": "`Uint8Array` values, stored as raw bytes (`BYTEA` in Postgres, `String` in ClickHouse).",
+          "type": "string",
+          "const": "uint8array"
+        }
+      ]
     }
   }
 }

package/index.d.ts

@@ -1423,7 +1423,7 @@ type SvmSelectedInstruction<Fields extends SvmFieldsSelection, ProgInstr> = {
   readonly instructionName: string;
   readonly discriminator: string;
   readonly programId: SvmInstrField<Fields, "programId", string>;
-  readonly data: SvmInstrField<Fields, "data", string>;
+  readonly data: SvmInstrField<Fields, "data", Uint8Array>;
   readonly path: SvmInstrField<Fields, "path", readonly number[]>;
   readonly isInner: SvmInstrField<Fields, "isInner", boolean>;
   readonly args: SvmInstrField<
@@ -1937,8 +1937,8 @@ type SvmSimulateItem<Config extends IndexerConfigTypes = GlobalConfig> =
             path?: readonly number[];
             /** Override the program id. Defaults to the configured `program_id`. */
             programId?: string;
-            /** Raw instruction data, `0x`-prefixed hex. */
-            data?: string;
+            /** Raw instruction data. Defaults to the configured discriminator bytes. */
+            data?: Uint8Array;
             /** Whether this is a CPI-invoked inner instruction. */
             isInner?: boolean;
             /** Decoded args. Keys match the instruction's arg names. */
@@ -2012,10 +2012,10 @@ type ConfigEntities<Config extends IndexerConfigTypes = GlobalConfig> =
 type PerChainEntityNames<Config extends IndexerConfigTypes = GlobalConfig> =
   Config extends { perChainEntities: infer Names extends string } ? Names : never;
 
-/** The row shape chain-agnostic APIs exchange. A per-chain entity's row is
- * only identified together with its chain, so the chain id travels alongside
- * the entity fields. */
-type ChainScopedEntityRow<
+/** The row shape the chain-agnostic test-indexer operations exchange. A
+ * per-chain entity's row is only identified together with its chain, so the
+ * chain id travels alongside the entity fields. */
+type TestIndexerEntityRow<
   Config extends IndexerConfigTypes,
   Name,
   Entity
@@ -2209,7 +2209,7 @@ export type TestIndexerFromConfig<Config extends IndexerConfigTypes = GlobalConf
 } & SingleEcosystemTestChains<Config> & {
   /** Entity operations for direct manipulation outside of handlers. */
   readonly [K in keyof ConfigEntities<Config>]: TestIndexerEntityOperations<
-    ChainScopedEntityRow<Config, K, ConfigEntities<Config>[K]>
+    TestIndexerEntityRow<Config, K, ConfigEntities<Config>[K]>
   >;
 };
 
@@ -2283,244 +2283,6 @@ export type EnumName = keyof EnumsT & string;
 /** Lookup an enum value type by name (e.g. `Enum<"AccountType">`). */
 export type Enum<TName extends EnumName> = EnumsT[TName];
 
-// ============== Custom Resolver Types ==============
-
-/** Handle for a custom GraphQL resolver created via {@link createResolver}. */
-export declare abstract class Resolver<Args, Output> {
-  protected opaque: Args | Output;
-}
-
-/** The selection the caller asked for: field names and their nesting, with
- *  aliases and fragments already resolved away. A resolver may use it to skip
- *  work it wasn't asked for — the response is projected against the declared
- *  schema either way, so correctness never depends on honouring it. */
-export type ResolverSelection = { readonly [field: string]: ResolverSelection };
-
-/** Request metadata, forwarded by envio-serve. */
-export type ResolverContext = {
-  /** The role the operation was executed under. `admin: true` resolvers are
-   *  only reachable as `"admin"`. */
-  readonly role: "public" | "admin";
-  /** Correlates this field's work with the operation it belongs to. */
-  readonly requestId: string;
-  /** W3C trace context of the incoming request, when the caller sent one. */
-  readonly traceparent?: string;
-};
-
-/** How far a chain has been indexed. Read it to refuse to answer from a stale
- *  index — `sourceBlock - progressBlock` is how far behind the head the
- *  indexer is. */
-export type ChainHeight = {
-  readonly chainId: number;
-  /** `"evm"`, `"fuel"` or `"svm"`. Chain ids are only unique within one. */
-  readonly ecosystem: string;
-  readonly startBlock: number;
-  readonly endBlock: number | null;
-  /** The latest block seen on the chain. */
-  readonly sourceBlock: number;
-  /** The latest block fetched from the source. */
-  readonly bufferBlock: number;
-  /** The latest block whose events have been processed and committed. */
-  readonly progressBlock: number;
-  /** When the chain first caught up to the head, or null while it hasn't. */
-  readonly readyAt: Date | null;
-  readonly isReady: boolean;
-};
-
-/** Raw SQL, run under the resolver's `statement_timeout` and against its
- *  bounded pool. */
-export type ResolverSql = {
-  /** ``db.sql`select 1` `` */
-  <Row = Record<string, unknown>>(
-    strings: TemplateStringsArray,
-    ...values: readonly unknown[]
-  ): Promise<Row[]>;
-  /** `db.sql.unsafe(text, params)` — the direct lift for a query built as a
-   *  string with positional parameters. */
-  unsafe<Row = Record<string, unknown>>(
-    text: string,
-    params?: readonly unknown[],
-    options?: { readonly prepare?: boolean }
-  ): Promise<Row[]>;
-};
-
-/** Options accepted by `db.find`. */
-export type ResolverFindOptions<Entity> = {
-  /** Filter by field, with the same operators as `context.<Entity>.getWhere`.
-   *  Unlike `getWhere`, any field can be filtered on here — it is a query
-   *  against the table, so an unindexed field is a slow one, not an error. */
-  readonly where?: GetWhereFilter<Entity>;
-  readonly orderBy?: readonly {
-    readonly field: keyof Entity & string;
-    readonly direction: "asc" | "desc";
-  }[];
-  readonly limit?: number;
-  readonly offset?: number;
-};
-
-/** The database a resolver reads through. Every query it runs carries the
- *  resolver's `timeoutMs` as a `statement_timeout` and takes one of the
- *  process's bounded connections. */
-export type ResolverDb<Config extends IndexerConfigTypes = GlobalConfig> = {
-  /** Entities matching `where`, decoded exactly as a handler sees them. */
-  readonly find: <Name extends keyof ConfigEntities<Config> & string>(
-    entityName: Name,
-    options?: ResolverFindOptions<
-      ChainScopedEntityRow<Config, Name, ConfigEntities<Config>[Name]>
-    >
-  ) => Promise<
-    ChainScopedEntityRow<Config, Name, ConfigEntities<Config>[Name]>[]
-  >;
-  /** One entity by id, or null. Not available for per-chain entities, whose
-   *  key is the id together with a chain — use {@link ResolverDb.find}. */
-  readonly get: <
-    Name extends Exclude<
-      keyof ConfigEntities<Config> & string,
-      PerChainEntityNames<Config>
-    >
-  >(
-    entityName: Name,
-    id: EntityId<ConfigEntities<Config>[Name]>
-  ) => Promise<ConfigEntities<Config>[Name] | null>;
-  /** Raw SQL, for what the loaders don't express. */
-  readonly sql: ResolverSql;
-  /** The Postgres schema the indexer's tables live in. Raw SQL has to qualify
-   *  table names with it — it is not `"public"` on a hosted deployment. */
-  readonly pgSchema: string;
-  /** Several queries on one connection, under one timeout. */
-  readonly transaction: <T>(work: (sql: ResolverSql) => Promise<T>) => Promise<T>;
-  /** How far each chain has been indexed, keyed by chain id. */
-  readonly chainHeights: () => Promise<Record<string, ChainHeight>>;
-};
-
-/** Arguments passed to a {@link Resolver}'s handler. */
-export type ResolverHandlerArgs<
-  Args,
-  Config extends IndexerConfigTypes = GlobalConfig
-> = {
-  /** Coerced and validated against the declared arg schemas before the
-   *  resolver is reached. */
-  readonly args: Args;
-  readonly db: ResolverDb<Config>;
-  readonly selection: ResolverSelection;
-  readonly ctx: ResolverContext;
-};
-
-/**
- * Declares a custom GraphQL resolver: a root query field served alongside the
- * generated entity fields, backed by TypeScript in this project.
- *
- * Arguments and result are declared with the same `S` schemas effects use, and
- * the GraphQL types are derived from them. A field is non-null unless its
- * schema is optional. Object types must be named with {@link defineType} —
- * GraphQL has no anonymous types.
- *
- * ```ts
- * export const marketsAprByPeriod = createResolver({
- *   name: "marketsAprByPeriod",
- *   args: { periodStart: S.int32, periodEnd: S.int32 },
- *   output: S.array(defineType("MarketApr", { marketAddress: S.string })),
- *   timeoutMs: 30_000,
- *   handler: async ({ args, db }) => db.find("MarketInfo"),
- * });
- * ```
- */
-export function createResolver<
-  // Both are schemas at runtime: `createResolver` reads `output.t` and walks
-  // every argument with `toGraphQLType` while the module is being imported, so
-  // anything else fails at indexer startup rather than in the editor.
-  AS extends Record<string, Sury.Schema<unknown>>,
-  OS extends Sury.Schema<unknown>,
-  A = UnknownToOutput<AS>,
-  O = UnknownToOutput<OS>,
-  // A hack to enforce that the inferred return type matches the output schema.
-  R extends O = O
->(options: {
-  /** The GraphQL field name. Must not collide with a generated one. */
-  readonly name: string;
-  /** Shown in the schema, for the people querying it. */
-  readonly description?: string;
-  /** Argument schemas, keyed by argument name. */
-  readonly args?: AS;
-  /** The result schema. Determines the field's GraphQL type. */
-  readonly output: OS;
-  /** Register the field on the admin schema only: it stays out of public
-   *  introspection and is unexecutable without the admin secret. */
-  readonly admin?: boolean;
-  /** The `statement_timeout` every query this resolver runs is bounded by.
-   *  Required: it is the only thing bounding a runaway query. */
-  readonly timeoutMs: number;
-  readonly handler: (args: ResolverHandlerArgs<A>) => Promise<R>;
-}): Resolver<A, O>;
-
-/**
- * Thrown by a resolver to put a specific error on the client's response.
- *
- * Anything else a handler throws is reported as an internal failure with its
- * message withheld — a driver error can carry a connection string, and the
- * caller is the public internet — so this is how a resolver says more than
- * that. envio-serve carries the extensions through unchanged.
- *
- * ```ts
- * throw new ResolverError("Service is syncing", {
- *   code: "SERVICE_UNAVAILABLE",
- *   httpStatus: 503,
- * });
- * ```
- */
-export declare class ResolverError extends Error {
-  constructor(
-    message: string,
-    options?: {
-      /** Becomes `extensions.code`. Defaults to `"INTERNAL_SERVER_ERROR"`. */
-      readonly code?: string;
-      /** Becomes `extensions.http.status`. */
-      readonly httpStatus?: number;
-      /** Merged into `extensions` alongside `code`. */
-      readonly extensions?: Record<string, unknown>;
-    }
-  );
-  readonly code: string;
-  readonly httpStatus?: number;
-  readonly extensions?: Record<string, unknown>;
-}
-
-/** Names a schema so it can appear in the GraphQL schema as an object type. */
-export function defineType<F extends Record<string, unknown>>(
-  name: string,
-  fields: F
-): Sury.Schema<UnknownToOutput<F>>;
-
-/**
- * Names a schema that appears in an argument.
- *
- * GraphQL keeps input and output types in a separate namespace from object
- * types, so a `where` argument is declared with this rather than with
- * {@link defineType}.
- */
-export function defineInput<F extends Record<string, unknown>>(
-  name: string,
-  fields: F
-): Sury.Schema<UnknownToOutput<F>>;
-
-/** Every resolver declared so far, in declaration order. */
-export function getRegisteredResolvers(): readonly Resolver<unknown, unknown>[];
-
-/** The manifest and SDL for everything declared so far. */
-export function buildRegisteredManifest(): { manifest: unknown; sdl: string };
-
-/** Names a schema representing a GraphQL enum. */
-export function defineEnum<const V extends readonly string[]>(
-  name: string,
-  values: V
-): Sury.Schema<V[number]>;
-
-/** Names a schema representing a custom GraphQL scalar, such as `BigInt`. */
-export function defineScalar<T>(
-  name: string,
-  schema: Sury.Schema<T>
-): Sury.Schema<T>;
-
 // ============== Runtime values ==============
 
 /** The indexer instance. Register handlers with `indexer.onEvent`,

package/index.js

@@ -9,16 +9,6 @@ import { schema as bigDecimalSchema } from "./src/bindings/BigDecimal.res.mjs";
 
 export * from "./src/Envio.res.mjs";
 export { indexer, createTestIndexer } from "./src/Api.res.mjs";
-export {
-  createResolver,
-  defineType,
-  defineInput,
-  defineEnum,
-  defineScalar,
-  getRegisteredResolvers,
-  buildRegisteredManifest,
-  ResolverError,
-} from "./src/resolvers/index.js";
 export { default as BigDecimal } from "bignumber.js";
 
 // Important! Should match the index.d.ts file

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "envio",
-  "version": "3.9.0-resolvers.0",
+  "version": "3.10.0",
   "type": "module",
   "description": "A latency and sync speed optimized, developer friendly blockchain data indexer.",
   "bin": "./bin.mjs",
@@ -68,10 +68,10 @@
     "tsx": "4.21.0"
   },
   "optionalDependencies": {
-    "envio-linux-x64": "3.9.0-resolvers.0",
-    "envio-linux-x64-musl": "3.9.0-resolvers.0",
-    "envio-linux-arm64": "3.9.0-resolvers.0",
-    "envio-darwin-x64": "3.9.0-resolvers.0",
-    "envio-darwin-arm64": "3.9.0-resolvers.0"
+    "envio-linux-x64": "3.10.0",
+    "envio-linux-x64-musl": "3.10.0",
+    "envio-linux-arm64": "3.10.0",
+    "envio-darwin-x64": "3.10.0",
+    "envio-darwin-arm64": "3.10.0"
   }
 }

package/src/Bin.res

@@ -18,13 +18,11 @@ type startCmd = {
 }
 type migrateCmd = {reset: bool, config: JSON.t}
 type dropSchemaCmd = {config: JSON.t}
-type resolversCmd = {mode: string, cwd: string, env: dict<JSON.t>, config: JSON.t}
 
 type command =
   | Start(startCmd)
   | Migrate(migrateCmd)
   | DropSchema(dropSchemaCmd)
-  | Resolvers(resolversCmd)
 
 let decodeCommand = (json: JSON.t): command => {
   let obj = switch json->JSON.Decode.object {
@@ -39,7 +37,6 @@ let decodeCommand = (json: JSON.t): command => {
   | "start" => Start(json->(Utils.magic: JSON.t => startCmd))
   | "migrate" => Migrate(json->(Utils.magic: JSON.t => migrateCmd))
   | "drop-schema" => DropSchema(json->(Utils.magic: JSON.t => dropSchemaCmd))
-  | "resolvers" => Resolvers(json->(Utils.magic: JSON.t => resolversCmd))
   | other => JsError.throwWithMessage(`Unknown command kind: ${other}`)
   }
 }
@@ -64,12 +61,6 @@ let run = async args => {
         Config.prime(config)
         processChdir(cwd)
         applyEnv(env)
-        // `envio dev` only — see ResolverProcess.startForDev. A deployment
-        // runs the resolvers as their own Deployment, never from here.
-        let loaded = Config.load()
-        if loaded.isDev {
-          let _ = await ResolverProcess.startForDev(~config=loaded, ~projectRoot=cwd)
-        }
         await Main.start(~reset)
       | Migrate({reset, config}) =>
         Config.prime(config)
@@ -77,44 +68,6 @@ let run = async args => {
       | DropSchema({config}) =>
         Config.prime(config)
         await Main.dropSchema()
-      | Resolvers({mode, cwd, env, config}) =>
-        Config.prime(config)
-        processChdir(cwd)
-        applyEnv(env)
-        switch mode {
-        | "manifest" => await ResolverProcess.writeManifest(~config=Config.load(), ~projectRoot=cwd)
-        | "metadata" =>
-          let handlerUrl = switch Env.Resolvers.publicUrl() {
-          | Some(url) => url
-          | None =>
-            JsError.throwWithMessage(
-              "ENVIO_RESOLVERS_PUBLIC_URL is not set. It is the URL Hasura posts to and is baked into every action, so the metadata cannot be printed without it.",
-            )
-          }
-          let metadata = await ResolverProcess.metadataJson(
-            ~config=Config.load(),
-            ~projectRoot=cwd,
-            ~handlerUrl,
-          )
-          // stdout, so it pipes into `hasura metadata apply` or `jq` rather
-          // than being buried in the log stream.
-          Console.log(JSON.stringify(metadata, ~space=2))
-        | "migrate" =>
-          let {applied, reasons} = await ResolverProcess.migrate(
-            ~config=Config.load(),
-            ~projectRoot=cwd,
-          )
-          Logging.info(
-            applied
-              ? `Updated Hasura to match these resolvers: ${reasons->Array.join("; ")}`
-              : "Hasura already matches these resolvers; nothing to update",
-          )
-        // Serving keeps the event loop alive on its own, so returning here
-        // leaves the process running rather than exiting.
-        | _ =>
-          let running = await ResolverProcess.serve(~config=Config.load(), ~projectRoot=cwd)
-          running->ResolverProcess.handleSignals
-        }
       }
     }
   } catch {

package/src/Bin.res.mjs

@@ -1,6 +1,5 @@
 // Generated by ReScript, PLEASE EDIT WITH CARE
 
-import * as Env from "./Env.res.mjs";
 import * as Core from "./Core.res.mjs";
 import * as Main from "./Main.res.mjs";
 import * as Utils from "./Utils.res.mjs";
@@ -12,7 +11,6 @@ import * as Stdlib_JSON from "@rescript/runtime/lib/es6/Stdlib_JSON.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_JsError from "@rescript/runtime/lib/es6/Stdlib_JsError.js";
-import * as ResolverProcess from "./resolvers/ResolverProcess.res.mjs";
 import * as Primitive_exceptions from "@rescript/runtime/lib/es6/Primitive_exceptions.js";
 
 let setEnvVar = ((k, v) => { process.env[k] = v; });
@@ -38,11 +36,6 @@ function decodeCommand(json) {
         TAG: "Migrate",
         _0: json
       };
-    case "resolvers" :
-      return {
-        TAG: "Resolvers",
-        _0: json
-      };
     case "start" :
       return {
         TAG: "Start",
@@ -72,14 +65,9 @@ async function run(args) {
     switch (match.TAG) {
       case "Start" :
         let match$1 = match._0;
-        let cwd = match$1.cwd;
         Config.prime(match$1.config);
-        process.chdir(cwd);
+        process.chdir(match$1.cwd);
         applyEnv(match$1.env);
-        let loaded = Config.load();
-        if (loaded.isDev) {
-          await ResolverProcess.startForDev(loaded, cwd);
-        }
         return await Main.start(undefined, match$1.reset, undefined, undefined, undefined);
       case "Migrate" :
         let match$2 = match._0;
@@ -88,27 +76,6 @@ async function run(args) {
       case "DropSchema" :
         Config.prime(match._0.config);
         return await Main.dropSchema();
-      case "Resolvers" :
-        let match$3 = match._0;
-        let cwd$1 = match$3.cwd;
-        Config.prime(match$3.config);
-        process.chdir(cwd$1);
-        applyEnv(match$3.env);
-        switch (match$3.mode) {
-          case "manifest" :
-            return await ResolverProcess.writeManifest(Config.load(), cwd$1);
-          case "metadata" :
-            let url = Env.Resolvers.publicUrl();
-            let handlerUrl = url !== undefined ? url : Stdlib_JsError.throwWithMessage("ENVIO_RESOLVERS_PUBLIC_URL is not set. It is the URL Hasura posts to and is baked into every action, so the metadata cannot be printed without it.");
-            let metadata = await ResolverProcess.metadataJson(Config.load(), cwd$1, handlerUrl);
-            console.log(JSON.stringify(metadata, undefined, 2));
-            return;
-          case "migrate" :
-            let match$4 = await ResolverProcess.migrate(Config.load(), cwd$1);
-            return Logging.info(match$4.applied ? `Updated Hasura to match these resolvers: ` + match$4.reasons.join("; ") : "Hasura already matches these resolvers; nothing to update");
-          default:
-            return ResolverProcess.handleSignals(await ResolverProcess.serve(Config.load(), cwd$1, undefined, undefined, undefined, undefined));
-        }
     }
   } catch (raw_exn) {
     let exn = Primitive_exceptions.internalToException(raw_exn);