Struct TrustedPeer 

pub struct TrustedPeer {
    pub address: AddrV2,
    pub port: Option<u16>,
    pub known_services: ServiceFlags,
}

A peer on the Bitcoin P2P network

Building peers

use std::net::{IpAddr, Ipv4Addr};
use kyoto::{TrustedPeer, ServiceFlags, AddrV2};

let local_host = IpAddr::V4(Ipv4Addr::new(0, 0, 0, 0));
let mut trusted = TrustedPeer::from_ip(local_host);
// Optionally set the known services of the peer later.
trusted.set_services(ServiceFlags::P2P_V2);

let local_host = Ipv4Addr::new(0, 0, 0, 0);
// Or construct a trusted peer directly.
let trusted = TrustedPeer::new(AddrV2::Ipv4(local_host), None, ServiceFlags::P2P_V2);

// Or implicitly with `into`
let local_host = IpAddr::V4(Ipv4Addr::new(0, 0, 0, 0));
let trusted: TrustedPeer = (local_host, None).into();

Fields

address: AddrV2

The IP address of the remote node to connect to.

port: Option<u16>

The port to establish a TCP connection. If none is provided, the typical Bitcoin Core port is used as the default.

known_services: ServiceFlags

The services this peer is known to offer before starting the node.

Implementations

impl TrustedPeer

pub fn new(address: AddrV2, port: Option<u16>, services: ServiceFlags) -> Self

Create a new trusted peer.

pub fn from_ip(ip_addr: impl Into<IpAddr>) -> Self

Create a new trusted peer using the default port for the network.

pub fn from_socket_addr(socket_addr: impl Into<SocketAddr>) -> Self

Create a new peer from a known address and port.

pub fn address(&self) -> AddrV2

The IP address of the trusted peer.

pub fn port(&self) -> Option<u16>

A recommended port to connect to, if there is one.

pub fn services(&self) -> ServiceFlags

The services this peer is known to offer.

pub fn set_services(&mut self, services: ServiceFlags)

Set the known services for this trusted peer.

Trait Implementations

impl Clone for TrustedPeer

fn clone(&self) -> TrustedPeer

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TrustedPeer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<(IpAddr, Option<u16>)> for TrustedPeer

fn from(value: (IpAddr, Option<u16>)) -> Self

Converts to this type from the input type.

impl From<IpAddr> for TrustedPeer

fn from(value: IpAddr) -> Self

Converts to this type from the input type.

impl From<SocketAddr> for TrustedPeer

fn from(value: SocketAddr) -> Self

Converts to this type from the input type.

impl From<TrustedPeer> for (AddrV2, Option<u16>)

fn from(value: TrustedPeer) -> Self

Converts to this type from the input type.