-
Notifications
You must be signed in to change notification settings - Fork 449
Bridge articles overhaul #3287
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
Open
anegg0
wants to merge
22
commits into
master
Choose a base branch
from
bridge-articles-overhaul
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Bridge articles overhaul #3287
Changes from 10 commits
Commits
Show all changes
22 commits
Select commit
Hold shift + click to select a range
d51afbb
docs: add 'Register via DAO governance' article for generic-custom ga…
anegg0 7f31031
Merge branch 'master' into docs/standardized-token-registrations
anegg0 89136b4
remove duplicate content, this belongs in the AF repository
anegg0 593c84c
add external link to AF docs
anegg0 4e139eb
point DAO token registration to AF docs
anegg0 0af4c21
point second DAO token registration link to the AF doc
anegg0 552f072
add missing docs/how-arbitrum-works/deep-dives/token-bridging.mdx to …
anegg0 3723c29
attempt: making setup gateway section clearer and more cohesive
anegg0 a1bc339
add new cross-article partials for token bridging next steps, prereqs…
anegg0 b380d60
Merge remote-tracking branch 'origin/build-iterate' into bridge-artic…
anegg0 4628b9c
Update docs/how-arbitrum-works/timeboost/timeboost-reserve-originator…
anegg0 ea856f4
Update docs/how-arbitrum-works/timeboost/timeboost-reserve-originator…
anegg0 7581779
Update docs/how-arbitrum-works/timeboost/timeboost-reserve-originator…
anegg0 f8fbd36
Update docs/build-decentralized-apps/bridging/configure-token-gateway…
anegg0 9d7574c
Update docs/build-decentralized-apps/bridging/configure-token-gateway…
anegg0 dbe5de6
Update docs/build-decentralized-apps/bridging/configure-token-gateway…
anegg0 44ca057
Update docs/build-decentralized-apps/bridging/configure-token-gateway…
anegg0 d899d32
Update docs/build-decentralized-apps/bridging/configure-token-gateway…
anegg0 aec01eb
Update docs/build-decentralized-apps/bridging/configure-token-gateway…
anegg0 29f3a37
Merge branch 'master' into bridge-articles-overhaul
anegg0 10fbc72
yarn format
pete-vielhaber 0b22fd3
Merge branch 'master' into bridge-articles-overhaul
pete-vielhaber File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
215 changes: 128 additions & 87 deletions
215
docs/build-decentralized-apps/bridging/configure-token-gateway/custom.mdx
Large diffs are not rendered by default.
Oops, something went wrong.
192 changes: 122 additions & 70 deletions
192
docs/build-decentralized-apps/bridging/configure-token-gateway/generic-custom.mdx
Large diffs are not rendered by default.
Oops, something went wrong.
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
2 changes: 2 additions & 0 deletions
2
docs/build-decentralized-apps/bridging/partials/_token-bridging-next-steps.mdx
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| - [Deposit tokens to the child chain](/build-decentralized-apps/bridging/deposit/tokens.mdx) | ||
| - [Withdraw tokens back to the parent chain](/build-decentralized-apps/bridging/withdraw/tokens.mdx) |
1 change: 1 addition & 0 deletions
1
docs/build-decentralized-apps/bridging/partials/_token-bridging-prereqs.mdx
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| Familiarity with [Arbitrum's token bridge system](/how-arbitrum-works/deep-dives/token-bridging.mdx), smart contracts, and decentralized application development is required. If you're new to developing on Arbitrum, consider reviewing the [Quickstart: Build an app with Arbitrum](/build-decentralized-apps/01-quickstart-solidity-remix.mdx) before proceeding. We'll use [Arbitrum's SDK](https://github.com/OffchainLabs/arbitrum-sdk) throughout this how-to, although no prior knowledge is required. |
3 changes: 3 additions & 0 deletions
3
docs/build-decentralized-apps/bridging/partials/_token-bridging-resources.mdx
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| - [Token bridge conceptual overview](/how-arbitrum-works/deep-dives/token-bridging.mdx) | ||
| - [Arbitrum SDK](https://github.com/OffchainLabs/arbitrum-sdk) | ||
| - [Token bridge contract addresses](/build-decentralized-apps/reference/02-contract-addresses.mdx) |
40 changes: 40 additions & 0 deletions
40
docs/how-arbitrum-works/timeboost/timeboost-reserve-originator.mdx
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| --- | ||
| title: 'Timeboost - Reserve Originator' | ||
| description: Learn how to use timeboost | ||
| author: alxdca | ||
| sme: alxdca | ||
| content_type: how-to | ||
| sidebar_position: 2 | ||
| target_audience: Developers writing Stylus contracts in Rust using Stylus | ||
| --- | ||
|
|
||
| ## What’s the Reserve Originator ? | ||
|
|
||
| Timeboost is an auction-based mechanism to gain exclusive access to the Arbitrum sequencer express lane for a given amount of time. It was recently noticed that auction participation is low and collusion may be happening to lower the winning bid price. | ||
|
|
||
| The reserve originator is part of a new design that introduces a reserve price, a minimum per round fair access price to the auction. The reserve originator basically acts as a participant to the auction, fetches the reserve price from a dedicated service and submits a bid to the Auctioneer service. If the reserve originator ends up being the winner of the auction, the auctioneer will nullify the round, meaning no one gains the express lane. In that case, the reserve originator doesn’t pay anything. | ||
|
|
||
| ## Links | ||
|
|
||
| Problem definition and requirements: [[PRD] Timeboost Dynamic Reserve Price](https://www.notion.so/PRD-Timeboost-Dynamic-Reserve-Price-30c01a3f59f880c8abdaf6be9e3846f5?pvs=21) | ||
|
|
||
| Timeboost docs: https://docs.arbitrum.io/how-arbitrum-works/timeboost/gentle-introduction | ||
|
|
||
| Repository: https://github.com/OffchainLabs/timeboost-virtual-bidder | ||
|
|
||
| Reserve pricer: https://github.com/OffchainLabs/timeboost-reserve-pricer | ||
|
|
||
| Auctioneer code: https://github.com/OffchainLabs/nitro/tree/master/cmd/autonomous-auctioneer | ||
|
|
||
| ## Architecture | ||
|
anegg0 marked this conversation as resolved.
Outdated
|
||
|
|
||
| ## How to use it? | ||
|
|
||
| Any auction participant looking to submit a valid bid will need to access the Timeboost Reserve Pricer API to get the round and minimum bid amount. There are 2 API endpoints that can be access using the following command | ||
|
anegg0 marked this conversation as resolved.
Outdated
|
||
|
|
||
| `curl -H "Authorization: Bearer replace_with_api_token" ip_addr:port/api/latest` | ||
|
|
||
| - `/api/latest` which returns the newest reserve price and round | ||
| - `/api/recent` which returns the reserve price and rounds of the last 2 hours | ||
|
anegg0 marked this conversation as resolved.
Outdated
|
||
|
|
||
| The price gets updated at the 31st second of every minute. | ||
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is this public?