envio 3.9.0 → 3.10.0-subgraph

package/src/subgraph/scope.ts

@@ -0,0 +1,66 @@
+import { AsyncLocalStorage } from "node:async_hooks";
+
+/** What a wrapper is doing when it runs the mapping. */
+export type Mode = "handler" | "register";
+
+export type SubgraphSchema = {
+  timestampFields: Record<string, string[]>;
+  bytesIdEntities: string[];
+  entityListFields: Record<string, string[]>;
+  entityFields: Record<string, string[]>;
+  entityRefFields: Record<string, string[]>;
+  /** Each field as the subgraph schema declares it, which is what a mapping reads. */
+  entityFieldTypes: Record<
+    string,
+    Record<string, { kind: string; target?: string; derivedFrom?: string; list: boolean }>
+  >;
+};
+
+export type Scope = {
+  /** envio's handler or contractRegister context. */
+  context: any;
+  event: any;
+  mode: Mode;
+  schema: SubgraphSchema;
+  dataSource: {
+    name: string;
+    address: string;
+    chainId: number;
+    network: string;
+    /** The manifest's `context` entries, as `dataSource.context()` serves them. */
+    context: Record<string, { type: string; data: string }>;
+  };
+  /** Addresses already registered this round, so replays stay idempotent. */
+  registered: Set<string>;
+  /**
+   * Host results the register pass has resolved, keyed by effect and input.
+   * The register pass has no envio context to run effects through, so it
+   * replays the mapping itself and answers from here (§5, register mode).
+   */
+  resolved?: Map<string, { value?: unknown; error?: unknown }>;
+  /** Lookups the current register round is waiting on. */
+  awaiting?: Promise<unknown>[];
+  /** The block a contract call is evaluated against, as graph-node does. */
+  blockNumber: number;
+  /** The mapping module, so `ipfs.map` can reach the callback it names. */
+  mappingExports: Record<string, any>;
+};
+
+const storage = new AsyncLocalStorage<Scope>();
+
+export function runInScope<T>(scope: Scope, fn: () => T): T {
+  return storage.run(scope, fn);
+}
+
+export function currentScope(): Scope {
+  const scope = storage.getStore();
+  if (!scope) {
+    throw new Error(
+      "A graph-ts API was called outside of a mapping handler. Envio Subgraph " +
+        "runs mappings inside a scope that carries the event and the store; " +
+        "calling into graph-ts from module top-level or from a detached " +
+        "callback escapes it.",
+    );
+  }
+  return scope;
+}

package/svm.schema.json

