feat(rpc): support connect_peer by pubkey

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Author: quake

crates/fiber-lib/src/fiber/network.rs

@@ -288,6 +288,8 @@ pub enum NetworkActorCommand {
     /// Network commands
     // Connect to a peer, and optionally also save the peer to the peer store.
     ConnectPeer(Multiaddr, bool),
+    // Connect to a peer via pubkey, resolving address from local graph/saved state.
+    ConnectPeerWithPubkey(Pubkey, RpcReplyPort<Result<(), String>>),
     DisconnectPeer(Pubkey, PeerDisconnectReason),
     // Save the address of a peer to the peer store, the address here must be a valid
     // multiaddr with the peer id.
@@ -1105,6 +1107,24 @@ where
                 // Tentacle sends an event by calling handle_error function instead, which
                 // may receive errors like DialerError.
             }
+            NetworkActorCommand::ConnectPeerWithPubkey(pubkey, reply) => {
+                let address = state
+                    .get_peer_addresses_by_pubkey(&pubkey)
+                    .into_iter()
+                    .choose(&mut rand::thread_rng());
+                let Some(addr) = address else {
+                    let _ = reply.send(Err(Error::PeerNotFound(pubkey).to_string()));
+                    return Ok(());
+                };
+                match state.control.dial(addr, TargetProtocol::All).await {
+                    Ok(()) => {
+                        let _ = reply.send(Ok(()));
+                    }
+                    Err(err) => {
+                        let _ = reply.send(Err(err.to_string()));
+                    }
+                }
+            }
             NetworkActorCommand::DisconnectPeer(pubkey, reason) => {
                 if let Some(session) = state.peer_session_map.get(&pubkey).map(|p| p.session_id) {
                     debug!(

crates/fiber-lib/src/fiber/tests/rpc.rs

@@ -18,7 +18,7 @@ use crate::{
         graph::{GraphNodesParams, GraphNodesResult},
         invoice::{InvoiceParams, InvoiceResult, NewInvoiceParams},
         payment::{GetPaymentCommandParams, GetPaymentCommandResult},
-        peer::ListPeersResult,
+        peer::{ConnectPeerParams, ListPeersResult},
     },
 };
 use biscuit_auth::macros::biscuit;
@@ -209,7 +209,7 @@ async fn test_rpc_list_peers() {
         Some(gen_rpc_config()),
     )
     .await;
-    let [mut node_0, mut node_1] = nodes.try_into().expect("2 nodes");
+    let [mut node_0, node_1] = nodes.try_into().expect("2 nodes");
 
     let list_peers: ListPeersResult = node_0.send_rpc_request("list_peers", ()).await.unwrap();
     assert_eq!(list_peers.peers.len(), 1);
@@ -231,6 +231,23 @@ async fn test_rpc_list_peers() {
     let list_peers: ListPeersResult = node_0.send_rpc_request("list_peers", ()).await.unwrap();
     assert_eq!(list_peers.peers.len(), 0);
 
+    let _res: () = node_0
+        .send_rpc_request(
+            "connect_peer",
+            ConnectPeerParams {
+                address: None,
+                pubkey: Some(node_1_pubkey),
+                save: Some(false),
+            },
+        )
+        .await
+        .unwrap();
+    tokio::time::sleep(tokio::time::Duration::from_millis(1000)).await;
+
+    let list_peers: ListPeersResult = node_0.send_rpc_request("list_peers", ()).await.unwrap();
+    assert_eq!(list_peers.peers.len(), 1);
+    assert_eq!(list_peers.peers[0].pubkey, node_1.pubkey);
+
     let mut node_3 = NetworkNode::new_with_config(
         NetworkNodeConfigBuilder::new()
             .node_name(Some(format!("node-{}", 3)))
@@ -248,7 +265,6 @@ async fn test_rpc_list_peers() {
     assert_eq!(list_peers.peers.len(), 1);
     assert_eq!(list_peers.peers[0].pubkey, node_0.pubkey);
 
-    node_0.connect_to(&mut node_1).await;
     let list_peers: ListPeersResult = node_0.send_rpc_request("list_peers", ()).await.unwrap();
     assert_eq!(list_peers.peers.len(), 2);
     dbg!("list_peers: {:?}", &list_peers);

crates/fiber-lib/src/rpc/README.md

@@ -865,7 +865,10 @@ Connect to a peer.
 
 ##### Params
 
-* `address` - <em>`MultiAddr`</em>, The address of the peer to connect to.
+* `address` - <em>`Option<MultiAddr>`</em>, The address of the peer to connect to.
+ Either `address` or `pubkey` must be provided.
+* `pubkey` - <em>Option<[Pubkey](#type-pubkey)></em>, The public key of the peer to connect to.
+ The node resolves the address from locally synced graph data.
 * `save` - <em>`Option<bool>`</em>, Whether to save the peer address to the peer store.
 
 ##### Returns

crates/fiber-lib/src/rpc/peer.rs

@@ -16,7 +16,11 @@ pub use tentacle::multiaddr::MultiAddr;
 #[derive(Serialize, Deserialize, Debug, Clone)]
 pub struct ConnectPeerParams {
     /// The address of the peer to connect to.
-    pub address: MultiAddr,
+    /// Either `address` or `pubkey` must be provided.
+    pub address: Option<MultiAddr>,
+    /// The public key of the peer to connect to.
+    /// The node resolves the address from locally synced graph data.
+    pub pubkey: Option<Pubkey>,
     /// Whether to save the peer address to the peer store.
     pub save: Option<bool>,
 }
@@ -94,11 +98,27 @@ impl PeerRpcServer for PeerRpcServerImpl {
 
 impl PeerRpcServerImpl {
     pub async fn connect_peer(&self, params: ConnectPeerParams) -> Result<(), ErrorObjectOwned> {
-        let message = NetworkActorMessage::Command(NetworkActorCommand::ConnectPeer(
-            params.address.clone(),
-            params.save.unwrap_or(true),
-        ));
-        crate::handle_actor_cast!(self.actor, message, params)
+        if let Some(address) = params.address.clone() {
+            let save = params.save.unwrap_or(true);
+            let message =
+                NetworkActorMessage::Command(NetworkActorCommand::ConnectPeer(address, save));
+            return crate::handle_actor_cast!(self.actor, message, params);
+        }
+
+        if let Some(pubkey) = params.pubkey.clone() {
+            let message = |rpc_reply| {
+                NetworkActorMessage::Command(NetworkActorCommand::ConnectPeerWithPubkey(
+                    pubkey, rpc_reply,
+                ))
+            };
+            return crate::handle_actor_call!(self.actor, message, params);
+        }
+
+        Err(ErrorObjectOwned::owned(
+            CALL_EXECUTION_FAILED_CODE,
+            "either `address` or `pubkey` is required",
+            Some(params),
+        ))
     }
 
     pub async fn disconnect_peer(

docs/testnet-nodes.md

@@ -72,58 +72,22 @@
 
 
 
-
-## Discover Public Nodes from `graph_nodes` (optional)
-
-1. Query graph nodes
-
-   ```bash
-   curl -s --location 'http://127.0.0.1:8227' --header 'Content-Type: application/json' --data '{
-       "id": 1,
-       "jsonrpc": "2.0",
-       "method": "graph_nodes",
-       "params": [
-           {}
-       ]
-   }'
-   ```
-
-2. Find node1 / node2 by pubkey and read addresses
-
-   - node1 pubkey: `02b6d4e3ab86a2ca2fad6fae0ecb2e1e559e0b911939872a90abdda6d20302be71`
-   - node1 address (current): `"/ip4/18.162.235.225/tcp/8119/p2p/QmXen3eUHhywmutEzydCsW4hXBoeVmdET2FJvMX69XJ1Eo"`
-   - node2 pubkey: `0291a6576bd5a94bd74b27080a48340875338fff9f6d6361fe6b8db8d0d1912fcc`
-   - node2 address (current): `"/ip4/18.163.221.211/tcp/8119/p2p/QmbKyzq9qUmymW2Gi8Zq7kKVpPiNA1XUJ6uMvsUC4F3p89"`
-   - use each node's `addresses` field in the `connect_peer` call below.
-
-   ```bash
-   curl -s --location 'http://127.0.0.1:8227' --header 'Content-Type: application/json' --data '{
-       "id": 1,
-       "jsonrpc": "2.0",
-       "method": "graph_nodes",
-       "params": [
-           {}
-       ]
-   }' | jq '.result.nodes[] | select(.pubkey=="02b6d4e3ab86a2ca2fad6fae0ecb2e1e559e0b911939872a90abdda6d20302be71" or .pubkey=="0291a6576bd5a94bd74b27080a48340875338fff9f6d6361fe6b8db8d0d1912fcc") | {pubkey, addresses}'
-   ```
-
-
 ## Establishing a CKB Channel with Public Node 1
 
 
 1. Establish a network connection between nodeA and node1
 
    ```bash
    curl -s --location 'http://127.0.0.1:8227' --header 'Content-Type: application/json' --data '{
-       "id": 1,
-       "jsonrpc": "2.0",
-       "method": "connect_peer",
-       "params": [
-           {
-               "address": "/ip4/18.162.235.225/tcp/8119/p2p/QmXen3eUHhywmutEzydCsW4hXBoeVmdET2FJvMX69XJ1Eo"
-           }
-       ]
-   }'
+        "id": 1,
+        "jsonrpc": "2.0",
+        "method": "connect_peer",
+        "params": [
+            {
+                "pubkey": "02b6d4e3ab86a2ca2fad6fae0ecb2e1e559e0b911939872a90abdda6d20302be71"
+            }
+        ]
+    }'
    ```
 
    ```json
@@ -376,6 +340,19 @@
 
 1. Establish a network connection between nodeA and node1
 
+   ```bash
+   curl -s --location 'http://127.0.0.1:8227' --header 'Content-Type: application/json' --data '{
+       "id": 1,
+       "jsonrpc": "2.0",
+       "method": "connect_peer",
+       "params": [
+           {
+               "pubkey": "02b6d4e3ab86a2ca2fad6fae0ecb2e1e559e0b911939872a90abdda6d20302be71"
+           }
+       ]
+   }'
+   ```
+
 
 
 2. Establish a channel with 20 RUSD: nodeA (20 RUSD) ⟺ node1 (0)