resolution-api.ts

import type { Duration } from "enssdk";

import type {
  ResolvePrimaryNameResponse,
  ResolvePrimaryNamesResponse,
  ResolveRecordsResponse,
} from "@ensnode/ensnode-sdk";

import { createApp } from "@/lib/hono-factory";
import { resolveForward } from "@/lib/resolution/forward-resolution";
import { resolvePrimaryNames } from "@/lib/resolution/multichain-primary-name-resolution";
import { resolveReverse } from "@/lib/resolution/reverse-resolution";
import { runWithTrace } from "@/lib/tracing/tracing-api";
import { canAccelerateMiddleware } from "@/middleware/can-accelerate.middleware";
import { indexingStatusMiddleware } from "@/middleware/indexing-status.middleware";
import { makeIsRealtimeMiddleware } from "@/middleware/is-realtime.middleware";

import {
  resolvePrimaryNameRoute,
  resolvePrimaryNamesRoute,
  resolveRecordsRoute,
} from "./resolution-api.routes";

/**
 * The effective distance for acceleration is indexing status cache time plus
 * MAX_REALTIME_DISTANCE_TO_ACCELERATE.
 */
const MAX_REALTIME_DISTANCE_TO_ACCELERATE: Duration = 60; // 1 minute in seconds

const app = createApp({
  middlewares: [
    indexingStatusMiddleware,
    makeIsRealtimeMiddleware("resolution-api", MAX_REALTIME_DISTANCE_TO_ACCELERATE),
    canAccelerateMiddleware,
  ],
});

/**
 * Example queries for /records:
 *
 * 1. Resolve address records (ETH and BTC):
 * GET /records/example.eth&addresses=60,0
 *
 * 2. Resolve text records (avatar and Twitter):
 * GET /records/example.eth&texts=avatar,com.twitter
 *
 * 3. Combined resolution:
 * GET /records/example.eth&name=true&addresses=60,0&texts=avatar,com.twitter
 */
app.openapi(resolveRecordsRoute, async (c) => {
  const { name } = c.req.valid("param");
  const { selection, trace: showTrace, accelerate } = c.req.valid("query");
  const canAccelerate = c.var.canAccelerate;

  const { result, trace } = await runWithTrace(() =>
    resolveForward(name, selection, { accelerate, canAccelerate }),
  );

  const response = {
    records: result,

    accelerationRequested: accelerate,
    accelerationAttempted: accelerate && canAccelerate,
    ...(showTrace && { trace }),
  } satisfies ResolveRecordsResponse<typeof selection>;

  return c.json(response);
});

/**
 * Example queries for /primary-name:
 *
 * 1. ENSIP-19 Primary Name Lookup (for ETH Mainnet)
 * GET /primary-name/0x1234...abcd/1
 *
 * 2. ENSIP-19 Primary Name (for specific Chain, e.g., Optimism)
 * GET /primary-name/0x1234...abcd/10
 *
 * 3. ENSIP-19 Primary Name (for 'default' EVM Chain)
 * GET /primary-name/0x1234...abcd/0
 */
app.openapi(resolvePrimaryNameRoute, async (c) => {
  const { address, chainId } = c.req.valid("param");
  const { trace: showTrace, accelerate } = c.req.valid("query");
  const canAccelerate = c.var.canAccelerate;

  const { result, trace } = await runWithTrace(() =>
    resolveReverse(address, chainId, { accelerate, canAccelerate }),
  );

  const response = {
    name: result,

    accelerationRequested: accelerate,
    accelerationAttempted: accelerate && canAccelerate,
    ...(showTrace && { trace }),
  } satisfies ResolvePrimaryNameResponse;

  return c.json(response);
});

/**
 * Example queries for /primary-names:
 *
 * 1. Multichain ENSIP-19 Primary Names Lookup (defaults to all ENSIP-19 supported chains)
 * GET /primary-names/0x1234...abcd
 *
 * 2. Multichain ENSIP-19 Primary Names Lookup (specific chain ids)
 * GET /primary-names/0x1234...abcd?chainIds=1,10,8453
 */
app.openapi(resolvePrimaryNamesRoute, async (c) => {
  const { address } = c.req.valid("param");
  const { chainIds, trace: showTrace, accelerate } = c.req.valid("query");
  const canAccelerate = c.var.canAccelerate;

  const { result, trace } = await runWithTrace(() =>
    resolvePrimaryNames(address, chainIds, { accelerate, canAccelerate }),
  );

  const response = {
    names: result,

    accelerationRequested: accelerate,
    accelerationAttempted: accelerate && canAccelerate,
    ...(showTrace && { trace }),
  } satisfies ResolvePrimaryNamesResponse;

  return c.json(response);
});

export default app;