feat: The Graph migration (moving on from GoldSky)

.github/workflows/tests.yml

@@ -5,9 +5,9 @@ name: Run tests
 
 on:
   push:
-    branches: [ "main" ]
+    branches: [ "*" ]
   pull_request:
-    branches: [ "main" ]
+    branches: [ "*" ]
 
 jobs:
   build:
@@ -28,3 +28,5 @@ jobs:
         cache: 'npm'
     - run: npm i
     - run: npm test
+      env:
+        REACT_APP_THE_GRAPH_API_KEY: ${{ secrets.THE_GRAPH_API_KEY }}

.gitignore

@@ -2,6 +2,7 @@ node_modules
 build
 dist
 .idea
+.env
 
 /coverage/lcov-report
 /coverage/coverage-summary.json

README.md

@@ -23,4 +23,24 @@ GraphQL Services
 
 ## Release
 1. Run `npm run build`
-2. Then `npm publish --access public --otp xxxxxx`
+2. Then `npm publish --access public --otp xxxxxx`
+
+## Installation..
+
+```ssh
+
+yarn add @bobanetwork/graphql-utils
+
+```
+
+or 
+
+```ssh
+
+npm install @bobanetwork/graphq-utils.
+
+```
+
+## For smooth functioning of package need expose env var below via process.
+
+`REACT_APP_THE_GRAPH_API_KEY` - The graph api key which helpfuls to fetch the graph data.

jest.config.js

@@ -1,4 +1,4 @@
-const { defaults } = require('jest-config')
+import { defaults } from 'jest-config';
 
 /** @type {import('jest').Config} */
 const config = {
@@ -18,7 +18,8 @@ const config = {
     "json-summary",
     "text",
     "lcov"
-  ]
-}
+  ],
+  testTimeout: 60000,
+};
 
-module.exports = config
+export default config;

package.json

@@ -4,6 +4,7 @@
   "description": "GraphQL services to be consumed by frontend/backend services.",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
+  "type": "module",
   "files": [
     "dist"
   ],
@@ -26,14 +27,17 @@
     "@apollo/client": "3.5.10",
     "@ethersproject/providers": "^5.7.2",
     "@types/jest": "^29.5.12",
+    "dotenv": "^16.4.5",
     "ethers": "^5.5.4",
+    "graphql": "^16.8.2",
     "node-fetch": "^2.6.1",
     "ts-jest": "^29.1.2"
   },
   "devDependencies": {
     "@types/node": "^16.18.62",
     "@types/node-fetch": "^2.6.11",
     "jest": "^29.7.0",
+    "jest-config": "^29.7.0",
     "jest-coverage-badges": "^1.1.2",
     "tsup": "^8.0.2",
     "typescript": "^5.4.2"