Enum bitcoin::network::Network

#[non_exhaustive]
pub enum Network {
    Bitcoin,
    Testnet,
    Signet,
    Regtest,
}

The cryptocurrency network to act on.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Bitcoin

Mainnet Bitcoin.

Testnet

Bitcoin’s testnet network.

Signet

Bitcoin’s signet network.

Regtest

Bitcoin’s regtest network.

Implementations

impl Network

pub fn from_magic(magic: Magic) -> Option<Network>

Creates a Network from the magic bytes.

Examples

use bitcoin::p2p::Magic;
use bitcoin::Network;
use std::convert::TryFrom;

assert_eq!(Ok(Network::Bitcoin), Network::try_from(Magic::from_bytes([0xF9, 0xBE, 0xB4, 0xD9])));
assert_eq!(None, Network::from_magic(Magic::from_bytes([0xFF, 0xFF, 0xFF, 0xFF])));

pub fn magic(self) -> Magic

Return the network magic bytes, which should be encoded little-endian at the start of every message

Examples

use bitcoin::p2p::Magic;
use bitcoin::Network;

let network = Network::Bitcoin;
assert_eq!(network.magic(), Magic::from_bytes([0xF9, 0xBE, 0xB4, 0xD9]));

pub fn to_core_arg(self) -> &'static str

Converts a Network to its equivalent bitcoind -chain argument name.

$ bitcoin-23.0/bin/bitcoind --help | grep -C 3 '\-chain=<chain>'
Chain selection options:

-chain=<chain>
Use the chain <chain> (default: main). Allowed values: main, test, signet, regtest

pub fn from_core_arg(core_arg: &str) -> Result<Self, ParseNetworkError>

Converts a bitcoind -chain argument name to its equivalent Network.

$ bitcoin-23.0/bin/bitcoind --help | grep -C 3 '\-chain=<chain>'
Chain selection options:

-chain=<chain>
Use the chain <chain> (default: main). Allowed values: main, test, signet, regtest

pub fn chain_hash(self) -> ChainHash

Return the network’s chain hash (genesis block hash).

Examples

use bitcoin::Network;
use bitcoin::blockdata::constants::ChainHash;

let network = Network::Bitcoin;
assert_eq!(network.chain_hash(), ChainHash::BITCOIN);

pub fn from_chain_hash(chain_hash: ChainHash) -> Option<Network>

Creates a Network from the chain hash (genesis block hash).

Examples

use bitcoin::Network;
use bitcoin::blockdata::constants::ChainHash;
use std::convert::TryFrom;

assert_eq!(Ok(Network::Bitcoin), Network::try_from(ChainHash::BITCOIN));

Trait Implementations

impl Clone for Network

fn clone(&self) -> Network

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Network

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Network

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Network

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

Formats the value using the given formatter.

impl From<Network> for Magic

fn from(network: Network) -> Magic

Converts to this type from the input type.

impl FromStr for Network

type Err = ParseNetworkError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Network

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Network

fn cmp(&self, other: &Network) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Network> for Network

fn eq(&self, other: &Network) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<Network> for Network

fn partial_cmp(&self, other: &Network) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Network

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<ChainHash> for Network

type Error = UnknownChainHashError

The type returned in the event of a conversion error.

fn try_from(chain_hash: ChainHash) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Magic> for Network

type Error = UnknownMagicError

The type returned in the event of a conversion error.

fn try_from(magic: Magic) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Network

impl Eq for Network

impl StructuralEq for Network

impl StructuralPartialEq for Network