Source code for bittensor.utils.networking
# The MIT License (MIT)
# Copyright © 2024 Opentensor Foundation
#
# 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.
"""Utils for handling local network with ip and ports."""
import json
import os
import socket
import urllib
from functools import wraps
from typing import Optional
import netaddr
import requests
from bittensor.utils.btlogging import logging
[docs]
def int_to_ip(int_val: int) -> str:
"""Maps an integer to a unique ip-string
Args:
int_val (int):
The integer representation of an ip. Must be in the range (0, 3.4028237e+38).
Returns:
str_val (str):
The string representation of an ip. Of form *.*.*.* for ipv4 or *::*:*:*:* for ipv6
Raises:
netaddr.core.AddrFormatError (Exception): Raised when the passed int_vals is not a valid ip int value.
"""
return str(netaddr.IPAddress(int_val))
[docs]
def ip_to_int(str_val: str) -> int:
"""Maps an ip-string to a unique integer.
arg:
str_val (:tyep:`str`, `required):
The string representation of an ip. Of form *.*.*.* for ipv4 or *::*:*:*:* for ipv6
Returns:
int_val (:type:`int128`, `required`):
The integer representation of an ip. Must be in the range (0, 3.4028237e+38).
Raises:
netaddr.core.AddrFormatError (Exception):
Raised when the passed str_val is not a valid ip string value.
"""
return int(netaddr.IPAddress(str_val))
[docs]
def ip_version(str_val: str) -> int:
"""Returns the ip version (IPV4 or IPV6).
arg:
str_val (:tyep:`str`, `required):
The string representation of an ip. Of form *.*.*.* for ipv4 or *::*:*:*:* for ipv6
Returns:
int_val (:type:`int128`, `required`):
The ip version (Either 4 or 6 for IPv4/IPv6)
Raises:
netaddr.core.AddrFormatError (Exception):
Raised when the passed str_val is not a valid ip string value.
"""
return int(netaddr.IPAddress(str_val).version)
[docs]
def ip__str__(ip_type: int, ip_str: str, port: int):
"""Return a formatted ip string"""
return "/ipv%i/%s:%i" % (ip_type, ip_str, port)
[docs]
class ExternalIPNotFound(Exception):
"""Raised if we cannot attain your external ip from CURL/URLLIB/IPIFY/AWS"""
[docs]
def get_external_ip() -> str:
"""Checks CURL/URLLIB/IPIFY/AWS for your external ip.
Returns:
external_ip (:obj:`str` `required`):
Your routers external facing ip as a string.
Raises:
ExternalIPNotFound (Exception):
Raised if all external ip attempts fail.
"""
# --- Try AWS
try:
external_ip = requests.get("https://checkip.amazonaws.com").text.strip()
assert isinstance(ip_to_int(external_ip), int)
return str(external_ip)
except Exception:
pass
# --- Try ipconfig.
try:
process = os.popen("curl -s ifconfig.me")
external_ip = process.readline()
process.close()
assert isinstance(ip_to_int(external_ip), int)
return str(external_ip)
except Exception:
pass
# --- Try ipinfo.
try:
process = os.popen("curl -s https://ipinfo.io")
external_ip = json.loads(process.read())["ip"]
process.close()
assert isinstance(ip_to_int(external_ip), int)
return str(external_ip)
except Exception:
pass
# --- Try myip.dnsomatic
try:
process = os.popen("curl -s myip.dnsomatic.com")
external_ip = process.readline()
process.close()
assert isinstance(ip_to_int(external_ip), int)
return str(external_ip)
except Exception:
pass
# --- Try urllib ipv6
try:
external_ip = urllib.request.urlopen("https://ident.me").read().decode("utf8")
assert isinstance(ip_to_int(external_ip), int)
return str(external_ip)
except Exception:
pass
# --- Try Wikipedia
try:
external_ip = requests.get("https://www.wikipedia.org").headers["X-Client-IP"]
assert isinstance(ip_to_int(external_ip), int)
return str(external_ip)
except Exception:
pass
raise ExternalIPNotFound
[docs]
def ensure_connected(func):
"""Decorator ensuring the function executes with an active substrate connection."""
@wraps(func)
def wrapper(self, *args, **kwargs):
"""Wrapper function where `self` argument is Subtensor instance with the substrate connection."""
# Check the socket state before method execution
if (
# connection was closed correctly
self.substrate.websocket.sock is None
# connection has a broken pipe
or self.substrate.websocket.sock.getsockopt(
socket.SOL_SOCKET, socket.SO_ERROR
)
!= 0
):
logging.info("Reconnection substrate...")
self._get_substrate()
# Execute the method if the connection is active or after reconnecting
return func(self, *args, **kwargs)
return wrapper
