fedimint_ln_common/contracts/
outgoing.rs

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
use bitcoin::hashes::Hash as BitcoinHash;
use fedimint_core::encoding::{Decodable, Encodable};
use fedimint_core::secp256k1::PublicKey;
use fedimint_core::Amount;
use serde::{Deserialize, Serialize};

use super::Preimage;
use crate::contracts::{ContractId, IdentifiableContract};
use crate::LightningInput;

const CANCELLATION_TAG: &str = "outgoing contract cancellation";

/// Specialized smart contract for outgoing payments.
///
/// A user locks up funds that can be claimed by a lightning gateway if it pays
/// the invoice and thus receives the preimage to the payment hash and can
/// thereby prove the payment. If the gateway is not able to do so before the
/// timelock expires the user can claim back the funds.
#[derive(Debug, Clone, Eq, PartialEq, Hash, Deserialize, Serialize, Encodable, Decodable)]
pub struct OutgoingContract {
    /// Hash that can be used to spend the output before the timelock expires
    pub hash: bitcoin::hashes::sha256::Hash,
    /// Public key of the LN gateway allowed to claim the HTLC before the
    /// timelock expires
    pub gateway_key: PublicKey,
    /// Block height at which the money will be spendable by the pubkey
    pub timelock: u32,
    /// Public key of the user that can claim the money back after the timelock
    /// expires
    pub user_key: PublicKey,
    /// Flag that can be set by the gateway and allows the client to claim an
    /// early refund
    pub cancelled: bool,
}

impl IdentifiableContract for OutgoingContract {
    fn contract_id(&self) -> ContractId {
        let mut engine = ContractId::engine();
        Encodable::consensus_encode(&self.hash, &mut engine).expect("Hashing never fails");
        Encodable::consensus_encode(&self.gateway_key, &mut engine).expect("Hashing never fails");
        Encodable::consensus_encode(&self.timelock, &mut engine).expect("Hashing never fails");
        Encodable::consensus_encode(&self.user_key, &mut engine).expect("Hashing never fails");
        ContractId::from_engine(engine)
    }
}

impl OutgoingContract {
    pub fn cancellation_message(&self) -> bitcoin::hashes::sha256::Hash {
        let mut engine = bitcoin::hashes::sha256::Hash::engine();
        Encodable::consensus_encode(&CANCELLATION_TAG.as_bytes(), &mut engine)
            .expect("Hashing never fails");
        Encodable::consensus_encode(&self.contract_id(), &mut engine).expect("Hashing never fails");
        bitcoin::hashes::sha256::Hash::from_engine(engine)
    }
}

#[derive(Debug, Clone, Eq, PartialEq, Hash, Encodable, Decodable, Serialize, Deserialize)]
pub struct OutgoingContractData {
    pub recovery_key: bitcoin::key::Keypair,
    pub contract_account: OutgoingContractAccount,
}

#[derive(Debug, Clone, PartialEq, Eq, Hash, Encodable, Decodable, Serialize, Deserialize)]
pub struct OutgoingContractAccount {
    pub amount: Amount,
    pub contract: OutgoingContract,
}

impl OutgoingContractAccount {
    pub fn claim(&self, preimage: Preimage) -> LightningInput {
        LightningInput::new_v0(self.contract.contract_id(), self.amount, Some(preimage))
    }

    pub fn refund(&self) -> LightningInput {
        LightningInput::new_v0(self.contract.contract_id(), self.amount, None)
    }
}