SushiSwap Subgraph

Setup

• configure chain on ./config files
• cd subgraphs/exchange
• yarn run codegen && yarn run build && yarn run deploy:matic

Info

Aims to deliver analytics & historical data for SushiSwap. Still a work in progress. Feel free to contribute!

The Graph exposes a GraphQL endpoint to query the events and entities within the SushiSwap ecosytem.

Current subgraph locations:

1. Exchange: Includes all SushiSwap Exchange data with Price Data, Volume, Users, etc:

   • https://thegraph.com/explorer/subgraph/sushiswap/exchange (mainnet)
   • https://thegraph.com/explorer/subgraph/sushiswap/bsc-exchange (bsc)
   • https://q.hg.network/okex-exchange/oec (okex)
   • https://thegraph.com/explorer/subgraph/sushiswap/xdai-exchange (xdai)
   • https://q.hg.network/heco-exchange/heco (heco)
   • https://thegraph.com/explorer/subgraph/sushiswap/matic-exchange (matic)
   • https://thegraph.com/explorer/subgraph/sushiswap/fantom-exchange (fantom)
   • https://thegraph.com/explorer/subgraph/sushiswap/arbitrum-exchange (arbitrum)
   • https://thegraph.com/explorer/subgraph/sushiswap/celo-exchange (celo)
   • https://thegraph.com/explorer/subgraph/sushiswap/avalanche-exchange (avalanche)
   • https://sushi.graph.t.hmny.io/subgraphs/name/sushiswap/harmony-exchange (harmony)

2. Master Chef: Indexes all MasterChef staking data: https://thegraph.com/explorer/subgraph/sushiswap/master-chef

3. Sushi Maker: Indexes the SushiMaker contract, that handles the serving of exchange fees to the SushiBar: https://thegraph.com/explorer/subgraph/sushiswap/sushi-maker

4. Sushi Timelock: Includes all of the timelock transactions queued, executed, and cancelled: https://thegraph.com/explorer/subgraph/sushiswap/sushi-timelock

5. Sushi Bar: Indexes the SushiBar, includes data related to the bar: https://thegraph.com/explorer/subgraph/sushiswap/sushi-bar

6. SushiSwap-SubGraph-Fork (on uniswap-fork branch): Indexes the SushiSwap Factory, includes Price Data, Pricing, etc: https://thegraph.com/explorer/subgraph/jiro-ono/sushiswap-v1-exchange

7. BentoBox: Indexes BentoBox and Kashi Lending data: https://thegraph.com/explorer/subgraph/sushiswap/bentobox

8. MiniChef: Indexes MiniChef contracts that are used in place of MasterChefs for alternate networks:

• https://thegraph.com/explorer/subgraph/sushiswap/matic-minichef

To setup and deploy

For any of the subgraphs follow below steps

1. CD in to the subgraph directory subgraphs:[subgraphName]
2. Run the yarn run prepare:[network] to prepare yaml file from template.yaml and network specific data.
3. Run the yarn run codegen command to prepare the TypeScript sources for the GraphQL (generated/schema) and the ABIs (generated/[ABI]/*)
4. [Optional] run the yarn run build command to build the subgraph. Can be used to check compile errors before deploying.
5. Run graph auth https://api.thegraph.com/deploy/ <ACCESS_TOKEN>
6. Deploy via yarn run deploy.

It is also possible to follow steps 2-4 from root directory. Given you are running from root, it will try to prepare/codegen/build all subgraphs. So to ensure successful run for prepare:[network] command, network of your interest, all subgraphs should have this command.

To query these subgraphs

Please use our node utility: sushi-data.

Note: This is in on going development as well.

Example Queries

We will add to this as development progresses.

Maker

{
  maker(id: "0x6684977bbed67e101bb80fc07fccfba655c0a64f") {
    id
    servings(orderBy: timestamp) {
      id
      server {
        id
      }
      tx
      pair
      token0
      token1
      sushiServed
      block
      timestamp
    }
  }
  servers {
    id
    sushiServed
    servings(orderBy: timestamp) {
      id
      server {
        id
      }
      tx
      pair
      token0
      token1
      sushi
      block
      timestamp
    }
  }
}

Community Subgraphs

1. croco-finance fork of this repo with slight modifications - deployment, code
2. croco-finance dex-rewards-subgraph which tracks SLPs in MasterChef and all the corresponding rewards individually. (can be used for analysis of user's positions) - deployment, code