Merge branch 'develop' into feature/detect-user-chain

Author: SeddikBellamine

.drone.yml

@@ -531,105 +531,6 @@ steps:
       password:
         from_secret: dockerhub-password
 
----
-kind: pipeline
-type: docker
-name: subgraph deploy
-
-trigger:
-  event:
-    - promote
-  target:
-    # deploy the dataprotector subgraph for the staging environment
-    - subgraph-deploy-staging
-    # deploy the dataprotector subgraph
-    - subgraph-deploy-tmp
-    # deploy the dataprotector subgraph for the prod environment
-    - subgraph-deploy-prod
-  branch:
-    - develop
-    - main
-
-steps:
-  - name: install deps
-    image: node:18.19
-    pull: always
-    commands:
-      - cd packages/subgraph
-      - npm ci
-
-  - name: deploy-v2-staging
-    image: node:18.19
-    params:
-      - START_BLOCK
-    environment:
-      GRAPHNODE_URL:
-        from_secret: graphnode-url-staging
-      IPFS_URL:
-        from_secret: ipfs-url-staging
-      ENV: staging
-    commands:
-      - cd packages/subgraph
-      - export SUBGRAPH_NAME=bellecour/staging-dataprotector-v2
-      - echo "deploying commit $DRONE_COMMIT on subgraph $SUBGRAPH_NAME"
-      - npm run codegen
-      - npm run build
-      - npx graph create --node $GRAPHNODE_URL $SUBGRAPH_NAME
-      - npx graph deploy --node $GRAPHNODE_URL $SUBGRAPH_NAME --ipfs $IPFS_URL --version-label $(npm pkg get version)
-    when:
-      target:
-        - subgraph-deploy-staging
-      branch:
-        - develop
-
-  - name: deploy-v2-tmp
-    image: node:18.19
-    params:
-      - START_BLOCK
-    environment:
-      GRAPHNODE_URL:
-        from_secret: graphnode-url
-      IPFS_URL:
-        from_secret: ipfs-url
-      ENV: prod
-    commands:
-      - cd packages/subgraph
-      - export SUBGRAPH_NAME=bellecour/tmp-dataprotector-v2
-      - echo "deploying commit $DRONE_COMMIT on subgraph $SUBGRAPH_NAME"
-      - npm run codegen
-      - npm run build
-      - npx graph create --node $GRAPHNODE_URL $SUBGRAPH_NAME
-      - npx graph deploy --node $GRAPHNODE_URL $SUBGRAPH_NAME --ipfs $IPFS_URL --version-label $DRONE_COMMIT
-    when:
-      target:
-        - subgraph-deploy-tmp
-      branch:
-        - main
-
-  - name: deploy-v2-prod
-    image: node:18.19
-    params:
-      - START_BLOCK
-    environment:
-      GRAPHNODE_URL:
-        from_secret: graphnode-url
-      IPFS_URL:
-        from_secret: ipfs-url
-      ENV: prod
-    commands:
-      - cd packages/subgraph
-      - export SUBGRAPH_NAME=bellecour/dataprotector-v2
-      - echo "deploying commit $DRONE_COMMIT on subgraph $SUBGRAPH_NAME"
-      - npm run codegen
-      - npm run build
-      - npx graph create --node $GRAPHNODE_URL $SUBGRAPH_NAME
-      - npx graph deploy --node $GRAPHNODE_URL $SUBGRAPH_NAME --ipfs $IPFS_URL --version-label $(npm pkg get version)
-    when:
-      target:
-        - subgraph-deploy-prod
-      branch:
-        - main
-
 ---
 #pipeline to deploy app whitelist on iexec
 kind: pipeline

.github/workflows/deploy-subgraph.yml

