create a new page for the Yield Bridge - #3500
Open
0xallan wants to merge 9 commits into
Open
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
[copilot] Clarified the roles and responsibilities of the chain operator and added details about deposit entrypoints and yield distribution mechanisms.
0xallan
marked this pull request as ready for review
August 4, 2026 22:11
waelsy123
reviewed
Aug 5, 2026
waelsy123
reviewed
Aug 5, 2026
|
|
||
| **Withdrawing to the parent chain.** The child chain gateway burns the token and sends a <a data-quicklook-from="l2-to-l1-message">child-to-parent message</a> exactly as it does for a canonical bridge. When that message executes, the parent chain gateway delivers `MasterVault` shares to the recipient rather than the underlying asset. The recipient then calls `redeem` on the vault to exchange those shares for the asset, optionally specifying a minimum amount to receive. Redemption is permissionless and available at any time: the vault pays from its idle balance and withdraws from the sub-vault to cover any shortfall. | ||
|
|
||
| **Rebalancing.** Deposits and withdrawals do not move capital in or out of the sub-vault. A keeper, appointed by the chain operator or a delegated vault manager, calls `rebalance` to bring the idle balance back to its target, which is the primary operation that moves capital into or out of the sub-vault. Each call passes a minimum exchange rate, which bounds how much the sub-vault's share price may move against the vault while the transaction is in flight. |
There was a problem hiding this comment.
Deposits never move capital into the sub-vault, and rebalancing is the only operation that does. Withdrawals pull from the sub-vault only to cover a shortfall in the idle balance.
Clarified description of MasterVault's role and structure.
godzillaba
approved these changes
Aug 6, 2026
|
|
||
| ## Deposit and withdrawal flow | ||
|
|
||
| **Depositing from the parent chain.** The user calls the gateway router as they would for any bridged token. The gateway pulls the underlying asset from the user, deposits it into that token's `MasterVault`, and holds the shares it receives as escrow. A retryable ticket mints the child chain token to the user. Shares are issued one-for-one with the asset, so the child chain balance matches what the user deposited. The router also exposes a deposit entrypoint that takes a minimum amount to be received on the child chain and reverts if the vault would issue fewer shares than that. This is useful when the vault may be carrying a loss. |
Contributor
There was a problem hiding this comment.
Suggested change
| **Depositing from the parent chain.** The user calls the gateway router as they would for any bridged token. The gateway pulls the underlying asset from the user, deposits it into that token's `MasterVault`, and holds the shares it receives as escrow. A retryable ticket mints the child chain token to the user. Shares are issued one-for-one with the asset, so the child chain balance matches what the user deposited. The router also exposes a deposit entrypoint that takes a minimum amount to be received on the child chain and reverts if the vault would issue fewer shares than that. This is useful when the vault may be carrying a loss. | |
| **Depositing from the parent chain.** The user calls the gateway router as they would for any bridged token. The gateway pulls the underlying asset from the user, deposits it into that token's `MasterVault`, and holds the shares it receives as escrow. A retryable ticket mints child chain tokens to the user 1 for 1 with `MasterVault` shares. Unless the `MasterVault` has suffered losses, shares are issued one-for-one with the asset, so the child chain balance matches what the user deposited. The router also exposes a deposit entrypoint that takes a minimum amount to be received on the child chain and reverts if the vault would issue fewer shares than that. This is useful when the vault may be carrying a loss, because the exchange rate can change in that situation. |
i think my suggested wording isn't very good, but basically wanted to make the fact that L2 token is 1 to 1 with MV shares, and MV shares are usually 1-1 with asset. the slippage tolerance is useful when MV is trading at less than 1 asset, and it suddenly spikes in value before the user lands their deposit
Co-authored-by: Henry <11198460+godzillaba@users.noreply.github.com>
waelsy123
self-requested a review
August 7, 2026 09:59
waelsy123
approved these changes
Aug 7, 2026
waelsy123
approved these changes
Aug 13, 2026
This file contains hidden or 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
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.
Thank you for contributing to our docs!
Please fill out the form below to ensure your doc gets quickly approved and merged.
Description
Adding a new page for the Yield Bridge, a new kind of bridge that allows chain operators to earn yield on the assets locked in the bridge on the parent chain.
Document type
Checklist
yarn startoryarn buildAdditional Notes