Struct breez_sdk_core::bitcoin::util::sighash::SighashCache
pub struct SighashCache<T>where
T: Deref<Target = Transaction>,{ /* private fields */ }
Expand description
Efficiently calculates signature hash message for legacy, segwit and taproot inputs.
Implementations§
§impl<R> SighashCache<R>where
R: Deref<Target = Transaction>,
impl<R> SighashCache<R>where
R: Deref<Target = Transaction>,
pub fn new(tx: R) -> SighashCache<R>
pub fn new(tx: R) -> SighashCache<R>
Constructs a new SighashCache
from an unsigned transaction.
The sighash components are computed in a lazy manner when required. For the generated sighashes to be valid, no fields in the transaction may change except for script_sig and witness.
pub fn taproot_encode_signing_data_to<Write, T>(
&mut self,
writer: Write,
input_index: usize,
prevouts: &Prevouts<'_, T>,
annex: Option<Annex<'_>>,
leaf_hash_code_separator: Option<(TapLeafHash, u32)>,
sighash_type: SchnorrSighashType,
) -> Result<(), Error>
pub fn taproot_encode_signing_data_to<Write, T>( &mut self, writer: Write, input_index: usize, prevouts: &Prevouts<'_, T>, annex: Option<Annex<'_>>, leaf_hash_code_separator: Option<(TapLeafHash, u32)>, sighash_type: SchnorrSighashType, ) -> Result<(), Error>
Encodes the BIP341 signing data for any flag type into a given object implementing a
io::Write
trait.
pub fn taproot_signature_hash<T>(
&mut self,
input_index: usize,
prevouts: &Prevouts<'_, T>,
annex: Option<Annex<'_>>,
leaf_hash_code_separator: Option<(TapLeafHash, u32)>,
sighash_type: SchnorrSighashType,
) -> Result<TapSighashHash, Error>
pub fn taproot_signature_hash<T>( &mut self, input_index: usize, prevouts: &Prevouts<'_, T>, annex: Option<Annex<'_>>, leaf_hash_code_separator: Option<(TapLeafHash, u32)>, sighash_type: SchnorrSighashType, ) -> Result<TapSighashHash, Error>
Computes the BIP341 sighash for any flag type.
pub fn taproot_key_spend_signature_hash<T>(
&mut self,
input_index: usize,
prevouts: &Prevouts<'_, T>,
sighash_type: SchnorrSighashType,
) -> Result<TapSighashHash, Error>
pub fn taproot_key_spend_signature_hash<T>( &mut self, input_index: usize, prevouts: &Prevouts<'_, T>, sighash_type: SchnorrSighashType, ) -> Result<TapSighashHash, Error>
Computes the BIP341 sighash for a key spend.
pub fn taproot_script_spend_signature_hash<S, T>(
&mut self,
input_index: usize,
prevouts: &Prevouts<'_, T>,
leaf_hash: S,
sighash_type: SchnorrSighashType,
) -> Result<TapSighashHash, Error>
pub fn taproot_script_spend_signature_hash<S, T>( &mut self, input_index: usize, prevouts: &Prevouts<'_, T>, leaf_hash: S, sighash_type: SchnorrSighashType, ) -> Result<TapSighashHash, Error>
Computes the BIP341 sighash for a script spend.
Assumes the default OP_CODESEPARATOR
position of 0xFFFFFFFF
. Custom values can be
provided through the more fine-grained API of SighashCache::taproot_encode_signing_data_to
.
pub fn segwit_encode_signing_data_to<Write>(
&mut self,
writer: Write,
input_index: usize,
script_code: &Script,
value: u64,
sighash_type: EcdsaSighashType,
) -> Result<(), Error>where
Write: Write,
pub fn segwit_encode_signing_data_to<Write>(
&mut self,
writer: Write,
input_index: usize,
script_code: &Script,
value: u64,
sighash_type: EcdsaSighashType,
) -> Result<(), Error>where
Write: Write,
Encodes the BIP143 signing data for any flag type into a given object implementing a
std::io::Write
trait.
pub fn segwit_signature_hash(
&mut self,
input_index: usize,
script_code: &Script,
value: u64,
sighash_type: EcdsaSighashType,
) -> Result<Sighash, Error>
pub fn segwit_signature_hash( &mut self, input_index: usize, script_code: &Script, value: u64, sighash_type: EcdsaSighashType, ) -> Result<Sighash, Error>
Computes the BIP143 sighash for any flag type.
pub fn legacy_encode_signing_data_to<Write, U>(
&self,
writer: Write,
input_index: usize,
script_pubkey: &Script,
sighash_type: U,
) -> EncodeSigningDataResult<Error>
pub fn legacy_encode_signing_data_to<Write, U>( &self, writer: Write, input_index: usize, script_pubkey: &Script, sighash_type: U, ) -> EncodeSigningDataResult<Error>
Encodes the legacy signing data for any flag type into a given object implementing a
std::io::Write
trait. Internally calls Transaction::encode_signing_data_to
.
§impl<R> SighashCache<R>where
R: DerefMut<Target = Transaction>,
impl<R> SighashCache<R>where
R: DerefMut<Target = Transaction>,
pub fn witness_mut(&mut self, input_index: usize) -> Option<&mut Witness>
pub fn witness_mut(&mut self, input_index: usize) -> Option<&mut Witness>
When the SighashCache
is initialized with a mutable reference to a transaction instead of
a regular reference, this method is available to allow modification to the witnesses.
This allows in-line signing such as
use bitcoin::blockdata::transaction::{Transaction, EcdsaSighashType};
use bitcoin::util::sighash::SighashCache;
use bitcoin::{PackedLockTime, Script};
let mut tx_to_sign = Transaction { version: 2, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: Vec::new() };
let input_count = tx_to_sign.input.len();
let mut sig_hasher = SighashCache::new(&mut tx_to_sign);
for inp in 0..input_count {
let prevout_script = Script::new();
let _sighash = sig_hasher.segwit_signature_hash(inp, &prevout_script, 42, EcdsaSighashType::All);
// ... sign the sighash
sig_hasher.witness_mut(inp).unwrap().push(&Vec::new());
}
Trait Implementations§
Auto Trait Implementations§
impl<T> Freeze for SighashCache<T>where
T: Freeze,
impl<T> RefUnwindSafe for SighashCache<T>where
T: RefUnwindSafe,
impl<T> Send for SighashCache<T>where
T: Send,
impl<T> Sync for SighashCache<T>where
T: Sync,
impl<T> Unpin for SighashCache<T>where
T: Unpin,
impl<T> UnwindSafe for SighashCache<T>where
T: UnwindSafe,
Blanket Implementations§
§impl<T> AnySync for T
impl<T> AnySync for T
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Downcast for Twhere
T: AsAny + ?Sized,
impl<T> Downcast for Twhere
T: AsAny + ?Sized,
§fn downcast_ref<T>(&self) -> Option<&T>where
T: AsAny,
fn downcast_ref<T>(&self) -> Option<&T>where
T: AsAny,
Any
.§fn downcast_mut<T>(&mut self) -> Option<&mut T>where
T: AsAny,
fn downcast_mut<T>(&mut self) -> Option<&mut T>where
T: AsAny,
Any
.§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
source§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T
in a tonic::Request