Enum ServerVtxoPolicy

pub enum ServerVtxoPolicy {
    User(VtxoPolicy),
    Checkpoint(CheckpointVtxoPolicy),
    Expiry(ExpiryVtxoPolicy),
    HarkLeaf(HarkLeafVtxoPolicy),
    HarkForfeit(HarkForfeitVtxoPolicy),
}

Server-internal VTXO policy.

This is a superset of VtxoPolicy used by the server for internal tracking. Includes policies without user public keys.

Variants

User(VtxoPolicy)

Wraps any user-facing policy.

Checkpoint(CheckpointVtxoPolicy)

A policy which returns all coins to the server after expiry.

Expiry(ExpiryVtxoPolicy)

Server-only policy where coins can only be swept by the server after expiry.

HarkLeaf(HarkLeafVtxoPolicy)

hArk leaf output policy (intermediate outputs spent by leaf txs).

HarkForfeit(HarkForfeitVtxoPolicy)

hArk forfeit tx output policy

Implementations

impl ServerVtxoPolicy

pub fn new_checkpoint(user_pubkey: PublicKey) -> Self

pub fn new_expiry(internal_key: XOnlyPublicKey) -> Self

pub fn new_hark_leaf(user_pubkey: PublicKey, unlock_hash: UnlockHash) -> Self

pub fn new_hark_forfeit(user_pubkey: PublicKey, unlock_hash: UnlockHash) -> Self

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 spent in an arkoor tx.

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

Returns the user pubkey if this policy has one.

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

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

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

pub fn is_user_policy(&self) -> bool

Check whether this is a user policy

pub fn into_user_policy(self) -> Option<VtxoPolicy>

Try to convert to a user policy if it is one

Trait Implementations

impl Clone for ServerVtxoPolicy

fn clone(&self) -> ServerVtxoPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ServerVtxoPolicy

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

Formats the value using the given formatter.

impl From<CheckpointVtxoPolicy> for ServerVtxoPolicy

fn from(policy: CheckpointVtxoPolicy) -> Self

Converts to this type from the input type.

impl From<HarkForfeitVtxoPolicy> for ServerVtxoPolicy

fn from(v: HarkForfeitVtxoPolicy) -> Self

Converts to this type from the input type.

impl From<HarkLeafVtxoPolicy> for ServerVtxoPolicy

fn from(p: HarkLeafVtxoPolicy) -> Self

Converts to this type from the input type.

impl From<VtxoPolicy> for ServerVtxoPolicy

fn from(p: VtxoPolicy) -> Self

Converts to this type from the input type.

impl Hash for ServerVtxoPolicy

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 ServerVtxoPolicy

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

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

fn partial_cmp(&self, other: &ServerVtxoPolicy) -> 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 Policy for ServerVtxoPolicy

fn policy_type(&self) -> VtxoPolicyKind

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

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

fn script_pubkey( &self, server_pubkey: PublicKey, exit_delta: BlockDelta, expiry_height: BlockHeight, ) -> ScriptBuf

fn txout( &self, amount: Amount, server_pubkey: PublicKey, exit_delta: BlockDelta, expiry_height: BlockHeight, ) -> TxOut

impl ProtocolEncoding for ServerVtxoPolicy

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 ServerVtxoPolicy

impl StructuralPartialEq for ServerVtxoPolicy