Struct WalletVtxo

pub struct WalletVtxo {
    pub vtxo: Vtxo,
    pub state: VtxoState,
}

A wallet-owned Vtxo paired with its current tracked state.

Fields

vtxo: Vtxo

The underlying Vtxo.

state: VtxoState

The current tracked state for WalletVtxo::vtxo.

Methods from Deref<Target = Vtxo>

pub fn id(&self) -> VtxoId

Get the identifier for this Vtxo.

This is the same as Vtxo::point but encoded as a byte array.

pub fn spec(&self) -> VtxoSpec

Get the spec for this VTXO.

pub fn point(&self) -> OutPoint

The outpoint from which to build forfeit or arkoor txs.

This can be an on-chain utxo or an off-chain vtxo.

pub fn amount(&self) -> Amount

The amount of the Vtxo.

pub fn chain_anchor(&self) -> OutPoint

The UTXO that should be confirmed for this Vtxo to be valid.

It is the very root of the VTXO.

pub fn policy(&self) -> &VtxoPolicy

The output policy of this VTXO.

pub fn policy_type(&self) -> VtxoPolicyKind

The output policy type of this VTXO.

pub fn expiry_height(&self) -> u32

The expiry height of the Vtxo.

pub fn server_pubkey(&self) -> PublicKey

The server pubkey used in arkoor transitions.

pub fn exit_delta(&self) -> u16

The relative timelock block delta used for exits.

pub fn exit_depth(&self) -> u16

Returns the total exit depth (including OOR depth) of the vtxo.

pub fn server_htlc_out_payment_hash(&self) -> Option<PaymentHash>

Get the payment hash if this vtxo is an HTLC send arkoor vtxo.

pub fn arkoor_pubkey(&self) -> Option<PublicKey>

The public key used to cosign arkoor txs spending this Vtxo. This will return None if [Vtxo::is_arkoor_compatible] returns false.

pub fn past_arkoor_pubkeys(&self) -> impl Iterator<Item = PublicKey>

Iterate over all arkoor pubkeys in the arkoor chain of this vtxo.

This does not include the current arkoor pubkey, for that use Vtxo::arkoor_pubkey.

pub fn user_pubkey(&self) -> PublicKey

Returns the user pubkey associated with this Vtxo.

pub fn output_taproot(&self) -> TaprootSpendInfo

The taproot spend info for the output of this Vtxo.

pub fn output_script_pubkey(&self) -> ScriptBuf

The scriptPubkey of the output of this Vtxo.

pub fn txout(&self) -> TxOut

The transaction output (eventual UTXO) of this Vtxo.

pub fn is_fully_signed(&self) -> bool

Whether this VTXO is fully signed

It is possible to represent unsigned VTXOs, for which this method will return false.

pub fn transactions(&self) -> VtxoTxIter<'_>

Iterator that constructs all the exit txs for this Vtxo.

pub fn claim_satisfaction_weight(&self) -> Weight

The satisfaction weight required to spend the output when doing a unilateral exit.

pub fn arkoor_pubkeys(&self) -> HashSet<PublicKey>

The set of all arkoor pubkeys present in the arkoor part of the VTXO exit path.

pub fn validate( &self, chain_anchor_tx: &Transaction, ) -> Result<(), VtxoValidationError>

Fully validate this VTXO and its entire transaction chain.

The chain_anchor_tx must be the tx with txid matching Vtxo::chain_anchor.

Trait Implementations

impl Clone for WalletVtxo

fn clone(&self) -> WalletVtxo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WalletVtxo

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

Formats the value using the given formatter.

impl PartialEq for WalletVtxo

fn eq(&self, other: &WalletVtxo) -> 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<'a> VtxoRef for &'a WalletVtxo

fn vtxo_id(&self) -> VtxoId

The VtxoId of the VTXO

fn vtxo(&self) -> Option<&Vtxo>

If the Vtxo can be provided, provides it

impl VtxoRef for WalletVtxo

fn vtxo_id(&self) -> VtxoId

The VtxoId of the VTXO

fn vtxo(&self) -> Option<&Vtxo>

If the Vtxo can be provided, provides it

impl Deref for WalletVtxo

type Target = Vtxo

The resulting type after dereferencing.

fn deref(&self) -> &Vtxo

Dereferences the value.

impl Eq for WalletVtxo

impl StructuralPartialEq for WalletVtxo