add support for polling block handler

graphprotocol · Aug 21, 2023 · b86cfb8 · b86cfb8
1 parent d4d5c90
commit b86cfb8
Show file tree

Hide file tree

Showing 7 changed files with 63 additions and 4 deletions.
diff --git a/.changeset/six-maps-double.md b/.changeset/six-maps-double.md
@@ -0,0 +1,5 @@
+---
+'@graphprotocol/graph-cli': minor
+---
+
+Add support for polling block handlers in the manifest for ethereum
diff --git a/packages/cli/src/protocols/ethereum/manifest.graphql b/packages/cli/src/protocols/ethereum/manifest.graphql
@@ -55,13 +55,26 @@ type ContractAbi {
   file: File!
 }
 
-type BlockHandler {
-  handler: String!
-  filter: BlockFilter
+enum BlockFilterKind {
+  polling
+  once
+  call
 }
 
 type BlockFilter {
-  kind: String!
+  kind: BlockFilterKind!
+}
+
+type PollingBlockFilter {
+  kind: BlockFilterKind!
+  every: BigInt!
+}
+
+union BlockFilterType = BlockFilter | PollingBlockFilter
+
+type BlockHandler {
+  handler: String!
+  filter: BlockFilterType
 }
 
 type CallHandler {

diff --git a/packages/cli/tests/cli/validation.test.ts b/packages/cli/tests/cli/validation.test.ts
@@ -1,6 +1,14 @@
 import { cliTest } from './util';
 
 describe('Validation', () => {
+  cliTest(
+    'Block handler filters',
+    ['codegen', '--skip-migrations'],
+    'validation/block-handler-filters',
+    {
+      exitCode: 0,
+    },
+  );
   cliTest(
     'Invalid subgraph manifest',
     ['codegen', '--skip-migrations'],

diff --git a/packages/cli/tests/cli/validation/block-handler-filters/Abi.json b/packages/cli/tests/cli/validation/block-handler-filters/Abi.json
@@ -0,0 +1 @@
+[]
diff --git a/packages/cli/tests/cli/validation/block-handler-filters/mapping.ts b/packages/cli/tests/cli/validation/block-handler-filters/mapping.ts
diff --git a/packages/cli/tests/cli/validation/block-handler-filters/schema.graphql b/packages/cli/tests/cli/validation/block-handler-filters/schema.graphql
@@ -0,0 +1,3 @@
+type A @entity {
+  id: ID!
+}
diff --git a/packages/cli/tests/cli/validation/block-handler-filters/subgraph.yaml b/packages/cli/tests/cli/validation/block-handler-filters/subgraph.yaml
@@ -0,0 +1,29 @@
+specVersion: 0.0.1
+schema:
+  file: ./schema.graphql
+dataSources:
+  - kind: ethereum/contract
+    name: DataSource
+    source:
+      address: '0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'
+      abi: ExampleContract
+    mapping:
+      kind: ethereum/events
+      apiVersion: 0.0.5
+      language: wasm/assemblyscript
+      file: ./mapping.ts
+      entities:
+        - A
+      abis:
+        - name: ExampleContract
+          file: ./Abi.json
+      blockHandlers:
+        - handler: handleBlock0
+        - handler: handleBlock1
+          filter:
+            kind: polling
+            every: 2
+        - handler: handleBlock2
+          filter:
+            kind: once
+