lwk_wasm 0.11.0

Liquid Wallet Kit - WASM
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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

use crate::Error;
use lwk_common::{multisig_desc, DescriptorBlindingKey, Multisig};
use std::str::FromStr;
use wasm_bindgen::prelude::*;

/// Wrapper of [`lwk_wollet::WolletDescriptor`]
#[wasm_bindgen]
pub struct WolletDescriptor {
    inner: lwk_wollet::WolletDescriptor,
}

impl AsRef<lwk_wollet::WolletDescriptor> for WolletDescriptor {
    fn as_ref(&self) -> &lwk_wollet::WolletDescriptor {
        &self.inner
    }
}

impl From<lwk_wollet::WolletDescriptor> for WolletDescriptor {
    fn from(inner: lwk_wollet::WolletDescriptor) -> Self {
        Self { inner }
    }
}

impl From<&WolletDescriptor> for lwk_wollet::WolletDescriptor {
    fn from(desc: &WolletDescriptor) -> Self {
        desc.inner.clone()
    }
}

impl From<WolletDescriptor> for lwk_wollet::WolletDescriptor {
    fn from(desc: WolletDescriptor) -> Self {
        desc.inner
    }
}

#[wasm_bindgen]
impl WolletDescriptor {
    /// Creates a `WolletDescriptor`
    #[wasm_bindgen(constructor)]
    pub fn new(descriptor: &str) -> Result<WolletDescriptor, Error> {
        let desc = lwk_wollet::WolletDescriptor::from_str_relaxed(descriptor)?;
        Ok(desc.into())
    }

    #[wasm_bindgen(js_name = toString)]
    pub fn to_string_js(&self) -> String {
        format!("{}", self)
    }

    #[wasm_bindgen(js_name = newMultiWshSlip77)]
    pub fn new_multi_wsh_slip77(
        threshold: u32,
        participants: Vec<String>,
    ) -> Result<WolletDescriptor, Error> {
        let xpubs: Vec<_> = participants
            .iter()
            .map(|s| lwk_common::keyorigin_xpub_from_str(s))
            .collect::<Result<_, _>>()?;

        let desc = multisig_desc(
            threshold,
            xpubs,
            Multisig::Wsh,
            DescriptorBlindingKey::Slip77Rand,
        )
        .map_err(Error::Generic)?;
        let desc = lwk_wollet::WolletDescriptor::from_str(&desc)?;
        Ok(desc.into())
    }

    #[wasm_bindgen(js_name = isMainnet)]
    pub fn is_mainnet(&self) -> bool {
        self.inner.is_mainnet()
    }

    /// Whether the descriptor is AMP0
    #[wasm_bindgen(js_name = isAmp0)]
    pub fn is_amp0(&self) -> bool {
        self.inner.is_amp0()
    }
}

impl std::fmt::Display for WolletDescriptor {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        write!(f, "{}", self.inner)
    }
}

#[cfg(all(test, target_arch = "wasm32"))]
mod tests {

    use wasm_bindgen_test::*;

    use crate::WolletDescriptor;
    wasm_bindgen_test_configure!(run_in_browser);

    #[wasm_bindgen_test]
    async fn test_descriptor() {
        let desc = "ct(slip77(0371e66dde8ab9f3cb19d2c20c8fa2d7bd1ddc73454e6b7ef15f0c5f624d4a86),elsh(wpkh([75ea4a43/49'/1776'/0']xpub6D3Y5EKNsmegjE7azkF2foAYFivHrV5u7tcnN2TXELxv1djNtabCHtp3jMvxqEhTU737mYSUqHD1sA5MdZXQ8DWJLNft1gwtpzXZDsRnrZd/<0;1>/*)))#efvhq75f";
        assert_eq!(desc, WolletDescriptor::new(desc).unwrap().to_string());

        // multiline
        let first = "ct(slip77(0371e66dde8ab9f3cb19d2c20c8fa2d7bd1ddc73454e6b7ef15f0c5f624d4a86),elsh(wpkh([75ea4a43/49'/1776'/0']xpub6D3Y5EKNsmegjE7azkF2foAYFivHrV5u7tcnN2TXELxv1djNtabCHtp3jMvxqEhTU737mYSUqHD1sA5MdZXQ8DWJLNft1gwtpzXZDsRnrZd/0/*)))";
        let second = "ct(slip77(0371e66dde8ab9f3cb19d2c20c8fa2d7bd1ddc73454e6b7ef15f0c5f624d4a86),elsh(wpkh([75ea4a43/49'/1776'/0']xpub6D3Y5EKNsmegjE7azkF2foAYFivHrV5u7tcnN2TXELxv1djNtabCHtp3jMvxqEhTU737mYSUqHD1sA5MdZXQ8DWJLNft1gwtpzXZDsRnrZd/1/*)))";
        let both = format!("{first}\n{second}");
        assert_eq!(desc, WolletDescriptor::new(&both).unwrap().to_string());

        assert!(WolletDescriptor::new(desc).unwrap().is_mainnet());
    }
}