Implement BidTx #1633
Closed
Implement BidTx #1633
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
jparr721
reviewed
Jun 21, 2024
tbro
commented
Jun 25, 2024
elliedavidson
requested changes
Jul 2, 2024
sequencer/src/auction.rs
Outdated
Comment on lines
20
to
71
| struct SequencerKey; | ||
|
|
||
| // for MVP-0(-1) (JIT) | ||
| // Sum of all sequencing fee match current check | ||
| // builder signature no longer includes payload | ||
| // new fee info flag (fee or bid) | ||
|
|
||
| pub struct MarketplaceResults { | ||
| /// Slot these results are for | ||
| slot: Slot, | ||
| /// Bids that did not win, initially all bids are added to this, | ||
| /// and then the winning bids are removed | ||
| pending_bids: Vec<BidTx>, | ||
| /// Map of winning sequencer public keys to the bundle of namespaces they bid for | ||
| winner_map: HashMap<SequencerKey, HashSet<NamespaceId>>, | ||
| /// Whether refunds have been processed for this slot | ||
| refunds_processed: bool, | ||
| } | ||
|
|
||
| // - needs to be configured in genesis block | ||
| // - needs to be updatable | ||
| /// Configuration for the auction system | ||
| struct AuctionConfig { | ||
| bid_phase_num_views: NonZeroU64, | ||
| auction_phase_num_views: NonZeroU64, | ||
| sequencing_phase_num_views: NonZeroU64, | ||
| } | ||
|
|
||
| /// Uniquely identifies an auction for sequencing rights of namespaces in the network | ||
| #[derive(Clone, Copy)] | ||
| struct AuctionId(u64); | ||
|
|
||
| /// Uniquely identifies one auction phase for a specific auction | ||
| #[derive(Clone, Copy)] | ||
| struct AuctionPhaseId(AuctionId, AuctionPhaseKind); | ||
|
|
||
| /// Describes one auction phase for a specific auction | ||
| #[derive(Clone, Copy)] | ||
| struct AuctionPhase { | ||
| id: AuctionPhaseId, | ||
| kind: AuctionPhaseKind, | ||
| start: ViewNumber, | ||
| end: ViewNumber, | ||
| } | ||
|
|
||
| /// Describes the 3 kinds of phases an active auction can be in | ||
| #[derive(Clone, Copy, Eq, PartialEq)] | ||
| enum AuctionPhaseKind { | ||
| Bid, | ||
| Assign, | ||
| Sequence, | ||
| } |
There was a problem hiding this comment.
I think we can remove all this for now (but let's keep in on a branch for later when we need it)
sequencer/src/auction.rs
Outdated
| /// from this sequencer if they win the auction | ||
| url: Url, | ||
| /// The slot this bid is for | ||
| slot: Slot, |
There was a problem hiding this comment.
Let's change this to be of ViewNumber type. The JIT auction won't have a concept of slots. See here for reference: https://www.notion.so/espressosys/Yet-Another-Marketplace-Spec-WIP-c09873314c8241e4b4e6463594d44bb6?pvs=4#7a316e557df44de7a834f82182d2b7fc
sequencer/src/auction.rs
Outdated
| bid_amount: FeeAmount, | ||
| // TODO What is the correct type? What do we use this for? | ||
| /// The public key of this sequencer | ||
| public_key: SequencerKey, |
There was a problem hiding this comment.
This should be the public key of the builder, which I think is BuilderSignatureKey type
sequencer/src/auction.rs
Outdated
| let key = FeeAccount::test_key_pair(); | ||
| let nsid = NamespaceId::from(999); | ||
| Self { | ||
| url: Url::from_str("htts://sequencer:3939/request_budle").unwrap(), |
There was a problem hiding this comment.
This URL will be just the base URL of the builder's API: https://<builder_url>.
sequencer/src/auction.rs
Outdated
Comment on lines
212
to
217
| if get_phase() != AuctionPhaseKind::Bid { | ||
| return Err(( | ||
| ExecutionError::InvalidPhase, | ||
| FullNetworkTx::Bid(self.clone()), | ||
| )); | ||
| } |
There was a problem hiding this comment.
We can remove this for the JIT auction
sequencer/src/auction.rs
Outdated
| .map_err(|e| (e, FullNetworkTx::Bid(self.clone())))?; | ||
|
|
||
| // TODO do we still do this in JIT auction? | ||
| // store_in_marketplace_state(); |
There was a problem hiding this comment.
No, we don't need to store any state for the JIT auction.
sequencer/src/auction.rs
Outdated
| // TODO I'm not sure how phases will work in JIT | ||
| pub fn get_phase() -> AuctionPhaseKind { | ||
| AuctionPhaseKind::Bid | ||
| } | ||
|
|
There was a problem hiding this comment.
There are no phases in the JIT auction
sequencer/src/header.rs
Outdated
Comment on lines
102
to
105
| // /// refund flag set at the beginning of new slots | ||
| // /// In extreme cases, more than one slot may need to be refunded, | ||
| // /// hence this data structure | ||
| // pub refund_bids: HashSet<Slot>, |
There was a problem hiding this comment.
We can delete this for now.
sequencer/src/state.rs
Outdated
Comment on lines
85
to
87
| // TODO | ||
| // /// Map of Marketplace Results. | ||
| // slot_map: HashMap<Slot, MarketplaceResults>, |
There was a problem hiding this comment.
The JIT auction no longer has the marketplace results struct, so we can delete this.
tbro
commented
Jul 3, 2024
FullNetworkTx for MVP-0 Auctions * we are currently only concerned with `BidTx` * there is some very basic coverage of essential functionality
cleanup
build a `BidTx` with `signed`
tbro
added a commit
that referenced
this pull request
Jul 11, 2024
`BidTx` as a varian of `FullNetworkTx`. Includes some tests. Closes #1633
Draft
tbro
added a commit
that referenced
this pull request
Jul 11, 2024
`BidTx` as a varian of `FullNetworkTx`. Includes some tests. Closes #1633
|
Closing superseded by #1696 |
tbro
added a commit
that referenced
this pull request
Jul 17, 2024
`BidTx` as a varian of `FullNetworkTx`. Includes some tests. Closes #1633
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:
This PR itroduces
FullNetworkTxby way of a single enum variant,BidTx. To meet upcoming goals we only needBidTxbut having it nested in long term structure may be helpful. There is a tiny bit of test coverage to ensure a moderate degree of santity.This is a DRAFT and exists for collaboration and to gather feedback.
Key places to review:
Most of the juicy bits are in
auction.rs.Headerinheader.rshas been given some useful methods (mocks for now) and validation logic instate.rshas been updated to execute the transaction. None of the logic is complete or refined, but it more or less covers the breadth of requirements for the first iteration ofBidTx.How to test this PR:
Tests are currently testing, you can run
cargo testif you like.Things tested
There is currently a test for verifying signature of a mock
BidTx.