Update documentation to include full description of parameters

Author: iamalwaysuncomfortable

docs/api_reference/sdk-src_network-client.md

@@ -110,30 +110,6 @@ networkClient.setHeader('Accept-Language', 'en-US');
 
 ---
 
-### `removeHeader(headerName)`
-
-![modifier: public](images/badges/modifier-public.svg)
-
-Remove a header from the `AleoNetworkClient`s header map
-
-Parameters | Type | Description
---- | --- | ---
-__headerName__ | `string` | *The name of the header to be removed*
-
-#### Examples
-
-```javascript
-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');
-```
-
----
-
 ### `fetchData(url)`
 
 ![modifier: public](images/badges/modifier-public.svg)
@@ -1146,30 +1122,6 @@ networkClient.setHeader('Accept-Language', 'en-US');
 
 ---
 
-### `removeHeader(headerName)`
-
-![modifier: public](images/badges/modifier-public.svg)
-
-Remove a header from the `AleoNetworkClient`s header map
-
-Parameters | Type | Description
---- | --- | ---
-__headerName__ | `string` | *The name of the header to be removed*
-
-#### Examples
-
-```javascript
-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');
-```
-
----
-
 ### `fetchData(url) ► Promise.<Type>`
 
 ![modifier: public](images/badges/modifier-public.svg)

docs/api_reference/sdk-src_program-manager.md

@@ -108,30 +108,6 @@ programManager.setHeader('Accept-Language', 'en-US');
 
 ---
 
-### `removeHeader(headerName)`
-
-![modifier: public](images/badges/modifier-public.svg)
-
-Remove a header from the `AleoNetworkClient`s header map
-
-Parameters | Type | Description
---- | --- | ---
-__headerName__ | `string` | *The name of the header to be removed*
-
-#### Examples
-
-```javascript
-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');
-```
-
----
-
 ### `buildDeploymentTransaction(program, priorityFee, privateFee, recordSearchParams, feeRecord, privateKey) ► string`
 
 ![modifier: public](images/badges/modifier-public.svg)
@@ -1357,30 +1333,6 @@ programManager.setHeader('Accept-Language', 'en-US');
 
 ---
 
-### `removeHeader(headerName)`
-
-![modifier: public](images/badges/modifier-public.svg)
-
-Remove a header from the `AleoNetworkClient`s header map
-
-Parameters | Type | Description
---- | --- | ---
-__headerName__ | `string` | *The name of the header to be removed*
-
-#### Examples
-
-```javascript
-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');
-```
-
----
-
 ### `buildDeploymentTransaction(program, priorityFee, privateFee, recordSearchParams, feeRecord, privateKey) ► string`
 
 ![modifier: public](images/badges/modifier-public.svg)

docs/api_reference/sdk-src_wasm.md

@@ -216,7 +216,7 @@ Create a new authorization from a request object.
 
 Parameters | Type | Description
 --- | --- | ---
-__request__ | `ExecutionRequest` | **
+__request__ | `ExecutionRequest` | *The ExecutionRequest to build the authorization from.*
 __*return*__ | [Authorization](sdk-src_wasm.md) | **
 
 ---
@@ -253,7 +253,7 @@ Reconstructs an Authorization object from its string representation.
 
 Parameters | Type | Description
 --- | --- | ---
-__authorization__ | `string` | **
+__authorization__ | `String` | *The string representation of the Authorization.*
 __*return*__ | [Authorization](sdk-src_wasm.md) | **
 
 ---
@@ -278,7 +278,7 @@ Creates an authorization object from a left-endian byte representation of an Aut
 
 Parameters | Type | Description
 --- | --- | ---
-__bytes__ | `Uint8Array` | **
+__bytes__ | `Uint8Array` | *Left-endian bytes representing the Authorization.*
 __*return*__ | [Authorization](sdk-src_wasm.md) | **
 
 ---
@@ -291,7 +291,7 @@ Check if an Authorization object is the same as another.
 
 Parameters | Type | Description
 --- | --- | ---
-__other__ | [Authorization](sdk-src_wasm.md) | **
+__other__ | [Authorization](sdk-src_wasm.md) | *The Authorization object to determine equality with.*
 __*return*__ | `boolean` | **
 
 ---
@@ -364,7 +364,7 @@ Insert a transition into the Authorization.
 
 Parameters | Type | Description
 --- | --- | ---
