[Feature] Add setHeader and removeHeader methods for the AleoNetworkClient (#1026)

* added setHeader and removeHeader methods for the AleoNetworkClient

* added option to include AleoNetworkClientOptions in ProgramManager constructor as well as setHeader and removeHeader methods

Author: alexpitsikoulis

sdk/src/network-client.ts

@@ -37,7 +37,7 @@ class AleoNetworkClient {
     headers: { [key: string]: string };
     account: Account | undefined;
 
-    constructor(host: string, options?: AleoNetworkClientOptions) {
+    constructor(host: string, options?: AleoNetworkClientOptions | undefined) {
         this.host = host + "/%%NETWORK%%";
 
         if (options && options.headers) {
@@ -94,6 +94,43 @@ class AleoNetworkClient {
         this.host = host + "/%%NETWORK%%";
     }
 
+    /**
+     * Set a header in the `AleoNetworkClient`s header map
+     * 
+     * @param {string} headerName The name of the header to set
+     * @param {string} value The header value
+     * 
+     * @example
+     * import { AleoNetworkClient } from "@provablehq/sdk/mainnet.js";
+     * 
+     * // Create a networkClient
+     * const networkClient = new AleoNetworkClient();
+     * 
+     * // Set the value of the `Accept-Language` header to `en-US`
+     * networkClient.setHeader('Accept-Language', 'en-US');
+     */
+    setHeader(headerName: string, value: string) {
+        this.headers[headerName] = value;
+    }
+
+    /**
+     * Remove a header from the `AleoNetworkClient`s header map
+     * 
+     * @param {string} headerName The name of the header to be removed
+     * 
+     * @example
+     * import { AleoNetworkClient } from "@provablehq/sdk/mainnet.js";
+     * 
+     * // Create a networkClient
+     * const networkClient = new AleoNetworkClient();
+     * 
+     * // Remove the default `X-Aleo-SDK-Version` header
+     * networkClient.removeHeader('X-Aleo-SDK-Version');
+     */
+    removeHeader(headerName: string) {
+        delete this.headers[headerName]
+    }
+
     /**
      * Fetches data from the Aleo network and returns it as a JSON object.
      *

sdk/src/program-manager.ts

@@ -1,5 +1,5 @@
 import { Account } from "./account";
-import { AleoNetworkClient, ProgramImports } from "./network-client";
+import { AleoNetworkClient, AleoNetworkClientOptions, ProgramImports } from "./network-client";
 
 import { RecordProvider, RecordSearchParams } from "./record-provider";
 
@@ -90,9 +90,10 @@ class ProgramManager {
         host?: string | undefined,
         keyProvider?: FunctionKeyProvider | undefined,
         recordProvider?: RecordProvider | undefined,
+        networkClientOptions?: AleoNetworkClientOptions | undefined,
     ) {
         this.host = host ? host : "https://api.explorer.provable.com/v1";
-        this.networkClient = new AleoNetworkClient(this.host);
+        this.networkClient = new AleoNetworkClient(this.host, networkClientOptions);
 
         this.keyProvider = keyProvider ? keyProvider : new AleoKeyProvider();
         this.recordProvider = recordProvider;
@@ -148,6 +149,43 @@ class ProgramManager {
         this.recordProvider = recordProvider;
     }
 
+    /**
+     * Set a header in the `AleoNetworkClient`s header map
+     * 
+     * @param {string} headerName The name of the header to set
+     * @param {string} value The header value
+     * 
+     * @example
+     * import { ProgramManager } from "@provablehq/sdk/mainnet.js";
+     * 
+     * // Create a ProgramManager
+     * const programManager = new ProgramManager("https://api.explorer.provable.com/v1");
+     * 
+     * // Set the value of the `Accept-Language` header to `en-US`
+     * programManager.setHeader('Accept-Language', 'en-US');
+     */
+    setHeader(headerName: string, value: string) {
+        this.networkClient.headers[headerName] = value;
+    }
+
+    /**
+     * Remove a header from the `AleoNetworkClient`s header map
+     * 
+     * @param {string} headerName The name of the header to be removed
+     * 
+     * @example
+     * import { ProgramManager } from "@provablehq/sdk/mainnet.js";
+     * 
+     * // Create a ProgramManager
+     * const programManager = new ProgramManager("https://api.explorer.provable.com/v1");
+     * 
+     * // Remove the default `X-Aleo-SDK-Version` header
+     * programManager.removeHeader('X-Aleo-SDK-Version');
+     */
+    removeHeader(headerName: string) {
+        delete this.networkClient.headers[headerName]
+    }
+
     /**
      * Builds a deployment transaction for submission to the Aleo network.
      *

sdk/tests/network-client.test.ts

@@ -214,6 +214,25 @@ describe("NodeConnection", () => {
         });
     });
 
+    describe("setHeader", () => {
+        it("should correctly update the headers map", async () => {
+            connection.setHeader('X-Test-Header', 'testvalue');
+            expect(connection.headers['X-Test-Header']).equal('testvalue');
+        })
+
+        it("should update existing header in map", async () => {
+            connection.setHeader('X-Test-Header', 'secondtestvalue');
+            expect(connection.headers['X-Test-Header']).equal('secondtestvalue');
+        })
+    })
+
+    describe("removeHeader", () => {
+        it("should remove header from the map", async () => {
+            connection.removeHeader('X-Test-Header');
+            expect(connection.headers['X-Test-Header']).undefined;
+        })
+    })
+
     describe("waitForTransactionConfirmation", () => {
         const mainnetAcceptedTx =
             "at1dl9lze8wscct0dee8x9tjnfmpjvj33hh23jcnp5f0ywjn5552yrsperzl9";

sdk/tests/program-manager.test.ts

@@ -10,9 +10,30 @@ import {
 import { Account, ExecutionResponse, OfflineQuery, ProgramManager, RecordPlaintext } from "../src/node";
 
 describe('Program Manager', () => {
-    const programManager = new ProgramManager("https://api.explorer.provable.com/v1", undefined, undefined);
+    const programManager = new ProgramManager("https://api.explorer.provable.com/v1");
     programManager.setAccount(new Account({privateKey: statePathRecordOwnerPrivateKey}));
 
+    describe('Instantiate with AleoNetworkClientOptions', () => {
+        it('should have the specified headers when instantiated', async () => {
+            const newProgramManager = new ProgramManager("https://api.explorer.provable.com/v1", undefined, undefined, { headers: {'X-Test-Header': 'programManager'} });
+            expect(Object.keys(newProgramManager.networkClient.headers).length).equal(1);
+            expect(newProgramManager.networkClient.headers['X-Test-Header']).equal('programManager');
+            expect(newProgramManager.networkClient.headers['X-Aleo-SDK-Version']).undefined;
+        })
+    });
+
+    describe('networkClient header methods', () => {
+        it('should correctly udpdate the networkClient headers map', async () => {
+            programManager.setHeader('X-Added-Header', 'programManager');
+            expect(programManager.networkClient.headers['X-Added-Header']).equal('programManager');
+        })
+
+        it('should remove header from the networkClient headers map', async () => {
+            programManager.removeHeader('X-Added-Header');
+            expect(programManager.networkClient.headers['X-Added-Header']).undefined;
+        })
+    })
+
     describe('Execute offline', () => {
         it.skip('Program manager should execute offline and verify the resulting proof correctly', async () => {
             const execution_result = <ExecutionResponse>await programManager.run(helloProgram, "hello", ["5u32", "5u32"], true, undefined, undefined, undefined, undefined, undefined, undefined)