Skip to content

Commit 8edaea4

Browse files
authored
Merge pull request #910 from owans/3-update-flyover-design-doc
Update terminology from RSK to Rootstock in DESIGN.md
2 parents 7e8c8d7 + c8d641a commit 8edaea4

File tree

1 file changed

+6
-12
lines changed

1 file changed

+6
-12
lines changed

docs/DESIGN.md

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,8 @@
11
# Flyover Protocol Design
22

3-
The Flyover system allows a user to transfer BTC from Bitcoin to RSK and vice versa in a fast way, where a third party
4-
takes the risk to advance the payment for the user. Flyover also provides the new feature to transfer BTC from Bitcoin
5-
directly to a smart contract in RSK.
6-
7-
The outstanding feature of the Flyover system is that it accomplishes the above without giving any third party custody
8-
of the transferred funds. This is an outstanding security guarantee to the user. The system comprises one or more
9-
liquidity providers (LPs) that store their BTC in RSK and Bitcoin. The first version of the Flyover protocol supports only the
10-
peg-in process (BTC to RBTC). Later versions will also support the peg-out process (RBTC to BTC).
3+
The Flyover system allows a user to transfer BTC from Bitcoin to Rootstock and vice versa in a fast way, where a third party takes the risk to advance the payment for the user. Flyover also provides the new feature to transfer BTC from Bitcoin directly to a smart contract in Rootstock.
114

5+
The outstanding feature of the Flyover system is that it accomplishes the above without giving any third party custody of the transferred funds. This is an outstanding security guarantee to the user. The system comprises one or more liquidity providers (LPs) that store their BTC in Rootstock and Bitcoin. The first version of the Flyover protocol supports only the peg-in process (BTC to RBTC). Later versions will also support the peg-out process (RBTC to BTC).
126

137
## Workflow
148

@@ -18,21 +12,21 @@ to isOperational could be performed at a different time:
1812
![Flyover Sequence Diagram](https://raw.githubusercontent.com/rsksmart/liquidity-provider-server/refs/heads/master/docs/diagrams/flyover-sd.png)
1913

2014

21-
The following diagrams show the interactions between Liquidity Provider, Liquidity Bridge Contract and RSK Bridge Contract in three different scenarios:
15+
The following diagrams show the interactions between Liquidity Provider, Liquidity Bridge Contract and Rootstock Bridge Contract in three different scenarios:
2216
1. Basic fast bridge workflow (happy path)
2317
2. Unsuccessful call on behalf of a user
2418
3. Liquidity Provider fails to deliver funds to LBC
2519

2620
![Flyover Sequence Diagram](https://raw.githubusercontent.com/rsksmart/liquidity-provider-server/master/docs/diagrams/flyover-ad-basic.png)
2721

28-
_Figure 1 - Basic fast bridge workflow. Note that step (3) `registerPegin` can be called by the LP or any other entity._
22+
* Figure 1 - Basic fast bridge workflow. Note that step (3) `registerPegin` can be called by the LP or any other entity._
2923

3024

3125
![Flyover Sequence Diagram](https://raw.githubusercontent.com/rsksmart/liquidity-provider-server/master/docs/diagrams/flyover-ad-unsuccessful-call.png)
3226

33-
_Figure 2 - Fast bridge interactions when the call on behalf of the user is unsuccessful. The LP keeps the call fee and the rest is refunded to the refund RSK address._
27+
* Figure 2 - Fast bridge interactions when the call on behalf of the user is unsuccessful. The LP keeps the call fee and the rest is refunded to the refund RSK address._
3428

3529

3630
![Flyover Sequence Diagram](https://raw.githubusercontent.com/rsksmart/liquidity-provider-server/master/docs/diagrams/flyover-ad-no-call.png)
3731

38-
_Figure 3 - Fast bridge interactions when the LP fails to call the LBC on behalf of the user. The LBC slashes the LP's collateral and refunds the user on the refund RSK address._
32+
* Figure 3 - Fast bridge interactions when the LP fails to call the LBC on behalf of the user. The LBC slashes the LP's collateral and refunds the user on the refund RSK address._

0 commit comments

Comments
 (0)