Struct Input

pub struct Input {

    pub non_witness_utxo: Option<Arc<Transaction>>,
    pub witness_utxo: Option<TxOut>,
    pub partial_sigs: HashMap<String, Vec<u8>>,
    pub sighash_type: Option<String>,
    pub redeem_script: Option<Arc<Script>>,
    pub witness_script: Option<Arc<Script>>,
    pub bip32_derivation: HashMap<String, KeySource>,
    pub final_script_sig: Option<Arc<Script>>,
    pub final_script_witness: Option<Vec<Vec<u8>>>,
    pub ripemd160_preimages: HashMap<String, Vec<u8>>,
    pub sha256_preimages: HashMap<String, Vec<u8>>,
    pub hash160_preimages: HashMap<String, Vec<u8>>,
    pub hash256_preimages: HashMap<String, Vec<u8>>,
    pub tap_key_sig: Option<Vec<u8>>,
    pub tap_script_sigs: HashMap<TapScriptSigKey, Vec<u8>>,
    pub tap_scripts: HashMap<ControlBlock, TapScriptEntry>,
    pub tap_key_origins: HashMap<String, TapKeyOrigin>,
    pub tap_internal_key: Option<String>,
    pub tap_merkle_root: Option<String>,
    pub proprietary: HashMap<ProprietaryKey, Vec<u8>>,
    pub unknown: HashMap<Key, Vec<u8>>,
}

A key-value map for an input of the corresponding index in the unsigned transaction.

Fields

non_witness_utxo: Option<Arc<Transaction>>

The non-witness transaction this input spends from. Should only be Option::Some for inputs which spend non-segwit outputs or if it is unknown whether an input spends a segwit output.

witness_utxo: Option<TxOut>

The transaction output this input spends from. Should only be Option::Some for inputs which spend segwit outputs, including P2SH embedded ones.

partial_sigs: HashMap<String, Vec<u8>>

A map from public keys to their corresponding signature as would be pushed to the stack from a scriptSig or witness for a non-taproot inputs.

sighash_type: Option<String>

The sighash type to be used for this input. Signatures for this input must use the sighash type.

redeem_script: Option<Arc<Script>>

The redeem script for this input.

witness_script: Option<Arc<Script>>

The witness script for this input.

bip32_derivation: HashMap<String, KeySource>

A map from public keys needed to sign this input to their corresponding master key fingerprints and derivation paths.

final_script_sig: Option<Arc<Script>>

The finalized, fully-constructed scriptSig with signatures and any other scripts necessary for this input to pass validation.

final_script_witness: Option<Vec<Vec<u8>>>

The finalized, fully-constructed scriptWitness with signatures and any other scripts necessary for this input to pass validation.

ripemd160_preimages: HashMap<String, Vec<u8>>

RIPEMD160 hash to preimage map.

sha256_preimages: HashMap<String, Vec<u8>>

SHA256 hash to preimage map.

hash160_preimages: HashMap<String, Vec<u8>>

HASH160 hash to preimage map.

hash256_preimages: HashMap<String, Vec<u8>>

HASH256 hash to preimage map.

tap_key_sig: Option<Vec<u8>>

Serialized taproot signature with sighash type for key spend.

tap_script_sigs: HashMap<TapScriptSigKey, Vec<u8>>

Map of <xonlypubkey>|<leafhash> with signature.

tap_scripts: HashMap<ControlBlock, TapScriptEntry>

Map of Control blocks to Script version pair.

tap_key_origins: HashMap<String, TapKeyOrigin>

Map of tap root x only keys to origin info and leaf hashes contained in it.

tap_internal_key: Option<String>

Taproot Internal key.

tap_merkle_root: Option<String>

Taproot Merkle root.

proprietary: HashMap<ProprietaryKey, Vec<u8>>

Proprietary key-value pairs for this input.

unknown: HashMap<Key, Vec<u8>>

Unknown key-value pairs for this input.

Trait Implementations

impl Clone for Input

fn clone(&self) -> Input

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<UT> ConvertError<UT> for Input

fn try_convert_unexpected_callback_error( e: UnexpectedUniFFICallbackError, ) -> Result<Self>

impl Debug for Input

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

Formats the value using the given formatter.

impl<UT> FfiConverter<UT> for Input

const TYPE_ID_META: MetadataBuffer

Type ID metadata, serialized into a [MetadataBuffer].

type FfiType = RustBuffer

The low-level type used for passing values of this type over the FFI.

fn lower(v: Self) -> RustBuffer

Lower a rust value of the target type, into an FFI value of type Self::FfiType.

fn try_lift(buf: RustBuffer) -> Result<Self>

Lift a rust value of the target type, from an FFI value of type Self::FfiType.

fn write(obj: Self, buf: &mut Vec<u8>)

Write a rust value into a buffer, to send over the FFI in serialized form.

fn try_read(buf: &mut &[u8]) -> Result<Self>

Read a rust value from a buffer, received over the FFI in serialized form.

impl From<&Input> for Input

fn from(input: &BdkInput) -> Self

Converts to this type from the input type.

impl<UT> Lift<UT> for Input

type FfiType = <Input as FfiConverter<UT>>::FfiType

fn try_lift(v: Self::FfiType) -> Result<Self>

fn try_read(buf: &mut &[u8]) -> Result<Self>

fn try_lift_from_rust_buffer(v: RustBuffer) -> Result<Self, Error>

Convenience method

impl<UT> LiftRef<UT> for Input

type LiftType = Input

impl<UT> LiftReturn<UT> for Input

type ReturnType = <Input as Lift<UT>>::FfiType

FFI return type for trait interfaces

fn try_lift_successful_return(v: Self::ReturnType) -> Result<Self>

Lift a successfully returned value from a trait interface

fn lift_foreign_return( ffi_return: Self::ReturnType, call_status: RustCallStatus, ) -> Self

Lift a foreign returned value from a trait interface

fn lift_error(_buf: RustBuffer) -> Self

Lift a Rust value for a callback interface method error result

fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self

Lift a Rust value for an unexpected callback interface error

impl<UT> Lower<UT> for Input

type FfiType = <Input as FfiConverter<UT>>::FfiType

fn lower(obj: Self) -> Self::FfiType

fn write(obj: Self, buf: &mut Vec<u8>)

fn lower_into_rust_buffer(obj: Self) -> RustBuffer

Convenience method

impl<UT> LowerError<UT> for Input

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for Input

type ReturnType = <Input as Lower<UT>>::FfiType

The type that should be returned by scaffolding functions for this type.

fn lower_return(v: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl<UT> TypeId<UT> for Input

const TYPE_ID_META: MetadataBuffer