fix: rename by-block-time endpoint

Author: rafa-stacks

client/src/generated/schema.d.ts

@@ -1228,18 +1228,18 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/extended/v2/blocks/at-time/{timestamp}": {
+    "/extended/v2/blocks/by-block-time/{timestamp}": {
         parameters: {
             query?: never;
             header?: never;
             path?: never;
             cookie?: never;
         };
         /**
-         * Get block at time
+         * Get block by block time
          * @description Retrieves the most recent block mined at or before a given Unix timestamp (in seconds)
          */
-        get: operations["get_block_at_time"];
+        get: operations["get_block_by_block_time"];
         put?: never;
         post?: never;
         delete?: never;
@@ -27582,7 +27582,7 @@ export interface operations {
             };
         };
     };
-    get_block_at_time: {
+    get_block_by_block_time: {
         parameters: {
             query?: never;
             header?: never;

openapi.yaml

@@ -80517,10 +80517,10 @@ paths:
                     type: string
                   message:
                     type: string
-  /extended/v2/blocks/at-time/{timestamp}:
+  /extended/v2/blocks/by-block-time/{timestamp}:
     get:
-      operationId: get_block_at_time
-      summary: Get block at time
+      operationId: get_block_by_block_time
+      summary: Get block by block time
       tags:
         - Blocks
       description: Retrieves the most recent block mined at or before a given Unix

src/api/routes/v2/blocks.ts

@@ -110,12 +110,12 @@ export const BlockRoutesV2: FastifyPluginAsync<
   );
 
   fastify.get(
-    '/at-time/:timestamp',
+    '/by-block-time/:timestamp',
     {
       preHandler: handleBlockCache,
       schema: {
-        operationId: 'get_block_at_time',
-        summary: 'Get block at time',
+        operationId: 'get_block_by_block_time',
+        summary: 'Get block by block time',
         description: `Retrieves the most recent block mined at or before a given Unix timestamp (in seconds)`,
         tags: ['Blocks'],
         params: BlockTimestampParamsSchema,

tests/api/blocks/block.test.ts

@@ -1270,33 +1270,33 @@ describe('block tests', () => {
     }
 
     // Query with timestamp between block 2 and block 3 => should return block 2
-    const res1 = await supertest(api.server).get(`/extended/v2/blocks/at-time/2500`);
+    const res1 = await supertest(api.server).get(`/extended/v2/blocks/by-block-time/2500`);
     assert.equal(res1.status, 200);
     assert.equal(res1.body.height, 2);
     assert.equal(res1.body.block_time, 2000);
     assert.equal(res1.body.hash, '0x2222222222222222222222222222222222222222222222222222222222222222');
 
     // Exact match: query with timestamp equal to block 3 => should return block 3
-    const res2 = await supertest(api.server).get(`/extended/v2/blocks/at-time/3000`);
+    const res2 = await supertest(api.server).get(`/extended/v2/blocks/by-block-time/3000`);
     assert.equal(res2.status, 200);
     assert.equal(res2.body.height, 3);
     assert.equal(res2.body.block_time, 3000);
 
     // Query with timestamp before all blocks => should return 404
-    const res3 = await supertest(api.server).get(`/extended/v2/blocks/at-time/500`);
+    const res3 = await supertest(api.server).get(`/extended/v2/blocks/by-block-time/500`);
     assert.equal(res3.status, 404);
 
     // Query with very large timestamp => should return most recent block
-    const res4 = await supertest(api.server).get(`/extended/v2/blocks/at-time/999999999`);
+    const res4 = await supertest(api.server).get(`/extended/v2/blocks/by-block-time/999999999`);
     assert.equal(res4.status, 200);
     assert.equal(res4.body.height, 3);
 
     // Invalid timestamp (negative) => should return 400
-    const res5 = await supertest(api.server).get(`/extended/v2/blocks/at-time/-1`);
+    const res5 = await supertest(api.server).get(`/extended/v2/blocks/by-block-time/-1`);
     assert.equal(res5.status, 400);
 
     // Invalid timestamp (non-numeric) => should return 400
-    const res6 = await supertest(api.server).get(`/extended/v2/blocks/at-time/abc`);
+    const res6 = await supertest(api.server).get(`/extended/v2/blocks/by-block-time/abc`);
     assert.equal(res6.status, 400);
   });
 });

tests/api/cache/cache-control.test.ts

@@ -1006,7 +1006,7 @@ describe('cache-control tests', () => {
     assert.equal(request7.text, '');
   });
 
-  test('block at-time cache control', async () => {
+  test('block by-block-time cache control', async () => {
     const blockTime1 = 1700000000;
     const blockTime2 = 1700001000;
 
@@ -1031,7 +1031,7 @@ describe('cache-control tests', () => {
 
     // Valid ETag for timestamp query.
     const request1 = await supertest(api.server).get(
-      `/extended/v2/blocks/at-time/${blockTime2}`
+      `/extended/v2/blocks/by-block-time/${blockTime2}`
     );
     assert.equal(request1.status, 200);
     assert.equal(request1.type, 'application/json');
@@ -1041,21 +1041,21 @@ describe('cache-control tests', () => {
 
     // Cache works with valid ETag.
     const request2 = await supertest(api.server)
-      .get(`/extended/v2/blocks/at-time/${blockTime2}`)
+      .get(`/extended/v2/blocks/by-block-time/${blockTime2}`)
       .set('If-None-Match', etag0);
     assert.equal(request2.status, 304);
     assert.equal(request2.text, '');
 
     // Cache miss with wrong ETag.
     const request3 = await supertest(api.server)
-      .get(`/extended/v2/blocks/at-time/${blockTime2}`)
+      .get(`/extended/v2/blocks/by-block-time/${blockTime2}`)
       .set('If-None-Match', '"0x12345678"');
     assert.equal(request3.status, 200);
     assert.equal(request3.headers['etag'], etag0);
 
     // Timestamp between blocks returns earlier block with different ETag.
     const request4 = await supertest(api.server).get(
-      `/extended/v2/blocks/at-time/${blockTime1 + 500}`
+      `/extended/v2/blocks/by-block-time/${blockTime1 + 500}`
     );
     assert.equal(request4.status, 200);
     assert.equal(request4.body.height, 1);
@@ -1064,7 +1064,7 @@ describe('cache-control tests', () => {
 
     // Cache works for earlier block timestamp.
     const request5 = await supertest(api.server)
-      .get(`/extended/v2/blocks/at-time/${blockTime1 + 500}`)
+      .get(`/extended/v2/blocks/by-block-time/${blockTime1 + 500}`)
       .set('If-None-Match', etag1);
     assert.equal(request5.status, 304);
     assert.equal(request5.text, '');
@@ -1091,15 +1091,15 @@ describe('cache-control tests', () => {
 
     // Old ETag is now a miss after re-org.
     const request6 = await supertest(api.server)
-      .get(`/extended/v2/blocks/at-time/${blockTime2}`)
+      .get(`/extended/v2/blocks/by-block-time/${blockTime2}`)
       .set('If-None-Match', etag0);
     assert.equal(request6.status, 200);
     assert.notEqual(request6.headers['etag'], etag0);
     const etag2 = request6.headers['etag'];
 
     // Cache works with new ETag.
     const request7 = await supertest(api.server)
-      .get(`/extended/v2/blocks/at-time/${blockTime2}`)
+      .get(`/extended/v2/blocks/by-block-time/${blockTime2}`)
       .set('If-None-Match', etag2);
     assert.equal(request7.status, 304);
     assert.equal(request7.text, '');