ddk-manager 1.1.0

//! #Utils
use std::ops::Deref;

use bitcoin::{consensus::Encodable, Amount, ScriptBuf, Txid};
use ddk_dlc::{dlc_input::DlcInputInfo, util::get_common_fee, PartyParams, TxInputInfo};
use ddk_messages::{
    oracle_msgs::{OracleAnnouncement, OracleAttestation},
    DlcInput, FundingInput,
};
use ddk_trie::RangeInfo;
#[cfg(not(feature = "fuzztarget"))]
use secp256k1_zkp::rand::{thread_rng, Rng, RngCore};
use secp256k1_zkp::{PublicKey, Secp256k1, Signing};

use crate::{
    channel::party_points::PartyBasePoints,
    contract::{contract_info::ContractInfo, ser::Serializable, AdaptorInfo},
    error::Error,
    Blockchain, ContractSigner, ContractSignerProvider, Wallet,
};

macro_rules! get_object_in_state {
    ($manager: expr, $id: expr, $state: ident, $peer_id: expr, $object_type: ident, $get_call: ident) => {{
        let object = $manager.get_store().$get_call($id).await?;
        match object {
            Some(c) => match $peer_id as Option<PublicKey> {
                Some(p) if c.get_counter_party_id() != p => Err(Error::InvalidParameters(format!(
                    "Peer {:02x?} is not involved with {} {:02x?}.",
                    $peer_id,
                    stringify!($object_type),
                    $id
                ))),
                _ => match c {
                    $object_type::$state(s) => Ok(s),
                    _ => Err(Error::InvalidState(format!(
                        "Invalid state {:?} expected {}.",
                        c,
                        stringify!($state),
                    ))),
                },
            },
            None => Err(Error::InvalidParameters(format!(
                "Unknown {} id.",
                stringify!($object_type)
            ))),
        }
    }};
}

pub(crate) use get_object_in_state;

#[cfg(not(feature = "fuzztarget"))]
pub(crate) fn get_new_serial_id() -> u64 {
    thread_rng().next_u64()
}

#[cfg(feature = "fuzztarget")]
pub(crate) fn get_new_serial_id() -> u64 {
    use rand_chacha::rand_core::RngCore;
    use rand_chacha::rand_core::SeedableRng;
    rand_chacha::ChaCha8Rng::from_seed([0u8; 32]).next_u64()
}

#[cfg(not(feature = "fuzztarget"))]
pub(crate) fn get_new_temporary_id() -> [u8; 32] {
    thread_rng().gen::<[u8; 32]>()
}

#[cfg(feature = "fuzztarget")]
pub(crate) fn get_new_temporary_id() -> [u8; 32] {
    use rand_chacha::rand_core::RngCore;
    use rand_chacha::rand_core::SeedableRng;
    let mut res = [0u8; 32];
    rand_chacha::ChaCha8Rng::from_seed([0u8; 32]).fill_bytes(&mut res);
    res
}

pub(crate) fn compute_id(
    fund_tx_id: Txid,
    fund_output_index: u16,
    temporary_id: &[u8; 32],
) -> [u8; 32] {
    let mut res = [0; 32];
    for i in 0..32 {
        res[i] = fund_tx_id[31 - i] ^ temporary_id[i];
    }
    res[30] ^= ((fund_output_index >> 8) & 0xff) as u8;
    res[31] ^= (fund_output_index & 0xff) as u8;
    res
}

