feat: feature api (#846)

* feat: feature api

* chore: linter changes

* feat: expose features API

* tests(integration): features api tests

* chore: linter changes

* tests(integration): check return format

* chore: linter changes

Author: r4mmer

__tests__/integration/api.test.ts

@@ -0,0 +1,27 @@
+import featureApi, { getBlockFeaturesSchema, getFeaturesSchema } from '../../src/api/featuresApi';
+
+describe('Feature api', () => {
+  it('should be able to call the features api', async () => {
+    await expect(featureApi.getFeatures()).resolves.not.toThrow();
+
+    // Validate response format
+    const response = await featureApi.getFeatures();
+    expect(() => getFeaturesSchema.parse(response)).not.toThrow();
+
+    expect(response.features).toEqual(
+      expect.arrayContaining([
+        expect.objectContaining({
+          name: 'INCREASE_MAX_MERKLE_PATH_LENGTH',
+        }),
+      ])
+    );
+  });
+
+  it('should be able to call the block features api', async () => {
+    const response = await featureApi.getFeatures();
+    await expect(featureApi.getBlockFeatures(response.block_hash)).resolves.not.toThrow();
+    // Validate response format
+    const blockResponse = await featureApi.getBlockFeatures(response.block_hash);
+    expect(() => getBlockFeaturesSchema.parse(blockResponse)).not.toThrow();
+  });
+});

src/api/featuresApi.ts

@@ -0,0 +1,102 @@
+/**
+ * Copyright (c) Hathor Labs and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import { z } from 'zod';
+import { createRequestInstance } from './axiosInstance';
+import { transformJsonBigIntResponse } from '../utils/bigint';
+
+export const featureActivationSchema = z
+  .object({
+    name: z.string(),
+    state: z.string(),
+    acceptance: z.number().nullish(),
+    threshold: z.number(),
+    start_height: z.number(),
+    minimum_activation_height: z.number(),
+    timeout_height: z.number(),
+    lock_in_on_timeout: z.boolean(),
+    version: z.string(),
+  })
+  .passthrough();
+
+export const getFeaturesSchema = z
+  .object({
+    block_hash: z.string(),
+    block_height: z.number().min(0),
+    features: z.array(featureActivationSchema),
+  })
+  .passthrough();
+
+export const errorSchema = z.object({
+  success: z.literal(false),
+  error: z.string(),
+});
+
+export const getBlockFeatureSignalBitSchema = z
+  .object({
+    bit: z.number(),
+    signal: z.number(),
+    feature: z.string(),
+    feature_state: z.string(),
+  })
+  .passthrough();
+
+export const getBlockFeaturesSuccessSchema = z
+  .object({
+    signal_bits: z.array(getBlockFeatureSignalBitSchema),
+  })
+  .passthrough();
+
+export const getBlockFeaturesSchema = z.union([getBlockFeaturesSuccessSchema, errorSchema]);
+
+const featuresApi = {
+  /**
+   * Get feature activation information
+   */
+  async getFeatures(): Promise<z.output<typeof getFeaturesSchema>> {
+    return new Promise((resolve, reject) => {
+      // @ts-expect-error XXX: createRequestInstance resolve argument is not typed correctly
+      createRequestInstance(resolve)
+        .get(`feature`, {
+          transformResponse: res => transformJsonBigIntResponse(res, getFeaturesSchema),
+        })
+        .then(
+          res => {
+            resolve(res.data);
+          },
+          res => {
+            reject(res);
+          }
+        );
+    });
+  },
+
+  /**
+   * Get block features information
+   * @param blockHash Block id encoded as hex
+   */
+  async getBlockFeatures(blockHash: string): Promise<z.output<typeof getBlockFeaturesSchema>> {
+    return new Promise((resolve, reject) => {
+      // @ts-expect-error XXX: createRequestInstance resolve argument is not typed correctly
+      createRequestInstance(resolve)
+        .get(`feature`, {
+          params: { block: blockHash },
+          transformResponse: res => transformJsonBigIntResponse(res, getBlockFeaturesSchema),
+        })
+        .then(
+          res => {
+            resolve(res.data);
+          },
+          res => {
+            reject(res);
+          }
+        );
+    });
+  },
+};
+
+export default featuresApi;

src/lib.ts

@@ -10,6 +10,7 @@ import healthApi from './api/health';
 import versionApi from './api/version';
 import * as axios from './api/axiosInstance';
 import metadataApi from './api/metadataApi';
+import featuresApi from './api/featuresApi';
 import { Storage } from './storage/storage';
 import { MemoryStore } from './storage/memory_store';
 import network from './network';
@@ -70,6 +71,7 @@ export {
   healthApi,
   versionApi,
   metadataApi,
+  featuresApi,
   errors,
   ErrorMessages,
   constants,