ipfs-node 0.1.6__py3-none-any.whl

ipfs_node/ipfs_tunnels.py

@@ -0,0 +1,263 @@
+import ctypes
+import json
+from typing import List, Dict, Optional, Tuple, Any, Union
+from ipfs_tk_generics.tunnels import SenderTunnel, ListenerTunnel, TunnelsList, BaseTunnels
+from libkubo import libkubo, c_str, from_c_str, ffi, c_bool
+
+
+
+
+
+class NodeTunnels(BaseTunnels):
+    """
+    Provides P2P stream mounting functionality for IPFS nodes.
+
+    Stream mounting allows you to expose local TCP services to the libp2p network
+    and connect to remote TCP services exposed by other nodes.
+    """
+
+    def __init__(self, node):
+        self._node = node
+        self._repo_path = self._node._repo_path
+        BaseTunnels.__init__(self)
+
+
+    def _enable_p2p(self) -> bool:
+        """Enable p2p functionality in the IPFS configuration."""
+
+        repo_path = c_str(self._repo_path.encode('utf-8'))
+        result = libkubo.P2PEnable(repo_path)
+
+        if result <= 0:
+            print(f"Warning: Could not enable p2p functionality ({result})")
+            return False
+        return True
+
+    def open_sender(self, name: str, listen_addr: int | str, target_peer_id: str):
+        """
+        Forward local connections to a remote peer.
+
+        This creates a new listener that forwards connections to the specified
+        peer over the libp2p network.
+
+        Args:
+            name: The protocol name to use for the forwarding.
+            listen_addr: The local address to listen on (e.g. "127.0.0.1:8080").
+            target_peer_id: The peer ID to forward connections to.
+
+        Returns:
+            bool: True if the forwarding was set up successfully, False otherwise.
+        """
+        # if not target_peer_id.startswith("/p2p/"):
+        #     target_peer_id = f"/p2p/{target_peer_id}"
+        result = libkubo.P2PForward(
+            c_str(self._repo_path.encode('utf-8')),
+            c_str(name.encode('utf-8')),
+            c_str(self._port_to_addr(listen_addr).encode('utf-8')),
+            c_str(target_peer_id.encode('utf-8'))
+        )
+        if result > 0:
+            return
+        if result == -2:
+            print(f"Can't create sender {name} {listen_addr} {target_peer_id}")
+            raise Exception("IpfsNode.tunnels.open_sender: failed to open sender: bind: address already in use")
+            
+        
+        raise Exception("IpfsNode.tunnels.open_sender: failed to open sender")
+
+    def open_listener(self, name: str, target_addr: int | str):
+        """
+        Listen for libp2p connections and forward them to a local TCP service.
+
+        This exposes a local TCP service to the libp2p network.
+
+        Args:
+            name: The protocol name to use for the listener.
+            target_addr: The local address to forward connections to (e.g. "127.0.0.1:8080").
+
+        Returns:
+            bool: True if the listener was set up successfully, False otherwise.
+        """
+        result = libkubo.P2PListen(
+            c_str(self._repo_path.encode('utf-8')),
+            c_str(name.encode('utf-8')),
+            c_str(self._port_to_addr(target_addr)))
+        if result > 0:
+            return
+        if result == -2:
+            print(f"Can't open listener {name} {target_addr}")
+            raise Exception("IpfsNode.tunnels.open_sender: failed to open listener")
+            
+        
+        raise Exception("IpfsNode.tunnels.open_sender: failed to open listener")
+
+    def close_sender(self, name: str = None, port: int = None, peer_id: str = None) -> int:
+        """
+        Close a specific TCP forwarding connection, optionally filtered by protocol, port, or peer ID.
+
+        Args:
+            name: Optional protocol filter
+            port: Optional port filter
+            peer_id: Optional peer ID filter
+
+        Returns:
+            int: Number of forwarding connections closed
+        """
+        if peer_id and not peer_id.startswith("/p2p/"):
+            peer_id = f"/p2p/{peer_id}"
+        return self.close_tcp_connections(name, port, peer_id, senders=True, listeners=False)
+
+    def close_listener(self, name: str = None, port: int = None) -> int:
+        """
+        Close a specific TCP listening connection, optionally filtered by protocol name or port.
+
+        Args:
+            name: Optional protocol name filter
+            port: Optional port filter
+
+        Returns:
+            int: Number of listening connections closed
+        """
+        return self.close_tcp_connections(name, target_addr=port, listeners=True, senders=False)
+
+    def close_streams(self, name: str, port: int | None = None, target_peer_id: str = "") -> bool:
+        """
+        Close a P2P listener or stream.
+
+        Args:
+            name: The protocol name of the listener or stream to close.
+            listen_addr: For streams, the local address that the stream listens on.
+            target_peer_id: For streams, the peer ID that the stream connects to.
+
+        Returns:
+            bool: True if the listener or stream was closed successfully, False otherwise.
+        """
+        result = libkubo.P2PClose(
+            c_str(self._repo_path.encode('utf-8')),
+            c_str(name.encode('utf-8')),
+            c_str(self._port_to_addr(port)) if port else c_str(""),
+            c_str(target_peer_id.encode('utf-8'))
+        )
+        return result > 0
+
+    def close_tcp_connections(
+        self,
+        name: str = "", listen_addr: str | int | None = None, target_addr: str | int | None = None, all: bool = False,
+        listeners: bool = True, senders: bool = True
+    ) -> int:
+        """
+        Close specific TCP p2p connections, optionally filtered by protocol name, port, or peer ID.
+
+        Args:
+            name: Optional protocol name filter
+            port: Optional port filter
+            peer_id: Optional peer ID filter
+
+        Returns:
+            int: Number of connections closed
+        """
+
+        repo_path = c_str(self._repo_path.encode('utf-8'))
+
+        result = libkubo.P2PClose(
+            repo_path, c_str(name),
+            c_str(self._port_to_addr(listen_addr)),
+            c_str(self._port_to_addr(target_addr)),
+            c_bool(all), c_bool(listeners), c_bool(senders)
+        )
+        return result
+
+    def close_all_senders(self) -> int:
+        """
+        Close all TCP forwarding connections.
+
+        Returns:
+            int: Number of forwarding connections closed
+        """
+        return self.close_tcp_connections(all=True, listeners=False, senders=True)
+
+    def close_all_listeners(self) -> int:
+        """
+        Close all TCP listening connections.
+
+        Returns:
+            int: Number of listening connections closed
+        """
+        return self.close_tcp_connections(all=True, listeners=True, senders=False)
+    def close_all(self) -> int:
+        """
+        Close all TCP connections.
+
+        Returns:
+            int: Number of listening connections closed
+        """
+        return self.close_tcp_connections(all=True, listeners=True, senders=True)
+
+    def get_tunnels(self) ->TunnelsList:
+        """
+        List all active P2P tunnels.
+        """
+        result_ptr = libkubo.P2PListListeners(
+            c_str(self._repo_path.encode('utf-8'))
+        )
+
+        if not result_ptr:
+            return [], []
+
+        # Convert the C string to a Python string and release memory
+        result_str = from_c_str(result_ptr)
+        # libkubo.free(result_ptr)
+
+        if not result_str:
+            return [], []
+
+        # Parse the JSON
+        try:
+            result = json.loads(result_str)
+        except json.JSONDecodeError:
+            return [], []
+
+        # Add local listeners
+        listeners = []
+        for item in result.get('Listens', []):
+            listener = ListenerTunnel(
+                name=item.get('Protocol', ''),
+                # listen_address=item.get('ListenAddress', ''),
+                target_address=item.get('TargetAddress', '')
+            )
+            listeners.append(listener)
+
+        # Add remote listeners
+        forwarders = []
+        for item in result.get('Forwards', []):
+            listener = SenderTunnel(
+                name=item.get('Protocol', ''),
+                listen_address=item.get('ListenAddress', ''),
+                target_address=item.get('TargetAddress', '')
+            )
+            forwarders.append(listener)
+
+        # # Extract active streams
+        # streams = []
+        # for item in result.get('Streams', []):
+        #     stream = P2PStream(
+        #         name=item.get('Protocol', ''),
+        #         origin_address=item.get('LocalAddr', ''),
+        #         target_address=item.get('RemoteAddr', '')
+        #     )
+        #     streams.append(stream)
+
+        return TunnelsList(senders=forwarders, listeners=listeners)
+
+
+    def _port_to_addr(self, addr: int | str | None) -> str:
+        if not addr:
+            return ""
+        if isinstance(addr, int):
+            return f"/ip4/{self._node._ipfs_host_ip()}/tcp/{addr}"
+        else:
+            return addr
+    def terminate(self):
+        pass
+    def __del__(self):
+        self.terminate()

ipfs_node/libkubo/libkubo_linux_x86_64.h

@@ -0,0 +1,237 @@
+/* Code generated by cmd/cgo; DO NOT EDIT. */
+
+/* package github.com/emendir/py_ipfs_node/libkubo */
+
+
+#line 1 "cgo-builtin-export-prolog"
+
+#include <stddef.h>
+
+#ifndef GO_CGO_EXPORT_PROLOGUE_H
+#define GO_CGO_EXPORT_PROLOGUE_H
+
+#ifndef GO_CGO_GOSTRING_TYPEDEF
+typedef struct { const char *p; ptrdiff_t n; } _GoString_;
+#endif
+
+#endif
+
+/* Start of preamble from import "C" comments.  */
+
+
+#line 3 "files.go"
+ #include <stdlib.h>
+ #include <stdbool.h>
+
+#line 1 "cgo-generated-wrapper"
+
+#line 3 "p2p.go"
+
+#include <stdlib.h>
+#include <stdbool.h>
+
+#line 1 "cgo-generated-wrapper"
+
+#line 3 "peers.go"
+ #include <stdlib.h>
+
+#line 1 "cgo-generated-wrapper"
+
+#line 3 "pubsub.go"
+ #include <stdlib.h>
+
+#line 1 "cgo-generated-wrapper"
+
+#line 3 "repo.go"
+ #include <stdlib.h>
+
+#line 1 "cgo-generated-wrapper"
+
+
+/* End of preamble from import "C" comments.  */
+
+
+/* Start of boilerplate cgo prologue.  */
+#line 1 "cgo-gcc-export-header-prolog"
+
+#ifndef GO_CGO_PROLOGUE_H
+#define GO_CGO_PROLOGUE_H
+
+typedef signed char GoInt8;
+typedef unsigned char GoUint8;
+typedef short GoInt16;
+typedef unsigned short GoUint16;
+typedef int GoInt32;
+typedef unsigned int GoUint32;
+typedef long long GoInt64;
+typedef unsigned long long GoUint64;
+typedef GoInt64 GoInt;
+typedef GoUint64 GoUint;
+typedef size_t GoUintptr;
+typedef float GoFloat32;
+typedef double GoFloat64;
+#ifdef _MSC_VER
+#include <complex.h>
+typedef _Fcomplex GoComplex64;
+typedef _Dcomplex GoComplex128;
+#else
+typedef float _Complex GoComplex64;
+typedef double _Complex GoComplex128;
+#endif
+
+/*
+  static assertion to make sure the file is being used on architecture
+  at least with matching size of GoInt.
+*/
+typedef char _check_for_64_bit_pointer_matching_GoInt[sizeof(void*)==64/8 ? 1:-1];
+
+#ifndef GO_CGO_GOSTRING_TYPEDEF
+typedef _GoString_ GoString;
+#endif
+typedef void *GoMap;
+typedef void *GoChan;
+typedef struct { void *t; void *v; } GoInterface;
+typedef struct { void *data; GoInt len; GoInt cap; } GoSlice;
+
+#endif
+
+/* End of boilerplate cgo prologue.  */
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+
+// AddFile adds a file to IPFS
+//
+extern char* AddFile(char* repoPath, char* filePath, _Bool onlyHash);
+
+// FreeString is a no-op for now - we'll let Go's garbage collection handle the memory
+//
+extern void FreeString(char* str);
+
+// Download retrieves a file or directory from IPFS
+//
+extern int Download(char* repoPath, char* cidStr, char* destPath);
+
+// PinCID pins a CID to the IPFS node
+//
+extern int PinCID(char* repoPath, char* cidStr);
+
+// UnpinCID unpins a CID from the IPFS node
+//
+extern int UnpinCID(char* repoPath, char* cidStr);
+
+// ListPins returns a list of pinned CIDs
+//
+extern char* ListPins(char* repoPath);
+
+// RemoveCID removes a pinned CID from IPFS (alias for UnpinCID for clarity)
+//
+extern int RemoveCID(char* repoPath, char* cidStr);
+
+// P2PForward creates a libp2p stream mounting forwarding connection
+//
+extern int P2PForward(char* repoPath, char* proto, char* listenAddr, char* targetPeerID);
+
+// P2PListen creates a libp2p service that listens for connections on the given protocol
+//
+extern int P2PListen(char* repoPath, char* proto, char* targetAddr);
+
+// P2PClose closes p2p listener or stream
+//
+extern int P2PClose(char* repoPath, char* proto, char* listenAddr, char* targetAddr, _Bool _all, _Bool listeners, _Bool forwarders);
+
+// P2PListListeners lists active p2p listeners
+//
+extern char* P2PListListeners(char* repoPath);
+
+// P2PEnable ensures p2p functionality is enabled in the config
+//
+extern int P2PEnable(char* repoPath);
+
+// P2PListForwards lists active p2p forwarding connections
+//
+extern char* P2PListForwards(char* repoPath);
+
+// P2PCloseAllListeners closes all p2p listeners
+//
+extern int P2PCloseAllListeners(char* repoPath);
+
+// P2PCloseAllForwards closes all p2p forwards
+//
+extern int P2PCloseAllForwards(char* repoPath);
+
+// ConnectToPeer connects to a peer
+//
+extern int ConnectToPeer(char* repoPath, char* peerAddr);
+
+// ListPeers connects to a peer
+//
+extern char* ListPeers(char* repoPath);
+
+// ListPeers connects to a peer
+//
+extern char* ListPeersIDs(char* repoPath);
+
+// FindPeer connects to a peer
+//
+extern char* FindPeer(char* repoPath, char* peerAddr, int timeOut);
+
+// PubSubListTopics lists the topics the node is subscribed to
+//
+extern char* PubSubListTopics(char* repoPath);
+
+// PubSubPublish publishes a message to a topic
+//
+extern int PubSubPublish(char* repoPath, char* topic, void* data, int dataLen);
+
+// PubSubSubscribe subscribes to a topic
+//
+extern long long int PubSubSubscribe(char* repoPath, char* topic);
+
+// PubSubNextMessage gets the next message from a subscription
+//
+extern char* PubSubNextMessage(long long int subID);
+
+// PubSubUnsubscribe unsubscribes from a topic
+//
+extern int PubSubUnsubscribe(long long int subID);
+
+// PubSubPeers lists peers participating in a topic
+//
+extern char* PubSubPeers(char* repoPath, char* topic);
+
+// PubSubCloseRepoSubscriptions closes all active pubsub subscriptions for a specific repository
+//
+extern int PubSubCloseRepoSubscriptions(char* repoPath);
+
+// PubSubCloseAllSubscriptions closes all active pubsub subscriptions across all repositories
+//
+extern int PubSubCloseAllSubscriptions();
+
+// CreateRepo initializes a new IPFS repository
+//
+extern int CreateRepo(char* repoPath);
+extern int RunNode(char* repoPath);
+
+// PubSubEnable enables pubsub on an IPFS node configuration
+//
+extern int PubSubEnable(char* repoPath);
+extern char* TestGetString();
+
+// GetNodeID gets the ID of the IPFS node
+//
+extern char* GetNodeID(char* repoPath);
+
+// GetNodeMultiAddrs gets the ID of the IPFS node
+//
+extern char* GetNodeMultiAddrs(char* repoPath);
+
+// CleanupNode explicitly releases a node by path
+//
+extern int CleanupNode(char* repoPath);
+
+#ifdef __cplusplus
+}
+#endif

