Class GraphService

constructor

• new GraphService(eBTC, baseURL): GraphService

• Parameters

  • eBTC: eBTC

  • baseURL: undefined | string

  Returns GraphService

graphClient

graphUrl

getCdp

• getCdp(_cdpId): Promise<Cdp>

• Returns a Cdp by _cdpId

  Parameters

  • _cdpId: string

  Returns Promise<Cdp>

getCdpOpenedInfo

• getCdpOpenedInfo(_cdpId): Promise<OpenCdpData>

• This function returns data about how the cdp was opened. By which contract (BorrowerOperations, Zap, etc.) and with what token if not stETH.

  Parameters

  • _cdpId: string

    the id of the cdp

  Returns Promise<OpenCdpData>

  information on how the cdp was opened

getCdpUpdatedEvents

• getCdpUpdatedEvents(_cdpId): Promise<CdpUpdated[]>

• Returns all CDP updated events for a _cdpId

  Parameters

  • _cdpId: string

  Returns Promise<CdpUpdated[]>

getCdpsForOwner

• getCdpsForOwner(_borrower): Promise<Cdp[]>

• Returns all Cdps for a borrower

  Parameters

  • _borrower: string

  Returns Promise<Cdp[]>

getCdpsFromList

• getCdpsFromList(_cdpIds): Promise<Cdp[]>

• Parameters

  • _cdpIds: string[]

  Returns Promise<Cdp[]>

getCdpsOpenedInfo

• getCdpsOpenedInfo(_cdpIds): Promise<OpenCdpData[]>

• This function returns data about how the multiple cdps were opened. By which contract (BorrowerOperations, Zap, etc.) and with what token if not stETH.

  Parameters

  • _cdpIds: string[]

    the id of the cdps

  Returns Promise<OpenCdpData[]>

  information on how the cdps were opened

getCdpsUpdatedEvents

• getCdpsUpdatedEvents(_cdpIds): Promise<CdpUpdated[]>

• Returns all CDPs updated events for a _cdpIds

  Parameters

  • _cdpIds: string[]

  Returns Promise<CdpUpdated[]>

getClosedCdpsForOwner

• getClosedCdpsForOwner(_borrower, _skip?, _first?): Promise<Cdp[]>

• Returns all closed Cdps for a borrower

  Parameters

  • _borrower: string

    the owner or borrower of the cdps

  • _skip: number = 0

    the number of cdps to skip for a paginated query

  • _first: number = 5

    the number of cdps to return

  Returns Promise<Cdp[]>

  a list of closed cdps

getStatsOfETHOpenedCdps

• getStatsOfETHOpenedCdps(minBlockNumber, maxBlockNumber): Promise<{
      count: number;
      total: BigNumber;
      userStake: Map<string, BigNumber>;
  }>

• Returns the total amount of ETH/WETH used to mint Cdps. Currently doesn't account for closed Cdps.

  Parameters

  • minBlockNumber: string | number

  • maxBlockNumber: string | number

  Returns Promise<{
      count: number;
      total: BigNumber;
      userStake: Map<string, BigNumber>;
  }>

  the amount of eth/weth used to mint cdps

hasGraphUrl

• hasGraphUrl(): boolean

• Checks if the graph url is set

  Returns boolean

  true if the graph url is set

ready

• ready(): Promise<void>

• Returns Promise<void>