cerc-io/watcher-ts
16
1
Fork 0
mirror of https://github.com/cerc-io/watcher-ts synced 2024-11-19 20:36:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Aggregation in entities (#109)

Browse Source 
* Analyse entity aggregations in uniswap subgraph.

* Analyse entity aggregation for Day data and Hour data entities.

* Design notes.

* Reorg, split analysis files.

Co-authored-by: nikugogoi <95nikass@gmail.com>
This commit is contained in:
Ashwin Phatak 2021-06-30 17:16:50 +05:30 committed by GitHub
parent 69f4cf3513
commit d5608f637a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 1168 additions and 183 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

182
packages/uniswap/README.md
View File

@ -10,189 +10,9 @@
Lint schema graphql files.
```bash
$ yarn lint:schema frontend-schema.graphql
$ yarn lint:schema schema/frontend.graphql
```
## View Methods in Uniswap V3 Core
* https://github.com/Uniswap/uniswap-v3-core/blob/main/contracts/NoDelegateCall.sol
- checkNotDelegateCall (private)
* https://github.com/Uniswap/uniswap-v3-core/blob/main/contracts/UniswapV3Pool.sol#L158
- _blockTimestamp (internal)
- balance0 (private)
- balance1 (private)
- snapshotCumulativesInside (external)
- observe (external)
* https://github.com/Uniswap/uniswap-v3-core/blob/main/contracts/libraries/Oracle.sol
- binarySearch (private)
- getSurroundingObservations (private)
- observeSingle (internal)
- observe (internal)
* https://github.com/Uniswap/uniswap-v3-core/blob/main/contracts/libraries/Position.sol
- get (internal)
* https://github.com/Uniswap/uniswap-v3-core/blob/main/contracts/libraries/Tick.sol
- getFeeGrowthInside (internal)
* https://github.com/Uniswap/uniswap-v3-core/blob/main/contracts/libraries/TickBitmap.sol
- nextInitializedTickWithinOneWord (internal)
## Queries in Uniswap subgraph frontend
Actual queries are listed in [queries](./queries.md) file.
- uniswap-v3 endpoint (https://api.thegraph.com/subgraphs/name/ianlapham/uniswap-v3-alt)
* PoolDayData
- poolDayDatas (https://github.com/Uniswap/uniswap-v3-info/blob/master/src/data/pools/chartData.ts)
* Pool
- pools
* https://github.com/Uniswap/uniswap-v3-info/blob/master/src/data/pools/poolData.ts
* https://github.com/Uniswap/uniswap-v3-info/blob/master/src/data/pools/topPools.ts
* https://github.com/Uniswap/uniswap-v3-info/blob/master/src/data/search/index.ts
* https://github.com/Uniswap/uniswap-v3-info/blob/master/src/data/tokens/poolsForToken.ts
- pool
* https://github.com/Uniswap/uniswap-v3-info/blob/master/src/data/pools/tickData.ts
* Tick
- tick (https://github.com/Uniswap/uniswap-v3-info/blob/master/src/data/pools/tickData.ts)
* Mint
- mints
* https://github.com/Uniswap/uniswap-v3-info/blob/master/src/data/pools/transactions.ts
* https://github.com/Uniswap/uniswap-v3-info/blob/master/src/data/tokens/transactions.ts
* UniswapDayData
- uniswapDayDatas (https://github.com/Uniswap/uniswap-v3-info/blob/master/src/data/protocol/chart.ts)
* Factory
- factories (https://github.com/Uniswap/uniswap-v3-info/blob/master/src/data/protocol/overview.ts)
* Transaction
- transactions (https://github.com/Uniswap/uniswap-v3-info/blob/master/src/data/protocol/transactions.ts)
* Token
- tokens
* https://github.com/Uniswap/uniswap-v3-info/blob/master/src/data/search/index.ts
* (queried by block) https://github.com/Uniswap/uniswap-v3-info/blob/master/src/data/tokens/tokenData.ts
* https://github.com/Uniswap/uniswap-v3-info/blob/master/src/data/tokens/topTokens.ts
- token queried by block (https://github.com/Uniswap/uniswap-v3-info/blob/master/src/data/tokens/priceData.ts)
* TokenDayData
- tokenDayDatas (https://github.com/Uniswap/uniswap-v3-info/blob/master/src/data/tokens/chartData.ts)
* Bundle
- bundle queried by block (https://github.com/Uniswap/uniswap-v3-info/blob/master/src/data/tokens/priceData.ts)
- bundles (https://github.com/Uniswap/uniswap-v3-info/blob/master/src/hooks/useEthPrices.ts)
* TokenHourData
- tokenHourDatas (https://github.com/Uniswap/uniswap-v3-info/blob/master/src/data/tokens/priceData.ts)
* Swap
- swaps (https://github.com/Uniswap/uniswap-v3-info/blob/master/src/data/tokens/transactions.ts)
* Burn
- burns (https://github.com/Uniswap/uniswap-v3-info/blob/master/src/data/tokens/transactions.ts)
- ethereum-blocks endpoint (https://api.thegraph.com/subgraphs/name/blocklytics/ethereum-blocks)
t${timestamp}:blocks (https://github.com/Uniswap/uniswap-v3-info/blob/master/src/hooks/useBlocksFromTimestamps.ts)
- Checking subgraph health (https://thegraph.com/docs/deploy-a-subgraph#checking-subgraph-health)
https://github.com/Uniswap/uniswap-v3-info/blob/master/src/data/application/index.ts#L5
## Mapping Event handlers in Uniswap subgraph
* handlePoolCreated (Factory contract - PoolCreated event)
- Data from event
- Entities
* Factory
* Bundle
* Pool
* Token
- Contract calls
* ERC20 (symbol, name, totalSupply, decimals)
* ERC20SymbolBytes (symbol)
* ERC20NameBytes (name)
- Create new Template contract (Pool)
* NonfungiblePositionManager contract
- Handlers (Similar code)
* handleIncreaseLiquidity (IncreaseLiquidity event)
* handleDecreaseLiquidity (DecreaseLiquidity event)
* handleCollect (Collect event)
* handleTransfer (Transfer event)
- Data from event
- Entities
* Position
* Transaction
* Token
- Contract calls
* NonfungiblePositionManager (positions)
* Factory (getPool)
* handleInitialize (Pool contract - Initialize event)
- Data from event
- Entities
* Pool
* Token
* Bundle
* PoolDayData
* PoolHourData
* handleSwap (Pool contract - Swap event)
- Data from event
- Entities
* Bundle
* Factory
* Pool
* Token
* Transaction
* Swap
* UniswapDayData
* PoolDayData
* PoolHourData
* TokenDayData
* TokenHourData
- Contract calls
* Pool (feeGrowthGlobal0X128, feeGrowthGlobal1X128)
* handleMint (Pool contract - Mint event)
- Data from event
- Entities
* Bundle
* Pool
* Factory
* Token
* Transaction
* Mint
* Tick
* UniswapDayData
* PoolDayData
* PoolHourData
* TokenDayData
* TokenHourData
* handleBurn (Pool contract - Burn event)
- Data from event
- Entities
* Bundle
* Pool
* Factory
* Token
* Burn
* Tick
* UniswapDayData
* PoolDayData
* PoolHourData
* TokenDayData
* TokenHourData
- Extra methods
* store.remove (remove Tick entity)
## References
* https://github.com/Uniswap/uniswap-v3-core

965
packages/uniswap/aggregation.md Normal file
View File

@ -0,0 +1,965 @@
# Aggregation in Entities
- Pool
* id (pool address)
- Factory PoolCreated event
```ts
let pool = new Pool(event.params.pool.toHexString()) as Pool
```
* feeTier (fee amount)
- Factory PoolCreated event
```ts
pool.feeTier = BigInt(event.params.fee)
```
* sqrtPrice (current price tracker)
- Pool Initialize event, Swap event
```ts
pool.sqrtPrice = event.params.sqrtPriceX96
```
* tick (current tick)
- Pool Initialize event, Swap event
```ts
pool.tick = BigInt(event.params.tick)
```
* token0Price (token0 per token1), token1Price(token1 per token0)
- Pool Swap event
```ts
let pool = Pool.load(event.address.toHexString())
let token0 = Token.load(pool.token0)
let token1 = Token.load(pool.token1)
let prices = sqrtPriceX96ToTokenPrices(pool.sqrtPrice, token0 as Token, token1 as Token)
pool.token0Price = prices[0]
pool.token1Price = prices[1]
```
* sqrtPriceX96ToTokenPrices (https://github.com/Uniswap/uniswap-v3-subgraph/blob/main/src/utils/pricing.ts#L39)
- Uses Token entity `decimals` field
* totalValueLockedToken0 (total token 0 across all ticks), totalValueLockedToken1 (total token 1 across all ticks)
- Pool Mint event, Swap event
```ts
let pool = Pool.load(event.address.toHexString())
let token0 = Token.load(pool.token0)
let token1 = Token.load(pool.token1)
let amount0 = convertTokenToDecimal(event.params.amount0, token0.decimals)
let amount1 = convertTokenToDecimal(event.params.amount1, token1.decimals)
pool.totalValueLockedToken0 = pool.totalValueLockedToken0.plus(amount0)
pool.totalValueLockedToken1 = pool.totalValueLockedToken1.plus(amount1)
```
* convertTokenToDecimal (https://github.com/Uniswap/uniswap-v3-subgraph/blob/main/src/utils/index.ts#L72)
- Pool Burn event
```ts
pool.totalValueLockedToken0 = pool.totalValueLockedToken0.minus(amount0)
pool.totalValueLockedToken1 = pool.totalValueLockedToken1.minus(amount1)
```
* totalValueLockedUSD (tvl USD)
- Pool Initialize event, Burn event, Swap event
```ts
let bundle = Bundle.load('1')
let pool = Pool.load(event.address.toHexString())
pool.totalValueLockedUSD = pool.totalValueLockedETH.times(bundle.ethPriceUSD)
```
* totalValueLockedETH (tvl derived ETH)
- Pool Mint event, Burn event, Swap event
```ts
let pool = Pool.load(poolAddress)
let token0 = Token.load(pool.token0)
let token1 = Token.load(pool.token1)
pool.totalValueLockedETH = pool.totalValueLockedToken0
.times(token0.derivedETH)
.plus(pool.totalValueLockedToken1.times(token1.derivedETH))
```
* txCount (all time number of transactions)
- Pool Mint event, Burn event, Swap event
```ts
let pool = Pool.load(event.address.toHexString())
// Constant ONE_BI is BigInt.fromI32(1)
pool.txCount = pool.txCount.plus(ONE_BI)
```
* volumeUSD (all time USD swapped)
- Pool Swap event
```ts
let pool = Pool.load(event.address.toHexString())
let token0 = Token.load(pool.token0)
let token1 = Token.load(pool.token1)
let amount0 = convertTokenToDecimal(event.params.amount0, token0.decimals)
let amount1 = convertTokenToDecimal(event.params.amount1, token1.decimals)
let amount0Abs = amount0
// Constant ZERO_BD is BigDecimal.fromString('0')
if (amount0.lt(ZERO_BD)) {
amount0Abs = amount0.times(BigDecimal.fromString('-1'))
}
let amount1Abs = amount1
if (amount1.lt(ZERO_BD)) {
amount1Abs = amount1.times(BigDecimal.fromString('-1'))
}
let amountTotalUSDTracked = getTrackedAmountUSD(amount0Abs, token0 as Token, amount1Abs, token1 as Token).div(
BigDecimal.fromString('2')
)
pool.volumeUSD = pool.volumeUSD.plus(amountTotalUSDTracked)
```
* getTrackedAmountUSD (https://github.com/Uniswap/uniswap-v3-subgraph/blob/main/src/utils/pricing.ts#L110)
- Uses Bundle entity `ethPriceUSD` field
- Uses Token entity `derivedEth` field
* convertTokenToDecimal (https://github.com/Uniswap/uniswap-v3-subgraph/blob/main/src/utils/index.ts#L72)
* liquidity (in range liquidity)
- Pool Mint event
```ts
let pool = Pool.load(event.address.toHexString())
if (
pool.tick !== null &&
BigInt.fromI32(event.params.tickLower).le(pool.tick as BigInt) &&
BigInt.fromI32(event.params.tickUpper).gt(pool.tick as BigInt)
) {
pool.liquidity = pool.liquidity.plus(event.params.amount)
}
```
- Token
* id (pool address)
- Factory PoolCreated event
```ts
let token0 = Token.load(event.params.token0.toHexString())
```
* decimals (token decimals)
- Factory PoolCreated event
```ts
let token0 = Token.load(event.params.token0.toHexString())
let decimals = fetchTokenDecimals(event.params.token0)
token0.decimals = decimals
```
* fetchTokenDecimals(https://github.com/Uniswap/uniswap-v3-subgraph/blob/main/src/utils/token.ts#L75)
- Uses ERC20 contract view method call `decimals`
* derivedETH (derived price in ETH)
- Pool Initialize event, Swap event
```ts
let pool = Pool.load(event.address.toHexString())
let token0 = Token.load(pool.token0)
token0.derivedETH = findEthPerToken(token0 as Token)
```
* findEthPerToken (https://github.com/Uniswap/uniswap-v3-subgraph/blob/main/src/utils/pricing.ts#L65)
- Uses Token entity `whitelistPools` field
- Uses Pool entity `liquidity`, `totalValueLockedToken1`, `token0Price` fields
* whitelistPools (pools token is in that are white listed for USD pricing)
- Factory PoolCreated event
```ts
let pool = new Pool(event.params.pool.toHexString()) as Pool
let token1 = Token.load(event.params.token1.toHexString())
if (WHITELIST_TOKENS.includes(token0.id)) {
let newPools = token1.whitelistPools
newPools.push(pool.id)
token1.whitelistPools = newPools
}
```
* Constant WHITELIST_TOKENS (https://github.com/Uniswap/uniswap-v3-subgraph/blob/main/src/utils/pricing.ts#L12)
* feesUSD (fees in USD)
- Pool Swap event
```ts
let pool = Pool.load(event.address.toHexString())
let token0 = Token.load(pool.token0)
let token1 = Token.load(pool.token1)
let amount0 = convertTokenToDecimal(event.params.amount0, token0.decimals)
let amount1 = convertTokenToDecimal(event.params.amount1, token1.decimals)
let amount0Abs = amount0
if (amount0.lt(ZERO_BD)) {
amount0Abs = amount0.times(BigDecimal.fromString('-1'))
}
let amount1Abs = amount1
if (amount1.lt(ZERO_BD)) {
amount1Abs = amount1.times(BigDecimal.fromString('-1'))
}
let amountTotalUSDTracked = getTrackedAmountUSD(amount0Abs, token0 as Token, amount1Abs, token1 as Token).div(
BigDecimal.fromString('2')
)
let feesUSD = amountTotalUSDTracked.times(pool.feeTier.toBigDecimal()).div(BigDecimal.fromString('1000000'))
token0.feesUSD = token0.feesUSD.plus(feesUSD)
```
* totalValueLocked (liquidity across all pools in token units)
- Pool Mint event, Swap event
```ts
let pool = Pool.load(event.address.toHexString())
let token0 = Token.load(pool.token0)
let amount0 = convertTokenToDecimal(event.params.amount0, token0.decimals)
token0.totalValueLocked = token0.totalValueLocked.plus(amount0)
```
- Pool Burn event
```ts
token0.totalValueLocked = token0.totalValueLocked.minus(amount0)
```
* totalValueLockedUSD (liquidity across all pools in derived USD)
- Pool Mint event, Burn event, Swap event
```ts
let bundle = Bundle.load('1')
let pool = Pool.load(event.address.toHexString())
let token0 = Token.load(pool.token0)
token0.totalValueLockedUSD = token0.totalValueLocked.times(token0.derivedETH.times(bundle.ethPriceUSD))
```
* txCount (transactions across all pools that include this token)
- Pool Mint event, Burn event, Swap event
```ts
token0.txCount = token0.txCount.plus(ONE_BI)
```
* volume (volume in token units)
- Pool Swap event
```ts
let pool = Pool.load(event.address.toHexString())
let token0 = Token.load(pool.token0)
let amount0 = convertTokenToDecimal(event.params.amount0, token0.decimals)
let amount0Abs = amount0
if (amount0.lt(ZERO_BD)) {
amount0Abs = amount0.times(BigDecimal.fromString('-1'))
}
token0.volume = token0.volume.plus(amount0Abs)
```
* volumeUSD (volume in derived USD)
- Pool Swap event
```ts
let pool = Pool.load(event.address.toHexString())
let token0 = Token.load(pool.token0)
let token1 = Token.load(pool.token1)
let amount0 = convertTokenToDecimal(event.params.amount0, token0.decimals)
let amount1 = convertTokenToDecimal(event.params.amount1, token1.decimals)
let amount0Abs = amount0
if (amount0.lt(ZERO_BD)) {
amount0Abs = amount0.times(BigDecimal.fromString('-1'))
}
let amount1Abs = amount1
if (amount1.lt(ZERO_BD)) {
amount1Abs = amount1.times(BigDecimal.fromString('-1'))
}
let amountTotalUSDTracked = getTrackedAmountUSD(amount0Abs, token0 as Token, amount1Abs, token1 as Token).div(
BigDecimal.fromString('2')
)
token0.volumeUSD = token0.volumeUSD.plus(amountTotalUSDTracked)
```
- Factory
* id (factory address)
- Factory PoolCreated event
```ts
let factory = Factory.load(FACTORY_ADDRESS)
```
* Constant FACTORY_ADDRESS is in https://github.com/Uniswap/uniswap-v3-subgraph/blob/main/src/utils/constants.ts#L6
* totalFeesUSD (total swap fees all time in USD)
- Pool Swap event
```ts
let factory = Factory.load(FACTORY_ADDRESS)
let pool = Pool.load(event.address.toHexString())
let token0 = Token.load(pool.token0)
let token1 = Token.load(pool.token1)
let amount0 = convertTokenToDecimal(event.params.amount0, token0.decimals)
let amount1 = convertTokenToDecimal(event.params.amount1, token1.decimals)
let amount0Abs = amount0
if (amount0.lt(ZERO_BD)) {
amount0Abs = amount0.times(BigDecimal.fromString('-1'))
}
let amount1Abs = amount1
if (amount1.lt(ZERO_BD)) {
amount1Abs = amount1.times(BigDecimal.fromString('-1'))
}
let amountTotalUSDTracked = getTrackedAmountUSD(amount0Abs, token0 as Token, amount1Abs, token1 as Token).div(
BigDecimal.fromString('2')
)
let feesUSD = amountTotalUSDTracked.times(pool.feeTier.toBigDecimal()).div(BigDecimal.fromString('1000000'))
factory.totalFeesUSD = factory.totalFeesUSD.plus(feesUSD)
```
* totalValueLockedUSD (TVL derived in USD)
- Pool Mint event, Burn event, Swap event
```ts
let bundle = Bundle.load('1')
let factory = Factory.load(FACTORY_ADDRESS)
factory.totalValueLockedUSD = factory.totalValueLockedETH.times(bundle.ethPriceUSD)
```
* totalValueLockedETH (TVL derived in ETH)
- Pool Mint event, Burn event, Swap event
```ts
let pool = Pool.load(event.address.toHexString())
let factory = Factory.load(FACTORY_ADDRESS)
factory.totalValueLockedETH = factory.totalValueLockedETH.minus(pool.totalValueLockedETH)
// After change in pool.totalValueLockedETH
factory.totalValueLockedETH = factory.totalValueLockedETH.plus(pool.totalValueLockedETH)
```
* totalVolumeUSD (total volume all time in derived USD)
- Pool Swap event
```ts
let factory = Factory.load(FACTORY_ADDRESS)
let pool = Pool.load(event.address.toHexString())
let token0 = Token.load(pool.token0)
let token1 = Token.load(pool.token1)
let amount0 = convertTokenToDecimal(event.params.amount0, token0.decimals)
let amount1 = convertTokenToDecimal(event.params.amount1, token1.decimals)
let amount0Abs = amount0
if (amount0.lt(ZERO_BD)) {
amount0Abs = amount0.times(BigDecimal.fromString('-1'))
}
let amount1Abs = amount1
if (amount1.lt(ZERO_BD)) {
amount1Abs = amount1.times(BigDecimal.fromString('-1'))
}
let amountTotalUSDTracked = getTrackedAmountUSD(amount0Abs, token0 as Token, amount1Abs, token1 as Token).div(
BigDecimal.fromString('2')
)
factory.totalVolumeUSD = factory.totalVolumeUSD.plus(amountTotalUSDTracked)
```
* txCount (amount of transactions all time)
- Pool Mint event, Burn event, Swap event
```ts
let factory = Factory.load(FACTORY_ADDRESS)
factory.txCount = factory.txCount.plus(ONE_BI)
```
- Bundle
Stores for USD calculations.
* id - Stores only one instance.
```ts
let bundle = Bundle.load('1')
```
* ethPriceUSD (price of ETH in usd)
- Pool Initialize event, Swap event
```ts
bundle.ethPriceUSD = getEthPriceInUSD()
```
* getEthPriceInUSD (https://github.com/Uniswap/uniswap-v3-subgraph/blob/main/src/utils/pricing.ts#L51)
- Uses Pool entity `token0Price` field
- Tick
* id (format: `<pool address>#<tick index>`)
- Pool Mint event
```ts
let poolAddress = event.address.toHexString()
let pool = Pool.load(poolAddress)
let lowerTickIdx = event.params.tickLower
let lowerTickId = poolAddress + '#' + BigInt.fromI32(event.params.tickLower).toString()
let lowerTick = Tick.load(lowerTickId)
if (lowerTick === null) {
lowerTick = createTick(lowerTickId, lowerTickIdx, pool.id, event)
}
```
* createTick (https://github.com/Uniswap/uniswap-v3-subgraph/blob/main/src/utils/tick.ts#L8)
* liquidityGross (total liquidity pool has as tick lower or upper)
- Pool Mint event
```ts
lowerTick.liquidityGross = lowerTick.liquidityGross.plus(event.params.amount)
```
- Pool Burn event
```ts
lowerTick.liquidityGross = lowerTick.liquidityGross.minus(event.params.amount)
```
* liquidityNet (how much liquidity changes when tick crossed)
- Pool Mint event
```ts
lowerTick.liquidityNet = lowerTick.liquidityNet.plus(event.params.amount)
```
- Pool Burn event
```ts
lowerTick.liquidityNet = lowerTick.liquidityNet.minus(event.params.amount)
```
* price0 (calculated price of token0 of tick within this pool - constant)
- Pool Mint event
```ts
lowerTick = createTick(lowerTickId, lowerTickIdx, pool.id, event)
// Inside createTick
// tickIdx = lowerTickIdx
tick.price0 = bigDecimalExponated(BigDecimal.fromString('1.0001'), BigInt.fromI32(tickIdx))
```
* price1 (calculated price of token0 of tick within this pool - constant)
- Pool Mint event
```ts
lowerTick = createTick(lowerTickId, lowerTickIdx, pool.id, event)
// Inside createTick
// tickIdx = lowerTickIdx
let price0 = bigDecimalExponated(BigDecimal.fromString('1.0001'), BigInt.fromI32(tickIdx))
tick.price1 = safeDiv(ONE_BD, price0)
```
* tickIdx (tick index)
- Pool Mint event
```ts
lowerTick = createTick(lowerTickId, lowerTickIdx, pool.id, event)
// Inside createTick
// tickIdx = lowerTickIdx
tick.tickIdx = BigInt.fromI32(tickIdx)
```
- Mint
* id (transaction hash + "#" + index in mints Transaction array)
- Pool Mint event
```ts
let mint = new Mint(transaction.id.toString() + '#' + pool.txCount.toString())
```
* amount0 (amount of token 0 minted), amount1 (amount of token 1 minted)
- Pool Mint event
```ts
let pool = Pool.load(event.address.toHexString())
let token0 = Token.load(pool.token0)
let token1 = Token.load(pool.token1)
mint.amount0 = convertTokenToDecimal(event.params.amount0, token0.decimals)
mint.amount1 = convertTokenToDecimal(event.params.amount1, token1.decimals)
```
* amountUSD (derived amount based on available prices of tokens)
- Pool Mint event
```ts
let bundle = Bundle.load('1')
let pool = Pool.load(event.address.toHexString())
let token0 = Token.load(pool.token0)
let token1 = Token.load(pool.token1)
let amount0 = convertTokenToDecimal(event.params.amount0, token0.decimals)
let amount1 = convertTokenToDecimal(event.params.amount1, token1.decimals)
mint.amountUSD = amount0
.times(token0.derivedETH.times(bundle.ethPriceUSD))
.plus(amount1.times(token1.derivedETH.times(bundle.ethPriceUSD)))
```
* origin (txn origin)
- Pool Mint event
```ts
mint.origin = event.transaction.from
```
* owner (owner of position where liquidity minted to)
- Pool Mint event
```ts
mint.owner = event.params.owner
```
* pool (pool position is within)
- Pool Mint event
```ts
let poolAddress = event.address.toHexString()
let pool = Pool.load(poolAddress)
mint.pool = pool.id
```
* sender (the address that minted the liquidity)
- Pool Mint event
```ts
mint.sender = event.params.sender
```
* timestamp (time of txn)
- Pool Mint event
```ts
let transaction = loadTransaction(event)
mint.timestamp = transaction.timestamp
```
* loadTransaction (https://github.com/Uniswap/uniswap-v3-subgraph/blob/main/src/utils/index.ts#L83)
- Uses Transaction entity
* transaction (which txn the mint was included in)
- Pool Mint event
```ts
let transaction = loadTransaction(event)
mint.transaction = transaction.id
```
- Burn
* id (transaction hash + "#" + index in mints Transaction array)
- Pool Burn event
```ts
let pool = Pool.load(event.address.toHexString())
let transaction = loadTransaction(event)
let mint = new Burn(transaction.id + '#' + pool.txCount.toString())
```
* amount0 (amount of token 0 burned), amount1 (amount of token 1 burned)
- Pool Burn event
```ts
let pool = Pool.load(event.address.toHexString())
let token0 = Token.load(pool.token0)
let token1 = Token.load(pool.token1)
burn.amount0 = convertTokenToDecimal(event.params.amount0, token0.decimals)
burn.amount1 = convertTokenToDecimal(event.params.amount1, token1.decimals)
```
* amountUSD (derived amount based on available prices of tokens)
- Pool Burn event
```ts
let bundle = Bundle.load('1')
let pool = Pool.load(event.address.toHexString())
let token0 = Token.load(pool.token0)
let token1 = Token.load(pool.token1)
let amount0 = convertTokenToDecimal(event.params.amount0, token0.decimals)
let amount1 = convertTokenToDecimal(event.params.amount1, token1.decimals)
burn.amountUSD = amount0
.times(token0.derivedETH.times(bundle.ethPriceUSD))
.plus(amount1.times(token1.derivedETH.times(bundle.ethPriceUSD)))
```
* origin (txn origin)
- Pool Burn event
```ts
burn.origin = event.transaction.from
```
* owner (owner of position where liquidity was burned)
- Pool Burn event
```ts
burn.owner = event.params.owner
```
* pool (pool position is within)
- Pool Burn event
```ts
let poolAddress = event.address.toHexString()
let pool = Pool.load(poolAddress)
burn.pool = pool.id
```
* timestamp (need this to pull recent txns for specific token or pool)
- Pool Burn event
```ts
let transaction = loadTransaction(event)
burn.timestamp = transaction.timestamp
```
* transaction (txn burn was included in)
- Pool Burn event
```ts
let transaction = loadTransaction(event)
burn.transaction = transaction.id
```
- Swap
* id (transaction hash + "#" + index in swaps Transaction array)
- Pool Swap event
```ts
let pool = Pool.load(event.address.toHexString())
let transaction = loadTransaction(event)
let swap = new Swap(transaction.id + '#' + pool.txCount.toString())
```
* amount0 (allow indexing by tokens), amount1 (allow indexing by tokens)
- Pool Swap event
```ts
let pool = Pool.load(event.address.toHexString())
let token0 = Token.load(pool.token0)
let token1 = Token.load(pool.token1)
swap.amount0 = convertTokenToDecimal(event.params.amount0, token0.decimals)
swap.amount1 = convertTokenToDecimal(event.params.amount1, token1.decimals)
```
* amountUSD (derived info)
- Pool Swap event
```ts
let bundle = Bundle.load('1')
let pool = Pool.load(event.address.toHexString())
let token0 = Token.load(pool.token0)
let token1 = Token.load(pool.token1)
let amount0Abs = amount0
if (amount0.lt(ZERO_BD)) {
amount0Abs = amount0.times(BigDecimal.fromString('-1'))
}
let amount1Abs = amount1
if (amount1.lt(ZERO_BD)) {
amount1Abs = amount1.times(BigDecimal.fromString('-1'))
}
let amountTotalUSDTracked = getTrackedAmountUSD(amount0Abs, token0 as Token, amount1Abs, token1 as Token).div(
BigDecimal.fromString('2')
)
swap.amountUSD = amountTotalUSDTracked
```
* origin (txn origin, the EOA that initiated the txn)
- Pool Swap event
```ts
swap.origin = event.transaction.from
```
* pool (pool swap occured within)
- Pool Swap event
```ts
let poolAddress = event.address.toHexString()
let pool = Pool.load(poolAddress)
swap.pool = pool.id
```
* timestamp (timestamp of transaction)
- Pool Swap event
```ts
let transaction = loadTransaction(event)
swap.timestamp = transaction.timestamp
```
* transaction (pointer to transaction)
- Pool Swap event
```ts
let transaction = loadTransaction(event)
swap.transaction = transaction.id
```
- Transaction
* id (txn hash)
- Pool Mint event, Burn event, Swap event
NonfungiblePositionManager IncreaseLiquidity event, DecreaseLiquidity event, Collect event, Transfer event
```ts
let transaction = loadTransaction(event)
// Inside loadTransaction
let transaction = Transaction.load(event.transaction.hash.toHexString())
if (transaction === null) {
transaction = new Transaction(event.transaction.hash.toHexString())
}
```
* loadTransaction (https://github.com/Uniswap/uniswap-v3-subgraph/blob/main/src/utils/index.ts#L83)
* timestamp (timestamp txn was confirmed)
- Pool Mint event, Burn event, Swap event
NonfungiblePositionManager IncreaseLiquidity event, DecreaseLiquidity event, Collect event, Transfer event
```ts
// Inside loadTransaction
let transaction = Transaction.load(event.transaction.hash.toHexString())
transaction.timestamp = event.block.timestamp
```
* burns, mints, swaps (derived values)
These fields are derived from reverse lookups.
https://thegraph.com/docs/define-a-subgraph#reverse-lookups
- UniswapDayData (Data accumulated and condensed into day stats for all of Uniswap)
* id (timestamp rounded to current day by dividing by 86400)
- Pool Mint event, Burn event, Swap event
```ts
updateUniswapDayData(event)
// Inside updateUniswapDayData
let timestamp = event.block.timestamp.toI32()
let dayID = timestamp / 86400
let uniswapDayData = UniswapDayData.load(dayID.toString())
if (uniswapDayData === null) {
uniswapDayData = new UniswapDayData(dayID.toString())
}
```
* updateUniswapDayData (https://github.com/Uniswap/uniswap-v3-subgraph/blob/main/src/utils/intervalUpdates.ts#L23)
- Uses Factory entity `totalValueLockedUSD`, `txCount` fields
* date (timestamp rounded to current day by dividing by 86400)
- Pool Mint event, Burn event, Swap event
```ts
// Inside updateUniswapDayData
let timestamp = event.block.timestamp.toI32()
let dayID = timestamp / 86400
let dayStartTimestamp = dayID * 86400
let uniswapDayData = UniswapDayData.load(dayID.toString())
if (uniswapDayData === null) {
uniswapDayData = new UniswapDayData(dayID.toString())
uniswapDayData.date = dayStartTimestamp
}
```
* tvlUSD (tvl in terms of USD)
- Pool Mint event, Burn event, Swap event
```ts
let uniswap = Factory.load(FACTORY_ADDRESS)
let uniswapDayData = UniswapDayData.load(dayID.toString())
uniswapDayData.tvlUSD = uniswap.totalValueLockedUSD
```
* volumeUSD (total daily volume in Uniswap derived in terms of USD)
- Pool Swap event
```ts
let pool = Pool.load(event.address.toHexString())
let token0 = Token.load(pool.token0)
let token1 = Token.load(pool.token1)
let amount0 = convertTokenToDecimal(event.params.amount0, token0.decimals)
let amount1 = convertTokenToDecimal(event.params.amount1, token1.decimals)
let amount0Abs = amount0
if (amount0.lt(ZERO_BD)) {
amount0Abs = amount0.times(BigDecimal.fromString('-1'))
}
let amount1Abs = amount1
if (amount1.lt(ZERO_BD)) {
amount1Abs = amount1.times(BigDecimal.fromString('-1'))
}
let amountTotalUSDTracked = getTrackedAmountUSD(amount0Abs, token0 as Token, amount1Abs, token1 as Token).div(
BigDecimal.fromString('2')
)
let uniswapDayData = updateUniswapDayData(event)
uniswapDayData.volumeUSD = uniswapDayData.volumeUSD.plus(amountTotalUSDTracked)
```
- PoolDayData (Data accumulated and condensed into day stats for each pool)
* id (timestamp rounded to current day by dividing by 86400)
- Pool Initialize event, Mint event, Burn event, Swap event
```ts
let poolDayData = updatePoolDayData(event)
// Inside updatePoolDayData
let timestamp = event.block.timestamp.toI32()
let dayID = timestamp / 86400
let dayPoolID = event.address
.toHexString()
.concat('-')
.concat(dayID.toString())
let poolDayData = PoolDayData.load(dayPoolID)
if (poolDayData === null) {
poolDayData = new PoolDayData(dayPoolID)
}
```
* updatePoolDayData (https://github.com/Uniswap/uniswap-v3-subgraph/blob/main/src/utils/intervalUpdates.ts#L43)
- Uses Pool entity `token0Price`, `token1Price`, `liquidity`, `sqrtPrice`, `feeGrowthGlobal0X128`, `feeGrowthGlobal1X128`, `tick`, `totalValueLockedUSD` fields
* date (timestamp rounded to current day by dividing by 86400)
- Pool Initialize event, Mint event, Burn event, Swap event
```ts
// Inside updatePoolDayData
let timestamp = event.block.timestamp.toI32()
let dayID = timestamp / 86400
let dayStartTimestamp = dayID * 86400
poolDayData.date = dayStartTimestamp
```
* tvlUSD (tvl derived in USD at end of period)
- Pool Initialize event, Mint event, Burn event, Swap event
```ts
// Inside updatePoolDayData
let pool = Pool.load(event.address.toHexString())
poolDayData.tvlUSD = pool.totalValueLockedUSD
```
* volumeUSD (volume in USD)
- Pool Swap event
```ts
let pool = Pool.load(event.address.toHexString())
let token0 = Token.load(pool.token0)
let token1 = Token.load(pool.token1)
let amount0 = convertTokenToDecimal(event.params.amount0, token0.decimals)
let amount1 = convertTokenToDecimal(event.params.amount1, token1.decimals)
let amount0Abs = amount0
if (amount0.lt(ZERO_BD)) {
amount0Abs = amount0.times(BigDecimal.fromString('-1'))
}
let amount1Abs = amount1
if (amount1.lt(ZERO_BD)) {
amount1Abs = amount1.times(BigDecimal.fromString('-1'))
}
let amountTotalUSDTracked = getTrackedAmountUSD(amount0Abs, token0 as Token, amount1Abs, token1 as Token).div(
BigDecimal.fromString('2')
)
poolDayData.volumeUSD = poolDayData.volumeUSD.plus(amountTotalUSDTracked)
```
- TokenDayData
* id (token address concatendated with date)
- Pool Mint event, Burn event, Swap event
```ts
let pool = Pool.load(event.address.toHexString())
let token0 = Token.load(pool.token0)
let token0DayData = updateTokenDayData(token0 as Token, event)
// Inside updateTokenDayData
// token = token0
let timestamp = event.block.timestamp.toI32()
let dayID = timestamp / 86400
let tokenDayID = token.id
.toString()
.concat('-')
.concat(dayID.toString())
let tokenDayData = TokenDayData.load(tokenDayID)
if (tokenDayData === null) {
tokenDayData = new TokenDayData(tokenDayID)
}
```
* updateTokenDayData (https://github.com/Uniswap/uniswap-v3-subgraph/blob/main/src/utils/intervalUpdates.ts#L143)
- Uses Bundle entity `ethPriceUSD` field
* date (timestamp rounded to current day by dividing by 86400)
- Pool Mint event, Burn event, Swap event
```ts
// Inside updateTokenDayData
let dayStartTimestamp = dayID * 86400
if (tokenDayData === null) {
tokenDayData = new TokenDayData(tokenDayID)
tokenDayData.date = dayStartTimestamp
}
```
* totalValueLockedUSD (liquidity across all pools in derived USD)
- Pool Mint event, Burn event, Swap event
```ts
// Inside updateTokenDayData
let tokenDayData = TokenDayData.load(tokenDayID)
tokenDayData.totalValueLockedUSD = token.totalValueLockedUSD
```
* volumeUSD (volume in derived USD)
- Pool Swap event
```ts
let pool = Pool.load(event.address.toHexString())
let token0 = Token.load(pool.token0)
let token1 = Token.load(pool.token1)
let amount0 = convertTokenToDecimal(event.params.amount0, token0.decimals)
let amount1 = convertTokenToDecimal(event.params.amount1, token1.decimals)
let amount0Abs = amount0
if (amount0.lt(ZERO_BD)) {
amount0Abs = amount0.times(BigDecimal.fromString('-1'))
}
let amount1Abs = amount1
if (amount1.lt(ZERO_BD)) {
amount1Abs = amount1.times(BigDecimal.fromString('-1'))
}
let amountTotalUSDTracked = getTrackedAmountUSD(amount0Abs, token0 as Token, amount1Abs, token1 as Token).div(
BigDecimal.fromString('2')
)
token0DayData.volumeUSD = token0DayData.volumeUSD.plus(amountTotalUSDTracked)
```
- TokenHourData
* id (token address concatendated with date)
- Pool Mint event, Burn event, Swap event
```ts
let token0HourData = updateTokenHourData(token0 as Token, event)
// Inside updateTokenHourData
// token = token0
let tokenHourID = token.id
.toString()
.concat('-')
.concat(hourIndex.toString())
let tokenHourData = TokenHourData.load(tokenHourID)
if (tokenHourData === null) {
tokenHourData = new TokenHourData(tokenHourID)
}
```
* updateTokenDayData (https://github.com/Uniswap/uniswap-v3-subgraph/blob/main/src/utils/intervalUpdates.ts#L186)
- Uses Bundle entity `ethPriceUSD` field
* close (close price USD)
- Pool Mint event, Burn event, Swap event
```ts
// Inside updateTokenHourData
let bundle = Bundle.load('1')
let tokenPrice = token.derivedETH.times(bundle.ethPriceUSD)
tokenHourData.close = tokenPrice
```
* high (high price USD)
- Pool Mint event, Burn event, Swap event
```ts
// Inside updateTokenHourData
let tokenHourData = TokenHourData.load(tokenHourID)
if (tokenHourData === null) {
tokenHourData = new TokenHourData(tokenHourID)
tokenHourData.high = tokenPrice
}
if (tokenPrice.gt(tokenHourData.high)) {
tokenHourData.high = tokenPrice
}
```
* low (low price USD)
- Pool Mint event, Burn event, Swap event
```ts
// Inside updateTokenHourData
let tokenHourData = TokenHourData.load(tokenHourID)
if (tokenHourData === null) {
tokenHourData = new TokenHourData(tokenHourID)
tokenHourData.low = tokenPrice
}
if (tokenPrice.lt(tokenHourData.low)) {
tokenHourData.low = tokenPrice
}
```
* open (opening price USD)
- Pool Mint event, Burn event, Swap event
```ts
// Inside updateTokenHourData
if (tokenHourData === null) {
tokenHourData = new TokenHourData(tokenHourID)
tokenHourData.open = tokenPrice
}
```
* periodStartUnix (unix timestamp for start of hour)
- Pool Mint event, Burn event, Swap event
```ts
// Inside updateTokenHourData
if (tokenHourData === null) {
tokenHourData = new TokenHourData(tokenHourID)
tokenHourData.periodStartUnix = hourStartUnix
}
```

117
packages/uniswap/contract.md Normal file
View File

@ -0,0 +1,117 @@
# Contract Analysis
## View Methods in Uniswap V3 Core
* https://github.com/Uniswap/uniswap-v3-core/blob/main/contracts/NoDelegateCall.sol
- checkNotDelegateCall (private)
* https://github.com/Uniswap/uniswap-v3-core/blob/main/contracts/UniswapV3Pool.sol#L158
- _blockTimestamp (internal)
- balance0 (private)
- balance1 (private)
- snapshotCumulativesInside (external)
- observe (external)
* https://github.com/Uniswap/uniswap-v3-core/blob/main/contracts/libraries/Oracle.sol
- binarySearch (private)
- getSurroundingObservations (private)
- observeSingle (internal)
- observe (internal)
* https://github.com/Uniswap/uniswap-v3-core/blob/main/contracts/libraries/Position.sol
- get (internal)
* https://github.com/Uniswap/uniswap-v3-core/blob/main/contracts/libraries/Tick.sol
- getFeeGrowthInside (internal)
* https://github.com/Uniswap/uniswap-v3-core/blob/main/contracts/libraries/TickBitmap.sol
- nextInitializedTickWithinOneWord (internal)
## Mapping Event handlers in Uniswap subgraph
* handlePoolCreated (Factory contract - PoolCreated event)
- Data from event
- Entities
* Factory
* Bundle
* Pool
* Token
- Contract calls
* ERC20 (symbol, name, totalSupply, decimals)
* ERC20SymbolBytes (symbol)
* ERC20NameBytes (name)
- Create new Template contract (Pool)
* NonfungiblePositionManager contract
- Handlers (Similar code)
* handleIncreaseLiquidity (IncreaseLiquidity event)
* handleDecreaseLiquidity (DecreaseLiquidity event)
* handleCollect (Collect event)
* handleTransfer (Transfer event)
- Data from event
- Entities
* Position
* Transaction
* Token
- Contract calls
* NonfungiblePositionManager (positions)
* Factory (getPool)
* handleInitialize (Pool contract - Initialize event)
- Data from event
- Entities
* Pool
* Token
* Bundle
* PoolDayData
* PoolHourData
* handleSwap (Pool contract - Swap event)
- Data from event
- Entities
* Bundle
* Factory
* Pool
* Token
* Transaction
* Swap
* UniswapDayData
* PoolDayData
* PoolHourData
* TokenDayData
* TokenHourData
- Contract calls
* Pool (feeGrowthGlobal0X128, feeGrowthGlobal1X128)
* handleMint (Pool contract - Mint event)
- Data from event
- Entities
* Bundle
* Pool
* Factory
* Token
* Transaction
* Mint
* Tick
* UniswapDayData
* PoolDayData
* PoolHourData
* TokenDayData
* TokenHourData
* handleBurn (Pool contract - Burn event)
- Data from event
- Entities
* Bundle
* Pool
* Factory
* Token
* Burn
* Tick
* UniswapDayData
* PoolDayData
* PoolHourData
* TokenDayData
* TokenHourData
- Extra methods
* store.remove (remove Tick entity)

19
packages/uniswap/design-notes.md Normal file
View File

@ -0,0 +1,19 @@
# Design Notes
## Watchers
* uniswap-watcher
* Provides events to downstream subscribers, access to core/periphery contract data,
* uniswap-info-watcher
* Subscribes to uniswap-watcher
* Performs computation/derivation of entity properties required by info frontend
* Filler (old to new block)
## Issues
* Filler should process block by block (old to new) starting from contract deployment block
* Otherwise, values of computed props will be incorrect
* "last_processed_block_number"
* Use audit/proof table to record changes to entities instead of aggregating in code (too slow)
* Handling reorgs
* ERC20 variants (storage layout)

2
packages/uniswap/package.json
View File

@ -4,7 +4,7 @@
"main": "index.js",
"license": "UNLICENSED",
"scripts": {
"generate:schema": "get-graphql-schema https://api.thegraph.com/subgraphs/name/ianlapham/uniswap-v3-alt > schema.graphql",
"generate:schema": "get-graphql-schema https://api.thegraph.com/subgraphs/name/ianlapham/uniswap-v3-alt > schema/full.graphql",
"lint:schema": "graphql-schema-linter"
},
"devDependencies": {

2
packages/uniswap/queries.md → packages/uniswap/queries/queries.md
View File

@ -1,4 +1,4 @@
## Queries
# Frontend (Info App) Queries
- uniswap-v3 endpoint (https://api.thegraph.com/subgraphs/name/ianlapham/uniswap-v3-alt)

64
packages/uniswap/queries/summary.md Normal file
View File

@ -0,0 +1,64 @@
# Summary of Queries in Uniswap Info App
Actual queries are listed in [queries](./queries.md) file.
- uniswap-v3 endpoint (https://api.thegraph.com/subgraphs/name/ianlapham/uniswap-v3-alt)
* PoolDayData
- poolDayDatas (https://github.com/Uniswap/uniswap-v3-info/blob/master/src/data/pools/chartData.ts)
* Pool
- pools
* https://github.com/Uniswap/uniswap-v3-info/blob/master/src/data/pools/poolData.ts
* https://github.com/Uniswap/uniswap-v3-info/blob/master/src/data/pools/topPools.ts
* https://github.com/Uniswap/uniswap-v3-info/blob/master/src/data/search/index.ts
* https://github.com/Uniswap/uniswap-v3-info/blob/master/src/data/tokens/poolsForToken.ts
- pool
* https://github.com/Uniswap/uniswap-v3-info/blob/master/src/data/pools/tickData.ts
* Tick
- tick (https://github.com/Uniswap/uniswap-v3-info/blob/master/src/data/pools/tickData.ts)
* Mint
- mints
* https://github.com/Uniswap/uniswap-v3-info/blob/master/src/data/pools/transactions.ts
* https://github.com/Uniswap/uniswap-v3-info/blob/master/src/data/tokens/transactions.ts
* UniswapDayData
- uniswapDayDatas (https://github.com/Uniswap/uniswap-v3-info/blob/master/src/data/protocol/chart.ts)
* Factory
- factories (https://github.com/Uniswap/uniswap-v3-info/blob/master/src/data/protocol/overview.ts)
* Transaction
- transactions (https://github.com/Uniswap/uniswap-v3-info/blob/master/src/data/protocol/transactions.ts)
* Token
- tokens
* https://github.com/Uniswap/uniswap-v3-info/blob/master/src/data/search/index.ts
* (queried by block) https://github.com/Uniswap/uniswap-v3-info/blob/master/src/data/tokens/tokenData.ts
* https://github.com/Uniswap/uniswap-v3-info/blob/master/src/data/tokens/topTokens.ts
- token queried by block (https://github.com/Uniswap/uniswap-v3-info/blob/master/src/data/tokens/priceData.ts)
* TokenDayData
- tokenDayDatas (https://github.com/Uniswap/uniswap-v3-info/blob/master/src/data/tokens/chartData.ts)
* Bundle
- bundle queried by block (https://github.com/Uniswap/uniswap-v3-info/blob/master/src/data/tokens/priceData.ts)
- bundles (https://github.com/Uniswap/uniswap-v3-info/blob/master/src/hooks/useEthPrices.ts)
* TokenHourData
- tokenHourDatas (https://github.com/Uniswap/uniswap-v3-info/blob/master/src/data/tokens/priceData.ts)
* Swap
- swaps (https://github.com/Uniswap/uniswap-v3-info/blob/master/src/data/tokens/transactions.ts)
* Burn
- burns (https://github.com/Uniswap/uniswap-v3-info/blob/master/src/data/tokens/transactions.ts)
- ethereum-blocks endpoint (https://api.thegraph.com/subgraphs/name/blocklytics/ethereum-blocks)
t${timestamp}:blocks (https://github.com/Uniswap/uniswap-v3-info/blob/master/src/hooks/useBlocksFromTimestamps.ts)
- Checking subgraph health (https://thegraph.com/docs/deploy-a-subgraph#checking-subgraph-health)
https://github.com/Uniswap/uniswap-v3-info/blob/master/src/data/application/index.ts#L5

0
packages/uniswap/frontend-schema.graphql → packages/uniswap/schema/frontend.graphql
View File

0
packages/uniswap/schema.graphql → packages/uniswap/schema/full.gql
View File