ipfs_node/utils/__init__.py

@@ -0,0 +1,3 @@
+"""Utility functions for the Kubo Python library."""
+
+__all__ = ["cid_utils", "peer_utils"]

ipfs_node/utils/cid_utils.py

@@ -0,0 +1,55 @@
+"""
+Utilities for working with IPFS Content Identifiers (CIDs).
+"""
+
+import re
+
+# Regular expression for matching CID v0 (Qm...)
+CID_V0_REGEX = re.compile(r"^Qm[1-9A-Za-z]{44}$")
+
+# Regular expression for matching CID v1
+CID_V1_REGEX = re.compile(r"^ba[a-zA-Z2-7]{57}$")
+
+def is_valid_cid(cid: str) -> bool:
+    """
+    Check if a string is a valid IPFS CID.
+    
+    Args:
+        cid: The Content Identifier to check.
+        
+    Returns:
+        bool: True if the CID is valid, False otherwise.
+    """
+    if not cid or not isinstance(cid, str):
+        return False
+    
+    # Check for CID v0 (starts with "Qm" and is 46 characters long)
+    if CID_V0_REGEX.match(cid):
+        return True
+    
+    # Check for CID v1 (starts with "ba" and is 59 characters long)
+    if CID_V1_REGEX.match(cid):
+        return True
+    
+    # Could add more sophisticated validation here
+    return False
+
+def format_cid_link(cid: str, gateway: str = "https://ipfs.io/ipfs/") -> str:
+    """
+    Format a CID as a link through an IPFS gateway.
+    
+    Args:
+        cid: The Content Identifier.
+        gateway: The IPFS gateway URL. Defaults to the public ipfs.io gateway.
+        
+    Returns:
+        str: The gateway URL for the CID.
+    """
+    if not is_valid_cid(cid):
+        raise ValueError(f"Invalid CID: {cid}")
+    
+    # Ensure the gateway URL ends with a slash
+    if not gateway.endswith("/"):
+        gateway += "/"
+    
+    return f"{gateway}{cid}"

