envio 3.15.0-sidecars.3 → 3.15.0

package/evm.schema.json

@@ -39,7 +39,7 @@
       "minimum": 0
     },
     "storage": {
-      "description": "Storage backends the indexer writes data to. Defaults to Postgres when omitted. Set `clickhouse: true` to additionally sync the indexed data to ClickHouse. Mark a backend with `default: true` to store entities that don't have an @storage directive in the schema, e.g. `clickhouse: {default: true}`.",
+      "description": "Where the indexer keeps entities. Postgres is always enabled and keeps them by default. Set `clickhouse: true` and mark an entity `@storage(clickhouse: true)` in the schema to keep it in ClickHouse, or set `clickhouse: {default: true}` to keep every unmarked entity there. Entities kept only in ClickHouse aren't served over GraphQL.",
       "anyOf": [
         {
           "$ref": "#/$defs/StorageConfig"
@@ -56,40 +56,6 @@
         "null"
       ]
     },
-    "sidecar": {
-      "description": "A sidecar: your own long-running TypeScript process, run next to the indexer by `envio sidecar` (and started by `envio dev`). Handlers call its functions through `context.sidecar.<name>(input)` without waiting.",
-      "anyOf": [
-        {
-          "$ref": "#/$defs/SidecarConfig"
-        },
-        {
-          "type": "null"
-        }
-      ]
-    },
-    "resolvers": {
-      "description": "Extra root query fields in the GraphQL API, answered by your sidecar or a webhook. Each one is published as a Hasura action, so Hasura and envio serve call the handler with Hasura's action payload.",
-      "type": [
-        "object",
-        "null"
-      ],
-      "additionalProperties": {
-        "$ref": "#/$defs/ResolverConfig"
-      }
-    },
-    "types": {
-      "description": "Output object types for `resolvers:`: type name to a map of field name to GraphQL type string (for example `address: \"String!\"`).",
-      "type": [
-        "object",
-        "null"
-      ],
-      "additionalProperties": {
-        "type": "object",
-        "additionalProperties": {
-          "type": "string"
-        }
-      }
-    },
     "ecosystem": {
       "description": "Ecosystem of the project.",
       "anyOf": [
@@ -171,6 +137,13 @@
           "type": "null"
         }
       ]
+    },
+    "strict_hex_type": {
+      "description": "If true, the `Hex` type of bytes params, block and transaction hashes and `Bytes` fields is `0x${string}` instead of `string` (default: false)",
+      "type": [
+        "boolean",
+        "null"
+      ]
     }
   },
   "additionalProperties": false,
