From 7b6e9cb2daa2fcb40b3c94f34d2a6b5e13402218 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Sat, 22 Jun 2024 21:34:46 +0300 Subject: [PATCH 01/85] Update and rename get-started/introduction.mdx to get-started/welcome/welcome-to-primev.mdx --- .../welcome-to-primev.mdx} | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) rename get-started/{introduction.mdx => welcome/welcome-to-primev.mdx} (78%) diff --git a/get-started/introduction.mdx b/get-started/welcome/welcome-to-primev.mdx similarity index 78% rename from get-started/introduction.mdx rename to get-started/welcome/welcome-to-primev.mdx index c4878f9b..1848c412 100644 --- a/get-started/introduction.mdx +++ b/get-started/welcome/welcome-to-primev.mdx @@ -1,6 +1,6 @@ --- title: Welcome to Primev -sidebarTitle: Welcome +sidebarTitle: Welcome to Primev description: "Primev is building mev-commit; a credible commitment network used for preconfirmations & more" icon: sailboat mode: wide @@ -100,3 +100,17 @@ Choose the guide below that best aligns with your interests and needs: + +## About Primev + +Our mission at Primev is to create a robust, transparent, and efficient ecosystem for mev actors through the development of mev-commit, a credible commitment network utilized for preconfirmations and more. We are dedicated to fostering a permissionless, transparent, and sustainable mev ecosystem. + +### Engage with Us + +Connect with us on various platforms to stay updated and get involved: + +- **X**: Follow us for real-time updates and announcements [here](https://x.com/primev_xyz). +- **Github**: Track our progress, contribute to our open-source projects, and explore our repositories [here](https://github.com/primev). +- **Mirror**: Stay informed with our latest articles and research papers [here](https://mirror.xyz/preconf.eth). + +Our work is open-source, and we welcome contributions from the community to enhance and expand our ecosystem. From b0bb5e2f8fa7f9ea101d8fe2af84c1e801f74768 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Sat, 22 Jun 2024 21:49:47 +0300 Subject: [PATCH 02/85] Update and rename concepts/what-is-mev-commit.mdx to get-started/welcome/what-is-mev-commit.mdx --- .../welcome}/what-is-mev-commit.mdx | 46 +++++++------------ 1 file changed, 17 insertions(+), 29 deletions(-) rename {concepts => get-started/welcome}/what-is-mev-commit.mdx (65%) diff --git a/concepts/what-is-mev-commit.mdx b/get-started/welcome/what-is-mev-commit.mdx similarity index 65% rename from concepts/what-is-mev-commit.mdx rename to get-started/welcome/what-is-mev-commit.mdx index 138307c0..bcfb51ea 100644 --- a/concepts/what-is-mev-commit.mdx +++ b/get-started/welcome/what-is-mev-commit.mdx @@ -9,6 +9,18 @@ Mev-commit is a peer-to-peer (P2P) networking platform designed to facilitate re +## What are Bids? + +Within mev-commit, bids act as the foundational requests placed by bidders, signaling their need for specific transaction execution services. This process occurs within a peer-to-peer networking setup to streamline direct negotiations with execution service providers like block builders and rollup sequencers. Each bid, marked by the unique identifier of a transaction hash, enables a straightforward mechanism for providers across the network to recognize and respond to these requests. + +Bids essentially convey a user's readiness to pay a certain fee for the execution of their transaction, proposing a price designed to motivate execution providers to give priority to their transaction. + +## What are Commitments? + +Commitments within mev-commit represent the execution providers' affirmative responses to bids, confirming their agreement to execute the specified transactions at the proposed prices within designated blocks. These commitments are conveyed through cryptographic proofs or digital signatures, signifying the providers' acceptance of a bid. + +Commitments serve as the critical link that aligns the supply and demand dynamics of the network, facilitating an effective and streamlined process for transaction execution. + ## Actors Network actors' roles are defined based on their interactions with other ecosystem actors. The diagram below depicts a given mev actor's relative placement compared to others: @@ -17,48 +29,24 @@ Network actors' roles are defined based on their interactions with other ecosyst -For example, a Searcher can be a bidder for a Sequencer; but that same Sequencer can be a bidder for a block builder. Thus it's best to think of actors' roles in mev-commit similar to their roles in the mev pipeline. To the left of the diagram are bidders, and to the right of the diagram are execution providers who can issue commitments against these bids. +For example, a Searcher can be a bidder for a Sequencer, but that same Sequencer can be a bidder for a block builder. Thus, it's best to think of actors' roles in mev-commit as similar to their roles in the mev pipeline. To the left of the diagram are bidders, and to the right of the diagram are execution providers who can issue commitments against these bids. Under the Proposer Builder Separation (PBS) model, information only moves to the right among actors in the mev pipeline. With mev-commit, credible commitments for execution and bits of information flow from providers back to bidders, enabling them to effectively utilize block space. This two-way exchange of information and commitments within the mev-commit system enhances the dynamic utilization and management of block space, supporting a more interactive and responsive ecosystem. ### **Providers** -Providers in the mev ecosystem include **Block Builders, Relays, Proposers, Rollup Sequencers, and even Solvers**. They are crucial for the delivery of commitments through their role in respective ecosystem or their sophistication. These providers receive bids and deliver transaction inclusion and execution, ensuring the efficient and effective use of block space. +Providers in the mev ecosystem include **Block Builders, Relays, Proposers, Rollup Sequencers, and even Solvers**. They are crucial for the delivery of commitments through their role in the respective ecosystem or their sophistication. These providers receive bids and deliver transaction inclusion and execution, ensuring the efficient and effective use of block space. ### **Bidders** -Bidders consist of **Searchers, Solvers, Blob Producers, AA Bundlers, Wallets and even End Users**. They bid for execution services, aiming to optimize their transactions within the block space. Their activities are fundamental to maintaining a competitive and efficient environment within the mev pipeline, facilitating a dynamic market for block space utilization. - -For a deep-dive into these roles and their interactions, please visit the [Actors](/concepts/actors) section. - -## Bids +Bidders consist of **Searchers, Solvers, Blob Producers, AA Bundlers, Wallets, and even End Users**. They bid for execution services, aiming to optimize their transactions within the block space. Their activities are fundamental to maintaining a competitive and efficient environment within the mev pipeline, facilitating a dynamic market for block space utilization. -Within mev-commit, bids act as the foundational requests placed by bidders, signaling their need for specific transaction execution services. This process occurs within a peer-to-peer networking setup to streamline direct negotiations with execution service providers like block builders and rollup sequencers. Each bid, marked by the unique identifier of a transaction hash, enables a straightforward mechanism for providers across the network to recognize and respond to these requests. - -Bids essentially convey a user's readiness to pay a certain fee for the execution of their transaction, proposing a price designed to motivate execution providers to give priority to their transaction. - -## Commitments - -Commitments within mev-commit represent the execution providers' affirmative responses to bids, confirming their agreement to execute the specified transactions at the proposed prices within designated blocks. These commitments are conveyed through cryptographic proofs or digital signatures, signifying the providers' acceptance of a bid. - -Commitments serve as the critical link that aligns the supply and demand dynamics of the network, facilitating an effective and streamlined process for transaction execution. - -## mev-commit software components - -- [mev-commit p2p client](https://github.com/primev/mev-commit/tree/main/p2p) -- [mev-commit-geth](https://github.com/primev/mev-commit-geth) -- [contracts](https://github.com/primev/mev-commit/tree/main/contracts) -- [mev-commit-oracle](https://github.com/primev/mev-commit/tree/main/oracle) -- [mev-commit-bridge](https://github.com/primev/mev-commit/tree/main/bridge) +For a detailed look at these roles and their interactions, please visit the [Actors](/concepts/actors) section. ## Why mev-commit? Through our experience developing products for the Ethereum and the broader crypto ecosystem, we’ve learned that users want to interact with networks as a whole as opposed to single actors that represent some percentage of the network, which is challenging to provide in decentralized systems that have goals beyond user needs. -We've created mev-commit to address this and optimized it to solve for coordination inefficiencies across the actors of any blockchain network, which are sure to increase with decentralization and greater transaction complexity. Mev-commit's actor and chain agnostic credible commitment approach ensures that users are not only able to convey their needs to a blockchain network, but receive commitments from the executors of those needs in real time so they can confidently take actions based on their expectation being satisfied or not. +We've created mev-commit to address this and optimized it to solve coordination inefficiencies across the actors of any blockchain network, which are sure to increase with decentralization and greater transaction complexity. Mev-commit's actor and chain agnostic credible commitment approach ensures that users are not only able to convey their needs to a blockchain network, but receive commitments from the executors of those needs in real time so they can confidently take actions based on their expectation being satisfied or not. We’re constructing mev-commit to be aligned with the ethos of the crypto ecosystem, specifically the vision being laid out by the Ethereum Foundation, and out of protocol services that supplement that vision such as the current mev pipeline largely introduced by Flashbots. We don’t aim to design a different mev pipeline, but create new avenues for efficiency in solving coordination problems between actors that can be used to have an expectation matching experience when engaging in the existing auctions and mev pipeline. We plan to continue supporting mev-commit’s evolution and adoption according to this mission as the existing landscape shifts and new paradigms are introduced. - -## Contribute - -Stay updated and engage with Primev through our social platforms. Follow us on [Twitter](https://twitter.com/primev_xyz) for the latest news and updates, and contribute to our open-source journey on [GitHub](https://github.com/primev/). From 2607990ecf592142aee746946938dc848549bab6 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Sat, 22 Jun 2024 22:03:37 +0300 Subject: [PATCH 03/85] Update testnet.mdx --- developers/testnet.mdx | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/developers/testnet.mdx b/developers/testnet.mdx index 8a312f74..9263c0ba 100644 --- a/developers/testnet.mdx +++ b/developers/testnet.mdx @@ -3,9 +3,7 @@ title: mev-commit Testnet sidebarTitle: Testnet --- -## mev-commit Testnet - -Live on Holesky Testnet, mev-commit allows bidders and providers to engage in execution service bids and commitments. Preconfirmations, the first use case for real time bids and commitments, are available to be tested on the mev-commit testnet. +Live on Holesky Testnet, mev-commit allows bidders and providers to engage in execution service bids and commitments. Preconfirmations, the first use case for real-time bids and commitments, are available to be tested on the mev-commit testnet. ## **Links and Connection Details** @@ -61,6 +59,14 @@ Primev will maintain a testnet consisting of the mev-commit chain, oracle servic +## mev-commit software components + +- [mev-commit p2p client](https://github.com/primev/mev-commit/tree/main/p2p) +- [mev-commit-geth](https://github.com/primev/mev-commit-geth) +- [contracts](https://github.com/primev/mev-commit/tree/main/contracts) +- [mev-commit-oracle](https://github.com/primev/mev-commit/tree/main/oracle) +- [mev-commit-bridge](https://github.com/primev/mev-commit/tree/main/bridge) + ## Differences Between the Testnet and Mainnet Environments Testnet bridging ether to/from Holesky, whereas mainnet mev-commit chain will bridge using mainnet ether. Commitments are also written to the settlement chain in plaintext, whereas mainnnet will include private commitments. From f856203a75bcc4e40a34d3efb7d46c490c5e2a03 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Sat, 22 Jun 2024 22:12:27 +0300 Subject: [PATCH 04/85] Update sending-commitments.mdx --- get-started/providers/sending-commitments.mdx | 33 +++++++++---------- 1 file changed, 15 insertions(+), 18 deletions(-) diff --git a/get-started/providers/sending-commitments.mdx b/get-started/providers/sending-commitments.mdx index 408f374d..f0a3e24c 100644 --- a/get-started/providers/sending-commitments.mdx +++ b/get-started/providers/sending-commitments.mdx @@ -3,15 +3,9 @@ title: Sending Commitments sidebarTitle: Sending Commitments --- -To send your first commitment, you will need to connect to the mev-commit Testnet. -This will allow you to consume bids incoming to the network and submit commitments. -Your first step is to set up a provider node. The following command will allow you to automatically set up a full provider mev-commit node: +To send your first commitment, you will need to connect to the mev-commit Testnet. This will allow you to consume bids incoming to the network and submit commitments. To do this, you'll want to run an emulator to simulate accepting and rejecting bids. -``` -curl -L -o launchmevcommit launch.mev-commit.xyz && chmod +x launchmevcommit && ./launchmevcommit --node-type provider -``` - -Now you'll want to run an emulator to simulate the accepting and rejecting of bids. You can read more about the internal builder API [here](/api-reference/provider/sendprocessedbids). +You can read more about the internal builder API [here](/api-reference/provider/sendprocessedbids). To get started with the emulator, open a new terminal and run the following command: @@ -30,11 +24,13 @@ We can take a deeper look at how you can add custom logic to decision on the sen To integrate bid processing in your system using the Provider API, follow these steps to receive bid information and send back processed bids: -#### 1. Implement the gRPC Service + + Implement the Provider service as outlined in the [providerapi.proto](https://github.com/primev/mev-commit/blob/main/p2p/rpc/providerapi/v1/providerapi.proto#L20). This requires setting up a server that can manage RPC methods, with a particular emphasis on the reception of bids and response of commitment authorizations. + -#### 2. Receive Bids + Utilize the ReceiveBids RPC method to listen for incoming bids from clients. This method streams bid messages to your server. The structure of the bid is as follows: @@ -60,12 +56,12 @@ message Bid { Below is an image of the flow through which bids would be received through the gRPC API ![gRPC Flow for Getting Bids](/images/grpc-flow-getbids.png) - -#### 3. Process Bids + + For each received bid, implement your custom logic to validate and process these bids. This could involve checking the bid's validity and feasibility based on orderflow, computing the effective gas price, and deciding whether to accept or reject the bid. - -#### 4. Send Processed Bid Responses (Accept/Reject) + + After processing each bid, construct a BidResponse message indicating the outcome. This message should include the bid's digest and a status indicating acceptance or rejection. At a high level, to commit to a bid, your code must send a `STATUS_ACCEPTED` with the bid digest specified, and correspondingly `STATUS_REJECTED` to reject the bid. @@ -112,8 +108,8 @@ It contains the following fields: STATUS_REJECTED: Indicates that the bid has been rejected by the provider. 3. dispatch_timestamp: Timestamp (int64 type) at which the commitment is accepted by provider and is used to compute the expected revenue from the preconfirmation. - -#### 5. Server Setup + + Deploy your gRPC server on suitable infrastructure, ensuring it's accessible to clients. Configure necessary network settings for security and connectivity. Example Server Implementation in Go: @@ -150,5 +146,6 @@ func ...() { } } ``` - -This should help you integrate bid processing into your system, allowing for the reception of bid information and sending back processed bids as commitments. + + +This should help you integrate bid processing into your system, allowing you to receive bid information and send back processed bids as commitments. From ba5ee0c49bb02c6eb3a1aa52b0af44d8acac2eb5 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Sat, 22 Jun 2024 22:15:23 +0300 Subject: [PATCH 05/85] Update consuming-bids.mdx --- get-started/providers/consuming-bids.mdx | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/get-started/providers/consuming-bids.mdx b/get-started/providers/consuming-bids.mdx index 1b1c68c5..72a9fe0f 100644 --- a/get-started/providers/consuming-bids.mdx +++ b/get-started/providers/consuming-bids.mdx @@ -5,15 +5,17 @@ sidebarTitle: Consuming Bids Providers that have registered in the mev-commit registry will automatically start receiving bids on the mev-commit p2p network from bidders. In order to see incoming bids, providers need to communicate with their mev-commit node: -- Use the official go RPC client to communicate with your mev-commit node. Go get the mev-commit package and then import the generated client as below: +Use the official go RPC client to communicate with your mev-commit node. Go get the mev-commit package and then import the generated client as below: - 1. Install the mev-commit package: + + + ```bash ❯_ terminal go install github.com/primev/mev-commit@latest ``` - - 2. Incorporate the generated client into your Go application as follows: + + ```go import providerapiv1 "github.com/primev/mev-commit/p2p/gen/go/providerapi/v1" @@ -72,7 +74,8 @@ Providers that have registered in the mev-commit registry will automatically sta ``` There is an [example implementation](https://github.com/primev/mev-commit/tree/main/p2p/examples/provideremulator) of a dummy provider client which blindly accepts all the bids it sees from its mev-commit node. This could be a good starting point for providers implementing their commitment decision logic in golang. - + + ### Alternative Methods 1. Use [https://github.com/fullstorydev/grpcurl](https://github.com/fullstorydev/grpcurl) or [https://github.com/bloomrpc/bloomrpc](https://github.com/bloomrpc/bloomrpc) or other GUI clients like [Postman](https://www.postman.com). Relevant protobuf files are available in the [mev-commit repository](https://github.com/primev/mev-commit). From f0d75b45d39cb8c1576a0d9438c16e6c1657fdf9 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Sat, 22 Jun 2024 22:24:22 +0300 Subject: [PATCH 06/85] Update welcome-to-primev.mdx --- get-started/welcome/welcome-to-primev.mdx | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/get-started/welcome/welcome-to-primev.mdx b/get-started/welcome/welcome-to-primev.mdx index 1848c412..44acd2d9 100644 --- a/get-started/welcome/welcome-to-primev.mdx +++ b/get-started/welcome/welcome-to-primev.mdx @@ -40,11 +40,11 @@ Choose the guide below that best aligns with your interests and needs: • [Bidder Node Commands](/get-started/bidders/bidder-node-commands) - • [Bid Structure](/concepts/bids) + • [Bid Structure](/concepts/bids/bid-structure) - • [Tools For Bid Submission](/developers/tools-for-bid-submission) + • [Bidder Deposit](/concepts/bids/bidder-deposit) - • [Managing Your Bidder Deposit](/developers/bidder-deposit) + • [Bid Decay](/concepts/bids/bid-decay-mechanism) @@ -79,7 +79,7 @@ Choose the guide below that best aligns with your interests and needs: - L1 Ethereum validators + L1 Ethereum Validators @@ -91,9 +91,7 @@ Choose the guide below that best aligns with your interests and needs: • [Opting-in as a Validator](/get-started/validators) - • [What is mev-commit?](/concepts/what-is-mev-commit) - - • [Validator considerations](/concepts/validator-considerations) + • [Validator Considerations](/concepts/validator-considerations) • [mev-commit Testnet](/developers/testnet) From cb7fbac3c905b9194515873019afb9e270cb2ed4 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Sat, 22 Jun 2024 22:25:18 +0300 Subject: [PATCH 07/85] Update bid-structure.mdx --- concepts/bids/bid-structure.mdx | 1 + 1 file changed, 1 insertion(+) diff --git a/concepts/bids/bid-structure.mdx b/concepts/bids/bid-structure.mdx index e5dea326..032c35f3 100644 --- a/concepts/bids/bid-structure.mdx +++ b/concepts/bids/bid-structure.mdx @@ -1,4 +1,5 @@ --- +title: Bid Structure sidebarTitle: Bid Structure --- From 5d043fd9ea7ffe834e10412cf0b21cca3ca7f786 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Sat, 22 Jun 2024 22:28:54 +0300 Subject: [PATCH 08/85] Update welcome-to-primev.mdx --- get-started/welcome/welcome-to-primev.mdx | 1 - 1 file changed, 1 deletion(-) diff --git a/get-started/welcome/welcome-to-primev.mdx b/get-started/welcome/welcome-to-primev.mdx index 44acd2d9..fff3927f 100644 --- a/get-started/welcome/welcome-to-primev.mdx +++ b/get-started/welcome/welcome-to-primev.mdx @@ -2,7 +2,6 @@ title: Welcome to Primev sidebarTitle: Welcome to Primev description: "Primev is building mev-commit; a credible commitment network used for preconfirmations & more" -icon: sailboat mode: wide --- From dab4995a85d19196f7738b211e678eb6181c1fb1 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Sat, 22 Jun 2024 22:29:08 +0300 Subject: [PATCH 09/85] Update mint.json --- mint.json | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/mint.json b/mint.json index 9480a8d8..4334ab09 100644 --- a/mint.json +++ b/mint.json @@ -30,7 +30,14 @@ { "group": "Get Started", "pages": [ - "get-started/introduction", + { + "group": "Welcome", + "pages": [ + "get-started/welcome/welcome-to-primev", + "get-started/welcome/what-is-mev-commit" + ], + "icon": "sailboat" + }, "get-started/quickstart", "get-started/faucet", "get-started/validators", @@ -72,7 +79,7 @@ ] }, { - "group": "mev-commit Chain", + "group": "Mev-commit Chain", "pages": [ "concepts/mev-commit-chain/chain-details", "concepts/mev-commit-chain/differences-between-ethereum-and-mev-commit-chain", From 59d65bf14a4f1f27a362f3f68b7c157c46c11b96 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Sat, 22 Jun 2024 22:34:38 +0300 Subject: [PATCH 10/85] Update network-overview.mdx --- concepts/network-overview.mdx | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/concepts/network-overview.mdx b/concepts/network-overview.mdx index f7e14069..16f7155b 100644 --- a/concepts/network-overview.mdx +++ b/concepts/network-overview.mdx @@ -3,14 +3,24 @@ title: Understanding mev-commit sidebarTitle: Network Overview --- +### Overview + Mev-commit is designed as an out of protocol layer to systems like mev-boost, facilitating the exchange of execution bids and commitments between mev actors, solving for coordination inefficiencies. This design ensures that only necessary parts of this faciliation happen on mev-commit (bids, commitments, settlement) and not the transaction flow itself. This design achieves chain abstraction by its nature, as any transaction hash on any chain can be referred to in a mev-commit bid, and be paid in eth. Bids and commitments on mev-commit also do not rely on blockchain bottlenecks and are real-time. +### Bids and Commitments + Bids are received and evaluated by providers, who run decisioning logic in their own environment and may decide to issue a cryptographic commitment against whatever the bid is for. In the preconfirmation case, the minimum a commitment can be made is for inclusion of the referred transaction hash(es) in the bid on the target L1 block number specified. +### Commitment Settlements + Once the commitment is recorded on the mev-commit chain, an oracle will check the target L1 block number as it gets confirmed to see if the commitment is satisfied by the committing actor. If so, the bid amount will be rewarded to the provider. If not, the provider stake will be slashed. +### Rewards and Slashing + _Only the actors who participated in the block's confirmation are considered for rewards or slashing._ This means if Block Builder A and Block Builder B commit to a bid and the target block is built by Block Builder A, the oracle will reward or slash Block Builder A. +### Network Architechture + The architecture of the mev-commit peer-to-peer (P2P) network is designed to support instantaneous communication among network participants. The diagram below depicts how mev-commit acts as a layer on bidder and provider operations, that are external to the mev-commit network by its nature: From ed1f253c7459b469e6e4e50212b4d61a28b09767 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Sat, 22 Jun 2024 22:36:24 +0300 Subject: [PATCH 11/85] Update chain-details.mdx --- concepts/mev-commit-chain/chain-details.mdx | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/concepts/mev-commit-chain/chain-details.mdx b/concepts/mev-commit-chain/chain-details.mdx index cf840c6a..e0b6a172 100644 --- a/concepts/mev-commit-chain/chain-details.mdx +++ b/concepts/mev-commit-chain/chain-details.mdx @@ -3,15 +3,15 @@ title: "Chain Details" sidebarTitle: Chain Details --- -Mev-commit chain mainnet is set to launch soon. In the meantime, join the testnet and get familiar with its functionalities at the [Testnet](/developers/testnet) section. +The mev-commit chain mainnet is set to launch soon. In the meantime, join the testnet and get familiar with its functionalities at the [Testnet](/developers/testnet) section. -## **Design** +## Design Mev-commit chain is currently built out as an Ethereum sidechain run with [go-ethereum’s Clique proof-of-authority consensus mechanism](https://geth.ethereum.org/docs/tools/clef/clique-signing). It's not a generalized chain for everyone to launch dapps on, but only for specific execution service applications, such as preconfirmations, top of block, bottom of block, or other services. Source code for the geth fork which runs the mev-commit chain can be found in the [mev-commit-geth repo](https://github.com/primev/mev-commit-geth). -## **Progressive decentralization** +## Progressive decentralization Today, most or arguably all Ethereum scaling solutions rely on centralized bridging and sequencing. Mev-commit components rely on existing tech, and consequently inherit this property. However anyone can permissionlessly validate correct execution, and operation of chain infrastructure. Moreover, because the mev-commit p2p network is decentralized and commitments are cryptographic, actors can theoretically settle commitments without the mev-commit chain. @@ -19,17 +19,17 @@ At this point of the network's inception, Primev entities will run all validatin The mev-commit chain will continue to evolve. We have ongoing research into consensus algorithms we can employ to decentralize the mev-commit chain without compromising on speed. Open source scaling solutions that prove to be practical, decentralized, and meet security thresholds will be considered to decentralize the mev-commit chain. -## **POA geth nodes** +## POA geth nodes Primev currently maintains a mev-commit-geth bootnode which doesn’t participate in consensus, and a set of full-node POA signers that run consensus. These signers take turns proposing the next block by utilizing a waiting period. The current target block period is 200ms, meaning about 60 mev-commit chain blocks will be committed for every Ethereum mainnet block. The block time will likely change as enhancements are added and chain state grows. -## **Fee Mechanism** +## Fee Mechanism **Non-inflationary Approach**: The fee mechanism on the mev-commit chain is designed to be non-inflationary, maintaining a strict 1:1 peg between the sidechain ether and the L1 escrowed ether. This is achieved through a variation of EIP-1559, where base fees are accumulated in a treasury and priority fees are allocated to block signers. -## **Smart Contracts** +## Smart Contracts Smart Contracts are deployed on the mev-commit chain to enable use cases, follow bid and commitment states, and invoke rewards or slashing as needed. Anyone can deploy contracts on the mev-commit chain, however there'll be additional integration work needed with mev-commit off-chain components to fully enable the use case under the current design. Thus we first recommend getting in touch with the Primev team to enable a use case at this stage of the network. @@ -40,7 +40,7 @@ Currently deployed contracts are designed as follows: - An oracle contract receives L1 payloads from the oracle service. It currently operates by checking confirmed Holesky blocks, and will transition to Mainnet as mev-commit migrates to Mainnet. - An block tracker contract which designed to track Ethereum blocks and their respective winners. -## **Oracle service** +## Oracle service The oracle service is an off-chain process that interacts with the oracle contract as needed. This service monitors and extracts the winning builder and corresponding transaction hash list from each L1 block, and submits this data to the oracle contract residing on the mev-commit chain. From 09d6d7508fc3850abf71bf285072f5cd03928141 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Sat, 22 Jun 2024 22:42:22 +0300 Subject: [PATCH 12/85] Update faucet.mdx --- get-started/faucet.mdx | 3 +++ 1 file changed, 3 insertions(+) diff --git a/get-started/faucet.mdx b/get-started/faucet.mdx index 2b80be2a..12dedae6 100644 --- a/get-started/faucet.mdx +++ b/get-started/faucet.mdx @@ -3,6 +3,9 @@ title: "Testnet Faucet" sidebarTitle: Testnet Faucet icon: "faucet" --- + +This faucet is for Providers and Bidders only, Validators please visit the faucet links listed on [this](/get-started/faucet) page +

