#![deny(clippy::pedantic)]
#![allow(clippy::cast_possible_wrap)]
#![allow(clippy::module_name_repetitions)]
#![allow(clippy::must_use_candidate)]
#![allow(clippy::too_many_lines)]
pub mod db;
use std::collections::BTreeMap;
use std::time::Duration;
use anyhow::{bail, Context};
use bitcoin_hashes::{sha256, Hash as BitcoinHash};
use fedimint_bitcoind::{create_bitcoind, DynBitcoindRpc};
use fedimint_core::config::{
ConfigGenModuleParams, DkgResult, ServerModuleConfig, ServerModuleConsensusConfig,
TypedServerModuleConfig, TypedServerModuleConsensusConfig,
};
use fedimint_core::core::ModuleInstanceId;
use fedimint_core::db::{DatabaseTransaction, DatabaseValue, IDatabaseTransactionOpsCoreTyped};
use fedimint_core::encoding::btc::NetworkLegacyEncodingWrapper;
use fedimint_core::encoding::Encodable;
use fedimint_core::module::audit::Audit;
use fedimint_core::module::{
api_endpoint, ApiEndpoint, ApiEndpointContext, ApiVersion, CoreConsensusVersion, InputMeta,
ModuleConsensusVersion, ModuleInit, PeerHandle, ServerModuleInit, ServerModuleInitArgs,
SupportedModuleApiVersions, TransactionItemAmount, CORE_CONSENSUS_VERSION,
};
use fedimint_core::secp256k1::{Message, PublicKey, SECP256K1};
use fedimint_core::server::DynServerModule;
use fedimint_core::task::sleep;
use fedimint_core::{
apply, async_trait_maybe_send, push_db_pair_items, Amount, NumPeersExt, OutPoint, PeerId,
ServerModule,
};
pub use fedimint_ln_common as common;
use fedimint_ln_common::config::{
FeeConsensus, LightningClientConfig, LightningConfig, LightningConfigConsensus,
LightningConfigLocal, LightningConfigPrivate, LightningGenParams,
};
use fedimint_ln_common::contracts::incoming::{IncomingContractAccount, IncomingContractOffer};
use fedimint_ln_common::contracts::{
Contract, ContractId, ContractOutcome, DecryptedPreimage, DecryptedPreimageStatus,
EncryptedPreimage, FundedContract, IdentifiableContract, Preimage, PreimageDecryptionShare,
PreimageKey,
};
use fedimint_ln_common::federation_endpoint_constants::{
ACCOUNT_ENDPOINT, AWAIT_ACCOUNT_ENDPOINT, AWAIT_BLOCK_HEIGHT_ENDPOINT, AWAIT_OFFER_ENDPOINT,
AWAIT_OUTGOING_CONTRACT_CANCELLED_ENDPOINT, AWAIT_PREIMAGE_DECRYPTION, BLOCK_COUNT_ENDPOINT,
GET_DECRYPTED_PREIMAGE_STATUS, LIST_GATEWAYS_ENDPOINT, OFFER_ENDPOINT,
REGISTER_GATEWAY_ENDPOINT, REMOVE_GATEWAY_CHALLENGE_ENDPOINT, REMOVE_GATEWAY_ENDPOINT,
};
use fedimint_ln_common::{
create_gateway_remove_message, ContractAccount, LightningCommonInit, LightningConsensusItem,
LightningGatewayAnnouncement, LightningGatewayRegistration, LightningInput,
LightningInputError, LightningModuleTypes, LightningOutput, LightningOutputError,
LightningOutputOutcome, LightningOutputOutcomeV0, LightningOutputV0, RemoveGatewayRequest,
MODULE_CONSENSUS_VERSION,
};
use fedimint_server::config::distributedgen::PeerHandleOps;
use futures::StreamExt;
use metrics::{LN_CANCEL_OUTGOING_CONTRACTS, LN_FUNDED_CONTRACT_SATS, LN_INCOMING_OFFER};
use rand::rngs::OsRng;
use strum::IntoEnumIterator;
use tracing::{debug, error, info, info_span, trace, warn};
use crate::db::{
AgreedDecryptionShareContractIdPrefix, AgreedDecryptionShareKey,
AgreedDecryptionShareKeyPrefix, BlockCountVoteKey, BlockCountVotePrefix, ContractKey,
ContractKeyPrefix, ContractUpdateKey, ContractUpdateKeyPrefix, DbKeyPrefix,
EncryptedPreimageIndexKey, EncryptedPreimageIndexKeyPrefix, LightningAuditItemKey,
LightningAuditItemKeyPrefix, LightningGatewayKey, LightningGatewayKeyPrefix, OfferKey,
OfferKeyPrefix, ProposeDecryptionShareKey, ProposeDecryptionShareKeyPrefix,
};
mod metrics;
#[derive(Debug, Clone)]
pub struct LightningInit;
impl ModuleInit for LightningInit {
type Common = LightningCommonInit;
async fn dump_database(
&self,
dbtx: &mut DatabaseTransaction<'_>,
prefix_names: Vec<String>,
) -> Box<dyn Iterator<Item = (String, Box<dyn erased_serde::Serialize + Send>)> + '_> {
let mut lightning: BTreeMap<String, Box<dyn erased_serde::Serialize + Send>> =
BTreeMap::new();
let filtered_prefixes = DbKeyPrefix::iter().filter(|f| {
prefix_names.is_empty() || prefix_names.contains(&f.to_string().to_lowercase())
});
for table in filtered_prefixes {
match table {
DbKeyPrefix::AgreedDecryptionShare => {
push_db_pair_items!(
dbtx,
AgreedDecryptionShareKeyPrefix,
AgreedDecryptionShareKey,
PreimageDecryptionShare,
lightning,
"Accepted Decryption Shares"
);
}
DbKeyPrefix::Contract => {
push_db_pair_items!(
dbtx,
ContractKeyPrefix,
ContractKey,
ContractAccount,
lightning,
"Contracts"
);
}
DbKeyPrefix::ContractUpdate => {
push_db_pair_items!(
dbtx,
ContractUpdateKeyPrefix,
ContractUpdateKey,
LightningOutputOutcomeV0,
lightning,
"Contract Updates"
);
}
DbKeyPrefix::LightningGateway => {
push_db_pair_items!(
dbtx,
LightningGatewayKeyPrefix,
LightningGatewayKey,
LightningGatewayRegistration,
lightning,
"Lightning Gateways"
);
}
DbKeyPrefix::Offer => {
push_db_pair_items!(
dbtx,
OfferKeyPrefix,
OfferKey,
IncomingContractOffer,
lightning,
"Offers"
);
}
DbKeyPrefix::ProposeDecryptionShare => {
push_db_pair_items!(
dbtx,
ProposeDecryptionShareKeyPrefix,
ProposeDecryptionShareKey,
PreimageDecryptionShare,
lightning,
"Proposed Decryption Shares"
);
}
DbKeyPrefix::BlockCountVote => {
push_db_pair_items!(
dbtx,
BlockCountVotePrefix,
BlockCountVoteKey,
u64,
lightning,
"Block Count Votes"
);
}
DbKeyPrefix::EncryptedPreimageIndex => {
push_db_pair_items!(
dbtx,
EncryptedPreimageIndexKeyPrefix,
EncryptedPreimageIndexKey,
(),
lightning,
"Encrypted Preimage Hashes"
);
}
DbKeyPrefix::LightningAuditItem => {
push_db_pair_items!(
dbtx,
LightningAuditItemKeyPrefix,
LightningAuditItemKey,
Amount,
lightning,
"Lightning Audit Items"
);
}
}
}
Box::new(lightning.into_iter())
}
}
#[apply(async_trait_maybe_send!)]
impl ServerModuleInit for LightningInit {
type Params = LightningGenParams;
fn versions(&self, _core: CoreConsensusVersion) -> &[ModuleConsensusVersion] {
&[MODULE_CONSENSUS_VERSION]
}
fn supported_api_versions(&self) -> SupportedModuleApiVersions {
SupportedModuleApiVersions::from_raw(
(CORE_CONSENSUS_VERSION.major, CORE_CONSENSUS_VERSION.minor),
(
MODULE_CONSENSUS_VERSION.major,
MODULE_CONSENSUS_VERSION.minor,
),
&[(0, 1)],
)
}
async fn init(&self, args: &ServerModuleInitArgs<Self>) -> anyhow::Result<DynServerModule> {
LN_CANCEL_OUTGOING_CONTRACTS.get();
Ok(Lightning::new(args.cfg().to_typed()?, args.our_peer_id())?.into())
}
fn trusted_dealer_gen(
&self,
peers: &[PeerId],
params: &ConfigGenModuleParams,
) -> BTreeMap<PeerId, ServerModuleConfig> {
let params = self.parse_params(params).unwrap();
let sks = threshold_crypto::SecretKeySet::random(peers.to_num_peers().degree(), &mut OsRng);
let pks = sks.public_keys();
let server_cfg = peers
.iter()
.map(|&peer| {
let sk = sks.secret_key_share(peer.to_usize());
(
peer,
LightningConfig {
local: LightningConfigLocal {
bitcoin_rpc: params.local.bitcoin_rpc.clone(),
},
consensus: LightningConfigConsensus {
threshold_pub_keys: pks.clone(),
fee_consensus: FeeConsensus::default(),
network: NetworkLegacyEncodingWrapper(params.consensus.network),
},
private: LightningConfigPrivate {
threshold_sec_key: threshold_crypto::serde_impl::SerdeSecret(sk),
},
}
.to_erased(),
)
})
.collect();
server_cfg
}
async fn distributed_gen(
&self,
peers: &PeerHandle,
params: &ConfigGenModuleParams,
) -> DkgResult<ServerModuleConfig> {
let params = self.parse_params(params).unwrap();
let g1 = peers.run_dkg_g1(()).await?;
let keys = g1[&()].threshold_crypto();
let server = LightningConfig {
local: LightningConfigLocal {
bitcoin_rpc: params.local.bitcoin_rpc.clone(),
},
consensus: LightningConfigConsensus {
threshold_pub_keys: keys.public_key_set,
fee_consensus: FeeConsensus::default(),
network: NetworkLegacyEncodingWrapper(params.consensus.network),
},
private: LightningConfigPrivate {
threshold_sec_key: keys.secret_key_share,
},
};
Ok(server.to_erased())
}
fn validate_config(&self, identity: &PeerId, config: ServerModuleConfig) -> anyhow::Result<()> {
let config = config.to_typed::<LightningConfig>()?;
if config.private.threshold_sec_key.public_key_share()
!= config
.consensus
.threshold_pub_keys
.public_key_share(identity.to_usize())
{
bail!("Lightning private key doesn't match pubkey share");
}
Ok(())
}
fn get_client_config(
&self,
config: &ServerModuleConsensusConfig,
) -> anyhow::Result<LightningClientConfig> {
let config = LightningConfigConsensus::from_erased(config)?;
Ok(LightningClientConfig {
threshold_pub_key: config.threshold_pub_keys.public_key(),
fee_consensus: config.fee_consensus,
network: config.network,
})
}
}
#[derive(Debug)]
pub struct Lightning {
cfg: LightningConfig,
btc_rpc: DynBitcoindRpc,
our_peer_id: PeerId,
}
#[apply(async_trait_maybe_send!)]
impl ServerModule for Lightning {
type Common = LightningModuleTypes;
type Init = LightningInit;
async fn consensus_proposal(
&self,
dbtx: &mut DatabaseTransaction<'_>,
) -> Vec<LightningConsensusItem> {
let mut items: Vec<LightningConsensusItem> = dbtx
.find_by_prefix(&ProposeDecryptionShareKeyPrefix)
.await
.map(|(ProposeDecryptionShareKey(contract_id), share)| {
LightningConsensusItem::DecryptPreimage(contract_id, share)
})
.collect()
.await;
if let Ok(block_count_vote) = self.block_count().await {
items.push(LightningConsensusItem::BlockCount(block_count_vote));
}
items
}
async fn process_consensus_item<'a, 'b>(
&'a self,
dbtx: &mut DatabaseTransaction<'b>,
consensus_item: LightningConsensusItem,
peer_id: PeerId,
) -> anyhow::Result<()> {
let span = info_span!("process decryption share", %peer_id);
let _guard = span.enter();
match consensus_item {
LightningConsensusItem::DecryptPreimage(contract_id, share) => {
if dbtx
.get_value(&AgreedDecryptionShareKey(contract_id, peer_id))
.await
.is_some()
{
bail!("Already received a valid decryption share for this peer");
}
let account = dbtx
.get_value(&ContractKey(contract_id))
.await
.context("Contract account for this decryption share does not exist")?;
let (contract, out_point) = match account.contract {
FundedContract::Incoming(contract) => (contract.contract, contract.out_point),
FundedContract::Outgoing(..) => {
bail!("Contract account for this decryption share is outgoing");
}
};
if contract.decrypted_preimage != DecryptedPreimage::Pending {
bail!("Contract for this decryption share is not pending");
}
if !self.validate_decryption_share(peer_id, &share, &contract.encrypted_preimage) {
bail!("Decryption share is invalid");
}
dbtx.insert_new_entry(&AgreedDecryptionShareKey(contract_id, peer_id), &share)
.await;
let decryption_shares = dbtx
.find_by_prefix(&AgreedDecryptionShareContractIdPrefix(contract_id))
.await
.map(|(key, decryption_share)| (key.1, decryption_share))
.collect::<Vec<_>>()
.await;
if decryption_shares.len() < self.cfg.consensus.threshold() {
return Ok(());
}
debug!("Beginning to decrypt preimage");
let Ok(preimage_vec) = self.cfg.consensus.threshold_pub_keys.decrypt(
decryption_shares
.iter()
.map(|(peer, share)| (peer.to_usize(), &share.0)),
&contract.encrypted_preimage.0,
) else {
error!(contract_hash = %contract.hash, "Failed to decrypt preimage");
return Ok(());
};
dbtx.remove_entry(&ProposeDecryptionShareKey(contract_id))
.await;
dbtx.remove_by_prefix(&AgreedDecryptionShareContractIdPrefix(contract_id))
.await;
let decrypted_preimage = if preimage_vec.len() == 33
&& contract.hash
== sha256::Hash::hash(&sha256::Hash::hash(&preimage_vec).to_byte_array())
{
let preimage = PreimageKey(
preimage_vec
.as_slice()
.try_into()
.expect("Invalid preimage length"),
);
if preimage.to_public_key().is_ok() {
DecryptedPreimage::Some(preimage)
} else {
DecryptedPreimage::Invalid
}
} else {
DecryptedPreimage::Invalid
};
debug!(?decrypted_preimage);
let contract_db_key = ContractKey(contract_id);
let mut contract_account = dbtx
.get_value(&contract_db_key)
.await
.expect("checked before that it exists");
let incoming = match &mut contract_account.contract {
FundedContract::Incoming(incoming) => incoming,
FundedContract::Outgoing(_) => {
unreachable!("previously checked that it's an incoming contract")
}
};
incoming.contract.decrypted_preimage = decrypted_preimage.clone();
trace!(?contract_account, "Updating contract account");
dbtx.insert_entry(&contract_db_key, &contract_account).await;
let mut outcome = dbtx
.get_value(&ContractUpdateKey(out_point))
.await
.expect("outcome was created on funding");
let LightningOutputOutcomeV0::Contract {
outcome: ContractOutcome::Incoming(incoming_contract_outcome_preimage),
..
} = &mut outcome
else {
panic!("We are expecting an incoming contract")
};
*incoming_contract_outcome_preimage = decrypted_preimage.clone();
dbtx.insert_entry(&ContractUpdateKey(out_point), &outcome)
.await;
}
LightningConsensusItem::BlockCount(block_count) => {
let current_vote = dbtx
.get_value(&BlockCountVoteKey(peer_id))
.await
.unwrap_or(0);
if block_count < current_vote {
bail!("Block count vote decreased");
}
if block_count == current_vote {
bail!("Block height vote is redundant");
}
dbtx.insert_entry(&BlockCountVoteKey(peer_id), &block_count)
.await;
}
LightningConsensusItem::Default { variant, .. } => {
bail!("Unknown lightning consensus item received, variant={variant}");
}
}
Ok(())
}
async fn process_input<'a, 'b, 'c>(
&'a self,
dbtx: &mut DatabaseTransaction<'c>,
input: &'b LightningInput,
) -> Result<InputMeta, LightningInputError> {
let input = input.ensure_v0_ref()?;
let mut account = dbtx
.get_value(&ContractKey(input.contract_id))
.await
.ok_or(LightningInputError::UnknownContract(input.contract_id))?;
if account.amount < input.amount {
return Err(LightningInputError::InsufficientFunds(
account.amount,
input.amount,
));
}
let consensus_block_count = self.consensus_block_count(dbtx).await;
let pub_key = match &account.contract {
FundedContract::Outgoing(outgoing) => {
if u64::from(outgoing.timelock) + 1 > consensus_block_count && !outgoing.cancelled {
let preimage_hash = bitcoin_hashes::sha256::Hash::hash(
&input
.witness
.as_ref()
.ok_or(LightningInputError::MissingPreimage)?
.0,
);
if preimage_hash != outgoing.hash {
return Err(LightningInputError::InvalidPreimage);
}
outgoing.gateway_key
} else {
outgoing.user_key
}
}
FundedContract::Incoming(incoming) => match &incoming.contract.decrypted_preimage {
DecryptedPreimage::Pending => {
return Err(LightningInputError::ContractNotReady);
}
DecryptedPreimage::Some(preimage) => match preimage.to_public_key() {
Ok(pub_key) => pub_key,
Err(_) => return Err(LightningInputError::InvalidPreimage),
},
DecryptedPreimage::Invalid => incoming.contract.gateway_key,
},
};
account.amount -= input.amount;
dbtx.insert_entry(&ContractKey(input.contract_id), &account)
.await;
let audit_key = LightningAuditItemKey::from_funded_contract(&account.contract);
if account.amount.msats == 0 {
dbtx.remove_entry(&audit_key).await;
} else {
dbtx.insert_entry(&audit_key, &account.amount).await;
}
Ok(InputMeta {
amount: TransactionItemAmount {
amount: input.amount,
fee: self.cfg.consensus.fee_consensus.contract_input,
},
pub_key,
})
}
async fn process_output<'a, 'b>(
&'a self,
dbtx: &mut DatabaseTransaction<'b>,
output: &'a LightningOutput,
out_point: OutPoint,
) -> Result<TransactionItemAmount, LightningOutputError> {
let output = output.ensure_v0_ref()?;
match output {
LightningOutputV0::Contract(contract) => {
if let Contract::Incoming(incoming) = &contract.contract {
let offer = dbtx
.get_value(&OfferKey(incoming.hash))
.await
.ok_or(LightningOutputError::NoOffer(incoming.hash))?;
if contract.amount < offer.amount {
return Err(LightningOutputError::InsufficientIncomingFunding(
offer.amount,
contract.amount,
));
}
}
if contract.amount == Amount::ZERO {
return Err(LightningOutputError::ZeroOutput);
}
let contract_db_key = ContractKey(contract.contract.contract_id());
let updated_contract_account = dbtx.get_value(&contract_db_key).await.map_or_else(
|| ContractAccount {
amount: contract.amount,
contract: contract.contract.clone().to_funded(out_point),
},
|mut value: ContractAccount| {
value.amount += contract.amount;
value
},
);
dbtx.insert_entry(
&LightningAuditItemKey::from_funded_contract(
&updated_contract_account.contract,
),
&updated_contract_account.amount,
)
.await;
if dbtx
.insert_entry(&contract_db_key, &updated_contract_account)
.await
.is_none()
{
dbtx.on_commit(move || {
record_funded_contract_metric(&updated_contract_account);
});
}
dbtx.insert_new_entry(
&ContractUpdateKey(out_point),
&LightningOutputOutcomeV0::Contract {
id: contract.contract.contract_id(),
outcome: contract.contract.to_outcome(),
},
)
.await;
if let Contract::Incoming(incoming) = &contract.contract {
let offer = dbtx
.get_value(&OfferKey(incoming.hash))
.await
.expect("offer exists if output is valid");
let decryption_share = self
.cfg
.private
.threshold_sec_key
.decrypt_share(&incoming.encrypted_preimage.0)
.expect("We checked for decryption share validity on contract creation");
dbtx.insert_new_entry(
&ProposeDecryptionShareKey(contract.contract.contract_id()),
&PreimageDecryptionShare(decryption_share),
)
.await;
dbtx.remove_entry(&OfferKey(offer.hash)).await;
}
Ok(TransactionItemAmount {
amount: contract.amount,
fee: self.cfg.consensus.fee_consensus.contract_output,
})
}
LightningOutputV0::Offer(offer) => {
if !offer.encrypted_preimage.0.verify() {
return Err(LightningOutputError::InvalidEncryptedPreimage);
}
if dbtx
.insert_entry(
&EncryptedPreimageIndexKey(offer.encrypted_preimage.consensus_hash()),
&(),
)
.await
.is_some()
{
return Err(LightningOutputError::DuplicateEncryptedPreimage);
}
dbtx.insert_new_entry(
&ContractUpdateKey(out_point),
&LightningOutputOutcomeV0::Offer { id: offer.id() },
)
.await;
dbtx.insert_new_entry(&OfferKey(offer.hash), &(*offer).clone())
.await;
dbtx.on_commit(|| {
LN_INCOMING_OFFER.inc();
});
Ok(TransactionItemAmount::ZERO)
}
LightningOutputV0::CancelOutgoing {
contract,
gateway_signature,
} => {
let contract_account = dbtx
.get_value(&ContractKey(*contract))
.await
.ok_or(LightningOutputError::UnknownContract(*contract))?;
let outgoing_contract = match &contract_account.contract {
FundedContract::Outgoing(contract) => contract,
FundedContract::Incoming(_) => {
return Err(LightningOutputError::NotOutgoingContract);
}
};
SECP256K1
.verify_schnorr(
gateway_signature,
&Message::from_digest(*outgoing_contract.cancellation_message().as_ref()),
&outgoing_contract.gateway_key.x_only_public_key().0,
)
.map_err(|_| LightningOutputError::InvalidCancellationSignature)?;
let updated_contract_account = {
let mut contract_account = dbtx
.get_value(&ContractKey(*contract))
.await
.expect("Contract exists if output is valid");
let outgoing_contract = match &mut contract_account.contract {
FundedContract::Outgoing(contract) => contract,
FundedContract::Incoming(_) => {
panic!("Contract type was checked in validate_output");
}
};
outgoing_contract.cancelled = true;
contract_account
};
dbtx.insert_entry(&ContractKey(*contract), &updated_contract_account)
.await;
dbtx.insert_new_entry(
&ContractUpdateKey(out_point),
&LightningOutputOutcomeV0::CancelOutgoingContract { id: *contract },
)
.await;
dbtx.on_commit(|| {
LN_CANCEL_OUTGOING_CONTRACTS.inc();
});
Ok(TransactionItemAmount::ZERO)
}
}
}
async fn output_status(
&self,
dbtx: &mut DatabaseTransaction<'_>,
out_point: OutPoint,
) -> Option<LightningOutputOutcome> {
dbtx.get_value(&ContractUpdateKey(out_point))
.await
.map(LightningOutputOutcome::V0)
}
async fn audit(
&self,
dbtx: &mut DatabaseTransaction<'_>,
audit: &mut Audit,
module_instance_id: ModuleInstanceId,
) {
audit
.add_items(
dbtx,
module_instance_id,
&LightningAuditItemKeyPrefix,
|_, v| -(v.msats as i64),
)
.await;
}
fn api_endpoints(&self) -> Vec<ApiEndpoint<Self>> {
vec![
api_endpoint! {
BLOCK_COUNT_ENDPOINT,
ApiVersion::new(0, 0),
async |module: &Lightning, context, _v: ()| -> Option<u64> {
Ok(Some(module.consensus_block_count(&mut context.dbtx().into_nc()).await))
}
},
api_endpoint! {
ACCOUNT_ENDPOINT,
ApiVersion::new(0, 0),
async |module: &Lightning, context, contract_id: ContractId| -> Option<ContractAccount> {
Ok(module
.get_contract_account(&mut context.dbtx().into_nc(), contract_id)
.await)
}
},
api_endpoint! {
AWAIT_ACCOUNT_ENDPOINT,
ApiVersion::new(0, 0),
async |module: &Lightning, context, contract_id: ContractId| -> ContractAccount {
Ok(module
.wait_contract_account(context, contract_id)
.await)
}
},
api_endpoint! {
AWAIT_BLOCK_HEIGHT_ENDPOINT,
ApiVersion::new(0, 0),
async |module: &Lightning, context, block_height: u64| -> () {
module.wait_block_height(block_height, &mut context.dbtx().into_nc()).await;
Ok(())
}
},
api_endpoint! {
AWAIT_OUTGOING_CONTRACT_CANCELLED_ENDPOINT,
ApiVersion::new(0, 0),
async |module: &Lightning, context, contract_id: ContractId| -> ContractAccount {
Ok(module.wait_outgoing_contract_account_cancelled(context, contract_id).await)
}
},
api_endpoint! {
GET_DECRYPTED_PREIMAGE_STATUS,
ApiVersion::new(0, 0),
async |module: &Lightning, context, contract_id: ContractId| -> (IncomingContractAccount, DecryptedPreimageStatus) {
Ok(module.get_decrypted_preimage_status(context, contract_id).await)
}
},
api_endpoint! {
AWAIT_PREIMAGE_DECRYPTION,
ApiVersion::new(0, 0),
async |module: &Lightning, context, contract_id: ContractId| -> (IncomingContractAccount, Option<Preimage>) {
Ok(module.wait_preimage_decrypted(context, contract_id).await)
}
},
api_endpoint! {
OFFER_ENDPOINT,
ApiVersion::new(0, 0),
async |module: &Lightning, context, payment_hash: bitcoin_hashes::sha256::Hash| -> Option<IncomingContractOffer> {
Ok(module
.get_offer(&mut context.dbtx().into_nc(), payment_hash)
.await)
}
},
api_endpoint! {
AWAIT_OFFER_ENDPOINT,
ApiVersion::new(0, 0),
async |module: &Lightning, context, payment_hash: bitcoin_hashes::sha256::Hash| -> IncomingContractOffer {
Ok(module
.wait_offer(context, payment_hash)
.await)
}
},
api_endpoint! {
LIST_GATEWAYS_ENDPOINT,
ApiVersion::new(0, 0),
async |module: &Lightning, context, _v: ()| -> Vec<LightningGatewayAnnouncement> {
Ok(module.list_gateways(&mut context.dbtx().into_nc()).await)
}
},
api_endpoint! {
REGISTER_GATEWAY_ENDPOINT,
ApiVersion::new(0, 0),
async |module: &Lightning, context, gateway: LightningGatewayAnnouncement| -> () {
module.register_gateway(&mut context.dbtx().into_nc(), gateway).await;
Ok(())
}
},
api_endpoint! {
REMOVE_GATEWAY_CHALLENGE_ENDPOINT,
ApiVersion::new(0, 1),
async |module: &Lightning, context, gateway_id: PublicKey| -> Option<sha256::Hash> {
Ok(module.get_gateway_remove_challenge(gateway_id, &mut context.dbtx().into_nc()).await)
}
},
api_endpoint! {
REMOVE_GATEWAY_ENDPOINT,
ApiVersion::new(0, 1),
async |module: &Lightning, context, remove_gateway_request: RemoveGatewayRequest| -> bool {
match module.remove_gateway(remove_gateway_request.clone(), &mut context.dbtx().into_nc()).await {
Ok(()) => Ok(true),
Err(e) => {
warn!("Unable to remove gateway registration {remove_gateway_request:?} Error: {e:?}");
Ok(false)
},
}
}
},
]
}
}
impl Lightning {
fn new(cfg: LightningConfig, our_peer_id: PeerId) -> anyhow::Result<Self> {
let btc_rpc = create_bitcoind(&cfg.local.bitcoin_rpc)?;
Ok(Lightning {
cfg,
btc_rpc,
our_peer_id,
})
}
async fn block_count(&self) -> anyhow::Result<u64> {
let res = self.btc_rpc.get_block_count().await;
if let Err(ref err) = res {
error!("Error while calling get_block_count: {:?}", err);
}
res
}
async fn consensus_block_count(&self, dbtx: &mut DatabaseTransaction<'_>) -> u64 {
let peer_count = 3 * (self.cfg.consensus.threshold() / 2) + 1;
let mut counts = dbtx
.find_by_prefix(&BlockCountVotePrefix)
.await
.map(|(.., count)| count)
.collect::<Vec<_>>()
.await;
assert!(counts.len() <= peer_count);
while counts.len() < peer_count {
counts.push(0);
}
counts.sort_unstable();
counts[peer_count / 2]
}
async fn wait_block_height(&self, block_height: u64, dbtx: &mut DatabaseTransaction<'_>) {
while block_height >= self.consensus_block_count(dbtx).await {
sleep(Duration::from_secs(5)).await;
}
}
fn validate_decryption_share(
&self,
peer: PeerId,
share: &PreimageDecryptionShare,
message: &EncryptedPreimage,
) -> bool {
self.cfg
.consensus
.threshold_pub_keys
.public_key_share(peer.to_usize())
.verify_decryption_share(&share.0, &message.0)
}
async fn get_offer(
&self,
dbtx: &mut DatabaseTransaction<'_>,
payment_hash: bitcoin_hashes::sha256::Hash,
) -> Option<IncomingContractOffer> {
dbtx.get_value(&OfferKey(payment_hash)).await
}
async fn wait_offer(
&self,
context: &mut ApiEndpointContext<'_>,
payment_hash: bitcoin_hashes::sha256::Hash,
) -> IncomingContractOffer {
let future = context.wait_key_exists(OfferKey(payment_hash));
future.await
}
async fn get_contract_account(
&self,
dbtx: &mut DatabaseTransaction<'_>,
contract_id: ContractId,
) -> Option<ContractAccount> {
dbtx.get_value(&ContractKey(contract_id)).await
}
async fn wait_contract_account(
&self,
context: &mut ApiEndpointContext<'_>,
contract_id: ContractId,
) -> ContractAccount {
let future = context.wait_key_exists(ContractKey(contract_id));
future.await
}
async fn wait_outgoing_contract_account_cancelled(
&self,
context: &mut ApiEndpointContext<'_>,
contract_id: ContractId,
) -> ContractAccount {
let future =
context.wait_value_matches(ContractKey(contract_id), |contract| {
match &contract.contract {
FundedContract::Outgoing(c) => c.cancelled,
FundedContract::Incoming(_) => false,
}
});
future.await
}
async fn get_decrypted_preimage_status(
&self,
context: &mut ApiEndpointContext<'_>,
contract_id: ContractId,
) -> (IncomingContractAccount, DecryptedPreimageStatus) {
let f_contract = context.wait_key_exists(ContractKey(contract_id));
let contract = f_contract.await;
let incoming_contract_account = Self::get_incoming_contract_account(contract);
match &incoming_contract_account.contract.decrypted_preimage {
DecryptedPreimage::Some(key) => (
incoming_contract_account.clone(),
DecryptedPreimageStatus::Some(Preimage(sha256::Hash::hash(&key.0).to_byte_array())),
),
DecryptedPreimage::Pending => {
(incoming_contract_account, DecryptedPreimageStatus::Pending)
}
DecryptedPreimage::Invalid => {
(incoming_contract_account, DecryptedPreimageStatus::Invalid)
}
}
}
async fn wait_preimage_decrypted(
&self,
context: &mut ApiEndpointContext<'_>,
contract_id: ContractId,
) -> (IncomingContractAccount, Option<Preimage>) {
let future =
context.wait_value_matches(ContractKey(contract_id), |contract| {
match &contract.contract {
FundedContract::Incoming(c) => match c.contract.decrypted_preimage {
DecryptedPreimage::Pending => false,
DecryptedPreimage::Some(_) | DecryptedPreimage::Invalid => true,
},
FundedContract::Outgoing(_) => false,
}
});
let decrypt_preimage = future.await;
let incoming_contract_account = Self::get_incoming_contract_account(decrypt_preimage);
match incoming_contract_account
.clone()
.contract
.decrypted_preimage
{
DecryptedPreimage::Some(key) => (
incoming_contract_account,
Some(Preimage(sha256::Hash::hash(&key.0).to_byte_array())),
),
_ => (incoming_contract_account, None),
}
}
fn get_incoming_contract_account(contract: ContractAccount) -> IncomingContractAccount {
if let FundedContract::Incoming(incoming) = contract.contract {
return IncomingContractAccount {
amount: contract.amount,
contract: incoming.contract,
};
}
panic!("Contract is not an IncomingContractAccount");
}
async fn list_gateways(
&self,
dbtx: &mut DatabaseTransaction<'_>,
) -> Vec<LightningGatewayAnnouncement> {
let stream = dbtx.find_by_prefix(&LightningGatewayKeyPrefix).await;
stream
.filter_map(|(_, gw)| async {
if gw.is_expired() {
None
} else {
Some(gw)
}
})
.collect::<Vec<LightningGatewayRegistration>>()
.await
.into_iter()
.map(LightningGatewayRegistration::unanchor)
.collect::<Vec<LightningGatewayAnnouncement>>()
}
async fn register_gateway(
&self,
dbtx: &mut DatabaseTransaction<'_>,
gateway: LightningGatewayAnnouncement,
) {
self.delete_expired_gateways(dbtx).await;
dbtx.insert_entry(
&LightningGatewayKey(gateway.info.gateway_id),
&gateway.anchor(),
)
.await;
}
async fn delete_expired_gateways(&self, dbtx: &mut DatabaseTransaction<'_>) {
let expired_gateway_keys = dbtx
.find_by_prefix(&LightningGatewayKeyPrefix)
.await
.filter_map(|(key, gw)| async move {
if gw.is_expired() {
Some(key)
} else {
None
}
})
.collect::<Vec<LightningGatewayKey>>()
.await;
for key in expired_gateway_keys {
dbtx.remove_entry(&key).await;
}
}
async fn get_gateway_remove_challenge(
&self,
gateway_id: PublicKey,
dbtx: &mut DatabaseTransaction<'_>,
) -> Option<sha256::Hash> {
if let Some(gateway) = dbtx.get_value(&LightningGatewayKey(gateway_id)).await {
let mut valid_until_bytes = gateway.valid_until.to_bytes();
let mut challenge_bytes = gateway_id.to_bytes();
challenge_bytes.append(&mut valid_until_bytes);
Some(sha256::Hash::hash(&challenge_bytes))
} else {
None
}
}
async fn remove_gateway(
&self,
remove_gateway_request: RemoveGatewayRequest,
dbtx: &mut DatabaseTransaction<'_>,
) -> anyhow::Result<()> {
let fed_public_key = self.cfg.consensus.threshold_pub_keys.public_key();
let gateway_id = remove_gateway_request.gateway_id;
let our_peer_id = self.our_peer_id;
let signature = remove_gateway_request
.signatures
.get(&our_peer_id)
.ok_or_else(|| {
warn!("No signature provided for gateway: {gateway_id}");
anyhow::anyhow!("No signature provided for gateway {gateway_id}")
})?;
let challenge = self
.get_gateway_remove_challenge(gateway_id, dbtx)
.await
.ok_or(anyhow::anyhow!(
"Gateway {gateway_id} is not registered with peer {our_peer_id}"
))?;
let msg = create_gateway_remove_message(fed_public_key, our_peer_id, challenge);
signature.verify(&msg, &gateway_id.x_only_public_key().0)?;
dbtx.remove_entry(&LightningGatewayKey(gateway_id)).await;
info!("Successfully removed gateway: {gateway_id}");
Ok(())
}
}
fn record_funded_contract_metric(updated_contract_account: &ContractAccount) {
LN_FUNDED_CONTRACT_SATS
.with_label_values(&[match updated_contract_account.contract {
FundedContract::Incoming(_) => "incoming",
FundedContract::Outgoing(_) => "outgoing",
}])
.observe(updated_contract_account.amount.sats_f64());
}
#[cfg(test)]
mod tests {
use assert_matches::assert_matches;
use bitcoin_hashes::{sha256, Hash as BitcoinHash};
use fedimint_core::config::ConfigGenModuleParams;
use fedimint_core::db::mem_impl::MemDatabase;
use fedimint_core::db::{Database, IDatabaseTransactionOpsCoreTyped};
use fedimint_core::encoding::Encodable;
use fedimint_core::envs::BitcoinRpcConfig;
use fedimint_core::module::registry::ModuleRegistry;
use fedimint_core::module::{InputMeta, ServerModuleInit, TransactionItemAmount};
use fedimint_core::secp256k1::{generate_keypair, PublicKey};
use fedimint_core::{Amount, OutPoint, PeerId, ServerModule, TransactionId};
use fedimint_ln_common::config::{
LightningClientConfig, LightningConfig, LightningGenParams, LightningGenParamsConsensus,
LightningGenParamsLocal, Network,
};
use fedimint_ln_common::contracts::incoming::{
FundedIncomingContract, IncomingContract, IncomingContractOffer,
};
use fedimint_ln_common::contracts::outgoing::OutgoingContract;
use fedimint_ln_common::contracts::{
DecryptedPreimage, EncryptedPreimage, FundedContract, IdentifiableContract, Preimage,
PreimageKey,
};
use fedimint_ln_common::{ContractAccount, LightningInput, LightningOutput};
use rand::rngs::OsRng;
use crate::db::{ContractKey, LightningAuditItemKey};
use crate::{Lightning, LightningInit};
const MINTS: u16 = 4;
fn build_configs() -> (Vec<LightningConfig>, LightningClientConfig) {
let peers = (0..MINTS).map(PeerId::from).collect::<Vec<_>>();
let server_cfg = ServerModuleInit::trusted_dealer_gen(
&LightningInit,
&peers,
&ConfigGenModuleParams::from_typed(LightningGenParams {
local: LightningGenParamsLocal {
bitcoin_rpc: BitcoinRpcConfig {
kind: "bitcoind".to_string(),
url: "http://localhost:18332".parse().unwrap(),
},
},
consensus: LightningGenParamsConsensus {
network: Network::Regtest,
},
})
.expect("valid config params"),
);
let client_cfg = ServerModuleInit::get_client_config(
&LightningInit,
&server_cfg[&PeerId::from(0)].consensus,
)
.unwrap();
let server_cfg = server_cfg
.into_values()
.map(|config| {
config
.to_typed()
.expect("Config was just generated by the same configgen")
})
.collect::<Vec<LightningConfig>>();
(server_cfg, client_cfg)
}
fn random_pub_key() -> PublicKey {
generate_keypair(&mut OsRng).1
}
#[test_log::test(tokio::test)]
async fn encrypted_preimage_only_usable_once() {
let (server_cfg, client_cfg) = build_configs();
let server = Lightning::new(server_cfg[0].clone(), 0.into()).unwrap();
let preimage = [42u8; 32];
let encrypted_preimage = EncryptedPreimage(client_cfg.threshold_pub_key.encrypt([42; 32]));
let hash = preimage.consensus_hash();
let offer = IncomingContractOffer {
amount: Amount::from_sats(10),
hash,
encrypted_preimage: encrypted_preimage.clone(),
expiry_time: None,
};
let output = LightningOutput::new_v0_offer(offer);
let out_point = OutPoint {
txid: TransactionId::all_zeros(),
out_idx: 0,
};
let db = Database::new(MemDatabase::new(), ModuleRegistry::default());
let mut dbtx = db.begin_transaction_nc().await;
server
.process_output(
&mut dbtx.to_ref_with_prefix_module_id(42).0.into_nc(),
&output,
out_point,
)
.await
.expect("First time works");
let hash2 = [21u8, 32].consensus_hash();
let offer2 = IncomingContractOffer {
amount: Amount::from_sats(1),
hash: hash2,
encrypted_preimage,
expiry_time: None,
};
let output2 = LightningOutput::new_v0_offer(offer2);
let out_point2 = OutPoint {
txid: TransactionId::all_zeros(),
out_idx: 1,
};
assert_matches!(
server
.process_output(
&mut dbtx.to_ref_with_prefix_module_id(42).0.into_nc(),
&output2,
out_point2
)
.await,
Err(_)
);
}
#[test_log::test(tokio::test)]
async fn process_input_for_valid_incoming_contracts() {
let (server_cfg, client_cfg) = build_configs();
let db = Database::new(MemDatabase::new(), ModuleRegistry::default());
let mut dbtx = db.begin_transaction_nc().await;
let mut module_dbtx = dbtx.to_ref_with_prefix_module_id(42).0;
let server = Lightning::new(server_cfg[0].clone(), 0.into()).unwrap();
let preimage = PreimageKey(generate_keypair(&mut OsRng).1.serialize());
let funded_incoming_contract = FundedContract::Incoming(FundedIncomingContract {
contract: IncomingContract {
hash: sha256::Hash::hash(&sha256::Hash::hash(&preimage.0).to_byte_array()),
encrypted_preimage: EncryptedPreimage(
client_cfg.threshold_pub_key.encrypt(preimage.0),
),
decrypted_preimage: DecryptedPreimage::Some(preimage.clone()),
gateway_key: random_pub_key(),
},
out_point: OutPoint {
txid: TransactionId::all_zeros(),
out_idx: 0,
},
});
let contract_id = funded_incoming_contract.contract_id();
let audit_key = LightningAuditItemKey::from_funded_contract(&funded_incoming_contract);
let amount = Amount { msats: 1000 };
let lightning_input = LightningInput::new_v0(contract_id, amount, None);
module_dbtx.insert_new_entry(&audit_key, &amount).await;
module_dbtx
.insert_new_entry(
&ContractKey(contract_id),
&ContractAccount {
amount,
contract: funded_incoming_contract,
},
)
.await;
let processed_input_meta = server
.process_input(&mut module_dbtx.to_ref_nc(), &lightning_input)
.await
.expect("should process valid incoming contract");
let expected_input_meta = InputMeta {
amount: TransactionItemAmount {
amount,
fee: Amount { msats: 0 },
},
pub_key: preimage
.to_public_key()
.expect("should create Schnorr pubkey from preimage"),
};
assert_eq!(processed_input_meta, expected_input_meta);
let audit_item = module_dbtx.get_value(&audit_key).await;
assert_eq!(audit_item, None);
}
#[test_log::test(tokio::test)]
async fn process_input_for_valid_outgoing_contracts() {
let (server_cfg, _) = build_configs();
let db = Database::new(MemDatabase::new(), ModuleRegistry::default());
let mut dbtx = db.begin_transaction_nc().await;
let mut module_dbtx = dbtx.to_ref_with_prefix_module_id(42).0;
let server = Lightning::new(server_cfg[0].clone(), 0.into()).unwrap();
let preimage = Preimage([42u8; 32]);
let gateway_key = random_pub_key();
let outgoing_contract = FundedContract::Outgoing(OutgoingContract {
hash: preimage.consensus_hash(),
gateway_key,
timelock: 1_000_000,
user_key: random_pub_key(),
cancelled: false,
});
let contract_id = outgoing_contract.contract_id();
let audit_key = LightningAuditItemKey::from_funded_contract(&outgoing_contract);
let amount = Amount { msats: 1000 };
let lightning_input = LightningInput::new_v0(contract_id, amount, Some(preimage.clone()));
module_dbtx.insert_new_entry(&audit_key, &amount).await;
module_dbtx
.insert_new_entry(
&ContractKey(contract_id),
&ContractAccount {
amount,
contract: outgoing_contract,
},
)
.await;
let processed_input_meta = server
.process_input(&mut module_dbtx.to_ref_nc(), &lightning_input)
.await
.expect("should process valid outgoing contract");
let expected_input_meta = InputMeta {
amount: TransactionItemAmount {
amount,
fee: Amount { msats: 0 },
},
pub_key: gateway_key,
};
assert_eq!(processed_input_meta, expected_input_meta);
let audit_item = module_dbtx.get_value(&audit_key).await;
assert_eq!(audit_item, None);
}
}