You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: get-started/providers/consume-bids-mev-commit.mdx
+10-8Lines changed: 10 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,15 +3,17 @@ title: Consuming Bids from Mev-Commit
3
3
sidebarTitle: Consuming Bids
4
4
---
5
5
6
-
Provider nodes that have a stake in the mev-commit registry will start receiving bids on the mev-commit p2p network from bidders. In order to see the incoming bids, the providers need to communicate with the provider API using the RPC clients or the HTTP APIs.
6
+
Provider nodes that have a stake in the mev-commit registry will 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 using one of the available options below.
7
7
8
-
Once a provider sees a bid and decides to accept or reject it, they send the status to the mev-commit node. If the bid is ACCEPTED, a signed commitment is sent back to the bidder and the mev-commit node will issue a transaction to the mev-commit chain to record the commitment.
8
+
Once a provider sees a bid and decides to accept or reject it, they send a status to their mev-commit node. If the bid is ACCEPTED, a signed commitment is sent back to the bidder and the provider's mev-commit node will send a transaction to the mev-commit chain to record the commitment.
9
9
10
-
It is the provider's responsibility to deliver inclusion of the transactions once they make a commitment. If they win or influence the mev-boost auction and they include the transactions correctly, the bid rewards will be settled by the oracle and made available to the provider. If the bid is rejected, no commitment is made and no response is sent to the network. There is no reward or penalty for rejecting bids. The accept and reject decisioning logic is left up to the provider.
10
+
It is the provider's responsibility to ensure inclusion of transactions on L1, relevant to accepted bids, once they make a commitment. If the provider wins the mev-boost auction and includes transactions correctly, bid amounts will be settled and rewarded to the provider.
11
11
12
-
There are 4 options to communicate with the API
12
+
If a bid is rejected by a provider, no commitment is made and no response is sent to the p2p network. There is no reward or penalty for rejecting bids, decision logic is left up to the provider.
13
13
14
-
* We recommend using the official go RPC client to communicate with the mev-commit API. In order to use this in go code, you can go get the mev-commit package and then import the generated client.
14
+
There are 4 options for a provider to communicate with their mev-commit node
15
+
16
+
* We recommend using the official go RPC client to communicate with your mev-commit node. In order to programmatically use this client in go, you can go get the mev-commit package and then import the generated client.
15
17
16
18
- For Go developers, leveraging the official Go RPC client is the recommended approach. Start by installing the mev-commit package:
17
19
@@ -77,7 +79,7 @@ There are 4 options to communicate with the API
77
79
}
78
80
```
79
81
80
-
There is an [example implementation](https://github.com/primevprotocol/mev-commit/tree/main/examples/provideremulator) of a dummy provider client that can be found in the repository which blindly accepts all the bids it sees. This could be a good starting point for providers to use if they are trying to integrate a Golang project in.
81
-
* 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). The protobuf files are available in the repository.
82
+
There is an [example implementation](https://github.com/primevprotocol/mev-commit/tree/main/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.
83
+
* 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/primevprotocol/mev-commit).
82
84
* Check the [API docs](https://primev-24.mintlify.app/api-reference/provider/sendprocessedbids) to use the REST APIs. The RPC APIs are also available on the HTTP server.
83
-
* Users can use the protobuf files to generate client in language of their choice.
85
+
* Users can use the protobuf files to generate a client in language of their choice.
Copy file name to clipboardExpand all lines: get-started/providers/register-a-provider.mdx
+13-7Lines changed: 13 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,10 @@
1
-
In order to register as a provider in the mev-commit network, you have to stake some ETH on the provider registry. This adds credibility to the commitments that you'll be issuing, as the stake may be slashed in the event of breaking a commitment, such as committing to a preconfirmation bid and not including the transaction in a block. Once the provider node is registered on the network, other nodes will connect to it and the provider node should start seeing bids come in.
1
+
To register on the mev-commit network, providers need to stake some ether with 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.
2
+
3
+
Once a provider is registered on the network, other nodes will connect to it and the provider node should see bids come in.
2
4
3
5
You can use the provider API to check and add stake.
4
6
5
-
* Check the stake
7
+
* Check stake
6
8
7
9
```shell
8
10
> curl localhost:13523/v1/provider/get_stake | jq
@@ -11,9 +13,9 @@ You can use the provider API to check and add stake.
11
13
}
12
14
```
13
15
14
-
In order to stake, we need to first add funds to the Ethereum wallet created for the node on the mev-commit chain.
16
+
In order to stake, first fund the mev-commit chain account relevant to your node.
15
17
16
-
* Get the wallet address of the node
18
+
* Get the account address of your node
17
19
18
20
```shell
19
21
> curl localhost:13523/topology | jq
@@ -31,7 +33,7 @@ You can use the provider API to check and add stake.
31
33
"blocked_peers": null
32
34
}
33
35
```
34
-
*Add funds to the account. Currently for the testnet, you can use the Primev account to get some testnet ETH. This can be done using the cast command:
36
+
*Fund your account with ether on the mev-commit chain. Currently for the testnet, you can use a faucet account to get some mev-commit chain ether. This can be done using the cast command:
@@ -41,14 +43,18 @@ You can use the provider API to check and add stake.
41
43
```
42
44
43
45
This command will transfer 100 ETH on mev-commit to your `$ADDRESS` which should be enough to get started.
44
-
* Check the minimum amount that can be staked, and consider staking a multiple of it. Bidders will only connect to providers which have stake higher than this minimum, and the larger your stake, the greater the credibility behind your commitments. The amount is set in `wei`
46
+
47
+
Alternatively, use the bridge from Holesky to fund your account. See [bridging-and-fees](https://docs.primev.xyz/get-started/bidders/bridging-and-fees).
48
+
49
+
* 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`.
@@ -58,4 +64,4 @@ You can use the provider API to check and add stake.
58
64
}
59
65
```
60
66
61
-
Once you have staked, you should seeing peers getting connected in the logs within a few minutes. You can check the `/topology` endpoint again to verify that you have some connected peers.
67
+
Once staked, peer connection logs should appear within a few minutes. You can check the `/topology` endpoint again to verify connected peers.
0 commit comments