chore: cleaning up docblocks

Author: tegefaulkes

src/nodes/NodeManager.ts

@@ -1545,6 +1545,15 @@ class NodeManager<Manifest extends AgentClientManifestNodeManager> {
     });
   }
 
+  /**
+   * Creates a claim on the sigchain granting this node authority over a network to create `ClaimNetworkAccess` claims.
+   *
+   * @param networkNodeId - The public key NodeId for the root authority for the network
+   * @param network - The network URL.
+   * @param isPrivate - Indicates if the network is private or not.
+   * @param signingHook - A callback used to sign the claim with the network's private key.
+   * @param tran
+   */
   public async createClaimNetworkAuthority(
     networkNodeId: NodeId,
     network: string,
@@ -1618,7 +1627,7 @@ class NodeManager<Manifest extends AgentClientManifestNodeManager> {
   }
 
   /**
-   * This takes a ClaimNetworkAuthority and tracks it in the database under the network name.
+   * This takes a `ClaimNetworkAuthority` and tracks it in the database under the network name.
    */
   protected async setClaimNetworkAuthority(
     claimNetworkAuthority: Token<ClaimNetworkAuthority>,
@@ -1638,6 +1647,9 @@ class NodeManager<Manifest extends AgentClientManifestNodeManager> {
     );
   }
 
+  /**
+   * This returns the `ClaimNetworkAuthority` for the given network.
+   */
   protected async getClaimNetworkAuthority(
     network: string,
     tran?: DBTransaction,
@@ -1664,7 +1676,7 @@ class NodeManager<Manifest extends AgentClientManifestNodeManager> {
   }
 
   /**
-   * This takes a ClaimNetworkAccess and tracks it in the database under the network name.
+   * This takes a `ClaimNetworkAccess` and tracks it in the database under the network name.
    */
   protected async setClaimNetworkAccess(
     claimNetworkAccess: Token<ClaimNetworkAccess>,
@@ -1684,6 +1696,9 @@ class NodeManager<Manifest extends AgentClientManifestNodeManager> {
     );
   }
 
+  /**
+   * This returns the `ClaimNetworkAccess` for the given network.
+   */
   protected async getClaimNetworkAccess(
     network: string,
     tran?: DBTransaction,
@@ -1709,8 +1724,16 @@ class NodeManager<Manifest extends AgentClientManifestNodeManager> {
     return token as Token<ClaimNetworkAccess>;
   }
 
+  /**
+   * This switches out the active `ClaimNetworkAuthority` and `ClaimNetworkAccess` for the desired network.
+   * If no claims exist for the network or no network is provided, then it switches to using no network.
+   * In doing so this also updates the `NodeConnectionManager`'s authentication callbacks to use the selected
+   * network for authentication.
+   * @param network - The Network URL for the desired network to switch to.
+   * @param tran
+   */
   public async switchNetwork(
-    network: string,
+    network?: string,
     tran?: DBTransaction,
   ): Promise<void> {
     if (tran == null) {
@@ -1719,6 +1742,19 @@ class NodeManager<Manifest extends AgentClientManifestNodeManager> {
       );
     }
 
+    if (network == null) {
+      this.claimNetworkAuthority = undefined;
+      this.claimNetworkAccess = undefined;
+      // Use the basic no network behavior
+      this.nodeConnectionManager.setAuthenticateNetworkForwardCallback(
+        nodesUtils.nodesAuthenticateConnectionForwardDefault,
+      );
+      this.nodeConnectionManager.setAuthenticateNetworkReverseCallback(
+        nodesUtils.nodesAuthenticateConnectionReverseDeny,
+      );
+      return;
+    }
+
     this.claimNetworkAuthority = await this.getClaimNetworkAuthority(
       network,
       tran,
@@ -1737,7 +1773,7 @@ class NodeManager<Manifest extends AgentClientManifestNodeManager> {
         ),
       );
     } else {
-      // Use the basic public behavior
+      // Use the basic no network behavior
       this.nodeConnectionManager.setAuthenticateNetworkForwardCallback(
         nodesUtils.nodesAuthenticateConnectionForwardDefault,
       );
@@ -1747,12 +1783,25 @@ class NodeManager<Manifest extends AgentClientManifestNodeManager> {
     }
   }
 
+  /**
+   * Quick hand utility for checking if the active `ClaimNetworkAuthority` is a private network
+   */
   public isClaimNetworkAuthorityPrivate(): boolean | undefined {
     // Return undefined if we're not acting as a network authority
     if (this.claimNetworkAuthority == null) return;
     return this.claimNetworkAuthority.payload.isPrivate;
   }
 
+  /**
+   * This creates a cross-signed `ClaimNetworkAccess` on the sigchain. The resulting `ClaimNetworkAccess` is used to
+   * authenticate connections between nodes within the network.
+   *
+   * @param targetNodeId - This is a node with an active `ClaimNetworkAuthority` for the network you wish to join.
+   * This usually is a seed node for that network.
+   * @param network - The URL of the network you wish to join.
+   * @param tran
+   * @param ctx
+   */
   public async claimNetwork(
     targetNodeId: NodeId,
     network: string,
@@ -1891,6 +1940,13 @@ class NodeManager<Manifest extends AgentClientManifestNodeManager> {
     return [claimId, token];
   }
 
+  /**
+   * This provides the handler side of the ClaimNetwork logic.
+   * @param requestingNodeId - The nodeId of the node making the request. This should be taken from the connections
+   * certificate to confirm that `ClaimNetworkAccess` is being created for the node requesting it.
+   * @param input - The input stream for the RPC handler.
+   * @param tran
+   */
   public async *handleClaimNetwork(
     requestingNodeId: NodeId,
     input: AsyncIterableIterator<AgentRPCRequestParams<AgentClaimMessage>>,
@@ -2012,6 +2068,11 @@ class NodeManager<Manifest extends AgentClientManifestNodeManager> {
     });
   }
 
+  /**
+   * Gets the `ClaimNetworkAuthority` from the target node. It also verifies its valid and for the expected network.
+   * @param network
+   * @param targetNodeId
+   */
   public async remoteClaimNetworkAuthorityGet(
     network: string,
     targetNodeId: NodeId,
@@ -2042,6 +2103,9 @@ class NodeManager<Manifest extends AgentClientManifestNodeManager> {
     );
   }
 
+  /**
+   * The handler side logic for `remoteClaimNetworkAuthorityGet`.
+   */
   public async handleClaimNetworkAuthorityGet(): Promise<SignedTokenEncoded> {
     if (this.claimNetworkAuthority == null) {
       throw new nodesErrors.ErrorNodeManagerClaimNetworkAuthorityMissing();