Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Snowbridge V2 docs #5902

Merged
merged 13 commits into from
Oct 9, 2024
Merged

Snowbridge V2 docs #5902

merged 13 commits into from
Oct 9, 2024

Conversation

vgeddes
Copy link
Contributor

@vgeddes vgeddes commented Oct 2, 2024

Here are MD docs for V2 @acatangiu @franciscoaguirre . Let me know what you think.

@vgeddes vgeddes marked this pull request as ready for review October 2, 2024 10:14
@paritytech-review-bot paritytech-review-bot bot requested a review from a team October 2, 2024 10:15
@acatangiu acatangiu added R0-silent Changes should not be mentioned in any release notes T11-documentation This PR/Issue is related to documentation. labels Oct 2, 2024
Copy link
Contributor

@acatangiu acatangiu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the great write-up capturing everything we discussed!

bridges/snowbridge/docs/v2.md Outdated Show resolved Hide resolved
bridges/snowbridge/docs/v2.md Outdated Show resolved Hide resolved
bridges/snowbridge/docs/v2.md Outdated Show resolved Hide resolved
bridges/snowbridge/docs/v2.md Outdated Show resolved Hide resolved
bridges/snowbridge/docs/v2.md Outdated Show resolved Hide resolved
bridges/snowbridge/docs/v2.md Outdated Show resolved Hide resolved
bridges/snowbridge/docs/v2.md Outdated Show resolved Hide resolved
bridges/snowbridge/docs/v2.md Outdated Show resolved Hide resolved
bridges/snowbridge/docs/v2.md Outdated Show resolved Hide resolved
bridges/snowbridge/docs/v2.md Outdated Show resolved Hide resolved
Comment on lines 36 to 38
2. Dry-run $x_1$ on AH to receive xcm $x_2$ and cost $b$ in DOT
3. Dry-run $x_2$ on BH to receive command $m$ and cost $c$ in DOT
4. Dry-run $m$ on Ethereum to receive cost $d$ in ETH
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given that you previously stated $P^{'}$ and $E^{'}$ were the native currency of Polkadot and Ethereum respectively, should those be used here? Or should we just use DOT and ETH throughout?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The mathematical notation was useful for distilling the essence of the algorithm. However I've made it more clear in 495ab69 that DOT and ETH are alternative names.

bridges/snowbridge/docs/v2.md Outdated Show resolved Hide resolved
- Given source parachain $S$, with native token $S^{'}$ and the initial xcm $x_0$ to be executed on $S$.
- The native currency $P^{'}$ of the Polkadot relay chain, and $E^{'}$ of Ethereum.
- Suppose that the user agent chooses relayer reward $r$ in $E^{'}$.
- Suppose that the exchange rates $K_{P^{'}/S^{'}}$ and $K_{E^{'}/S^{'}}$. The user agent chooses a multiplier to $\beta$ to cover volatility in these rates.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These rates are obtained off-chain and the total fee might be too low if the rates were wrong and beta not enough to cover the difference, right?

I might add a little note here to highlight the importance of getting the correct exchange rates and the consequence of not having them.

bridges/snowbridge/docs/v2.md Outdated Show resolved Hide resolved
bridges/snowbridge/docs/v2.md Outdated Show resolved Hide resolved
bridges/snowbridge/docs/v2.md Outdated Show resolved Hide resolved
bridges/snowbridge/docs/v2.md Outdated Show resolved Hide resolved
bridges/snowbridge/docs/v2.md Outdated Show resolved Hide resolved
bridges/snowbridge/docs/v2.md Outdated Show resolved Hide resolved
bridges/snowbridge/docs/v2.md Outdated Show resolved Hide resolved
Copy link
Contributor

@franciscoaguirre franciscoaguirre left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great writeup 😄

bridges/snowbridge/docs/v2.md Outdated Show resolved Hide resolved
bridges/snowbridge/docs/v2.md Outdated Show resolved Hide resolved
bridges/snowbridge/docs/v2.md Outdated Show resolved Hide resolved
bridges/snowbridge/docs/v2.md Outdated Show resolved Hide resolved
bridges/snowbridge/docs/v2.md Show resolved Hide resolved
vgeddes and others added 4 commits October 9, 2024 15:01
Co-authored-by: Francisco Aguirre <franciscoaguirreperez@gmail.com>
Co-authored-by: Adrian Catangiu <adrian@parity.io>
Co-authored-by: Alistair Singh <alistair.singh7@gmail.com>
Co-authored-by: Francisco Aguirre <franciscoaguirreperez@gmail.com>
@Polkadot-Forum
Copy link

This pull request has been mentioned on Polkadot Forum. There might be relevant details there:

https://forum.polkadot.network/t/snowbridge-september-update/10389/1

@acatangiu acatangiu added this pull request to the merge queue Oct 9, 2024
Merged via the queue into paritytech:master with commit 90ff47d Oct 9, 2024
185 of 196 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
R0-silent Changes should not be mentioned in any release notes T11-documentation This PR/Issue is related to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants