breez_sdk_liquid/persist/

receive.rs

use anyhow::{anyhow, Result};
use boltz_client::swaps::boltz::CreateReverseResponse;
use rusqlite::{named_params, params, Connection, Row, TransactionBehavior};
use sdk_common::bitcoin::hashes::{hex::ToHex, sha256, Hash};
use serde::{Deserialize, Serialize};

use crate::ensure_sdk;
use crate::error::PaymentError;
use crate::model::*;
use crate::persist::{get_where_clause_state_in, where_clauses_to_string, Persister};
use crate::sync::model::data::ReceiveSyncData;
use crate::sync::model::RecordType;

impl Persister {
    pub(crate) fn insert_or_update_receive_swap_inner(
        con: &Connection,
        receive_swap: &ReceiveSwap,
    ) -> Result<()> {
        let id_hash = sha256::Hash::hash(receive_swap.id.as_bytes()).to_hex();
        con.execute(
            "
            INSERT INTO receive_swaps (
                id,
                id_hash,
                preimage,
                create_response_json,
                claim_private_key,
                invoice,
                timeout_block_height,
                payment_hash,
                destination_pubkey,
                payer_amount_sat,
                receiver_amount_sat,
                created_at,
                claim_fees_sat,
                mrh_address,
                state,
                pair_fees_json
            )
            VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
            ON CONFLICT DO NOTHING
            ",
            (
                &receive_swap.id,
                id_hash,
                &receive_swap.preimage,
                &receive_swap.create_response_json,
                &receive_swap.claim_private_key,
                &receive_swap.invoice,
                &receive_swap.timeout_block_height,
                &receive_swap.payment_hash,
                &receive_swap.destination_pubkey,
                &receive_swap.payer_amount_sat,
                &receive_swap.receiver_amount_sat,
                &receive_swap.created_at,
                &receive_swap.claim_fees_sat,
                &receive_swap.mrh_address,
                &receive_swap.state,
                &receive_swap.pair_fees_json,
            ),
        )?;

        let rows_affected = con.execute(
            "UPDATE receive_swaps
            SET
                bolt12_offer = :bolt12_offer,
                description = :description,
                payer_note = :payer_note,
                claim_address = :claim_address,
                claim_tx_id = :claim_tx_id,
                lockup_tx_id = :lockup_tx_id,
                mrh_tx_id = :mrh_tx_id,
                payer_amount_sat = :payer_amount_sat,
                receiver_amount_sat = :receiver_amount_sat,
                state = :state
            WHERE
                id = :id AND
                version = :version",
            named_params! {
                ":id": &receive_swap.id,
                ":bolt12_offer": &receive_swap.bolt12_offer,
                ":description": &receive_swap.description,
                ":payer_note": &receive_swap.payer_note,
                ":claim_address": &receive_swap.claim_address,
                ":claim_tx_id": &receive_swap.claim_tx_id,
                ":lockup_tx_id": &receive_swap.lockup_tx_id,
                ":mrh_tx_id": &receive_swap.mrh_tx_id,
                // When the swap is paid via MRH, the recoverer sets the
                // payer/receiver amount to the MRH tx amount.
                // This is to show no fees in the payment.
                ":payer_amount_sat": &receive_swap.payer_amount_sat,
                ":receiver_amount_sat": &receive_swap.receiver_amount_sat,
                ":state": &receive_swap.state,
                ":version": &receive_swap.metadata.version,
            },
        )?;
        ensure_sdk!(
            rows_affected > 0,
            anyhow!("Version mismatch for receive swap {}", receive_swap.id)
        );

        if receive_swap.mrh_tx_id.is_some() {
            Self::delete_reserved_address_inner(con, &receive_swap.mrh_address)?;
        }

        Ok(())
    }

    pub(crate) fn insert_or_update_receive_swap(&self, receive_swap: &ReceiveSwap) -> Result<()> {
        let maybe_swap = self.fetch_receive_swap_by_id(&receive_swap.id)?;
        let updated_fields = ReceiveSyncData::updated_fields(maybe_swap, receive_swap);

        let mut con = self.get_connection()?;
        let tx = con.transaction_with_behavior(TransactionBehavior::Immediate)?;

        Self::insert_or_update_receive_swap_inner(&tx, receive_swap)?;

        // Trigger a sync if:
        // - updated_fields is None (swap is inserted, not updated)
        // - updated_fields in a non empty list of updated fields
        let trigger_sync = updated_fields.as_ref().is_none_or(|u| !u.is_empty());
        match trigger_sync {
            true => {
                self.commit_outgoing(&tx, &receive_swap.id, RecordType::Receive, updated_fields)?;
                tx.commit()?;
                self.trigger_sync();
            }
            false => {
                tx.commit()?;
            }
        };

        Ok(())
    }

    fn list_receive_swaps_query(where_clauses: Vec<String>) -> String {
        let where_clause_str = where_clauses_to_string(where_clauses);

        format!(
            "
            SELECT
                rs.id,
                rs.preimage,
                rs.create_response_json,
                rs.claim_private_key,
                rs.invoice,
                rs.bolt12_offer,
                rs.payment_hash,
                rs.destination_pubkey,
                rs.timeout_block_height,
                rs.description,
                rs.payer_note,
                rs.payer_amount_sat,
                rs.receiver_amount_sat,
                rs.claim_fees_sat,
                rs.claim_address,
                rs.claim_tx_id,
                rs.lockup_tx_id,
                rs.mrh_address,
                rs.mrh_tx_id,
                rs.created_at,
                rs.state,
                rs.pair_fees_json,
                rs.version,
                rs.last_updated_at,

                sync_state.is_local
            FROM receive_swaps AS rs
            LEFT JOIN sync_state ON rs.id = sync_state.data_id
            {where_clause_str}
            ORDER BY rs.created_at
        "
        )
    }

    pub(crate) fn fetch_receive_swap_by_id(&self, id: &str) -> Result<Option<ReceiveSwap>> {
        let con: Connection = self.get_connection()?;
        let query = Self::list_receive_swaps_query(vec!["id = ?1 or id_hash = ?1".to_string()]);
        let res = con.query_row(&query, [id], Self::sql_row_to_receive_swap);

        Ok(res.ok())
    }

    pub(crate) fn fetch_receive_swap_by_invoice(
        &self,
        invoice: &str,
    ) -> Result<Option<ReceiveSwap>> {
        let con: Connection = self.get_connection()?;
        let query = Self::list_receive_swaps_query(vec!["invoice= ?1".to_string()]);
        let res = con.query_row(&query, [invoice], Self::sql_row_to_receive_swap);

        Ok(res.ok())
    }

    fn sql_row_to_receive_swap(row: &Row) -> rusqlite::Result<ReceiveSwap> {
        Ok(ReceiveSwap {
            id: row.get(0)?,
            preimage: row.get(1)?,
            create_response_json: row.get(2)?,
            claim_private_key: row.get(3)?,
            invoice: row.get(4)?,
            bolt12_offer: row.get(5)?,
            payment_hash: row.get(6)?,
            destination_pubkey: row.get(7)?,
            timeout_block_height: row.get(8)?,
            description: row.get(9)?,
            payer_note: row.get(10)?,
            payer_amount_sat: row.get(11)?,
            receiver_amount_sat: row.get(12)?,
            claim_fees_sat: row.get(13)?,
            claim_address: row.get(14)?,
            claim_tx_id: row.get(15)?,
            lockup_tx_id: row.get(16)?,
            mrh_address: row.get(17)?,
            mrh_tx_id: row.get(18)?,
            created_at: row.get(19)?,
            state: row.get(20)?,
            pair_fees_json: row.get(21)?,
            metadata: SwapMetadata {
                version: row.get(22)?,
                last_updated_at: row.get(23)?,
                is_local: row.get::<usize, Option<bool>>(24)?.unwrap_or(true),
            },
        })
    }

    pub(crate) fn list_receive_swaps_where(
        &self,
        con: &Connection,
        where_clauses: Vec<String>,
    ) -> Result<Vec<ReceiveSwap>> {
        let query = Self::list_receive_swaps_query(where_clauses);
        let ongoing_receive = con
            .prepare(&query)?
            .query_map(params![], Self::sql_row_to_receive_swap)?
            .map(|i| i.unwrap())
            .collect();
        Ok(ongoing_receive)
    }

    pub(crate) fn list_ongoing_receive_swaps(&self) -> Result<Vec<ReceiveSwap>> {
        let con = self.get_connection()?;
        let where_clauses = vec![get_where_clause_state_in(&[
            PaymentState::Created,
            PaymentState::Pending,
        ])];

        self.list_receive_swaps_where(&con, where_clauses)
    }

    pub(crate) fn list_recoverable_receive_swaps(&self) -> Result<Vec<ReceiveSwap>> {
        let con = self.get_connection()?;
        let where_clause = vec![get_where_clause_state_in(&[
            PaymentState::Created,
            PaymentState::Pending,
        ])];

        self.list_receive_swaps_where(&con, where_clause)
    }

