doc: update bridge documentation #880
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sameh-farouk
requested review from
brandonpille,
renauter,
LeeSmet and
muhamadazmy
as code owners
renauter
reviewed
Oct 25, 2023
bridge/docs/bridging.md
Outdated
| @@ -34,3 +34,94 @@ Again, a withdrawfee of 1 TFT will be taken, so make sure you send a larger amou | |||
| The amount withdrawn from TF Chain will be sent to your Stellar wallet. | |||
|
|
|||
| Example:  | |||
renauter
reviewed
Oct 25, 2023
renauter
reviewed
Oct 25, 2023
renauter
reviewed
Oct 25, 2023
renauter
reviewed
Oct 25, 2023
renauter
reviewed
Oct 25, 2023
renauter
reviewed
Oct 25, 2023
renauter
reviewed
Oct 25, 2023
renauter
reviewed
Oct 30, 2023
renauter
reviewed
Oct 30, 2023
renauter
reviewed
Oct 30, 2023
renauter
reviewed
Oct 30, 2023
renauter
reviewed
Oct 30, 2023
renauter
reviewed
Oct 30, 2023
renauter
reviewed
Oct 30, 2023
renauter
reviewed
Oct 30, 2023
renauter
reviewed
Oct 30, 2023
renauter
reviewed
Oct 30, 2023
renauter
reviewed
Oct 30, 2023
renauter
reviewed
Oct 30, 2023
renauter
reviewed
Oct 30, 2023
renauter
requested changes
Oct 30, 2023
renauter
approved these changes
Nov 1, 2023
sameh-farouk
commented
Nov 1, 2023
bridge/docs/bridging.md
Outdated
|
|
||
| 2. The transaction information undergoes validation. If it fails, a refund is issued (sent back to the stellar source account). Starting from this point, we assume that the validation has passed, but we will examine the refund flow in the next section. | ||
| 2. Each time such transaction event is reported by a bridge validator it undergoes some validation. If it fails, a refund is issued (sent back to the stellar source account). Here we assume that the validation has passed, but we will examine the refund flow in the next section. |
There was a problem hiding this comment.
reported -> received
bridge/docs/bridging.md
Outdated
| @@ -41,13 +41,13 @@ Example:  | |||
|
|
|||
| In this section, we look into the details of transferring TFT from a Stellar Account to a TFChain Account. | |||
|
|
|||
| 1. A transaction is received on the bridge Stellar account and witnessed by a bridge validator.. | |||
| 1. A transaction is received on the bridge Stellar account (aka. vault) and monitored by bridge validators (deamons). | |||
There was a problem hiding this comment.
monitored -> noticed or witnessed
bridge/docs/bridging.md
Outdated
| * `tftBridgeModule.BurnTransactionExpired` | ||
| * `tftBridgeModule.RefundTransactionExpired` | ||
| * `tftBridgeModule.BurnTransactionExpired`: from TFCHAIN -> STELLAR burn flow, when transaction (burn TFT on TFChain source account and transfer amount from Stellar vault account to Stellar destination account) is stuck in bridge. | ||
| * `tftBridgeModule.RefundTransactionExpired`: from STELLAR -> TFCHAIN refund flow, after TFT were locked into Stellar vault, finally not minted to TFChain, and transaction to get it back to Stellar source account is stuck in bridge. |
There was a problem hiding this comment.
I think saying stuck in bridge is technically wrong? you can say the transfer is pending approval from bridge daemons instead which more accurate
also Both events explained below, if you think we need to include a short description here as well lets say something like
- certain number of TFChain blocks passed without a
BurnTransactionbeing noticed and signed by the majority of bridge validators - certain number of TFChain blocks passed without a
RefundTransactionbeing noticed and signed by the majority of bridge validators
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This pull request enhances the documentation for the TFChain bridge by providing a more detailed look into the sequential flow of how it works, which is divided between the Stellar network, bridge daemon/s, and TFChain runtime.
The added information would lessen the learning curve for newcomers.
Checklist: