dex-provider/src/dex.ts

Fetch data like trading pair and liquidity from DEX

import {gql, GraphQLClient} from 'graphql-request'
import {Decimal} from 'decimal.js'
import {sha256} from '@ethersproject/solidity'
import {
  DexJSON,
  PairJSON,
  IChain,
  IPair,
  IDex,
  IToken,
  Option,
  DexExtension,
} from './types'
import {Pair} from './pair'

export class UniswapV2Extension extends DexExtension {
  indexer: GraphQLClient
  chain: IChain

  constructor(chain: IChain, endpoint: string) {
    super()

    this.chain = chain
    this.indexer = new GraphQLClient(endpoint, {
      timeout: 300000,
    })
  }

  fetchPairCount(): Promise<number> {
    return new Promise<number>((resolve, reject) => {
      this.indexer
        .request(
          gql`
            {
              uniswapFactories {
                pairCount
              }
            }
          `
        )
        .then((data) => {
          if (data.uniswapFactories?.length > 0) {
            resolve(data.uniswapFactories[0].pairCount)
          } else {
            reject(new Error('Unknow error'))
          }
        })
        .catch((e) => {
          reject(
            new Error(
              'Error getting uniswapFactories from blockchain: ' +
                JSON.stringify(e)
            )
          )
        })
    })
  }

  fetchSinglePair(id: string): Promise<Option<IPair>> {
    return new Promise<Option<IPair>>((resolve, reject) => {
      this.indexer
        .request(
          gql`
            {
              pairs(where: {id: id}) {
                id
                token0 {
                  id
                  name
                  symbol
                  decimals
                }
                token1 {
                  id
                  name
                  symbol
                  decimals
                }
                reserve0
                reserve1
                token0Price
                token1Price
                volumeUSD
              }
            }
          `
        )
        .then((data) => {
          if (data.pairs?.length > 0) {
            const raw = data.pairs[0]
            resolve(
              new Pair(
                raw.id,
                raw.token0,
                raw.token1,
                raw.reserve0,
                raw.reserve1,
                raw.token0Price,
                raw.token1Price,
                raw.volumeUSD,
                null,
                null,
                null,
                null
              )
            )
          } else {
            resolve(null)
          }
        })
        .catch((e) => {
          reject(
            new Error(
              'Error getting pairs from blockchain: ' + JSON.stringify(e)
            )
          )
        })
    })
  }

  fetchLimitedPairs(limit: number): Promise<IPair[]> {
    return new Promise<IPair[]>((resolve, reject) => {
      this.indexer
        .request(
          gql`
                {
                    pairs (first: ${limit}, orderBy: volumeUSD, orderDirection: desc) {
                        id
                        token0 {
                            id
                            name
                            symbol
                            decimals
                        }
                        token1 {
                            id
                            name
                            symbol
                            decimals
                        }
                        reserve0
                        reserve1
                        token0Price
                        token1Price
                        volumeUSD
                    }
                }
                `
        )
        .then((data) => {
          if (data.pairs?.length > 0) {
            const pairs = data.pairs.map((raw: any) => {
              return new Pair(
                raw.id,
                raw.token0,
                raw.token1,
                raw.reserve0,
                raw.reserve1,
                raw.token0Price,
                raw.token1Price,
                raw.volumeUSD,
                null,
                null,
                null,
                null
              )
            })
            resolve(pairs)
          } else {
            resolve([])
          }
        })
        .catch((e) => {
          reject(
            new Error(
              'Error getting pairs from blockchain: ' + JSON.stringify(e)
            )
          )
        })
    })
  }

  // Fetch pairs according to creating block number range
  fetchRangePairs(from: number, to: number): Promise<IPair[]> {
    return new Promise<IPair[]>((resolve, reject) => {
      this.indexer
        .request(
          gql`
                  {
                      pairs (orderBy: createdAtBlockNumber, orderDirection: asc, where: {createdAtBlockNumber_gte: ${Number(
                        from
                      )}, createdAtBlockNumber_lt: ${Number(to)}}) {
                          id
                          token0 {
                              id
                              name
                              symbol
                              decimals
                          }
                          token1 {
                              id
                              name
                              symbol
                              decimals
                          }
                          reserve0
                          reserve1
                          token0Price
                          token1Price
                          volumeUSD
                      }
                  }
                  `
        )
        .then((data) => {
          if (data.pairs?.length > 0) {
            const pairs = data.pairs.map((raw: any) => {
              return new Pair(
                raw.id,
                raw.token0,
                raw.token1,
                raw.reserve0,
                raw.reserve1,
                raw.token0Price,
                raw.token1Price,
                raw.volumeUSD,
                null,
                null,
                null,
                null
              )
            })
            resolve(pairs)
          } else {
            resolve([])
          }
        })
        .catch((e) => {
          reject(
            new Error(
              'Error getting pairs from blockchain: ' + JSON.stringify(e)
            )
          )
        })
    })
  }
}

export class Dex<Ex extends DexExtension> implements IDex {
  name: string
  chain: IChain
  factory: string
  pairs: Map<string, IPair>
  ex: Ex
  // Mapping string of concat(token0.id, token1.id) to pair address
  ids: Map<string, string>

  constructor(name: string, chain: IChain, factory: string, ex: Ex) {
    this.name = name
    this.chain = chain
    this.factory = factory
    this.pairs = new Map<string, IPair>()
    this.ex = ex
    this.ids = new Map<string, string>()
  }

  // Generate key of `ids` map according to given pair token address/indentity
  generateIdKey(token0: string, token1: string): string {
    const concatId: string =
      token0.toLowerCase() < token1.toLowerCase()
        ? token0 + token1
        : token1 + token0

    return sha256(['string'], [concatId])
  }

  // Return promise with pair count, fetch top 200 volume trading pairs from DEX by default
  async initialize(limit = 200): Promise<number> {
    const totalPairs = await this.ex.fetchPairCount()
    console.info(
      `There are ${totalPairs} trading pairs founded from ${this.name}, start fetching top ${limit} volume USD of them...`
    )

    const pairs = await this.ex.fetchLimitedPairs(limit)
    pairs.map((pair) => {
      const key = this.generateIdKey(pair.token0.id, pair.token1.id)
      this.ids.set(key, pair.id)
      this.pairs.set(pair.id, pair)
    })
    console.info(`Got ${this.pairs.size} pairs from indexer`)
    return Promise.resolve(this.pairs.size)
  }

  getTokenPairs(token: IToken): IPair[] {
    const pairs: IPair[] = []
    for (const [pairId, pair] of this.pairs) {
      if (token.id.toLowerCase() === pair.token0.id) {
        pairs.push(pair)
        continue
      }
      if (token.id.toLowerCase() === pair.token1.id.toLowerCase()) {
        // Revert pair
        pairs.push(pair.flip())
        continue
      }
    }
    return pairs
  }

  getPair(token0: IToken, token1: IToken): Option<IPair> {
    const id = this.ids.get(this.generateIdKey(token0.id, token1.id))
    if (id !== undefined) {
      const pair = this.pairs.get(id)
      if (pair !== undefined) {
        return pair
      }
    }
    //   console.debug(
    //     `Tring to get pair of token[${token0.name}-${token1.name}], but not found`
    //   )
    return null
  }

  getPairs(): IPair[] {
    const pairs: IPair[] = []
    for (const [_, pair] of this.pairs) {
      pairs.push(pair)
    }
    return pairs
  }

  updatePair(id: string): Promise<IPair> {
    return new Promise<IPair>((resolve, reject) => {
      if (this.pairs.get(id) === undefined) {
        reject(new Error(`Pair does not exist: ${id}`))
      }
      this.ex
        .fetchSinglePair(id)
        .then((pair) => {
          if (pair !== null) {
            this.pairs.set(id, pair)
          } else {
            reject(new Error(`Pair not found on remote: ${id}`))
          }
        })
        .catch((err) => reject(err))
    })
  }

  getCapcities(pair: IPair): Option<string> {
    let chainNativeWrap: IToken
    let chainUSDT: IToken
    if (this.chain.nativeWrap === null || this.chain.stableCoin === null)
      return null
    else {
      chainNativeWrap = this.chain.nativeWrap
      chainUSDT = this.chain.stableCoin
    }

    const nativeWrapUSDTPair = this.getPair(chainNativeWrap, chainUSDT)
    if (nativeWrapUSDTPair === null) {
      return null
    }

    let cap: Option<string> = null
    // Calculate capacity of pair
    if (pair.token0.id.toLowerCase() === chainNativeWrap.id.toLowerCase()) {
      cap = new Decimal(nativeWrapUSDTPair.token1Price)
        .mul(new Decimal(pair.reserve0))
        .toFixed(6)
    } else if (
      pair.token1.id.toLowerCase() === chainNativeWrap.id.toLowerCase()
    ) {
      cap = new Decimal(nativeWrapUSDTPair.token1Price)
        .mul(new Decimal(pair.reserve1))
        .toFixed(6)
    } else if (pair.token0.id.toLowerCase() === chainUSDT.id.toLowerCase()) {
      cap = new Decimal(pair.reserve0).toFixed(6)
    } else if (pair.token1.id.toLowerCase() === chainUSDT.id.toLowerCase()) {
      cap = new Decimal(pair.reserve1).toFixed(6)
    } else {
      const token0NativewrapPair = this.getPair(pair.token0, chainNativeWrap)
      if (token0NativewrapPair !== null) {
        cap = new Decimal(token0NativewrapPair.token1Price)
          .mul(new Decimal(nativeWrapUSDTPair.token1Price))
          .mul(new Decimal(pair.reserve0))
          .toFixed(6)
      }
    }
    return cap
  }

  toJSON(): DexJSON {
    const pairs: PairJSON[] = []
    for (const [_, pair] of this.pairs) {
      pairs.push({
        token0: pair.token0.symbol,
        token0Id: pair.token0.id,
        token1: pair.token1.symbol,
        token1Id: pair.token1.id,
        cap: Number(this.getCapcities(pair)),
        rate: Number(pair.token1Price),
        dex: this.name,
      })
    }

    return {
      chain: this.name,
      pairs: pairs,
    }
  }
}