-__transition__ | `Transition` | **
+__transition__ | `Transition` | *The transition object to insert into the Authorization.*
 __*return*__ | `void` | **
 
 ---
@@ -2432,13 +2432,13 @@ Represents a proving request to a delegated proving service.
 
 ![modifier: public](images/badges/modifier-public.svg) ![modifier: static](images/badges/modifier-static.svg)
 
-Creates a new ProvingRequest from a function authorization and an optional fee authorization.
+Creates a new ProvingRequest from a function Authorization and an optional fee Authorization.
 
 Parameters | Type | Description
 --- | --- | ---
-__authorization__ | [Authorization](sdk-src_wasm.md) | **
-__fee_authorization__ | [Authorization](sdk-src_wasm.md) | **
-__broadcast__ | `boolean` | **
+__authorization__ | [Authorization](sdk-src_wasm.md) | *An Authorization for a function.*
+__fee_authorization__ | [Authorization](sdk-src_wasm.md) | *The authorization for the `credits.aleo/fee_public` or `credits.aleo/fee_private` function that pays the fee for the execution of the main function.*
+__broadcast__ | `boolean` | *Flag that indicates whether the remote proving service should attempt to submit the transaction on the caller's behalf.*
 __*return*__ | [ProvingRequest](sdk-src_wasm.md) | **
 
 ---
@@ -2451,7 +2451,7 @@ Creates a ProvingRequest from a string representation.
 
 Parameters | Type | Description
 --- | --- | ---
-__request__ | `string` | **
+__request__ | `Uint8Array` | *String representation of the ProvingRequest.*
 __*return*__ | [ProvingRequest](sdk-src_wasm.md) | **
 
 ---
@@ -2472,11 +2472,11 @@ __*return*__ | `string` | **
 
 ![modifier: public](images/badges/modifier-public.svg) ![modifier: static](images/badges/modifier-static.svg)
 
-Creates a ProvingRequest from a left-endian byte representation of the proving request.
+Creates a ProvingRequest from a left-endian byte representation of the ProvingRequest.
 
 Parameters | Type | Description
 --- | --- | ---
-__bytes__ | `Uint8Array` | **
+__bytes__ | `Uint8Array` | *Left-endian bytes representing the proving request.*
 __*return*__ | [ProvingRequest](sdk-src_wasm.md) | **
 
 ---
@@ -2497,7 +2497,7 @@ __*return*__ | `Uint8Array` | **
 
 ![modifier: public](images/badges/modifier-public.svg)
 
-Get the main authorization for the request.
+Get the Authorization of the main function in the ProvingRequest.
 
 Parameters | Type | Description
 --- | --- | ---
@@ -2509,7 +2509,7 @@ __*return*__ | [Authorization](sdk-src_wasm.md) | **
 
 ![modifier: public](images/badges/modifier-public.svg)
 
-Get the fee authorization for the request.
+Get the fee Authorization in the ProvingRequest.
 
 Parameters | Type | Description
 --- | --- | ---
@@ -2521,7 +2521,7 @@ __*return*__ | [Authorization](sdk-src_wasm.md) | **
 
 ![modifier: public](images/badges/modifier-public.svg)
 
-Get the broadcast flag for the request.
+Get the broadcast flag set in the ProvingRequest.
 
 Parameters | Type | Description
 --- | --- | ---

sdk/src/network-client.ts

@@ -120,20 +120,6 @@ class AleoNetworkClient {
         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];
     }

sdk/src/program-manager.ts

@@ -239,20 +239,6 @@ class ProgramManager {
         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]
     }

wasm/src/synthesizer/authorization.rs

