package
0.29.0-beta.rc2
Repository: https://github.com/lightninglabs/loop.git
Documentation: pkg.go.dev
# Functions
NewBatch creates a new batch.
NewBatcher creates a new Batcher instance.
NewBatchFromDB creates a new batch that already existed in storage.
NewSQLStore creates a new SQLStore.
NewStoreMock instantiates a new mock store.
NewSweepFetcherFromSwapStore accepts swapStore (e.g.
UseLogger uses a specified Logger to output package logging info.
WithClock sets the clock used by sweepbatcher and its batches.
WithCustomFeeRate instructs sweepbatcher not to fee bump itself and rely on external source of fee rates (FeeRateProvider).
WithCustomSignMuSig2 instructs sweepbatcher to use a custom function to produce MuSig2 signatures.
WithInitialDelay instructs sweepbatcher to wait for the duration provided after new batch creation before it is first published.
WithMixedBatch instructs sweepbatcher to create mixed batches with regard to cooperativeness.
WithPublishDelay sets the delay of batch publishing that is applied in the beginning, after the appearance of a new block in the network or after the end of initial delay (see WithInitialDelay).
WithPublishErrorHandler sets the callback used to handle publish errors.
WithTxLabeler sets a function generating a transaction label.
# Constants
Closed is the state in which the batch is no longer able to accept new sweeps.
Confirmed is the state in which the batch transaction has reached the configured conf height.
MaxSweepsPerBatch is the maximum number of sweeps in a single batch.
Open is the state in which the batch is able to accept new sweeps.
# Variables
No description provided by the author
No description provided by the author
# Structs
Batcher is a system that is responsible for accepting sweep requests and placing them in appropriate batches.
BatcherConfig holds batcher configuration.
No description provided by the author
SpendNotifier is a notifier that is used to notify the requester of a sweep that the sweep was successful.
SQLStore manages the reservations in the database.
StoreMock implements a mock client swap store.
SwapStoreWrapper is LoopOutFetcher wrapper providing SweepFetcher interface.
SweepInfo stores any data related to sweeping a specific outpoint.
SweepRequest is a request to sweep a specific outpoint.
# Interfaces
BaseDB is the interface that contains all the queries generated by sqlc for sweep batcher and transaction functionality.
No description provided by the author
LoopOutFetcher is used to load LoopOut swaps from the database.
Querier is the interface that contains all the queries generated by sqlc for sweep batcher.
SweepFetcher is used to get details of a sweep.
# Type aliases
BatcherOption configures batcher behaviour.
FeeRateProvider is a function that returns min fee rate of a batch sweeping the UTXO of the swap.
MuSig2SignSweep is a function that can be used to sign a sweep transaction cooperatively with the swap server.
PublishErrorHandler is a function that handles transaction publishing error.
Purger is a function that takes a sweep request and feeds it back to the batcher main entry point.
SignMuSig2 is a function that can be used to sign a sweep transaction in a custom way.
VerifySchnorrSig is a function that can be used to verify a schnorr signature.