hiero-ledger
diff --git a/‎.github/workflows/subgraph.yml‎
Lines changed: 53 additions & 0 deletions b/‎.github/workflows/subgraph.yml‎
Lines changed: 53 additions & 0 deletions
diff --git a/‎tools/README.md‎
Lines changed: 1 addition & 1 deletion b/‎tools/README.md‎
Lines changed: 1 addition & 1 deletion
diff --git a/‎tools/subgraph-example/README.md‎
Lines changed: 44 additions & 19 deletions b/‎tools/subgraph-example/README.md‎
Lines changed: 44 additions & 19 deletions
diff --git a/‎tools/subgraph-example/configs/latest.json‎
Lines changed: 0 additions & 36 deletions b/‎tools/subgraph-example/configs/latest.json‎
Lines changed: 0 additions & 36 deletions
@@ -0,0 +1,53 @@
+name: Subgraph Tests
+
+on:
+  pull_request:
+    branches: [main, release/**]
+  push:
+    branches: [main, release/**]
+    tags: [v*]
+
+jobs:
+  subgraph-workflow:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    defaults:
+      run:
+        working-directory: ./tools/subgraph-example/
+    steps:
+      - name: Setup node
+        uses: actions/setup-node@v2
+        with:
+          node-version: 16
+
+      - name: Checkout repo
+        uses: actions/checkout@v2
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Create .env file
+        run: cp .env.example .env
+
+      - name: Run local node
+        run: npx hedera start --network local-test --detached
+
+      - name: Deploy and interact with contracts
+        run: npx hardhat prepare
+
+      - name: Start local graph-node
+        run: npm run graph-local -- --detach
+
+      - name: Sleep for 10 seconds
+        run: sleep 10s
+        shell: bash
+
+      - name: Create subgraph
+        run: npm run create-local
+
+      - name: Deploy subgraph
+        run: npm run deploy-local -- --network local --version-label 0.0.1
+
+      - name: Run the tests
+        run: npx hardhat test
@@ -12,11 +12,11 @@
 | Support for multiple dataSources | ✅ |
 | Support for dynamic dataSource templates | ✅ |
 | Block Handlers WITHOUT filters | ✅ |
+| Can index anonymous events | ✅ |
 | Block Handlers WITH filters | ❌ | Requires Parity's [trace_filter](https://openethereum.github.io/JSONRPC-trace-module#trace_filter)
 | Call Handlers | ❌ | Requires Parity's [trace_filter](https://openethereum.github.io/JSONRPC-trace-module#trace_filter)
 | Capture HTS transfers through HTS precompile | ❌ | Depends on [4127](https://github.com/hashgraph/hedera-services/issues/4127)
 | Capture HTS token transfers through HAPI | ❌ | Depends on [4337](https://github.com/hashgraph/hedera-mirror-node/issues/4337), [4738](https://github.com/hashgraph/hedera-mirror-node/issues/4738)
-| Can index anonymous events | ❔ | Depends on [667](https://github.com/hashgraph/hedera-json-rpc-relay/issues/667)
 
 ### Supported tools
 |                                                                      | web3js | Truffle | ethers | Hardhat |
 
@@ -1,5 +1,7 @@
 # Subgraph example
 
+## Description:
+
 Hardhat based project containing example subgraph indexing the following contracts and events:
 
 ExampleERC721 -> Transfer
@@ -10,29 +12,37 @@ GravatarRegistry -> GravatarCreated and GravatarUpdated
 
 For more information on subgraphs, check the official TheGraph documentation https://thegraph.com/docs/en/
 
-## Prerequisites:
+## Introduction:
+
+1. [What is TheGraph](https://thegraph.com/docs/en/about)
+2. [How to create a subgraph](https://thegraph.com/docs/en/developing/creating-a-subgraph/)
+3. [The AssemblyScript API](https://thegraph.com/docs/en/developing/assemblyscript-api/)
+
+## Try it out:
+
+### Prerequisites:
 
-Note: Currently this example needs to be executed against older relay and mirror-node versions, until all fixes have been released.
+Note: Currently this example needs to be executed against older relay (v0.10.0) and mirror-node (v0.67.0-rc1) versions, until all fixes have been released.
 
-### Install the dependencies:
+The full hedera local-node config can be found [here](./configs/local-test.json)
+
+#### Install the dependencies:
 
 Run `npm install` or `yarn [install]`
 
-### Run Hedera local node:
+#### Run Hedera local node:
 
 To start a Hedera local node by running `npx hedera start --network local-test`. Note that when the containers are up, you'll need to stop the `json-rpc-relay` container and start a local relay server.
 
-### JSON-RPC Relay configurations:
-
-Note: Currently you'll have to start the relay from the main branch in this repo, because it contains important bugfixes. This doc will be updated when a new version containing all the fixes is released.
+#### JSON-RPC Relay configurations:
 
-The graph node is configured to run against a local instance of the json-rpc-relay. Be sure to set the following options in your json-rpc .env file:
+If the graph node is configured to run against a local instance of the json-rpc-relay. Be sure to set the following env variables in your json-rpc-relay .env file:
 ```
 ETH_GET_LOGS_BLOCK_RANGE_LIMIT=2000
 RATE_LIMIT_DISABLED = true
 ```
 
-### Set .env vars
+#### Set .env vars
 
 Rename `.env.example` to `.env`
 
@@ -53,7 +63,7 @@ Rename `.env.example` to `.env`
 
 `npx hardhat createGravatar`
 
-NOTE: This example uses the [hardhat-graph](https://github.com/graphprotocol/hardhat-graph) hardhat plugin. After every contract deploy, the plugin will update the networks.json file with the contract address (and the startBlock), so you don't have to manually update it in the `subgraph.yaml` file.
+_NOTE: This example uses the [hardhat-graph](https://github.com/graphprotocol/hardhat-graph) plugin. After every contract deploy, the plugin will update the networks.json file with the contract address (and the startBlock), this way you can use the `--network <network_name>` option of the `deploy` command, which will automatically update the address (and startBlock) in the `subgraph.yaml` file to the last contract deployment._
 
 ### Generate the types:
 
@@ -63,34 +73,49 @@ Run `npm run graph-codegen` or `yarn graph-codegen`
 
 Run `npm run graph-local` or `yarn graph-local`
 
-Note: If you run the graph-node against a local Hedera node and see this error in the graph-node console:
+_NOTE: If you run the graph-node against a local Hedera node and see this error in the graph-node console:_
+
 ```
 Trying again after eth_getBlockByNumber(0, false) RPC call failed (attempt #10) with result Err(Ethereum node could not find genesis block), provider: local-rpc-0
 ```
 
-Uncomment [this](./docker-compose.yml#L24) line and restart the node.
+_Add [this](./docker-compose.yml#L24) line to your `docker-compose.yml` and restart the node._
 
-Every time you restart the hedera-node it is recommended to do a clean-up of the graph-node. To do this run `npm run graph-local-clean` or `yarn graph-local-clean`
+_NOTE: Every time you restart the hedera-node it is recommended to do a clean-up of the graph-node. To do this run `npm run graph-local-clean` or `yarn graph-local-clean`_
 
 ### Deploy the subgraph to the local graph-node:
 
-Before deploying the subgraph, be sure to update the address (and startBlock) in `subgraph.yaml` to the address of the deployed Greeter contract.
-
 To deploy the subgraph:
 
 1. Run `npm run create-local` or `yarn create-local`
 2. Run `npm run deploy-local -- --network local` or `yarn deploy-local --network local`
 3. Follow the instructions
 4. After the subgraph is successfully deployed open the [GraphQL playground](http://127.0.0.1:8000/subgraphs/name/subgraph-example/graphql?query=%7B+%0A++gravatars+%7B%0A++++id%0A++++owner%0A++++displayName%0A++++imageUrl%0A++%7D%0A++erc20S+%7B%0A++++id%0A++++supply%0A++++type%0A++++transfers+%7B%0A++++++from%0A++++++to%0A++++++amount%0A++++%7D%0A++%7D%0A++erc721S+%7B%0A++++id%0A++++owner%0A++++type%0A++++tokenId%0A++++transfers+%7B%0A++++++from%0A++++++to%0A++++%7D%0A++%7D%0A%7D%0A) where you can execute queries and fetch indexed data.
 
-### Running the tests:
+## Running the tests:
 
-Note: At this time the whole test workflow can't be proficiently automated, so you'll need to perform some manual steps:
+_NOTE: At this time the whole test workflow can't be proficiently automated, so you'll need to perform some manual steps:_
 
 1. Be sure to start a clean local hedera node. If the node is currently running stop it.
-    - Run `npx hedera stop` to be sure that all containers are stopped and the temp files and volumes have been removed.
-    - Run `npx hedera start --network local-test` to start a new clean node.
+    1. Run `npx hedera stop` to be sure that all containers are stopped and the temp files and volumes have been removed.
+    2. Run `npx hedera start --network local-test` to start a new clean node.
 2. After the node has started, execute `npx hardhat prepare` task, which will deploy and interact with the contracts.
 3. Be sure to start a clean graph-node by executing `yarn/npm run graph-local-clean` and then `yarn/npm run graph-local`
 4. Create and deploy the subgraph by executing `yarn/npm run create-local` and `yarn deploy-local --network local` or `npx run deploy-local -- --network local` and follow the instructions
 5. Execute `npx hardhat test`
+
+
+## HOW TOs:
+
+### Run a private graph-node against testnet, previewnet and mainnet:
+
+The easiest way to run a local `graph-node` against `testnet`, `previewnet` or `mainnet` is using the [docker-compose](https://github.com/graphprotocol/graph-node/tree/master/docker#docker-compose) setup.
+
+1. Copy the content of the provided [docker-compose.yml](https://github.com/graphprotocol/graph-node/blob/master/docker/docker-compose.yml) file, or use the one from the [subgraph-example](./docker-compose.yml)
+2. Replace `'mainnet:http://host.docker.internal:8545'` on [this](https://github.com/graphprotocol/graph-node/blob/master/docker/docker-compose.yml#L22) line with:
+     1. `'mainnet:https://mainnet.hashio.io/api'` for `mainnet`
+     2.  `'testnet:https://testnet.hashio.io/api'` for `testnet`
+     3.  `'previewnet:https://previewnet.hashio.io/api'` for `testnet`
+3. In the `subgraph.yaml` file change the dataSources network with to the network you want to index. Also don't forget to update the address (and the startBlock).
+
+Advanced info on how to set up an indexer could be found in [The Graph Docs](https://thegraph.com/docs/en/indexing/operating-graph-node/) and the [official graph-node GitHub repository](https://github.com/graphprotocol/graph-node)