#[allow(clippy::too_many_arguments)]
pub(crate) async fn get_party_params<W: Deref, B: Deref, X: ContractSigner, C: Signing>(
    secp: &Secp256k1<C>,
    own_collateral: Amount,
    total_collateral: Amount,
    dlc_inputs: Vec<DlcInputInfo>,
    fee_rate: u64,
    wallet: &W,
    signer: &X,
    blockchain: &B,
) -> Result<(PartyParams, Vec<FundingInput>), Error>
where
    W::Target: Wallet,
    B::Target: Blockchain,
{
    let funding_pubkey = signer.get_public_key(secp)?;

    let payout_addr = wallet.get_new_address().await?;
    let payout_spk = payout_addr.script_pubkey();
    let payout_serial_id = get_new_serial_id();
    let change_addr = wallet.get_new_change_address().await?;
    let change_spk = change_addr.script_pubkey();
    let change_serial_id = get_new_serial_id();

    let appr_required_amount =
        get_approximate_required_amount(&dlc_inputs, total_collateral, own_collateral, fee_rate)?;

    // First get the amount in the DLC input. Subtract from own collateral to see if there is needed extra UTXO.
    let dlc_input_amount = dlc_inputs.iter().map(|d| d.fund_amount).sum::<Amount>();

    let potential_additional_collateral_needed = appr_required_amount
        .checked_sub(dlc_input_amount)
        .unwrap_or(Amount::ZERO);
    let utxos = wallet
        .get_utxos_for_amount(potential_additional_collateral_needed, fee_rate, true)
        .await?;

    let mut funding_inputs: Vec<FundingInput> = Vec::new();
    let mut funding_tx_info: Vec<TxInputInfo> = Vec::new();
    let mut total_input = dlc_input_amount;
    for utxo in utxos {
        let prev_tx = blockchain.get_transaction(&utxo.outpoint.txid).await?;
        let mut writer = Vec::new();
        prev_tx.consensus_encode(&mut writer)?;
        let prev_tx_vout = utxo.outpoint.vout;
        let sequence = 0xffffffff;
        // TODO(tibo): this assumes P2WPKH with low R
        let max_witness_len = 108;
        let funding_input = FundingInput {
            input_serial_id: get_new_serial_id(),
            prev_tx: writer,
            prev_tx_vout,
            sequence,
            max_witness_len,
            redeem_script: utxo.redeem_script,
            dlc_input: None,
        };
        total_input += prev_tx.output[prev_tx_vout as usize].value;
        funding_tx_info.push((&funding_input).into());
        funding_inputs.push(funding_input);
    }

    dlc_inputs.iter().for_each(|d| {
        let funding_input = FundingInput {
            input_serial_id: d.input_serial_id,
            prev_tx: d.fund_tx.serialize().unwrap(),
            prev_tx_vout: d.fund_vout,
            sequence: 0xffffffff,
            max_witness_len: d.max_witness_len as u16,
            redeem_script: ScriptBuf::new(),
            dlc_input: Some(DlcInput {
                local_fund_pubkey: d.local_fund_pubkey,
                remote_fund_pubkey: d.remote_fund_pubkey,
                contract_id: d.contract_id,
            }),
        };
        funding_tx_info.push((&funding_input).into());
        funding_inputs.push(funding_input);
    });

    let party_params = PartyParams {
        fund_pubkey: funding_pubkey,
        change_script_pubkey: change_spk,
        change_serial_id,
        payout_script_pubkey: payout_spk,
        payout_serial_id,
        inputs: funding_tx_info,
        dlc_inputs,
        collateral: own_collateral,
        input_amount: total_input,
    };

    Ok((party_params, funding_inputs))
}

// If own_collateral is zero, appr_required_amount is zero.
// If own_collateral is equal to total_collateral, appr_required_amount is the common fee.
// Otherwise, appr_required_amount is the half common fee.
// Add base cost of fund tx + CET / 2 and a CET output to the collateral.
fn get_approximate_required_amount(
    dlc_inputs: &[DlcInputInfo],
    total_collateral: Amount,
    own_collateral: Amount,
    fee_rate: u64,
) -> Result<Amount, Error> {
    // defaults to a p2wpkh address for CET execution
    // 20 bytes pubkey hash + 2 bytes opcodes + 9 bytes base output size = 31 bytes * 4 = 124 bytes
    // TODO: handle different address types for CET execution (multisig, p2wsh, p2tr, etc.)
    const ASSUME_P2WPKH_WEIGHT: usize = 124;

    let dlc_weight = ddk_dlc::dlc_input::get_dlc_inputs_weight(dlc_inputs);

    let appr_required_amount = if own_collateral == Amount::ZERO {
        // No collateral = no fees
        Amount::ZERO
    } else if own_collateral == total_collateral {
        // Full collateral = full fees
        own_collateral
            + get_common_fee(fee_rate)?
            + ddk_dlc::util::weight_to_fee(ASSUME_P2WPKH_WEIGHT, fee_rate)?
            + ddk_dlc::util::weight_to_fee(dlc_weight, fee_rate)?
    } else {
        // Partial collateral = split fees
        own_collateral
            + get_half_common_fee(fee_rate)?
            + ddk_dlc::util::weight_to_fee(ASSUME_P2WPKH_WEIGHT, fee_rate)?
            + ddk_dlc::util::weight_to_fee(dlc_weight, fee_rate)?
    };
    Ok(appr_required_amount)
}

