Categorygithub.com/lightninglabs/loop/swapserverrpc
modulepackage
1.0.12
Repository: https://github.com/lightninglabs/loop.git
Documentation: pkg.go.dev

# Functions

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Constants

No description provided by the author
No description provided by the author
A non-recoverable error has occured.
Payment details incorrect (unknown hash, invalid amt or invalid final cltv delta).
Insufficient local balance.
All possible routes were tried and failed permanently.
Payment isn't failed (yet).
There are more routes to try, but the payment timeout was exceeded.
The client will use the new v2 HTLC scripts.
The client will use the new v3 (taproot) HTLC scripts.
/ No protocol version reported at all.
The client supports loop out swap cancelation.
The client creates a probe invoice so that the server can perform a multi-path probe.
/ Client may attempt to send the loop out payment in multiple parts.
Enables MuSig2 signature scheme for swaps.
* Loop will use native segwit (P2WSH) htlcs by default, while externally published htlcs may use native (P2WSH) or nested (NP2WSH) segwit as well.
Once the on chain loop out htlc is confirmed, the client can push the swap preimage to the server to speed up claim of their off chain htlc (acquiring incoming liquidity more quickly than if the server waited for the on chain claim tx).
The client is able to ask the server to probe to test inbound liquidity and provide more accurate loop-in fees.
The client may ask the server to use a custom routing helper plugin in order to enhance off-chain payments corresponding to a swap.
The client will propose a cltv expiry height for loop out.
RESERVATION_NONE is the default value and means that the reservation protocol version is not set.
RESERVATION_SERVER_NOTIFY is the first version of the reservation protocol where the server notifies the client about a reservation.
Invoice route indicates that the swap was canceled because the client could not find a route to the server for the swap invoice.
Prepay route indicates that the swap was canceled because the client could not find a route to the server for the prepay.
No reason, used to distinguish from the default value.
Client will try more expensive routes for off-chain payments.
Client won't use any plugins to help with payment routing.
The client canceled the swap because they could not route the swap payment.
The client canceled the swap because they could not route the prepay.
The server could not publish the loop out on chain htlc.
The swap failed during creation.
A loop in htlc confirmed on chain, but it did not have the correct value.
A loop in swap was rejected because it contained multiple outputs for a single swap.
No htlc was confirmed in time for the loop in swap to complete.
We did not succeed in completing the loop in off chain payment before the timeout.
The server could not publish the loop out on chain htlc before the deadline provided.
The on chain timeout was claimed.
The swap failed for a reason that is unknown to the server, this is only set for older swaps.
The swap htlc has confirmed on chain.
The server has published the loop out on chain htlc.
The server has created the swap.
The swap completed successfully.
The server has published the loop out on chain timeout tx.
The swap has failed for unknown reasons, it will not be completed.
V0 is the initially released static address protocol version.

# Variables

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Enum value maps for InstantOutProtocolVersion.
Enum value maps for InstantOutProtocolVersion.
InstantSwapServer_ServiceDesc is the grpc.ServiceDesc for InstantSwapServer service.
Enum value maps for PaymentFailureReason.
Enum value maps for PaymentFailureReason.
Enum value maps for ProtocolVersion.
Enum value maps for ProtocolVersion.
Enum value maps for ReservationProtocolVersion.
Enum value maps for ReservationProtocolVersion.
ReservationService_ServiceDesc is the grpc.ServiceDesc for ReservationService service.
Enum value maps for RoutePaymentType.
Enum value maps for RoutePaymentType.
Enum value maps for RoutingPlugin.
Enum value maps for RoutingPlugin.
Enum value maps for ServerSwapState.
Enum value maps for ServerSwapState.
Enum value maps for StaticAddressProtocolVersion.
Enum value maps for StaticAddressProtocolVersion.
StaticAddressServer_ServiceDesc is the grpc.ServiceDesc for StaticAddressServer service.
SwapServer_ServiceDesc is the grpc.ServiceDesc for SwapServer service.

# Structs

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
FetchL402Request is an empty request sent from the client to the server to fetch the lnd L402.
FetchL402Response is an empty response sent from the server to the client to confirm the lnd L402.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ReservationNotificationRequest is an empty request sent from the client to the server to open a stream to receive reservation notifications.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ServerLoopOutPushPreimageRequest pushes a preimage to the server.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ServerOpenReservationRequest is a request sent from the client to the server to confirm a reservation opening.
ServerOpenReservationResponse is a response sent from the server to the client to confirm a reservation opening.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ServerReservationNotification is a notification sent from the server to the client if the server wants to open a reservation.
No description provided by the author
No description provided by the author
ServerStaticLoopInSweepNotification is a request from the server to the client to cosign a transaction that contains deposits from a finished static loop ins.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SubscribeNotificationsRequest is a request to subscribe to notifications.
SubscribeNotificationsResponse is a response to a SubscribeNotificationsRequest.
No description provided by the author
No description provided by the author
No description provided by the author
UnimplementedInstantSwapServerServer must be embedded to have forward compatible implementations.
UnimplementedReservationServiceServer must be embedded to have forward compatible implementations.
UnimplementedStaticAddressServerServer must be embedded to have forward compatible implementations.
UnimplementedSwapServerServer must be embedded to have forward compatible implementations.

# Interfaces

InstantSwapServerClient is the client API for InstantSwapServer service.
InstantSwapServerServer is the server API for InstantSwapServer service.
No description provided by the author
No description provided by the author
ReservationServiceClient is the client API for ReservationService service.
ReservationServiceServer is the server API for ReservationService service.
StaticAddressServerClient is the client API for StaticAddressServer service.
StaticAddressServerServer is the server API for StaticAddressServer service.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SwapServerClient is the client API for SwapServer service.
SwapServerServer is the server API for SwapServer service.
UnsafeInstantSwapServerServer may be embedded to opt out of forward compatibility for this service.
UnsafeReservationServiceServer may be embedded to opt out of forward compatibility for this service.
UnsafeStaticAddressServerServer may be embedded to opt out of forward compatibility for this service.
UnsafeSwapServerServer may be embedded to opt out of forward compatibility for this service.

# Type aliases

No description provided by the author
PaymentFailureReason describes the reason that a payment failed.
* This enum defines the protocol versions that clients may adhere to.
ReservationProtocolVersion is the version of the reservation protocol.
No description provided by the author
No description provided by the author
ServerSwapState is an enum which represents all the states a swap may have from the server's perspective.
StaticAddressProtocolVersion represents the static address protocol version the client adheres to.