Struct elements::TxIn

pub struct TxIn {
    pub previous_output: OutPoint,
    pub is_pegin: bool,
    pub script_sig: Script,
    pub sequence: Sequence,
    pub asset_issuance: AssetIssuance,
    pub witness: TxInWitness,
}

A transaction input, which defines old coins to be consumed

Fields

previous_output: OutPoint

The reference to the previous output that is being used an an input

is_pegin: bool

Flag indicating that previous_outpoint refers to something on the main chain

script_sig: Script

The script which pushes values on the stack which will cause the referenced output’s script to accept

sequence: Sequence

The sequence number, which suggests to miners which of two conflicting transactions should be preferred, or 0xFFFFFFFF to ignore this feature. This is generally never used since the miner behaviour cannot be enforced.

asset_issuance: AssetIssuance

Asset issuance data

witness: TxInWitness

Witness data - not deserialized/serialized as part of a TxIn object (rather as part of its containing transaction, if any) but is logically part of the txin.

Implementations

impl TxIn

pub fn is_coinbase(&self) -> bool

Whether the input is a coinbase

pub fn is_pegin(&self) -> bool

Whether the input is a pegin

pub fn pegin_prevout(&self) -> Option<OutPoint>

In case of a pegin input, returns the Bitcoin prevout.

pub fn pegin_data(&self) -> Option<PeginData<'_>>

Extracts witness data from a pegin. Will return None if any data cannot be parsed. The combination of is_pegin() returning true and pegin_data() returning None indicates an invalid transaction.

pub fn has_issuance(&self) -> bool

Helper to determine whether an input has an asset issuance attached

pub fn outpoint_flag(&self) -> u8

Obtain the outpoint flag corresponding to this input

pub fn issuance_ids(&self) -> (AssetId, AssetId)

Compute the issuance asset ids from this TxIn. This function does not check whether there is an issuance in this input. Returns (asset_id, token_id)

impl TxIn

pub fn blind_issuances_with_bfs<C: Signing>( &mut self, secp: &Secp256k1<C>, issue_vbf: ValueBlindingFactor, token_vbf: ValueBlindingFactor, issue_sk: SecretKey, token_sk: SecretKey ) -> Result<(), BlindError>

Blind issuances for this TxIn. Asset amount and token amount must be set in AssetIssuance field for this input

pub fn blind_issuances<C: Signing, R: RngCore + CryptoRng>( &mut self, secp: &Secp256k1<C>, rng: &mut R ) -> Result<(ValueBlindingFactor, SecretKey, ValueBlindingFactor, SecretKey), BlindError>

Blind issuances for this TxIn. Asset amount and token amount must be set in AssetIssuance field for this input

Returns (issuance_blinding_factor, issue_blind_sec_key, token_blinding_factor, token_blind_sec_key)

Trait Implementations

impl Clone for TxIn

fn clone(&self) -> TxIn

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TxIn

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

Formats the value using the given formatter.

impl Decodable for TxIn

fn consensus_decode<D: Read>(d: D) -> Result<TxIn, Error>

Decode an object with a well-defined format

impl Default for TxIn

fn default() -> Self

Returns the “default value” for a type.

impl Encodable for TxIn

fn consensus_encode<S: Write>(&self, s: S) -> Result<usize, Error>

Encode an object with a well-defined format, should only ever error if the underlying Write errors. Returns the number of bytes written on success

impl Hash for TxIn

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 TxIn

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for TxIn

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

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

impl StructuralPartialEq for TxIn