Validator can accept api key

tablelandnetwork · Aug 21, 2023 · 46cd2d4 · 46cd2d4
1 parent 1c39536
commit 46cd2d4
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 4 deletions.
diff --git a/packages/sdk/src/helpers/config.ts b/packages/sdk/src/helpers/config.ts
@@ -6,6 +6,7 @@ import { type Signer, type ExternalProvider, getSigner } from "./ethers.js";
 export interface ReadConfig {
   baseUrl: string;
   aliases?: AliasesNameMap;
+  apiKey?: string;
 }
 
 export interface SignerConfig {

diff --git a/packages/sdk/src/validator/index.ts b/packages/sdk/src/validator/index.ts
@@ -21,6 +21,7 @@ import {
   type TransactionReceipt,
   type Params as ReceiptParams,
 } from "./receipt.js";
+import { type FetchConfig } from "./client/index.js";
 
 export { ApiError } from "./client/index.js";
 export {
@@ -65,7 +66,7 @@ export class Validator {
    * @description Returns OK if the validator considers itself healthy
    */
   async health(opts: Signal = {}): Promise<boolean> {
-    return await getHealth(this.config, opts);
+    return await getHealth(prepReadConfig(this.config), opts);
   }
 
   /**
@@ -131,3 +132,16 @@ export class Validator {
     return await pollTransactionReceipt(this.config, params, opts);
   }
 }
+
+function prepReadConfig(config: Partial<ReadConfig>): FetchConfig {
+  const conf: FetchConfig = {};
+  if (config.apiKey) {
+    conf.init = {
+      headers: {
+        "Api-Key": config.apiKey
+      }
+    };
+  }
+
+  return { ...config, ...conf };
+}
diff --git a/packages/sdk/test/validator.test.ts b/packages/sdk/test/validator.test.ts
@@ -453,11 +453,15 @@ describe("validator", function () {
     });
 
     test("when valid api key is used there is no exeption", async function () {
-      const api = new Validator({ baseUrl });
+      const apiKey = "foo";
+      const api = new Validator({
+        baseUrl,
+        apiKey,
+      });
       const responses = await Promise.all(getRange(15).map(async () => await api.health()));
 
       equal(responses.length, 15);
-      console.log(JSON.stringify(responses));
+      equal(responses.every((r: unknown) => r === true), true);
     });
   });
 });
diff --git a/packages/sdk/test/validator/config.json b/packages/sdk/test/validator/config.json
@@ -3,7 +3,8 @@
   "HTTP": {
     "Port": "8081",
     "RateLimInterval": "1s",
-    "MaxRequestPerInterval": 10
+    "MaxRequestPerInterval": 10,
+    "APIKey": "foo"
   },
   "Gateway": {
     "ExternalURIPrefix": "http://localhost:8081",