Expose IPLD API (#140)

* feat: add IPLD nodes API with block height range validation and repository methods

* feat: add DATABASE_URL environment variable to file-retriever service in docker-compose

* feat: integrate @autonomys/auto-utils for object serialization in IPLD nodes API

* fix: update response handling in objects controller to use stringify for JSON serialization

* revert: intended update

* fix: update response handling in IPLD nodes controller to use status and content type for JSON responses

* feat: add composite indexes to Node type in GraphQL schema for improved query performance

* fix: improve block height range validation in IPLD nodes controller with detailed error messages

* fix: simplify composite indexes in Node type of GraphQL schema for better clarity

Author: clostao

docker/file-retriever/docker-compose.yml

@@ -40,6 +40,7 @@ services:
       - VICTORIA_USERNAME=${VICTORIA_USERNAME}
       - VICTORIA_PASSWORD=${VICTORIA_PASSWORD}
       - OBJECT_MAPPING_INDEXER_URL=http://object-mapping-app:3000/ws
+      - DATABASE_URL=${DATABASE_URL}
     depends_on:
       subspace-node:
         condition: service_healthy

services/dag-indexer/schema.graphql

@@ -1,4 +1,8 @@
-type Node @entity {
+type Node
+  @entity
+  @compositeIndexes(
+    fields: [["blockHeight", "indexInBlock"], ["timestamp", "indexInBlock"]]
+  ) {
   id: ID!
   cid: String! @index
   type: String

services/object-mapping-indexer/package.json

@@ -18,6 +18,7 @@
     "@auto-files/models": "workspace:*",
     "@auto-files/rpc-apis": "workspace:*",
     "@autonomys/auto-dag-data": "^1.4.35",
+    "@autonomys/auto-utils": "^1.4.35",
     "@autonomys/rpc": "^1.4.31",
     "@peculiar/webcrypto": "^1.5.0",
     "@types/node": "^22.10.2",

services/object-mapping-indexer/src/config.ts

@@ -19,4 +19,7 @@ export const config = {
     ),
     timeBetweenMessages: notNaN(Number(env('TIME_BETWEEN_MESSAGES', '1000'))),
   },
+  ipldNodesAPI: {
+    maxBlockHeightRange: notNaN(Number(env('MAX_BLOCK_HEIGHT_RANGE', '1000'))),
+  },
 }

services/object-mapping-indexer/src/http/api.ts

@@ -3,6 +3,7 @@ import express, { Request, Response } from 'express'
 import { objectsController } from './controllers/objects.js'
 import { config } from '../config.js'
 import cors from 'cors'
+import { ipldNodesController } from './controllers/IPLDNodes.js'
 
 export const expressApp = express()
 
@@ -17,6 +18,7 @@ if (config.corsAllowOrigins) {
 
 expressApp.use('/objects', objectsController)
 expressApp.use('/health', healthController)
+expressApp.use('/ipld-nodes', ipldNodesController)
 
 // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type, @typescript-eslint/no-unused-vars
 expressApp.use((err: unknown, _: Request, res: Response, __: Function) => {

services/object-mapping-indexer/src/http/controllers/IPLDNodes.ts

@@ -0,0 +1,62 @@
+import { Router } from 'express'
+import { ipldNodesRepository } from '../../repositories/IPLDNodes.js'
+import { config } from '../../config.js'
+import { stringify } from '@autonomys/auto-utils'
+
+export const ipldNodesController = Router()
+
+ipldNodesController.get('/by-block-height-range', async (req, res, next) => {
+  try {
+    const { fromBlock, toBlock } = req.query
+
+    const parsedFromBlock = parseInt(fromBlock as string)
+    const parsedToBlock = parseInt(toBlock as string)
+
+    if (isNaN(parsedFromBlock) || isNaN(parsedToBlock)) {
+      res
+        .status(400)
+        .json({ error: 'Invalid block height range: not a number' })
+      return
+    }
+
+    if (parsedFromBlock < 0 || parsedToBlock < 0) {
+      res
+        .status(400)
+        .json({ error: 'Invalid block height range: negative values' })
+      return
+    }
+
+    if (parsedFromBlock > parsedToBlock) {
+      res
+        .status(400)
+        .json({ error: 'Invalid block height range: fromBlock > toBlock' })
+      return
+    }
+
+    if (
+      parsedToBlock - parsedFromBlock >
+      config.ipldNodesAPI.maxBlockHeightRange
+    ) {
+      res.status(400).json({ error: 'Block height range is too large' })
+      return
+    }
+
+    try {
+      const objects = await ipldNodesRepository.getDagNodesByBlockHeightRange(
+        parsedFromBlock,
+        parsedToBlock,
+      )
+
+      res
+        .status(200)
+        .set('Content-Type', 'application/json')
+        .send(stringify(objects))
+    } catch (error) {
+      res.status(500).json({
+        error: error instanceof Error ? error.message : 'Internal server error',
+      })
+    }
+  } catch (error) {
+    next(error)
+  }
+})