Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 1 addition & 36 deletions docs/loop.1
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,10 @@
.TH loop 1

.SH NAME
.PP
loop - control plane for your loopd
loop \- control plane for your loopd


.SH SYNOPSIS
.PP
loop

.EX
Expand All @@ -29,7 +27,6 @@ loop [GLOBAL OPTIONS] [command [COMMAND OPTIONS]] [ARGUMENTS...]


.SH GLOBAL OPTIONS
.PP
\fB--help, -h\fP: show help

.PP
Expand All @@ -53,7 +50,6 @@ loop [GLOBAL OPTIONS] [command [COMMAND OPTIONS]] [ARGUMENTS...]

.SH COMMANDS
.SH out
.PP
perform an off-chain to on-chain swap (looping out)

.PP
Expand Down Expand Up @@ -105,7 +101,6 @@ perform an off-chain to on-chain swap (looping out)
\fB--verbose, -v\fP: show expanded details

.SH in
.PP
perform an on-chain to off-chain swap (loop in)

.PP
Expand Down Expand Up @@ -139,28 +134,24 @@ perform an on-chain to off-chain swap (loop in)
\fB--verbose, -v\fP: show expanded details

.SH terms
.PP
Display the current swap terms imposed by the server.

.PP
\fB--help, -h\fP: show help

.SH monitor
.PP
monitor progress of any active swaps

.PP
\fB--help, -h\fP: show help

.SH quote
.PP
get a quote for the cost of a swap

.PP
\fB--help, -h\fP: show help

.SS in
.PP
get a quote for the cost of a loop in swap

.PP
Expand All @@ -185,7 +176,6 @@ get a quote for the cost of a loop in swap
\fB--verbose, -v\fP: show expanded details

.SS out
.PP
get a quote for the cost of a loop out swap

.PP
Expand All @@ -201,21 +191,18 @@ get a quote for the cost of a loop out swap
\fB--verbose, -v\fP: show expanded details

.SH listauth
.PP
list all L402 tokens

.PP
\fB--help, -h\fP: show help

.SH fetchl402
.PP
fetches a new L402 authentication token from the server

.PP
\fB--help, -h\fP: show help

.SH listswaps
.PP
list all swaps in the local database

.PP
Expand Down Expand Up @@ -246,7 +233,6 @@ list all swaps in the local database
\fB--start_time_ns\fP="": Unix timestamp in nanoseconds to select swaps initiated after this time (default: 0)

.SH swapinfo
.PP
show the status of a swap

.PP
Expand All @@ -256,14 +242,12 @@ show the status of a swap
\fB--id\fP="": the ID of the swap (default: 0)

.SH getparams
.PP
show liquidity manager parameters

.PP
\fB--help, -h\fP: show help

.SH setrule
.PP
set liquidity manager rule for a channel/peer

.PP
Expand All @@ -282,14 +266,12 @@ set liquidity manager rule for a channel/peer
\fB--type\fP="": the type of swap to perform, set to 'out' for acquiring inbound liquidity or 'in' for acquiring outbound liquidity. (default: out)

.SH suggestswaps
.PP
show a list of suggested swaps

.PP
\fB--help, -h\fP: show help

.SH setparams
.PP
update the parameters set for the liquidity manager

.PP
Expand Down Expand Up @@ -380,14 +362,12 @@ update the parameters set for the liquidity manager
\fB--sweeplimit\fP="": the limit placed on our estimated sweep fee in sat/vByte. (default: 0)

.SH getinfo
.PP
show general information about the loop daemon

.PP
\fB--help, -h\fP: show help

.SH abandonswap
.PP
abandon a swap with a given swap hash

.PP
Expand All @@ -397,21 +377,18 @@ abandon a swap with a given swap hash
\fB--i_know_what_i_am_doing\fP: Specify this flag if you made sure that you read and understood the following consequence of applying this command.

.SH reservations, r
.PP
manage reservations

.PP
\fB--help, -h\fP: show help

.SS list, l
.PP
list all reservations

.PP
\fB--help, -h\fP: show help

