/Koffeeswap-subgraph

Primary LanguageTypeScriptGNU General Public License v3.0GPL-3.0

KoffeeSwap Subgraph

KoffeeSwap is a decentralized token exchange on KuCoin Community Chain.

This subgraph dynamically tracks any pair created by the KoffeeSwap factory. It tracks of the current state of KoffeeSwap contracts, and contains derived stats for things like historical data and USD prices.

  • aggregated data across pairs and tokens,
  • data on individual pairs and tokens,
  • data on transactions
  • data on liquidity providers
  • historical data on KoffeeSwap, pairs or tokens, aggregated by day

Running Locally

Make sure to update package.json settings to point to your own graph account.

Queries

Below are a few ways to show how to query the koffeeswap-subgraph for data. The queries show most of the information that is queryable, but there are many other filtering options that can be used, just check out the querying api. These queries can be used locally or in The Graph Explorer playground.

Key Entity Overviews

KoffeeSwapFactory

Contains data across all of KoffeeSwap V2. This entity tracks important things like total liquidity (in KCS and USD, see below), all time volume, transaction count, number of pairs and more.

Token

Contains data on a specific token. This token specific data is aggregated across all pairs, and is updated whenever there is a transaction involving that token.

Pair

Contains data on a specific pair.

Transaction

Every transaction on KoffeeSwap is stored. Each transaction contains an array of mints, burns, and swaps that occured within it.

Mint, Burn, Swap

These contain specifc information about a transaction. Things like which pair triggered the transaction, amounts, sender, recipient, and more. Each is linked to a parent Transaction entity.

Example Queries

Querying Aggregated KoffeeSwap Data

This query fetches aggredated data from all KoffeeSwap pairs and tokens, to give a view into how much activity is happening within the whole protocol.

{
  koffeeSwapFactories(first: 1) {
    pairCount
    totalVolumeUSD
    totalLiquidityUSD
  }
}