Struct lnpbp::bp::scripts::types::LockScript

pub struct LockScript(_);

Script which knowledge is required for spending some specific transaction output. This is the deepest nested version of Bitcoin script containing no hashes of other scripts, including P2SH redeemScript hashes or witnessProgram (hash or witness script), or public keys

Implementations

impl LockScript

pub fn extract_pubkeyset(&self) -> Result<BTreeSet<PublicKey>, PubkeyParseError>

Returns set of unique public keys from the script; fails on public key hash

pub fn extract_pubkey_hash_set(
    &self
) -> Result<(BTreeSet<PublicKey>, BTreeSet<PubkeyHash>), PubkeyParseError>

Returns tuple of two sets: one for unique public keys and one for unique hash values, extracted from the script

pub fn extract_pubkeys_and_hashes(
    &self
) -> Result<(Vec<PublicKey>, Vec<PubkeyHash>), PubkeyParseError>

Returns tuple with two vectors: one for public keys and one for public key hashes present in the script; if any of the keys or hashes has more than a single occurrence it returns all occurrences for each of them

pub fn extract_pubkeys(&self) -> Result<Vec<PublicKey>, PubkeyParseError>

Returns all public keys found in the script; fails on public key hash. If the key present multiple times in the script it returns all occurrences.

pub fn replace_pubkeys(
    &self,
    processor: impl Fn(&PublicKey) -> Option<PublicKey>
) -> Result<Self, PubkeyParseError>

Replaces pubkeys using provided matching function; does not fail on public key hashes.

pub fn replace_pubkeys_and_hashes(
    &self,
    key_processor: impl Fn(&PublicKey) -> Option<PublicKey>,
    hash_processor: impl Fn(&Hash) -> Option<Hash>
) -> Result<Self, PubkeyParseError>

Replaces public kes and public key hashes using provided matching functions.

Trait Implementations

impl AsMut<<LockScript as Wrapper>::Inner> for LockScript

fn as_mut(&mut self) -> &mut Self::Inner

Performs the conversion.

impl AsRef<<LockScript as Wrapper>::Inner> for LockScript

fn as_ref(&self) -> &Self::Inner

Performs the conversion.

impl Borrow<<LockScript as Wrapper>::Inner> for LockScript

fn borrow(&self) -> &Self::Inner

Immutably borrows from an owned value.

impl BorrowMut<<LockScript as Wrapper>::Inner> for LockScript

fn borrow_mut(&mut self) -> &mut Self::Inner

Mutably borrows from an owned value.

impl Clone for LockScript

fn clone(&self) -> LockScript

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LockScript

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

Formats the value using the given formatter.

impl Default for LockScript

fn default() -> LockScript

Returns the "default value" for a type.

impl Deref for LockScript

type Target = Self::Inner

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for LockScript

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Display for LockScript

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

Formats the value using the given formatter.

impl Eq for LockScript

impl From<LockScript> for LockscriptCommitment

fn from(v: LockScript) -> Self

Performs the conversion.

impl From<LockScript> for RedeemScript

fn from(lock_script: LockScript) -> Self

Performs the conversion.

impl From<LockScript> for WitnessScript

fn from(lock_script: LockScript) -> Self

Performs the conversion.

impl From<Script> for LockScript

fn from(v: Script) -> Self

Performs the conversion.

impl From<WitnessScript> for LockScript

fn from(witness_script: WitnessScript) -> Self

Performs the conversion.

impl GenerateScripts for LockScript

fn to_script_pubkey(&self, strategy: Strategy) -> PubkeyScript

fn to_sig_script(&self, strategy: Strategy) -> SigScript

fn to_witness(&self, strategy: Strategy) -> Option<Witness>

fn to_scripts(&self, strategy: Strategy) -> ScriptSet

impl Hash for LockScript

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, 

Feeds a slice of this type into the given Hasher.

impl LowerHex for LockScript

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

Formats the value using the given formatter.

impl Ord for LockScript

fn cmp(&self, other: &LockScript) -> Ordering

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<LockScript> for LockScript

fn eq(&self, other: &LockScript) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &LockScript) -> bool

This method tests for !=.

impl PartialOrd<LockScript> for LockScript

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl ScriptGenerators for LockScript

fn ln_funding(_: u64, pubkey1: PublicKey, pubkey2: PublicKey) -> Self

fn ln_to_local(
    _: u64,
    revocationpubkey: PublicKey,
    local_delayedpubkey: PublicKey,
    to_self_delay: u16
) -> Self

fn ln_to_remote_v1(_: u64, _: PublicKey) -> Self

fn ln_to_remote_v2(_: u64, remote_pubkey: PublicKey) -> Self

impl ScriptGenerators for LockScript

fn ln_offered_htlc(
    _: u64,
    revocationpubkey: PublicKey,
    local_htlcpubkey: PublicKey,
    remote_htlcpubkey: PublicKey,
    payment_hash: HashLock
) -> Self

fn ln_received_htlc(
    _: u64,
    revocationpubkey: PublicKey,
    local_htlcpubkey: PublicKey,
    remote_htlcpubkey: PublicKey,
    cltv_expiry: u32,
    payment_hash: HashLock
) -> Self

fn ln_htlc_output(
    _: u64,
    revocationpubkey: PublicKey,
    local_delayedpubkey: PublicKey,
    to_self_delay: u16
) -> Self

impl Strategy for LockScript

type Strategy = Wrapped

impl StructuralEq for LockScript

impl StructuralPartialEq for LockScript

impl UpperHex for LockScript

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

Formats the value using the given formatter.

impl Wrapper for LockScript

type Inner = Script

Inner type wrapped by the current newtype

fn from_inner(inner: Self::Inner) -> Self

Instantiates wrapper type with the inner data

fn as_inner(&self) -> &Self::Inner

Returns reference to the inner representation for the wrapper type

fn as_inner_mut(&mut self) -> &mut Self::Inner

Returns a mutable reference to the inner representation for the wrapper type

fn into_inner(self) -> Self::Inner

Unwraps the wrapper returning the inner type

fn to_inner(&self) -> Self::Inner

Clones inner data of the wrapped type and return them