quasvel/packages/connect-disputable-voting/src/thegraph/connector.ts

Access and interact with Aragon Organizations and their apps.

import { providers as ethersProviders } from 'ethers'
import { GraphQLWrapper, QueryResult } from '@aragon/connect-thegraph'
import { SubscriptionCallback, SubscriptionHandler } from '@aragon/connect-types'

import { DisputableVotingData, IDisputableVotingConnector } from '../types'
import Vote from '../models/Vote'
import Voter from '../models/Voter'
import ERC20 from '../models/ERC20'
import Setting from '../models/Setting'
import CastVote from '../models/CastVote'
import ArbitratorFee from '../models/ArbitratorFee'
import CollateralRequirement from '../models/CollateralRequirement'
import * as queries from './queries'
import {
  parseSetting,
  parseSettings,
  parseCurrentSetting,
  parseDisputableVoting,
  parseERC20,
  parseVoter,
  parseVote,
  parseVotes,
  parseCastVote,
  parseCastVotes,
  parseArbitratorFee,
  parseCollateralRequirement,
  parseCurrentCollateralRequirement,
} from './parsers'

export function subgraphUrlFromChainId(chainId: number) {
  if (chainId === 1) {
    return 'https://api.thegraph.com/subgraphs/name/aragon/aragon-dvoting-mainnet'
  }
  if (chainId === 4) {
    return 'https://api.thegraph.com/subgraphs/name/aragon/aragon-dvoting-rinkeby'
  }
  if (chainId === 100) {
    return 'https://api.thegraph.com/subgraphs/name/aragon/aragon-dvoting-xdai'
  }
  return null
}

type DisputableVotingConnectorTheGraphConfig = {
  pollInterval?: number
  subgraphUrl?: string
  verbose?: boolean
}

export default class DisputableVotingConnectorTheGraph implements IDisputableVotingConnector {
  #gql: GraphQLWrapper
  #ethersProvider: ethersProviders.Provider

