feat: add web3 docker setup

Author: dnechay

docker-setup/Makefile

@@ -1,6 +1,7 @@
 .PHONY: check-env-file \
 	infra-up infra-stop \
-	build-services services-up services-stop
+	build-services services-up services-stop \
+	web3-start web3-stop
 
 DOCKER_PARALLEL ?= 4
 
@@ -26,6 +27,18 @@ services-stop:
 	@service_names="$(wordlist 2, $(words $(MAKECMDGOALS)), $(MAKECMDGOALS))"; \
 	docker-compose --env-file .env.compose.local stop $$service_names
 
+web3-up:
+	@service_names="$(wordlist 2, $(words $(MAKECMDGOALS)), $(MAKECMDGOALS))"; \
+	docker-compose -f docker-compose.web3.yml --parallel $(DOCKER_PARALLEL) up -d $$service_names
+
+web3-stop:
+	@service_names="$(wordlist 2, $(words $(MAKECMDGOALS)), $(MAKECMDGOALS))"; \
+	docker-compose -f docker-compose.web3.yml stop $$service_names
+
+# also remove volumes to get the clean start after
+web3-down:
+	docker-compose -f docker-compose.web3.yml down -v
+
 # catch-all and noop; to avoid warnings when using MAKECMDGOALS 
 %:
 	@:

docker-setup/docker-compose.web3.yml

@@ -0,0 +1,124 @@
+name: human-protocol-local-web3
+
+x-service-default-config:
+  restart: &default-restart unless-stopped
+  logging: &default-logging
+    options:
+      max-size: 10m
+      max-file: 3
+
+x-hardcoded-vars:
+  graph_db_user: &graph_db_user graph-node
+  graph_db_passwrod: &graph_db_passwrod let-me-in
+  graph_db_name: &graph_db_name graph-node
+
+services:
+  blockchain-node:
+    container_name: blockchain-node
+    image: human-protocol/hardhat-blockchain-node
+    pull_policy: build
+    restart: *default-restart
+    logging:
+      <<: *default-logging
+    build: 
+      context: ../
+      dockerfile: packages/core/Dockerfile.local
+    healthcheck:
+      test: yarn local:readiness
+      interval: 15s
+      timeout: 30s
+      retries: 0
+    networks:
+      - human_protocol_web3
+    ports:
+      - name: node-port
+        target: 8545
+        published: ${BLOCKCHAIN_NODE_PORT:-8545}
+
+  ipfs:
+    container_name: ipfs
+    image: ipfs/kubo:v0.14.0
+    restart: *default-restart
+    logging:
+      <<: *default-logging
+    healthcheck:
+      test: ["CMD-SHELL", "ipfs id > /dev/null"]
+      interval: 10s
+      timeout: 5s
+      retries: 3
+    networks:
+      - human_protocol_web3
+    ports:
+      - name: ipfs-port
+        target: 5001
+        published: ${IPFS_PORT:-5010}
+    volumes:
+      - ipfs-data:/data/ipfs:Z
+
+  graph-node-db:
+    container_name: graph-node-db
+    image: postgres:latest
+    restart: *default-restart
+    logging:
+      <<: *default-logging
+    networks:
+      - human_protocol_web3
+    ports:
+      - name: instance_port
+        target: 5432
+        published: ${GRAPH_NODE_DB_PORT:-5434}
+    command:
+      [
+        "postgres",
+        "-cshared_preload_libraries=pg_stat_statements",
+        "-cmax_connections=200"
+      ]
+    healthcheck:
+      test: ["CMD", "pg_isready"]
+      interval: 10s
+      timeout: 5s
+      retries: 5
+    volumes:
+      - graph-node-db-data:/var/lib/postgresql/data:Z
+    environment:
+      POSTGRES_USER: *graph_db_user
+      POSTGRES_PASSWORD: *graph_db_passwrod
+      POSTGRES_DB: *graph_db_name
+      POSTGRES_INITDB_ARGS: "-E UTF8 --locale=C"
+
+  graph-node:
+    container_name: graph-node
+    # In case of issues on Mac M1 rebuild the image for it locally
+    # https://github.com/graphprotocol/graph-node/blob/master/docker/README.md#running-graph-node-on-an-macbook-m1
+    image: graphprotocol/graph-node
+    restart: *default-restart
+    logging:
+      <<: *default-logging
+    networks:
+      - human_protocol_web3
+    ports:
+      - '8000:8000'
+      - '8001:8001'
+      - '8020:8020'
+      - '8030:8030'
+      - '8040:8040'
+    depends_on:
+      - blockchain-node
+      - ipfs
+      - graph-node-db
+    environment:
+      postgres_host: graph-node-db
+      postgres_user: *graph_db_user
+      postgres_pass: *graph_db_passwrod
+      postgres_db: *graph_db_name
+      ipfs: ipfs:5001
+      ethereum: localhost:http://blockchain-node:8545
+      GRAPH_LOG: info
+
+volumes:
+  ipfs-data:
+  graph-node-db-data:
+
+networks:
+  human_protocol_web3:
+    name: human-protocol-web3

package.json

@@ -12,6 +12,8 @@
     "build:sdk": "yarn workspace @human-protocol/sdk build",
     "build:libs": "yarn build:core && yarn build:sdk",
     "docker:infra-up": "make -C ./docker-setup check-env-file infra-up",
+    "docker:web3-up": "make -C ./docker-setup web3-up",
+    "docker:web3-down": "make -C ./docker-setup web3-down",
     "docker:stop": "make -C ./docker-setup services-stop"
   },
   "workspaces": [

packages/sdk/typescript/subgraph/README.md

@@ -29,6 +29,39 @@ Package installation
 yarn install
 ```
 
+## Development
+### Tests
+
+To run tests next commands should be executed:
+
+```bash
+NETWORK=polygon yarn generate
+
+yarn codegen
+
+yarn build
+
+yarn test
+```
+
+### e2e test using local node
+You can e2e test subgraph changes by running blockchain and graph node locally. To do so, first you will need to run necessary infra in Docker:
+```bash
+yarn workspace human-protocol docker:web3-up
+```
+> In case you already have such infra running and want a clean start w/o previous data - run `yarn workspace human-protocol docker:web3-down` first
+
+After you have the infra running:
+```bash
+# Generate artifacts for running subgraph on localhost
+NETWORK=localhost yarn generate
+# Create graph for localhost
+yarn create-local
+# Deploy the graph
+yarn deploy-local
+```
+After that subgraph should be available on `http://0.0.0.0:8000/subgraphs/name/humanprotocol/localhost`
+
 ## 🏊 Deploying graphs for live networks
 
 1. Generate & deploy on matic
@@ -49,20 +82,6 @@ You can access it on `http://localhost:8020/`
 
 The deployment of the graph on each network is automatically triggered by the github CI when mofications are made on the subgraph.
 
-### Tests
-
-To run tests next commands should be executed:
-
-```bash
-NETWORK=polygon yarn generate
-
-yarn codegen
-
-yarn build
-
-yarn test
-```
-
 ### Supported networks
 
 Following networks are supported :