Add method for fetching smart transactions API liveness (#9)

* feat: add stx liveness request

* feat: add smart transactions liveness fetch call

* chore: clean up prettier issue

* chore: move liveness definition to controller

* chore: add unit tests for fetchLiveness

* chore: rename successLivenessApiResponse variable in tests

Author: meppsilon

src/SmartTransactionsController.test.ts

@@ -132,6 +132,10 @@ const createSuccessBatchStatusApiResponse = () => {
   ];
 };
 
+const createSuccessLivenessApiResponse = () => ({
+  lastBlock: 123456,
+});
+
 const ethereumChainIdDec = CHAIN_IDS_HEX_TO_DEC[CHAIN_IDS.ETHEREUM];
 
 describe('SmartTransactionsController', () => {
@@ -320,4 +324,15 @@ describe('SmartTransactionsController', () => {
       });
     });
   });
+
+  describe('fetchLiveness', () => {
+    it('fetches a liveness for Smart Transactions API', async () => {
+      const successLivenessApiResponse = createSuccessLivenessApiResponse();
+      nock(API_BASE_URL)
+        .get(`/networks/${ethereumChainIdDec}/health`)
+        .reply(200, successLivenessApiResponse);
+      const liveness = await smartTransactionsController.fetchLiveness();
+      expect(liveness).toBe(true);
+    });
+  });
 });

src/SmartTransactionsController.ts

@@ -275,4 +275,12 @@ export default class SmartTransactionsController extends BaseController<
       body: JSON.stringify({ uuid }),
     });
   }
+
+  async fetchLiveness(): Promise<boolean> {
+    const { chainId } = this.config;
+    const response = await this.fetch(
+      getAPIRequestURL(APIType.LIVENESS, chainId),
+    );
+    return Boolean(response.lastBlock);
+  }
 }

src/utils.test.ts

@@ -66,14 +66,14 @@ describe('src/utils.js', () => {
 
     it('returns a URL for smart transactions API liveness', () => {
       expect(utils.getAPIRequestURL(APIType.LIVENESS, CHAIN_IDS.ETHEREUM)).toBe(
-        `${API_BASE_URL}/networks/${ethereumChainIdDec}/liveness`,
+        `${API_BASE_URL}/networks/${ethereumChainIdDec}/health`,
       );
     });
 
     it('returns a URL for smart transactions API liveness for the BSC chainId', () => {
       const bscChainIdDec = CHAIN_IDS_HEX_TO_DEC[CHAIN_IDS.BSC];
       expect(utils.getAPIRequestURL(APIType.LIVENESS, CHAIN_IDS.BSC)).toBe(
-        `${API_BASE_URL}/networks/${bscChainIdDec}/liveness`,
+        `${API_BASE_URL}/networks/${bscChainIdDec}/health`,
       );
     });
   });

src/utils.ts

@@ -30,7 +30,7 @@ export function getAPIRequestURL(apiType: APIType, chainId: string): string {
     }
 
     case APIType.LIVENESS: {
-      return `${API_BASE_URL}/networks/${chainIdDec}/liveness`;
+      return `${API_BASE_URL}/networks/${chainIdDec}/health`;
     }
 
     default: {