gclient 1.10.0

// This file is part of Gear.

// Copyright (C) 2022-2025 Gear Technologies Inc.
// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0

// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.

use crate::{Error, Result};
use anyhow::anyhow;
use std::{
    fmt,
    net::{AddrParseError, SocketAddrV4},
};
use url::Url;

/// Full WebSocket address required to specify the node.
#[derive(Clone, Eq, PartialEq, Ord, PartialOrd)]
pub struct WSAddress {
    // Host domain name or IP address.
    //
    // TODO: `String` here for saving lives, could be
    // `Ipv4Address`(ip) + tls(wss?) after then.
    domain: String,
    port: Option<u16>,
}

impl WSAddress {
    // Default substrate node port.
    const DEFAULT_PORT: u16 = 9944;

    // Local dev node.
    const LOCALHOST: &'static str = "ws://127.0.0.1";

    // Default secure WebSocket port.
    const WSS_DEFAULT_PORT: u16 = 443;

    // Vara testnet.
    const VARA_TESTNET: &'static str = "wss://testnet.vara.network";

    // Vara network.
    const VARA: &'static str = "wss://rpc.vara.network";

    /// Create a new `WSAddress` from a host `domain` and `port`.
    ///
    /// This method does not do any validation of `domain`,
    /// see [`WSAddress::try_new`] if you need it.
    pub fn new(domain: impl AsRef<str>, port: impl Into<Option<u16>>) -> Self {
        Self {
            domain: domain.as_ref().into(),
            port: port.into(),
        }
    }

    /// Try to create a new `WSAddress` from `domain` and `port`.
    ///
    /// Unlike the [`WSAddress::new`] method, this function checks
    /// that the `domain` is valid.
    pub fn try_new(domain: impl AsRef<str>, port: impl Into<Option<u16>>) -> Result<Self> {
        let domain = domain.as_ref().to_string();
        let port = port.into();

        let url = Url::parse(domain.as_ref())?;

        let valid_domain = matches!(url.scheme(), "ws" | "wss")
            && !url.cannot_be_a_base()
            && url.has_host()
            && url.port().is_none()
            && url.query().is_none()
            && url.fragment().is_none();

        if !valid_domain {
            return Err(Error::WSDomainInvalid);
        }

        Ok(Self { domain, port })
    }

    /// Return the address of the local node working in developer mode (running
    /// with `--dev` argument).
    ///
    /// # Examples
    ///
    /// ```
    /// use gclient::WSAddress;
    ///
    /// let address = WSAddress::dev();
    /// assert_eq!(address, WSAddress::new("ws://127.0.0.1", 9944));
    /// ```
    pub fn dev() -> Self {
        Self::dev_with_port(Self::DEFAULT_PORT)
    }

    /// Return the address of the local node working in developer mode (running
    /// with `--dev` argument).
    ///
    /// # Examples
    ///
    /// ```
    /// use gclient::WSAddress;
    ///
    /// let address = WSAddress::dev_with_port(1234);
    /// assert_eq!(address, WSAddress::new("ws://127.0.0.1", 1234));
    /// ```
    pub fn dev_with_port(port: u16) -> Self {
        Self::new(Self::LOCALHOST, port)
    }

    /// Return the default address of the public Vara testnet node.
    ///
    /// # Examples
    ///
    /// ```
    /// use gclient::WSAddress;
    ///
    /// let address = WSAddress::vara_testnet();
    /// assert_eq!(address, WSAddress::new("wss://testnet.vara.network", 443));
    /// ```
    pub fn vara_testnet() -> Self {
        Self::new(Self::VARA_TESTNET, Self::WSS_DEFAULT_PORT)
    }

    /// Return the default address of the public Vara node.
    ///
    /// # Examples
    ///
    /// ```
    /// use gclient::WSAddress;
    ///
    /// let address = WSAddress::vara();
    /// assert_eq!(address.url(), "wss://rpc.vara.network");
    /// ```
    pub fn vara() -> Self {
        Self::new(Self::VARA, None)
    }

    /// Convert the address to the URL string.
    ///
    /// # Examples
    ///
    /// ```
    /// use gclient::WSAddress;
    ///
    /// let address = WSAddress::new("wss://my-node.example.com", 443);
    /// assert_eq!(address.url(), "wss://my-node.example.com:443");
    /// ```
    pub fn url(&self) -> String {
        if let Some(port) = self.port {
            format!("{}:{port}", self.domain)
        } else {
            self.domain.to_string()
        }
    }
}

impl fmt::Debug for WSAddress {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        fmt::Display::fmt(self, f)
    }
}

impl fmt::Display for WSAddress {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.url())
    }
}

impl From<SocketAddrV4> for WSAddress {
    fn from(addr: SocketAddrV4) -> Self {
        let tls = addr.port() == 443;
        let scheme_prefix = if tls { "wss" } else { "ws" }.to_string() + "://";

        Self::new(scheme_prefix + &addr.ip().to_string(), addr.port())
    }
}

impl TryInto<SocketAddrV4> for WSAddress {
    type Error = Error;

    fn try_into(self) -> Result<SocketAddrV4, Self::Error> {
        let domain = self.domain.split("://").collect::<Vec<_>>();
        let (ip, mb_port) = if domain.len() != 2 {
            return Err(anyhow!("Invalid domain").into());
        } else {
            match domain[0] {
                "ws" => (domain[1], 80),
                "wss" => (domain[1], 443),
                _ => return Err(anyhow!("Invalid scheme").into()),
            }
        };

        Ok(format!("{}:{}", ip, self.port.unwrap_or(mb_port))
            .parse()
            .map_err(|e: AddrParseError| anyhow!(e))?)
    }
}