|
| 1 | +# Add contract as dataSource and use local Subgraph + Ganache + Brownie |
| 2 | +To develop new features on top of `ocean-subgraph`, it pays to deploy a local Subgraph that consumes from Ganache, so you can deploy your Contracts, execute their functionality, and query the Subgraph to verify Events are being Handled correctly, w/ the right Schema being yielded. |
| 3 | + |
| 4 | +The following doc takes you through: |
| 5 | +1. Configuring `docker-compose.yml` to run an internal Subgraph that consumes from a local Ganache. |
| 6 | +2. Configuring `df-py` + Brownie to connect to the `ocean-subgraph` Ganache so we can deploy our local contracts. |
| 7 | +3. Adding our smart contract as a dataSource for our internal Subgraph. We can then handle contract events, and transform that data into queryable entities using GQL. |
| 8 | +4. Finally, we can hook our contracts into Testing & verifying that your subgraph is working as intended. |
| 9 | + |
| 10 | +Note 1: For this tutorial, you should be using multiple terminal windows. These will be referred to at the top of each section. |
| 11 | + |
| 12 | +Note 2: For this example, we're going to use the `df-py` repository and integrate `veAllocate` contract into `ocean-subgraph` |
| 13 | + |
| 14 | +Note 3: For the sake of versatility, the example below is being executed using `df-py` while verification is being done by hand by viewing & querying GQL on the browser. |
| 15 | + |
| 16 | +### 1. ocean-subgraph - Add & Connect Ganache |
| 17 | +Section 1 takes place inside `ocean-subgraph` terminal window. |
| 18 | + |
| 19 | +You should have this repository configured and working on your machine. |
| 20 | + |
| 21 | +We now need to update `./docker/docker-compose.yml` to implement a local instance of Ganache. Our `graph-node` needs to listen to Ganache for events, so we update the ethereum url. |
| 22 | +``` |
| 23 | +services: |
| 24 | + ganache: |
| 25 | + image: trufflesuite/ganache-cli:latest |
| 26 | + ports: |
| 27 | + - 8545:8545 |
| 28 | + entrypoint: ["node", "/app/ganache-core.docker.cli.js", "--db", "./ganache_cache","--chainId","0x2324","--networkId","0x2324","--gasLimit","10000000000","--gasPrice","1","---hardfork","istanbul","--mnemonic","${GANACHE_MNEMONIC}", "-e", "100", "-a", "20"] |
| 29 | + graph-node: |
| 30 | + environment: |
| 31 | + ethereum: 'development:http://ganache:8545' |
| 32 | +``` |
| 33 | + |
| 34 | +Great, our docker environment is now setup. We can finally deploy it by typing `docker-compose up` inside of `./docker/`. |
| 35 | + |
| 36 | +### 2a. df-py - Configure to connect to Subgraph |
| 37 | +Section 2 takes place inside `df-py` terminal window. |
| 38 | + |
| 39 | +You should have this repository configured and working on your machine. |
| 40 | + |
| 41 | +First, we make sure that we're inside our venv by typing `source venv/bin/activate/`. Again, we're assuming your requirements.txt, and other dependencies have been properly initialized. |
| 42 | + |
| 43 | +We now `df-py` connect to Ganache via Brownie. To do this, we're going to add a network so Brownie can listen to our Ganache service. |
| 44 | +``` |
| 45 | +brownie networks add Ethereum subgraph-ganache host=http://127.0.0.1:8545, chainid=8996 |
| 46 | +``` |
| 47 | + |
| 48 | +We then update our `brownie-config.yaml` so that it uses the network above by default. |
| 49 | +``` |
| 50 | +networks: |
| 51 | + default: subgraph-ganache |
| 52 | +``` |
| 53 | + |
| 54 | +You should now be able to verify that the accounts from `subgraph-ganache` are working from inside `df-py` brownie. |
| 55 | +``` |
| 56 | +brownie console --network subgraph-ganache |
| 57 | +>>> accounts[0].balance() |
| 58 | +100000000000000000000 |
| 59 | +``` |
| 60 | + |
| 61 | +### 2b. df-py - Configure dftools and deploy contracts |
| 62 | +This section continues from Section 2. |
| 63 | + |
| 64 | +We can now, also configure dftools to use accounts from Ganache, and deploy contracts into `ocean-subgraph`. |
| 65 | + |
| 66 | +Look inside the `ocean-subgraph` terminal for the private accounts that were generated for you inside of Ganache. Copy one of their private keys, and do the following inside of `df-py/(venv)/` |
| 67 | +``` |
| 68 | +export DFTOOL_KEY=0xYourUserPrivateKeyFromGanache |
| 69 | +export WEB3_INFURA_PROJECT_ID=YourInfuraKey |
| 70 | +``` |
| 71 | + |
| 72 | +You should now be able to deploy a newToken + veOCEAN + veAllocate contracts. |
| 73 | +``` |
| 74 | + // deploy a new token |
| 75 | + dftool newToken 8996 |
| 76 | + |
| 77 | + // use the token address from above to deploy veOcean |
| 78 | + dftool newVeOcean 8996 token_address |
| 79 | +
|
| 80 | + // deploy veAllocate |
| 81 | + dftool newVeAllocate 8996 |
| 82 | +``` |
| 83 | + |
| 84 | +You will need the address from the new `veAllocate` contract you just deployed for the next section. This contract will be used in the future so our subgraph can listen for events. |
| 85 | + |
| 86 | +### 3a. ocean-subgraph - Initialize the project |
| 87 | +Section 3 takes place inside `ocean-subgraph` terminal. |
| 88 | + |
| 89 | +We're going to now generate `subgraph.yaml` so we can start connecting the veOCEAN contract into the logic of `ocean-subpgrah`. |
| 90 | + |
| 91 | +We begin by running the following node script from the root folder. |
| 92 | +``` |
| 93 | +node ./scripts/generatenetworkssubgraphs.js |
| 94 | +``` |
| 95 | + |
| 96 | +Here, we're going to configure our local `subgraph.yaml` file so we can serve our local ganache, contracts, and everything that `df-py` depends on. |
| 97 | + |
| 98 | +Use this file for all of your development until you have things sorted out. If you make any mistakes, you can just recreate the file. You should make your final changes inside of `subgraph.template.yaml` before submitting a PR. |
| 99 | + |
| 100 | +### 3b. ocean-subgraph - Configure dataSources |
| 101 | + |
| 102 | +We now configure our `subgraph.yaml` to talk to ganache and add our veAllocate Contract as a dataSource. |
| 103 | + |
| 104 | +Our first step is to reset our `subgraph.yaml` so that it can consume all the events. Do a search for `startBlock` and make sure all params are initialized to 0. |
| 105 | +``` |
| 106 | +- kind: ethereum/contract |
| 107 | + source: |
| 108 | + startBlock: 0 |
| 109 | +``` |
| 110 | + |
| 111 | +We then add our contract as a dataSource. We get our address from Section 2b `dftool newVeAllocate 8996` and enter it in the `dataSources` section of the `subgraph.yaml` file. |
| 112 | +``` |
| 113 | +dataSources: |
| 114 | + - kind: ethereum/contract |
| 115 | + name: veAllocate |
| 116 | + network: development |
| 117 | + source: |
| 118 | + address: 0x0000000000000000000000000000000 |
| 119 | + abi: veAllocate |
| 120 | + startBlock: 0 |
| 121 | + mapping: |
| 122 | + kind: ethereum/events |
| 123 | + apiVersion: 0.0.6 |
| 124 | + language: wasm/assemblyscript |
| 125 | + file: ./src/mappings/veAllocate.ts |
| 126 | + entities: |
| 127 | + - veAllocate |
| 128 | + abis: |
| 129 | + - name: veAllocate |
| 130 | + file: ./abis/veAllocate.json |
| 131 | + eventHandlers: |
| 132 | + - event: AllocationSet(indexed address,indexed address,indexed uint256,uint256) |
| 133 | + handler: handleAllocationSet |
| 134 | +``` |
| 135 | + |
| 136 | +As you can see, we have also imported our `veAllocate.json ABI` file into the project, added the contract events we want to handle, and created a mapping script `./src/mappings/veAllocate.ts` so we can handle all the vents for the Subgraph. |
| 137 | + |
| 138 | +Note: This tutorial will not go into details of how to do this work. Someone can create a separate guide on how to handle internal logic, define GraphQL entities, and save records into GraphQL. |
| 139 | + |
| 140 | +_Please review the PR associated with this README for more intuition on this_ |
| 141 | + |
| 142 | +### 4a. ocean-subgraph - run: `npm run codegen` |
| 143 | +From the root folder run this command. |
| 144 | + |
| 145 | +You'll have to do this again every time you change `schema.graphql` |
| 146 | + |
| 147 | +### 4b. ocean-subgraph - run: `npm run create:local` |
| 148 | +From the root folder run this command. |
| 149 | + |
| 150 | +You'll have to do this again every time you run step 5a. |
| 151 | + |
| 152 | +### 4c. ocean-subgraph - run: `npm run deploy:local` |
| 153 | +From the root folder run this command. |
| 154 | + |
| 155 | +You'll have to do this again when you write any new subgraph code (mappings, utils, etc...). |
| 156 | + |
| 157 | +### 5. ocean-subgraph - restart docker |
| 158 | +Restart docker containers via `docker-compose up` |
| 159 | + |
| 160 | +### 6. df-py - Execute onchain events + query subgraph |
| 161 | +You can now start performing your onchain + contract tests and see records inside of your local subgraph. |
| 162 | + |
| 163 | +As an example, you may use the following command inside `dftools` to generate many onchain events for Ganache. |
| 164 | +``` |
| 165 | +dftool manyrandom 8996 |
| 166 | +``` |
0 commit comments