.SH instantout
.PP
perform an instant off-chain to on-chain swap (looping out)

.PP
Expand All @@ -424,14 +401,12 @@ perform an instant off-chain to on-chain swap (looping out)
\fB--help, -h\fP: show help

.SH listinstantouts
.PP
list all instant out swaps

.PP
\fB--help, -h\fP: show help

.SH stop
.PP
stop the loop daemon

.PP
Expand All @@ -441,21 +416,18 @@ stop the loop daemon
\fB--wait\fP: wait until loopd fully shuts down

.SH static, s
.PP
perform on-chain to off-chain swaps using static addresses.

.PP
\fB--help, -h\fP: show help

.SS new, n
.PP
Create a new static loop in address.

.PP
\fB--help, -h\fP: show help

.SS listunspent, l
.PP
List unspent static address outputs.

.PP
Expand All @@ -468,7 +440,6 @@ List unspent static address outputs.
\fB--min_confs\fP="": The minimum amount of confirmations an output should have to be listed. (default: 0)

.SS listdeposits
.PP
Displays static address deposits. A filter can be applied to only show deposits in a specific state.

.PP
Expand All @@ -493,21 +464,18 @@ failed
\fB--help, -h\fP: show help

.SS listwithdrawals
.PP
Display a summary of past withdrawals.

.PP
\fB--help, -h\fP: show help

.SS listswaps
.PP
Shows a list of static address swaps.

.PP
\fB--help, -h\fP: show help

.SS withdraw, w
.PP
Withdraw from static address deposits.

.PP
Expand All @@ -529,14 +497,12 @@ Withdraw from static address deposits.
\fB--utxo\fP="": specify utxos as outpoints(tx:idx) which willbe withdrawn. (default: [])

.SS summary, s
.PP
Display a summary of static address related information.

.PP
\fB--help, -h\fP: show help

.SS in
.PP
Loop in funds from static address deposits.

.PP
Expand Down Expand Up @@ -582,7 +548,6 @@ Loop in funds from static address deposits.
\fB--verbose, -v\fP: show expanded details

.SS openchannel
.PP
Open a channel to an existing peer.

