-
Notifications
You must be signed in to change notification settings - Fork 360
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
Add how to use timeboost #1772
base: master
Are you sure you want to change the base?
Add how to use timeboost #1772
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
…nLabs/arbitrum-docs into add-how-to-use-timeboost
arbitrum-docs/build-decentralized-apps/how-to-use-timeboost.mdx
Outdated
Show resolved
Hide resolved
arbitrum-docs/build-decentralized-apps/how-to-use-timeboost.mdx
Outdated
Show resolved
Hide resolved
arbitrum-docs/build-decentralized-apps/how-to-use-timeboost.mdx
Outdated
Show resolved
Hide resolved
arbitrum-docs/build-decentralized-apps/how-to-use-timeboost.mdx
Outdated
Show resolved
Hide resolved
arbitrum-docs/build-decentralized-apps/how-to-use-timeboost.mdx
Outdated
Show resolved
Hide resolved
arbitrum-docs/build-decentralized-apps/how-to-use-timeboost.mdx
Outdated
Show resolved
Hide resolved
arbitrum-docs/build-decentralized-apps/how-to-use-timeboost.mdx
Outdated
Show resolved
Hide resolved
arbitrum-docs/build-decentralized-apps/how-to-use-timeboost.mdx
Outdated
Show resolved
Hide resolved
arbitrum-docs/build-decentralized-apps/how-to-use-timeboost.mdx
Outdated
Show resolved
Hide resolved
arbitrum-docs/build-decentralized-apps/how-to-use-timeboost.mdx
Outdated
Show resolved
Hide resolved
arbitrum-docs/build-decentralized-apps/how-to-use-timeboost.mdx
Outdated
Show resolved
Hide resolved
|
||
:::: | ||
|
||
Auctions are held in an auction contract, and bids are submitted to an autonomous auctioneer, that also communicates with the contract. Let's take a look at the process of submitting bids and finding out the winner of an auction. |
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.
Auctions are held in an auction contract, and bids are submitted to an autonomous auctioneer, that also communicates with the contract. Let's take a look at the process of submitting bids and finding out the winner of an auction. | |
Auctions are in an auction contract, and bids get submitted to an autonomous auctioneer who communicates with the contract. Let's look at the process of submitting bids and finding out the winner of an auction. |
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.
I kept held
here. It seems to me that the sentence is not completed by just saying "Auctions are in an auction contract".
|
||
### Step 1: deposit funds into the auction contract | ||
|
||
Before bidding on an auction, we need to deposit funds in the auction contract. These funds are deposited in the form of the ERC-20 token used to bid, also known as, the `bidding token`. We will be able to bid for an amount that is equal to or less than the tokens we have deposited in the auction contract. |
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.
Before bidding on an auction, we need to deposit funds in the auction contract. These funds are deposited in the form of the ERC-20 token used to bid, also known as, the `bidding token`. We will be able to bid for an amount that is equal to or less than the tokens we have deposited in the auction contract. | |
Before bidding on an auction, we need to deposit funds in the auction contract. These deposited funds are the ERC-20 token used to bid, also known as the `bidding token`. We will be able to bid for an amount that is equal to or less than the tokens we have deposited in the auction contract. |
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.
I'd like to be a bit more explicit with what I'm referring to with "funds", since it can mean different things. I've kept the sentence as it was, but happy to change it to something that keeps my intention
arbitrum-docs/build-decentralized-apps/how-to-use-timeboost.mdx
Outdated
Show resolved
Hide resolved
arbitrum-docs/build-decentralized-apps/how-to-use-timeboost.mdx
Outdated
Show resolved
Hide resolved
arbitrum-docs/build-decentralized-apps/how-to-use-timeboost.mdx
Outdated
Show resolved
Hide resolved
arbitrum-docs/build-decentralized-apps/how-to-use-timeboost.mdx
Outdated
Show resolved
Hide resolved
arbitrum-docs/build-decentralized-apps/how-to-use-timeboost.mdx
Outdated
Show resolved
Hide resolved
|
||
### Step 3: find out the winner of the auction | ||
|
||
After the auction closes, and before the round starts, the autonomous auctioneer will call the auction contract with the two highest bids received, so the contract can declare the winner and subtract the second-highest bid from the winner's deposited funds. After this, the contract will emit an event with the new express lane controller address. |
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.
After the auction closes, and before the round starts, the autonomous auctioneer will call the auction contract with the two highest bids received, so the contract can declare the winner and subtract the second-highest bid from the winner's deposited funds. After this, the contract will emit an event with the new express lane controller address. | |
After the auction closes, and before the round starts the autonomous auctioneer will call the auction contract with the two highest bids received so the contract can declare the winner and subtract the second-highest bid from the winner's deposited funds. After this, the contract will emit an event with the new express lane controller address. |
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.
Why not keeping the first comma? I don't know the right term in english, but that bit seems to be a clarification of what I'm trying to explain, which is usually surrounded by commas.
Or maybe the intention was to remove the one after closes
? (that might sound better now that I look at it). I'll remove that one and we can discuss further changes.
arbitrum-docs/build-decentralized-apps/how-to-use-timeboost.mdx
Outdated
Show resolved
Hide resolved
arbitrum-docs/build-decentralized-apps/how-to-use-timeboost.mdx
Outdated
Show resolved
Hide resolved
|
||
::::info Timeboost-ing third party transactions | ||
|
||
Notice that, while the express lane controller needs to sign the `timeboost_sendExpressLaneTransaction` request, the actual transaction to be executed can be signed by any party. In other words, the express lane controller can receive transactions signed by other parties and sign them to apply the time advantage offered by the express lane to those transactions. |
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.
Notice that, while the express lane controller needs to sign the `timeboost_sendExpressLaneTransaction` request, the actual transaction to be executed can be signed by any party. In other words, the express lane controller can receive transactions signed by other parties and sign them to apply the time advantage offered by the express lane to those transactions. | |
Notice that while the express lane controller must sign the `timeboost_sendExpressLaneTransaction` request, any party can sign the transaction to execute it. In other words, the express lane controller can receive transactions signed by other parties and sign them to apply the time advantage offered by the express lane to those transactions. |
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.
The second bit of the correction might lead to some misconceptions, so I prefer to be a bit more clear with it. For context, what's happening here is that the express lane controller (ELC) will sign and send the request to the sequencer, but within that request there's a transaction signed by whoever wishes their transaction to be sent through the express lane (might be the ELC or a third party). That signer must collaborate with the ELC though, since the ELC is the one sending the transaction to the sequencer.
I'm not completely happy with my description either, but the correction might lead to thinking that anyone (regardless of them collaborating with the ELC) can sign the transaction.
I'll keep the original text (with your first correction), but happy to hear other alternatives:
Notice that while the express lane controller must sign the
timeboost_sendExpressLaneTransaction request, the actual transaction to be executed can be signed by any party. In other words, the express lane controller can receive transactions signed by other parties and sign them to apply the time advantage offered by the express lane to those transactions.
arbitrum-docs/build-decentralized-apps/how-to-use-timeboost.mdx
Outdated
Show resolved
Hide resolved
arbitrum-docs/build-decentralized-apps/how-to-use-timeboost.mdx
Outdated
Show resolved
Hide resolved
arbitrum-docs/build-decentralized-apps/how-to-use-timeboost.mdx
Outdated
Show resolved
Hide resolved
arbitrum-docs/build-decentralized-apps/how-to-use-timeboost.mdx
Outdated
Show resolved
Hide resolved
arbitrum-docs/build-decentralized-apps/how-to-use-timeboost.mdx
Outdated
Show resolved
Hide resolved
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.
Minor changes throughout for readability.
This PR adds a guide on "How to use timeboost".
TODO:
Preview