Struct HashLockedForfeitBundle 

pub struct HashLockedForfeitBundle {
    pub vtxo_id: VtxoId,
    pub unlock_hash: UnlockHash,
    pub user_nonce: PublicNonce,
    pub part_sig: PartialSignature,
}

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

Fields

vtxo_id: VtxoId

unlock_hash: UnlockHash

user_nonce: PublicNonce

part_sig: PartialSignature

User’s partial signature on the forfeit tx

Implementations

impl HashLockedForfeitBundle

pub fn new<G>( vtxo: &Vtxo<G>, unlock_hash: UnlockHash, user_key: &Keypair, server_nonce: &PublicNonce, ) -> Self

Create a new HashLockedForfeitBundle for the given VTXO

This is used to forfeit the VTXO to the server conditional on receiving the unlock preimage corresponding to the given unlock hash.

pub fn verify<G>( &self, vtxo: &Vtxo<G>, server_nonce: &PublicNonce, ) -> Result<(), &'static str>

Used by the server to verify if the partial signature in the bundle is valid

pub fn finish( &self, vtxo: &Vtxo<Full>, server_pub_nonce: &PublicNonce, server_sec_nonce: SecretNonce, server_key: &Keypair, ) -> (Signature, Transaction, ServerVtxo<Full>)

Used by the server to finish the forfeit signature using its own nonce

NB users don’t need to know this signature

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