feat: implement GraphQL subscriptions support

.changeset/twelve-apes-kneel.md

@@ -0,0 +1,5 @@
+---
+"@fuel-ts/providers": minor
+---
+
+Added subscriptions to graphql node

.eslintrc.js

@@ -25,6 +25,12 @@ module.exports = {
     // Disable error on devDependencies importing since this isn't a TS library
     'import/no-extraneous-dependencies': ['error', { devDependencies: true }],
     'no-await-in-loop': 0,
+    'no-restricted-syntax': [
+      'off',
+      {
+        selector: 'ForOfStatement',
+      },
+    ],
     'prefer-destructuring': 0,
     'no-bitwise': 0,
     'no-underscore-dangle': 'off',

.github/actions/ci-setup/action.yaml

@@ -2,7 +2,7 @@ name: "CI setup"
 inputs:
   node-version:
     description: "Node version"
-    default: 18.14.1
+    default: 18.18.0
   pnpm-version:
     description: "PNPM version"
     default: 8.6.1

.nvmrc

@@ -1 +1 @@
-18.14.1
+18.18.0

package.json

@@ -5,10 +5,10 @@
   "author": "Fuel Labs <contact@fuel.sh> (https://fuel.network/)",
   "private": true,
   "engines": {
-    "node": ">= 18.14.1",
-    "pnpm": ">= 8.1.1"
+    "node": ">= 18.18.0",
+    "pnpm": ">= 8.6.1"
   },
-  "packageManager": "pnpm@8.1.1",
+  "packageManager": "pnpm@8.6.1",
   "scripts": {
     "dev": "nodemon --config nodemon.config.json -x 'turbo run build --filter=!fuel-gauge'",
     "build": "turbo run build",
@@ -87,10 +87,5 @@
     "tsx": "^3.12.7",
     "turbo": "^1.8.8",
     "typescript": "~5.1.6"
-  },
-  "pnpm": {
-    "overrides": {
-      "cross-fetch": "4.0.0"
-    }
   }
 }

packages/errors/src/error-codes.ts

@@ -11,7 +11,7 @@ export enum ErrorCode {
   TYPE_NOT_FOUND = 'type-not-found',
   TYPE_NOT_SUPPORTED = 'type-not-supported',
   INVALID_DECODE_VALUE = 'invalid-decode-value',
-  JSON_ABI_ERROR = 'abi-main-method-missing',
+  JSON_ABI_ERROR = 'json-abi-error',
   TYPE_ID_NOT_FOUND = 'type-id-not-found',
   BIN_FILE_NOT_FOUND = 'bin-file-not-found',
   CODER_NOT_FOUND = 'coder-not-found',
@@ -84,6 +84,9 @@ export enum ErrorCode {
   SCRIPT_REVERTED = 'script-reverted',
   SCRIPT_RETURN_INVALID_TYPE = 'script-return-invalid-type',
 
+  // general
+  FUEL_NODE_ERROR = 'fuel-node-error',
+
   // coder
   // ...
 }

packages/providers/codegen.json

@@ -1,13 +1,19 @@
 {
   "$schema": "https://www.graphql-code-generator.com/config.schema.json",
   "schema": "./fuel-core-schema.graphql",
-  "documents": "./src/operations.graphql",
   "generates": {
     "./src/__generated__/operations.ts": {
+      "documents": "./src/operations.graphql",
       "plugins": [
         { "typescript": {} },
-        { "typescript-operations": {} },
-        { "typescript-graphql-request": {} }
+        {
+          "typescript-operations": {}
+        },
+        {
+          "typescript-generic-sdk": {
+            "dedupeFragments": true
+          }
+        }
       ],
       "config": {
         "scalars": {

packages/providers/package.json

@@ -38,6 +38,7 @@
     "graphql": "^16.6.0",
     "graphql-request": "^5.0.0",
     "graphql-tag": "^2.12.6",
+    "graphql-sse": "^2.2.1",
     "ramda": "^0.29.0",
     "tai64": "^1.0.0"
   },
@@ -47,8 +48,8 @@
     "@graphql-codegen/typescript": "^2.8.0",
     "@graphql-codegen/typescript-graphql-request": "^4.5.7",
     "@graphql-codegen/typescript-operations": "^2.5.5",
+    "@graphql-codegen/typescript-generic-sdk": "^3.1.0",
     "@types/ramda": "^0.29.3",
-    "get-graphql-schema": "^2.1.2",
-    "typescript": "^4.8.4"
+    "get-graphql-schema": "^2.1.2"
   }
 }

packages/providers/src/operations.graphql

@@ -4,6 +4,31 @@
 # generate `operations.ts` from this file.
 
 # Fragments
+
+fragment transactionStatusFragment on TransactionStatus {
+  type: __typename
+  ... on SubmittedStatus {
+    time
+  }
+  ... on SuccessStatus {
+    block {
+      id
+    }
+    time
+    programState {
+      returnType
+      data
+    }
+  }
+  ... on FailureStatus {
+    block {
+      id
+    }
+    time
+    reason
+  }
+}
+
 fragment transactionFragment on Transaction {
   id
   rawPayload
@@ -12,27 +37,7 @@ fragment transactionFragment on Transaction {
     ...receiptFragment
   }
   status {
-    type: __typename
-    ... on SubmittedStatus {
-      time
-    }
-    ... on SuccessStatus {
-      block {
-        id
-      }
-      time
-      programState {
-        returnType
-        data
-      }
-    }
-    ... on FailureStatus {
-      block {
-        id
-      }
-      time
-      reason
-    }
+    ...transactionStatusFragment
   }
 }
 
@@ -462,3 +467,15 @@ mutation produceBlocks(
     startTimestamp: $startTimestamp
   )
 }
+
+subscription submitAndAwait($encodedTransaction: HexString!) {
+  submitAndAwait(tx: $encodedTransaction) {
+    ...transactionStatusFragment
+  }
+}
+
+subscription statusChange($transactionId: TransactionId!) {
+  statusChange(id: $transactionId) {
+    ...transactionStatusFragment
+  }
+}