# Documentation ## Docs - [Welcome to Primev](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/get-started/welcome-to-primev.md): Primev is building mev-commit; a credible commitment network used for preconfirmations & more - [Quickstart for mev-commit bidder node](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/get-started/quickstart.md): This guide covers everything you need to set up your mev-commit bidder node. For providers, please refer to the [manual start mev-commit](/v1.0.0/developers/manual-start-mev-commit) section - [Bridge](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/get-started/bridge.md) - [Validator Guide](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/get-started/validators/validator-guide.md): Opt into mev-commit with ease. This guide covers everything you need to passively opt-in to mev-commit as an L1 validator. - [Eigenlayer Opt-in](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/get-started/validators/eigenlayer.md): Opt into mev-commit by natively restaking to our AVS. - [Symbiotic Opt-in](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/get-started/validators/symbiotic.md): Opt into mev-commit by ERC20 restaking with the MevCommitMiddleware contract through Symbiotic. - [Vanilla Opt-in](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/get-started/validators/vanilla.md): Opt into mev-commit by simply staking ETH. - [Relay Integration Guide](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/get-started/relays.md) - [Bidder Best Practices](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/get-started/bidders/best-practices.md) - [Bidder Node Commands](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/get-started/bidders/bidder-node-commands.md) - [Bidder CLI application](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/get-started/bidders/bidder-cli.md) - [Registering as a Provider](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/get-started/providers/registering-a-provider.md) - [Consuming Bids from mev-commit](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/get-started/providers/consuming-bids.md) - [Sending Commitments](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/get-started/providers/sending-commitments.md) - [Querying for Proposers](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/get-started/providers/Querying-for-proposers.md): Use the pointers below to determine whether an upcoming proposer has opted in to mev-commit or not. - [Withdraw Stake](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/get-started/providers/withdraw.md): Withdraws the stake from the provider registry. - [What is mev-commit?](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/concepts/what-is-mev-commit.md) - [Actors](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/concepts/actors.md) - [Understanding mev-commit](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/concepts/network-overview.md) - [Security & Privacy](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/concepts/privacy.md) - [Commitments](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/concepts/commitments.md) - [Solvers](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/concepts/solvers.md) - [Builder Attribution](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/concepts/builder-attribution.md): Understanding how builders are identified and attributed in mev-commit - [Bid Structure](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/concepts/bids/bid-structure.md) - [Reverting txns](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/concepts/bids/reverting-txns.md) - [Understanding Bidder Deposit Rules](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/concepts/bids/bidder-deposit.md) - [Bid Decay Mechanism](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/concepts/bids/bid-decay-mechanism.md): Learn about how bids decay in value in real time - [Chain Details](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/concepts/mev-commit-chain/chain-details.md) - [Differences Between Ethereum and mev-commit Chain](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/concepts/mev-commit-chain/differences-between-ethereum-and-mev-commit-chain.md) - [Bridging Details](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/concepts/mev-commit-chain/bridging-details.md) - [Rewards and Slashing](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/concepts/rewards-and-slashing.md) - [Oracle](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/concepts/oracle.md) - [Validator considerations](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/concepts/validator-considerations.md) - [Mev-commit Mainnet](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/developers/mainnet.md) - [Mev-commit Testnet](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/developers/testnet.md) - [System Requirements](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/developers/system-requirements.md) - [Provider API](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/developers/provider-api.md) - [Bidder API](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/developers/bidder-api.md) - [Managing Your Bidder Deposit](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/developers/bidder-deposit.md) - [Docker bidder](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/developers/docker-bidder.md) - [Tools for Bid Submission](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/developers/tools-for-bid-submission.md) - [Contracts](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/developers/contracts.md) - [Debugging](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/developers/debugging.md) - [Manual Node Setup](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/developers/manual-start-mev-commit.md) - [Run mev-commit Chain Node](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/developers/run-mev-commit-chain-node.md) - [Introduction](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/api-reference/introduction.md) - [Receive Bids](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/api-reference/provider/receivebids.md): ReceiveBids is called by the provider to receive bids from the mev-commit node. The mev-commit node will stream bids to the provider as the response. The bid can optionally have the raw transaction payload in it. The order of the transaction hashes will be the same as the raw transaction payloads if… - [Send Processed Bids](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/api-reference/provider/sendprocessedbids.md): SendProcessedBids is called by the provider to send processed bids to the mev-commit node. The provider will stream processed bids to the mev-commit node. - [Register Stake](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/api-reference/provider/registerstake.md): Stake is called by the provider to register or add to its stake in the provider registry. - [Retrieve Minimum Stake](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/api-reference/provider/getminstake.md): GetMinStake is called by the provider to get the minimum stake required to be in the provider registry. - [Retrieve Stake](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/api-reference/provider/getstake.md): GetStake is called by the provider to get its stake in the provider registry. - [Unstake Funds](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/api-reference/provider/unstake.md): Unstake is called by the provider to request a unstake from the provider registry. - [Withdraw Stake](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/api-reference/provider/withdraw_stake.md): WithdrawStake is called by the provider to withdraw its stake from the provider registry. - [Send Bid](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/api-reference/bidder/sendbid.md): Send a bid to the bidder mev-commit node. The bid is a message from the bidder to the provider with the transaction hashes and the amount of ETH that the bidder is willing to pay to the provider for including the transaction in the block. The bid also includes the block number that the bidder wants… - [Retrieve Deposit](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/api-reference/bidder/getdeposit.md): GetDeposit is called by the bidder to get its deposit in the bidder registry. - [Add Deposit](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/api-reference/bidder/deposit.md): Deposit is called by the bidder node to add deposit in the bidder registry. The bidder can deposit funds in a particular window by specifying the window number. If the window number is not specified, the current block number is used to calculate the window number. If the block number is specified, t… - [Withdraw Deposit](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/api-reference/bidder/withdraw.md): Withdraw is called by the bidder to withdraw deposit from the bidder registry. - [Withdraw Deposit From Windows](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/api-reference/bidder/withdrawfromwindows.md): WithdrawFromWindows is called by the bidder node to withdraw funds from multiple windows. - [Add Auto Deposit](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/api-reference/bidder/autodeposit.md): AutoDeposit is called by the bidder node to add a recurring deposit in the bidder registry. The bidder can specify the amount of ETH to be deposited in each window. The bidder can also specify the start window number for the deposit. If the start window number is not specified, the current block num… - [Get Auto Deposit Status](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/api-reference/bidder/autodepositstatus.md): AutoDepositStatus is called by the bidder node to get the status of the auto deposit. - [Cancel Auto Deposit](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/api-reference/bidder/cancelautodeposit.md): CancelAutoDeposit is called by the bidder node to cancel the auto deposit. The bidder can specify if it wants to withdraw the deposit from the current deposited windows. If the withdraw flag is set to true, the API will wait till we can withdraw the deposit from the latest deposited window. - [Get Validators](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/api-reference/validator/getvalidators.md): GetValidators is called by the bidder to get the validators for a given epoch. - [Cancel Transaction](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/api-reference/debug/canceltx.md): CancelTransaction is called by the provider to cancel a transaction sent from this wallet. - [Pending Transactions](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/api-reference/debug/pendingtxs.md): GetPendingTransactions is called by the provider to get the pending transactions for the wallet. - [Topology](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/api-reference/debug/topology.md): GetTopology is called by the user to get the topology of the node. The topology includes connectivity information about the node. - [Introduction](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/knowledge-base/introduction.md): A collection of answers to frequently asked questions. - [What is the Deposit Amount?](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/knowledge-base/what-is-deposit-amount.md): Learn about deposit amounts required for bidding and their significance. - [How do I fix the error: "failed to read msg: stream reset"?](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/knowledge-base/how-do-i-fix-the-error-failed-to-read-msg-stream-reset.md): Learn how to resolve the `failed to read msg: stream reset` error for provider nodes within the mev-commit network. - [What is Foundry?](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/knowledge-base/what-is-foundry.md): Discover what Foundry is and its role in smart contract development and interactions within the mev-commit ecosystem. - [Why is cast necessary for mev-commit chain interactions?](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/knowledge-base/why-is-cast-necessary-for-mev-commit-chain-interactions.md) - [Why do I receive the same commitment when resending a bid?](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/knowledge-base/why-do-i-receive-the-same-commitment-when-resending-a-bid.md): Understand why resending a bid in the mev-commit ecosystem results in receiving the same commitment. - [What is Execution Preconfirmations?](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/knowledge-base/what-is-execution-preconfirmations.md) - [How to Price A Bid](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/knowledge-base/how-to-price-a-bid.md): Learn how to find the sweet spot for competitive bids. - [What Happens During An Execution Preconfirmation?](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/knowledge-base/what-happens-during-an-execution-preconf.md): Learn about what happens behind the scenes during an execution preconfirmation. - [How Do You Provide A Commitment for Execution?](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/knowledge-base/how-do-preconfs-work.md): Learn what providers do during an execution preconfirmation. - [Eigenlayer Operator Registration](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v1.0.0/knowledge-base/eigenlayer-operator-registration.md): Instructions for registering as an Eigenlayer operator for the mev-commit AVS, enabling validator opt-in via restaking. ## OpenAPI Specs - [validator-openapi-spec](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/validator-openapi-spec.json) - [openapi](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/v0.8.0/api-reference/openapi.json) - [provider-openapi-spec](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/provider-openapi-spec.json) - [debug-openapi-spec](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/debug-openapi-spec.json) - [bidder-openapi-spec](https://primev-24-ckartik-fix-docs-tgvl.mintlify.site/bidder-openapi-spec.json)