package
0.29.0-beta.rc2
Repository: https://github.com/lightninglabs/loop.git
Documentation: pkg.go.dev

# Functions

GetRandomDepositID generates a random deposit ID.
NewFSM creates a new state machine that can action on all static address feature requests.
NewManager creates a new deposit manager.
NewSqlStore constructs a new SQLStore from a BaseDB.
UseLogger uses a specified Logger to output package logging info.

# Constants

No description provided by the author
No description provided by the author
DefaultTransitionTimeout is the default timeout for transitions in the deposit state machine.
No description provided by the author
MaxConfs is unset since we don't require a max number of confirmations for deposits.
MinConfs is the minimum number of confirmations we require for a deposit to be considered available for loop-ins, coop-spends and timeouts.
PollInterval is the interval in which we poll for new deposits to our static address.
Subsystem defines the sub system name of this package.

# Variables

Deposited signals that funds at a static address have reached the confirmation height.
No description provided by the author
Expired signals that the deposit has expired and the expiry sweep transaction has been confirmed sufficiently.
HtlcTimeoutSwept signals that the htlc timeout path has been swept.
LoopedIn signals that the loop in swap has been successfully completed.
LoopingIn signals that the deposit is locked for a loop in swap.
OnExpiry is sent to the fsm when the deposit has expired.
OnExpiryPublished is sent to the fsm when the expiry sweep tx has been published.
OnExpirySwept is sent to the fsm when the expiry sweep tx has been confirmed.
OnHtlcTimeoutSwept is sent to the fsm when the htlc timeout path has been swept.
OnLoopedIn is sent to the fsm when the user intents to use the deposit for a loop in swap.
OnLoopInInitiated is sent to the fsm when a loop in has been initiated.
OnRecover is sent to the fsm when it should recover from client restart.
OnStart is sent to the fsm once the deposit outpoint has been sufficiently confirmed.
OnSweepingHtlcTimeout is sent to the fsm when the htlc timeout path is being swept.
OnWithdrawInitiated is sent to the fsm when a withdrawal has been initiated.
OnWithdrawn is sent to the fsm when a withdrawal has been confirmed.
PublishExpirySweep signals that the deposit has expired, and we are in the process of publishing the expiry sweep transaction.
SweepHtlcTimeout signals that the htlc timeout path is in the process of being swept.
WaitForExpirySweep signals that the expiry sweep transaction has been published, and we are waiting for it to be confirmed.
Withdrawing signals that the withdrawal transaction has been broadcast, awaiting sufficient confirmations.
Withdrawn signals that the withdrawal transaction has been confirmed.

# Structs

Deposit bundles an utxo at a static address together with manager-relevant data.
FSM is the state machine that handles the instant out.
Manager manages the address state machines.
ManagerConfig holds the configuration for the address manager.
SqlStore is the backing store for static address deposits.

# Interfaces

AddressManager handles fetching of address parameters.
Store is the database interface that is used to store and retrieve static address deposits.

# Type aliases

ID is a unique identifier for a deposit.