Struct BitcoinTransactionInput

pub struct BitcoinTransactionInput<N: BitcoinNetwork> {

    pub outpoint: Outpoint,
    pub balance: Option<BitcoinAmount>,
    pub address: Option<BitcoinAddress<N>>,
    pub format: Option<BitcoinFormat>,
    pub script_pub_key: Option<Vec<u8>>,
    pub redeem_script: Option<Vec<u8>>,
    pub script_sig: Vec<u8>,
    pub sequence: Vec<u8>,
    pub sighash_code: SignatureHash,
    pub witnesses: Vec<Vec<u8>>,
    pub is_signed: bool,
    pub additional_witness: Option<(Vec<u8>, bool)>,
    pub witness_script_data: Option<Vec<u8>>,
}

Represents a Bitcoin transaction input

Fields

outpoint: Outpoint

The outpoint (36 bytes)

balance: Option<BitcoinAmount>

The balance of the utxo pointed by this input (used for SegWit transaction signatures)

address: Option<BitcoinAddress<N>>

The address of the utxo pointed by this input

format: Option<BitcoinFormat>

The address format of the utxo pointed by this input

script_pub_key: Option<Vec<u8>>

The ‘scriptPubkey’ of the utxo pointed by this input

redeem_script: Option<Vec<u8>>

An optional redeem script in case of an SegWit utxo

script_sig: Vec<u8>

The transaction input script (variable size)

sequence: Vec<u8>

The sequence number (4 bytes) (0xFFFFFFFF unless lock > 0) Also used in replace-by-fee (BIP 125)

sighash_code: SignatureHash

The signature hash (4 bytes) (used in signing raw transaction only)

witnesses: Vec<Vec<u8>>

The witnesses in a SegWit transaction

is_signed: bool

If true, the input has been signed

additional_witness: Option<(Vec<u8>, bool)>

Provide more flexibility for multiple signatures (for P2WSH)

witness_script_data: Option<Vec<u8>>

Option for additional witness stack script args

Implementations

impl<N: BitcoinNetwork> BitcoinTransactionInput<N>

pub fn new( transaction_id: Vec<u8>, index: u32, public_key: Option<BitcoinPublicKey<N>>, format: Option<BitcoinFormat>, address: Option<BitcoinAddress<N>>, balance: Option<BitcoinAmount>, sighash: SignatureHash, ) -> Result<Self, TransactionError>

Returns a new Bitcoin transaction input.

pub fn set_public_key( &mut self, public_key: BitcoinPublicKey<N>, format: BitcoinFormat, ) -> Result<(), TransactionError>

pub fn set_redeem_script( &mut self, redeem_script: Vec<u8>, ) -> Result<(), TransactionError>

pub fn set_format( &mut self, format: BitcoinFormat, ) -> Result<(), TransactionError>

pub fn set_balance(&mut self, balance: i64) -> Result<(), TransactionError>

pub fn set_sequence(&mut self, sequence: u32) -> Result<(), TransactionError>

pub fn set_sighash( &mut self, sighash: SignatureHash, ) -> Result<(), TransactionError>

pub fn get_address(&self) -> Option<BitcoinAddress<N>>

pub fn get_format(&self) -> Option<BitcoinFormat>

pub fn get_balance(&self) -> Option<BitcoinAmount>

pub fn get_sequence(&self) -> u32

pub fn get_sighash(&self) -> SignatureHash

pub fn read<R: Read>(reader: &mut R) -> Result<Self, TransactionError>

Read and output a Bitcoin transaction input

pub fn serialize(&self, raw: bool) -> Result<Vec<u8>, TransactionError>

Returns the serialized transaction input.

pub fn sign( &mut self, signature: Vec<u8>, public_key: Vec<u8>, ) -> Result<(), TransactionError>

Insert ‘signature’ and ‘public_key’ into this input to make it signed

Trait Implementations

impl<N: Clone + BitcoinNetwork> Clone for BitcoinTransactionInput<N>

fn clone(&self) -> BitcoinTransactionInput<N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N: Debug + BitcoinNetwork> Debug for BitcoinTransactionInput<N>

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

Formats the value using the given formatter.

impl<N: PartialEq + BitcoinNetwork> PartialEq for BitcoinTransactionInput<N>

fn eq(&self, other: &BitcoinTransactionInput<N>) -> 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<N: Eq + BitcoinNetwork> Eq for BitcoinTransactionInput<N>

impl<N: BitcoinNetwork> StructuralPartialEq for BitcoinTransactionInput<N>