# Functions
No description provided by the author
No description provided by the author
No description provided by the author
RegisterSwapClientHandler registers the http handlers for service SwapClient to "mux".
RegisterSwapClientHandlerClient registers the http handlers for service SwapClient to "mux".
RegisterSwapClientHandlerFromEndpoint is same as RegisterSwapClientHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
RegisterSwapClientHandlerServer registers the http handlers for service SwapClient to "mux".
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
Budget elapsed indicates that the autoloop budget for the period has been elapsed.
Budget insufficient indicates that we cannot perform a swap because we do not have enough pending budget available.
Budget not started indicates that we do not recommend any swaps because the start time for our budget has not arrived yet.
Failure backoff indicates that a swap has recently failed for this target, and the backoff period has not yet passed.
Fee insufficient indicates that the fee estimate for a swap is higher than the portion of total swap amount that we allow fees to consume.
In flight indicates that the limit on in-flight automatically dispatched swaps has already been reached.
Liquidity ok indicates that a target meets the liquidity balance expressed in its rule, so no swap is needed.
Loop In indicates that a loop in swap is currently in flight for the peer, so it is not eligible.
Loop out indicates that a loop out swap is currently utilizing the channel, so it is not eligible.
Miner fee indicates that the miner fee for a specific swap is to high.
Prepay indicates that the prepay fee for a specific swap is too high.
Swap fee indicates that the server fee for a specific swap is too high.
Sweep fees indicates that the estimated fees to sweep swaps are too high right now.
No description provided by the author
DEPOSITED indicates that the deposit has been sufficiently confirmed on chain.
EXPIRED indicates that the deposit has expired and the sweep transaction has been sufficiently confirmed.
HTLC_TIMEOUT_SWEPT indicates that the timeout path of the htlc has been swept by the client.
LOOPED_IN indicates that the deposit was used in a static address loop-in swap.
LOOPING_IN indicates that the deposit is currently being used in a static address loop-in swap.
PUBLISH_EXPIRED indicates that the deposit has expired and the sweep transaction has been published.
SWEEP_HTLC_TIMEOUT indicates that the deposit is part of an active loop-in of which the respective htlc was published by the server and the timeout path has opened up for the client to sweep.
UNKNOWN_STATE is the default state of a deposit.
WAIT_FOR_EXPIRY_SWEEP indicates that the deposit has expired and the sweep transaction has not yet been sufficiently confirmed.
WITHDRAWING indicates that the deposit is currently being withdrawn.
WITHDRAWN indicates that the deposit has been withdrawn.
FAILURE_REASON_ABANDONED indicates that a swap permanently failed because the client manually abandoned the swap.
FAILURE_REASON_INCORRECT_AMOUNT indicates that a loop in permanently failed because the amount extended by an external loop in htlc is insufficient.
FAILURE_REASON_INCORRECT_HTLC_AMT_SWEPT indicates that a swap wasn't published due to insufficient confirmed balance.
FAILURE_REASON_INSUFFICIENT_CONFIRMED_BALANCE indicates that a swap wasn't published due to insufficient confirmed balance.
FAILURE_REASON_INSUFFICIENT_VALUE indicates that a loop out has failed because the on chain htlc had a lower value than requested.
FAILURE_REASON_NONE is set when the swap did not fail, it is either in progress or succeeded.
FAILURE_REASON_OFFCHAIN indicates that a loop out failed because it wasn't possible to find a route for one or both off chain payments that met the fee and timelock limits required.
FAILURE_REASON_SWEEP_TIMEOUT indicates that a loop out permanently failed because the on chain htlc wasn't swept before the server revoked the htlc.
FAILURE_REASON_TEMPORARY indicates that a swap cannot continue due to an internal error.
FAILURE_REASON_TIMEOUT indicates that the swap failed because on chain htlc did not confirm before its expiry, or it confirmed too late for us to reveal our preimage and claim.
No description provided by the author
No description provided by the author
ANY indicates that no filter is applied.
LOOP_IN indicates a loop in swap (on-chain to off-chain).
LOOP_OUT indicates an loop out swap (off-chain to on-chain).
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
FAILED is the final swap state for a failed swap with or without loss of the swap amount.
HTLC_PUBLISHED is reached when the htlc tx has been published in a loop in swap.
INITIATED is the initial state of a swap.
INVOICE_SETTLED is reached when the swap invoice in a loop in swap has been paid, but we are still waiting for the htlc spend to confirm.
PREIMAGE_REVEALED is reached when the sweep tx publication is first attempted.
SUCCESS is the final swap state that is reached when the sweep tx has the required confirmation depth.
LOOP_IN indicates a loop in swap (on-chain to off-chain).
LOOP_OUT indicates an loop out swap (off-chain to on-chain).
# Variables
Enum value maps for AddressType.
Enum value maps for AddressType.
Enum value maps for AutoReason.
Enum value maps for AutoReason.
Debug_ServiceDesc is the grpc.ServiceDesc for Debug service.
Enum value maps for DepositState.
Enum value maps for DepositState.
Enum value maps for FailureReason.
Enum value maps for FailureReason.
No description provided by the author
No description provided by the author
Enum value maps for LiquidityRuleType.
Enum value maps for LiquidityRuleType.
Enum value maps for ListSwapsFilter_SwapTypeFilter.
Enum value maps for ListSwapsFilter_SwapTypeFilter.
Enum value maps for StaticAddressLoopInSwapState.
Enum value maps for StaticAddressLoopInSwapState.
SwapClient_ServiceDesc is the grpc.ServiceDesc for SwapClient service.
Enum value maps for SwapState.
Enum value maps for SwapState.
Enum value maps for SwapType.
Enum value maps for SwapType.
# 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
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
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
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
UnimplementedDebugServer must be embedded to have forward compatible implementations.
UnimplementedSwapClientServer must be embedded to have forward compatible implementations.
No description provided by the author
No description provided by the author
No description provided by the author
# Interfaces
DebugClient is the client API for Debug service.
DebugServer is the server API for Debug service.
No description provided by the author
No description provided by the author
SwapClientClient is the client API for SwapClient service.
SwapClientServer is the server API for SwapClient service.
UnsafeDebugServer may be embedded to opt out of forward compatibility for this service.
UnsafeSwapClientServer may be embedded to opt out of forward compatibility for this service.
# Type aliases
`AddressType` has to be one of:
- `unknown`: Unknown address type - `p2tr`: Pay to taproot pubkey (`TAPROOT_PUBKEY` = 1).
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