lwk_boltz 0.14.0

Liquid Wallet Kit - Boltz integration
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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

use std::str::FromStr;

use bip39::Mnemonic;
use boltz_client::boltz::CreateChainResponse;
use boltz_client::network::{BitcoinChain, Chain, LiquidChain};
use boltz_client::util::secrets::Preimage;
use boltz_client::Keypair;
use lightning::bitcoin::XKeyIdentifier;
use serde::{Deserialize, Serialize};

use crate::error::Error;
use crate::preimage_from_keypair;
use crate::SwapState;
use crate::SwapType;
use crate::{derive_keypair, mnemonic_identifier};

#[derive(Clone, Debug)]
pub struct ChainSwapData {
    pub last_state: SwapState,
    pub swap_type: SwapType,
    pub fee: Option<u64>,
    pub boltz_fee: Option<u64>,
    pub create_chain_response: CreateChainResponse,
    pub claim_keys: Keypair,
    pub refund_keys: Keypair,
    pub preimage: Preimage,
    pub lockup_address: String,
    pub expected_lockup_amount: u64,
    pub claim_address: String,
    pub refund_address: String,
    pub claim_key_index: u32,
    pub refund_key_index: u32,
    pub mnemonic_identifier: XKeyIdentifier,
    pub from_chain: Chain,
    pub to_chain: Chain,
    pub random_preimage: bool,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct ChainSwapDataSerializable {
    pub last_state: SwapState,
    pub swap_type: SwapType,
    pub fee: Option<u64>,
    pub boltz_fee: Option<u64>,
    pub create_chain_response: CreateChainResponse,
    pub claim_key_index: u32,
    pub refund_key_index: u32,
    pub lockup_address: String,
    pub expected_lockup_amount: u64,
    pub claim_address: String,
    pub refund_address: String,
    pub mnemonic_identifier: XKeyIdentifier,
    pub from_chain: String,
    pub to_chain: String,

    /// It's some if created at random, otherwise can be derived from mnemonic and key_index
    pub preimage: Option<String>,
}

impl From<ChainSwapData> for ChainSwapDataSerializable {
    fn from(data: ChainSwapData) -> Self {
        ChainSwapDataSerializable {
            last_state: data.last_state,
            swap_type: data.swap_type,
            fee: data.fee,
            boltz_fee: data.boltz_fee,
            create_chain_response: data.create_chain_response,
            claim_key_index: data.claim_key_index,
            refund_key_index: data.refund_key_index,
            lockup_address: data.lockup_address,
            expected_lockup_amount: data.expected_lockup_amount,
            claim_address: data.claim_address,
            refund_address: data.refund_address,
            mnemonic_identifier: data.mnemonic_identifier,
            from_chain: data.from_chain.to_string(),
            to_chain: data.to_chain.to_string(),
            preimage: data
                .random_preimage
                .then_some(data.preimage.to_string().expect("preimage has 32 bytes")),
        }
    }
}

pub(crate) fn chain_from_str(chain: &str) -> Result<Chain, Error> {
    // Display format of the chain is "BTC" or "L-BTC" for regtest/testnet/mainnet
    match chain {
        "BTC" => Ok(Chain::Bitcoin(BitcoinChain::BitcoinRegtest)),
        "L-BTC" => Ok(Chain::Liquid(LiquidChain::LiquidRegtest)),
        s => Err(Error::SwapRestoration(format!("Unknown chain: {s}"))),
    }
}

pub fn to_chain_data(
    data: ChainSwapDataSerializable,
    mnemonic: &Mnemonic,
) -> Result<ChainSwapData, Error> {
    let claim_keys = derive_keypair(data.claim_key_index, mnemonic)?;
    let refund_keys = derive_keypair(data.refund_key_index, mnemonic)?;
    let preimage = match data.preimage.as_ref() {
        Some(preimage) => Preimage::from_str(preimage)?,
        None => preimage_from_keypair(&claim_keys),
    };

    let mnemonic_identifier = mnemonic_identifier(mnemonic)?;
    if mnemonic_identifier != data.mnemonic_identifier {
        return Err(Error::MnemonicIdentifierMismatch(
            mnemonic_identifier,
            data.mnemonic_identifier,
        ));
    }
    let from_chain: Chain = chain_from_str(&data.from_chain)?;
    let to_chain: Chain = chain_from_str(&data.to_chain)?;
    Ok(ChainSwapData {
        last_state: data.last_state,
        swap_type: data.swap_type,
        fee: data.fee,
        boltz_fee: data.boltz_fee,
        create_chain_response: data.create_chain_response,
        claim_keys,
        refund_keys,
        preimage,
        lockup_address: data.lockup_address,
        expected_lockup_amount: data.expected_lockup_amount,
        claim_address: data.claim_address,
        refund_address: data.refund_address,
        claim_key_index: data.claim_key_index,
        refund_key_index: data.refund_key_index,
        mnemonic_identifier,
        from_chain,
        to_chain,
        random_preimage: data.preimage.is_some(),
    })
}

impl ChainSwapDataSerializable {
    pub fn deserialize(data: &str) -> Result<Self, Error> {
        Ok(serde_json::from_str(data)?)
    }
}