Vesper Subgraph

Live subgraph deployed in the Graph Explorer.

Setup

Prerequisites

• Docker
• Node v15

Note The mappings code is written in AssemblyScript, which is (most of the time - there are exceptions) a subset of Typescript. It is recommended to read the quirks section and the implementation status section to see which limitations the language has in comparison to Javascript/Typescript.

Local Environment

• Download the graph-node repo in a separated folder

git clone https://github.com/graphprotocol/graph-node/

• Run the following command in the docker folder if the OS is linux:

cd graph-node/docker
# only for linux
./setup.sh

• The ethereum variable needs to be updated to set the network and the node url. Update in docker-compose.yml in the line 20 with the following pattern:

# pattern is ethereum: <network-name>:<url>
ethereum: mainnet:https://some-url:8545

(See notes below for further considerations).

• Start the docker container

docker-compose up

• Go back to this repo folder. To install the dependencies, run

npm i

• Run the following command which will generate then subgraph.yml, the types files and then deploy the subgraph locally. You may be prompted a label version.

npm run dev

• After that, the docker container should start syncing for each pool. The url to open the GraphQL api will be in the output (in the form of http://127.0.0.1:8000/subgraphs/name/vesperfi/vesper-subgraph/graphql).
  Open it in the browser and use GraphQL to query the data.

Whenever you change schema.graphql, the template in subgraph.template.yml or the pools used in subgraph-generator, the following command must be run to regenerate all the types without deploying

npm run bootstrap
# use npm run dev if you want to also deploy locally

Wiping out the indexed information can be done by removing the data folder in graph-node/docker

Notes

• The node url must support batch requests.
• If another network is used (like rinkeby), the subgraph.template.yaml must be updated. The names in the docker-compose.yml (in the graph-node repo) and the generated subgraph.yml must be the same.

Query Model

Checkout the Vesper Revenue Model.
This is an example query:

{
  pools(id: "pool-id") {
    id
    poolName
    poolVersion
    poolToken
    poolTokenDecimals
    collateralToken
    collateralTokenDecimals
    totalSupply
    totalSupplyUsd
    totalDebt
    totalDebtUsd
    protocolRevenue
    protocolRevenueUsd
    supplySideRevenue
    supplySideRevenueUsd
    totalRevenue
    totalRevenueUsd
  }
}

Checkout the GraphQL schema for further information of each field and their types.

Deployment

Testing deploy in Graph Studio

Go to Graph Studio and connect a wallet. Then, the following commands must be run.

# The deployment id can be copied from the Details tab
# This is only required once
./node_modules/.bin/graph auth  --studio <deployment-id>
# make sure the latest version of the generated files is correct
npm run bootstrap && npm run build
# push to graph studio
./node_modules/.bin/graph deploy --studio vesper-subgraph-test -l <VERSION>

<VERSION> follows a semantic versioning schema and must be incremented on each deploy.

Further information on the steps here here.

Troubleshooting errors in Graph Studio

Follow these steps to query the state of the subgraph if it fails syncing and there are no logs.

1. Go to graphiql-online.
2. Enter API https://api.thegraph.com/index-node/graphql
3. Get your Deployment ID - you will find it in the Details section in Graph Studio (keep in mind it changes on every deployment)
4. Run the following query, replacing the <DEPLOYMENT-ID>

{
  indexingStatuses(subgraphs: ["<DEPLOYMENT-ID>"]) {
    subgraph
    synced
    health
    entityCount
    fatalError {
      handler
      message
      deterministic
      block {
        hash
        number
      }
    }
    chains {
      chainHeadBlock {
        number
      }
      earliestBlock {
        number
      }
      latestBlock {
        number
      }
    }
  }
}