@@ -0,0 +1,71 @@
+name: Deploy Subgraph
+
+on:
+  workflow_dispatch:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        include:
+          - target: staging
+            subgraph_name: "bellecour/staging-dataprotector-v2"
+            branch: develop
+            env_name: staging
+            graphnode_url: ${{ secrets.GRAPHNODE_URL_STAGING }}
+            ipfs_url: ${{ secrets.IPFS_URL_STAGING }}
+            version_method: npm_version
+          - target: tmp
+            subgraph_name: "bellecour/tmp-dataprotector-v2"
+            branch: main
+            env_name: prod
+            graphnode_url: ${{ secrets.GRAPHNODE_URL }}
+            ipfs_url: ${{ secrets.IPFS_URL }}
+            version_method: commit
+          - target: prod
+            subgraph_name: "bellecour/dataprotector-v2"
+            branch: main
+            env_name: prod
+            graphnode_url: ${{ secrets.GRAPHNODE_URL }}
+            ipfs_url: ${{ secrets.IPFS_URL }}
+            version_method: npm_version
+
+    # Run only if the current branch matches the matrix branch
+    if: github.ref == format('refs/heads/{0}', matrix.subgraph.branch)
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18
+
+      - name: Install Dependencies
+        working-directory: packages/subgraph
+        run: npm ci
+
+      - name: Run Codegen and Build
+        working-directory: packages/subgraph
+        run: |
+          npm run codegen
+          npm run build
+
+      - name: Set Version Label
+        id: set_version
+        working-directory: packages/subgraph
+        run: |
+          if [ "${{ matrix.subgraph.version_method }}" = "commit" ]; then
+            echo "version=${GITHUB_SHA}" >> $GITHUB_OUTPUT
+          else
+            version=$(npm pkg get version | sed 's/"//g')
+            echo "version=${version}" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Create Subgraph
+        working-directory: packages/subgraph
+        run: |
+          npx graph create --node ${{ matrix.subgraph.graphnode_url }} ${{ matrix.subgraph.subgraph_name }}
+
+      - name: Deploy Subgraph
+        working-directory: packages/subgraph
+        run: |
+          npx graph deploy --node ${{ matrix.subgraph.graphnode_url }} ${{ matrix.subgraph.subgraph_name }} --ipfs ${{ matrix.subgraph.ipfs_url }} --version-label ${{ steps.set_version.outputs.version }}

packages/subgraph/.env.template

@@ -1,20 +1,11 @@
-# environment to use for configuration (prod/staging)
-ENV=prod
+# The name of the network (e.g., mainnet, arbitrum, etc.)
+NETWORK_NAME=...
 
-# override the starting block for indexation of all contracts events
-# START_BLOCK=0
+# The URL of the Graph Node endpoint for self-hosted Graph Node
+GRAPHNODE_URL=...
 
-# AppRegistry contract address override
-# APP_REGISTRY_ADDRESS=0x...
+# The URL of the IPFS endpoint for self-hosted IPFS
+IPFS_URL=...
 
-# DatasetRegistry contract address override
-# DATASET_REGISTRY_ADDRESS=0x...
-
-# Dataprotector contract address override
-# DATAPROTECTOR_ADDRESS=0x...
-
-# DataprotectorSharing contract address override
-# DATAPROTECTOR_SHARING_ADDRESS=0x...
-
-# AddOnlyAppWhitelistRegistry contract address override
-# ADD_ONLY_APP_WHITELIST_REGISTRY_ADDRESS=0x...
+# The version label for the deployment (e.g., v1.0.0)
+VERSION_LABEL=...

packages/subgraph/.gitignore

@@ -11,3 +11,4 @@ coverage.json
 # subgraph
 generated
 subgraph.yaml
+tests/.latest.json

packages/subgraph/README.md

@@ -1,32 +1,69 @@
 # Subgraph
 
+This repository contains the code for the DataProtector subgraph, which indexes blockchain events to make them queryable through a GraphQL API.
+
 ## Build the Subgraph
 
-And you have finishing editing the schema.graphql & subgraph.yaml files. Type the following command
+After editing the schema.graphql & subgraph.yaml files, build the subgraph with:
 
 ```bash
 npm run codegen
 npm run build
 ```
 
-Then you have to write ./src/bays.ts files in order to update the graph when new events appear. In this way, it will always be up to date.
+Then implement event handlers in the ./src files to keep the graph updated when new events occur on the blockchain.
+
+## Deployment Options
 
-## Local
+### Local Development
 
-### Deploy on Local Graph node
+To deploy on a local Graph Node:
 
 ```bash
 npm run create-local
 npm run deploy-local
 ```
 
