Struct bitcoins::nets::Bitcoin

pub struct Bitcoin<T: AddressEncoder>(_);

A newtype for Bitcoin networks, parameterized by an encoder. We change the encoder to differentiate between main, test, and signet.

Trait Implementations

impl<T> BitcoinNetwork for Bitcoin<T> where
    T: BitcoinEncoderMarker, 

type WTx = WitnessTx

An associated witness transaction type.

impl<T: Debug + AddressEncoder> Debug for Bitcoin<T>

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

Formats the value using the given formatter.

impl<T> Network for Bitcoin<T> where
    T: BitcoinEncoderMarker, 

type Address = Address

A type handling the network’s address semantics. This will typically represent some predicate on the transaction. It is used by both the Encoder and the Builder.

type Error = EncodingError

An error type that will be used by the Encoder, and returned by the passthrough encode_address and decode_address functions

type RecipientIdentifier = ScriptPubkey

A type representing the in-protocol recipient. This is usually different from the Address type.

type Encoder = T

An Encoder that uses the Address and Error types above. This Encoder must implement AddressEncoder. It handles translating the Address type to the networks RecipientIdentifier type.

type TxIn = BitcoinTxIn

A transaction Input type. This type is used within the Transaction and specificies UTXOs being spent by the transaction.

type TxOut = TxOut

A transaction Output type. This type is used within the Transaction and specificies UTXOs being consumed by the transaction.

type Tx = BitcoinTx

A Transaction type that uses the TxIn and TxOut.

type Builder = BitcoinTxBuilder<T>

A transaction Builder that uses the Encoder and Transaction types defined earlier. The builder is returned by Network::tx_builder(), and provides a convenient interface for transaction construction.

fn tx_builder() -> Self::Builder

Returns a new instance of the associated transaction builder.

fn builder_from_tx_ref(tx: &Self::Tx) -> Self::Builder

Instantiate a builder from a tx object

fn builder_from_tx(tx: Self::Tx) -> Self::Builder

Instantiate a builder from a tx object

fn builder_from_hex(
    hex_tx: &str
) -> Result<Self::Builder, <Self::Tx as Transaction>::TxError>

Instantiate a builder from a hex-serialized transaction

fn encode_address(
    a: &Self::RecipientIdentifier
) -> Result<Self::Address, Self::Error>

Encode an address using the network’s Address semantics

fn decode_address(addr: &Self::Address) -> Self::RecipientIdentifier

Decode an address using the network’s Address semantics

fn string_to_address(s: &str) -> Result<Self::Address, Self::Error>

Attempt to convert a string into an Address.