@@ -37,6 +37,8 @@ pub struct Authorization(AuthorizationNative);
 #[wasm_bindgen]
 impl Authorization {
     /// Create a new authorization from a request object.
+    ///
+    /// @param {ExecutionRequest} request The ExecutionRequest to build the authorization from.
     pub fn new(request: ExecutionRequest) -> Result<Authorization, JsValue> {
         Ok(Authorization(AuthorizationNative::new(RequestNative::from(request))))
     }
@@ -54,6 +56,8 @@ impl Authorization {
     }
 
     /// Reconstructs an Authorization object from its string representation.
+    ///
+    /// @param {String} authorization The string representation of the Authorization.
     #[wasm_bindgen(js_name = "fromString")]
     pub fn from_string(authorization: String) -> Result<Authorization, String> {
         Ok(Authorization(AuthorizationNative::from_str(&authorization).map_err(|e| e.to_string())?))
@@ -67,6 +71,8 @@ impl Authorization {
     }
 
     /// Creates an authorization object from a left-endian byte representation of an Authorization.
+    ///
+    /// @param {Uint8Array} bytes Left-endian bytes representing the Authorization.
     #[wasm_bindgen(js_name = "fromBytesLe")]
     pub fn from_bytes_le(bytes: Uint8Array) -> Result<Authorization, String> {
         let rust_bytes = bytes.to_vec();
@@ -75,6 +81,8 @@ impl Authorization {
     }
 
     /// Check if an Authorization object is the same as another.
+    ///
+    /// @param {Authorization} other The Authorization object to determine equality with.
     pub fn equals(&self, other: &Authorization) -> bool {
         self == other
     }
@@ -115,6 +123,8 @@ impl Authorization {
 #[wasm_bindgen]
 impl Authorization {
     /// Insert a transition into the Authorization.
+    ///
+    /// @param {Transition} transition The transition object to insert into the Authorization.
     #[wasm_bindgen(js_name = insertTransition)]
     pub fn insert_transition(&self, transition: Transition) -> Result<(), String> {
         let transition = <TransitionNative as From<Transition>>::from(transition);

wasm/src/synthesizer/proving_request.rs

@@ -34,12 +34,18 @@ pub struct ProvingRequest(ProvingRequestNative);
 
 #[wasm_bindgen]
 impl ProvingRequest {
-    /// Creates a new ProvingRequest from a function authorization and an optional fee authorization.
+    /// Creates a new ProvingRequest from a function Authorization and an optional fee Authorization.
+    ///
+    /// @param {Authorization} authorization An Authorization for a function.
+    /// @param {Authorization} fee_authorization The authorization for the `credits.aleo/fee_public` or `credits.aleo/fee_private` function that pays the fee for the execution of the main function.
+    /// @param {boolean} broadcast Flag that indicates whether the remote proving service should attempt to submit the transaction on the caller's behalf.
     pub fn new(authorization: Authorization, fee_authorization: Option<Authorization>, broadcast: bool) -> Self {
         ProvingRequest(ProvingRequestNative::new(authorization, fee_authorization, broadcast))
     }
 
     /// Creates a ProvingRequest from a string representation.
+    ///
+    /// @param {Uint8Array} request String representation of the ProvingRequest.
     #[wasm_bindgen(js_name = "fromString")]
     pub fn from_string(request: String) -> Result<ProvingRequest, String> {
         Ok(ProvingRequest(ProvingRequestNative::from_str(&request).map_err(|e| e.to_string())?))
@@ -52,7 +58,9 @@ impl ProvingRequest {
         self.0.to_string()
     }
 
-    /// Creates a ProvingRequest from a left-endian byte representation of the proving request.
+    /// Creates a ProvingRequest from a left-endian byte representation of the ProvingRequest.
+    ///
+    /// @param {Uint8Array} bytes Left-endian bytes representing the proving request.
     #[wasm_bindgen(js_name = "fromBytesLe")]
     pub fn from_bytes_le(bytes: Uint8Array) -> Result<ProvingRequest, String> {
         let rust_bytes = bytes.to_vec();
@@ -67,18 +75,18 @@ impl ProvingRequest {
         Ok(Uint8Array::from(bytes.as_slice()))
     }
 
-    /// Get the main authorization for the request.
+    /// Get the Authorization of the main function in the ProvingRequest.
     pub fn authorization(&self) -> Authorization {
         Authorization::from(self.0.authorization())
     }
 
-    /// Get the fee authorization for the request.
+    /// Get the fee Authorization in the ProvingRequest.
     #[wasm_bindgen(js_name = "feeAuthorization")]
     pub fn fee_authorization(&self) -> Option<Authorization> {
         self.0.fee_authorization().map(Authorization::from)
     }
 
-    /// Get the broadcast flag for the request.
+    /// Get the broadcast flag set in the ProvingRequest.
     pub fn broadcast(&self) -> bool {
         self.0.broadcast()
     }