Skip to main content

VhtlcScript

Struct VhtlcScript 

Source
pub struct VhtlcScript { /* private fields */ }
Expand description

VHTLC Script builder and manager

This struct creates and manages VHTLC scripts with six different spending paths:

  1. Claim: Receiver reveals preimage (collaborative with server)
  2. Refund: Collaborative refund (all three parties)
  3. Refund without Receiver: Sender refunds after locktime (with server)
  4. Unilateral Claim: Receiver claims after delay (no server needed)
  5. Unilateral Refund: Collaborative unilateral refund after delay
  6. Unilateral Refund without Receiver: Sender unilateral refund after both timeouts

Implementations§

Source§

impl VhtlcScript

Source

pub fn new(options: VhtlcOptions, network: Network) -> Result<Self, VhtlcError>

Creates a new VHTLC script with the given options

This will validate the options and build the complete taproot tree with all spending paths.

Source

pub fn taproot_spend_info(&self) -> &TaprootSpendInfo

Source

pub fn script_pubkey(&self) -> ScriptBuf

Source

pub fn address(&self) -> ArkAddress

Source

pub fn claim_script(&self) -> ScriptBuf

Creates the claim script where receiver reveals the preimage

Requires: preimage hash verification + receiver signature + server signature

Source

pub fn refund_script(&self) -> ScriptBuf

Creates the collaborative refund script

Requires: sender + receiver + server signatures

Source

pub fn refund_without_receiver_script(&self) -> ScriptBuf

Creates the refund script when receiver is unavailable

Requires: CLTV timeout + sender + server signatures

Source

pub fn unilateral_claim_script(&self) -> ScriptBuf

Creates the unilateral claim script (no server cooperation needed)

Requires: preimage hash verification + CSV delay + receiver signature

Source

pub fn unilateral_refund_script(&self) -> ScriptBuf

Creates the unilateral refund script

Requires: CSV delay + sender + receiver signatures

Source

pub fn unilateral_refund_without_receiver_script(&self) -> ScriptBuf

Creates the unilateral refund script when receiver is unavailable

Requires: CSV delay + sender signature

Source

pub fn get_script_map(&self) -> BTreeMap<String, ScriptBuf>

Source

pub fn tapscripts(self) -> Vec<ScriptBuf>

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more