sweep

Documentation

Index

• Constants
• func AddOutputEstimate(weightEstimate *input.TxWeightEstimator, destAddr btcutil.Address) error
• func UseLogger(logger btclog.Logger)
• type Sweeper
  • func (s *Sweeper) CreateSweepTx(globalCtx context.Context, height int32, sequence uint32, htlc *swap.Htlc, ...) (*wire.MsgTx, error)
  • func (s *Sweeper) CreateUnsignedTaprootKeySpendSweepTx(ctx context.Context, lockTime uint32, htlc *swap.Htlc, ...) (*wire.MsgTx, []byte, []byte, error)
  • func (s *Sweeper) GetSweepFee(ctx context.Context, addInputEstimate func(*input.TxWeightEstimator) error, ...) (btcutil.Amount, error)
  • func (s *Sweeper) GetSweepFeeDetails(ctx context.Context, addInputEstimate func(*input.TxWeightEstimator) error, ...) (btcutil.Amount, chainfee.SatPerKWeight, lntypes.WeightUnit, error)

Constants

const Subsystem = "SWP"

Subsystem defines the sub system name of this package.

Functions

func AddOutputEstimate

func AddOutputEstimate(weightEstimate *input.TxWeightEstimator,
	destAddr btcutil.Address) error

AddOutputEstimate adds output to weight estimator.

func UseLogger

func UseLogger(logger btclog.Logger)

UseLogger uses a specified Logger to output package logging info. This should be used in preference to SetLogWriter if the caller is also using btclog.

Types

type Sweeper

type Sweeper struct {
	Lnd *lndclient.LndServices
}

Sweeper creates htlc sweep txes.

func (*Sweeper) CreateSweepTx

func (s *Sweeper) CreateSweepTx(
	globalCtx context.Context, height int32, sequence uint32,
	htlc *swap.Htlc, htlcOutpoint wire.OutPoint,
	keyBytes [33]byte, witnessScript []byte,
	witnessFunc func(sig []byte) (wire.TxWitness, error),
	amount, fee btcutil.Amount,
	destAddr btcutil.Address) (*wire.MsgTx, error)

CreateSweepTx creates an htlc sweep tx.

func (*Sweeper) CreateUnsignedTaprootKeySpendSweepTx

func (s *Sweeper) CreateUnsignedTaprootKeySpendSweepTx(
	ctx context.Context, lockTime uint32,
	htlc *swap.Htlc, htlcOutpoint wire.OutPoint,
	amount, fee btcutil.Amount, destAddr btcutil.Address) (
	*wire.MsgTx, []byte, []byte, error)

CreateUnsignedTaprootKeySpendSweepTx creates a taproot htlc sweep tx using keyspend. Returns the raw unsigned txn, the psbt serialized txn, the sighash or an error.

func (*Sweeper) GetSweepFee

func (s *Sweeper) GetSweepFee(ctx context.Context,
	addInputEstimate func(*input.TxWeightEstimator) error,
	destAddr btcutil.Address, sweepConfTarget int32, label string) (
	btcutil.Amount, error)

GetSweepFee calculates the required tx fee to spend to P2WKH. It takes a function that is expected to add the weight of the input to the weight estimator. It also takes a label used for logging.

func (*Sweeper) GetSweepFeeDetails

func (s *Sweeper) GetSweepFeeDetails(ctx context.Context,
	addInputEstimate func(*input.TxWeightEstimator) error,
	destAddr btcutil.Address, sweepConfTarget int32, label string) (
	btcutil.Amount, chainfee.SatPerKWeight, lntypes.WeightUnit, error)

GetSweepFeeDetails calculates the required tx fee to spend to P2WKH. It takes a function that is expected to add the weight of the input to the weight estimator. It also takes a label used for logging. It returns also the fee rate and transaction weight.