@@ -183,7 +156,7 @@
       "type": "object",
       "properties": {
         "postgres": {
-          "description": "Whether to use Postgres as a storage backend (default: true). Accepts a boolean or an options object (the object form implies the backend is enabled).",
+          "description": "Always enabled. Accepts `true` or an options object.",
           "anyOf": [
             {
               "type": [
@@ -195,7 +168,7 @@
               "type": "object",
               "properties": {
                 "default": {
-                  "description": "Whether entities without an @storage directive are stored in this backend (default: true when Postgres is the only enabled backend, false otherwise).",
+                  "description": "Whether entities without an @storage directive are kept here (default: true, unless `clickhouse: {default: true}` is set).",
                   "type": [
                     "boolean",
                     "null"
@@ -219,7 +192,7 @@
           ]
         },
         "clickhouse": {
-          "description": "Whether to additionally sync the indexed data to ClickHouse. Requires Postgres to be enabled (default: false). Accepts a boolean or an options object (the object form implies the backend is enabled).",
+          "description": "Whether to enable ClickHouse (default: false). Accepts a boolean or an options object.",
           "anyOf": [
             {
               "type": [
@@ -231,7 +204,7 @@
               "type": "object",
               "properties": {
                 "default": {
-                  "description": "Whether entities without an @storage directive are stored in this backend (default: false).",
+                  "description": "Whether entities without an @storage directive are kept here (default: false). Set it together with `postgres: {default: true}` to keep them in both.",
                   "type": [
                     "boolean",
                     "null"
@@ -256,118 +229,16 @@
         }
       },
       "additionalProperties": false,
-      "allOf": [
-        {
-          "not": {
-            "properties": {
-              "postgres": {
-                "const": false
-              }
-            },
-            "required": [
-              "postgres"
-            ]
+      "not": {
+        "properties": {
+          "postgres": {
+            "const": false
           }
         },
-        {
-          "if": {
-            "properties": {
-              "clickhouse": {
-                "anyOf": [
-                  {
-                    "const": true
-                  },
-                  {
-                    "type": "object"
-                  }
-                ]
-              }
-            },
-            "required": [
-              "clickhouse"
-            ]
-          },
-          "then": {
-            "properties": {
-              "postgres": {
-                "anyOf": [
-                  {
-                    "const": true
-                  },
-                  {
-                    "type": "object"
-                  }
-                ]
-              }
-            },
-            "required": [
-              "postgres"
-            ]
-          }
-        }
-      ]
-    },
-    "SidecarConfig": {
-      "type": "object",
-      "properties": {
-        "contract": {
-          "description": "Relative path to the contract module: `export default defineSidecar({ functions, webhooks })`. Schemas only, since both the indexer and the sidecar load it. Types `context.sidecar`.",
-          "type": "string"
-        },
-        "entry": {
-          "description": "Relative path to the sidecar entry module, which default-exports the `createSidecar(contract, {...})` result. Keep it outside the handlers directory, which the indexer auto-loads.",
-          "type": "string"
-        }
-      },
-      "additionalProperties": false,
-      "required": [
-        "contract",
-        "entry"
-      ]
-    },
-    "ResolverConfig": {
-      "type": "object",
-      "properties": {
-        "description": {
-          "description": "Shown as the field's description in the GraphQL schema.",
-          "type": [
-            "string",
-            "null"
-          ]
-        },
-        "args": {
-          "description": "Argument name to GraphQL type string, for example `limit: \"Int!\"`. Scalars or lists of scalars.",
-          "type": [
-            "object",
-            "null"
-          ],
-          "additionalProperties": {
-            "type": "string"
-          }
-        },
-        "output": {
-          "description": "GraphQL type string of the result, for example `\"[TopTrader!]!\"`. Scalars or types declared under `types:`.",
-          "type": "string"
-        },
-        "handler": {
-          "description": "`sidecar` (answered by the `resolvers` of your `createSidecar`) or an http(s):// URL that accepts Hasura's action payload.",
-          "type": "string"
-        },
-        "timeoutMs": {
-          "description": "How long the GraphQL layer waits for the handler. (default: 30000)",
-          "type": [
-            "integer",
-            "null"
-          ],
-          "format": "uint64",
-          "minimum": 0
-        }
-      },
-      "additionalProperties": false,
-      "required": [
-        "output",
-        "handler"
-      ]
+        "required": [
+          "postgres"
+        ]
+      }
     },
     "EcosystemTag": {
       "type": "string",

package/fuel.schema.json

@@ -39,7 +39,7 @@
       "minimum": 0
     },
     "storage": {
-      "description": "Storage backends the indexer writes data to. Defaults to Postgres when omitted. Set `clickhouse: true` to additionally sync the indexed data to ClickHouse. Mark a backend with `default: true` to store entities that don't have an @storage directive in the schema, e.g. `clickhouse: {default: true}`.",
+      "description": "Where the indexer keeps entities. Postgres is always enabled and keeps them by default. Set `clickhouse: true` and mark an entity `@storage(clickhouse: true)` in the schema to keep it in ClickHouse, or set `clickhouse: {default: true}` to keep every unmarked entity there. Entities kept only in ClickHouse aren't served over GraphQL.",
       "anyOf": [
         {
           "$ref": "#/$defs/StorageConfig"
@@ -56,40 +56,6 @@
         "null"
       ]
     },
-    "sidecar": {
-      "description": "A sidecar: your own long-running TypeScript process, run next to the indexer by `envio sidecar` (and started by `envio dev`). Handlers call its functions through `context.sidecar.<name>(input)` without waiting.",
-      "anyOf": [
-        {
-          "$ref": "#/$defs/SidecarConfig"
-        },
-        {
-          "type": "null"
-        }
-      ]
-    },
-    "resolvers": {
-      "description": "Extra root query fields in the GraphQL API, answered by your sidecar or a webhook. Each one is published as a Hasura action, so Hasura and envio serve call the handler with Hasura's action payload.",
-      "type": [
-        "object",
-        "null"
-      ],
-      "additionalProperties": {
-        "$ref": "#/$defs/ResolverConfig"
-      }
-    },
-    "types": {
-      "description": "Output object types for `resolvers:`: type name to a map of field name to GraphQL type string (for example `address: \"String!\"`).",
-      "type": [
-        "object",
-        "null"
-      ],
-      "additionalProperties": {
-        "type": "object",
-        "additionalProperties": {
-          "type": "string"
-        }
-      }
-    },
     "ecosystem": {
       "description": "Ecosystem of the project.",
       "$ref": "#/$defs/EcosystemTag"
@@ -128,6 +94,13 @@
           "type": "null"
         }
       ]
+    },
+    "strict_hex_type": {
+      "description": "If true, the `Hex` type of bytes params, block and transaction hashes and `Bytes` fields is `0x${string}` instead of `string` (default: false)",
+      "type": [
+        "boolean",
+        "null"
+      ]
     }
   },
   "additionalProperties": false,
@@ -141,7 +114,7 @@
       "type": "object",
       "properties": {
         "postgres": {
-          "description": "Whether to use Postgres as a storage backend (default: true). Accepts a boolean or an options object (the object form implies the backend is enabled).",
+          "description": "Always enabled. Accepts `true` or an options object.",
           "anyOf": [
             {
               "type": [
@@ -153,7 +126,7 @@
               "type": "object",
               "properties": {
                 "default": {
-                  "description": "Whether entities without an @storage directive are stored in this backend (default: true when Postgres is the only enabled backend, false otherwise).",
+                  "description": "Whether entities without an @storage directive are kept here (default: true, unless `clickhouse: {default: true}` is set).",
                   "type": [
                     "boolean",
                     "null"
@@ -177,7 +150,7 @@
           ]
         },
         "clickhouse": {
-          "description": "Whether to additionally sync the indexed data to ClickHouse. Requires Postgres to be enabled (default: false). Accepts a boolean or an options object (the object form implies the backend is enabled).",
+          "description": "Whether to enable ClickHouse (default: false). Accepts a boolean or an options object.",
           "anyOf": [
             {
               "type": [
@@ -189,7 +162,7 @@
               "type": "object",
               "properties": {
                 "default": {
-                  "description": "Whether entities without an @storage directive are stored in this backend (default: false).",
+                  "description": "Whether entities without an @storage directive are kept here (default: false). Set it together with `postgres: {default: true}` to keep them in both.",
                   "type": [
                     "boolean",
                     "null"
@@ -214,118 +187,16 @@
         }
       },
       "additionalProperties": false,
-      "allOf": [
-        {
-          "not": {
-            "properties": {
-              "postgres": {
-                "const": false
-              }
-            },
-            "required": [
-              "postgres"
-            ]
-          }
-        },
-        {
-          "if": {
-            "properties": {
-              "clickhouse": {
-                "anyOf": [
-                  {
-                    "const": true
-                  },
-                  {
-                    "type": "object"
-                  }
-                ]
-              }
-            },
-            "required": [
-              "clickhouse"
-            ]
-          },
-          "then": {
-            "properties": {
-              "postgres": {
-                "anyOf": [
-                  {
-                    "const": true
-                  },
-                  {
-                    "type": "object"
-                  }
-                ]
-              }
-            },
-            "required": [
-              "postgres"
-            ]
-          }
-        }
-      ]
-    },
-    "SidecarConfig": {
-      "type": "object",
-      "properties": {
-        "contract": {
-          "description": "Relative path to the contract module: `export default defineSidecar({ functions, webhooks })`. Schemas only, since both the indexer and the sidecar load it. Types `context.sidecar`.",
-          "type": "string"
-        },
-        "entry": {
-          "description": "Relative path to the sidecar entry module, which default-exports the `createSidecar(contract, {...})` result. Keep it outside the handlers directory, which the indexer auto-loads.",
-          "type": "string"
-        }
-      },
-      "additionalProperties": false,
-      "required": [
-        "contract",
-        "entry"
-      ]
-    },
-    "ResolverConfig": {
-      "type": "object",
-      "properties": {
-        "description": {
-          "description": "Shown as the field's description in the GraphQL schema.",
-          "type": [
-            "string",
-            "null"
-          ]
-        },
-        "args": {
-          "description": "Argument name to GraphQL type string, for example `limit: \"Int!\"`. Scalars or lists of scalars.",
-          "type": [
-            "object",
-            "null"
-          ],
-          "additionalProperties": {
-            "type": "string"
+      "not": {
+        "properties": {
+          "postgres": {
+            "const": false
           }
         },
-        "output": {
-          "description": "GraphQL type string of the result, for example `\"[TopTrader!]!\"`. Scalars or types declared under `types:`.",
-          "type": "string"
-        },
-        "handler": {
-          "description": "`sidecar` (answered by the `resolvers` of your `createSidecar`) or an http(s):// URL that accepts Hasura's action payload.",
-          "type": "string"
-        },
-        "timeoutMs": {
-          "description": "How long the GraphQL layer waits for the handler. (default: 30000)",
-          "type": [
-            "integer",
-            "null"
-          ],
-          "format": "uint64",
-          "minimum": 0
-        }
-      },
-      "additionalProperties": false,
-      "required": [
-        "output",
-        "handler"
-      ]
+        "required": [
+          "postgres"
+        ]
+      }
     },
     "EcosystemTag": {
       "type": "string",