ipfs-node 0.1.12rc2__py3-none-android_28_arm64_v8a.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/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.12rc2.dist-info/LICENSE

@@ -0,0 +1,18 @@
+MIT No Attribution
+
+Copyright [year] [fullname]
+
+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.
+
+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.

ipfs_node-0.1.12rc2.dist-info/LICENSE-CC0

@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.