Struct lnpbp_chain::ChainParams

pub struct ChainParams {

    pub genesis_hash: BlockHash,
    pub name: String,
    pub p2p_magic: P2pNetworkId,
    pub bip70_name: String,
    pub bip173_prefix: String,
    pub p2p_port: u16,
    pub rpc_port: u16,
    pub ln_height: u32,
    pub rgb_height: u32,
    pub format: ChainFormat,
    pub dust_limit: u64,
    pub native_asset: AssetParams,
    pub is_testnet: bool,
    pub is_pow: bool,
}

Full set of parameters which uniquely define given blockchain, corresponding P2P network and RPC interface of fully validating nodes

Fields

genesis_hash: BlockHash

Hash of the genesis block, uniquely defining chain

name: String

Blockchain name, including version:

• mainnet for Bitcoin mainnet
• testnet3 for Bitcoin testnet version 3
• regtest for Bitcoin regtest networks
• signet for Bitcoin signet and private signet networks
• liquidv1 for Liquid network v1

p2p_magic: P2pNetworkId

Magic number used as prefix in P2P network API

bip70_name: String

Network name according to BIP 70, which may be different from ChainParams::name. Not widely used these days, but we still have to account for standard.

bip173_prefix: String

HRP bech32 address prefix as defined in BIP 173

p2p_port: u16

Default port for P2P network

rpc_port: u16

Default port for full validating node RPC interface

ln_height: u32

Block number from which Lightning network support had started using the given chain

rgb_height: u32

Block number from which RGB had started using the given chain

format: ChainFormat

Format of chain-specific data. See ChainFormat for more information

dust_limit: u64

Dust limit for the given chain; 0 if none dust limit applies

native_asset: AssetParams

Parameters of the native chain asset (can be only one; it is the asset in which miners are got paid).

is_testnet: bool

Flag indicating any kind of testnet network that do not operate with real economic values

is_pow: bool

Flag indicating blockchains that use PoW consensus algorithm

Trait Implementations

impl Clone for ChainParams

fn clone(&self) -> ChainParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChainParams

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

Formats the value using the given formatter.

impl Display for ChainParams

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

Formats the value using the given formatter.

impl From<&ChainParams> for Chain

fn from(params: &ChainParams) -> Self

Converts to this type from the input type.

impl From<ChainParams> for Chain

fn from(params: ChainParams) -> Self

Converts to this type from the input type.

impl Hash for ChainParams

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 ChainParams

fn cmp(&self, other: &ChainParams) -> 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<ChainParams> for ChainParams

fn eq(&self, other: &Self) -> 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<ChainParams> for ChainParams

fn partial_cmp(&self, other: &ChainParams) -> 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 StrictDecode for ChainParams

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

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

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

Tries to deserialize byte array into the current type using StrictDecode::strict_decode. If there are some data remains in the buffer once deserialization is completed, fails with Error::DataNotEntirelyConsumed. Use io::Cursor over the buffer and StrictDecode::strict_decode to avoid such failures.

fn strict_file_load(path: impl AsRef<Path>) -> Result<Self, Error>

Reads data from file at path and reconstructs object from it. Fails with Error::DataNotEntirelyConsumed if file contains remaining data after the object reconstruction.

impl StrictEncode for ChainParams

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

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

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

Serializes data as a byte array using StrictEncode::strict_encode function

fn strict_file_save(&self, path: impl AsRef<Path>) -> Result<usize, Error>

Saves data to a file at a given path. If the file does not exists, attempts to create the file. If the file already exists, it gets truncated.

impl Eq for ChainParams