Enum bitcoins::types::tx::BitcoinTx

pub enum BitcoinTx {
    Witness(WitnessTx),
    Legacy(LegacyTx),
}

Wrapper enum for returning values that may be EITHER a Witness OR a Legacy tx and the type is not known in advance. While a few transaction methods have been implemented for convenience, This wrapper must be explicitly unwrapped before the tx object can be signed.

Variants

Witness(WitnessTx)

Tuple Fields

0: WitnessTx

Witness

Legacy(LegacyTx)

Tuple Fields

0: LegacyTx

Legacy

Implementations

impl BitcoinTx

pub fn is_witness(&self) -> bool

True if the wrapped tx is a witness transaction. False otherwise

pub fn is_legacy(&self) -> bool

True if the wrapped tx is a legacy transaction. False otherwise

Trait Implementations

impl BitcoinTransaction for BitcoinTx

fn as_legacy(&self) -> &LegacyTx

Returns a reference to the tx as a legacy tx.

fn witnesses(&self) -> &[Witness]

Return a reference to a slice of witnesses. For legacy txins this will ALWAYS be length 0. For witness txns, this will ALWAYS be the same length as the input vector.

fn into_legacy(self) -> LegacyTx

Consume the tx and convert it to a legacy tx. Useful for when you have dyn BitcoinTransaction or impl BitcoinTransaction types, but into_witness should be preferred, as it will never drop information.

fn into_witness(self) -> WitnessTx

Consume the tx and convert it to a legacy tx. Useful for when you have dyn BitcoinTransaction or impl BitcoinTransaction types.

fn txout_from_outpoint(&self, outpoint: &BitcoinOutpoint) -> Option<&TxOut>

Get a reference to the output by

impl ByteFormat for BitcoinTx

fn serialized_length(&self) -> usize

Returns the byte-length of the serialized data structure.

type Error = TxError

An associated error type

fn read_from<R>(reader: &mut R) -> Result<Self, Self::Error> where
    R: Read,
    Self: Sized, 

Deserializes an instance of Self from a std::io::Read. The limit argument is used only when deserializing collections, and specifies a maximum number of instances of the underlying type to read.

fn write_to<W>(
    &self,
    writer: &mut W
) -> Result<usize, <Self as ByteFormat>::Error> where
    W: Write, 

Serializes self to a std::io::Write. Following Write trait conventions, its Ok type must be a usize denoting the number of bytes written.

fn read_seq_from<R>(
    reader: &mut R,
    mode: ReadSeqMode
) -> Result<Vec<Self, Global>, Self::Error> where
    R: Read, 

Read a sequence of exactly limit objects from the reader.

fn write_seq_to<'a, W, E, Iter, Item>(
    writer: &mut W,
    iter: Iter
) -> Result<usize, Self::Error> where
    W: Write,
    E: Into<Self::Error> + From<SerError> + From<Error> + Error,
    Item: 'a + ByteFormat<Error = E>,
    Iter: IntoIterator<Item = &'a Item>, 

Write a sequence of ByteFormat objects to a writer. The iter argument may be any object that implements IntoIterator<Item = &Item>. This means we can seamlessly use vectors, slices, etc.

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

Decodes a hex string to a Vec<u8>, deserializes an instance of Self from that vector.

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

Serialize self to a base64 string, using standard RFC4648 non-url safe characters

fn serialize_hex(&self) -> String

Serializes self to a vector, returns the hex-encoded vector

fn serialize_base64(&self) -> String

Serialize self to a base64 string, using standard RFC4648 non-url safe characters

impl Clone for BitcoinTx

fn clone(&self) -> BitcoinTx

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BitcoinTx

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

Formats the value using the given formatter.

impl Default for BitcoinTx

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BitcoinTx

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

Deserialize this value from the given Serde deserializer.

impl From<LegacyTx> for BitcoinTx

fn from(w: LegacyTx) -> Self

Performs the conversion.

impl From<WitnessTx> for BitcoinTx

fn from(w: WitnessTx) -> Self

Performs the conversion.

impl PartialEq<BitcoinTx> for BitcoinTx

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

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

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

This method tests for !=.

impl Serialize for BitcoinTx

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

Serialize this value into the given Serde serializer.

impl Transaction for BitcoinTx

fn new<I, O>(
    version: u32,
    vin: I,
    vout: O,
    locktime: u32
) -> Result<Self, Self::TxError> where
    I: Into<Vec<BitcoinTxIn>>,
    O: Into<Vec<TxOut>>,
    Self: Sized, 

Instantiate a new BitcoinTx. This always returns a BitcoinTx::Legacy

fn version(&self) -> u32

Get the version number from the underlying tx

fn inputs(&self) -> &[BitcoinTxIn]

Get the inputs from the underlying tx

fn outputs(&self) -> &[TxOut]

Get the outputs from the underlying tx

fn locktime(&self) -> u32

Get the locktime from the underlying tx

fn txid(&self) -> TXID

Return the TXID of the transaction

fn write_sighash_preimage<W: Write>(
    &self,
    writer: &mut W,
    args: &Self::SighashArgs
) -> Result<(), Self::TxError>

Return the TXID of the transaction

type TxError = TxError

An associated error type, used in Results returned by the Transaction.

type TXID = TXID

A marked hash (see crate::hashes::marked) to be used as the transaction ID type.

type TxOut = TxOut

The Output type for the transaction

type TxIn = BitcoinTxIn

The Input type for the transaction

type HashWriter = Hash256

A type that implements HashWriter. Used to generate the TXID and Sighash.

type SighashArgs = WitnessSighashArgs

A type describing arguments for the sighash function for this transaction.

fn sighash(
    &self,
    args: &Self::SighashArgs
) -> Result<GenericArray<u8, <Self::HashWriter as Digest>::OutputSize>, Self::TxError>

Calls write_sighash_preimage with the provided arguments and a new HashWriter. Returns the sighash digest which should be signed.

impl Eq for BitcoinTx

impl StructuralEq for BitcoinTx

impl StructuralPartialEq for BitcoinTx