    pub(crate) fn set_receive_swap_claim_address(
        &self,
        swap_id: &str,
        claim_address: &str,
    ) -> Result<(), PaymentError> {
        let con = self.get_connection()?;
        con.execute(
            "UPDATE receive_swaps
            SET claim_address = :claim_address
            WHERE id = :id",
            named_params! {
                        ":id": swap_id,
                        ":claim_address": claim_address,
            },
        )?;
        Ok(())
    }

    // Only set the Receive Swap claim_tx_id if not set, otherwise return an error
    pub(crate) fn set_receive_swap_claim_tx_id(
        &self,
        swap_id: &str,
        claim_tx_id: &str,
    ) -> Result<(), PaymentError> {
        let con = self.get_connection()?;
        let row_count = con
            .execute(
                "UPDATE receive_swaps 
            SET claim_tx_id = :claim_tx_id
            WHERE id = :id AND claim_tx_id IS NULL",
                named_params! {
                            ":id": swap_id,
                            ":claim_tx_id": claim_tx_id,
                },
            )
            .map_err(|_| PaymentError::PersistError)?;
        match row_count {
            1 => Ok(()),
            _ => Err(PaymentError::AlreadyClaimed),
        }
    }

    // Only unset the Receive Swap claim_tx_id if set with the same tx id
    pub(crate) fn unset_receive_swap_claim_tx_id(
        &self,
        swap_id: &str,
        claim_tx_id: &str,
    ) -> Result<(), PaymentError> {
        let con = self.get_connection()?;
        con.execute(
            "UPDATE receive_swaps 
            SET claim_tx_id = NULL
            WHERE id = :id AND claim_tx_id = :claim_tx_id",
            named_params! {
                        ":id": swap_id,
                        ":claim_tx_id": claim_tx_id,
            },
        )
        .map_err(|_| PaymentError::PersistError)?;
        Ok(())
    }

    pub(crate) fn try_handle_receive_swap_update(
        &self,
        swap_id: &str,
        to_state: PaymentState,
        claim_tx_id: Option<&str>,
        lockup_tx_id: Option<&str>,
        mrh_tx_id: Option<&str>,
        mrh_amount_sat: Option<u64>,
    ) -> Result<(), PaymentError> {
        // Do not overwrite claim_tx_id, lockup_tx_id, mrh_tx_id
        let mut con = self.get_connection()?;
        let tx = con.transaction_with_behavior(rusqlite::TransactionBehavior::Immediate)?;

        tx.execute(
            "UPDATE receive_swaps
            SET
                claim_tx_id = COALESCE(claim_tx_id, :claim_tx_id),
                lockup_tx_id = COALESCE(lockup_tx_id, :lockup_tx_id),
                mrh_tx_id = COALESCE(mrh_tx_id, :mrh_tx_id),

                payer_amount_sat = COALESCE(:mrh_amount_sat, payer_amount_sat),
                receiver_amount_sat = COALESCE(:mrh_amount_sat, receiver_amount_sat),
                state = :state
            WHERE
                id = :id",
            named_params! {
                ":id": swap_id,
                ":lockup_tx_id": lockup_tx_id,
                ":claim_tx_id": claim_tx_id,
                ":mrh_tx_id": mrh_tx_id,
                ":mrh_amount_sat": mrh_amount_sat,
                ":state": to_state,
            },
        )?;

        // NOTE: Receive currently does not update any fields, bypassing the commit logic for now
        // let updated_fields = None;
        // Self::commit_outgoing(&tx, swap_id, RecordType::Receive, updated_fields)?;
        // self.sync_trigger
        //     .try_send(())
        //     .map_err(|err| PaymentError::Generic {
        //         err: format!("Could not trigger manual sync: {err:?}"),
        //     })?;

        tx.commit()?;

        Ok(())
    }
}

