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

# Packages

No description provided by the author

# Functions

CurrentProtocolVersion returns the current protocol version.
CurrentRpcProtocolVersion returns the current rpc protocol version.
NewFSM creates a new instant out FSM.
NewFSMFromInstantOut creates a new instantout FSM from an existing instantout recovered from the database.
NewInstantOutManager creates a new instantout manager.
NewSQLStore creates a new SQLStore.
UseLogger uses a specified Logger to output package logging info.

# Constants

No description provided by the author
ProtocolVersionFullReservation is the protocol version that uses the full reservation amount without change.
ProtocolVersionUndefined is the undefined protocol version.
Subsystem defines the sub system name of this package.

# Variables

BuildHtlc is the state where the htlc transaction is built.
No description provided by the author
No description provided by the author
Failed is the state where the swap failed.
FailedHtlcSweep is the state where the htlc sweep failed.
FinishedHtlcPreimageSweep is the state where the swap is finished by publishing the htlc preimage sweep.
FinishedSweeplessSweep is the state where the swap is finished by publishing the sweepless sweep.
Init is the initial state of the instant out FSM.
OnErrorPublishHtlc is the event that is triggered when the htlc sweep is published after an error.
OnHtlcPublished is the event that is triggered when the htlc transaction is published.
OnHtlcSigReceived is the event that is triggered when the htlc sig is received.
OnHtlcSweepPublished is the event that is triggered when the htlc sweep is published.
OnHtlcSwept is the event that is triggered when the htlc sweep is confirmed.
OnInit is the event that is triggered when the FSM is initialized.
OnInvalidCoopSweep is the event that is triggered when the coop sweep is invalid.
OnPaymentAccepted is the event that is triggered when the payment is accepted by the server.
OnPreimagePushed is the event that is triggered when the preimage is pushed to the server.
OnRecover is the event that is triggered when the FSM recovers from a restart.
OnStart is the event that is sent when the FSM is started.
OnSweeplessSweepConfirmed is the event that is triggered when the sweepless sweep is confirmed.
OnSweeplessSweepPublished is the event that is triggered when the sweepless sweep is published.
PublishHtlc is the state where the htlc transaction is published.
PublishHtlcSweep is the state where the htlc sweep transaction is published.
PushPreimage is the state where the preimage is pushed to the server.
SendPaymentAndPollAccepted is the state where the payment is sent and the server is polled for the accepted state.
WaitForHtlcSweepConfirmed is the state where we wait for the htlc sweep to be confirmed.
WaitForSweeplessSweepConfirmed is the state where we wait for the sweepless sweep to be confirmed.

# Structs

Config contains the services required for the instant out FSM.
FSM is the state machine that handles the instant out.
InitInstantOutCtx contains the context for the InitInstantOutAction.
InputReservation is a helper struct for the input reservation.
InstantOut holds the necessary information to execute an instant out swap.
Manager manages the instantout state machines.
No description provided by the author
No description provided by the author

# Interfaces

InstantLoopOutStore is the interface that needs to be implemented by a store that wants to be used by the instant loop out manager.
InstantOutBaseDB is the interface that contains all the queries generated by sqlc for the instantout table and transaction functionality.
Querier is the interface that contains all the queries generated by sqlc for the instantout table.
ReservationManager handles fetching and locking of reservations.
ReservationStore is the interface that is required to load the reservations based on the stored reservation ids.

# Type aliases

InputReservations is a helper struct for the input reservations.
No description provided by the author