-### Test Subgrah API
+The subgraph will be available at: http://localhost:8000/subgraphs/name/DataProtector/graphql
+
+### Hosted Production Environments
+
+We use CI/CD pipelines to deploy our subgraphs to hosted environments.
+
+#### Docker Image Tags
+
+When building and pushing Docker images, the following tag generation strategy is used:
+
+| Trigger | Environment | Tag Format | Example | Push? |
+|---------|-------------|------------|---------|-------|
+| Manual workflow dispatch | Production | `{package.json version}` | `1.2.3` | Yes |
+| Manual workflow dispatch | Development | `dev-{commit SHA}` | `dev-8e7d3f2` | Yes |
+| Push to `main` branch | Production | `{package.json version}` | `1.2.3` | Yes |
+| Push to `develop` branch | Development | `dev-{commit SHA}` | `dev-8e7d3f2` | Yes |
+| Tag push | N/A | `{tag name}` | `v1.2.3-beta` | Yes |
+| Other branch push | Development | `dev-{commit SHA}` | `dev-8e7d3f2` | No |
 
-Deployed to : <http://localhost:8000/subgraphs/name/DataProtector/graphql>
+### Self-Hosted Subgraph Deployment Process
 
-Request Example on GraphiQL :
+For zero-downtime updates to the production subgraph:
 
-Query for GraphiQL API
+1. **Index the New Version (Temporary Deployment)**
+   - Trigger deployment with target: `subgraph-deploy-tmp`
+   - This creates a separate instance for indexing
+
+2. **Wait for Indexing Completion**
+   - Monitor the temporary deployment until it's fully synced
+   
+3. **Deploy to Production (Zero Downtime)**
+   - Once temporary deployment is ready, trigger: `subgraph-deploy-prod`
+   - This swaps the deployments with no service interruption
+
+4. **Verify the Deployment**
+   - Access the production subgraph at: https://thegraph.iex.ec/subgraphs/name/bellecour/dataprotector-v2/graphql
+
+## Query Examples
+
+### Sample GraphQL Query
 
 ```graphql
 query MyQuery($requiredSchema: [String!]!, $start: Int!, $range: Int!) {
@@ -57,48 +94,27 @@ query MyQuery($requiredSchema: [String!]!, $start: Int!, $range: Int!) {
 }
 ```
 
-```graphql
-Query Variables :
+### Query Variables
 
+```json
 {
   "start": 0,
   "range": 1000,
   "requiredSchema": []
 }
 ```
 
-## Hosted
-
-You can trigger a deployment using the promote action on the CI.
-
-### Self Hosted Subgraph
-
-To deploy a new version of a subgraph on the iExec self-hosted service, follow these steps:
-
-1. Index the New Subgraph
-
-First, index the new version of the subgraph using the temporary subgraph deployment.
-Trigger its deployment with the target:
-
-```sh
-subgraph-deploy-tmp
-```
-
-2. Wait for Indexing Completion
-
-Once the temporary subgraph has finished indexing, you can proceed to the production deployment.
-
-3. Deploy to Production (No Downtime)
-
-Trigger the production deployment with :
-
-```sh
-subgraph-deploy-prod
-```
+## Development Workflow
 
-This ensures a seamless transition with no downtime.
+1. Update schema.graphql and subgraph.yaml as needed
+2. Run codegen to generate TypeScript types: `npm run codegen`
+3. Implement mapping handlers in src/ files 
+4. Build the subgraph: `npm run build`
+5. Test locally before deploying to production environments
 
-4. Verify the Deployment
+## CI/CD Integration
 
-Visit the following URL to check the new version of the subgraph:
-<https://thegraph.iex.ec/subgraphs/name/bellecour/dataprotector-v2/graphql>
+Our repository uses automated workflows to build, test, and deploy the subgraph:
+- ABI validation checks ensure contract ABIs are up-to-date
+- Docker images are built and pushed with appropriate tags based on the source branch
+- Deployment follows a staged approach to ensure zero downtime

packages/subgraph/config/env.ts

@@ -0,0 +1,17 @@
+import 'dotenv/config';
+import { z } from 'zod';
+
+const envSchema = z.object({
+    NETWORK_NAME: z.string().min(1, 'NETWORK_NAME is required').default('bellecour'),
+
+    GRAPHNODE_URL: z
+        .string()
+        .url('GRAPHNODE_URL must be a valid URL')
+        .default('http://localhost:8020'),
+
+    IPFS_URL: z.string().url('IPFS_URL must be a valid URL').default('http://localhost:5001'),
+
+    VERSION_LABEL: z.string().min(1, 'VERSION_LABEL is required').default('bellecour/poco-v5'),
+});
+
+export const env = envSchema.parse(process.env);