feat: snapshot status indicator

gatsby-browser.js

@@ -31,6 +31,7 @@ import Segment from "decentraland-gatsby/dist/components/Development/Segment"
 import { SEGMENT_KEY, SSO_URL } from "./src/constants"
 import { flattenMessages } from "./src/utils/intl"
 import en from "./src/intl/en.json"
+import SnapshotStatus from "./src/components/Debug/SnapshotStatus"
 
 const queryClient = new QueryClient()
 
@@ -49,6 +50,7 @@ export const wrapPageElement = ({ element, props }) => {
       <IntlProvider defaultLocale='en' locale='en' messages={flattenMessages(en)}>
         <IdentityModalContextProvider>
           <BurgerMenuStatusContextProvider>
+            <SnapshotStatus />
             <Layout {...props} rightMenu={<Navbar />}>
               {element}
             </Layout>

package.json

@@ -87,6 +87,7 @@
     "keccak": "^3.0.1",
     "lodash": "^4.17.21",
     "nft.storage": "^7.1.1",
+    "node-cache": "^5.1.2",
     "node-pg-migrate": "^6.2.1",
     "numeral": "^2.0.6",
     "patch-package": "^6.4.7",

src/back/routes/debug.ts

@@ -2,7 +2,7 @@ import { WithAuth, auth } from 'decentraland-gatsby/dist/entities/Auth/middlewar
 import handleAPI from 'decentraland-gatsby/dist/entities/Route/handle'
 import routes from 'decentraland-gatsby/dist/entities/Route/routes'
 
-import { DEBUG_ADDRESSES } from '../../entities/Debug/isDebugAddress'
+import { DEBUG_ADDRESSES } from '../../constants'
 import { ErrorService } from '../../services/ErrorService'
 import { giveAndRevokeLandOwnerBadges, giveTopVoterBadges, runQueuedAirdropJobs } from '../jobs/BadgeAirdrop'
 import { validateDebugAddress } from '../utils/validations'

src/back/routes/snapshot.ts

@@ -3,12 +3,13 @@ import handleAPI from 'decentraland-gatsby/dist/entities/Route/handle'
 import routes from 'decentraland-gatsby/dist/entities/Route/routes'
 import { Request } from 'express'
 
-import { SnapshotVote } from '../../clients/SnapshotGraphqlTypes'
+import { SnapshotVote } from '../../clients/SnapshotTypes'
 import { SnapshotService } from '../../services/SnapshotService'
 import { validateAddress, validateDates, validateFields, validateProposalSnapshotId } from '../utils/validations'
 
 export default routes((router) => {
-  router.get('/snapshot/status-space/:spaceName', handleAPI(getStatusAndSpace))
+  router.get('/snapshot/status', handleAPI(getStatus))
+  router.get('/snapshot/config/:spaceName', handleAPI(getConfig))
   router.post('/snapshot/votes', handleAPI(getAddressesVotes))
   router.get('/snapshot/votes/:proposalSnapshotId', handleAPI(getProposalVotes))
   router.post('/snapshot/votes/all', handleAPI(getAllVotesBetweenDates))
@@ -19,9 +20,13 @@ export default routes((router) => {
   router.get('/snapshot/proposal-scores/:proposalSnapshotId', handleAPI(getProposalScores))
 })
 
-async function getStatusAndSpace(req: Request<{ spaceName?: string }>) {
+async function getStatus(req: Request) {
+  return await SnapshotService.getStatus()
+}
+
+async function getConfig(req: Request<{ spaceName?: string }>) {
   const { spaceName } = req.params
-  return await SnapshotService.getStatusAndSpace(spaceName)
+  return await SnapshotService.getConfig(spaceName)
 }
 
 async function getAddressesVotes(req: Request) {

src/back/routes/votes.ts

@@ -4,7 +4,7 @@ import { Request } from 'express'
 import isNumber from 'lodash/isNumber'
 
 import { SnapshotGraphql } from '../../clients/SnapshotGraphql'
-import { SnapshotVote } from '../../clients/SnapshotGraphqlTypes'
+import { SnapshotVote } from '../../clients/SnapshotTypes'
 import ProposalModel from '../../entities/Proposal/model'
 import { ProposalAttributes } from '../../entities/Proposal/types'
 import VotesModel from '../../entities/Votes/model'

src/back/services/vote.ts

@@ -1,4 +1,4 @@
-import { SnapshotVote } from '../../clients/SnapshotGraphqlTypes'
+import { SnapshotVote } from '../../clients/SnapshotTypes'
 import { VOTES_VP_THRESHOLD } from '../../constants'
 import VoteModel from '../../entities/Votes/model'
 import { VoteCount, Voter } from '../../entities/Votes/types'

src/back/utils/validations.ts

@@ -2,7 +2,7 @@ import RequestError from 'decentraland-gatsby/dist/entities/Route/error'
 import isEthereumAddress from 'validator/lib/isEthereumAddress'
 import isUUID from 'validator/lib/isUUID'
 
-import { SnapshotProposal } from '../../clients/SnapshotGraphqlTypes'
+import { SnapshotProposal } from '../../clients/SnapshotTypes'
 import isDebugAddress from '../../entities/Debug/isDebugAddress'
 
 export function validateDates(start?: string, end?: string) {

src/clients/Governance.ts

@@ -40,12 +40,13 @@ import Time from '../utils/date/Time'
 import { TransparencyBudget } from './DclData'
 import {
   DetailedScores,
+  SnapshotConfig,
   SnapshotProposal,
   SnapshotSpace,
   SnapshotStatus,
   SnapshotVote,
   VpDistribution,
-} from './SnapshotGraphqlTypes'
+} from './SnapshotTypes'
 import { VestingInfo } from './VestingData'
 
 type NewProposalMap = {
@@ -527,14 +528,19 @@ export class Governance extends API {
     return response.data
   }
 
-  async getSnapshotStatusAndSpace(spaceName?: string) {
-    const response = await this.fetch<ApiResponse<{ status: SnapshotStatus; space: SnapshotSpace }>>(
-      `/snapshot/status-space/${spaceName}`,
+  async getSnapshotConfigAndSpace(spaceName?: string) {
+    const response = await this.fetch<ApiResponse<{ config: SnapshotConfig; space: SnapshotSpace }>>(
+      `/snapshot/config/${spaceName}`,
       this.options().method('GET')
     )
     return response.data
   }
 
+  async getSnapshotStatus() {
+    const response = await this.fetch<ApiResponse<SnapshotStatus>>(`/snapshot/status`, this.options().method('GET'))
+    return response.data
+  }
+
   async getAddressesVotes(addresses: string[]) {
     const result = await this.fetch<ApiResponse<VotedProposal[]>>(
       `/snapshot/votes/`,

src/clients/SnapshotApi.ts

@@ -6,6 +6,7 @@ import { CancelProposal, ProposalType, Vote } from '@snapshot-labs/snapshot.js/d
 import logger from 'decentraland-gatsby/dist/entities/Development/logger'
 import env from 'decentraland-gatsby/dist/utils/env'
 
+import { DEBUG_ADDRESSES } from '../constants'
 import {
   SNAPSHOT_ADDRESS,
   SNAPSHOT_API_KEY,
@@ -155,11 +156,9 @@ export class SnapshotApi {
   }
 
   async getScores(addresses: string[]) {
-    const formattedAddresses = addresses.map((address) => getChecksumAddress(address))
-    const spaceName = SnapshotApi.getSpaceName()
-    const network = getEnvironmentChainId().toString()
-    const strategies = (await SnapshotGraphql.get().getSpace(spaceName)).strategies
-    const scoreApiUrl = `https://score.snapshot.org/?apiKey=${SNAPSHOT_API_KEY}`
+    const { formattedAddresses, spaceName, network, strategies, scoreApiUrl } = await this.prepareScoresQueryArgs(
+      addresses
+    )
 
     try {
       const scores = await snapshot.utils.getScores(
@@ -188,4 +187,29 @@ export class SnapshotApi {
   private static toSnapshotTimestamp(time: number) {
     return Number(time.toString().slice(0, -3))
   }
+
+  async ping(addressesSample: string[]) {
+    const addresses = addressesSample.length === 0 ? DEBUG_ADDRESSES : addressesSample
+    try {
+      const { formattedAddresses, spaceName, network, strategies, scoreApiUrl } = await this.prepareScoresQueryArgs(
+        addresses
+      )
+      const now = new Date()
+      const startTime = now.getTime()
+      await snapshot.utils.getScores(spaceName, strategies, network, formattedAddresses, undefined, scoreApiUrl)
+      const endTime = new Date().getTime()
+      return endTime - startTime
+    } catch (error) {
+      return -1 // Return -1 to indicate API failures
+    }
+  }
+
+  private async prepareScoresQueryArgs(addresses: string[]) {
+    const formattedAddresses = addresses.map((address) => getChecksumAddress(address))
+    const spaceName = SnapshotApi.getSpaceName()
+    const network = getEnvironmentChainId().toString()
+    const strategies = (await SnapshotGraphql.get().getSpace(spaceName)).strategies
+    const scoreApiUrl = `https://score.snapshot.org/?apiKey=${SNAPSHOT_API_KEY}`
+    return { formattedAddresses, spaceName, network, strategies, scoreApiUrl }
+  }
 }

src/clients/SnapshotGraphql.ts

@@ -3,31 +3,46 @@ import env from 'decentraland-gatsby/dist/utils/env'
 import uniqBy from 'lodash/uniqBy'
 
 import { SNAPSHOT_API, SNAPSHOT_API_KEY, SNAPSHOT_SPACE } from '../entities/Snapshot/constants'
+import { getAMonthAgo } from '../utils/date/aMonthAgo'
 import { ErrorCategory } from '../utils/errorCategories'
 
 import { ErrorClient } from './ErrorClient'
 import {
+  SnapshotConfig,
   SnapshotProposal,
   SnapshotProposalContent,
   SnapshotProposalResponse,
   SnapshotProposalsResponse,
   SnapshotQueryResponse,
   SnapshotScoresState,
   SnapshotSpace,
-  SnapshotStatus,
   SnapshotVote,
   SnapshotVoteResponse,
   SnapshotVpResponse,
   StrategyOrder,
   VpDistribution,
-} from './SnapshotGraphqlTypes'
+} from './SnapshotTypes'
 import { inBatches, trimLastForwardSlash } from './utils'
 
 export const getQueryTimestamp = (dateTimestamp: number) => Math.round(dateTimestamp / 1000)
 
 const GRAPHQL_ENDPOINT = `/graphql`
 const BATCH_SIZE = 1000
-const OLDEST_PROPOSAL_TIMESTAMP = 1621036800
+const GET_VOTES_QUERY = `
+  query getVotes($space: String!, $start: Int!, $end: Int!, $first: Int!) {
+    votes(where: {space: $space, created_gte: $start, created_lt: $end}, orderBy: "created", orderDirection: asc, first: $first) {
+      id
+      voter
+      created
+      vp
+      choice
+      proposal {
+        id
+        choices
+      }
+    }
+  }
+`
 
 export class SnapshotGraphql extends API {
   static Url = SNAPSHOT_API || 'https://hub.snapshot.org/'
@@ -52,12 +67,12 @@ export class SnapshotGraphql extends API {
     if (SNAPSHOT_API_KEY) this.defaultOptions.header('x-api-key', SNAPSHOT_API_KEY)
   }
 
-  async getStatus() {
-    const status = await this.fetch<SnapshotStatus>('/api/')
+  async getConfig() {
+    const snapshotConfig = await this.fetch<SnapshotConfig>('/api/')
 
     return {
-      ...status,
-      version: status.version.split('#')[0],
+      ...snapshotConfig,
+      version: snapshotConfig.version.split('#')[0],
     }
   }
 
@@ -235,22 +250,6 @@ export class SnapshotGraphql extends API {
   }
 
   async getAllVotesBetweenDates(start: Date, end: Date): Promise<SnapshotVote[]> {
-    const query = `
-      query getVotes($space: String!, $start: Int!, $end: Int!, $first: Int!) {
-        votes(where: {space: $space, created_gte: $start, created_lt: $end}, orderBy: "created", orderDirection: asc, first: $first) {
-          id
-          voter
-          created
-          vp
-          choice
-          proposal {
-            id
-            choices
-          }
-        }
-      }
-    `
-
     let allResults: SnapshotVote[] = []
     let hasNext = true
     let created = getQueryTimestamp(start.getTime())
@@ -268,7 +267,7 @@ export class SnapshotGraphql extends API {
         const result = await this.fetch<SnapshotVoteResponse>(
           GRAPHQL_ENDPOINT,
           this.options().method('POST').json({
-            query,
+            GET_VOTES_QUERY,
             variables,
           })
         )
@@ -444,23 +443,31 @@ export class SnapshotGraphql extends API {
     return result?.data?.proposal
   }
 
-  async hasVoted(address: string) {
-    const query = `query HasVoted($space: String!, $address: String!, $created: Int!) {
-      votes(
-          where: { space: $space, voter: $address, created_gt: $created}
-          first: 1
-      ) {
-        voter  
-      }
+  async ping() {
+    const now = new Date()
+    const startTime = now.getTime()
+    try {
+      const startDate = getAMonthAgo(now).getTime()
+      const endDate = now.getTime()
+      const response = await this.fetch<SnapshotVoteResponse>(
+        GRAPHQL_ENDPOINT,
+        this.options()
+          .method('POST')
+          .json({
+            query: GET_VOTES_QUERY,
+            variables: {
+              space: SNAPSHOT_SPACE,
+              first: 10,
+              start: getQueryTimestamp(startDate),
+              end: getQueryTimestamp(endDate),
+            },
+          })
+      )
+      const endTime = new Date().getTime()
+      const addressesSample = response?.data?.votes.map((vote: SnapshotVote) => vote.voter)
+      return { responseTime: endTime - startTime, addressesSample }
+    } catch (error) {
+      return { responseTime: -1, addressesSample: [] } // Return -1 to indicate API failures
     }
-    `
-    const result = await this.fetch<SnapshotQueryResponse<{ votes: Pick<SnapshotVote, 'voter'>[] }>>(
-      GRAPHQL_ENDPOINT,
-      this.options()
-        .method('POST')
-        .json({ query, variables: { address, space: SNAPSHOT_SPACE, created: OLDEST_PROPOSAL_TIMESTAMP } })
-    )
-
-    return result?.data?.votes.length > 0
   }
 }

src/clients/SnapshotSubgraph.ts

@@ -3,7 +3,7 @@ import fetch from 'isomorphic-fetch'
 import { SNAPSHOT_QUERY_ENDPOINT } from '../entities/Snapshot/constants'
 import { PICKED_BY_QUERY } from '../entities/Snapshot/queries'
 
-import { Delegation } from './SnapshotGraphqlTypes'
+import { Delegation } from './SnapshotTypes'
 import { inBatches, trimLastForwardSlash } from './utils'
 
 export type DelegationQueryResult = {

src/clients/SnapshotGraphqlTypes.ts → src/clients/SnapshotTypes.ts

@@ -1,5 +1,5 @@
 export type SnapshotQueryResponse<T> = { data: T }
-export type SnapshotStatus = {
+export type SnapshotConfig = {
   name: string
   network: string
   version: string
@@ -131,3 +131,11 @@ export enum StrategyOrder {
   L1Wearables,
   Rental,
 }
+
+export enum ServiceHealth {
+  Normal = 'normal',
+  Slow = 'slow',
+  Failing = 'failing',
+}
+export type ServiceStatus = { health: ServiceHealth; responseTime: number }
+export type SnapshotStatus = { scoresStatus: ServiceStatus; graphQlStatus: ServiceStatus }