chore(spec): update bridge spec #1705
Merged
+201
−85
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
github-actions
bot
added
the
documentation
itamarreif
force-pushed
the
itamarreif/bridge/docs-update
branch
2 times, most recently
from
0856cb1
to
bd609d9
Compare
itamarreif
force-pushed
the
itamarreif/bridge/docs-update
branch
from
bd609d9
to
926dc49
Compare
noot
reviewed
Oct 29, 2024
|
|
||
| The Astria sequencer implements a native bridging protocol which allows for | ||
| bridging assets from the sequencer to rollups which decide to use this protocol. | ||
|
|
||
| At a high level, the sequencer-to-rollup protocol works as follows: |
There was a problem hiding this comment.
i like having the high level summary first, before delving into the code details. can you re-add?
noot
reviewed
Oct 29, 2024
specs/bridge.md
Outdated
| 1. A bridge account is initialized on the sequencer with an associated rollup | ||
| ID, which is the rollup ID that the rollup reads its block data from. | ||
|
|
||
| 2. The rollup registers the sequencer bridge account for use in its state |
There was a problem hiding this comment.
i would say "modifies its consensus" or something like that here
noot
reviewed
Oct 29, 2024
specs/bridge.md
Outdated
Comment on lines
47
to
48
| transfer funds out of the bridge account to other sequencer accounts, such as | ||
| [`BridgeUnlock` actions.](https://github.com/astriaorg/astria/blob/d03059977c3a40590d66591c520bfda3a9b9de1c/proto/protocolapis/astria/protocol/transaction/v1/action.proto#L186) |
There was a problem hiding this comment.
Suggested change
| transfer funds out of the bridge account to other sequencer accounts, such as | |
| [`BridgeUnlock` actions.](https://github.com/astriaorg/astria/blob/d03059977c3a40590d66591c520bfda3a9b9de1c/proto/protocolapis/astria/protocol/transaction/v1/action.proto#L186) | |
| transfer funds out of the bridge account to other sequencer accounts, eg. via | |
| [`BridgeUnlock` actions.](https://github.com/astriaorg/astria/blob/d03059977c3a40590d66591c520bfda3a9b9de1c/proto/protocolapis/astria/protocol/transaction/v1/action.proto#L186) |
also mention funds can only be transferred out via BridgeUnlock or IBC withdrawal?
noot
reviewed
Oct 29, 2024
specs/bridge.md
Outdated
Comment on lines
104
to
105
| the `Withdrawal` event. These actions are batched and signed into sequencer | ||
| transaction by rollup block, and the transaction is submitted to the sequencer. |
There was a problem hiding this comment.
Suggested change
| the `Withdrawal` event. These actions are batched and signed into sequencer | |
| transaction by rollup block, and the transaction is submitted to the sequencer. | |
| the `Withdrawal` event. These actions are batched by rollup block into one sequencer transaction, and the transaction is submitted to the sequencer. |
noot
reviewed
Oct 29, 2024
specs/bridge.md
Outdated
| `Withdrawal` event that includes the asset, the amount, and a memo. | ||
| - the memo contains the needed information for creating an Ics20 withdrawal on | ||
| The User initiates a withdrawal from the rollup to an IBC destination using the | ||
| `Ics20Withdrawal` function of an `IAstriaWithdrawer`-compatible smart contract. This |
There was a problem hiding this comment.
Suggested change
| `Ics20Withdrawal` function of an `IAstriaWithdrawer`-compatible smart contract. This | |
| `withdrawToIbcChain` function of an `IAstriaWithdrawer`-compatible smart contract. This |
itamarreif
force-pushed
the
itamarreif/bridge/docs-update
branch
from
0772a3a
to
ca80845
Compare
noot
reviewed
Oct 31, 2024
specs/bridge.md
Outdated
Comment on lines
29
to
30
| 1. The bridge withdrawer is registered with the sequencer-side bridge account, | ||
| allowing it to make withdrawals from the bridge account. |
There was a problem hiding this comment.
this is a bit confusing, maybe rephrase to "the bridge account has an associated withdrawer address which is authorized to withdraw from the bridge account"
noot
approved these changes
Oct 31, 2024
itamarreif
force-pushed
the
itamarreif/bridge/docs-update
branch
from
01a0966
to
9234977
Compare
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.
Summary
Updated the bridge spec to add more details on some of the data structures and link to the up-to-date actions.
Background
With the preparation for mainnet, some of the action names and locations have changed. The spec needed updating to reflect that.
Related Issues
Link any issues that are related, prefer full github links.
closes