  constructor(config: DisputableVotingConnectorTheGraphConfig, provider: ethersProviders.Provider) {
    if (!config.subgraphUrl) {
      throw new Error(
        'DisputableVotingConnectorTheGraph requires subgraphUrl to be passed.'
      )
    }

    this.#gql = new GraphQLWrapper(config.subgraphUrl, {
      pollInterval: config.pollInterval,
      verbose: config.verbose,
    })

    this.#ethersProvider = provider
  }

  async disconnect() {
    this.#gql.close()
  }

  async disputableVoting(
    disputableVoting: string
  ): Promise<DisputableVotingData> {
    return this.#gql.performQueryWithParser<DisputableVotingData>(
      queries.GET_DISPUTABLE_VOTING('query'),
      { disputableVoting },
      (result: QueryResult) => parseDisputableVoting(result)
    )
  }

  onDisputableVoting(
    disputableVoting: string,
    callback: SubscriptionCallback<DisputableVotingData>
  ): SubscriptionHandler {
    return this.#gql.subscribeToQueryWithParser<DisputableVotingData>(
      queries.GET_DISPUTABLE_VOTING('subscription'),
      { disputableVoting },
      callback,
      (result: QueryResult) => parseDisputableVoting(result)
    )
  }

  async currentSetting(disputableVoting: string): Promise<Setting> {
    return this.#gql.performQueryWithParser<Setting>(
      queries.GET_CURRENT_SETTING('query'),
      { disputableVoting },
      (result: QueryResult) => parseCurrentSetting(result)
    )
  }

  onCurrentSetting(
    disputableVoting: string,
    callback: SubscriptionCallback<Setting>
  ): SubscriptionHandler {
    return this.#gql.subscribeToQueryWithParser<Setting>(
      queries.GET_CURRENT_SETTING('subscription'),
      { disputableVoting },
      callback,
      (result: QueryResult) => parseCurrentSetting(result)
    )
  }

  async setting(settingId: string): Promise<Setting> {
    return this.#gql.performQueryWithParser<Setting>(
      queries.GET_SETTING('query'),
      { settingId },
      (result: QueryResult) => parseSetting(result)
    )
  }

  onSetting(
    settingId: string,
    callback: SubscriptionCallback<Setting>
  ): SubscriptionHandler {
    return this.#gql.subscribeToQueryWithParser<Setting>(
      queries.GET_SETTING('subscription'),
      { settingId },
      callback,
      (result: QueryResult) => parseSetting(result)
    )
  }

  async settings(
    disputableVoting: string,
    first: number,
    skip: number
  ): Promise<Setting[]> {
    return this.#gql.performQueryWithParser<Setting[]>(
      queries.ALL_SETTINGS('query'),
      { disputableVoting, first, skip },
      (result: QueryResult) => parseSettings(result)
    )
  }

  onSettings(
    disputableVoting: string,
    first: number,
    skip: number,
    callback: SubscriptionCallback<Setting[]>
  ): SubscriptionHandler {
    return this.#gql.subscribeToQueryWithParser<Setting[]>(
      queries.ALL_SETTINGS('subscription'),
      { disputableVoting, first, skip },
      callback,
      (result: QueryResult) => parseSettings(result)
    )
  }

  async currentCollateralRequirement(disputableVoting: string): Promise<CollateralRequirement> {
    return this.#gql.performQueryWithParser<CollateralRequirement>(
      queries.GET_CURRENT_COLLATERAL_REQUIREMENT('query'),
      { disputableVoting },
      (result: QueryResult) => parseCurrentCollateralRequirement(result, this)
    )
  }

  onCurrentCollateralRequirement(
    disputableVoting: string,
    callback: SubscriptionCallback<CollateralRequirement>
  ): SubscriptionHandler {
    return this.#gql.subscribeToQueryWithParser<CollateralRequirement>(
      queries.GET_CURRENT_COLLATERAL_REQUIREMENT('subscription'),
      { disputableVoting },
      callback,
      (result: QueryResult) => parseCurrentCollateralRequirement(result, this)
    )
  }

  async vote(voteId: string): Promise<Vote> {
    return this.#gql.performQueryWithParser<Vote>(
      queries.GET_VOTE('query'),
      { voteId },
      (result: QueryResult) => parseVote(result, this, this.#ethersProvider)
    )
  }

  onVote(
    voteId: string,
    callback: SubscriptionCallback<Vote>
  ): SubscriptionHandler {
    return this.#gql.subscribeToQueryWithParser<Vote>(
      queries.GET_VOTE('subscription'),
      { voteId },
      callback,
      (result: QueryResult) => parseVote(result, this, this.#ethersProvider)
    )
  }

  async votes(
    disputableVoting: string,
    first: number,
    skip: number
  ): Promise<Vote[]> {
    return this.#gql.performQueryWithParser<Vote[]>(
      queries.ALL_VOTES('query'),
      { disputableVoting, first, skip },
      (result: QueryResult) => parseVotes(result, this, this.#ethersProvider)
    )
  }

  onVotes(
    disputableVoting: string,
    first: number,
    skip: number,
    callback: SubscriptionCallback<Vote[]>
  ): SubscriptionHandler {
    return this.#gql.subscribeToQueryWithParser<Vote[]>(
      queries.ALL_VOTES('subscription'),
      { disputableVoting, first, skip },
      callback,
      (result: QueryResult) => parseVotes(result, this, this.#ethersProvider)
    )
  }

  async castVote(castVoteId: string): Promise<CastVote | null> {
    return this.#gql.performQueryWithParser<CastVote | null>(
      queries.GET_CAST_VOTE('query'),
      { castVoteId },
      (result: QueryResult) => parseCastVote(result, this)
    )
  }

  onCastVote(
    castVoteId: string,
    callback: SubscriptionCallback<CastVote | null>
  ): SubscriptionHandler {
    return this.#gql.subscribeToQueryWithParser<CastVote | null>(
      queries.GET_CAST_VOTE('subscription'),
      { castVoteId },
      callback,
      (result: QueryResult) => parseCastVote(result, this)
    )
  }

  async castVotes(
    voteId: string,
    first: number,
    skip: number
  ): Promise<CastVote[]> {
    return this.#gql.performQueryWithParser<CastVote[]>(
      queries.ALL_CAST_VOTES('query'),
      { voteId, first, skip },
      (result: QueryResult) => parseCastVotes(result, this)
    )
  }

  onCastVotes(
    voteId: string,
    first: number,
    skip: number,
    callback: SubscriptionCallback<CastVote[]>
  ): SubscriptionHandler {
    return this.#gql.subscribeToQueryWithParser<CastVote[]>(
      queries.ALL_CAST_VOTES('subscription'),
      { voteId, first, skip },
      callback,
      (result: QueryResult) => parseCastVotes(result, this)
    )
  }

  async voter(voterId: string): Promise<Voter> {
    return this.#gql.performQueryWithParser<Voter>(
      queries.GET_VOTER('query'),
      { voterId },
      (result: QueryResult) => parseVoter(result, this)
    )
  }

  onVoter(
    voterId: string,
    callback: SubscriptionCallback<Voter>
  ): SubscriptionHandler {
    return this.#gql.subscribeToQueryWithParser<Voter>(
      queries.GET_VOTER('subscription'),
      { voterId },
      callback,
      (result: QueryResult) => parseVoter(result, this)
    )
  }

  async collateralRequirement(collateralRequirementId: string): Promise<CollateralRequirement> {
    return this.#gql.performQueryWithParser<CollateralRequirement>(
      queries.GET_COLLATERAL_REQUIREMENT('query'),
      { collateralRequirementId },
      (result: QueryResult) => parseCollateralRequirement(result, this)
    )
  }

  onCollateralRequirement(
    collateralRequirementId: string,
    callback: SubscriptionCallback<CollateralRequirement>
  ): SubscriptionHandler {
    return this.#gql.subscribeToQueryWithParser<CollateralRequirement>(
      queries.GET_COLLATERAL_REQUIREMENT('subscription'),
      { collateralRequirementId },
      callback,
      (result: QueryResult) => parseCollateralRequirement(result, this)
    )
  }

  async arbitratorFee(arbitratorFeeId: string): Promise<ArbitratorFee | null> {
    return this.#gql.performQueryWithParser<ArbitratorFee | null>(
      queries.GET_ARBITRATOR_FEE('query'),
      { arbitratorFeeId },
      (result: QueryResult) => parseArbitratorFee(result, this)
    )
  }

  onArbitratorFee(
    arbitratorFeeId: string,
    callback: SubscriptionCallback<ArbitratorFee | null>
  ): SubscriptionHandler {
    return this.#gql.subscribeToQueryWithParser<ArbitratorFee | null>(
      queries.GET_ARBITRATOR_FEE('subscription'),
      { arbitratorFeeId },
      callback,
      (result: QueryResult) => parseArbitratorFee(result, this)
    )
  }

  async ERC20(tokenAddress: string): Promise<ERC20> {
    return this.#gql.performQueryWithParser(
      queries.GET_ERC20('query'),
      { tokenAddress },
      (result: QueryResult) => parseERC20(result, this.#ethersProvider)
    )
  }

  onERC20(
    tokenAddress: string,
    callback: SubscriptionCallback<ERC20>
  ): SubscriptionHandler {
    return this.#gql.subscribeToQueryWithParser<ERC20>(
      queries.GET_ERC20('subscription'),
      { tokenAddress },
      callback,
      (result: QueryResult) => parseERC20(result, this.#ethersProvider)
    )
  }
}