#[derive(Clone, Debug, Serialize, Deserialize)]
pub(crate) struct InternalCreateReverseResponse {
    pub swap_tree: InternalSwapTree,
    pub lockup_address: String,
    pub refund_public_key: String,
    pub timeout_block_height: u32,
    pub onchain_amount: u64,
    pub blinding_key: Option<String>,
}
impl InternalCreateReverseResponse {
    pub(crate) fn try_convert_from_boltz(
        boltz_create_response: &CreateReverseResponse,
        expected_swap_id: &str,
        expected_invoice: Option<&str>,
    ) -> Result<Self, PaymentError> {
        // Do not store the CreateResponse fields that are already stored separately
        // Before skipping them, ensure they match the separately stored ones
        ensure_sdk!(
            boltz_create_response.id == expected_swap_id,
            PaymentError::PersistError
        );
        match (&boltz_create_response.invoice, expected_invoice) {
            (Some(invoice), Some(expected_invoice)) => {
                ensure_sdk!(invoice == expected_invoice, PaymentError::PersistError);
            }
            (None, None) => {}
            _ => {
                return Err(PaymentError::PersistError);
            }
        }

        let res = InternalCreateReverseResponse {
            swap_tree: boltz_create_response.swap_tree.clone().into(),
            lockup_address: boltz_create_response.lockup_address.clone(),
            refund_public_key: boltz_create_response.refund_public_key.to_string(),
            timeout_block_height: boltz_create_response.timeout_block_height,
            onchain_amount: boltz_create_response.onchain_amount,
            blinding_key: boltz_create_response.blinding_key.clone(),
        };
        Ok(res)
    }
}

#[cfg(test)]
mod tests {
    use anyhow::{anyhow, Result};

    use crate::test_utils::persist::{create_persister, new_receive_swap};

    use super::PaymentState;

    #[cfg(feature = "browser-tests")]
    wasm_bindgen_test::wasm_bindgen_test_configure!(run_in_browser);

    #[sdk_macros::test_all]
    fn test_fetch_receive_swap() -> Result<()> {
        create_persister!(storage);

        let receive_swap = new_receive_swap(None, None);

        storage.insert_or_update_receive_swap(&receive_swap)?;
        // Fetch swap by id
        assert!(storage.fetch_receive_swap_by_id(&receive_swap.id).is_ok());
        // Fetch swap by invoice
        assert!(storage
            .fetch_receive_swap_by_invoice(&receive_swap.invoice)
            .is_ok());

        Ok(())
    }

    #[sdk_macros::test_all]
    fn test_list_receive_swap() -> Result<()> {
        create_persister!(storage);

        // List general receive swaps
        let range = 0..3;
        for _ in range.clone() {
            storage.insert_or_update_receive_swap(&new_receive_swap(None, None))?;
        }

        let con = storage.get_connection()?;
        let swaps = storage.list_receive_swaps_where(&con, vec![])?;
        assert_eq!(swaps.len(), range.len());

        // List ongoing receive swaps
        storage
            .insert_or_update_receive_swap(&new_receive_swap(Some(PaymentState::Pending), None))?;
        let ongoing_swaps = storage.list_ongoing_receive_swaps()?;
        assert_eq!(ongoing_swaps.len(), 4);

        Ok(())
    }

    #[sdk_macros::test_all]
    fn test_update_receive_swap() -> Result<()> {
        create_persister!(storage);

        let receive_swap = new_receive_swap(None, None);
        storage.insert_or_update_receive_swap(&receive_swap)?;

        // Update metadata
        let new_state = PaymentState::Pending;
        let claim_tx_id = Some("claim_tx_id");

        storage.try_handle_receive_swap_update(
            &receive_swap.id,
            new_state,
            claim_tx_id,
            None,
            None,
            None,
        )?;

        let updated_receive_swap = storage
            .fetch_receive_swap_by_id(&receive_swap.id)?
            .ok_or(anyhow!("Could not find Receive swap in database"))?;

        assert_eq!(new_state, updated_receive_swap.state);
        assert_eq!(claim_tx_id, updated_receive_swap.claim_tx_id.as_deref());

        Ok(())
    }

    #[sdk_macros::async_test_all]
    async fn test_writing_stale_swap() -> Result<()> {
        create_persister!(storage);

        let receive_swap = new_receive_swap(None, None);
        storage.insert_or_update_receive_swap(&receive_swap)?;

        // read - update - write works if there are no updates in between
        let mut receive_swap = storage.fetch_receive_swap_by_id(&receive_swap.id)?.unwrap();
        receive_swap.lockup_tx_id = Some("tx_id".to_string());
        storage.insert_or_update_receive_swap(&receive_swap)?;

        // read - update - write works if there are no updates in between even if no field changes
        let receive_swap = storage.fetch_receive_swap_by_id(&receive_swap.id)?.unwrap();
        storage.insert_or_update_receive_swap(&receive_swap)?;

        // read - update - write fails if there are any updates in between
        let mut receive_swap = storage.fetch_receive_swap_by_id(&receive_swap.id)?.unwrap();
        receive_swap.lockup_tx_id = Some("tx_id_2".to_string());
        // Concurrent update
        storage.set_receive_swap_claim_tx_id(&receive_swap.id, "tx_id")?;
        assert!(storage
            .insert_or_update_receive_swap(&receive_swap)
            .is_err());

        Ok(())
    }
}