Entities#

Entities define the schema of the subgraph, and represent the data that can be queried. Within each entity are sets of fields that store useful information related to the entity. Below is a list of the available entities within the Subgraph, and descriptions for the available fields.

Swap Factory#

The Swap Factory entity is responsible for storing aggregate information across all Swap pairs. It can be used to view stats about total liquidity, volume, amount of pairs and more. There is only one Swap Factory entity in the subgraph.

Field NameValue TypeDescription
idIDfactory address
pairCountBigDecimal all time USD volume across all pairs (USD is derived)
totalVolumeUSDBigDecimalall time USD volume across all pairs (USD is derived)
totalLiquidityUSDBigDecimaltotal liquidity across all pairs stored as a derived USD amount
txCountBigIntall time amount of transactions across all pairs
UntrackedVolumeUSDBigDecimalamount of token in USD traded all time across pairs (no minimum liquidity threshold)

Token#

Stores aggregated information for a specific token across all pairs that token is included in.

Field NameValue TypeDescription
idIDtoken address
symbolStringtoken symbol
nameStringtoken name
decimalsBigInttoken decimals
tradeVolumeBigDecimal amount of token traded all time across all pairs
tradeVolumeUSDBigDecimalamount of token in USD traded all time across pairs (only for tokens with liquidity above minimum threshold)
untrackedVolumeUSDBigDecimalamount of token in USD traded all time across pairs (no minimum liquidity threshold)
txCountBigIntamount of transactions all time in pairs including token
totalLiquidityBigDecimaltotal amount of token provided as liquidity across all pairs
totalSupplyBigDecimaltotal supply of liquidity token distributed to LPs
derivedUSDBigDecimalUSD per token

Pair#

Information about a pair. Includes references to each token within the pair, volume information, liquidity information, and more. The pair entity mirrors the pair smart contract, and also contains aggregated information about use.

Field NameValue TypeDescription
idIDpair contract address
factorySwapFactoryreference to Swap factory entity
token0Tokenreference to token0 as stored in pair contract
token1Tokenreference to token1 as stored in pair contract
reserve0BigDecimalreserve of token0
reserve1BigDecimalreserve of token1
totalSupplyBigDecimaltotal supply of liquidity token distributed to LPs
reserveUSDBigDecimaltotal liquidity amount in pair stored as an amount of USD
trackedReserveUSDBigDecimaltotal liquidity with only tracked amount (see tracked amounts of USD)
token0PriceBigDecimaltoken0 per token1
token1PriceBigDecimaltoken1 per token0
volumeToken0BigDecimalamount of token0 swapped on this pair
volumeToken1BigDecimalamount of token1 swapped on this pair
volumeUSDBigDecimaltotal amount swapped all time in this pair stored in USD (only tracked if USD liquidity is above minimum threshold)
untrackedVolumeUSDBigDecimaltotal amount swapped all time in this pair stored in USD, no minimum liquidity threshold
txCountBigIntall time amount of transactions on this pair
createdAtTimestampBigInttimestamp contract was created
liquidityPositions[LiquidityPosition]rray of liquidity providers, used as a reference to LP entities

User#

A user entity is created for any address that provides liquidity to a pool on Swap. This entity can be used to track open positions for users. LiquidyPosition entities can be referenced to get specific data about each position.

Field NameValue TypeDescription
idIDuser address
liquidityPositions[LiquidityPosition]array of all liquidity positions user has open
usdSwappedBigDecimaltotal USD value swapped

Transaction#

Transaction entities are created for each OKT Chain transaction that contains an interaction within Swap contracts. This subgraph tracks Mint, Burn, and Swap events on the Swap core contracts. Each transaction contains 3 arrays, and at least one of these arrays has a length of 1.

Field NameValue TypeDescription
idIDOKT Chain transaction hash
blockNumberBigIntblock transaction was mined in
timestampBigInttimestamp for transaction
mints[Mint]array of Mint events within the transaction, 0 or greater
burns[Burn]array of Burn events within transaction, 0 or greater
swaps[Swap]array of Swap events within transaction, 0 or greater

Mint#

Mint entities are created for every emitted Mint event on the Swap core contracts. The Mint entity stores key data about the event like token amounts, who sent the transaction, who received the liquidity, and more. This entity can be used to track liquidity provisions on pairs.

Field NameValue TypeDescription
idIDTransaction hash plus index in the transaction mint array
transactionTransactionreference to the transaction Mint was included in
timestampBigInttimestamp of Mint, used to sort recent liquidity provisions
pairPairreference to pair
toBytesrecipient of liquidity tokens
liquidityBigDecimalamount of liquidity tokens minted
senderBytesaddress that initiated the liquidity provision
amount0BigDecimalamount of token0 provided
amount1BigDecimalamount of token1 provided
logIndexBigIntindex in the transaction event was emitted
amountUSDBigDecimalderived USD value of token0 amount plus token1 amount
feeToBytesaddress of fee recipient
feeLiquidityBigDecimalamount of liquidity sent to fee recipient

