Add how to use timeboost #1772
Draft
Add how to use timeboost #1772
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
…nLabs/arbitrum-docs into add-how-to-use-timeboost
leeederek
requested changes
Nov 22, 2024
| content_type: how-to | ||
| --- | ||
|
|
||
| Timeboost is a new transaction ordering policy for Arbitrum chains where any participant can bid for the right to access an express lane on the sequencer for faster transaction inclusion. |
There was a problem hiding this comment.
Suggested change
| Timeboost is a new transaction ordering policy for Arbitrum chains where any participant can bid for the right to access an express lane on the sequencer for faster transaction inclusion. | |
| Timeboost is a new transaction ordering policy for Arbitrum chains. With Timeboost, anyone can bid for the right to access an express lane on the sequencer for faster transaction inclusion. |
|
|
||
| Timeboost is a new transaction ordering policy for Arbitrum chains where any participant can bid for the right to access an express lane on the sequencer for faster transaction inclusion. | ||
|
|
||
| In this how-to, you'll learn how to bid for the right to use the express lane, how to submit transactions to it, and how to transfer that right to someone else. To learn more about Timeboost, refer to the gentle introduction. |
There was a problem hiding this comment.
Suggested change
| In this how-to, you'll learn how to bid for the right to use the express lane, how to submit transactions to it, and how to transfer that right to someone else. To learn more about Timeboost, refer to the gentle introduction. | |
| In this how-to, you'll learn how to bid for the right to use the express lane, how to submit transactions through the express lane, and how to transfer that express lane rights to someone else. To learn more about Timeboost, refer to the [Gentle Introduction](TODO). |
|
|
||
| This how-to assumes that you're familiar with: | ||
|
|
||
| - [How Timeboost works](#) |
There was a problem hiding this comment.
This should link to the Gentle Introduction right?
|
|
||
| ## How to submit bids for the right to be the express lane controller | ||
|
|
||
| To use the express lane for faster transaction inclusion, we must win an auction for the right to be the express lane controller for a specific round. |
There was a problem hiding this comment.
Suggested change
| To use the express lane for faster transaction inclusion, we must win an auction for the right to be the express lane controller for a specific round. | |
| To use the express lane for faster transaction inclusion, you must win an auction for the right to be the express lane controller for a specific round. |
|
|
||
| ::::info | ||
|
|
||
| Remember that, by default, each round lasts 60 seconds, and the auction for a specific round closes 15 seconds before the round starts. These default values can be configured in a chain with the `roundDurationSeconds` and `auctionClosingSeconds` parameters respectively. |
There was a problem hiding this comment.
Suggested change
| Remember that, by default, each round lasts 60 seconds, and the auction for a specific round closes 15 seconds before the round starts. These default values can be configured in a chain with the `roundDurationSeconds` and `auctionClosingSeconds` parameters respectively. | |
| Remember that, by default, each round lasts 60 seconds, and the auction for a specific round closes 15 seconds before the round starts. These default values can be configured on a chain using the `roundDurationSeconds` and `auctionClosingSeconds` parameters, respectively. |
|
|
||
| :::: | ||
|
|
||
| ## How to transfer the right to use the express lane to someone else |
|
|
||
| From that moment, the previous express lane controller will not be able to send new transactions to the express lane. | ||
|
|
||
| ### Setting a transferor account |
There was a problem hiding this comment.
Let's add a sentence or two here to describe that we decided to add this function (setTransferor) for the express lane controller to nominate an address that can transfer rights to anyone they see fit. This is mostly to make reselling UX a bit better
|
|
||
| From that moment on (until the transferor is changed or disabled), the transferor will be able to call `transferExpressLaneController` while the express lane controller is `currentELCAccount` to transfer the rights to use the express lane to a different account. | ||
|
|
||
| ## How to withdraw funds deposited in the auction contract |
| console.log(`Finalize withdrawal transaction sent: ${finalizeWithdrawalTransaction}`); | ||
| ``` | ||
|
|
||
| ## How to identify timeboosted transactions |
|
|
||
| Transactions that have been sent to the express lane by the express lane controller, and that have been executed (regardless of them being successful or having reverted), can be identified by looking at their receipts, or the message broadcasted by the sequencer feed. | ||
|
|
||
| Transaction receipts include now a new field `timeboosted`, which will be `true` for timeboosted transactions, and `false` for regular non-timeboosted transactions. |
There was a problem hiding this comment.
Can you add an example of the Timeboosted metadata/field that gets returned when you make an eth_getTransactionReceipt call?
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.
This PR adds a guide on "How to use timeboost".
TODO:
Preview