/* Wraps all code blocks to prevent overflow  */
div.min-w-full > pre.language-shell {
  white-space: pre-wrap; /* Wrap text */
  word-break: break-word; /* Prevents overflow by breaking long words */
  overflow-wrap: break-word; /* Ensures text breaks nicely */
}

.inline-card-header > a {
  height: 100%;
}

/* Adjusts card padding */
.inline-card-header > a > div {
  padding-left: 1.25rem;
  padding-right: 1.25rem;
}

/* Displays the logo and title of a card inline */
.inline-card-header > a > div > div {
  display: inline-block;
  vertical-align: middle;
}

.inline-card-header > a > div > h2 {
  display: inline-block;
  vertical-align: middle;
  margin: auto 0 auto 10px;
}

/* Adds back link styles to links within cards */
.inline-card-header div a {
  text-decoration: none;
  font-weight: 600;
  border-bottom: 1px solid rgb(var(--primary-light)) !important;
}

/* 
.inline-card-header > a > div {
  color: blue;
} */


Documentation

API Reference

Knowledge Base

RegisterStake is called by the provider to register its stake in the provider registry.

Register Stake

Get staked amount for provider in the provider registry.

Stake response

RegisterStake

Primev is building mev-commit; a credible commitment network used for preconfirmations & more

Welcome to Primev

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.

Quickstart

Quickstart Your mev-commit Node

Testnet Faucet

Opt into mev-commit with ease. This guide covers everything you need to do to passively interact with the mev-commit protocol as a validator.

Validators

Validator Guide

Relays

Relay Guide

Best Practices

Bidder Best Practices

Bidder Node Commands

Registering as a Provider

Consuming Bids

Consuming Bids from mev-commit

Sending Commitments

Use the pointers below to determine whether an upcoming proposer has opted in to mev-commit or not.

Querying for Proposers

Withdraws the stake from the provider registry.

Withdraw Stake

What is mev-commit?

Network Overview

Understanding mev-commit

Security & Privacy

Solvers

Bid Structure

Bidder Deposit

Understanding Bidder Deposit Rules

Learn about how bids decay in value in real time

Bid Decay

Bid Decay Mechanism

Chain Details

Ethereum vs mev-commit

Differences Between Ethereum and mev-commit Chain

Bridging Details

Rewards and Slashing

Validator Considerations

Testnet

mev-commit Testnet

System Requirements

Provider API

Bidder API

Managing Your Bidder Deposit

Tools for Bid Submission

Stake Validators Keys Manually

Manual Node Setup

Run mev-commit Chain Node

A collection of answers to frequently asked questions.

Introduction

Learn about deposit amounts required for bidding and their significance.

Deposit amount

What is the Deposit Amount?

Learn how to resolve the `failed to read msg: stream reset` error for provider nodes within the mev-commit network.

Failed to read message

How do I fix the error: "failed to read msg: stream reset"?

Discover what Foundry is and its role in smart contract development and interactions within the mev-commit ecosystem.

What is Foundry?

Using cast with mev-commit

Why is cast necessary for mev-commit chain interactions?

Understand why resending a bid in the mev-commit ecosystem results in receiving the same commitment.

Receiving same commitment on bid

Why do I receive the same commitment when resending a bid?

What is Execution Preconfirmations?

Learn how to find the sweet spot for competitive bids.

How to Price A Bid

Learn about what happens behind the scenes during an execution preconfirmation.

What Happens During A Preconf?

What Happens During An Execution Preconfirmation?

Learn what providers do during an execution preconfirmation.

How Do Preconfs Work?

How Do You Provide A Commitment for Execution?

Instructions for registering as an Eigenlayer operator for the mev-commit AVS, enabling validator opt-in via restaking.

Eigenlayer Operator Registration

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.

Receive Bids

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.

Send Processed Bids

GetMinStake is called by the provider to get the minimum stake required to be in the provider registry.

Retrieve Minimum Stake

GetStake is called by the provider to get its stake in the provider registry.

Retrieve Stake

Unstake is called by the provider to request a unstake from the provider registry.

Unstake Funds

WithdrawStake is called by the provider to withdraw its stake from the provider registry.

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.

Send Bid

GetDeposit is called by the bidder to get its deposit in the bidder registry.

Retrieve 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.

Add Deposit

Withdraw is called by the bidder to withdraw deposit from the bidder registry.

Withdraw Deposit

WithdrawFromWindows is called by the bidder node to withdraw funds from multiple windows.

Withdraw Deposit From Windows

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.

Add Auto Deposit

AutoDepositStatus is called by the bidder node to get the status of the auto deposit.

Get Auto Deposit Status

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.

Cancel Auto Deposit

GetValidators is called by the bidder to get the validators for a given epoch.

Get Validators

CancelTransaction is called by the provider to cancel a transaction sent from this wallet.

Cancel Transaction

GetPendingTransactions is called by the provider to get the pending transactions for the wallet.

Pending Transactions

GetTopology is called by the user to get the topology of the node. The topology
includes connectivity information about the node.

API Reference

Provider

Bidder

Debug

Register Stake

Path Parameters

Query Parameters

Response