Repository navigation
Expand file tree
/
Copy pathrest.ts
More file actions
459 lines (423 loc) · 18.5 KB
/
Copy pathrest.ts
File metadata and controls
459 lines (423 loc) · 18.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
import type { FastifyInstance } from 'fastify'
import { resolveDecimalFormat, formatDecimal } from '../utils/decimals'
import { listCrashes } from '../ingester/restart'
import { listSourceFailures } from '../ingest/sourceFailures'
import { isBootComplete } from '../health'
import { price_requests_total } from '../metrics'
import { getCachedPrice, setCachedPrice } from '../redis'
import { getAggregatedPrice } from '../aggregator/vwap'
import { getBestRoute } from '../aggregator/bestRoute'
import { pgPool } from '../db'
import { config, getNetworkConfig, activeNetwork, type NetworkName } from '../config'
import { isAdminConfigured } from './auth'
import '../middleware/network' // declares req.network on the FastifyRequest type
import {
statusResponseSchema,
statusErrorResponseSchema,
priceResponseSchema,
routeResponseSchema,
historyResponseSchema,
depthResponseSchema,
impactResponseSchema,
installResponseValidation,
} from './schemas'
import { findOverlappingGaps } from '../backfill/gaps'
import { getDepth, getImpact } from '../pricing/depth'
import { getRetentionPath } from '../jobs/retentionStatus'
function makePairKey(a: string, b: string): string {
return [a, b].sort().join('/')
}
export const HISTORY_DEFAULT_LIMIT = 100
export const HISTORY_MAX_LIMIT = 1000
/**
* Resolve a requested pair against the ones this network watches.
*
* The issuer is honoured when the caller supplies one. It used to be discarded
* outright — `a.split(':')[0]` — so every asset called USDC was the same asset,
* and a request for Circle's mainnet USDC was answered with testnet USDC's
* price, stamped `"network":"testnet"`, at 1.72 per XLM against a real ~0.18.
*
* That is the worst failure mode an oracle has: not a refusal, but a confident
* wrong number. Asset codes are not unique on Stellar — anyone can issue
* "USDC", and Horizon lists many — so the issuer is the only thing that
* identifies an asset. A bare code still matches on code alone, since callers
* quoting XLM or a single-issuer asset rely on that.
*/
function findPair(assetA: string, assetB: string, network: NetworkName) {
const parse = (a: string) => {
if (a.toLowerCase() === 'native') return { code: 'XLM', issuer: null as string | null }
const [code, issuer] = a.split(':')
return { code: (code ?? '').toUpperCase(), issuer: issuer ?? null }
}
const qA = parse(assetA)
const qB = parse(assetB)
const matches = (
q: { code: string; issuer: string | null },
side: { code: string; issuer?: string | null },
) => {
if (q.code !== side.code.toUpperCase()) return false
// Only enforce the issuer when both sides name one; XLM has none, and a
// caller passing a bare code is not asserting which issuer they meant.
if (!q.issuer || !side.issuer) return true
return q.issuer === side.issuer
}
return getNetworkConfig(network).pairs.find(
p =>
(matches(qA, p.assetA) && matches(qB, p.assetB)) ||
(matches(qA, p.assetB) && matches(qB, p.assetA)),
)
}
export async function registerRESTRoutes(app: FastifyInstance) {
// Validate every response against its declared schema in dev/test (no-op in
// production). Must run before the routes below are registered so they pick
// up the validating serializer.
installResponseValidation(app)
/**
* How long the last ingester write may be stale before `/status` says so.
*
* Named rather than inlined because it is a published threshold: the README's
* Datadog/Prometheus/BetterStack examples and the `degraded` contract in
* `openapi.yaml` all quote it, and a monitor tuned to one number while the
* service uses another is worse than no monitor.
*/
const INGEST_STALE_AFTER_SECONDS = 300
// GET /status — public health/monitoring endpoint (no API key required) (#273)
app.get(
'/status',
{
config: { public: true },
schema: {
response: {
200: statusResponseSchema,
503: statusErrorResponseSchema,
},
},
},
async (req, reply) => {
const network = req.network ?? activeNetwork
const mem = process.memoryUsage()
const uptimeSeconds = Math.round(process.uptime())
const memoryUsageMb = Math.round((mem.heapUsed / 1024 / 1024) * 100) / 100
let result
try {
result = await pgPool.query(
`SELECT last_ledger, last_processed_at
FROM indexer_state
WHERE network = $1
ORDER BY updated_at DESC
LIMIT 1`,
[network]
)
} catch (err: unknown) {
// The driver's own message is not safe to return here. `/status` is
// public and unauthenticated, and a pg connection failure puts the host,
// the user and sometimes the whole connection string into
// `err.message` — this endpoint is the most-polled surface Lens has.
// Lens has already had to rotate a database password over exactly this
// shape of leak on another route, so the detail goes to the log, where
// buildLogger pipes it through redactSecrets, and the response says only
// which dependency is down.
req.log.error({ err }, 'status: database query failed')
return reply.status(503).send({
ok: false,
status: 'unhealthy',
error: 'Database unavailable',
pagingCondition: 'DATABASE_DOWN',
})
}
const lastProcessedAt = result.rows[0]?.last_processed_at ?? null
const lastIndexedLedger = result.rows[0]?.last_ledger ?? null
const ingestLagSeconds = lastProcessedAt
? Math.max(0, Math.round((Date.now() - new Date(lastProcessedAt).getTime()) / 1000))
: null
const isStale = ingestLagSeconds !== null && ingestLagSeconds > INGEST_STALE_AFTER_SECONDS
// Process health has to be measured, or the split this endpoint exists to
// make is cosmetic. Boot is the signal that is actually available and
// actually distinct from data freshness: between `listen()` and
// `markBootComplete()` the process answers requests while its ingesters
// are not all running yet, which is a degraded *process*, not stale data.
// It is the same signal `/ready` gates on.
const processHealth = isBootComplete() ? ('healthy' as const) : ('degraded' as const)
const dataHealth = isStale ? ('stale' as const) : ('healthy' as const)
const overallStatus =
processHealth === 'degraded' || isStale ? ('degraded' as const) : ('healthy' as const)
return {
ok: true,
status: overallStatus,
network,
health: {
process: processHealth,
data: dataHealth,
},
process: {
uptimeSeconds,
memoryUsageMb,
status: processHealth,
},
data: {
lastIndexedLedger,
lastProcessedAt,
ingestLagSeconds,
isStale,
},
watchedPairs: getNetworkConfig(network).pairs.map(p => p.pairKey),
lastIndexedLedger,
lastProcessedAt,
ingestLagSeconds,
retentionPath: getRetentionPath(),
// #508: whether the admin surface is usable at all, so an operator
// can tell "I sent the wrong token" from "this deployment has no
// ADMIN_TOKEN" without guessing from a 401. It reports only that the
// token is configured, never any part of its value.
adminConfigured: isAdminConfigured(),
crashes: listCrashes(network).map(c => ({
name: c.name,
network: c.network,
message: c.message,
at: c.at.toISOString(),
})),
// #329: sources whose latest fetch failed on this network, so a venue
// that is down is visible rather than reading as a venue with nothing
// to report. The error message stays in the log: an upstream client
// error can carry the upstream URL, and this route is public.
failedSources: listSourceFailures(network).map(f => ({
source: f.source,
network: f.network,
subject: f.subject,
at: f.at.toISOString(),
})),
}
}
)
// GET /price/:assetA/:assetB
app.get<{
Params: { assetA: string; assetB: string }
Querystring: {
decimals?: string
decimalFormat?: string
staleThreshold?: string
staleThresholdSeconds?: string
}
}>(
'/price/:assetA/:assetB',
{ config: { scope: 'read:prices' }, schema: { response: { 200: priceResponseSchema } } },
async (req, reply) => {
price_requests_total.inc()
const { assetA, assetB } = req.params
const network = req.network ?? activeNetwork
const pair = findPair(assetA, assetB, network)
if (!pair) return reply.status(404).send({ error: `Pair ${assetA}/${assetB} not watched on ${network}` })
const rawThreshold = req.query?.staleThreshold ?? req.query?.staleThresholdSeconds
let staleThreshold: number | undefined
if (rawThreshold !== undefined) {
staleThreshold = parseInt(rawThreshold, 10)
if (isNaN(staleThreshold) || staleThreshold <= 0) {
return reply.status(400).send({ error: 'staleThreshold must be a positive integer' })
}
}
const decimalFormat = resolveDecimalFormat(req)
if (decimalFormat === 'string') {
reply.header('x-decimal-format', 'string')
}
// Cache key is network-scoped and format-isolated so number and string payloads never collide,
// and scoped to staleThreshold if customized.
const cacheParts = [network, pair.pairKey]
if (decimalFormat === 'string') cacheParts.push('decimals_string')
if (staleThreshold !== undefined) cacheParts.push(`stale_${staleThreshold}`)
const cacheKey = cacheParts.join(':')
const cached = await getCachedPrice(cacheKey)
if (cached) {
try {
reply.header('X-Cache', 'HIT')
return JSON.parse(cached)
} catch { /* fall through */ }
}
const agg = await getAggregatedPrice(pair.pairKey, network, { decimalFormat, staleThresholdSeconds: staleThreshold })
const route = await getBestRoute(pair.assetA, pair.assetB, pair.pairKey, 1000, network)
const result = {
assetA: pair.assetA.code,
assetB: pair.assetB.code,
pairKey: pair.pairKey,
network,
...agg,
bestRoute: route.route,
lastUpdated: new Date().toISOString(),
}
await setCachedPrice(cacheKey, result, config.cache.priceTtl)
reply.header('X-Cache', 'MISS')
return result
}
)
// GET /price/:assetA/:assetB/route?amount=1000
app.get<{
Params: { assetA: string; assetB: string }
Querystring: { amount?: string; network?: string }
}>(
'/price/:assetA/:assetB/route',
{ config: { scope: 'read:prices' }, schema: { response: { 200: routeResponseSchema } } },
async (req, reply) => {
const { assetA, assetB } = req.params
const amount = parseFloat(req.query.amount ?? '1000')
// Validate amount before the pair check: a malformed request parameter
// is a 400 regardless of whether the pair is watched.
if (isNaN(amount) || amount <= 0) return reply.status(400).send({ error: 'amount must be a positive number' })
const network = req.network ?? activeNetwork
const pair = findPair(assetA, assetB, network)
if (!pair) return reply.status(404).send({ error: `Pair ${assetA}/${assetB} not watched on ${network}` })
const decimalFormat = resolveDecimalFormat(req)
const routeInfo = await getBestRoute(pair.assetA, pair.assetB, pair.pairKey, amount, network)
if (decimalFormat === 'string') {
reply.header('x-decimal-format', 'string')
return {
...routeInfo,
sdexPrice: String(routeInfo.sdexPrice),
ammPrice: String(routeInfo.ammPrice),
estimatedOutput: String(routeInfo.estimatedOutput),
slippagePct: String(routeInfo.slippagePct),
}
}
return routeInfo
}
)
// GET /price/:assetA/:assetB/history?window=1h&limit=100
app.get<{
Params: { assetA: string; assetB: string }
Querystring: { window?: string; limit?: string; decimals?: string; decimalFormat?: string }
}>(
'/price/:assetA/:assetB/history',
{ config: { scope: 'read:history' }, schema: { response: { 200: historyResponseSchema } } },
async (req, reply) => {
const { assetA, assetB } = req.params
const network = req.network ?? activeNetwork
const window = req.query.window ?? '1h'
const limit = Math.min(parseInt(req.query.limit ?? String(HISTORY_DEFAULT_LIMIT), 10), HISTORY_MAX_LIMIT)
const pairKey = makePairKey(assetA, assetB)
const decimalFormat = resolveDecimalFormat(req)
if (decimalFormat === 'string') {
reply.header('x-decimal-format', 'string')
}
if (!['1m', '5m', '1h', '24h'].includes(window)) {
return reply.status(400).send({ error: 'window must be one of: 1m, 5m, 1h, 24h' })
}
const result = await pgPool.query(
`SELECT bucket, window, vwap::numeric, sdex_vwap::numeric, amm_vwap::numeric,
volume::numeric, trade_count, open_price::numeric, close_price::numeric,
high_price::numeric, low_price::numeric
FROM price_aggregates
WHERE pair_key = $1 AND window = $2 AND network = $3
ORDER BY bucket DESC
LIMIT $4`,
[pairKey, window, network, limit]
)
const windowMs: Record<string, number> = {
'1m': 60_000,
'5m': 300_000,
'1h': 3600_000,
'24h': 86400_000,
}
const span = (windowMs[window] ?? 3600_000) * limit
const now = new Date()
const queryStart = new Date(now.getTime() - span)
const overlappingGaps = await findOverlappingGaps({
network,
pair: pairKey,
start: queryStart,
end: now,
})
const gapDeclaration = overlappingGaps.length > 0 ? { incomplete: true, gaps: overlappingGaps } : {}
return {
pairKey,
network,
window,
buckets: result.rows.map(r => ({
bucket: r.bucket,
vwap: formatDecimal(r.vwap, decimalFormat),
sdexVwap: formatDecimal(r.sdex_vwap, decimalFormat),
ammVwap: formatDecimal(r.amm_vwap, decimalFormat),
volume: formatDecimal(r.volume, decimalFormat),
tradeCount: r.trade_count !== null && r.trade_count !== undefined ? parseInt(String(r.trade_count), 10) : null,
open: formatDecimal(r.open_price, decimalFormat),
close: formatDecimal(r.close_price, decimalFormat),
high: formatDecimal(r.high_price, decimalFormat),
low: formatDecimal(r.low_price, decimalFormat),
})),
...gapDeclaration,
}
}
)
// GET /pools?cursor=&limit= lives in src/routes/pools.ts, next to /pairs and
// /screener, so the `lens_get_pools` MCP tool runs the same listPools this
// route does; registerPoolsRoutes() is called from app.ts.
// GET /price/:assetA/:assetB/depth?amount=1000
app.get<{
Params: { assetA: string; assetB: string }
Querystring: { amount?: string; decimals?: string; decimalFormat?: string }
}>(
'/price/:assetA/:assetB/depth',
{
config: { scope: 'read:prices' },
schema: { response: { 200: depthResponseSchema, 503: depthResponseSchema } },
},
async (req, reply) => {
const { assetA, assetB } = req.params
// Number(), not parseFloat(): parseFloat('100abc') is 100, so a typo in a
// query string would silently price a different trade than the caller
// asked for. Trailing junk is a 400.
const amount = Number(req.query.amount ?? '1000')
const network = req.network ?? activeNetwork
const pair = findPair(assetA, assetB, network)
if (!pair) return reply.status(404).send({ error: `Pair ${assetA}/${assetB} not watched on ${network}` })
if (isNaN(amount) || amount <= 0) return reply.status(400).send({ error: 'amount must be a positive number' })
// Depth reads are network-scoped on both legs (pool_snapshots and the
// price_points subquery that names this pair's pools), so a mainnet pair
// is never priced off a testnet pool's reserves.
// Argument order is (network, pairKey, amount, feeOpts). network and
// pairKey are both strings, so swapping them compiles cleanly and then
// prices every pair against a network named "XLM/USDC" — worth reading
// twice before editing this line.
const depthResult = await getDepth(network, pair.pairKey, amount, {
horizonUrl: getNetworkConfig(network).horizon.url,
})
// An unavailable answer is a 503, not a 200 with zeros: the pair is
// watched, we simply cannot price it right now, and a caller retrying
// later is the correct response to that.
return reply.status(depthResult.status === 'unavailable' ? 503 : 200).send({
assetA: pair.assetA.code,
assetB: pair.assetB.code,
// pairKey and network come from depthResult, which carries both on each
// arm of the union. Naming pairKey here too made it a duplicate key.
...depthResult,
})
}
)
// GET /impact/:assetA/:assetB?thresholds=1,5,10
app.get<{
Params: { assetA: string; assetB: string }
Querystring: { thresholds?: string; liquidityFraction?: string }
}>(
'/impact/:assetA/:assetB',
{ schema: { response: { 200: impactResponseSchema } } },
async (req, reply) => {
const { assetA, assetB } = req.params
const network = req.network ?? activeNetwork
const pair = findPair(assetA, assetB, network)
if (!pair) return reply.status(404).send({ error: `Pair ${assetA}/${assetB} not watched on ${network}` })
const thresholds = req.query.thresholds
? req.query.thresholds.split(',').map(Number)
: [1, 5, 10]
const liquidityFraction = req.query.liquidityFraction === undefined
? 0.5
: Number(req.query.liquidityFraction)
if (
thresholds.length === 0 ||
thresholds.some(value => !Number.isFinite(value) || value <= 0) ||
!Number.isFinite(liquidityFraction) || liquidityFraction <= 0 || liquidityFraction > 1
) {
return reply.status(400).send({ error: 'thresholds must be positive numbers and liquidityFraction must be between 0 and 1' })
}
const impact = await getImpact(pair.pairKey, { thresholds, liquidityFraction }, network)
if (!impact) return reply.status(404).send({ error: `No AMM liquidity available for ${assetA}/${assetB}` })
return { assetA: pair.assetA.code, assetB: pair.assetB.code, pairKey: pair.pairKey, ...impact }
}
)
}