@@ -352,14 +352,14 @@
           ]
         },
         "idl": {
-          "description": "Optional path (relative to config.yaml) to an Anchor IDL JSON file. When present, codegen parses the IDL and derives `accounts`/`args` for every named instruction. Mutually exclusive with per-instruction `accounts`/`args` overrides.",
+          "description": "Optional path (relative to config.yaml) to an IDL JSON file (Anchor 0.30+, legacy Anchor, Shank, or Codama). When present, every usable instruction is in the catalog and `onInstruction` selects by name. Omit YAML `instructions` to take that catalog as-is. A YAML row overwrites the IDL instruction of the same name, or adds a name the IDL did not declare.",
           "type": [
             "string",
             "null"
           ]
         },
         "instructions": {
-          "description": "A list of instructions that should be indexed on this program.",
+          "description": "Instructions to index. With `idl:`, omit this list to take the full usable IDL catalog. A YAML row overwrites the IDL instruction of the same name, or adds a new name to the catalog, and must set `discriminator` plus both `accounts` and `args`. Without `idl:`, omit `discriminator` to match every instruction of the program; set both `accounts` and `args`, or omit both.",
           "type": "array",
           "items": {
             "$ref": "#/$defs/Instruction"
@@ -369,8 +369,7 @@
       "additionalProperties": false,
       "required": [
         "name",
-        "program_id",
-        "instructions"
+        "program_id"
       ]
     },
     "Instruction": {
@@ -381,30 +380,12 @@
           "type": "string"
         },
         "discriminator": {
-          "description": "Hex-encoded instruction-data prefix used as the discriminator (\"0x\" optional). Must be 1, 2, 4, or 8 bytes after decoding. An 8-byte value matches the standard Anchor discriminator.",
+          "description": "Hex-encoded instruction-data prefix used as the discriminator (\"0x\" optional), of any whole number of bytes; an 8-byte value matches the standard Anchor discriminator. With `idl:` on the program, this field is required on every YAML row. Without `idl:`, omit it to match every instruction of the program. Every instruction whose prefix an on-chain call carries receives it, so a program-wide entry fires alongside a keyed one, and two entries may share a prefix (say, the layouts before and after a program upgrade): each decodes with its own `args`, and one whose layout rejects the data is skipped for that call.",
           "type": [
             "string",
             "null"
           ]
         },
-        "is_inner": {
-          "description": "Filter on inner-vs-outer instructions. None / absent matches both.",
-          "type": [
-            "boolean",
-            "null"
-          ]
-        },
-        "account_filters": {
-          "description": "Optional positional account filters. Two shapes are accepted: a flat list of `{position, values}` entries (AND across positions, OR within `values`); or `{any_of: [[...]] }`, a list of AND-groups that are OR-ed together. Positions must be in 0..=5; positions 6..=9 are reserved for a future extension.",
-          "anyOf": [
-            {
-              "$ref": "#/$defs/AccountFilters"
-            },
-            {
-              "type": "null"
-            }
-          ]
-        },
         "accounts": {
           "description": "Optional positional account names. The Nth entry names account slot N on the dispatched instruction; surfaces as `instruction.accounts.<name>` when `fields.instruction` includes `accounts`.",
           "type": [
@@ -416,7 +397,7 @@
           }
         },
         "args": {
-          "description": "Optional Borsh argument schema. Each entry names one arg and gives its type; the decoder walks the instruction data after the discriminator in declared order. Mutually exclusive with the program-level `idl` field.",
+          "description": "Optional Borsh argument schema. Each entry names one arg and gives its type; the decoder walks the instruction data after the discriminator in declared order. Must be set together with `accounts` when either is present.",
           "type": [
             "array",
             "null"
@@ -431,62 +412,6 @@
         "name"
       ]
     },
-    "AccountFilters": {
-      "anyOf": [
-        {
-          "type": "array",
-          "items": {
-            "$ref": "#/$defs/AccountFilter"
-          }
-        },
-        {
-          "$ref": "#/$defs/AnyOfAccountFilters"
-        }
-      ]
-    },
-    "AccountFilter": {
-      "type": "object",
-      "properties": {
-        "position": {
-          "description": "Account position within the instruction (0..=5).",
-          "type": "integer",
-          "format": "uint8",
-          "minimum": 0,
-          "maximum": 255
-        },
-        "values": {
-          "description": "Allowed base58 pubkeys for this account position.",
-          "type": "array",
-          "items": {
-            "type": "string"
-          }
-        }
-      },
-      "additionalProperties": false,
-      "required": [
-        "position",
-        "values"
-      ]
-    },
-    "AnyOfAccountFilters": {
-      "type": "object",
-      "properties": {
-        "any_of": {
-          "description": "A non-empty list of AND-groups. Each group is itself a non-empty list of `{position, values}` entries that must all match the same instruction. An instruction matches `any_of` when any one group matches.",
-          "type": "array",
-          "items": {
-            "type": "array",
-            "items": {
-              "$ref": "#/$defs/AccountFilter"
-            }
-          }
-        }
-      },
-      "additionalProperties": false,
-      "required": [
-        "any_of"
-      ]
-    },
     "ArgDef": {
       "description": "One named argument of an instruction. Mirrors\n`hypersync_client_solana::decode::NamedField`.",
       "type": "object",
@@ -591,7 +516,7 @@
           "additionalProperties": false
         },
         {
-          "description": "Reference to a nominal type defined in the program-level\n`defined_types` registry (populated from an Anchor IDL `types:`\nblock or the bundled-Metaplex registry).",
+          "description": "Reference to a nominal type defined in the program-level\n`defined_types` registry (populated from an Anchor IDL `types:`\nblock).",
           "type": "object",
           "properties": {
             "defined": {