Struct Preimage 

pub struct Preimage {
    pub bytes: Option<[u8; 32]>,
    pub sha256: Hash,
    pub hash160: Hash,
}

Helper to work with Preimage & Hashes required for swap scripts.

Fields

bytes: Option<[u8; 32]>

sha256: Hash

hash160: Hash

Implementations

impl Preimage

pub fn random() -> Preimage

Creates a new random preimage RECOMMENDED NOT TO USE THIS FUNCTION USE FROM_SWAP_KEY INSTEAD

pub fn from_vec(preimage: Vec<u8>) -> Result<Preimage, Error>

Creates a struct from a preimage vector.

pub fn from_sha256_str(preimage_sha256: &str) -> Result<Preimage, Error>

Creates a Preimage struct without a value and only a hash Used only in submarine swaps where we do not know the preimage, only the hash

pub fn from_sha256_vec(preimage_sha256: Vec<u8>) -> Result<Preimage, Error>

Creates a Preimage struct without a value and only a hash Used only in submarine swaps where we do not know the preimage, only the hash

pub fn from_invoice_str(invoice_str: &str) -> Result<Preimage, Error>

Extracts the preimage sha256 hash from a lightning invoice Creates a Preimage struct without a value and only a hash

pub fn to_string(&self) -> Option<String>

Converts the preimage value bytes to String

pub fn from_swap_key(keypair: &Keypair) -> Preimage

Creates a Preimage from a KeyPair’s private key hash sha256(privateKey(index)) RECOMMENDED TO ENSURE SWAPS CAN BE RESTORED MORE EASILY

Trait Implementations

impl Clone for Preimage

fn clone(&self) -> Preimage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Preimage

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

Formats the value using the given formatter.

impl Default for Preimage

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Preimage

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromStr for Preimage

fn from_str(preimage: &str) -> Result<Self, Self::Err>

Creates a struct from a preimage string.

type Err = Error

The associated error which can be returned from parsing.

impl PartialEq for Preimage

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Preimage

impl StructuralPartialEq for Preimage