pub(crate) fn get_party_base_points<C: Signing, SP: Deref>(
    secp: &Secp256k1<C>,
    signer_provider: &SP,
) -> Result<PartyBasePoints, Error>
where
    SP::Target: ContractSignerProvider,
{
    Ok(PartyBasePoints {
        own_basepoint: PublicKey::from_secret_key(secp, &signer_provider.get_new_secret_key()?),
        publish_basepoint: PublicKey::from_secret_key(secp, &signer_provider.get_new_secret_key()?),
        revocation_basepoint: PublicKey::from_secret_key(
            secp,
            &signer_provider.get_new_secret_key()?,
        ),
    })
}

pub(crate) fn get_half_common_fee(fee_rate: u64) -> Result<Amount, Error> {
    let common_fee = ddk_dlc::util::get_common_fee(fee_rate)?;
    Ok(common_fee / 2)
}

pub(crate) fn get_range_info_and_oracle_sigs(
    contract_info: &ContractInfo,
    adaptor_info: &AdaptorInfo,
    attestations: &[(usize, OracleAttestation)],
) -> Result<(RangeInfo, Vec<Vec<secp256k1_zkp::schnorr::Signature>>), Error> {
    let outcomes = attestations
        .iter()
        .map(|(i, x)| (*i, &x.outcomes))
        .collect::<Vec<(usize, &Vec<String>)>>();
    let info_opt = contract_info.get_range_info_for_outcome(adaptor_info, &outcomes, 0);
    if let Some((sig_infos, range_info)) = info_opt {
        let sigs: Vec<Vec<_>> = attestations
            .iter()
            .filter_map(|(i, a)| {
                let sig_info = sig_infos.iter().find(|x| x.0 == *i)?;
                Some(a.signatures.iter().take(sig_info.1).cloned().collect())
            })
            .collect();
        return Ok((range_info, sigs));
    }

    Err(Error::InvalidState(
        "Could not find closing info for given outcomes".to_string(),
    ))
}

pub(crate) fn get_latest_maturity_date(
    announcements: &[Vec<OracleAnnouncement>],
) -> Result<u32, Error> {
    announcements
        .iter()
        .flatten()
        .map(|x| x.oracle_event.event_maturity_epoch)
        .max()
        .ok_or_else(|| {
            Error::InvalidParameters("Could not find maximum event maturity.".to_string())
        })
}

#[cfg(test)]
mod tests {
    use std::str::FromStr;

    use bitcoin::{consensus::Decodable, Transaction};
    use ddk_messages::oracle_msgs::{EnumEventDescriptor, EventDescriptor, OracleEvent};
    use secp256k1_zkp::{
        rand::{thread_rng, RngCore},
        schnorr::Signature,
        XOnlyPublicKey,
    };

    use super::*;

    /// Utility function used to parse hex into a target u8 buffer. Returns
    /// the number of bytes converted or an error if it encounters an invalid
    /// character or unexpected end of string.
    #[allow(clippy::result_unit_err)] // This is just a test util
    fn from_hex(hex: &str, target: &mut [u8]) -> Result<usize, ()> {
        if hex.len() % 2 == 1 || hex.len() > target.len() * 2 {
            return Err(());
        }

        let mut b = 0;
        let mut idx = 0;
        for c in hex.bytes() {
            b <<= 4;
            match c {
                b'A'..=b'F' => b |= c - b'A' + 10,
                b'a'..=b'f' => b |= c - b'a' + 10,
                b'0'..=b'9' => b |= c - b'0',
                _ => return Err(()),
            }
            if (idx & 1) == 1 {
                target[idx / 2] = b;
                b = 0;
            }
            idx += 1;
        }
        Ok(idx / 2)
    }

