GlcoinCore/loop
1
0
Fork 0
mirror of https://github.com/lightninglabs/loop.git synced 2026-08-13 12:33:03 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: move out architecture diagram

Browse source
This commit is contained in:
Alex Bosworth 2019-03-13 16:11:04 -07:00
parent 7b769d57bb
commit 974da15ead
No known key found for this signature in database
GPG key ID: E80D2F3F311FD87E
2 changed files with 72 additions and 48 deletions
Download patch file Download diff file Expand all files Collapse all files

53
README.md
View file

@ -43,56 +43,13 @@ problems. Community support is also available in the
[LND Slack](https://join.slack.com/t/lightningcommunity/shared_invite/enQtMzQ0OTQyNjE5NjU1LWRiMGNmOTZiNzU0MTVmYzc1ZGFkZTUyNzUwOGJjMjYwNWRkNWQzZWE3MTkwZjdjZGE5ZGNiNGVkMzI2MDU4ZTE)
.
## Loop Out Swap (off -> on-chain)
## Setup and Install
```
loop out 500
|
|
v
.-----------------------------.
| Loop CLI |
| ./cmd/loop |
| |
| |
| .-------------------. | .--------------. .---------------.
| | Loop Client (lib) | | | LND node | | Bitcoin node |
| | ./ |<-------------| |-------------------| |
| | | | | | on-chain | |
| | |------------->| | htlc | |
| | | | off-chain | | | |
| '-------------------' | htlc '--------------' '---------------'
'-----------------|-----------' | ^
| | |
| v |
| .--. .--.
| _ -( )- _ _ -( )- _
| .--,( ),--. .--,( ),--.
initiate| _.-( )-._ _.-( )-._
swap | ( LIGHTNING NETWORK ) ( BITCOIN NETWORK )
| '-._( )_.-' '-._( )_.-'
| '__,( ),__' '__,( ),__'
| - ._(__)_. - - ._(__)_. -
| | ^
| | |
v v |
.--------------------. off-chain .--------------. .---------------.
| Loop Server | htlc | LND node | | Bitcoin node |
| |<-------------| | | |
| | | | on-chain | |
| | | | htlc | |
| |--------------| |----------------->| |
| | | | | |
'--------------------' '--------------' '---------------'
LND and the loop client are using Go modules. Make sure that the `GO111MODULE`
env variable is set to `on`.
```
## Setup
LND and the swaplet are using go modules. Make sure that the `GO111MODULE` env
variable is set to `on`.
In order to execute a swap, LND needs to be rebuilt with sub servers enabled.
In order to execute a swap, LND will need to be rebuilt with sub servers
enabled.
### LND

67
docs/architecture.md Normal file
View file

@ -0,0 +1,67 @@
# Loop Architecture
Lightning Loop's architecture for orchestrating submarine swaps is based on a
client/server concept.
The client has a swap execution daemon `loopd` controlled by a CLI application
`loop` which uses a gRPC API. The client daemon initiates swaps and handles
their progress through swap phases. To manage keys and the connection to the
LN/BTC network layers the client daemon connects to a local lnd wallet.
Client daemons communicate with the Loop server daemon, which is opaque but
operates in a similar way. The server is not a trusted component in this
architecture; the client daemon validates that the terms of the swap are
acceptable and the server cannot access the swap funds unless the swap enters
the "complete" phase.
## Loop Out Swap (off -> on-chain)
Phases:
1. Initiation: Client queries for terms of a swap
2. Fee: Client sends a small fee HTLC that is unrestricted
3. Funding: Client sends a funding HTLC locked to a preimage they generate
4. Payment: Server sends the funds on-chain locked to the funding preimage hash
5. Complete: Client uses the preimage to take the on-chain funds.
6. Final: The server uses the on-chain-revealed preimage to claim funding HTLC
```
loop out 500
|
|
v
.-----------------------------.
| Loop CLI |
| ./cmd/loop |
| |
| |
| .-------------------. | .--------------. .---------------.
| | Loop Client (lib) | | | LND node | | Bitcoin node |
| | ./ |<-------------| |-------------------| |
| | | | | | on-chain | |
| | |------------->| | htlc | |
| | | | off-chain | | | |
| '-------------------' | htlc '--------------' '---------------'
'-----------------|-----------' | ^
| | |
| v |
| .--. .--.
| _ -( )- _ _ -( )- _
| .--,( ),--. .--,( ),--.
initiate| _.-( )-._ _.-( )-._
swap | ( LIGHTNING NETWORK ) ( BITCOIN NETWORK )
| '-._( )_.-' '-._( )_.-'
| '__,( ),__' '__,( ),__'
| - ._(__)_. - - ._(__)_. -
| | ^
| | |
v v |
.--------------------. off-chain .--------------. .---------------.
| Loop Server | htlc | LND node | | Bitcoin node |
| |<-------------| | | |
| | | | on-chain | |
| | | | htlc | |
| |--------------| |----------------->| |
| | | | | |
'--------------------' '--------------' '---------------'
```