Skip to content

Commit 7fa47dc

Browse files
committed
Update Readme
1 parent 6d7d9a7 commit 7fa47dc

File tree

1 file changed

+26
-27
lines changed

1 file changed

+26
-27
lines changed

README.md

Lines changed: 26 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,11 @@
1-
# iExec PoCo v5 - subgraph
1+
# iExec PoCo Subgraph
22

3-
A subgraph to explore the PoCo smarcontracts
3+
A subgraph to index the PoCo Smart Contracts.
44

5-
[CHANGELOG](./CHANGELOG.md)
65

7-
# Setup coverage⁠
6+
## Local development
87

9-
> In order for Matchstick to check which handlers are being run, those handlers need to be exported from the test file.
10-
11-
Check how to export handlers with [Matchstick - Test Coverage documentation](https://thegraph.com/docs/en/subgraphs/developing/creating/unit-testing-framework/#test-coverage).
12-
13-
> [!NOTE]
14-
> Since Matchstick code coverage is in very early stages, Matchstick cannot check for branch coverage, but rely on the assertion that a given handler has been called.
15-
16-
## local dev
17-
18-
run local services:
8+
Run local services:
199

2010
- blockchain with iExec PoCo deployed
2111
- graph node (with ipfs + DB)
@@ -24,43 +14,48 @@ run local services:
2414
docker-compose -f docker/test/docker-compose.yml up -d
2515
```
2616

27-
install project deps
17+
Install project dependencies
2818

2919
```sh
3020
npm ci
3121
```
3222

33-
build the project and generate the necessary files:
23+
Build the project and generate the necessary files:
3424

3525
```sh
3626
npm run build
3727
```
3828

39-
deploy the subgraph on local node
29+
Deploy the subgraph on local node
4030

4131
```sh
4232
npm run start-test-stack
4333
```
4434

45-
run integration tests
35+
Run integration tests
4636

4737
```sh
4838
npm run itest
4939
```
5040

51-
test/poco subgraph graphql API enpoints:
52-
41+
The subgraph `test/poco` graphql API is accessible at:
5342
- queries: <http://127.0.0.1:8000/subgraphs/name/test/poco>
5443

55-
---
5644

57-
Here's the revised "Generating Subgraph and Jenkins Configuration Files" section for your README:
45+
### Coverage setup
46+
47+
> In order for Matchstick to check which handlers are being run, those handlers need to be exported from the test file.
48+
49+
Check how to export handlers with [Matchstick - Test Coverage documentation](https://thegraph.com/docs/en/subgraphs/developing/creating/unit-testing-framework/#test-coverage).
50+
51+
> [!NOTE]
52+
> Since Matchstick code coverage is in very early stages, Matchstick cannot check for branch coverage, but rely on the assertion that a given handler has been called.
5853
5954
## Docker subgraph deployer
6055

61-
docker image for deploying the subgraph
56+
The subgraph is deploy via a generated Docker image.
6257

63-
### Build Image
58+
### Build image
6459

6560
```sh
6661
docker build -f docker/Dockerfile . -t poco-subgraph-deployer
@@ -82,9 +77,9 @@ docker run --rm \
8277
poco-subgraph-deployer
8378
```
8479

85-
## Deployment Configuration
80+
## Deployment configuration
8681

87-
### Jenkins Pipeline Deployment
82+
### Jenkins pipeline deployment
8883

8984
The project uses a Jenkins pipeline for automated deployment of the subgraph. The deployment can be triggered through Jenkins with interactive parameter selection.
9085

@@ -141,9 +136,13 @@ choice(
141136

142137
The deployment process will automatically generate the appropriate subgraph configuration using the network-specific addresses and start blocks from `networks.json`.
143138

139+
## Changelog
140+
141+
Changes to this project are tracked in [CHANGELOG.md](./CHANGELOG.md)
142+
144143
## Resources
145144

146-
- [thegraph docs](https://thegraph.com/docs/en/)
145+
- [The Graph docs](https://thegraph.com/docs/en/)
147146

148147
## TODO
149148

0 commit comments

Comments
 (0)