Enum lnpbp::chain::Chain

#[non_exhaustive]
#[repr(u32)]pub enum Chain {
    Mainnet,
    Testnet3,
    Regtest(BlockHash),
    Signet,
    SignetCustom(BlockHash),
    LiquidV1,
    Other(ChainParams),
}

A set of recommended standard networks. Differs from bitcoin::Network in ability to support non-standard and non-predefined networks

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.

Mainnet

Bitcoin mainnet

Testnet3

Bitcoin testnet version 3

Regtest(BlockHash)

Bitcoin regtest network, with provided genesis hash to distinguish different private networks

Signet

Default bitcoin signet network

SignetCustom(BlockHash)

Some private bitcoin signet network, with provided genesis hash to distinguish private networks from each other

LiquidV1

Liquidv1 sidechain & network by Blockstream

Other(ChainParams)

All other networks/chains, providing full information on chain parameters

Implementations

impl Chain

pub fn chain_params(&self) -> ChainParams

Returns chain parameters ChainParams for a given chain id

pub fn as_genesis_hash(&self) -> &BlockHash

Returns hash of genesis block

pub fn from_genesis_hash(hash: &BlockHash) -> Option<Self>

Gueses chain from the given genesis block hash, returning Option::None if the hash is unknown. This implies that for custom signet and some regtest networks with modified genesis the function will fail.

Trait Implementations

impl Clone for Chain

fn clone(&self) -> Chain

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Chain

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

Formats the value using the given formatter.

impl Default for Chain

fn default() -> Self

Returns the "default value" for a type.

impl Display for Chain

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

Formats the value using the given formatter.

impl Eq for Chain

impl From<ChainParams> for Chain

fn from(params: ChainParams) -> Self

Performs the conversion.

impl From<Network> for Chain

fn from(bn: Network) -> Self

Performs the conversion.

impl FromStr for Chain

type Err = ParseError

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 Chain

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for Chain

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Chain> for Chain

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Chain> for Chain

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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 StrictDecode for Chain

fn strict_decode<D: Read>(d: D) -> Result<Self, Error>

Decode with the given [std::io::Reader] instance; must either construct an instance or return implementation-specific error type.

pub fn strict_deserialize(data: impl AsRef<[u8]>) -> Result<Self, Error>

Tries to deserialize byte array into the current type using [strict_decode()]

impl StrictEncode for Chain

fn strict_encode<E: Write>(&self, e: E) -> Result<usize, Error>

Encode with the given [std::io::Writer] instance; must return result with either amount of bytes encoded – or implementation-specific error type.

pub fn strict_serialize(&self) -> Result<Vec<u8, Global>, Error>

Serializes data as a byte array using [strict_encode()] function