# Documentation

## Docs

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