Enum VtxoPolicy

pub enum VtxoPolicy {
    Pubkey(PubkeyVtxoPolicy),
    Checkpoint(CheckpointVtxoPolicy),
    ServerHtlcSend(ServerHtlcSendVtxoPolicy),
    ServerHtlcRecv(ServerHtlcRecvVtxoPolicy),
}

The output policy of the VTXO.

Variants

Pubkey(PubkeyVtxoPolicy)

Standard VTXO output protected with a public key.

This can be the result of either:

• a board
• a round
• an arkoor tx
• change from a LN payment

Checkpoint(CheckpointVtxoPolicy)

A policy which returns all funds to the server after expiry

ServerHtlcSend(ServerHtlcSendVtxoPolicy)

A VTXO that represents an HTLC with the Ark server to send money.

ServerHtlcRecv(ServerHtlcRecvVtxoPolicy)

A VTXO that represents an HTLC with the Ark server to receive money.

Implementations

impl VtxoPolicy

pub fn new_pubkey(user_pubkey: PublicKey) -> Self

pub fn new_checkpoint(user_pubkey: PublicKey) -> Self

pub fn new_server_htlc_send( user_pubkey: PublicKey, payment_hash: PaymentHash, htlc_expiry: BlockHeight, ) -> Self

pub fn new_server_htlc_recv( user_pubkey: PublicKey, payment_hash: PaymentHash, htlc_expiry: BlockHeight, htlc_expiry_delta: BlockDelta, ) -> Self

Creates a new htlc from server to client

• user_pubkey: A public key owned by the client
• payment_hash: The payment hash, the client can claim the HTLC by revealing the corresponding pre-image
• htlc_expiry: An absolute blockheight at which the HTLC expires
• htlc_expiry_delta: A safety margin for the server. If the user tries to exit after time-out the server will have at-least htlc_expiry_delta blocks to claim the payment

pub fn as_pubkey(&self) -> Option<&PubkeyVtxoPolicy>

pub fn as_server_htlc_send(&self) -> Option<&ServerHtlcSendVtxoPolicy>

pub fn as_server_htlc_recv(&self) -> Option<&ServerHtlcRecvVtxoPolicy>

pub fn policy_type(&self) -> VtxoPolicyKind

The policy type id.

pub fn is_arkoor_compatible(&self) -> bool

Whether a Vtxo with this output can be spend in an arkoor tx.

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

The public key used to cosign arkoor txs spending a Vtxo with this output. This will return None if VtxoPolicy::is_arkoor_compatible returns false.

pub fn user_pubkey(&self) -> PublicKey

Returns the user pubkey associated with a Vtxo with this output.

pub fn taproot( &self, server_pubkey: PublicKey, exit_delta: BlockDelta, expiry_height: BlockHeight, ) -> TaprootSpendInfo

pub fn clauses( &self, exit_delta: u16, expiry_height: BlockHeight, server_pubkey: PublicKey, ) -> Vec<VtxoClause>

Trait Implementations

impl Clone for VtxoPolicy

fn clone(&self) -> VtxoPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VtxoPolicy

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

Formats the value using the given formatter.

impl From<CheckpointVtxoPolicy> for VtxoPolicy

fn from(policy: CheckpointVtxoPolicy) -> Self

Converts to this type from the input type.

impl From<PubkeyVtxoPolicy> for VtxoPolicy

fn from(policy: PubkeyVtxoPolicy) -> Self

Converts to this type from the input type.

impl From<ServerHtlcRecvVtxoPolicy> for VtxoPolicy

fn from(policy: ServerHtlcRecvVtxoPolicy) -> Self

Converts to this type from the input type.

impl From<ServerHtlcSendVtxoPolicy> for VtxoPolicy

fn from(policy: ServerHtlcSendVtxoPolicy) -> Self

Converts to this type from the input type.

impl Hash for VtxoPolicy

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 VtxoPolicy

fn cmp(&self, other: &VtxoPolicy) -> 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,

Restrict a value to a certain interval.

impl PartialEq for VtxoPolicy

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

fn partial_cmp(&self, other: &VtxoPolicy) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl ProtocolEncoding for VtxoPolicy

fn encode<W: Write + ?Sized>(&self, w: &mut W) -> Result<(), Error>

Encode the object into the writer.

fn decode<R: Read + ?Sized>(r: &mut R) -> Result<Self, ProtocolDecodingError>

Decode the object from the writer.

fn serialize(&self) -> Vec<u8>

Serialize the object into a byte vector.

fn deserialize(byte_slice: &[u8]) -> Result<Self, ProtocolDecodingError>

Deserialize object from the given byte slice.

fn serialize_hex(&self) -> String

Serialize the object to a lowercase hex string.

fn deserialize_hex(hex_str: &str) -> Result<Self, ProtocolDecodingError>

Deserialize object from hex slice.

impl Eq for VtxoPolicy

impl StructuralPartialEq for VtxoPolicy