Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ianlapham authored Jun 22, 2020
1 parent 57e3377 commit 91751da
Showing 1 changed file with 2 additions and 51 deletions.
53 changes: 2 additions & 51 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,53 +1,4 @@
# Uniswap V2 Subgraph
# Uniswap V2 Subgraph Testing

[Uniswap](https://uniswap.org/) is a decentralized protocol for automated token exchange on Ethereum.
This subgraph is for testing specifc interactions on a limited set of exchanges.

This subgraph dynamically tracks any pair created by the uniswap factory. It tracks of the current state of Uniswap 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 Uniswap, 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 uniswap-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](https://thegraph.com/docs/graphql-api). These queries can be used locally or in The Graph Explorer playground.

## Key Entity Overviews

#### UniswapFactory

Contains data across all of Uniswap V2. This entity tracks important things like total liquidity (in ETH 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 Uniswap 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 Uniswap Data

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

```graphql
{
uniswapFactory(id: "1") {
pairCount
totalVolumeUSD
totalLiquidityUSD
}
}
```

0 comments on commit 91751da

Please sign in to comment.