Burn#

Burn entities are created for every emitted Burn event on the Uniswap core contracts. The Burn entity stores key data about the event like token amounts, who burned LP tokens, who received tokens, and more. This entity can be used to track liquidity removals on pairs.

Field NameValue TypeDescription
idIDTransaction hash plus index in the transaction burn array
transactionTransactionreference to the transaction Burn was included in
timestampBigInttimestamp of Burn, used to sort recent liquidity removals
pairPairreference to pair
toBytesrecipient of tokens
liquidityBigDecimalamount of liquidity tokens burned
senderBytesaddress that initiated the liquidity removal
amount0BigDecimalamount of token0 removed
amount1BigDecimalamount of token1 removed
logIndexBigIntindex in the transaction event was emitted
amountUSDBigDecimalderived USD value of token0 amount plus token1 amount
feeToBytesaddress of fee recipient
feeLiquidityBigDecimalamount of tokens sent to fee recipient

Swap#

Swap entities are created for each token swap within a pair. The Swap entity can be used to get things like swap size (in tokens and USD), sender, recipient and more.

Field NameValue TypeDescription
idIDtransaction hash plus index in Transaction swap array
transactionTransactioneference to transaction swap was included in
timestampBigInttimestamp of swap, used for sorted lookups
pairPairreference to pair
senderBytesaddress that initiated the swap
amount0InBigDecimalamount of token0 sold
amount1InBigDecimalamount of token1 sold
amount0OutBigDecimalamount of token0 received
amount1OutBigDecimalamount of token1 received
toBytesrecipient of output tokens
logIndexBigIntevent index within transaction
amountUSDBigDecimalderived amount of tokens sold in USD

Bundle#

The Bundle is used as a global store of USDT. In Swap, 1USDT is always equal to $1,thus we use USDT as our common base token to derive USD values of other Tokens.

Field NameValue TypeDescription
idIDconstant 1
usdPriceBigDecimalalways equal to 1

Historical Entities#

The subgraph tracks information grouped in daily buckets, using timestamps provided by contract events. These entities can be used to query things like total volume on a given day, price of a token on a given day, etc.

SwapDayData#

Tracks data across all pairs aggregated into a daily bucket.

Field NameValue TypeDescription
idIDunix timestamp for start of day / 86400 giving a unique day index
dateIntunix timestamp for start of day
dailyVolumeUSDBigDecimaltotal volume across all pairs on this day, stored as a derived amount of USD
totalVolumeUSDBigDecimalall time volume across all pairs in USD up to and including this day
totalLiquidityUSDBigDecimaltotal liquidity across all pairs in USD up to and including this day
maxStoredIntreference used to store most liquid tokens, used for historical liquidity charts
mostLiquidTokens[TokenDayData!]tokens with most liquidity in Swap
txCountBigIntnumber of transactions throughout this day

PairDayData#

Tracks pair data across each day.

Field NameValue TypeDescription
idIDpair contract address and day id (day start timestamp in unix / 86400) concatenated with a dash
dateIntunix timestamp for start of day
pairAddressBytesaddress for pair contract
token0Tokenreference to token0
token1Tokenreference to token1
reserve0BigDecimal reserve of token0 (updated during each transaction on pair)
reserve01BigDecimalreserve of token1 (updated during each transaction on pair)
totalSupplyBigDecimaltotal supply of liquidity token distributed to LPs
reserveUSDBigDecimalreserve of token0 plus token1 stored as a derived USD amount
dailyVolumeToken0BigDecimaltotal amount of token0 swapped throughout day
dailyVolumeToken1BigDecimaltotal amount of token1 swapped throughout day
dailyVolumeUSDBigDecimaltotal volume within pair throughout day
dailyTxnsBigIntamount of transactions on pair throughout day

TokenDayData#

Tracks token data aggregated across all pairs that include token.

Field NameValue TypeDescription
idIDtoken address and day id (day start timestamp in unix / 86400) concatenated with a dash
dateIntunix timestamp for start of day
tokenTokenreference to token entity
dailyVolumeTokenBigDecimal amount of token swapped across all pairs throughout day
dailyVolumeUSDBigDecimalamount of token swapped across all pairs throughout day stored as a derived amount of USD
dailyTxnsBigIntamount of transactions with this token across all pairs
totalLiquidityTokenBigDecimaltoken amount of token deposited across all pairs
totalLiquidityUSDBigDecimaltoken amount of token deposited across all pairs stored as amount of USD
priceUSDBigDecimalprice of token in derived USD