    /// Transforms an hex string to a Vec<u8>.
    /// Panics if the string is not valid hex.
    fn str_to_hex(hex_str: &str) -> Vec<u8> {
        let mut hex = vec![0; hex_str.len() / 2];
        from_hex(hex_str, &mut hex).unwrap();
        hex
    }

    /// Deserialize an hex string to a bitcoin transaction.
    /// Panics if given invalid hex or data.
    pub fn tx_from_string(tx_str: &str) -> Transaction {
        let tx_hex = str_to_hex(tx_str);
        Transaction::consensus_decode(&mut tx_hex.as_slice()).unwrap()
    }

    #[test]
    fn get_appr_required_amount_single_funded_dlc() {
        let total_collateral = Amount::ONE_BTC;
        let own_collateral = Amount::ONE_BTC;
        let fee_rate = 2;
        let appr_required_amount =
            get_approximate_required_amount(&[], total_collateral, own_collateral, fee_rate)
                .unwrap();
        let expected_amount = Amount::ONE_BTC + Amount::from_sat(420);
        assert_eq!(appr_required_amount, expected_amount);
    }

    #[test]
    fn get_appr_required_amount_unfunded_dlc() {
        let total_collateral = Amount::ONE_BTC;
        let own_collateral = Amount::ZERO;
        let fee_rate = 2;
        let appr_required_amount =
            get_approximate_required_amount(&[], total_collateral, own_collateral, fee_rate)
                .unwrap();
        assert_eq!(appr_required_amount, Amount::ZERO);
    }

    #[test]
    fn get_appr_required_amount_dual_funded_dlc() {
        let total_collateral = Amount::ONE_BTC;
        let own_collateral = Amount::from_sat(50_000_000);
        let fee_rate = 2;
        let appr_required_amount =
            get_approximate_required_amount(&[], total_collateral, own_collateral, fee_rate)
                .unwrap();
        assert_eq!(appr_required_amount, Amount::from_sat(50_000_000 + 241));
    }

    #[test]
    fn id_computation_test() {
        let transaction = tx_from_string("01000000010000000000000000000000000000000000000000000000000000000000000000ffffffff020000ffffffff0101000000000000000000000000");
        let output_index = 1;
        let temporary_id = [34u8; 32];
        let expected_id =
            str_to_hex("81db60dcbef10a2d0cb92cb78400a96ee6a9b6da785d0230bdabf1e18a2d6ffb");

        let id = compute_id(transaction.compute_txid(), output_index, &temporary_id);

        assert_eq!(expected_id, id);
    }

    #[test]
    fn get_latest_maturity_date_test() {
        let mut rand = thread_rng();
        let maturity_dates: Vec<Vec<u32>> = (0..20)
            .map(|_| (0..20).map(|_| rand.next_u32()).collect())
            .collect();
        let announcements: Vec<Vec<_>> = maturity_dates
            .iter()
            .map(|x| x.iter().map(|y| create_announcement(*y)).collect())
            .collect();

        assert_eq!(
            *maturity_dates.iter().flatten().max().unwrap(),
            get_latest_maturity_date(&announcements).expect("to have a latest maturity date.")
        );
    }

    fn create_announcement(maturity: u32) -> OracleAnnouncement {
        let xonly_pk = XOnlyPublicKey::from_str(
            "e6642fd69bd211f93f7f1f36ca51a26a5290eb2dd1b0d8279a87bb0d480c8443",
        )
        .unwrap();

        OracleAnnouncement {
            announcement_signature: Signature::from_str("6470FD1303DDA4FDA717B9837153C24A6EAB377183FC438F939E0ED2B620E9EE5077C4A8B8DCA28963D772A94F5F0DDF598E1C47C137F91933274C7C3EDADCE8").unwrap(),
            oracle_public_key: xonly_pk,
            oracle_event: OracleEvent { oracle_nonces: vec![xonly_pk], event_maturity_epoch: maturity,event_descriptor: EventDescriptor::EnumEvent(EnumEventDescriptor { outcomes: vec!["1".to_string(), "2".to_string()] }), event_id: "01".to_string() },
        }
    }
}