Merging AleoNetworkClientOptions into ProgramManagerOptions

Author: Pauan

docs/api_reference/sdk-src_program-manager.md

@@ -13,17 +13,13 @@ The ProgramManager class is used to execute and deploy programs on the Aleo netw
 ## Constructors
 
 
-### `ProgramManager(params)`
+### `ProgramManager(ProgramManagerOptions)`
 
 Create a new instance of the ProgramManager
 
 Parameters | Type | Description
 --- | --- | ---
-__params__ | `Object` | **
-__params.host__ | `string` | *A host uri running the official Aleo API*
-__params.keyProvider__ | `FunctionKeyProvider` | *A key provider that implements {@link FunctionKeyProvider} interface*
-__params.recordProvider__ | `RecordProvider` | *A record provider that implements {@link RecordProvider} interface*
-__params.networkClientOptions__ | `AleoNetworkClientOptions` | **
+__ProgramManagerOptions__ | `Object` | **
 
 ---
 

sdk/src/program-manager.ts

@@ -142,6 +142,15 @@ interface ProvingRequestOptions {
     unchecked?: boolean;
 }
 
+/**
+ * @property { FunctionKeyProvider | undefined } [params.keyProvider] A key provider that implements {@link FunctionKeyProvider} interface
+ * @property { RecordProvider | undefined } [params.recordProvider] A record provider that implements {@link RecordProvider} interface
+ */
+interface ProgramManagerOptions extends AleoNetworkClientOptions {
+    keyProvider?: FunctionKeyProvider | undefined,
+    recordProvider?: RecordProvider | undefined,
+}
+
 /**
  * The ProgramManager class is used to execute and deploy programs on the Aleo network and create value transfers.
  */
@@ -154,25 +163,22 @@ class ProgramManager {
 
     /** Create a new instance of the ProgramManager
      *
-     * @param {Object} [params]
-     * @param { string | undefined } [params.host] A host uri running the official Aleo API
-     * @param { FunctionKeyProvider | undefined } [params.keyProvider] A key provider that implements {@link FunctionKeyProvider} interface
-     * @param { RecordProvider | undefined } [params.recordProvider] A record provider that implements {@link RecordProvider} interface
-     * @param {AleoNetworkClientOptions} [params.networkClientOptions]
+     * @param {Object} ProgramManagerOptions
      */
-    constructor(params: {
-        host?: string | undefined,
-        keyProvider?: FunctionKeyProvider | undefined,
-        recordProvider?: RecordProvider | undefined,
-        networkClientOptions?: Omit<AleoNetworkClientOptions, "host"> | undefined,
-    } = {}) {
-        const { host, keyProvider, recordProvider, networkClientOptions } = params;
-
-        this.host = host ? host : "https://api.explorer.provable.com/v1";
-        this.networkClient = new AleoNetworkClient({ ...networkClientOptions, host: this.host });
-
-        this.keyProvider = keyProvider ? keyProvider : new AleoKeyProvider();
-        this.recordProvider = recordProvider;
+    constructor(params?: ProgramManagerOptions) {
+        if (params == null) {
+            params = {} as ProgramManagerOptions;
+        }
+
+        if (params.host == null) {
+            params.host = "https://api.explorer.provable.com/v1";
+        }
+
+        this.host = params.host;
+        this.networkClient = new AleoNetworkClient(params);
+
+        this.keyProvider = params.keyProvider ? params.keyProvider : new AleoKeyProvider();
+        this.recordProvider = params.recordProvider;
     }
 
     /**

sdk/tests/program-manager.test.ts

@@ -44,7 +44,7 @@ describe('Program Manager', () => {
         it('should have the specified headers when instantiated', async () => {
             const newProgramManager = new ProgramManager({
                 host: "https://api.explorer.provable.com/v1",
-                networkClientOptions: { headers: {'X-Test-Header': 'programManager'} },
+                headers: {'X-Test-Header': 'programManager'},
             });
             expect(Object.keys(newProgramManager.networkClient.headers).length).equal(1);
             expect(newProgramManager.networkClient.headers['X-Test-Header']).equal('programManager');