Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
139 changes: 139 additions & 0 deletions server/api/[version]/validators/index.get.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
import type { TestDbHarness } from '~~/server/test/db-harness'
import type { FetchedValidator } from '~~/server/utils/types'
import { afterAll, afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
import * as schema from '~~/server/db/schema'
import { createTestDbHarness } from '~~/server/test/db-harness'
import { mainQuerySchema } from '~~/server/utils/schemas'

const mocks = vi.hoisted(() => ({
db: undefined as unknown,
getRange: vi.fn(),
getRpcUrl: vi.fn(),
initRpcClient: vi.fn(),
}))

vi.mock('nimiq-rpc-client-ts/client', () => ({ initRpcClient: mocks.initRpcClient }))
vi.mock('~~/packages/nimiq-validator-trustscore/src/range', () => ({ getRange: mocks.getRange }))
vi.mock('~~/server/utils/rpc', () => ({ getRpcUrl: mocks.getRpcUrl }))
vi.mock('~~/server/utils/drizzle', () => ({
tables: schema,
useDrizzle: () => mocks.db,
}))
vi.mock('~~/server/utils/logo', () => ({ handleValidatorLogo: vi.fn() }))

vi.stubGlobal('defineEventHandler', (handler: unknown) => handler)
vi.stubGlobal('defineCachedFunction', (handler: unknown) => handler)
vi.stubGlobal('getValidatedQuery', async (
event: { query?: Record<string, string> },
validate: (query: unknown) => unknown,
) => validate(event.query ?? {}))
vi.stubGlobal('createError', (error: { statusCode?: number, statusMessage?: string }) =>
Object.assign(new Error(error.statusMessage), error))
vi.stubGlobal('mainQuerySchema', mainQuerySchema)
vi.stubGlobal('tables', schema)
vi.stubGlobal('useDrizzle', () => mocks.db)
vi.stubGlobal('useSafeRuntimeConfig', () => ({
scoreV2Mode: 'active',
public: { nimiqNetwork: 'main-albatross' },
}))

let harness: TestDbHarness
let handler: (event: { query?: Record<string, string> }) => Promise<FetchedValidator[]>

beforeEach(async () => {
vi.clearAllMocks()
harness = await createTestDbHarness()
mocks.db = harness.db
mocks.getRpcUrl.mockReturnValue('https://rpc.invalid')
mocks.getRange.mockResolvedValue([false, 'HTTP error 403: Forbidden', undefined])

const validators = await harness.db.insert(schema.validators).values([
{ address: 'listed-validator', name: 'Listed', logo: 'logo', accentColor: '#000000', isListed: true, payoutType: 'restake' },
{ address: 'unlisted-validator', name: 'Unlisted', logo: 'logo', accentColor: '#000000', isListed: false, payoutType: 'direct' },
]).returning().all()
for (const validator of validators) {
await harness.db.insert(schema.scores).values([
{ validatorId: validator.id, epochNumber: 100, scoreVersion: 1, total: 0.6, availability: 0.7, dominance: 0.8, reliability: 0.9 },
{ validatorId: validator.id, epochNumber: 100, scoreVersion: 2, total: 0.9, availability: 0.8, dominance: 0.7, reliability: 0.6 },
]).execute()
await harness.db.insert(schema.activity).values({
validatorId: validator.id,
epochNumber: 101,
likelihood: 1,
rewarded: 10,
missed: 0,
dominanceRatioViaBalance: 0.01,
dominanceRatioViaSlots: 0.01,
balance: 1000,
stakers: 5,
}).execute()
}
await harness.db.insert(schema.activityEpochs).values({
epochNumber: 101,
status: 'failed',
startedAt: '2026-10-22T10:00:00.000Z',
lastError: 'HTTP error 403: Forbidden',
}).execute()

handler = (await import('./index.get')).default as typeof handler
})

afterEach(() => harness.close())
afterAll(() => vi.unstubAllGlobals())

describe('validator list RPC failure isolation', () => {
it('serves stored validators and stale scores when the RPC returns an error', async () => {
expect(await handler({})).toMatchObject([
{ address: 'listed-validator', balance: 1000, stakers: 5, score: { scoreVersion: 2, scoreEpoch: 100, total: 0.9, dataStatus: 'stale' } },
])
})

it('serves stored validators when the RPC throws', async () => {
mocks.getRange.mockRejectedValue(new Error('RPC connection failed'))

expect(await handler({})).toMatchObject([
{ address: 'listed-validator', score: { scoreEpoch: 100, dataStatus: 'stale' } },
])
})

it('serves stored validators without an RPC URL', async () => {
mocks.getRpcUrl.mockReturnValue('')

expect(await handler({})).toMatchObject([
{ address: 'listed-validator', score: { scoreEpoch: 100, dataStatus: 'stale' } },
])
})

it('preserves filters, score version, and forced reads during an outage', async () => {
expect(await handler({ query: { 'only-known': 'false', 'payout-type': 'direct', 'score-version': '1', 'force': 'true' } })).toMatchObject([
{ address: 'unlisted-validator', score: { scoreVersion: 1, total: 0.6, dataStatus: 'stale' } },
])
})

it('marks stored scores stale even when their epoch is the latest stored epoch', async () => {
await harness.db.delete(schema.activityEpochs).execute()

expect(await handler({})).toMatchObject([
{ address: 'listed-validator', score: { scoreEpoch: 100, dataStatus: 'stale' } },
])
})

it('keeps current scores when the live RPC succeeds', async () => {
mocks.getRange.mockResolvedValue([true, undefined, {
fromEpoch: 1,
toEpoch: 100,
epochDurationMs: 43_200_000,
}])

expect(await handler({})).toMatchObject([
{ address: 'listed-validator', score: { scoreVersion: 2, scoreEpoch: 100, dataStatus: 'current' } },
])
})

it('returns service unavailable when neither live nor stored epoch data exists', async () => {
await harness.db.delete(schema.activityEpochs).execute()
await harness.db.delete(schema.scores).execute()

await expect(handler({})).rejects.toMatchObject({ statusCode: 503 })
})
})
55 changes: 45 additions & 10 deletions server/api/[version]/validators/index.get.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
import type { Range } from 'nimiq-validator-trustscore/types'
import type { FetchValidatorsOptions } from '~~/server/utils/validators'
import { BATCHES_PER_EPOCH, BLOCK_SEPARATION_TIME, BLOCKS_PER_EPOCH } from '@nimiq/utils/albatross-policy'
import { consola } from 'consola'
import { initRpcClient } from 'nimiq-rpc-client-ts/client'
import { getRange } from '~~/packages/nimiq-validator-trustscore/src/range'
import {
Expand All @@ -8,27 +11,51 @@ import {
} from '~~/server/utils/activity-epochs'
import { getRpcUrl } from '~~/server/utils/rpc'
import { resolveScoreVersion } from '~~/server/utils/score-api'
import { parseScoreV2Mode } from '~~/server/utils/scores'
import { getLatestScoreState, parseScoreV2Mode } from '~~/server/utils/scores'
import { cachedFetchValidators, fetchValidators } from '~~/server/utils/validators'

export default defineEventHandler(async (event) => {
const queryParams = await getValidatedQuery(event, mainQuerySchema.parse)

const rpcUrl = getRpcUrl()
if (!rpcUrl)
throw createError('No Albatross RPC Node URL')
initRpcClient({ url: rpcUrl })
const runtimeConfig = useSafeRuntimeConfig() as ReturnType<typeof useSafeRuntimeConfig> & {
scoreV2Mode?: string
}
const { nimiqNetwork: network } = runtimeConfig.public

const [rangeSuccess, errorRange, range] = await getRange({ network })
if (!rangeSuccess || !range)
throw createError({ statusCode: 404, statusMessage: errorRange })

const rolloutMode = parseScoreV2Mode(runtimeConfig.scoreV2Mode)
const scoreVersion = resolveScoreVersion(queryParams['score-version'], rolloutMode)
let range: Pick<Range, 'fromEpoch' | 'toEpoch' | 'epochDurationMs'> | undefined
try {
const rpcUrl = getRpcUrl()
if (rpcUrl) {
initRpcClient({ url: rpcUrl })
const [rangeSuccess, , liveRange] = await getRange({ network })
if (rangeSuccess)
range = liveRange
}
}
catch (error) {
consola.warn('Failed to fetch live validator range', error)
}

const hasLiveRange = !!range
if (!range) {
const [latestScore, markers] = await Promise.all([
getLatestScoreState(scoreVersion),
getActivityEpochMarkers(),
])
const toEpoch = Math.max(latestScore?.epochNumber ?? 0, ...markers.map(marker => marker.epochNumber))
if (toEpoch < 1)
throw createError({ statusCode: 503, statusMessage: 'Validator data unavailable' })

// Stored epochs keep cache keys and database reads usable during RPC outages.
range = {
fromEpoch: 1,
toEpoch,
epochDurationMs: BLOCK_SEPARATION_TIME * (BLOCKS_PER_EPOCH - BATCHES_PER_EPOCH),
}
}

const recentRange = getRecentEpochRange(range)
const recentMarkers = await getActivityEpochMarkers(recentRange)
const recentCoverage = calculateActivityCoverage(
Expand All @@ -49,5 +76,13 @@ export default defineEventHandler(async (event) => {
if (!validatorsSuccess || !validators)
throw createError({ statusCode: 500, statusMessage: errorValidators || 'Failed to fetch validators' })

return validators
if (hasLiveRange)
return validators

return validators.map(validator => ({
...validator,
score: validator.score.dataStatus === 'current'
? { ...validator.score, dataStatus: 'stale' as const }
: validator.score,
}))
})
2 changes: 1 addition & 1 deletion server/utils/activity-epochs.ts
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ export interface PreparedCompletedEpoch {
activities: NewActivity[]
}

export function getRecentEpochRange(range: Range, durationMs = RECENT_ACTIVITY_DURATION_MS): { fromEpoch: number, toEpoch: number } {
export function getRecentEpochRange(range: Pick<Range, 'fromEpoch' | 'toEpoch' | 'epochDurationMs'>, durationMs = RECENT_ACTIVITY_DURATION_MS): { fromEpoch: number, toEpoch: number } {
if (!Number.isFinite(durationMs) || durationMs <= 0)
throw new RangeError('Recent activity duration must be positive')
if (!Number.isFinite(range.epochDurationMs) || range.epochDurationMs <= 0)
Expand Down
Loading