# Documentation

## Docs

- [ClaimSlashedFunds](https://docs.primev.xyz/v1.2.x/api-reference/bidder/claimslashedfunds.md): ClaimSlashedFunds is called by the bidder to claim slashed funds from the provider. The response
will show the amount claimed if any in wei.
- [Deposit](https://docs.primev.xyz/v1.2.x/api-reference/bidder/deposit.md): Deposit is called by the bidder node to add deposit in the bidder registry, specific to a provider.
- [DepositEvenly](https://docs.primev.xyz/v1.2.x/api-reference/bidder/depositevenly.md): DepositEvenly is called by the bidder node to deposit a total amount evenly across multiple providers.
- [DepositManagerStatus](https://docs.primev.xyz/v1.2.x/api-reference/bidder/depositmanagerstatus.md): DepositManagerStatus is called by the bidder node to query whether the bidder
has enabled the deposit manager via eip 7702.
- [DisableDepositManager](https://docs.primev.xyz/v1.2.x/api-reference/bidder/disabledepositmanager.md): DisableDepositManager is called by the bidder node to disable the deposit manager 
by setting the bidder EOA's code to zero address.
- [EnableDepositManager](https://docs.primev.xyz/v1.2.x/api-reference/bidder/enabledepositmanager.md): EnableDepositManager is called by the bidder node to enable the deposit manager via eip 7702.
- [GetAllDeposits](https://docs.primev.xyz/v1.2.x/api-reference/bidder/getalldeposits.md): GetAllDeposits is called by the bidder to get all its deposits in the bidder registry,
and the balance of the bidder EOA itself.
- [GetBidInfo](https://docs.primev.xyz/v1.2.x/api-reference/bidder/getbidinfo.md): GetBidInfo is called by the bidder to get the bid information. If block number is not specified,
all known block numbers are returned in the ascending order.
- [GetDeposit](https://docs.primev.xyz/v1.2.x/api-reference/bidder/getdeposit.md): GetDeposit is called by the bidder to get its deposit specific to a provider in the bidder registry.
- [GetValidProviders](https://docs.primev.xyz/v1.2.x/api-reference/bidder/getvalidproviders.md): GetValidProviders is called by the bidder node to get a list of all valid providers.
Each provider returned by this RPC must:
- Be "registered" in the provider registry
- Have deposit >= minStake in provider registry
- Have no pending withdrawal request with provider registry
- Have at least one BLS key registered with provider registry
- [RequestWithdrawals](https://docs.primev.xyz/v1.2.x/api-reference/bidder/requestwithdrawals.md): RequestWithdrawals is called by the bidder node to request withdrawals from provider(s)
- [SendBid](https://docs.primev.xyz/v1.2.x/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 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.
- [SetTargetDeposits](https://docs.primev.xyz/v1.2.x/api-reference/bidder/settargetdeposits.md): SetTargetDeposits is called by the bidder node to set target deposits per provider
within the deposit manager. During this call, the bidder node will also attempt to top-up
deposits for each new target deposit.
- [Withdraw](https://docs.primev.xyz/v1.2.x/api-reference/bidder/withdraw.md): Withdraw is called by the bidder to withdraw their deposit to a provider.
- [CancelTransaction](https://docs.primev.xyz/v1.2.x/api-reference/debug/canceltransaction.md): CancelTransaction is called by the provider to cancel a transaction sent from this wallet.
- [GetPendingTransactions](https://docs.primev.xyz/v1.2.x/api-reference/debug/getpendingtransactions.md): GetPendingTransactions is called by the provider to get the pending transactions for the wallet.
- [GetTopology](https://docs.primev.xyz/v1.2.x/api-reference/debug/gettopology.md): GetTopology is called by the user to get the topology of the node. The topology
includes connectivity information about the node.
- [Subscribe](https://docs.primev.xyz/v1.2.x/api-reference/notifications/subscribe.md): Subscribe to notifications for given topics. The client will receive
notifications for the topics it has subscribed to. The client can
subscribe to multiple topics.
- [GetCommitmentInfo](https://docs.primev.xyz/v1.2.x/api-reference/provider/getcommitmentinfo.md): GetCommitmentInfo is called by the provider to retrieve the commitment information.
- [GetMinStake](https://docs.primev.xyz/v1.2.x/api-reference/provider/getminstake.md): GetMinStake is called by the provider to get the minimum stake required to be in the provider registry.
- [GetProviderReward](https://docs.primev.xyz/v1.2.x/api-reference/provider/getproviderreward.md): GetProviderReward is called by the provider to retrieve their current reward balance
without withdrawing it from the bidder registry.
- [GetStake](https://docs.primev.xyz/v1.2.x/api-reference/provider/getstake.md): GetStake is called by the provider to get its stake in the provider registry.
- [ReceiveBids](https://docs.primev.xyz/v1.2.x/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 included.
- [SendProcessedBids](https://docs.primev.xyz/v1.2.x/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.
- [Stake](https://docs.primev.xyz/v1.2.x/api-reference/provider/stake.md): Stake is called by the provider to register or add to its stake in the provider registry.
- [Unstake](https://docs.primev.xyz/v1.2.x/api-reference/provider/unstake.md): Unstake is called by the provider to request a unstake from the provider registry.
- [WithdrawProviderReward](https://docs.primev.xyz/v1.2.x/api-reference/provider/withdrawproviderreward.md): WithdrawProviderReward is called by the provider to withdraw their accumulated rewards
from the bidder registry contract.
- [WithdrawStake](https://docs.primev.xyz/v1.2.x/api-reference/provider/withdrawstake.md): WithdrawStake is called by the provider to withdraw its stake from the provider registry.
- [null](https://docs.primev.xyz/v1.2.x/concepts/actors.md)
- [Bid Decay Mechanism](https://docs.primev.xyz/v1.2.x/concepts/bids/bid-decay-mechanism.md): Learn about how bids decay in value in real time
- [Bid Structure](https://docs.primev.xyz/v1.2.x/concepts/bids/bid-structure.md)
- [Understanding Bidder Deposit Rules](https://docs.primev.xyz/v1.2.x/concepts/bids/bidder-deposit.md)
- [null](https://docs.primev.xyz/v1.2.x/concepts/bids/reverting-txns.md)
- [Builder Attribution](https://docs.primev.xyz/v1.2.x/concepts/builder-attribution.md): Understanding how builders are identified and attributed in mev-commit
- [null](https://docs.primev.xyz/v1.2.x/concepts/commitments.md)
- [Bridging Details](https://docs.primev.xyz/v1.2.x/concepts/mev-commit-chain/bridging-details.md)
- [Chain Details](https://docs.primev.xyz/v1.2.x/concepts/mev-commit-chain/chain-details.md)
- [Differences Between Ethereum and mev-commit Chain](https://docs.primev.xyz/v1.2.x/concepts/mev-commit-chain/differences-between-ethereum-and-mev-commit-chain.md)
- [Understanding mev-commit](https://docs.primev.xyz/v1.2.x/concepts/network-overview.md)
- [null](https://docs.primev.xyz/v1.2.x/concepts/oracle.md)
- [Security & Privacy](https://docs.primev.xyz/v1.2.x/concepts/privacy.md)
- [mev-commit Points Program](https://docs.primev.xyz/v1.2.x/concepts/rewards-and-slashing/points.md)
- [Rewards and Slashing](https://docs.primev.xyz/v1.2.x/concepts/rewards-and-slashing/rewards-and-slashing.md)
- [Solvers](https://docs.primev.xyz/v1.2.x/concepts/solvers.md)
- [null](https://docs.primev.xyz/v1.2.x/concepts/validator-considerations.md)
- [What is mev-commit?](https://docs.primev.xyz/v1.2.x/concepts/what-is-mev-commit.md)
- [Bidder API](https://docs.primev.xyz/v1.2.x/developers/bidder-api/bidder-api.md)
- [Managing Your Bidder Deposit](https://docs.primev.xyz/v1.2.x/developers/bidder-api/bidder-deposit.md)
- [Docker Container for Bidder Node](https://docs.primev.xyz/v1.2.x/developers/bidder-api/docker-bidder.md)
- [Tools for Bid Submission](https://docs.primev.xyz/v1.2.x/developers/bidder-api/tools-for-bid-submission.md)
- [null](https://docs.primev.xyz/v1.2.x/developers/contracts.md)
- [null](https://docs.primev.xyz/v1.2.x/developers/debugging.md)
- [FAST RPC API](https://docs.primev.xyz/v1.2.x/developers/fast-rpc-api.md)
- [Hyperliquid (Early Access)](https://docs.primev.xyz/v1.2.x/developers/networks/hyperliquid.md)
- [Mev-commit Mainnet](https://docs.primev.xyz/v1.2.x/developers/networks/mainnet.md)
- [Mev-commit Testnet](https://docs.primev.xyz/v1.2.x/developers/networks/testnet.md)
- [Provider API](https://docs.primev.xyz/v1.2.x/developers/provider-api.md)
- [Run mev-commit Chain Node](https://docs.primev.xyz/v1.2.x/developers/run-mev-commit-chain-node.md)
- [System Requirements](https://docs.primev.xyz/v1.2.x/developers/system-requirements.md)
- [Bidder Best Practices](https://docs.primev.xyz/v1.2.x/get-started/bidders/best-practices.md)
- [Bidder CLI application](https://docs.primev.xyz/v1.2.x/get-started/bidders/bidder-cli.md)
- [Bidder Node Commands](https://docs.primev.xyz/v1.2.x/get-started/bidders/bidder-node-commands.md): This guide covers how to interact with your bidder node.
- [Using the Bridge UI](https://docs.primev.xyz/v1.2.x/get-started/bridge/bridge.md): How to bridge ETH between L1 and mev-commit using the web interface
- [Bridge CLI](https://docs.primev.xyz/v1.2.x/get-started/bridge/bridge-cli.md)
- [FAST RPC](https://docs.primev.xyz/v1.2.x/get-started/fastrpc.md)
- [Querying for Proposers](https://docs.primev.xyz/v1.2.x/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.
- [Consuming Bids from mev-commit](https://docs.primev.xyz/v1.2.x/get-started/providers/consuming-bids.md)
- [Registering as a Provider](https://docs.primev.xyz/v1.2.x/get-started/providers/registering-a-provider.md)
- [Sending Commitments](https://docs.primev.xyz/v1.2.x/get-started/providers/sending-commitments.md)
- [Withdraw Stake](https://docs.primev.xyz/v1.2.x/get-started/providers/withdraw.md): Withdraws the stake from the provider registry.
- [Quickstart your mev-commit node](https://docs.primev.xyz/v1.2.x/get-started/quickstart.md): This guide covers everything you need to set up your mev-commit node.
- [Relay Integration Guide](https://docs.primev.xyz/v1.2.x/get-started/relays.md)
- [Eigenlayer Opt-in](https://docs.primev.xyz/v1.2.x/get-started/validators/eigenlayer.md): Opt into mev-commit by natively restaking to our AVS.
- [Lido Opt-in](https://docs.primev.xyz/v1.2.x/get-started/validators/lido.md): Opt into mev-commit using Validators registered through Lido.
- [Rocket Pool Opt-in](https://docs.primev.xyz/v1.2.x/get-started/validators/rocketpool.md): Opt into mev-commit using Validators registered through Rocket Minipools.
- [Symbiotic Opt-in](https://docs.primev.xyz/v1.2.x/get-started/validators/symbiotic.md): Opt into mev-commit by ERC20 restaking with the MevCommitMiddleware contract through Symbiotic.
- [Validator Guide](https://docs.primev.xyz/v1.2.x/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.
- [Vanilla Opt-in](https://docs.primev.xyz/v1.2.x/get-started/validators/vanilla.md): Opt into mev-commit by simply staking ETH.
- [Welcome to Primev](https://docs.primev.xyz/v1.2.x/get-started/welcome-to-primev.md): Primev's mev-commit makes Ethereum FAST by enabling preconfirmations and new types of mev using an encrypted mempool, enhancing yield for opted-in validators.
- [Eigenlayer Operator Registration](https://docs.primev.xyz/v1.2.x/knowledge-base/eigenlayer-operator-registration.md): 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/v1.2.x/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.
- [How Do You Provide A Commitment for Execution?](https://docs.primev.xyz/v1.2.x/knowledge-base/how-do-preconfs-work.md): Learn what providers do during an execution preconfirmation.
- [How to Price A Bid](https://docs.primev.xyz/v1.2.x/knowledge-base/how-to-price-a-bid.md): Learn how to find the sweet spot for competitive bids.
- [Introduction](https://docs.primev.xyz/v1.2.x/knowledge-base/introduction.md): A collection of answers to frequently asked questions.
- [What Happens During An Execution Preconfirmation?](https://docs.primev.xyz/v1.2.x/knowledge-base/what-happens-during-an-execution-preconf.md): Learn about what happens behind the scenes during an execution preconfirmation.
- [What is the Deposit Amount?](https://docs.primev.xyz/v1.2.x/knowledge-base/what-is-deposit-amount.md): Learn about deposit amounts required for bidding and their significance.
- [What is Execution Preconfirmations?](https://docs.primev.xyz/v1.2.x/knowledge-base/what-is-execution-preconfirmations.md)
- [What is Foundry?](https://docs.primev.xyz/v1.2.x/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 do I receive the same commitment when resending a bid?](https://docs.primev.xyz/v1.2.x/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.
- [Why is cast necessary for mev-commit chain interactions?](https://docs.primev.xyz/v1.2.x/knowledge-base/why-is-cast-necessary-for-mev-commit-chain-interactions.md)