Visit our testnet [faucet page](http://faucet.testnet.mev-commit.xyz/), to easily request up to 10 ETH per request for your wallet.

To facilitate your interaction with the mev-commit Testnet, we provide a convenient method to fund your node with Ether using our dedicated faucet.

From c4b617afea6d22fcb3322b296abc775fb14a8cfd Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Sat, 22 Jun 2024 22:50:23 +0300 Subject: [PATCH 13/85] Update validators.mdx --- get-started/validators.mdx | 21 +++++---------------- 1 file changed, 5 insertions(+), 16 deletions(-) diff --git a/get-started/validators.mdx b/get-started/validators.mdx index 49d5cb7b..b411afbd 100644 --- a/get-started/validators.mdx +++ b/get-started/validators.mdx @@ -25,22 +25,11 @@ By opting-in to the mev-commit protocol as a Holesky validator, you agree to the **Supporting Relays:** - - - - - - - - - - - - - -
RelayDocs
Titan[docs.titanrelay.xyz](https://docs.titanrelay.xyz/)
- -If you are a relay looking to join mev-commit network please visit our [Relays page](/get-started/relays) to get more information. +| Relay | Docs | +| :----: | :----: | +| Titan | [docs.titanrelay.xyz](https://docs.titanrelay.xyz/) | + +If you are a relay looking to join mev-commit network please visit our [Relays page](/get-started/relays) for more information. 0.0001 ETH must be staked with the registry contract on Holesky for each validator pubkey. Below are a few options for obtaining this testnet ETH: From 2d13af829177fa0ae5a7bc1f2d81fe4e59028416 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Sat, 22 Jun 2024 22:56:01 +0300 Subject: [PATCH 14/85] Update validators.mdx --- get-started/validators.mdx | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/get-started/validators.mdx b/get-started/validators.mdx index b411afbd..9ddcb294 100644 --- a/get-started/validators.mdx +++ b/get-started/validators.mdx @@ -25,9 +25,20 @@ By opting-in to the mev-commit protocol as a Holesky validator, you agree to the **Supporting Relays:** -| Relay | Docs | -| :----: | :----: | -| Titan | [docs.titanrelay.xyz](https://docs.titanrelay.xyz/) | + + + + + + + + + + + + + +
RelayDocs
Titan[docs.titanrelay.xyz](https://docs.titanrelay.xyz/)
If you are a relay looking to join mev-commit network please visit our [Relays page](/get-started/relays) for more information. From ef400f007c284ee2dc28b325b0ea35d7aa4c6f99 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Mon, 24 Jun 2024 18:57:51 +0300 Subject: [PATCH 15/85] Update welcome-to-primev.mdx --- get-started/welcome/welcome-to-primev.mdx | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/get-started/welcome/welcome-to-primev.mdx b/get-started/welcome/welcome-to-primev.mdx index fff3927f..ad63c9ff 100644 --- a/get-started/welcome/welcome-to-primev.mdx +++ b/get-started/welcome/welcome-to-primev.mdx @@ -16,8 +16,8 @@ import { ## Get Started Welcome to the starting point of your mev-commit journey! -Our quickstart guides are tailored to your specific role within the Ethereum ecosystem and designed to get you up and running quickly. -Choose the guide below that best aligns with your interests and needs: +You can either visit our [quickstart guide](/get-started/quickstart) which is tailored to your specific role within the Ethereum ecosystem and designed to get you up and running quickly. +Or if you want to learn about specific concepts first, please visit the pages below that best align with your interests and needs: @@ -29,15 +29,14 @@ Choose the guide below that best aligns with your interests and needs: - For those looking to explore MEV opportunities, follow our Bidder Quickstart to learn how to - efficiently identify and capture valuable transactions. + Bidders seek to optimize their transaction execution strategies. Explore the resources below to efficiently identify and capture valuable transactions. • [Receive a Preconfirmation](/get-started/bidders/first-preconf) - • [Bidder Node Commands](/get-started/bidders/bidder-node-commands) + • [Node Commands](/get-started/bidders/bidder-node-commands) • [Bid Structure](/concepts/bids/bid-structure) @@ -56,8 +55,7 @@ Choose the guide below that best aligns with your interests and needs: - Providers are the backbone of the Primev ecosystem. Start with our Provider's Quick Setup to - optimize your block production and validation processes. + Providers form the backbone of the Primev ecosystem. Learn how to optimize your block production and validation processes with the resources below. From f1933a0ce3f4a4650bd1835a5b47e66e7d3a3e1e Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Mon, 24 Jun 2024 18:59:25 +0300 Subject: [PATCH 16/85] Update welcome-to-primev.mdx --- get-started/welcome/welcome-to-primev.mdx | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/get-started/welcome/welcome-to-primev.mdx b/get-started/welcome/welcome-to-primev.mdx index ad63c9ff..0a060264 100644 --- a/get-started/welcome/welcome-to-primev.mdx +++ b/get-started/welcome/welcome-to-primev.mdx @@ -15,7 +15,8 @@ import { ## Get Started -Welcome to the starting point of your mev-commit journey! +Welcome to the starting point of your mev-commit journey! +

You can either visit our [quickstart guide](/get-started/quickstart) which is tailored to your specific role within the Ethereum ecosystem and designed to get you up and running quickly. Or if you want to learn about specific concepts first, please visit the pages below that best align with your interests and needs: From 070d342a5c6a1ecba102b76e434e64b5981ae2b2 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Mon, 24 Jun 2024 19:03:43 +0300 Subject: [PATCH 17/85] Update bid-decay-mechanism.mdx --- concepts/bids/bid-decay-mechanism.mdx | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/concepts/bids/bid-decay-mechanism.mdx b/concepts/bids/bid-decay-mechanism.mdx index 91bc0022..07760e75 100644 --- a/concepts/bids/bid-decay-mechanism.mdx +++ b/concepts/bids/bid-decay-mechanism.mdx @@ -1,18 +1,18 @@ --- title: Bid Decay Mechanism sidebarTitle: Bid Decay -description: "Learn about how bids decay in value after they are issued." +description: "Learn about how bids decay in value after they are issued" --- In the mev-commit auction for transaction bundles, bidders submit their bids to providers and their goal is to receive a confirmation that the bundle they bid for will be included in the next block produced by the provider. Bidders aim to receive confirmation for their bundle as soon as possible since early confirmations tend to be more valuable to the bidders. However, providers may want to wait until the last moment to issue confirmations in order to build the most valuable block possible without missing out on any late bids. Therefore, it's essential to have a mechanism that encourages providers to confirm bids as early as possible. This is where a bid decay mechanism comes into play, which reduces the value of a bid based on the time elapsed since it was issued. -## Mechanism Description: -The timestamp is specified in Unix milliseconds. For example, a timestamp of `1633046400000` represents `October 1, 2021 00:00:00 GMT`. +## Mechanism Description +Every bid has two timestamps attached to it: **(1)** a timestamp indicating the exact time of dispatch of the bid, and **(2)** an expiry timestamp, marking the moment when the decay for this bid reaches 100%—essentially, the point in time beyond which the bidder is unwilling to pay anything to a provider for a commitment. -Every bid has two timestamps attached to it: (1) a timestamp indicating the exact time of dispatch of the bid, and (2) an expiry timestamp, marking the moment when the decay for this bid reaches 100%—essentially, the point in time beyond which the bidder is unwilling to pay anything to a provider for a commitment. +The timestamp is specified in Unix milliseconds. For example, a timestamp of `1633046400000` represents `October 1, 2021 00:00:00 GMT`. When a provider decides to commit to the bid, they must issue a commitment and also assign a "commitment timestamp" to it. This commitment is then sent to the mev-commit chain for inclusion. The mev-commit chain will include the commitment into the chain, however the commitment will only be considered valid if the commitment timestamp supplied by the provider is not "too old" in comparison to the block timestamp where the commitment was included, or more formally, their difference is within some time interval $\Delta$. @@ -42,7 +42,7 @@ In many network-based systems, including our decay mechanism, faster connections Our decay mechanism design achieves the following properties: -**1. Predictability of Decay:** the providers can *accurately compute* how much their decay will be for a commitment. +**1. Predictability of Decay:** The providers can *accurately compute* how much their decay will be for a commitment. **2. Public Verifiability of Decay**: The decay mechanism offers public verifiability, as the decay amount can be calculated using the public timestamps from the bid and the commitment. From e21286a95969a11bb86e3a9a0174dc265fecd638 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Mon, 24 Jun 2024 19:12:15 +0300 Subject: [PATCH 18/85] Update registering-a-provider.mdx --- .../providers/registering-a-provider.mdx | 37 ++++++++++++------- 1 file changed, 24 insertions(+), 13 deletions(-) diff --git a/get-started/providers/registering-a-provider.mdx b/get-started/providers/registering-a-provider.mdx index f21f0bc7..373e1226 100644 --- a/get-started/providers/registering-a-provider.mdx +++ b/get-started/providers/registering-a-provider.mdx @@ -5,13 +5,26 @@ sidebarTitle: Registering as a Provider To register on the mev-commit network, providers need to stake ETH in the provider registry contract. This adds credibility to issued commitments, as stake may be slashed in the event of a broken commitment, such as committing to a preconfirmation bid and not including the relevant transaction in a block. -Once a provider is registered on the network, other nodes will connect to it and the provider node will see bids come in. +Once a provider is registered on the network, other nodes will connect to it, and the provider node will receive bids. You can use the provider API to stake and check your stake balance. -- Stake (make sure you've [funded your account on the mev-commit chain](/get-started/faucet) first). + + + Make sure you've [funded your account on the mev-commit chain](/get-started/faucet) first. + + + Check the minimum amount that can be staked, and consider staking more than the minimum. Bidders will only connect to providers which have stake higher than this minimum. The larger a provider's stake, the greater the credibility behind that provider's commitments. The amount is set in `wei`. - ```shell + ```shell + > curl localhost:13523/v1/provider/get_min_stake | jq + { + "amount": "1000000000000000000" + } + ``` + + + ```shell > curl -X POST localhost:13523/v1/provider/register_stake/10000000000000000000 | jq { "amount": "10000000000000000000" @@ -20,6 +33,13 @@ You can use the provider API to stake and check your stake balance. Once staked, peer connection logs should appear within a few minutes. You can check the `/topology` endpoint again to verify connected peers. + + + + + +Other commands that can be used are: + - Check stake balance ```shell @@ -48,13 +68,4 @@ You can use the provider API to stake and check your stake balance. } ``` -- Check the minimum amount that can be staked, and consider staking more than the minimum. Bidders will only connect to providers which have stake higher than this minimum. The larger a provider's stake, the greater the credibility behind that provider's commitments. The amount is set in `wei`. - - ```shell - > curl localhost:13523/v1/provider/get_min_stake | jq - { - "amount": "1000000000000000000" - } - ``` - -Congrats, your provider node is registered on mev-commit and you're ready to [consume bids](/get-started/providers/consuming-bids). + Congrats! Your provider node is registered on mev-commit, and you're ready to [consume bids](/get-started/providers/consuming-bids). From 64703a1b587e1ca8c2336a3f083060d3929903a5 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Mon, 24 Jun 2024 19:12:51 +0300 Subject: [PATCH 19/85] Update welcome-to-primev.mdx --- get-started/welcome/welcome-to-primev.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/get-started/welcome/welcome-to-primev.mdx b/get-started/welcome/welcome-to-primev.mdx index 0a060264..54e27df4 100644 --- a/get-started/welcome/welcome-to-primev.mdx +++ b/get-started/welcome/welcome-to-primev.mdx @@ -15,7 +15,7 @@ import { ## Get Started -Welcome to the starting point of your mev-commit journey! +Welcome to the starting point of your mev-commit journey!

You can either visit our [quickstart guide](/get-started/quickstart) which is tailored to your specific role within the Ethereum ecosystem and designed to get you up and running quickly. Or if you want to learn about specific concepts first, please visit the pages below that best align with your interests and needs: From da03fb490b618bb645b962f9e941498ff652b7dc Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Mon, 24 Jun 2024 19:15:02 +0300 Subject: [PATCH 20/85] Update welcome-to-primev.mdx --- get-started/welcome/welcome-to-primev.mdx | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/get-started/welcome/welcome-to-primev.mdx b/get-started/welcome/welcome-to-primev.mdx index 54e27df4..9255aa89 100644 --- a/get-started/welcome/welcome-to-primev.mdx +++ b/get-started/welcome/welcome-to-primev.mdx @@ -15,8 +15,7 @@ import { ## Get Started -Welcome to the starting point of your mev-commit journey! -

+Welcome to the starting point of your mev-commit journey! You can either visit our [quickstart guide](/get-started/quickstart) which is tailored to your specific role within the Ethereum ecosystem and designed to get you up and running quickly. Or if you want to learn about specific concepts first, please visit the pages below that best align with your interests and needs: From 19752488dec3585037df032e59196f56f98c6819 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Mon, 24 Jun 2024 19:15:31 +0300 Subject: [PATCH 21/85] Update welcome-to-primev.mdx --- get-started/welcome/welcome-to-primev.mdx | 1 + 1 file changed, 1 insertion(+) diff --git a/get-started/welcome/welcome-to-primev.mdx b/get-started/welcome/welcome-to-primev.mdx index 9255aa89..86f46220 100644 --- a/get-started/welcome/welcome-to-primev.mdx +++ b/get-started/welcome/welcome-to-primev.mdx @@ -16,6 +16,7 @@ import { ## Get Started Welcome to the starting point of your mev-commit journey! + You can either visit our [quickstart guide](/get-started/quickstart) which is tailored to your specific role within the Ethereum ecosystem and designed to get you up and running quickly. Or if you want to learn about specific concepts first, please visit the pages below that best align with your interests and needs: From dda2754ffb14d3a5634555e1af5693c86f7d741b Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Mon, 24 Jun 2024 19:24:37 +0300 Subject: [PATCH 22/85] Update quickstart.mdx --- get-started/quickstart.mdx | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/get-started/quickstart.mdx b/get-started/quickstart.mdx index 149dbc2f..30c77647 100644 --- a/get-started/quickstart.mdx +++ b/get-started/quickstart.mdx @@ -5,9 +5,7 @@ sidebarTitle: Quickstart icon: "gear" --- -# Quickstart - -Ready to get your node up and running? This streamlined process will guide you through launching either a bidder or provider node on the mev-commit network. +Ready to get your node up and running? The codes below are all you need to launch either a bidder or provider node on the mev-commit network. @@ -21,11 +19,11 @@ Ready to get your node up and running? This streamlined process will guide you t - To fund your account, please visit http://faucet.testnet.mev-commit.xyz/. Details about the account address will be displayed after running the commands below. + To fund your account, please visit http://faucet.testnet.mev-commit.xyz/. Details about the account address will be displayed after running the commands above.

- + ## Script Overview From 9176dc770a3bc6ed1f32df3186b8d811632e0f70 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Mon, 24 Jun 2024 19:25:26 +0300 Subject: [PATCH 23/85] Update faucet.mdx --- get-started/faucet.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/get-started/faucet.mdx b/get-started/faucet.mdx index 12dedae6..a16908b6 100644 --- a/get-started/faucet.mdx +++ b/get-started/faucet.mdx @@ -4,7 +4,7 @@ sidebarTitle: Testnet Faucet icon: "faucet" --- -This faucet is for Providers and Bidders only, Validators please visit the faucet links listed on [this](/get-started/faucet) page +This faucet is for Providers and Bidders only, Validators please visit the faucet links listed on [this](/get-started/validators) page

Visit our testnet [faucet page](http://faucet.testnet.mev-commit.xyz/), to easily request up to 10 ETH per request for your wallet.

From 8caa175f48350df91c73da74105db794910cd462 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Mon, 24 Jun 2024 19:27:34 +0300 Subject: [PATCH 24/85] Update relays.mdx --- get-started/relays.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/get-started/relays.mdx b/get-started/relays.mdx index 6139385e..b266c613 100644 --- a/get-started/relays.mdx +++ b/get-started/relays.mdx @@ -13,7 +13,7 @@ Opting into mev-commit as a relay means that you sign up to deliver mev-boost bi -Information about the providers (entities like builders who commit on our network) is stored in our provider registry. You can interact with the registry at the contract address at {ProviderRegistryAddress}. +Information about the providers (entities like builders who commit on our network) is stored in our provider registry. You can interact with the registry at the contract address at '{ProviderRegistryAddress}'. You can retrieve all connected providers using the following script: From b73cd01729c04fb448f24dc55b98d7e2e156dc25 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Mon, 24 Jun 2024 19:28:45 +0300 Subject: [PATCH 25/85] Update relays.mdx --- get-started/relays.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/get-started/relays.mdx b/get-started/relays.mdx index b266c613..0e629fb2 100644 --- a/get-started/relays.mdx +++ b/get-started/relays.mdx @@ -13,7 +13,7 @@ Opting into mev-commit as a relay means that you sign up to deliver mev-boost bi -Information about the providers (entities like builders who commit on our network) is stored in our provider registry. You can interact with the registry at the contract address at '{ProviderRegistryAddress}'. +Information about the providers (entities like builders who commit on our network) is stored in our provider registry. You can interact with the registry at the contract address at `{ProviderRegistryAddress}`. You can retrieve all connected providers using the following script: From 4d51f188b280b356cdb119b741ed6853d87af821 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Mon, 24 Jun 2024 19:29:08 +0300 Subject: [PATCH 26/85] Update relays.mdx --- get-started/relays.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/get-started/relays.mdx b/get-started/relays.mdx index 0e629fb2..6139385e 100644 --- a/get-started/relays.mdx +++ b/get-started/relays.mdx @@ -13,7 +13,7 @@ Opting into mev-commit as a relay means that you sign up to deliver mev-boost bi -Information about the providers (entities like builders who commit on our network) is stored in our provider registry. You can interact with the registry at the contract address at `{ProviderRegistryAddress}`. +Information about the providers (entities like builders who commit on our network) is stored in our provider registry. You can interact with the registry at the contract address at {ProviderRegistryAddress}. You can retrieve all connected providers using the following script: From 387336644422d8fdbce8ba68b89a390fbf615219 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Mon, 24 Jun 2024 19:37:11 +0300 Subject: [PATCH 27/85] Update first-preconf.mdx --- get-started/bidders/first-preconf.mdx | 30 +++++++++++++-------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/get-started/bidders/first-preconf.mdx b/get-started/bidders/first-preconf.mdx index 277c5a88..95f876ae 100644 --- a/get-started/bidders/first-preconf.mdx +++ b/get-started/bidders/first-preconf.mdx @@ -16,15 +16,15 @@ Once you've funded your bidder node wallet, you're ready to start submitting bid It's crucial to verify that your bidder node is connected to at least one provider node. This connectivity can be confirmed via the [localhost:13523/topology](http://localhost:13523/topology) endpoint. -### 💳 Deposit For Bids - -Run this command to load your account with funds to start bidding: + + + Run this command to load your account with funds to start bidding: ```shell ❯_ terminal curl -X POST http://localhost:13523/v1/bidder/deposit/1000000000000000000 ``` -This tops up your account with `1000000000000000000 wei` (1 ETH) for the current [window](https://docs.primev.xyz/concepts/bidder-deposit), ensuring you're all set to send bids! +This tops up your account with `1000000000000000000 wei` (1 ETH) for the current [window](/concepts/bids/bidder-deposit), ensuring you're all set to send bids! The window is the number of L1 blocks in the round for which the bidder can post bids. If you want to deposit funds for a specific L1 block number, which will be automatically converted to the corresponding window, use the following command: @@ -32,10 +32,9 @@ If you want to deposit funds for a specific L1 block number, which will be autom ```shell ❯_ terminal curl -X POST "http://localhost:13523/v1/bidder/deposit/1000000000000000000?block_number=" ``` - -### Sending Bids - -Open a new terminal window. To send bids, we simply run the following command: + + + Open a new terminal window. To send bids, we simply run the following command: ```shell ❯_ example curl -X POST http://localhost:13523/v1/bidder/bid \ @@ -47,6 +46,8 @@ curl -X POST http://localhost:13523/v1/bidder/bid \ "decayEndTimestamp": }' ``` + +Make sure your bid amount is sufficiently high for the commitment you're requesting, and your target L1 block number is accurate. It's up to the providers to commit to your bid, so try to ensure a commitment is feasible to your bid by its construction. | Key | Description | @@ -57,7 +58,7 @@ curl -X POST http://localhost:13523/v1/bidder/bid \ | `decayStartTimestamp` | Start timestamp for bid decay (in Unix milliseconds) | | `decayEndTimestamp` | End timestamp for bid decay (in Unix milliseconds) | - If you want to learn more about Bids and Bid Structure visit [Bids](/concepts/bids) section. + If you want to learn more about Bids and Bid Structure visit [Bid Structure](/concepts/bids/bid-structure) section. To include bundles of transactions, add them in the atomic sequence in which they exist in the bundle, as follows: @@ -71,10 +72,9 @@ curl -X POST http://localhost:13523/v1/bidder/bid \ "decayStartTimestamp": , "decayEndTimestamp": }' -``` - -💡You can change the values in the fields txHashes, amount, blockNumber, decayStartTimestamp and decayEndTimestamp as desired. - -🎉 Congrats, you just sent your first L1 preconfirmation bid! You should be receiving commmitments near instantly. +``` +You can change the values in the fields txHashes, amount, blockNumber, decayStartTimestamp and decayEndTimestamp as desired. + + -Make sure your bid amount is sufficiently high for the commitment you're requesting, and your target L1 block number is accurate. It's up to the providers to commit to your bid, so try to ensure a commitment is feasible to your bid by its construction. +🎉 Congrats, you just sent your first L1 preconfirmation bid! You should be receiving commitments nearly instantly. From 6e738a6b10b922964b982c16bef86d63d340c5f0 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Mon, 24 Jun 2024 19:39:07 +0300 Subject: [PATCH 28/85] Update bidder-node-commands.mdx --- get-started/bidders/bidder-node-commands.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/get-started/bidders/bidder-node-commands.mdx b/get-started/bidders/bidder-node-commands.mdx index 9740ed02..3aa20277 100644 --- a/get-started/bidders/bidder-node-commands.mdx +++ b/get-started/bidders/bidder-node-commands.mdx @@ -17,13 +17,13 @@ export ADDRESS=$(cast wallet address --private-key 0x$(cat key)) ## Getting Deposit -To get the current deposit balance in the contract for the current [window](https://docs.primev.xyz/concepts/bidder-deposit): +To get the current deposit balance in the contract for the current [window](/concepts/bids/bidder-deposit): ```shell ❯_ terminal curl -s http://localhost:13523/v1/bidder/get_deposit ``` -To get the current deposit balance in the contract for a specific [window](https://docs.primev.xyz/concepts/bidder-deposit): +To get the current deposit balance in the contract for a specific [window](/concepts/bids/bidder-deposit): ```shell ❯_ terminal curl -s http://localhost:13523/v1/bidder/get_deposit?windowNumber=1 @@ -33,7 +33,7 @@ curl -s http://localhost:13523/v1/bidder/get_deposit?windowNumber=1 ## Withdraw Deposited Funds -This command will allow you to withdraw funds from the specific [window](https://docs.primev.xyz/concepts/bidder-deposit). +This command will allow you to withdraw funds from the specific [window](/concepts/bids/bidder-deposit). Window number is the number where the bidder deposited funds. ```shell ❯_ terminal From 5fea214158eeb129a4758b1261fe309e4f48d30d Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Tue, 25 Jun 2024 14:39:02 +0300 Subject: [PATCH 29/85] Update quickstart.mdx --- get-started/quickstart.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/get-started/quickstart.mdx b/get-started/quickstart.mdx index 30c77647..838eb8f9 100644 --- a/get-started/quickstart.mdx +++ b/get-started/quickstart.mdx @@ -23,7 +23,7 @@ Ready to get your node up and running? The codes below are all you need to launc

- + ## Script Overview From 5acd3151651204282b6e872a391b910cb2307372 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Tue, 25 Jun 2024 15:50:25 +0300 Subject: [PATCH 30/85] Rename get-started/welcome/what-is-mev-commit.mdx to concepts/what-is-mev-commit.mdx --- {get-started/welcome => concepts}/what-is-mev-commit.mdx | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename {get-started/welcome => concepts}/what-is-mev-commit.mdx (100%) diff --git a/get-started/welcome/what-is-mev-commit.mdx b/concepts/what-is-mev-commit.mdx similarity index 100% rename from get-started/welcome/what-is-mev-commit.mdx rename to concepts/what-is-mev-commit.mdx From f5d40611deb11c1d8311c883a689bc30a8982fa4 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Tue, 25 Jun 2024 16:02:25 +0300 Subject: [PATCH 31/85] Update and rename get-started/welcome/welcome-to-primev.mdx to get-started/welcome-to-primev.mdx --- get-started/{welcome => }/welcome-to-primev.mdx | 3 --- 1 file changed, 3 deletions(-) rename get-started/{welcome => }/welcome-to-primev.mdx (98%) diff --git a/get-started/welcome/welcome-to-primev.mdx b/get-started/welcome-to-primev.mdx similarity index 98% rename from get-started/welcome/welcome-to-primev.mdx rename to get-started/welcome-to-primev.mdx index 86f46220..6981e230 100644 --- a/get-started/welcome/welcome-to-primev.mdx +++ b/get-started/welcome-to-primev.mdx @@ -13,8 +13,6 @@ import { QuickStartCardFooter, } from "/snippets/quick-start-card.mdx"; -## Get Started - Welcome to the starting point of your mev-commit journey! You can either visit our [quickstart guide](/get-started/quickstart) which is tailored to your specific role within the Ethereum ecosystem and designed to get you up and running quickly. @@ -91,7 +89,6 @@ Or if you want to learn about specific concepts first, please visit the pages be • [Validator Considerations](/concepts/validator-considerations) - • [mev-commit Testnet](/developers/testnet) From a217d1c3004ac09dd4e70b4808b3a9a7d7d5b7d3 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Tue, 25 Jun 2024 16:43:57 +0300 Subject: [PATCH 32/85] Update quickstart.mdx --- get-started/quickstart.mdx | 95 +++++++++++++++++++++++++------------- 1 file changed, 62 insertions(+), 33 deletions(-) diff --git a/get-started/quickstart.mdx b/get-started/quickstart.mdx index 838eb8f9..548c73c4 100644 --- a/get-started/quickstart.mdx +++ b/get-started/quickstart.mdx @@ -3,26 +3,65 @@ title: "Quickstart Your mev-commit Node" description: "Step into the Primev ecosystem with ease. This guide covers everything you need to set up your mev-commit node, whether you're aiming to be a bidder or a provider." sidebarTitle: Quickstart icon: "gear" +mode: "wide" --- -Ready to get your node up and running? The codes below are all you need to launch either a bidder or provider node on the mev-commit network. - - - - ```bash ❯_ bidder + + +Make sure to check [System Requirements](/developers/system-requirements) to better understand what is needed to run mev-commit without any interruptions. + + + ```bash ❯_ bidder curl -L -o launchmevcommit launch.mev-commit.xyz; chmod +x launchmevcommit; ./launchmevcommit --node-type bidder ``` + + + ## Script Overview + + This script automates the setup and initialization of your Primev node, catering to both bidder and provider roles. Below is a detailed breakdown of the script's operations: + + ### 1. Initialization + - Sets up essential variables like the RPC URL (`https://chainrpc.testnet.mev-commit.xyz) for network communication and the node type (either `bidder` or `provider`). + - Establishes the root directory (`$HOME/.mev-commit`) where the mev-commit node will be installed. + + ### 2. Download + - Fetches the appropriate mev-commit binary for your system from the [Primev GitHub releases page](https://github.com/primev/mev-commit/releases/latest), considering your operating system and architecture. + + ### 3. Installation + - Extracts the downloaded binary into the specified root directory, ensuring all necessary executables are correctly placed for the node's operation. + ### 4. Configuration + - Initializes the mev-commit node with your specified settings, including the node type and the RPC endpoint, along with necessary contract addresses for the node's functionality. + + ### 5. Wallet Setup + - Generates a new private key and wallet address for your node and secures it with test ether to facilitate transactions within the testnet environment. + + ### 6. Node Startup + - Launches the mev-commit node in the background tailored to the specified role, enabling it to begin its operations within the Primev network. + + ### 7. Cleanup + - Includes a cleanup function to ensure the node is properly shut down when the script exits, preventing any residual processes. + + + + + + To fund your account, please visit our [Testnet Faucet](/get-started/faucet). Details about the account address will be displayed after running the command above. + + + Visit [My First Preconf](/get-started/bidders/first-preconf) page to submit bids on the network and start receiving preconfirmations. +If you want to perform a manual setup with detailed steps, please skip to the [manual start mev-commit](/developers/manual-start-mev-commit) section. + + + + + + Make sure to check [System Requirements](/developers/system-requirements) to better understand what is needed to run mev-commit without any interruptions. + + ```bash ❯_ provider curl -L -o launchmevcommit launch.mev-commit.xyz; chmod +x launchmevcommit; ./launchmevcommit --node-type provider ``` - - - - To fund your account, please visit http://faucet.testnet.mev-commit.xyz/. Details about the account address will be displayed after running the commands above. - -

- ## Script Overview @@ -53,24 +92,14 @@ Ready to get your node up and running? The codes below are all you need to launc -If you want to perform a manual setup with detailed steps, please skip to the [manual start mev-commit](/developers/manual-start-mev-commit) section. - -# What's next? - - -
- -
-
- Once your node is funded, you can move on to [My First Preconf](/get-started/bidders/first-preconf) to start sending bids. - -
-
- -
-
- In order to register as a provider, please go through the [registration - process](/get-started/providers/registering-a-provider). - -
- + + + To fund your account, please visit our [Testnet Faucet](/get-started/faucet). Details about the account address will be displayed after running the command above. + + + Visit [Register as a Provider](/get-started/providers/registering-a-provider) page to register yourself as a provider on mev-commit network and follow the steps to start sending commitments. +If you want to perform a manual setup with detailed steps, please skip to the [manual start mev-commit](/developers/manual-start-mev-commit) section. + + + + From abc2f240a607f8cf44a6a44da90e7c0701a7e943 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Tue, 25 Jun 2024 16:46:07 +0300 Subject: [PATCH 33/85] Update mint.json --- mint.json | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/mint.json b/mint.json index 4334ab09..32acda0e 100644 --- a/mint.json +++ b/mint.json @@ -31,13 +31,7 @@ "group": "Get Started", "pages": [ { - "group": "Welcome", - "pages": [ - "get-started/welcome/welcome-to-primev", - "get-started/welcome/what-is-mev-commit" - ], - "icon": "sailboat" - }, + "get-started/welcome-to-primev", "get-started/quickstart", "get-started/faucet", "get-started/validators", From 6b131935012e2531431bd084c0add3636165a27b Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Tue, 25 Jun 2024 16:49:36 +0300 Subject: [PATCH 34/85] Update first-preconf.mdx --- get-started/bidders/first-preconf.mdx | 11 +---------- 1 file changed, 1 insertion(+), 10 deletions(-) diff --git a/get-started/bidders/first-preconf.mdx b/get-started/bidders/first-preconf.mdx index 95f876ae..88021220 100644 --- a/get-started/bidders/first-preconf.mdx +++ b/get-started/bidders/first-preconf.mdx @@ -3,15 +3,6 @@ title: "Receive your First Preconfirmation" sidebarTitle: "My First Preconf" --- -## Pre-requisites - -Make sure you: - -1. Get a [mev-commit Bidder Node up and running](/get-started/quickstart). -2. [Fund your node](/get-started/faucet) so you have the funds to submit bids. - -## Introduction - Once you've funded your bidder node wallet, you're ready to start submitting bids to the network. It's crucial to verify that your bidder node is connected to at least one provider node. This connectivity can be confirmed via the [localhost:13523/topology](http://localhost:13523/topology) endpoint. @@ -77,4 +68,4 @@ curl -X POST http://localhost:13523/v1/bidder/bid \ -🎉 Congrats, you just sent your first L1 preconfirmation bid! You should be receiving commitments nearly instantly. +Congrats, you just sent your first L1 preconfirmation bid! You should be receiving commitments nearly instantly. From 589b249b0fae96e2dbab0598d8184f19589fb8f6 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Tue, 25 Jun 2024 16:50:12 +0300 Subject: [PATCH 35/85] Update first-preconf.mdx --- get-started/bidders/first-preconf.mdx | 1 + 1 file changed, 1 insertion(+) diff --git a/get-started/bidders/first-preconf.mdx b/get-started/bidders/first-preconf.mdx index 88021220..e0d0fc11 100644 --- a/get-started/bidders/first-preconf.mdx +++ b/get-started/bidders/first-preconf.mdx @@ -1,6 +1,7 @@ --- title: "Receive your First Preconfirmation" sidebarTitle: "My First Preconf" +icon: "circle-1" --- Once you've funded your bidder node wallet, you're ready to start submitting bids to the network. From 77e7c3bda530e484ad0b9cacfc9c91dc378603cc Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Tue, 25 Jun 2024 16:55:13 +0300 Subject: [PATCH 36/85] Update bidder-node-commands.mdx --- get-started/bidders/bidder-node-commands.mdx | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/get-started/bidders/bidder-node-commands.mdx b/get-started/bidders/bidder-node-commands.mdx index 3aa20277..695d6cab 100644 --- a/get-started/bidders/bidder-node-commands.mdx +++ b/get-started/bidders/bidder-node-commands.mdx @@ -1,6 +1,7 @@ --- title: "Bidder Node Commands" sidebarTitle: Bidder Node Commands +icon: "circle-2" --- ## Interacting with the Bidder Node @@ -29,7 +30,7 @@ To get the current deposit balance in the contract for a specific [window](/conc curl -s http://localhost:13523/v1/bidder/get_deposit?windowNumber=1 ``` -💡Deposit represents the funds in the bidder's account that can be used to submit bids on the mev-commit p2p-network and settled on-chain. +Deposit represents the funds in the bidder's account that can be used to submit bids on the mev-commit p2p-network and settled on-chain. ## Withdraw Deposited Funds From 3a8c22f0c97dd0e52aa7390ab6b4fd39ca6738e7 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Tue, 25 Jun 2024 16:58:50 +0300 Subject: [PATCH 37/85] Update mint.json --- mint.json | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/mint.json b/mint.json index 32acda0e..b0d9ef15 100644 --- a/mint.json +++ b/mint.json @@ -15,7 +15,6 @@ "to": "#E97D25" } }, - "tabs": [ { "name": "API Reference", @@ -30,7 +29,6 @@ { "group": "Get Started", "pages": [ - { "get-started/welcome-to-primev", "get-started/quickstart", "get-started/faucet", @@ -64,7 +62,7 @@ "concepts/network-overview", "concepts/privacy", "concepts/commitments", - { + { "group": "Bids", "pages": [ "concepts/bids/bid-structure", @@ -92,9 +90,9 @@ "developers/system-requirements", "developers/provider-api", "developers/bidder-api", - "developers/bidder-deposit", - "developers/tools-for-bid-submission", - "developers/stake-validator-keys-manually", + "developers/bidder-deposit", + "developers/tools-for-bid-submission", + "developers/stake-validator-keys-manually", "developers/contracts", "developers/debugging", "developers/manual-start-mev-commit", From 9aa3c235262fe2f9b4035fdaaaed6a2c9f3512b0 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Tue, 25 Jun 2024 17:02:18 +0300 Subject: [PATCH 38/85] Update welcome-to-primev.mdx --- get-started/welcome-to-primev.mdx | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/get-started/welcome-to-primev.mdx b/get-started/welcome-to-primev.mdx index 6981e230..97304e8e 100644 --- a/get-started/welcome-to-primev.mdx +++ b/get-started/welcome-to-primev.mdx @@ -2,7 +2,8 @@ title: Welcome to Primev sidebarTitle: Welcome to Primev description: "Primev is building mev-commit; a credible commitment network used for preconfirmations & more" -mode: wide +mode: "wide" +icon: "sailboat" --- import { From e159fec9736003bda5ec0b77717640d13ee59865 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Tue, 25 Jun 2024 17:16:13 +0300 Subject: [PATCH 39/85] Update validators.mdx --- get-started/validators.mdx | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/get-started/validators.mdx b/get-started/validators.mdx index 9ddcb294..d350e5e2 100644 --- a/get-started/validators.mdx +++ b/get-started/validators.mdx @@ -25,19 +25,19 @@ By opting-in to the mev-commit protocol as a Holesky validator, you agree to the **Supporting Relays:** - - - - - - - - - - - - - +
RelayDocs
Titan[docs.titanrelay.xyz](https://docs.titanrelay.xyz/)
+ + + + + + + + + + + +
RelayDocs
Titan[docs.titanrelay.xyz](https://docs.titanrelay.xyz/)
If you are a relay looking to join mev-commit network please visit our [Relays page](/get-started/relays) for more information. From af430b6d6cc205419f52819f8b89850accc7e7c1 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Tue, 25 Jun 2024 17:17:47 +0300 Subject: [PATCH 40/85] Update validators.mdx --- get-started/validators.mdx | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/get-started/validators.mdx b/get-started/validators.mdx index d350e5e2..627e5e7c 100644 --- a/get-started/validators.mdx +++ b/get-started/validators.mdx @@ -28,18 +28,21 @@ By opting-in to the mev-commit protocol as a Holesky validator, you agree to the - - + + - - + +
RelayDocsRelayDocs
Titan[docs.titanrelay.xyz](https://docs.titanrelay.xyz/)Titan + docs.titanrelay.xyz +
+ If you are a relay looking to join mev-commit network please visit our [Relays page](/get-started/relays) for more information. 0.0001 ETH must be staked with the registry contract on Holesky for each validator pubkey. Below are a few options for obtaining this testnet ETH: From 50e17a5104f0088dd039aa9a2ed2fc03a0346d4f Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Tue, 25 Jun 2024 19:35:08 +0300 Subject: [PATCH 41/85] Update first-preconf.mdx --- get-started/bidders/first-preconf.mdx | 1 - 1 file changed, 1 deletion(-) diff --git a/get-started/bidders/first-preconf.mdx b/get-started/bidders/first-preconf.mdx index e0d0fc11..88021220 100644 --- a/get-started/bidders/first-preconf.mdx +++ b/get-started/bidders/first-preconf.mdx @@ -1,7 +1,6 @@ --- title: "Receive your First Preconfirmation" sidebarTitle: "My First Preconf" -icon: "circle-1" --- Once you've funded your bidder node wallet, you're ready to start submitting bids to the network. From 37ae2c5e7ab5482a1090181c62b55bf7d0a0d53f Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Tue, 25 Jun 2024 19:35:20 +0300 Subject: [PATCH 42/85] Update bidder-node-commands.mdx --- get-started/bidders/bidder-node-commands.mdx | 1 - 1 file changed, 1 deletion(-) diff --git a/get-started/bidders/bidder-node-commands.mdx b/get-started/bidders/bidder-node-commands.mdx index 695d6cab..c90a1324 100644 --- a/get-started/bidders/bidder-node-commands.mdx +++ b/get-started/bidders/bidder-node-commands.mdx @@ -1,7 +1,6 @@ --- title: "Bidder Node Commands" sidebarTitle: Bidder Node Commands -icon: "circle-2" --- ## Interacting with the Bidder Node From 92addc249937b1cf832081ff006e975d7d22e100 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Tue, 25 Jun 2024 19:39:46 +0300 Subject: [PATCH 43/85] Update welcome-to-primev.mdx --- get-started/welcome-to-primev.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/get-started/welcome-to-primev.mdx b/get-started/welcome-to-primev.mdx index 97304e8e..a7d54653 100644 --- a/get-started/welcome-to-primev.mdx +++ b/get-started/welcome-to-primev.mdx @@ -2,7 +2,7 @@ title: Welcome to Primev sidebarTitle: Welcome to Primev description: "Primev is building mev-commit; a credible commitment network used for preconfirmations & more" -mode: "wide" +mode: "custom" icon: "sailboat" --- From 62b4badbb638a9a79cc95cc2d242bb7ffc2da18e Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Tue, 25 Jun 2024 19:42:46 +0300 Subject: [PATCH 44/85] Update welcome-to-primev.mdx --- get-started/welcome-to-primev.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/get-started/welcome-to-primev.mdx b/get-started/welcome-to-primev.mdx index a7d54653..97304e8e 100644 --- a/get-started/welcome-to-primev.mdx +++ b/get-started/welcome-to-primev.mdx @@ -2,7 +2,7 @@ title: Welcome to Primev sidebarTitle: Welcome to Primev description: "Primev is building mev-commit; a credible commitment network used for preconfirmations & more" -mode: "custom" +mode: "wide" icon: "sailboat" --- From b8bc8c77d7efbd3fd2a6ee8623fb6c366e77fdef Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Tue, 25 Jun 2024 19:50:14 +0300 Subject: [PATCH 45/85] Create quickstart --- get-started/quickstart | 1 + 1 file changed, 1 insertion(+) create mode 100644 get-started/quickstart diff --git a/get-started/quickstart b/get-started/quickstart new file mode 100644 index 00000000..8b137891 --- /dev/null +++ b/get-started/quickstart @@ -0,0 +1 @@ + From 3d7322f75271a2ea3a6936b6dc2f1d0647a1ab5a Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Tue, 25 Jun 2024 19:50:35 +0300 Subject: [PATCH 46/85] Delete get-started/quickstart --- get-started/quickstart | 1 - 1 file changed, 1 deletion(-) delete mode 100644 get-started/quickstart diff --git a/get-started/quickstart b/get-started/quickstart deleted file mode 100644 index 8b137891..00000000 --- a/get-started/quickstart +++ /dev/null @@ -1 +0,0 @@ - From e9f15b0a07b18b2951b118431611ea92627fe959 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Tue, 25 Jun 2024 19:51:40 +0300 Subject: [PATCH 47/85] Rename get-started/bidders/bidder-node-commands.mdx to get-started/quickstart/bidders/bidder-node-commands.mdx --- get-started/{ => quickstart}/bidders/bidder-node-commands.mdx | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename get-started/{ => quickstart}/bidders/bidder-node-commands.mdx (100%) diff --git a/get-started/bidders/bidder-node-commands.mdx b/get-started/quickstart/bidders/bidder-node-commands.mdx similarity index 100% rename from get-started/bidders/bidder-node-commands.mdx rename to get-started/quickstart/bidders/bidder-node-commands.mdx From 062f6a0573d751cb2ee2f4f00ec47108d9c386e3 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Tue, 25 Jun 2024 19:52:17 +0300 Subject: [PATCH 48/85] Rename get-started/bidders/bidder-overview.mdx to get-started/quickstart/bidders/bidder-overview.mdx --- get-started/{ => quickstart}/bidders/bidder-overview.mdx | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename get-started/{ => quickstart}/bidders/bidder-overview.mdx (100%) diff --git a/get-started/bidders/bidder-overview.mdx b/get-started/quickstart/bidders/bidder-overview.mdx similarity index 100% rename from get-started/bidders/bidder-overview.mdx rename to get-started/quickstart/bidders/bidder-overview.mdx From 3d6aba2cd14e96fb4eedf55951fa85e5176a847a Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Tue, 25 Jun 2024 19:53:06 +0300 Subject: [PATCH 49/85] Rename first-preconf.mdx to first-preconf.mdx --- {get-started => quickstart}/bidders/first-preconf.mdx | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename {get-started => quickstart}/bidders/first-preconf.mdx (100%) diff --git a/get-started/bidders/first-preconf.mdx b/quickstart/bidders/first-preconf.mdx similarity index 100% rename from get-started/bidders/first-preconf.mdx rename to quickstart/bidders/first-preconf.mdx From ee9b2426d148d22c61433a9c21f70265aa60c990 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Tue, 25 Jun 2024 20:33:54 +0300 Subject: [PATCH 50/85] fix --- .../quickstart => quickstart}/bidders/bidder-node-commands.mdx | 0 .../quickstart => quickstart}/bidders/bidder-overview.mdx | 0 {get-started => quickstart}/faucet.mdx | 0 {get-started => quickstart}/providers/Querying-for-proposers.mdx | 0 {get-started => quickstart}/providers/consuming-bids.mdx | 0 {get-started => quickstart}/providers/registering-a-provider.mdx | 0 {get-started => quickstart}/providers/sending-commitments.mdx | 0 {get-started => quickstart}/quickstart.mdx | 0 {get-started => quickstart}/relays.mdx | 0 {get-started => quickstart}/validators.mdx | 0 10 files changed, 0 insertions(+), 0 deletions(-) rename {get-started/quickstart => quickstart}/bidders/bidder-node-commands.mdx (100%) rename {get-started/quickstart => quickstart}/bidders/bidder-overview.mdx (100%) rename {get-started => quickstart}/faucet.mdx (100%) rename {get-started => quickstart}/providers/Querying-for-proposers.mdx (100%) rename {get-started => quickstart}/providers/consuming-bids.mdx (100%) rename {get-started => quickstart}/providers/registering-a-provider.mdx (100%) rename {get-started => quickstart}/providers/sending-commitments.mdx (100%) rename {get-started => quickstart}/quickstart.mdx (100%) rename {get-started => quickstart}/relays.mdx (100%) rename {get-started => quickstart}/validators.mdx (100%) diff --git a/get-started/quickstart/bidders/bidder-node-commands.mdx b/quickstart/bidders/bidder-node-commands.mdx similarity index 100% rename from get-started/quickstart/bidders/bidder-node-commands.mdx rename to quickstart/bidders/bidder-node-commands.mdx diff --git a/get-started/quickstart/bidders/bidder-overview.mdx b/quickstart/bidders/bidder-overview.mdx similarity index 100% rename from get-started/quickstart/bidders/bidder-overview.mdx rename to quickstart/bidders/bidder-overview.mdx diff --git a/get-started/faucet.mdx b/quickstart/faucet.mdx similarity index 100% rename from get-started/faucet.mdx rename to quickstart/faucet.mdx diff --git a/get-started/providers/Querying-for-proposers.mdx b/quickstart/providers/Querying-for-proposers.mdx similarity index 100% rename from get-started/providers/Querying-for-proposers.mdx rename to quickstart/providers/Querying-for-proposers.mdx diff --git a/get-started/providers/consuming-bids.mdx b/quickstart/providers/consuming-bids.mdx similarity index 100% rename from get-started/providers/consuming-bids.mdx rename to quickstart/providers/consuming-bids.mdx diff --git a/get-started/providers/registering-a-provider.mdx b/quickstart/providers/registering-a-provider.mdx similarity index 100% rename from get-started/providers/registering-a-provider.mdx rename to quickstart/providers/registering-a-provider.mdx diff --git a/get-started/providers/sending-commitments.mdx b/quickstart/providers/sending-commitments.mdx similarity index 100% rename from get-started/providers/sending-commitments.mdx rename to quickstart/providers/sending-commitments.mdx diff --git a/get-started/quickstart.mdx b/quickstart/quickstart.mdx similarity index 100% rename from get-started/quickstart.mdx rename to quickstart/quickstart.mdx diff --git a/get-started/relays.mdx b/quickstart/relays.mdx similarity index 100% rename from get-started/relays.mdx rename to quickstart/relays.mdx diff --git a/get-started/validators.mdx b/quickstart/validators.mdx similarity index 100% rename from get-started/validators.mdx rename to quickstart/validators.mdx From 9024e7a48c1fc915e73394ece6e0169ae78ac727 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Tue, 25 Jun 2024 20:47:34 +0300 Subject: [PATCH 51/85] Rename quickstart.mdx to set-up-mev-commit-node.mdx --- quickstart/{quickstart.mdx => set-up-mev-commit-node.mdx} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename quickstart/{quickstart.mdx => set-up-mev-commit-node.mdx} (100%) diff --git a/quickstart/quickstart.mdx b/quickstart/set-up-mev-commit-node.mdx similarity index 100% rename from quickstart/quickstart.mdx rename to quickstart/set-up-mev-commit-node.mdx From 13023670ff937bd8443cd29658cee74d472b2dec Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Tue, 25 Jun 2024 20:50:55 +0300 Subject: [PATCH 52/85] Update mint.json --- mint.json | 27 ++++++++++++++++----------- 1 file changed, 16 insertions(+), 11 deletions(-) diff --git a/mint.json b/mint.json index b0d9ef15..bfbd9d18 100644 --- a/mint.json +++ b/mint.json @@ -29,26 +29,31 @@ { "group": "Get Started", "pages": [ - "get-started/welcome-to-primev", - "get-started/quickstart", - "get-started/faucet", - "get-started/validators", - "get-started/relays", + "get-started/welcome-to-primev" + ] + }, + { + "group": "Quickstart", + "pages": [ + "quickstart/Set-up-mev-commit-node", + "quickstart/faucet", + "quickstart/validators", + "quickstart/relays", { "group": "Bidders", "pages": [ - "get-started/bidders/first-preconf", - "get-started/bidders/bidder-node-commands" + "quickstart/bidders/first-preconf", + "quickstart/bidders/bidder-node-commands" ], "icon": "user-bounty-hunter" }, { "group": "Providers", "pages": [ - "get-started/providers/registering-a-provider", - "get-started/providers/consuming-bids", - "get-started/providers/sending-commitments", - "get-started/providers/Querying-for-proposers" + "quickstart/providers/registering-a-provider", + "quickstart/providers/consuming-bids", + "quickstart/providers/sending-commitments", + "quickstart/providers/Querying-for-proposers" ], "icon": "network-wired" } From 186d7403a51e7dd99228182fde3c26e434538569 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Tue, 25 Jun 2024 20:52:17 +0300 Subject: [PATCH 53/85] Update mint.json --- mint.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mint.json b/mint.json index bfbd9d18..9d2176eb 100644 --- a/mint.json +++ b/mint.json @@ -35,7 +35,7 @@ { "group": "Quickstart", "pages": [ - "quickstart/Set-up-mev-commit-node", + "quickstart/set-up-mev-commit-node", "quickstart/faucet", "quickstart/validators", "quickstart/relays", From 4a1a3b6821e4093af0b7fc993ddd320cc075c6f8 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Tue, 25 Jun 2024 21:23:51 +0300 Subject: [PATCH 54/85] Update set-up-mev-commit-node.mdx --- quickstart/set-up-mev-commit-node.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/quickstart/set-up-mev-commit-node.mdx b/quickstart/set-up-mev-commit-node.mdx index 548c73c4..ea66e985 100644 --- a/quickstart/set-up-mev-commit-node.mdx +++ b/quickstart/set-up-mev-commit-node.mdx @@ -1,7 +1,7 @@ --- title: "Quickstart Your mev-commit Node" description: "Step into the Primev ecosystem with ease. This guide covers everything you need to set up your mev-commit node, whether you're aiming to be a bidder or a provider." -sidebarTitle: Quickstart +sidebarTitle: Set Up mev-commit Node icon: "gear" mode: "wide" --- From b45aaf2c57ac5a073ce575ba169f0cad2f222bdc Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Tue, 25 Jun 2024 21:43:46 +0300 Subject: [PATCH 55/85] Update mint.json --- mint.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/mint.json b/mint.json index 9d2176eb..6116161f 100644 --- a/mint.json +++ b/mint.json @@ -37,8 +37,6 @@ "pages": [ "quickstart/set-up-mev-commit-node", "quickstart/faucet", - "quickstart/validators", - "quickstart/relays", { "group": "Bidders", "pages": [ @@ -57,6 +55,8 @@ ], "icon": "network-wired" } + "quickstart/validators", + "quickstart/relays" ] }, { From 3af79f7a5b186a4f317aac90b7fd2de46d650c28 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Tue, 25 Jun 2024 22:42:39 +0300 Subject: [PATCH 56/85] Update mint.json --- mint.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mint.json b/mint.json index 6116161f..e9799d38 100644 --- a/mint.json +++ b/mint.json @@ -54,7 +54,7 @@ "quickstart/providers/Querying-for-proposers" ], "icon": "network-wired" - } + }, "quickstart/validators", "quickstart/relays" ] From 5efe439594fab38139cd6add9f32126c2a158b84 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Tue, 25 Jun 2024 23:39:42 +0300 Subject: [PATCH 57/85] sections update --- .../{ => Providers and Bidders}/bidders/bidder-node-commands.mdx | 0 .../{ => Providers and Bidders}/bidders/bidder-overview.mdx | 0 quickstart/{ => Providers and Bidders}/bidders/first-preconf.mdx | 0 quickstart/{ => Providers and Bidders}/faucet.mdx | 0 .../providers/Querying-for-proposers.mdx | 0 .../{ => Providers and Bidders}/providers/consuming-bids.mdx | 0 .../providers/registering-a-provider.mdx | 0 .../{ => Providers and Bidders}/providers/sending-commitments.mdx | 0 quickstart/{ => Providers and Bidders}/set-up-mev-commit-node.mdx | 0 9 files changed, 0 insertions(+), 0 deletions(-) rename quickstart/{ => Providers and Bidders}/bidders/bidder-node-commands.mdx (100%) rename quickstart/{ => Providers and Bidders}/bidders/bidder-overview.mdx (100%) rename quickstart/{ => Providers and Bidders}/bidders/first-preconf.mdx (100%) rename quickstart/{ => Providers and Bidders}/faucet.mdx (100%) rename quickstart/{ => Providers and Bidders}/providers/Querying-for-proposers.mdx (100%) rename quickstart/{ => Providers and Bidders}/providers/consuming-bids.mdx (100%) rename quickstart/{ => Providers and Bidders}/providers/registering-a-provider.mdx (100%) rename quickstart/{ => Providers and Bidders}/providers/sending-commitments.mdx (100%) rename quickstart/{ => Providers and Bidders}/set-up-mev-commit-node.mdx (100%) diff --git a/quickstart/bidders/bidder-node-commands.mdx b/quickstart/Providers and Bidders/bidders/bidder-node-commands.mdx similarity index 100% rename from quickstart/bidders/bidder-node-commands.mdx rename to quickstart/Providers and Bidders/bidders/bidder-node-commands.mdx diff --git a/quickstart/bidders/bidder-overview.mdx b/quickstart/Providers and Bidders/bidders/bidder-overview.mdx similarity index 100% rename from quickstart/bidders/bidder-overview.mdx rename to quickstart/Providers and Bidders/bidders/bidder-overview.mdx diff --git a/quickstart/bidders/first-preconf.mdx b/quickstart/Providers and Bidders/bidders/first-preconf.mdx similarity index 100% rename from quickstart/bidders/first-preconf.mdx rename to quickstart/Providers and Bidders/bidders/first-preconf.mdx diff --git a/quickstart/faucet.mdx b/quickstart/Providers and Bidders/faucet.mdx similarity index 100% rename from quickstart/faucet.mdx rename to quickstart/Providers and Bidders/faucet.mdx diff --git a/quickstart/providers/Querying-for-proposers.mdx b/quickstart/Providers and Bidders/providers/Querying-for-proposers.mdx similarity index 100% rename from quickstart/providers/Querying-for-proposers.mdx rename to quickstart/Providers and Bidders/providers/Querying-for-proposers.mdx diff --git a/quickstart/providers/consuming-bids.mdx b/quickstart/Providers and Bidders/providers/consuming-bids.mdx similarity index 100% rename from quickstart/providers/consuming-bids.mdx rename to quickstart/Providers and Bidders/providers/consuming-bids.mdx diff --git a/quickstart/providers/registering-a-provider.mdx b/quickstart/Providers and Bidders/providers/registering-a-provider.mdx similarity index 100% rename from quickstart/providers/registering-a-provider.mdx rename to quickstart/Providers and Bidders/providers/registering-a-provider.mdx diff --git a/quickstart/providers/sending-commitments.mdx b/quickstart/Providers and Bidders/providers/sending-commitments.mdx similarity index 100% rename from quickstart/providers/sending-commitments.mdx rename to quickstart/Providers and Bidders/providers/sending-commitments.mdx diff --git a/quickstart/set-up-mev-commit-node.mdx b/quickstart/Providers and Bidders/set-up-mev-commit-node.mdx similarity index 100% rename from quickstart/set-up-mev-commit-node.mdx rename to quickstart/Providers and Bidders/set-up-mev-commit-node.mdx From 2a0b7e0b771e2d7a5a3702b9ef437d54f3934809 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Tue, 25 Jun 2024 23:46:23 +0300 Subject: [PATCH 58/85] Update mint.json --- mint.json | 39 ++++++++++++++++++++++----------------- 1 file changed, 22 insertions(+), 17 deletions(-) diff --git a/mint.json b/mint.json index e9799d38..dcb0f7b6 100644 --- a/mint.json +++ b/mint.json @@ -35,25 +35,30 @@ { "group": "Quickstart", "pages": [ - "quickstart/set-up-mev-commit-node", - "quickstart/faucet", { - "group": "Bidders", + "group": "Providers and Bidders", "pages": [ - "quickstart/bidders/first-preconf", - "quickstart/bidders/bidder-node-commands" - ], - "icon": "user-bounty-hunter" - }, - { - "group": "Providers", - "pages": [ - "quickstart/providers/registering-a-provider", - "quickstart/providers/consuming-bids", - "quickstart/providers/sending-commitments", - "quickstart/providers/Querying-for-proposers" - ], - "icon": "network-wired" + "quickstart/set-up-mev-commit-node", + "quickstart/faucet", + { + "group": "Bidders", + "pages": [ + "quickstart/bidders/first-preconf", + "quickstart/bidders/bidder-node-commands" + ], + "icon": "user-bounty-hunter" + }, + { + "group": "Providers", + "pages": [ + "quickstart/providers/registering-a-provider", + "quickstart/providers/consuming-bids", + "quickstart/providers/sending-commitments", + "quickstart/providers/Querying-for-proposers" + ], + "icon": "network-wired" + } + ] }, "quickstart/validators", "quickstart/relays" From 12e130001ab8b6dcd4eb49aecb1a4b1dfd1088eb Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Tue, 25 Jun 2024 23:48:46 +0300 Subject: [PATCH 59/85] Update mint.json --- mint.json | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/mint.json b/mint.json index dcb0f7b6..7a621ca7 100644 --- a/mint.json +++ b/mint.json @@ -36,25 +36,25 @@ "group": "Quickstart", "pages": [ { - "group": "Providers and Bidders", + "group": "Providers-and-Bidders", "pages": [ - "quickstart/set-up-mev-commit-node", - "quickstart/faucet", + "quickstart/Providers-and-Bidders/set-up-mev-commit-node", + "quickstart/Providers-and-Bidders/faucet", { "group": "Bidders", "pages": [ - "quickstart/bidders/first-preconf", - "quickstart/bidders/bidder-node-commands" + "quickstart/Providers-and-Bidders/bidders/first-preconf", + "quickstart/Providers-and-Bidders/bidders/bidder-node-commands" ], "icon": "user-bounty-hunter" }, { "group": "Providers", "pages": [ - "quickstart/providers/registering-a-provider", - "quickstart/providers/consuming-bids", - "quickstart/providers/sending-commitments", - "quickstart/providers/Querying-for-proposers" + "quickstart/Providers-and-Bidders/providers/registering-a-provider", + "quickstart/Providers-and-Bidders/providers/consuming-bids", + "quickstart/Providers-and-Bidders/providers/sending-commitments", + "quickstart/Providers-and-Bidders/providers/Querying-for-proposers" ], "icon": "network-wired" } From 646c64ffbc1b0991e9d5292e1bceaddffd39a860 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Tue, 25 Jun 2024 23:49:21 +0300 Subject: [PATCH 60/85] section update --- .../bidders/bidder-node-commands.mdx | 0 .../bidders/bidder-overview.mdx | 0 .../bidders/first-preconf.mdx | 0 .../{Providers and Bidders => Providers-and-Bidders}/faucet.mdx | 0 .../providers/Querying-for-proposers.mdx | 0 .../providers/consuming-bids.mdx | 0 .../providers/registering-a-provider.mdx | 0 .../providers/sending-commitments.mdx | 0 .../set-up-mev-commit-node.mdx | 0 9 files changed, 0 insertions(+), 0 deletions(-) rename quickstart/{Providers and Bidders => Providers-and-Bidders}/bidders/bidder-node-commands.mdx (100%) rename quickstart/{Providers and Bidders => Providers-and-Bidders}/bidders/bidder-overview.mdx (100%) rename quickstart/{Providers and Bidders => Providers-and-Bidders}/bidders/first-preconf.mdx (100%) rename quickstart/{Providers and Bidders => Providers-and-Bidders}/faucet.mdx (100%) rename quickstart/{Providers and Bidders => Providers-and-Bidders}/providers/Querying-for-proposers.mdx (100%) rename quickstart/{Providers and Bidders => Providers-and-Bidders}/providers/consuming-bids.mdx (100%) rename quickstart/{Providers and Bidders => Providers-and-Bidders}/providers/registering-a-provider.mdx (100%) rename quickstart/{Providers and Bidders => Providers-and-Bidders}/providers/sending-commitments.mdx (100%) rename quickstart/{Providers and Bidders => Providers-and-Bidders}/set-up-mev-commit-node.mdx (100%) diff --git a/quickstart/Providers and Bidders/bidders/bidder-node-commands.mdx b/quickstart/Providers-and-Bidders/bidders/bidder-node-commands.mdx similarity index 100% rename from quickstart/Providers and Bidders/bidders/bidder-node-commands.mdx rename to quickstart/Providers-and-Bidders/bidders/bidder-node-commands.mdx diff --git a/quickstart/Providers and Bidders/bidders/bidder-overview.mdx b/quickstart/Providers-and-Bidders/bidders/bidder-overview.mdx similarity index 100% rename from quickstart/Providers and Bidders/bidders/bidder-overview.mdx rename to quickstart/Providers-and-Bidders/bidders/bidder-overview.mdx diff --git a/quickstart/Providers and Bidders/bidders/first-preconf.mdx b/quickstart/Providers-and-Bidders/bidders/first-preconf.mdx similarity index 100% rename from quickstart/Providers and Bidders/bidders/first-preconf.mdx rename to quickstart/Providers-and-Bidders/bidders/first-preconf.mdx diff --git a/quickstart/Providers and Bidders/faucet.mdx b/quickstart/Providers-and-Bidders/faucet.mdx similarity index 100% rename from quickstart/Providers and Bidders/faucet.mdx rename to quickstart/Providers-and-Bidders/faucet.mdx diff --git a/quickstart/Providers and Bidders/providers/Querying-for-proposers.mdx b/quickstart/Providers-and-Bidders/providers/Querying-for-proposers.mdx similarity index 100% rename from quickstart/Providers and Bidders/providers/Querying-for-proposers.mdx rename to quickstart/Providers-and-Bidders/providers/Querying-for-proposers.mdx diff --git a/quickstart/Providers and Bidders/providers/consuming-bids.mdx b/quickstart/Providers-and-Bidders/providers/consuming-bids.mdx similarity index 100% rename from quickstart/Providers and Bidders/providers/consuming-bids.mdx rename to quickstart/Providers-and-Bidders/providers/consuming-bids.mdx diff --git a/quickstart/Providers and Bidders/providers/registering-a-provider.mdx b/quickstart/Providers-and-Bidders/providers/registering-a-provider.mdx similarity index 100% rename from quickstart/Providers and Bidders/providers/registering-a-provider.mdx rename to quickstart/Providers-and-Bidders/providers/registering-a-provider.mdx diff --git a/quickstart/Providers and Bidders/providers/sending-commitments.mdx b/quickstart/Providers-and-Bidders/providers/sending-commitments.mdx similarity index 100% rename from quickstart/Providers and Bidders/providers/sending-commitments.mdx rename to quickstart/Providers-and-Bidders/providers/sending-commitments.mdx diff --git a/quickstart/Providers and Bidders/set-up-mev-commit-node.mdx b/quickstart/Providers-and-Bidders/set-up-mev-commit-node.mdx similarity index 100% rename from quickstart/Providers and Bidders/set-up-mev-commit-node.mdx rename to quickstart/Providers-and-Bidders/set-up-mev-commit-node.mdx From 953f8f1462bc107c248fde77b87fc060080d6eaf Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Tue, 25 Jun 2024 23:50:50 +0300 Subject: [PATCH 61/85] Update mint.json --- mint.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mint.json b/mint.json index 7a621ca7..203a2d7c 100644 --- a/mint.json +++ b/mint.json @@ -36,7 +36,7 @@ "group": "Quickstart", "pages": [ { - "group": "Providers-and-Bidders", + "group": "Providers and Bidders", "pages": [ "quickstart/Providers-and-Bidders/set-up-mev-commit-node", "quickstart/Providers-and-Bidders/faucet", From 9e275df57dd6dcd9e2b01eda3879abe1786b86ab Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Wed, 26 Jun 2024 13:24:52 +0300 Subject: [PATCH 62/85] fix --- {developers => api-reference}/bidder-api.mdx | 0 .../provider-api.mdx | 0 mint.json | 33 +++++++++++++------ .../bidders}/bidder-deposit.mdx | 0 quickstart/Providers-and-Bidders/faucet.mdx | 2 +- .../set-up-mev-commit-node.mdx | 4 +-- quickstart/relays.mdx | 2 +- 7 files changed, 27 insertions(+), 14 deletions(-) rename {developers => api-reference}/bidder-api.mdx (100%) rename {developers => api-reference}/provider-api.mdx (100%) rename {developers => quickstart/Providers-and-Bidders/bidders}/bidder-deposit.mdx (100%) diff --git a/developers/bidder-api.mdx b/api-reference/bidder-api.mdx similarity index 100% rename from developers/bidder-api.mdx rename to api-reference/bidder-api.mdx diff --git a/developers/provider-api.mdx b/api-reference/provider-api.mdx similarity index 100% rename from developers/provider-api.mdx rename to api-reference/provider-api.mdx diff --git a/mint.json b/mint.json index 203a2d7c..841729e7 100644 --- a/mint.json +++ b/mint.json @@ -15,6 +15,16 @@ "to": "#E97D25" } }, + "topbarLinks": [ + { + "name": "Twitter", + "url": "https://twitter.com/youraccount" + }, + { + "name": "GitHub", + "url": "https://github.com/yourorganization" + } + ], "tabs": [ { "name": "API Reference", @@ -36,7 +46,7 @@ "group": "Quickstart", "pages": [ { - "group": "Providers and Bidders", + "group": "Providers&Bidders", "pages": [ "quickstart/Providers-and-Bidders/set-up-mev-commit-node", "quickstart/Providers-and-Bidders/faucet", @@ -44,9 +54,10 @@ "group": "Bidders", "pages": [ "quickstart/Providers-and-Bidders/bidders/first-preconf", - "quickstart/Providers-and-Bidders/bidders/bidder-node-commands" + "quickstart/Providers-and-Bidders/bidders/bidder-node-commands", + "quickstart/Providers-and-Bidders/bidders/bidder-deposit" ], - "icon": "user-bounty-hunter" + "icon": "3" }, { "group": "Providers", @@ -56,13 +67,14 @@ "quickstart/Providers-and-Bidders/providers/sending-commitments", "quickstart/Providers-and-Bidders/providers/Querying-for-proposers" ], - "icon": "network-wired" + "icon": "3" } ] }, "quickstart/validators", "quickstart/relays" ] + "icon": "arrow-right-arrow-left" }, { "group": "Concepts", @@ -98,13 +110,10 @@ "pages": [ "developers/testnet", "developers/system-requirements", - "developers/provider-api", - "developers/bidder-api", - "developers/bidder-deposit", + "developers/contracts", + "developers/debugging", "developers/tools-for-bid-submission", "developers/stake-validator-keys-manually", - "developers/contracts", - "developers/debugging", "developers/manual-start-mev-commit", "developers/run-mev-commit-chain-node" ] @@ -122,7 +131,11 @@ }, { "group": "API Reference", - "pages": ["api-reference/introduction"] + "pages": [ + "api-reference/introduction", + "api-reference/provider-api", + "api-reference/bidder-api" + ] }, { "group": "Provider", diff --git a/developers/bidder-deposit.mdx b/quickstart/Providers-and-Bidders/bidders/bidder-deposit.mdx similarity index 100% rename from developers/bidder-deposit.mdx rename to quickstart/Providers-and-Bidders/bidders/bidder-deposit.mdx diff --git a/quickstart/Providers-and-Bidders/faucet.mdx b/quickstart/Providers-and-Bidders/faucet.mdx index a16908b6..2c444861 100644 --- a/quickstart/Providers-and-Bidders/faucet.mdx +++ b/quickstart/Providers-and-Bidders/faucet.mdx @@ -1,7 +1,7 @@ --- title: "Testnet Faucet" sidebarTitle: Testnet Faucet -icon: "faucet" +icon: "2" --- This faucet is for Providers and Bidders only, Validators please visit the faucet links listed on [this](/get-started/validators) page diff --git a/quickstart/Providers-and-Bidders/set-up-mev-commit-node.mdx b/quickstart/Providers-and-Bidders/set-up-mev-commit-node.mdx index ea66e985..f0566c43 100644 --- a/quickstart/Providers-and-Bidders/set-up-mev-commit-node.mdx +++ b/quickstart/Providers-and-Bidders/set-up-mev-commit-node.mdx @@ -1,8 +1,8 @@ --- title: "Quickstart Your mev-commit Node" description: "Step into the Primev ecosystem with ease. This guide covers everything you need to set up your mev-commit node, whether you're aiming to be a bidder or a provider." -sidebarTitle: Set Up mev-commit Node -icon: "gear" +sidebarTitle: Setup Node +icon: "1" mode: "wide" --- diff --git a/quickstart/relays.mdx b/quickstart/relays.mdx index 6139385e..fd388495 100644 --- a/quickstart/relays.mdx +++ b/quickstart/relays.mdx @@ -1,7 +1,7 @@ --- title: Relay Guide sidebarTitle: Relays -icon: 'arrow-right-arrow-left' +icon: 'satellite-dish' --- import { ProviderRegistryAddress } from '/snippets/testnet-addresses.mdx'; From a2396c67a952a43e0336fa5026fcb9b887a9b45e Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Wed, 26 Jun 2024 13:28:10 +0300 Subject: [PATCH 63/85] Update mint.json --- mint.json | 90 +++++++++++++++++++++++++++---------------------------- 1 file changed, 44 insertions(+), 46 deletions(-) diff --git a/mint.json b/mint.json index 841729e7..47812be9 100644 --- a/mint.json +++ b/mint.json @@ -16,14 +16,14 @@ } }, "topbarLinks": [ - { - "name": "Twitter", - "url": "https://twitter.com/youraccount" - }, - { - "name": "GitHub", - "url": "https://github.com/yourorganization" - } + { + "name": "Twitter", + "url": "https://twitter.com/youraccount" + }, + { + "name": "GitHub", + "url": "https://github.com/yourorganization" + } ], "tabs": [ { @@ -46,35 +46,35 @@ "group": "Quickstart", "pages": [ { - "group": "Providers&Bidders", + "group": "Providers & Bidders", "pages": [ - "quickstart/Providers-and-Bidders/set-up-mev-commit-node", - "quickstart/Providers-and-Bidders/faucet", + "quickstart/providers-and-bidders/set-up-mev-commit-node", + "quickstart/providers-and-bidders/faucet", { "group": "Bidders", "pages": [ - "quickstart/Providers-and-Bidders/bidders/first-preconf", - "quickstart/Providers-and-Bidders/bidders/bidder-node-commands", - "quickstart/Providers-and-Bidders/bidders/bidder-deposit" + "quickstart/providers-and-bidders/bidders/first-preconf", + "quickstart/providers-and-bidders/bidders/bidder-node-commands", + "quickstart/providers-and-bidders/bidders/bidder-deposit" ], - "icon": "3" + "icon": "user-bounty-hunter" }, { "group": "Providers", "pages": [ - "quickstart/Providers-and-Bidders/providers/registering-a-provider", - "quickstart/Providers-and-Bidders/providers/consuming-bids", - "quickstart/Providers-and-Bidders/providers/sending-commitments", - "quickstart/Providers-and-Bidders/providers/Querying-for-proposers" + "quickstart/providers-and-bidders/providers/registering-a-provider", + "quickstart/providers-and-bidders/providers/consuming-bids", + "quickstart/providers-and-bidders/providers/sending-commitments", + "quickstart/providers-and-bidders/providers/querying-for-proposers" ], - "icon": "3" + "icon": "network-wired" } ] }, "quickstart/validators", "quickstart/relays" - ] - "icon": "arrow-right-arrow-left" + ], + "icon": "arrow-right-arrow-left" }, { "group": "Concepts", @@ -110,8 +110,8 @@ "pages": [ "developers/testnet", "developers/system-requirements", - "developers/contracts", - "developers/debugging", + "developers/contracts", + "developers/debugging", "developers/tools-for-bid-submission", "developers/stake-validator-keys-manually", "developers/manual-start-mev-commit", @@ -132,28 +132,26 @@ { "group": "API Reference", "pages": [ - "api-reference/introduction", - "api-reference/provider-api", - "api-reference/bidder-api" - ] - }, - { - "group": "Provider", - "pages": [ - "api-reference/provider/receivebids", - "api-reference/provider/sendprocessedbids", - "api-reference/provider/registerstake", - "api-reference/provider/getminstake", - "api-reference/provider/getstake" - ] - }, - { - "group": "Bidder", - "pages": [ - "api-reference/bidder/sendbid", - "api-reference/bidder/getdeposit", - "api-reference/bidder/getmindeposit", - "api-reference/bidder/deposit" + "api-reference/introduction", + { + "group": "Provider API", + "pages": [ + "api-reference/provider/receivebids", + "api-reference/provider/sendprocessedbids", + "api-reference/provider/registerstake", + "api-reference/provider/getminstake", + "api-reference/provider/getstake" + ] + }, + { + "group": "Bidder API", + "pages": [ + "api-reference/bidder/sendbid", + "api-reference/bidder/getdeposit", + "api-reference/bidder/getmindeposit", + "api-reference/bidder/deposit" + ] + } ] } ], From 4455476707e30fa340c6fabdd8da97123ecdaaa1 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Wed, 26 Jun 2024 13:35:04 +0300 Subject: [PATCH 64/85] Update mint.json --- mint.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mint.json b/mint.json index 47812be9..d93d5084 100644 --- a/mint.json +++ b/mint.json @@ -46,7 +46,7 @@ "group": "Quickstart", "pages": [ { - "group": "Providers & Bidders", + "group": "Providers and Bidders", "pages": [ "quickstart/providers-and-bidders/set-up-mev-commit-node", "quickstart/providers-and-bidders/faucet", From 2fdec80e9f89c6e14831b56af0380b3cf9bc4072 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Wed, 26 Jun 2024 13:38:03 +0300 Subject: [PATCH 65/85] Update mint.json --- mint.json | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/mint.json b/mint.json index d93d5084..9f3726c7 100644 --- a/mint.json +++ b/mint.json @@ -18,11 +18,18 @@ "topbarLinks": [ { "name": "Twitter", - "url": "https://twitter.com/youraccount" + "url": "https://twitter.com/primev_xyz" + "icon": "x-twitter" }, { "name": "GitHub", - "url": "https://github.com/yourorganization" + "url": "https://github.com/primev/mev-commit" + "icon": "github" + }, + { + "name": "Mirror", + "url": "https://github.com/primev/mev-commit" + "icon": "newspaper" } ], "tabs": [ From aa330b00d1f856f6c215fecf0eb1456adb3148ab Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Wed, 26 Jun 2024 13:40:02 +0300 Subject: [PATCH 66/85] Update mint.json --- mint.json | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/mint.json b/mint.json index 9f3726c7..c7c30edf 100644 --- a/mint.json +++ b/mint.json @@ -18,17 +18,17 @@ "topbarLinks": [ { "name": "Twitter", - "url": "https://twitter.com/primev_xyz" + "url": "https://twitter.com/primev_xyz", "icon": "x-twitter" }, { "name": "GitHub", - "url": "https://github.com/primev/mev-commit" + "url": "https://github.com/primev/mev-commit", "icon": "github" }, - { + { "name": "Mirror", - "url": "https://github.com/primev/mev-commit" + "url": "https://github.com/primev/mev-commit", "icon": "newspaper" } ], From 9af039dfea067c108670b4f61ae1cd929e9f878f Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Wed, 26 Jun 2024 13:43:13 +0300 Subject: [PATCH 67/85] Update mint.json --- mint.json | 14 ++------------ 1 file changed, 2 insertions(+), 12 deletions(-) diff --git a/mint.json b/mint.json index c7c30edf..39f63329 100644 --- a/mint.json +++ b/mint.json @@ -18,18 +18,8 @@ "topbarLinks": [ { "name": "Twitter", - "url": "https://twitter.com/primev_xyz", - "icon": "x-twitter" - }, - { - "name": "GitHub", - "url": "https://github.com/primev/mev-commit", - "icon": "github" - }, - { - "name": "Mirror", - "url": "https://github.com/primev/mev-commit", - "icon": "newspaper" + "icon": "x-twitter", + "url": "https://twitter.com/primev_xyz" } ], "tabs": [ From aa63ba6e6845744ec0dc961c7bcd0420f59b1d20 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Wed, 26 Jun 2024 13:44:06 +0300 Subject: [PATCH 68/85] Update mint.json --- mint.json | 1 - 1 file changed, 1 deletion(-) diff --git a/mint.json b/mint.json index 39f63329..0cd55a6c 100644 --- a/mint.json +++ b/mint.json @@ -17,7 +17,6 @@ }, "topbarLinks": [ { - "name": "Twitter", "icon": "x-twitter", "url": "https://twitter.com/primev_xyz" } From 6b9fe884203965cdab1ffc01e7586e6987b7244e Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Wed, 26 Jun 2024 13:57:25 +0300 Subject: [PATCH 69/85] Update mint.json --- mint.json | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/mint.json b/mint.json index 0cd55a6c..8d998bde 100644 --- a/mint.json +++ b/mint.json @@ -17,8 +17,16 @@ }, "topbarLinks": [ { - "icon": "x-twitter", + "name": "Twitter", "url": "https://twitter.com/primev_xyz" + }, + { + "name": "GitHub", + "url": "https://github.com/primev/mev-commit", + }, + { + "name": "Mirror", + "url": "https://github.com/primev/mev-commit", } ], "tabs": [ From 6c36fb707c36fa6d5ca6f44ee46e8dd4517fb5f1 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Wed, 26 Jun 2024 13:58:02 +0300 Subject: [PATCH 70/85] Update mint.json --- mint.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/mint.json b/mint.json index 8d998bde..c3bab108 100644 --- a/mint.json +++ b/mint.json @@ -22,11 +22,11 @@ }, { "name": "GitHub", - "url": "https://github.com/primev/mev-commit", + "url": "https://github.com/primev/mev-commit" }, { "name": "Mirror", - "url": "https://github.com/primev/mev-commit", + "url": "https://github.com/primev/mev-commit" } ], "tabs": [ From dd14b0e3cfad75e941536cb872b800e7c3de7fbf Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Wed, 26 Jun 2024 14:07:22 +0300 Subject: [PATCH 71/85] Update mint.json --- mint.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/mint.json b/mint.json index c3bab108..efaaf375 100644 --- a/mint.json +++ b/mint.json @@ -50,7 +50,7 @@ "group": "Quickstart", "pages": [ { - "group": "Providers and Bidders", + "group": "Providers & Bidders", "pages": [ "quickstart/providers-and-bidders/set-up-mev-commit-node", "quickstart/providers-and-bidders/faucet", @@ -73,7 +73,7 @@ ], "icon": "network-wired" } - ] + ], }, "quickstart/validators", "quickstart/relays" From 0bd3aeedf12092ebd4747d124a38bbb6b1f671ab Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Wed, 26 Jun 2024 14:42:09 +0300 Subject: [PATCH 72/85] Update mint.json --- mint.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mint.json b/mint.json index efaaf375..5a174d3e 100644 --- a/mint.json +++ b/mint.json @@ -73,7 +73,7 @@ ], "icon": "network-wired" } - ], + ] }, "quickstart/validators", "quickstart/relays" From 3b98f0d7292507ddcae7e7cf05ea191a656744f7 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Wed, 26 Jun 2024 14:45:09 +0300 Subject: [PATCH 73/85] Update mint.json --- mint.json | 3 --- 1 file changed, 3 deletions(-) diff --git a/mint.json b/mint.json index 5a174d3e..3e1aebdd 100644 --- a/mint.json +++ b/mint.json @@ -61,7 +61,6 @@ "quickstart/providers-and-bidders/bidders/bidder-node-commands", "quickstart/providers-and-bidders/bidders/bidder-deposit" ], - "icon": "user-bounty-hunter" }, { "group": "Providers", @@ -71,14 +70,12 @@ "quickstart/providers-and-bidders/providers/sending-commitments", "quickstart/providers-and-bidders/providers/querying-for-proposers" ], - "icon": "network-wired" } ] }, "quickstart/validators", "quickstart/relays" ], - "icon": "arrow-right-arrow-left" }, { "group": "Concepts", From a4a8c9e10f71f2f167999006a9a54333f54e9aa2 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Wed, 26 Jun 2024 14:51:23 +0300 Subject: [PATCH 74/85] Update mint.json --- mint.json | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/mint.json b/mint.json index 3e1aebdd..bcd41297 100644 --- a/mint.json +++ b/mint.json @@ -24,7 +24,7 @@ "name": "GitHub", "url": "https://github.com/primev/mev-commit" }, - { + { "name": "Mirror", "url": "https://github.com/primev/mev-commit" } @@ -60,7 +60,7 @@ "quickstart/providers-and-bidders/bidders/first-preconf", "quickstart/providers-and-bidders/bidders/bidder-node-commands", "quickstart/providers-and-bidders/bidders/bidder-deposit" - ], + ] }, { "group": "Providers", @@ -69,13 +69,14 @@ "quickstart/providers-and-bidders/providers/consuming-bids", "quickstart/providers-and-bidders/providers/sending-commitments", "quickstart/providers-and-bidders/providers/querying-for-proposers" - ], + ] } - ] + ], + "icon": "arrow-right-arrow-left" }, "quickstart/validators", "quickstart/relays" - ], + ] }, { "group": "Concepts", @@ -134,6 +135,8 @@ "group": "API Reference", "pages": [ "api-reference/introduction", + "api-reference/provider-api", + "api-reference/bidder-api", { "group": "Provider API", "pages": [ From 6ae0f9e8b637a5e151e5d75342761579886c74ff Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Wed, 26 Jun 2024 14:53:12 +0300 Subject: [PATCH 75/85] Update mint.json --- mint.json | 1 - 1 file changed, 1 deletion(-) diff --git a/mint.json b/mint.json index bcd41297..235b8d92 100644 --- a/mint.json +++ b/mint.json @@ -72,7 +72,6 @@ ] } ], - "icon": "arrow-right-arrow-left" }, "quickstart/validators", "quickstart/relays" From a49e6fbd1f38fcfde7c20a40074989031fa39423 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Wed, 26 Jun 2024 14:53:51 +0300 Subject: [PATCH 76/85] Update mint.json --- mint.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mint.json b/mint.json index 235b8d92..1d9db5d5 100644 --- a/mint.json +++ b/mint.json @@ -71,7 +71,7 @@ "quickstart/providers-and-bidders/providers/querying-for-proposers" ] } - ], + ] }, "quickstart/validators", "quickstart/relays" From 6af66c598f7c33c180b2e9c80a196b231cbaf194 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Wed, 26 Jun 2024 14:55:56 +0300 Subject: [PATCH 77/85] Update mint.json --- mint.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/mint.json b/mint.json index 1d9db5d5..184c8ec4 100644 --- a/mint.json +++ b/mint.json @@ -52,8 +52,8 @@ { "group": "Providers & Bidders", "pages": [ - "quickstart/providers-and-bidders/set-up-mev-commit-node", - "quickstart/providers-and-bidders/faucet", + "quickstart/Providers-and-Bidders/set-up-mev-commit-node", + "quickstart/Providers-and-Bidders/faucet", { "group": "Bidders", "pages": [ From fe064a140f1be46ad0657a857f48154b48d14aa6 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Wed, 26 Jun 2024 14:57:50 +0300 Subject: [PATCH 78/85] fix --- .../bidders/bidder-deposit.mdx | 0 .../bidders/bidder-node-commands.mdx | 0 .../bidders/bidder-overview.mdx | 0 .../bidders/first-preconf.mdx | 0 .../{Providers-and-Bidders => providers-and-bidders1}/faucet.mdx | 0 .../providers/Querying-for-proposers.mdx | 0 .../providers/consuming-bids.mdx | 0 .../providers/registering-a-provider.mdx | 0 .../providers/sending-commitments.mdx | 0 .../set-up-mev-commit-node.mdx | 0 10 files changed, 0 insertions(+), 0 deletions(-) rename quickstart/{Providers-and-Bidders => providers-and-bidders1}/bidders/bidder-deposit.mdx (100%) rename quickstart/{Providers-and-Bidders => providers-and-bidders1}/bidders/bidder-node-commands.mdx (100%) rename quickstart/{Providers-and-Bidders => providers-and-bidders1}/bidders/bidder-overview.mdx (100%) rename quickstart/{Providers-and-Bidders => providers-and-bidders1}/bidders/first-preconf.mdx (100%) rename quickstart/{Providers-and-Bidders => providers-and-bidders1}/faucet.mdx (100%) rename quickstart/{Providers-and-Bidders => providers-and-bidders1}/providers/Querying-for-proposers.mdx (100%) rename quickstart/{Providers-and-Bidders => providers-and-bidders1}/providers/consuming-bids.mdx (100%) rename quickstart/{Providers-and-Bidders => providers-and-bidders1}/providers/registering-a-provider.mdx (100%) rename quickstart/{Providers-and-Bidders => providers-and-bidders1}/providers/sending-commitments.mdx (100%) rename quickstart/{Providers-and-Bidders => providers-and-bidders1}/set-up-mev-commit-node.mdx (100%) diff --git a/quickstart/Providers-and-Bidders/bidders/bidder-deposit.mdx b/quickstart/providers-and-bidders1/bidders/bidder-deposit.mdx similarity index 100% rename from quickstart/Providers-and-Bidders/bidders/bidder-deposit.mdx rename to quickstart/providers-and-bidders1/bidders/bidder-deposit.mdx diff --git a/quickstart/Providers-and-Bidders/bidders/bidder-node-commands.mdx b/quickstart/providers-and-bidders1/bidders/bidder-node-commands.mdx similarity index 100% rename from quickstart/Providers-and-Bidders/bidders/bidder-node-commands.mdx rename to quickstart/providers-and-bidders1/bidders/bidder-node-commands.mdx diff --git a/quickstart/Providers-and-Bidders/bidders/bidder-overview.mdx b/quickstart/providers-and-bidders1/bidders/bidder-overview.mdx similarity index 100% rename from quickstart/Providers-and-Bidders/bidders/bidder-overview.mdx rename to quickstart/providers-and-bidders1/bidders/bidder-overview.mdx diff --git a/quickstart/Providers-and-Bidders/bidders/first-preconf.mdx b/quickstart/providers-and-bidders1/bidders/first-preconf.mdx similarity index 100% rename from quickstart/Providers-and-Bidders/bidders/first-preconf.mdx rename to quickstart/providers-and-bidders1/bidders/first-preconf.mdx diff --git a/quickstart/Providers-and-Bidders/faucet.mdx b/quickstart/providers-and-bidders1/faucet.mdx similarity index 100% rename from quickstart/Providers-and-Bidders/faucet.mdx rename to quickstart/providers-and-bidders1/faucet.mdx diff --git a/quickstart/Providers-and-Bidders/providers/Querying-for-proposers.mdx b/quickstart/providers-and-bidders1/providers/Querying-for-proposers.mdx similarity index 100% rename from quickstart/Providers-and-Bidders/providers/Querying-for-proposers.mdx rename to quickstart/providers-and-bidders1/providers/Querying-for-proposers.mdx diff --git a/quickstart/Providers-and-Bidders/providers/consuming-bids.mdx b/quickstart/providers-and-bidders1/providers/consuming-bids.mdx similarity index 100% rename from quickstart/Providers-and-Bidders/providers/consuming-bids.mdx rename to quickstart/providers-and-bidders1/providers/consuming-bids.mdx diff --git a/quickstart/Providers-and-Bidders/providers/registering-a-provider.mdx b/quickstart/providers-and-bidders1/providers/registering-a-provider.mdx similarity index 100% rename from quickstart/Providers-and-Bidders/providers/registering-a-provider.mdx rename to quickstart/providers-and-bidders1/providers/registering-a-provider.mdx diff --git a/quickstart/Providers-and-Bidders/providers/sending-commitments.mdx b/quickstart/providers-and-bidders1/providers/sending-commitments.mdx similarity index 100% rename from quickstart/Providers-and-Bidders/providers/sending-commitments.mdx rename to quickstart/providers-and-bidders1/providers/sending-commitments.mdx diff --git a/quickstart/Providers-and-Bidders/set-up-mev-commit-node.mdx b/quickstart/providers-and-bidders1/set-up-mev-commit-node.mdx similarity index 100% rename from quickstart/Providers-and-Bidders/set-up-mev-commit-node.mdx rename to quickstart/providers-and-bidders1/set-up-mev-commit-node.mdx From db44e566ac3e1a13b911439b8ae2c2a6fed25982 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Wed, 26 Jun 2024 14:58:06 +0300 Subject: [PATCH 79/85] fix v2 --- .../bidders/bidder-deposit.mdx | 0 .../bidders/bidder-node-commands.mdx | 0 .../bidders/bidder-overview.mdx | 0 .../bidders/first-preconf.mdx | 0 .../{providers-and-bidders1 => providers-and-bidders}/faucet.mdx | 0 .../providers/Querying-for-proposers.mdx | 0 .../providers/consuming-bids.mdx | 0 .../providers/registering-a-provider.mdx | 0 .../providers/sending-commitments.mdx | 0 .../set-up-mev-commit-node.mdx | 0 10 files changed, 0 insertions(+), 0 deletions(-) rename quickstart/{providers-and-bidders1 => providers-and-bidders}/bidders/bidder-deposit.mdx (100%) rename quickstart/{providers-and-bidders1 => providers-and-bidders}/bidders/bidder-node-commands.mdx (100%) rename quickstart/{providers-and-bidders1 => providers-and-bidders}/bidders/bidder-overview.mdx (100%) rename quickstart/{providers-and-bidders1 => providers-and-bidders}/bidders/first-preconf.mdx (100%) rename quickstart/{providers-and-bidders1 => providers-and-bidders}/faucet.mdx (100%) rename quickstart/{providers-and-bidders1 => providers-and-bidders}/providers/Querying-for-proposers.mdx (100%) rename quickstart/{providers-and-bidders1 => providers-and-bidders}/providers/consuming-bids.mdx (100%) rename quickstart/{providers-and-bidders1 => providers-and-bidders}/providers/registering-a-provider.mdx (100%) rename quickstart/{providers-and-bidders1 => providers-and-bidders}/providers/sending-commitments.mdx (100%) rename quickstart/{providers-and-bidders1 => providers-and-bidders}/set-up-mev-commit-node.mdx (100%) diff --git a/quickstart/providers-and-bidders1/bidders/bidder-deposit.mdx b/quickstart/providers-and-bidders/bidders/bidder-deposit.mdx similarity index 100% rename from quickstart/providers-and-bidders1/bidders/bidder-deposit.mdx rename to quickstart/providers-and-bidders/bidders/bidder-deposit.mdx diff --git a/quickstart/providers-and-bidders1/bidders/bidder-node-commands.mdx b/quickstart/providers-and-bidders/bidders/bidder-node-commands.mdx similarity index 100% rename from quickstart/providers-and-bidders1/bidders/bidder-node-commands.mdx rename to quickstart/providers-and-bidders/bidders/bidder-node-commands.mdx diff --git a/quickstart/providers-and-bidders1/bidders/bidder-overview.mdx b/quickstart/providers-and-bidders/bidders/bidder-overview.mdx similarity index 100% rename from quickstart/providers-and-bidders1/bidders/bidder-overview.mdx rename to quickstart/providers-and-bidders/bidders/bidder-overview.mdx diff --git a/quickstart/providers-and-bidders1/bidders/first-preconf.mdx b/quickstart/providers-and-bidders/bidders/first-preconf.mdx similarity index 100% rename from quickstart/providers-and-bidders1/bidders/first-preconf.mdx rename to quickstart/providers-and-bidders/bidders/first-preconf.mdx diff --git a/quickstart/providers-and-bidders1/faucet.mdx b/quickstart/providers-and-bidders/faucet.mdx similarity index 100% rename from quickstart/providers-and-bidders1/faucet.mdx rename to quickstart/providers-and-bidders/faucet.mdx diff --git a/quickstart/providers-and-bidders1/providers/Querying-for-proposers.mdx b/quickstart/providers-and-bidders/providers/Querying-for-proposers.mdx similarity index 100% rename from quickstart/providers-and-bidders1/providers/Querying-for-proposers.mdx rename to quickstart/providers-and-bidders/providers/Querying-for-proposers.mdx diff --git a/quickstart/providers-and-bidders1/providers/consuming-bids.mdx b/quickstart/providers-and-bidders/providers/consuming-bids.mdx similarity index 100% rename from quickstart/providers-and-bidders1/providers/consuming-bids.mdx rename to quickstart/providers-and-bidders/providers/consuming-bids.mdx diff --git a/quickstart/providers-and-bidders1/providers/registering-a-provider.mdx b/quickstart/providers-and-bidders/providers/registering-a-provider.mdx similarity index 100% rename from quickstart/providers-and-bidders1/providers/registering-a-provider.mdx rename to quickstart/providers-and-bidders/providers/registering-a-provider.mdx diff --git a/quickstart/providers-and-bidders1/providers/sending-commitments.mdx b/quickstart/providers-and-bidders/providers/sending-commitments.mdx similarity index 100% rename from quickstart/providers-and-bidders1/providers/sending-commitments.mdx rename to quickstart/providers-and-bidders/providers/sending-commitments.mdx diff --git a/quickstart/providers-and-bidders1/set-up-mev-commit-node.mdx b/quickstart/providers-and-bidders/set-up-mev-commit-node.mdx similarity index 100% rename from quickstart/providers-and-bidders1/set-up-mev-commit-node.mdx rename to quickstart/providers-and-bidders/set-up-mev-commit-node.mdx From 2d7bf632df78219df05d3bac0854c7f71c1afcad Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Wed, 26 Jun 2024 15:02:01 +0300 Subject: [PATCH 80/85] Update mint.json --- mint.json | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/mint.json b/mint.json index 184c8ec4..cc7515c7 100644 --- a/mint.json +++ b/mint.json @@ -17,18 +17,19 @@ }, "topbarLinks": [ { - "name": "Twitter", + "name": "Follow", "url": "https://twitter.com/primev_xyz" }, { "name": "GitHub", "url": "https://github.com/primev/mev-commit" - }, - { - "name": "Mirror", - "url": "https://github.com/primev/mev-commit" } ], + "topbarCtaButton": { + "type": "link", + "url": "https://mirror.xyz/preconf.eth", + "name": "Writings" +}, "tabs": [ { "name": "API Reference", @@ -52,8 +53,8 @@ { "group": "Providers & Bidders", "pages": [ - "quickstart/Providers-and-Bidders/set-up-mev-commit-node", - "quickstart/Providers-and-Bidders/faucet", + "quickstart/providers-and-bidders/set-up-mev-commit-node", + "quickstart/providers-and-bidders/faucet", { "group": "Bidders", "pages": [ @@ -71,7 +72,8 @@ "quickstart/providers-and-bidders/providers/querying-for-proposers" ] } - ] + ], + "icon": "arrow-right-arrow-left" }, "quickstart/validators", "quickstart/relays" From 10b5d8ccd6b0caf11c338c8e535e6b6c8b2eef17 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Wed, 26 Jun 2024 15:04:22 +0300 Subject: [PATCH 81/85] Update mint.json --- mint.json | 1 - 1 file changed, 1 deletion(-) diff --git a/mint.json b/mint.json index cc7515c7..b3a2beab 100644 --- a/mint.json +++ b/mint.json @@ -26,7 +26,6 @@ } ], "topbarCtaButton": { - "type": "link", "url": "https://mirror.xyz/preconf.eth", "name": "Writings" }, From 803f165fe66d81b94402c509fb95c360f6cf5813 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Wed, 26 Jun 2024 15:20:12 +0300 Subject: [PATCH 82/85] fix --- api-reference/bidder-api.mdx | 1 + api-reference/provider-api.mdx | 1 + concepts/{ => bids}/commitments.mdx | 0 mint.json | 5 +++-- quickstart/providers-and-bidders/bidders/bidder-deposit.mdx | 2 +- quickstart/providers-and-bidders/faucet.mdx | 1 - quickstart/providers-and-bidders/set-up-mev-commit-node.mdx | 1 - 7 files changed, 6 insertions(+), 5 deletions(-) rename concepts/{ => bids}/commitments.mdx (100%) diff --git a/api-reference/bidder-api.mdx b/api-reference/bidder-api.mdx index 2bd651a3..5518efe3 100644 --- a/api-reference/bidder-api.mdx +++ b/api-reference/bidder-api.mdx @@ -1,5 +1,6 @@ --- title: "Bidder API" +sidebarTitle: "Bidder API Overview" --- ## **Bidders** diff --git a/api-reference/provider-api.mdx b/api-reference/provider-api.mdx index e140a407..f5dece4a 100644 --- a/api-reference/provider-api.mdx +++ b/api-reference/provider-api.mdx @@ -1,5 +1,6 @@ --- title: "Provider API" +sidebarTitle: "Provider API Overview" --- ## **Providers** diff --git a/concepts/commitments.mdx b/concepts/bids/commitments.mdx similarity index 100% rename from concepts/commitments.mdx rename to concepts/bids/commitments.mdx diff --git a/mint.json b/mint.json index b3a2beab..10606ed1 100644 --- a/mint.json +++ b/mint.json @@ -26,6 +26,7 @@ } ], "topbarCtaButton": { + "type": "github" "url": "https://mirror.xyz/preconf.eth", "name": "Writings" }, @@ -85,11 +86,11 @@ "concepts/actors", "concepts/network-overview", "concepts/privacy", - "concepts/commitments", { - "group": "Bids", + "group": "Bids & Commitments", "pages": [ "concepts/bids/bid-structure", + "concepts/bids/commitments", "concepts/bids/bidder-deposit", "concepts/bids/bid-decay-mechanism" ] diff --git a/quickstart/providers-and-bidders/bidders/bidder-deposit.mdx b/quickstart/providers-and-bidders/bidders/bidder-deposit.mdx index 98433768..56543fce 100644 --- a/quickstart/providers-and-bidders/bidders/bidder-deposit.mdx +++ b/quickstart/providers-and-bidders/bidders/bidder-deposit.mdx @@ -1,6 +1,6 @@ --- title: "Managing Your Bidder Deposit" -sidebarTitle: Managing Your Bidder Deposit +sidebarTitle: Bidder Deposit --- **To Check Your Deposit for current window:** diff --git a/quickstart/providers-and-bidders/faucet.mdx b/quickstart/providers-and-bidders/faucet.mdx index 2c444861..eb0591cd 100644 --- a/quickstart/providers-and-bidders/faucet.mdx +++ b/quickstart/providers-and-bidders/faucet.mdx @@ -1,7 +1,6 @@ --- title: "Testnet Faucet" sidebarTitle: Testnet Faucet -icon: "2" --- This faucet is for Providers and Bidders only, Validators please visit the faucet links listed on [this](/get-started/validators) page diff --git a/quickstart/providers-and-bidders/set-up-mev-commit-node.mdx b/quickstart/providers-and-bidders/set-up-mev-commit-node.mdx index f0566c43..26dcd281 100644 --- a/quickstart/providers-and-bidders/set-up-mev-commit-node.mdx +++ b/quickstart/providers-and-bidders/set-up-mev-commit-node.mdx @@ -2,7 +2,6 @@ title: "Quickstart Your mev-commit Node" description: "Step into the Primev ecosystem with ease. This guide covers everything you need to set up your mev-commit node, whether you're aiming to be a bidder or a provider." sidebarTitle: Setup Node -icon: "1" mode: "wide" --- From 15c752909f020403dccde3c2f1912e465591aa48 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Wed, 26 Jun 2024 15:21:39 +0300 Subject: [PATCH 83/85] Update mint.json --- mint.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mint.json b/mint.json index 10606ed1..648334af 100644 --- a/mint.json +++ b/mint.json @@ -26,7 +26,7 @@ } ], "topbarCtaButton": { - "type": "github" + "type": "github", "url": "https://mirror.xyz/preconf.eth", "name": "Writings" }, From cf47fc176352adffe04e4cd3cd36e222cbf3e3d9 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Wed, 26 Jun 2024 15:40:34 +0300 Subject: [PATCH 84/85] Update mint.json --- mint.json | 56 +++++++++++++++++++++++++++---------------------------- 1 file changed, 28 insertions(+), 28 deletions(-) diff --git a/mint.json b/mint.json index 648334af..1e65de45 100644 --- a/mint.json +++ b/mint.json @@ -21,15 +21,15 @@ "url": "https://twitter.com/primev_xyz" }, { - "name": "GitHub", - "url": "https://github.com/primev/mev-commit" + "name": "Writings", + "url": "https://mirror.xyz/preconf.eth" } ], "topbarCtaButton": { - "type": "github", - "url": "https://mirror.xyz/preconf.eth", - "name": "Writings" -}, + "type": "github", + "url": "https://github.com/primev/mev-commit", + "name": "Github" + }, "tabs": [ { "name": "API Reference", @@ -90,7 +90,7 @@ "group": "Bids & Commitments", "pages": [ "concepts/bids/bid-structure", - "concepts/bids/commitments", + "concepts/bids/commitments", "concepts/bids/bidder-deposit", "concepts/bids/bid-decay-mechanism" ] @@ -136,27 +136,27 @@ "group": "API Reference", "pages": [ "api-reference/introduction", - "api-reference/provider-api", - "api-reference/bidder-api", - { - "group": "Provider API", - "pages": [ - "api-reference/provider/receivebids", - "api-reference/provider/sendprocessedbids", - "api-reference/provider/registerstake", - "api-reference/provider/getminstake", - "api-reference/provider/getstake" - ] - }, - { - "group": "Bidder API", - "pages": [ - "api-reference/bidder/sendbid", - "api-reference/bidder/getdeposit", - "api-reference/bidder/getmindeposit", - "api-reference/bidder/deposit" - ] - } + "api-reference/provider-api", + "api-reference/bidder-api" + ] + }, + { + "group": "Provider", + "pages": [ + "api-reference/provider/receivebids", + "api-reference/provider/sendprocessedbids", + "api-reference/provider/registerstake", + "api-reference/provider/getminstake", + "api-reference/provider/getstake" + ] + }, + { + "group": "Bidder", + "pages": [ + "api-reference/bidder/sendbid", + "api-reference/bidder/getdeposit", + "api-reference/bidder/getmindeposit", + "api-reference/bidder/deposit" ] } ], From cefe24033eef8d6aefd43a5da691a7a030757866 Mon Sep 17 00:00:00 2001 From: Dogandi <152641329+Dogandi@users.noreply.github.com> Date: Wed, 26 Jun 2024 15:42:18 +0300 Subject: [PATCH 85/85] Update mint.json --- mint.json | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/mint.json b/mint.json index 1e65de45..d491da94 100644 --- a/mint.json +++ b/mint.json @@ -27,8 +27,7 @@ ], "topbarCtaButton": { "type": "github", - "url": "https://github.com/primev/mev-commit", - "name": "Github" + "url": "https://github.com/primev/mev-commit" }, "tabs": [ {