ipfs_node/utils/peer_utils.py

@@ -0,0 +1,62 @@
+"""
+Utilities for working with IPFS peer addresses and connections.
+"""
+
+import re
+
+# Regular expression for matching multiaddress format
+MULTIADDR_REGEX = re.compile(r"^(/[^/]+)+$")
+
+# Regular expression for matching peer ID format (with multiaddress)
+PEER_ID_REGEX = re.compile(r"/p2p/([a-zA-Z0-9]+)$")
+
+def is_valid_multiaddr(addr: str) -> bool:
+    """
+    Check if a string is a valid IPFS multiaddress.
+    
+    Args:
+        addr: The multiaddress to check.
+        
+    Returns:
+        bool: True if the multiaddress is valid, False otherwise.
+    """
+    if not addr or not isinstance(addr, str):
+        return False
+    
+    # Basic check for multiaddress format
+    return bool(MULTIADDR_REGEX.match(addr))
+
+def extract_peer_id(multiaddr: str) -> str:
+    """
+    Extract the peer ID from a multiaddress.
+    
+    Args:
+        multiaddr: The multiaddress containing a peer ID.
+        
+    Returns:
+        str: The peer ID, or an empty string if not found.
+    """
+    if not is_valid_multiaddr(multiaddr):
+        return ""
+    
+    # Find the peer ID component
+    match = PEER_ID_REGEX.search(multiaddr)
+    if match:
+        return match.group(1)
+    
+    return ""
+
+def get_bootstrap_peers() -> list:
+    """
+    Get a list of default IPFS bootstrap peers.
+    
+    Returns:
+        list: A list of multiaddresses for the default bootstrap peers.
+    """
+    return [
+        "/dnsaddr/bootstrap.libp2p.io/p2p/QmNnooDu7bfjPFoTZYxMNLWUQJyrVwtbZg5gBMjTezGAJN",
+        "/dnsaddr/bootstrap.libp2p.io/p2p/QmQCU2EcMqAqQPR2i9bChDtGNJchTbq5TbXJJ16u19uLTa",
+        "/dnsaddr/bootstrap.libp2p.io/p2p/QmbLHAnMoJPWSCR5Zhtx6BHJX9KiKNN6tpvbUcqanj75Nb",
+        "/dnsaddr/bootstrap.libp2p.io/p2p/QmcZf59bWwK5XFi76CZX8cbJ4BhTzzA3gU1ZjYZcYW3dwt",
+        "/ip4/104.131.131.82/tcp/4001/p2p/QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ",
+    ]

ipfs_node-0.1.6.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.