vls-core 1.0.0-rc.1

A library for implementing a Lightning signer, which externalizes and secures cryptographic operations.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

use bitcoin::bip32::DerivationPath;
use bitcoin::secp256k1::PublicKey;
use bitcoin::{Address, Network, ScriptBuf};

use crate::util::status::Status;

/// A layer-1 wallet used by Validator
pub trait Wallet {
    /// True if the wallet can spend the given output with a derived key
    fn can_spend(
        &self,
        child_path: &DerivationPath,
        script_pubkey: &ScriptBuf,
    ) -> Result<bool, Status>;

    /// Returns true if the given destination Lightning payee is in the node's allowlist
    fn allowlist_contains_payee(&self, payee: PublicKey) -> bool;

    /// True if the script_pubkey is in the node's allowlist
    fn allowlist_contains(&self, script_pubkey: &ScriptBuf, path: &DerivationPath) -> bool;

    /// Returns the network
    fn network(&self) -> Network;

    /// Returns the native segwit address at path
    fn get_native_address(&self, child_path: &DerivationPath) -> Result<Address, Status>;

    /// Returns the p2tr address at path
    fn get_taproot_address(&self, child_path: &DerivationPath) -> Result<Address, Status>;

    /// Returns the wrapped segwit address at path
    #[deprecated(since = "0.9.0", note = "Use native addresses instead")]
    fn get_wrapped_address(&self, child_path: &DerivationPath) -> Result<Address, Status>;
}