package client import ( "context" "crypto/rand" "crypto/sha256" "fmt" "time" "github.com/btcsuite/btcd/wire" "github.com/btcsuite/btcutil" "github.com/lightninglabs/loop/lndclient" "github.com/lightninglabs/loop/sweep" "github.com/lightninglabs/loop/utils" "github.com/lightningnetwork/lnd/chainntnfs" "github.com/lightningnetwork/lnd/lntypes" ) var ( // MinUnchargePreimageRevealDelta configures the minimum number of remaining // blocks before htlc expiry required to reveal preimage. MinUnchargePreimageRevealDelta = int32(20) ) // unchargeSwap contains all the in-memory state related to a pending uncharge // swap. type unchargeSwap struct { swapKit UnchargeContract swapPaymentChan chan lndclient.PaymentResult prePaymentChan chan lndclient.PaymentResult } // executeConfig contains extra configuration to execute the swap. type executeConfig struct { sweeper *sweep.Sweeper statusChan chan<- SwapInfo blockEpochChan <-chan interface{} timerFactory func(d time.Duration) <-chan time.Time } // newUnchargeSwap initiates a new swap with the server and returns a // corresponding swap object. func newUnchargeSwap(globalCtx context.Context, cfg *swapConfig, currentHeight int32, request *UnchargeRequest) (*unchargeSwap, error) { // Generate random preimage. var swapPreimage [32]byte if _, err := rand.Read(swapPreimage[:]); err != nil { logger.Error("Cannot generate preimage") } swapHash := lntypes.Hash(sha256.Sum256(swapPreimage[:])) // Derive a receiver key for this swap. keyDesc, err := cfg.lnd.WalletKit.DeriveNextKey( globalCtx, utils.SwapKeyFamily, ) if err != nil { return nil, err } var receiverKey [33]byte copy(receiverKey[:], keyDesc.PubKey.SerializeCompressed()) // Post the swap parameters to the swap server. The response contains // the server revocation key and the swap and prepay invoices. logger.Infof("Initiating swap request at height %v", currentHeight) swapResp, err := cfg.server.NewUnchargeSwap(globalCtx, swapHash, request.Amount, receiverKey, ) if err != nil { return nil, fmt.Errorf("cannot initiate swap: %v", err) } err = validateUnchargeContract(cfg.lnd, currentHeight, request, swapResp) if err != nil { return nil, err } // Instantie a struct that contains all required data to start the swap. initiationTime := time.Now() contract := UnchargeContract{ SwapInvoice: swapResp.swapInvoice, DestAddr: request.DestAddr, MaxSwapRoutingFee: request.MaxSwapRoutingFee, SweepConfTarget: request.SweepConfTarget, UnchargeChannel: request.UnchargeChannel, SwapContract: SwapContract{ InitiationHeight: currentHeight, InitiationTime: initiationTime, PrepayInvoice: swapResp.prepayInvoice, ReceiverKey: receiverKey, SenderKey: swapResp.senderKey, Preimage: swapPreimage, AmountRequested: request.Amount, CltvExpiry: swapResp.expiry, MaxMinerFee: request.MaxMinerFee, MaxSwapFee: request.MaxSwapFee, MaxPrepayRoutingFee: request.MaxPrepayRoutingFee, }, } swapKit, err := newSwapKit( swapHash, SwapTypeUncharge, cfg, &contract.SwapContract, ) if err != nil { return nil, err } swapKit.lastUpdateTime = initiationTime swap := &unchargeSwap{ UnchargeContract: contract, swapKit: *swapKit, } // Persist the data before exiting this function, so that the caller can // trust that this swap will be resumed on restart. err = cfg.store.createUncharge(swapHash, &swap.UnchargeContract) if err != nil { return nil, fmt.Errorf("cannot store swap: %v", err) } return swap, nil } // resumeUnchargeSwap returns a swap object representing a pending swap that has // been restored from the database. func resumeUnchargeSwap(reqContext context.Context, cfg *swapConfig, pend *PersistentUncharge) (*unchargeSwap, error) { hash := lntypes.Hash(sha256.Sum256(pend.Contract.Preimage[:])) logger.Infof("Resuming swap %v", hash) swapKit, err := newSwapKit( hash, SwapTypeUncharge, cfg, &pend.Contract.SwapContract, ) if err != nil { return nil, err } swap := &unchargeSwap{ UnchargeContract: *pend.Contract, swapKit: *swapKit, } lastUpdate := pend.LastUpdate() if lastUpdate == nil { swap.lastUpdateTime = pend.Contract.InitiationTime } else { swap.state = lastUpdate.State swap.lastUpdateTime = lastUpdate.Time } return swap, nil } // execute starts/resumes the swap. It is a thin wrapper around // executeAndFinalize to conveniently handle the error case. func (s *unchargeSwap) execute(mainCtx context.Context, cfg *executeConfig, height int32) error { s.executeConfig = *cfg s.height = height err := s.executeAndFinalize(mainCtx) // If an unexpected error happened, report a temporary failure. // Otherwise for example a connection error could lead to abandoning the // swap permanently and losing funds. if err != nil { s.log.Errorf("Swap error: %v", err) s.state = StateFailTemporary // If we cannot send out this update, there is nothing we can do. _ = s.sendUpdate(mainCtx) } return err } // executeAndFinalize executes a swap and awaits the definitive outcome of the // offchain payments. When this method returns, the swap outcome is final. func (s *unchargeSwap) executeAndFinalize(globalCtx context.Context) error { // Announce swap by sending out an initial update. err := s.sendUpdate(globalCtx) if err != nil { return err } // Execute swap. When this call returns, the swap outcome is final, but // it may be that there are still off-chain payments pending. err = s.executeSwap(globalCtx) if err != nil { return err } // Sanity check. if s.state.Type() == StateTypePending { return fmt.Errorf("swap in non-final state %v", s.state) } // Wait until all offchain payments have completed. If payments have // already completed early, their channels have been set to nil. s.log.Infof("Wait for server pulling off-chain payment(s)") for s.swapPaymentChan != nil || s.prePaymentChan != nil { select { case result := <-s.swapPaymentChan: s.swapPaymentChan = nil if result.Err != nil { // Server didn't pull the swap payment. s.log.Infof("Swap payment failed: %v", result.Err) continue } s.cost.Server += result.PaidAmt case result := <-s.prePaymentChan: s.prePaymentChan = nil if result.Err != nil { // Server didn't pull the prepayment. s.log.Infof("Prepayment failed: %v", result.Err) continue } s.cost.Server += result.PaidAmt case <-globalCtx.Done(): return globalCtx.Err() } } // Mark swap completed in store. s.log.Infof("Swap completed: %v "+ "(final cost: server %v, onchain %v)", s.state, s.cost.Server, s.cost.Onchain, ) return s.persistState(globalCtx) } // executeSwap executes the swap, but returns as soon as the swap outcome is // final. At that point, there may still be pending off-chain payment(s). func (s *unchargeSwap) executeSwap(globalCtx context.Context) error { // We always pay both invoices (again). This is currently the only way // to sort of resume payments. // // TODO: We shouldn't pay the invoices if it is already too late to // start the swap. But because we don't know if we already fired the // payments in a previous run, we cannot just abandon here. s.payInvoices(globalCtx) // Wait for confirmation of the on-chain htlc by watching for a tx // producing the swap script output. txConf, err := s.waitForConfirmedHtlc(globalCtx) if err != nil { return err } // If no error and no confirmation, the swap is aborted without an // error. The swap state has been updated to a final state. if txConf == nil { return nil } // TODO: Off-chain payments can be canceled here. Most probably the HTLC // is accepted by the server, but in case there are not for whatever // reason, we don't need to have mission control start another payment // attempt. // Retrieve outpoint for sweep. htlcOutpoint, htlcValue, err := utils.GetScriptOutput( txConf.Tx, s.htlc.ScriptHash, ) if err != nil { return err } s.log.Infof("Htlc value: %v", htlcValue) // Verify amount if preimage hasn't been revealed yet. if s.state != StatePreimageRevealed && htlcValue < s.AmountRequested { logger.Warnf("Swap amount too low, expected %v but received %v", s.AmountRequested, htlcValue) s.state = StateFailInsufficientValue return nil } // Try to spend htlc and continue (rbf) until a spend has confirmed. spendDetails, err := s.waitForHtlcSpendConfirmed(globalCtx, func() error { return s.sweep(globalCtx, *htlcOutpoint, htlcValue) }, ) if err != nil { return err } // Inspect witness stack to see if it is a success transaction. We don't // just try to match with the hash of our sweep tx, because it may be // swept by a different (fee) sweep tx from a previous run. htlcInput, err := getTxInputByOutpoint( spendDetails.SpendingTx, htlcOutpoint, ) if err != nil { return err } sweepSuccessful := s.htlc.IsSuccessWitness(htlcInput.Witness) if sweepSuccessful { s.cost.Server -= htlcValue s.cost.Onchain = htlcValue - btcutil.Amount(spendDetails.SpendingTx.TxOut[0].Value) s.state = StateSuccess } else { s.state = StateFailSweepTimeout } return nil } // persistState updates the swap state and sends out an update notification. func (s *unchargeSwap) persistState(ctx context.Context) error { updateTime := time.Now() s.lastUpdateTime = updateTime // Update state in store. err := s.store.updateUncharge(s.hash, updateTime, s.state) if err != nil { return err } // Send out swap update return s.sendUpdate(ctx) } // payInvoices pays both swap invoices. func (s *unchargeSwap) payInvoices(ctx context.Context) { // Pay the swap invoice. s.log.Infof("Sending swap payment %v", s.SwapInvoice) s.swapPaymentChan = s.lnd.Client.PayInvoice( ctx, s.SwapInvoice, s.MaxSwapRoutingFee, s.UnchargeContract.UnchargeChannel, ) // Pay the prepay invoice. s.log.Infof("Sending prepayment %v", s.PrepayInvoice) s.prePaymentChan = s.lnd.Client.PayInvoice( ctx, s.PrepayInvoice, s.MaxPrepayRoutingFee, nil, ) } // waitForConfirmedHtlc waits for a confirmed htlc to appear on the chain. In // case we haven't revealed the preimage yet, it also monitors block height and // off-chain payment failure. func (s *unchargeSwap) waitForConfirmedHtlc(globalCtx context.Context) ( *chainntnfs.TxConfirmation, error) { // Wait for confirmation of the on-chain htlc by watching for a tx // producing the swap script output. s.log.Infof( "Register conf ntfn for swap script on chain (hh=%v)", s.InitiationHeight, ) ctx, cancel := context.WithCancel(globalCtx) defer cancel() htlcConfChan, htlcErrChan, err := s.lnd.ChainNotifier.RegisterConfirmationsNtfn( ctx, nil, s.htlc.ScriptHash, 1, s.InitiationHeight, ) if err != nil { return nil, err } var txConf *chainntnfs.TxConfirmation if s.state == StateInitiated { // Check if it is already too late to start this swap. If we // already revealed the preimage, this check is irrelevant and // we need to sweep in any case. maxPreimageRevealHeight := s.CltvExpiry - MinUnchargePreimageRevealDelta checkMaxRevealHeightExceeded := func() bool { s.log.Infof("Checking preimage reveal height %v "+ "exceeded (height %v)", maxPreimageRevealHeight, s.height) if s.height <= maxPreimageRevealHeight { return false } s.log.Infof("Max preimage reveal height %v "+ "exceeded (height %v)", maxPreimageRevealHeight, s.height) s.state = StateFailTimeout return true } // First check, because after resume we may otherwise reveal the // preimage after the max height (depending on order in which // events are received in the select loop below). if checkMaxRevealHeightExceeded() { return nil, nil } s.log.Infof("Waiting for either htlc on-chain confirmation or " + " off-chain payment failure") loop: for { select { // If the swap payment fails, abandon the swap. We may // have lost the prepayment. case result := <-s.swapPaymentChan: s.swapPaymentChan = nil if result.Err != nil { s.state = StateFailOffchainPayments s.log.Infof("Failed swap payment: %v", result.Err) return nil, nil } s.cost.Server += result.PaidAmt // If the prepay fails, abandon the swap. Because we // didn't reveal the preimage, the swap payment will be // canceled or time out. case result := <-s.prePaymentChan: s.prePaymentChan = nil if result.Err != nil { s.state = StateFailOffchainPayments s.log.Infof("Failed prepayment: %v", result.Err) return nil, nil } s.cost.Server += result.PaidAmt // Unexpected error on the confirm channel happened, // abandon the swap. case err := <-htlcErrChan: return nil, err // Htlc got confirmed, continue to sweeping. case htlcConfNtfn := <-htlcConfChan: txConf = htlcConfNtfn break loop // New block is received. Recheck max reveal height. case notification := <-s.blockEpochChan: s.height = notification.(int32) logger.Infof("Received block %v", s.height) if checkMaxRevealHeightExceeded() { return nil, nil } // Client quit. case <-globalCtx.Done(): return nil, globalCtx.Err() } } s.log.Infof("Swap script confirmed on chain") } else { s.log.Infof("Retrieving htlc onchain") select { case err := <-htlcErrChan: return nil, err case htlcConfNtfn := <-htlcConfChan: txConf = htlcConfNtfn case <-globalCtx.Done(): return nil, globalCtx.Err() } } s.log.Infof("Htlc tx %v at height %v", txConf.Tx.TxHash(), txConf.BlockHeight) return txConf, nil } // waitForHtlcSpendConfirmed waits for the htlc to be spent either by our own // sweep or a server revocation tx. During this process, this function will try // to spend the htlc every block by calling spendFunc. // // TODO: Improve retry/fee increase mechanism. Once in the mempool, server can // sweep offchain. So we must make sure we sweep successfully before on-chain // timeout. func (s *unchargeSwap) waitForHtlcSpendConfirmed(globalCtx context.Context, spendFunc func() error) (*chainntnfs.SpendDetail, error) { // Register the htlc spend notification. ctx, cancel := context.WithCancel(globalCtx) defer cancel() spendChan, spendErr, err := s.lnd.ChainNotifier.RegisterSpendNtfn( ctx, nil, s.htlc.ScriptHash, s.InitiationHeight, ) if err != nil { return nil, fmt.Errorf("register spend ntfn: %v", err) } timerChan := s.timerFactory(republishDelay) for { select { // Htlc spend, break loop. case spendDetails := <-spendChan: s.log.Infof("Htlc spend by tx: %v", spendDetails.SpenderTxHash) return spendDetails, nil // Spend notification error. case err := <-spendErr: return nil, err // New block arrived, update height and restart the republish // timer. case notification := <-s.blockEpochChan: s.height = notification.(int32) timerChan = s.timerFactory(republishDelay) // Some time after start or after arrival of a new block, try // to spend again. case <-timerChan: err := spendFunc() if err != nil { return nil, err } // Context canceled. case <-globalCtx.Done(): return nil, globalCtx.Err() } } } // sweep tries to sweep the given htlc to a destination address. It takes into // account the max miner fee and marks the preimage as revealed when it // published the tx. // // TODO: Use lnd sweeper? func (s *unchargeSwap) sweep(ctx context.Context, htlcOutpoint wire.OutPoint, htlcValue btcutil.Amount) error { witnessFunc := func(sig []byte) (wire.TxWitness, error) { return s.htlc.GenSuccessWitness( sig, s.Preimage, ) } // Calculate sweep tx fee fee, err := s.sweeper.GetSweepFee( ctx, s.htlc.MaxSuccessWitnessSize, s.SweepConfTarget, ) if err != nil { return err } if fee > s.MaxMinerFee { s.log.Warnf("Required miner fee %v exceeds max of %v", fee, s.MaxMinerFee) if s.state == StatePreimageRevealed { // The currently required fee exceeds the max, but we // already revealed the preimage. The best we can do now // is to republish with the max fee. fee = s.MaxMinerFee } else { s.log.Warnf("Not revealing preimage") return nil } } // Create sweep tx. sweepTx, err := s.sweeper.CreateSweepTx( ctx, s.height, s.htlc, htlcOutpoint, s.ReceiverKey, witnessFunc, htlcValue, fee, s.DestAddr, ) if err != nil { return err } // Before publishing the tx, already mark the preimage as revealed. This // is a precaution in case the publish call never returns and would // leave us thinking we didn't reveal yet. if s.state != StatePreimageRevealed { s.state = StatePreimageRevealed err := s.persistState(ctx) if err != nil { return err } } // Publish tx. s.log.Infof("Sweep on chain HTLC to address %v with fee %v (tx %v)", s.DestAddr, fee, sweepTx.TxHash()) err = s.lnd.WalletKit.PublishTransaction(ctx, sweepTx) if err != nil { s.log.Warnf("Publish sweep: %v", err) } return nil } // validateUnchargeContract validates the contract parameters against our // request. func validateUnchargeContract(lnd *lndclient.LndServices, height int32, request *UnchargeRequest, response *newUnchargeResponse) error { // Check invoice amounts. chainParams := lnd.ChainParams swapInvoiceAmt, err := utils.GetInvoiceAmt( chainParams, response.swapInvoice, ) if err != nil { return err } prepayInvoiceAmt, err := utils.GetInvoiceAmt( chainParams, response.prepayInvoice, ) if err != nil { return err } swapFee := swapInvoiceAmt + prepayInvoiceAmt - request.Amount if swapFee > request.MaxSwapFee { logger.Warnf("Swap fee %v exceeding maximum of %v", swapFee, request.MaxSwapFee) return ErrSwapFeeTooHigh } if prepayInvoiceAmt > request.MaxPrepayAmount { logger.Warnf("Prepay amount %v exceeding maximum of %v", prepayInvoiceAmt, request.MaxPrepayAmount) return ErrPrepayAmountTooHigh } if response.expiry-height < MinUnchargePreimageRevealDelta { logger.Warnf("Proposed expiry %v (delta %v) too soon", response.expiry, response.expiry-height) return ErrExpiryTooSoon } return nil }