📖
Read Me
All information here is source from the official DFX Finance GitHub.

DFX V1 Subgraph

Any USD base pair created by the DFX factory is tracked by this subgraph. The subgraph tracks DFX for daily and hourly historical data on TVLs and volumes.
Currently there are 6 USD based stablecoin pairs on Ethereum (Mainnet) and 5 on Polygon.
DFX Subgraph Source: https://github.com/dfx-finance/subgraph​

Ethereum (Mainnet)

Polygon

Setup

  1. 1.
    Go to https://thegraph.com/studio/
  2. 2.
    Connect your MetaMask wallet and sign (This will not cost you any ETH)
  3. 3.
    Create a subgraph called 'dfx-test'
  4. 4.
    Install The Graph's CLI on your terminal npm install -g @graphprotocol/graph-cli
  5. 5.
    Clone this repo git clone https://github.com/dfx-finance/subgraph.git
  6. 6.
    Install dependencies yarn install
  7. 7.
    Go into the directory cd subgraph

Deploy

  1. 1.
    Generate the code from the schema yarn codegen (This should be done every time the schema is changed)
  2. 2.
    Copy the Deploy Key from https://thegraph.com/studio/ under 'dfx-test'
  3. 3.
    In your command line, graph auth --studio
  4. 4.
    Paste your Deploy Key when prompted
  5. 5.
    Deploy to your instance yarn deploy-test:mainnet
  6. 6.
    Set version to 'v0.0.1' and increment as you update the schema and source code.
  7. 7.
    Go back to https://thegraph.com/studio/dfx-test and you can start querying in the Playground even before the subgraph has synced to 100%
  8. 8.
    Run this query to get the latest trades ordered from newest to oldest

Deploy Legacy Explorer (Hosted)

The legacy explorer is the free public subgraph service provided by the graph. It can be seen as the centralized production environment.
  1. 1.
    yarn prepare:mainnet
  2. 2.
    yarn codegen
  3. 3.
    yarn deploy-prod:mainnet

Documentation

Full documentation on how to use GraphQL queries in The Graph playground can be found here.

Debugging

Common issues:

One of the most common issues when changing the schema is all specified fields except for the id must be initialized or the subgraph will fail to index.

For example given this schema for the parent factory contract

1
type DFXFactory @entity {
2
# factory address
3
id: ID!
4
​
5
# pair info
6
pairCount: Int!
7
​
8
# total volume
9
totalVolumeUSD: BigDecimal!
10
​
11
# total liquidity
12
totalLiquidityUSD: BigDecimal!
13
# transactions
14
# txCount: BigInt!
15
}
Copied!

The subsequent mapping definition must have all fields present and defined.

1
factory = new DFXFactory(FACTORY_ADDRESS)
2
factory.pairCount = 0
3
factory.totalVolumeUSD = ZERO_BD
4
factory.totalLiquidityUSD = ZERO_BD
Copied!

Configuration constants must be lowercase (Bad Example)

1
0x84Bf8151394dcF32146965753B28760550f3D7A8
Copied!

(Good Example)

1
0x84bf8151394dcf32146965753b28760550f3d7a8
Copied!
Switching from Ethereum to Polygon and vice versa requires a small change in subgraph\src\helpers.ts.
In fetchRewardsForDuration() there is a function that makes calls to the staking contracts contract.getRewardForDuration() in Ethereum it is just 1 BigDecimal but Polygon the number is inside an array so upon switching between the two there needs to be a small change of contract.getRewardForDuration()[0].

Logging

To help with debugging the The Graph has provided a logging object within the graph-ts module.
1
import { log } from "@graphprotocol/graph-ts";
Copied!
This can be used almost anywhere in your mapping code the provide insight on values that are being defined on your schema. There are four different types of logs that can be defined error, warn, info, debug They all follow the format of string message followed by and string array filled with your variables. They will show up after the subgraph is deployed. For example
1
log.debug("The amount of pairs currently in dfx is {}", [factory.pairCount.toString()])
Copied!
Note: Addresses and transaction hashes must be converted to Hexstrings in order to show up properly in the logging.