Enum Network

#[non_exhaustive]
pub enum Network {
    Bitcoin,
    Testnet,
    Testnet4,
    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. (In future versions this will be combined into a single variant containing the version)

Testnet4

Bitcoin’s testnet4 network. (In future versions this will be combined into a single variant containing the version)

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;

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<Network, 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;

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

pub const fn params(self) -> &'static Params

Returns the associated network parameters.

Trait Implementations

impl AsRef<Params> for Network

fn as_ref(&self) -> &Params

Converts this type into a shared reference of the (usually inferred) input type.

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<(), Error>

Formats the value using the given formatter.

impl Decodable for Network

fn consensus_decode<D>( d: &mut D, modules: &ModuleRegistry<Decoder, DecodingMode>, ) -> Result<Network, DecodeError>

where D: Read,

Decode an object with a well-defined format.

fn consensus_decode_from_finite_reader<R>( r: &mut R, modules: &ModuleRegistry<Decoder, DecodingMode>, ) -> Result<Self, DecodeError>

where R: Read,

Decode Self from a size-limited reader.

fn consensus_decode_hex( hex: &str, modules: &ModuleRegistry<Decoder, DecodingMode>, ) -> Result<Self, DecodeError>

Decode an object from hex

fn consensus_decode_vec( bytes: Vec<u8>, modules: &ModuleRegistry<Decoder, DecodingMode>, ) -> Result<Self, DecodeError>

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Network

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

Formats the value using the given formatter.

impl Encodable for Network

fn consensus_encode<W>(&self, writer: &mut W) -> Result<usize, Error>

where W: Write,

Encode an object with a well-defined format. Returns the number of bytes written on success.

fn consensus_encode_to_vec(&self) -> Vec<u8>

Self::consensus_encode to newly allocated Vec<u8>

fn consensus_encode_to_hex(&self) -> String

Encode and convert to hex string representation

fn consensus_encode_to_len(&self) -> usize

Encode without storing the encoding, return the size

fn consensus_hash<H>(&self) -> H

where H: Hash, <H as Hash>::Engine: Write,

Generate a SHA256 hash of the consensus encoding using the default hash engine for H.

impl From<Currency> for Network

fn from(currency: Currency) -> Network

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<Network, <Network as FromStr>::Err>

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

impl Hash for Network

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

where __H: Hasher,

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) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Network

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd 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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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 as Serializer>::Ok, <__S as Serializer>::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<Network, <Network as TryFrom<ChainHash>>::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<Network, <Network as TryFrom<Magic>>::Error>

Performs the conversion.

impl Copy for Network

impl Eq for Network

impl StructuralPartialEq for Network