.PP
Expand Down
4 changes: 2 additions & 2 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ require (
github.com/coreos/go-semver v0.3.0 // indirect
github.com/coreos/go-systemd v0.0.0-20191104093116-d3cd4ed1dbcf // indirect
github.com/coreos/go-systemd/v22 v22.5.0 // indirect
github.com/cpuguy83/go-md2man/v2 v2.0.4 // indirect
github.com/cpuguy83/go-md2man/v2 v2.0.5 // indirect
github.com/decred/dcrd/crypto/blake256 v1.1.0 // indirect
github.com/decred/dcrd/lru v1.1.2 // indirect
github.com/distribution/reference v0.6.0 // indirect
Expand Down Expand Up @@ -148,7 +148,7 @@ require (
github.com/ncruces/go-strftime v0.1.9 // indirect
github.com/opencontainers/go-digest v1.0.0 // indirect
github.com/opencontainers/image-spec v1.1.1 // indirect
github.com/opencontainers/runc v1.2.8 // indirect
github.com/opencontainers/runc v1.3.6 // indirect
github.com/pmezard/go-difflib v1.0.0 // indirect
github.com/prometheus/client_golang v1.14.0 // indirect
github.com/prometheus/client_model v0.3.0 // indirect
Expand Down
8 changes: 4 additions & 4 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -741,8 +741,8 @@ github.com/coreos/go-systemd v0.0.0-20191104093116-d3cd4ed1dbcf h1:iW4rZ826su+pq
github.com/coreos/go-systemd v0.0.0-20191104093116-d3cd4ed1dbcf/go.mod h1:F5haX7vjVVG0kc13fIWeqUViNPyEJxv/OmvnBo0Yme4=
github.com/coreos/go-systemd/v22 v22.5.0 h1:RrqgGjYQKalulkV8NGVIfkXQf6YYmOyiJKk8iXXhfZs=
github.com/coreos/go-systemd/v22 v22.5.0/go.mod h1:Y58oyj3AT4RCenI/lSvhwexgC+NSVTIJ3seZv2GcEnc=
github.com/cpuguy83/go-md2man/v2 v2.0.4 h1:wfIWP927BUkWJb2NmU/kNDYIBTh/ziUX91+lVfRxZq4=
github.com/cpuguy83/go-md2man/v2 v2.0.4/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
github.com/cpuguy83/go-md2man/v2 v2.0.5 h1:ZtcqGrnekaHpVLArFSe4HK5DoKx1T0rq2DwVB0alcyc=
github.com/cpuguy83/go-md2man/v2 v2.0.5/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
github.com/creack/pty v1.1.7/go.mod h1:lj5s0c3V2DBrqTV7llrYr5NG6My20zk30Fl46Y7DoTY=
github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
github.com/creack/pty v1.1.24 h1:bJrF4RRfyJnbTJqzRLHzcGaZK1NeM5kTC9jGgovnR1s=
Expand Down Expand Up @@ -1223,8 +1223,8 @@ github.com/opencontainers/go-digest v1.0.0 h1:apOUWs51W5PlhuyGyz9FCeeBIOUDA/6nW8
github.com/opencontainers/go-digest v1.0.0/go.mod h1:0JzlMkj0TRzQZfJkVvzbP0HBR3IKzErnv2BNG4W4MAM=
github.com/opencontainers/image-spec v1.1.1 h1:y0fUlFfIZhPF1W537XOLg0/fcx6zcHCJwooC2xJA040=
github.com/opencontainers/image-spec v1.1.1/go.mod h1:qpqAh3Dmcf36wStyyWU+kCeDgrGnAve2nCC8+7h8Q0M=
github.com/opencontainers/runc v1.2.8 h1:RnEICeDReapbZ5lZEgHvj7E9Q3Eex9toYmaGBsbvU5Q=
github.com/opencontainers/runc v1.2.8/go.mod h1:cC0YkmZcuvr+rtBZ6T7NBoVbMGNAdLa/21vIElJDOzI=
github.com/opencontainers/runc v1.3.6 h1:SLGIymCtsk80iNPWgbc8dtjI30r+5mTVV+4dN8/17Sk=
github.com/opencontainers/runc v1.3.6/go.mod h1:o1wyv76EDlTkcf0KTFgN8bMWLPvgF/HfX709lDv+rr4=
github.com/opentracing/opentracing-go v1.1.0/go.mod h1:UkNAQd3GIcIGf0SeVgPpRdFStlNbqXla1AfSYxPUl2o=
github.com/ory/dockertest/v3 v3.10.0 h1:4K3z2VMe8Woe++invjaTB7VRyQXQy5UY+loujO4aNE4=
github.com/ory/dockertest/v3 v3.10.0/go.mod h1:nr57ZbRWMqfsdGdFNLHz5jjNdDb7VVFnzAeW1n5N1Lg=
Expand Down
4 changes: 2 additions & 2 deletions looprpc/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ require (
require (
dario.cat/mergo v1.0.1 // indirect
github.com/Azure/go-ansiterm v0.0.0-20250102033503-faa5f7b0171c // indirect
github.com/BurntSushi/toml v1.3.2 // indirect
github.com/BurntSushi/toml v1.4.0 // indirect
github.com/Microsoft/go-winio v0.6.2 // indirect
github.com/Nvveen/Gotty v0.0.0-20120604004816-cd527374f1e5 // indirect
github.com/aead/chacha20 v0.0.0-20180709150244-8b13a72661da // indirect
Expand Down Expand Up @@ -119,7 +119,7 @@ require (
github.com/ncruces/go-strftime v0.1.9 // indirect
github.com/opencontainers/go-digest v1.0.0 // indirect
github.com/opencontainers/image-spec v1.1.1 // indirect
github.com/opencontainers/runc v1.2.8 // indirect
github.com/opencontainers/runc v1.3.6 // indirect
github.com/ory/dockertest/v3 v3.10.0 // indirect
github.com/pmezard/go-difflib v1.0.0 // indirect
github.com/prometheus/client_golang v1.11.1 // indirect
Expand Down
8 changes: 4 additions & 4 deletions looprpc/go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ cloud.google.com/go v0.34.0/go.mod h1:aQUYkXzVsufM+DwF1aE+0xfcU+56JwCaLick0ClmMT
github.com/Azure/go-ansiterm v0.0.0-20250102033503-faa5f7b0171c h1:udKWzYgxTojEKWjV8V+WSxDXJ4NFATAsZjh8iIbsQIg=
github.com/Azure/go-ansiterm v0.0.0-20250102033503-faa5f7b0171c/go.mod h1:xomTg63KZ2rFqZQzSB4Vz2SUXa1BpHTVz9L5PTmPC4E=
github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
github.com/BurntSushi/toml v1.3.2 h1:o7IhLm0Msx3BaB+n3Ag7L8EVlByGnpq14C4YWiu/gL8=
github.com/BurntSushi/toml v1.3.2/go.mod h1:CxXYINrC8qIiEnFrOxCa7Jy5BFHlXnUU2pbicEuybxQ=
github.com/BurntSushi/toml v1.4.0 h1:kuoIxZQy2WRRk1pttg9asf+WVv6tWQuBNVmK8+nqPr0=
github.com/BurntSushi/toml v1.4.0/go.mod h1:ukJfTF/6rtPPRCnwkur4qwRxa8vTRFBF0uk2lLoLwho=
github.com/Masterminds/semver/v3 v3.1.1 h1:hLg3sBzpNErnxhQtUy/mmLR2I9foDujNK030IGemrRc=
github.com/Masterminds/semver/v3 v3.1.1/go.mod h1:VPu/7SZ7ePZ3QOrcuXROw5FAcLl4a0cBrbBpGY/8hQs=
github.com/Microsoft/go-winio v0.6.2 h1:F2VQgta7ecxGYO8k3ZZz3RS8fVIXVxONVUPlNERoyfY=
Expand Down Expand Up @@ -428,8 +428,8 @@ github.com/opencontainers/go-digest v1.0.0 h1:apOUWs51W5PlhuyGyz9FCeeBIOUDA/6nW8
github.com/opencontainers/go-digest v1.0.0/go.mod h1:0JzlMkj0TRzQZfJkVvzbP0HBR3IKzErnv2BNG4W4MAM=
github.com/opencontainers/image-spec v1.1.1 h1:y0fUlFfIZhPF1W537XOLg0/fcx6zcHCJwooC2xJA040=
github.com/opencontainers/image-spec v1.1.1/go.mod h1:qpqAh3Dmcf36wStyyWU+kCeDgrGnAve2nCC8+7h8Q0M=
github.com/opencontainers/runc v1.2.8 h1:RnEICeDReapbZ5lZEgHvj7E9Q3Eex9toYmaGBsbvU5Q=
github.com/opencontainers/runc v1.2.8/go.mod h1:cC0YkmZcuvr+rtBZ6T7NBoVbMGNAdLa/21vIElJDOzI=
github.com/opencontainers/runc v1.3.6 h1:SLGIymCtsk80iNPWgbc8dtjI30r+5mTVV+4dN8/17Sk=
github.com/opencontainers/runc v1.3.6/go.mod h1:o1wyv76EDlTkcf0KTFgN8bMWLPvgF/HfX709lDv+rr4=
github.com/opentracing/opentracing-go v1.1.0/go.mod h1:UkNAQd3GIcIGf0SeVgPpRdFStlNbqXla1AfSYxPUl2o=
github.com/ory/dockertest/v3 v3.10.0 h1:4K3z2VMe8Woe++invjaTB7VRyQXQy5UY+loujO4aNE4=
github.com/ory/dockertest/v3 v3.10.0/go.mod h1:nr57ZbRWMqfsdGdFNLHz5jjNdDb7VVFnzAeW1n5N1Lg=
Expand Down
Loading