Skip to content

Commit

Permalink
Update subgraph readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
soilking committed Oct 11, 2024
1 parent 8ee17d1 commit cb57a6c
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 22 deletions.
18 changes: 10 additions & 8 deletions projects/subgraph-basin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,21 @@

### Subgraphs

All currently used subgraphs live on a centralized host controlled by beanstalk farms.

- [Testing Subgraph](https://graph.node.bean.money/subgraphs/name/basin-testing)
- Used during local development for debugging and rapid iteration.
- [Dev Subgraph](https://graph.node.bean.money/subgraphs/name/basin-dev)
- Used for testing fixes or improvements made in the testing subgraph.
- [Canonical Subgraph](https://graph.node.bean.money/subgraphs/name/basin)
- [Testing Subgraph](https://graph.bean.money/basin-testing)
- The bleeding edge. Used for debugging and rapid iteration.
- [Dev Subgraph](https://graph.bean.money/basin-dev)
- Used for testing fixes or improvements made in the testing subgraph before going live.
- [Canonical Subgraph](https://graph.bean.money/basin)
- Stable deployment and current source of truth for UI and other production processes.

All subgraphs are hosted on a mix of Alchemy and Graph Network, with responses served from a proxy api managed by Beanstalk Farms. Read more about the advantages of the proxy here: https://github.com/BeanstalkFarms/Subgraph-Proxy.

Looking to analyze data from Basin on Ethereum? Append "\_eth" to each of the above links.

### Testing

To test with Docker, the first time you will need to run `yarn run graph test -d`. This will build the `matchstick` Docker image. Then, you can use the `yarn testd` script to run all tests. Alternatively, use `yarn testd-named <TestName1> ...` to run specific tests. I have found running in Docker to be preferred since otherwise there can be issues with console output and some test cases fail silently.

### Deploying

When using graph cli commands, you will often need to specify which manifest file should be used. This is necessary to support multiple chains in the same codebase. The commands which need it will be evident - as they will fail when unable to find a `subgraph.yaml` file. In those commands, include `./manifest/${chain}.yaml` as the final argument to the command. See scripts inside `package.json` for examples.
When using graph cli commands, you will often need to specify which manifest file should be used. This is necessary to support multiple chains in the same codebase. The commands which need it will be evident - as they will fail when unable to find a `subgraph.yaml` file. In those commands, include `./manifest/${chain}.yaml` as the final argument to the command. See scripts inside `package.json` for examples.
16 changes: 9 additions & 7 deletions projects/subgraph-bean/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,17 @@

### Subgraphs

All currently used subgraphs live on a centralized host controlled by beanstalk farms.

- [Testing Subgraph](https://graph.node.bean.money/subgraphs/name/bean-testing)
- Used during local development for debugging and rapid iteration.
- [Dev Subgraph](https://graph.node.bean.money/subgraphs/name/bean-dev)
- Used for testing fixes or improvements made in the testing subgraph.
- [Canonical Subgraph](https://graph.node.bean.money/subgraphs/name/bean)
- [Testing Subgraph](https://graph.bean.money/bean-testing)
- The bleeding edge. Used for debugging and rapid iteration.
- [Dev Subgraph](https://graph.bean.money/bean-dev)
- Used for testing fixes or improvements made in the testing subgraph before going live.
- [Canonical Subgraph](https://graph.bean.money/bean)
- Stable deployment and current source of truth for UI and other production processes.

All subgraphs are hosted on a mix of Alchemy and Graph Network, with responses served from a proxy api managed by Beanstalk Farms. Read more about the advantages of the proxy here: https://github.com/BeanstalkFarms/Subgraph-Proxy.

Looking to analyze data from when Beanstalk was on Ethereum? Append "\_eth" to each of the above links.

### Testing

To test with Docker, the first time you will need to run `yarn run graph test -d`. This will build the `matchstick` Docker image. Then, you can use the `yarn testd` script to run all tests. Alternatively, use `yarn testd-named <TestName1> ...` to run specific tests. I have found running in Docker to be preferred since otherwise there can be issues with console output and some test cases fail silently.
Expand Down
16 changes: 9 additions & 7 deletions projects/subgraph-beanstalk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,17 @@

### Subgraphs

All currently used subgraphs live on a centralized host controlled by beanstalk farms.

- [Testing Subgraph](https://graph.node.bean.money/subgraphs/name/beanstalk-testing)
- Used during local development for debugging and rapid iteration.
- [Dev Subgraph](https://graph.node.bean.money/subgraphs/name/beanstalk-dev)
- Used for testing fixes or improvements made in the testing subgraph.
- [Canonical Subgraph](https://graph.node.bean.money/subgraphs/name/beanstalk)
- [Testing Subgraph](https://graph.bean.money/beanstalk-testing)
- The bleeding edge. Used for debugging and rapid iteration.
- [Dev Subgraph](https://graph.bean.money/beanstalk-dev)
- Used for testing fixes or improvements made in the testing subgraph before going live.
- [Canonical Subgraph](https://graph.bean.money/beanstalk)
- Stable deployment and current source of truth for UI and other production processes.

All subgraphs are hosted on a mix of Alchemy and Graph Network, with responses served from a proxy api managed by Beanstalk Farms. Read more about the advantages of the proxy here: https://github.com/BeanstalkFarms/Subgraph-Proxy.

Looking to analyze data from when Beanstalk was on Ethereum? Append "\_eth" to each of the above links.

### Testing

To test with Docker, the first time you will need to run `yarn run graph test -d`. This will build the `matchstick` Docker image. Then, you can use the `yarn testd` script to run all tests. Alternatively, use `yarn testd-named <TestName1> ...` to run specific tests. I have found running in Docker to be preferred since otherwise there can be issues with console output and some test cases fail silently.
Expand Down

0 comments on commit cb57a6c

Please sign in to comment.