Struct HashLockedForfeitBundle

pub struct HashLockedForfeitBundle {
    pub vtxo_id: VtxoId,
    pub unlock_hash: UnlockHash,
    pub user_nonces: HashLockedForfeitNonces,
    pub forfeit_tx_part_sig: PartialSignature,
    pub forfeit_claim_tx_part_sig: PartialSignature,
}

A bundle of signatures that forfeits a user’s VTXO conditional on the server revealing a secret preimage

In hArk, the forfeit protocol actually consists of two steps. First there is a tx that sends the money to an output that the server can claim if he provides the preimage, but that still has a timeout back to the user, to force the server to actually reveal the preimage before the new hArk VTXO expires. This output policy also has to contain the user’s pubkey, so the user that forfeits will have to provide a partial signature for both the spend from his VTXO to the forfeit tx and on a tx that spends the forfeit tx to the server’s wallet.

Fields

vtxo_id: VtxoId

unlock_hash: UnlockHash

user_nonces: HashLockedForfeitNonces

forfeit_tx_part_sig: PartialSignature

User’s partial signature on the forfeit tx

forfeit_claim_tx_part_sig: PartialSignature

User’s partial signature on the forfeit claim tx

Implementations

impl HashLockedForfeitBundle

pub fn forfeit_vtxo( vtxo: &Vtxo, unlock_hash: UnlockHash, user_key: &Keypair, server_nonces: &HashLockedForfeitNonces, ) -> Self

Create a new HashLockedForfeitBundle for the given VTXO

pub fn verify( &self, vtxo: &Vtxo, server_nonces: &HashLockedForfeitNonces, ) -> Result<(), &'static str>

Used by the server to verify if the partial signatures in the bundle are valid

pub fn finish( self, vtxo: &Vtxo, server_pub_nonces: &HashLockedForfeitNonces, [ff_sec_nonce, claim_sec_nonce]: [SecretNonce; 2], server_key: &Keypair, ) -> [Signature; 2]

Used by the server to finish the forfeit signatures using its own nonces.

NB users don’t need to know these signatures.

Trait Implementations

impl Clone for HashLockedForfeitBundle

fn clone(&self) -> HashLockedForfeitBundle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HashLockedForfeitBundle

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

Formats the value using the given formatter.

impl PartialEq for HashLockedForfeitBundle

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

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 HashLockedForfeitBundle

impl StructuralPartialEq for HashLockedForfeitBundle