Skip to content

Commit 3de565d

Browse files
authored
Revamp protect docs with new settings guide (#578)
* Revamp protect docs with new settings guide * Fix broken links * Capitalize titles and add extra settings * Fix bundle cache API link
1 parent 0204e0f commit 3de565d

File tree

16 files changed

+217
-152
lines changed

16 files changed

+217
-152
lines changed

docs/flashbots-auction/advanced/rpc-endpoint.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -402,7 +402,7 @@ example response:
402402

403403
#### `privacy`
404404

405-
By default, transactions are sent to the Flashbots MEV-Share Node with the default [Stable](/flashbots-protect/mev-share#stable-configuration) configuration. The `privacy` parameter allows you to specify your own privacy parameters.
405+
By default, transactions are sent to the Flashbots MEV-Share Node with the default [Stable](/flashbots-protect/mev-refunds#stable-configuration) configuration. The `privacy` parameter allows you to specify your own privacy parameters.
406406

407407
| Param | Type Info | Description |
408408
| --- | --- | --- |

docs/flashbots-mev-share/introduction.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Users send their transactions to a specialized actor called a MEV-Share Node. Th
2020
At the moment, MEV-Share Nodes ony accept backruns.
2121

2222
## How do I use MEV-Share?
23-
The most simple way to use MEV-Share is by sending transactions to [Flashbots Protect](/flashbots-protect/quick-start), which leverages the [Flashbots MEV-Share Node](/flashbots-protect/mev-share). Wallet and application developers should check out the [Flashbots Protect MEV-Share section](/flashbots-protect/mev-share) for information about integrating and configuring the Flashbots MEV-Share Node.
23+
The most simple way to use MEV-Share is by sending transactions to [Flashbots Protect](/flashbots-protect/quick-start), which leverages the [Flashbots MEV-Share Node](/flashbots-protect/mev-refunds). Wallet and application developers should check out the [Flashbots Protect MEV-Share section](/flashbots-protect/mev-refunds) for information about integrating and configuring the Flashbots MEV-Share Node.
2424

2525
## How do I search on MEV-Share?
2626
Searchers should see the [Getting Started](/flashbots-mev-share/searchers/getting-started) guide for a walkthrough of MEV-Share and how it differs from traditional searching.

docs/flashbots-mev-share/orderflow-providers.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
title: For Orderflow Providers
33
---
44

5-
Flashbots runs a MEV-Share Node that can be used by sending transactions to [Flashbots Protect](/flashbots-protect/quick-start). Wallets and application developers should see the [Protect MEV-Share Node guide](/flashbots-protect/mev-share) to configure your integration.
5+
Flashbots runs a MEV-Share Node that can be used by sending transactions to [Flashbots Protect](/flashbots-protect/quick-start). Wallets and application developers should see the [Protect MEV-Share Node guide](/flashbots-protect/mev-refunds) to configure your integration.

docs/flashbots-mev-share/release-notes/2023-07.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
## customized refunds
44

5-
Configure the percent(s) and recipient(s) for MEV-Share refunds by adding the [`refund`](/flashbots-protect/mev-share#refunds) query parameter to Protect RPC requests
5+
Configure the percent(s) and recipient(s) for MEV-Share refunds by adding the [`refund`](/flashbots-protect/settings-guide#refunds) query parameter to Protect RPC requests
66
or by adding `preferences.validity.refund` argument to the `eth_sendPrivateTransaction` JSON-RPC [method](/flashbots-auction/advanced/rpc-endpoint#eth_sendprivatetransaction).
77

88
## builder sharing
99
Share transactions and bundles with additional builders for faster inclusion.
1010

11-
- Users: [Opt in to share with registered builders](/flashbots-protect/mev-share#builders)
11+
- Users: [Opt in to share with registered builders](/flashbots-protect/settings-guide#builders)
1212
- Builders: [Register to receive bundles](https://github.com/flashbots/dowg#builders)
1313

1414
## debugging guide

docs/flashbots-mev-share/release-notes/2023-09.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## default logs hint
44

5-
A new hint which shares a subset of logs, as described in the [stable configuration](/flashbots-protect/mev-share#stable-configuration).
5+
A new hint which shares a subset of logs, as described in the [hints] settings(/flashbots-protect/settings-guide#hints).
66

77
Previously these logs were shared by default. Now, users of the private transaction API, Protect RPC, and bundle relay can also request to share these logs when customizing their settings.
88

docs/flashbots-mev-share/searchers/tutorials/flash-loan-arbitrage/bot.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Client libraries have been developed for the following programming languages (mo
2626

2727
To reiterate our goal, we need to find pending transactions from other Ethereum users and backrun them (send our transaction immediately after the user's transaction). If the user's trade moves the price enough, we'll arbitrage the trading pair between two exchanges for a profit.
2828

29-
As MEV-Share receives new transactions, it broadcasts them to searchers via the [Event Stream](/flashbots-mev-share/searchers/event-stream). Each transaction shares varying amounts of data via [hints](/flashbots-protect/mev-share#hints), but by default, transactions that trade on Uniswap, Balancer, or Curve will expose the trading pair's contract address in the log topics.
29+
As MEV-Share receives new transactions, it broadcasts them to searchers via the [Event Stream](/flashbots-mev-share/searchers/event-stream). Each transaction shares varying amounts of data via [hints](/flashbots-protect/mev-refunds#hints), but by default, transactions that trade on Uniswap, Balancer, or Curve will expose the trading pair's contract address in the log topics.
3030

3131
Here's an example of an event generated by a user who's (most likely) using MEV-Share's default privacy settings:
3232

@@ -141,7 +141,7 @@ _To read more about how the SSE stream works, see the [Event Stream docs](/flash
141141

142142
## Filtering Relevant Transactions
143143

144-
MEV-Share uses [**hints**](/flashbots-protect/mev-share#hints) to selectively share information about a transaction. Based on the hint preferences specifies by the user when connecting, the transactions (or bundles) they send will trigger events containing information about their transaction which is filtered according to their hint preferences.
144+
MEV-Share uses [**hints**](/flashbots-protect/mev-refunds#hints) to selectively share information about a transaction. Based on the hint preferences specifies by the user when connecting, the transactions (or bundles) they send will trigger events containing information about their transaction which is filtered according to their hint preferences.
145145

146146
In this guide, we're only concerned with the fields in `logs`: `address` and `topics`. Other fields not covered in this guide are detailed in the [Event Scheme docs](/flashbots-mev-share/searchers/event-stream#event-scheme).
147147

docs/flashbots-protect/additional-documentation/bundle-cache.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Once all the transactions you want to include in your bundle are added to the qu
4949

5050
If you're being helped with a whitehat recovery, we may provide a web interface for you to do this.
5151

52-
If you want to send a bundle directly, check out the [Flashbots Auction Docs](/flashbots-auction/quick-start#how-to-send-your-first-flashbots-bundle) for instructions on how to do this.
52+
If you want to send a bundle directly, check out the [Flashbots Builder Docs](/flashbots-auction/quick-start#how-to-send-your-first-flashbots-bundle) for instructions on how to do this.
5353

5454
## Fake Funds
5555

docs/flashbots-protect/additional-documentation/eth-sendPrivateTransaction.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ example response:
183183

184184
#### Privacy options
185185

186-
By default, transactions are sent to the Flashbots MEV-Share Node with the default [Stable](/flashbots-protect/mev-share#stable-configuration) configuration. The `privacy` parameter allows you to customize privacy settings:
186+
By default, transactions are sent to the Flashbots MEV-Share Node with the default [Stable](/flashbots-protect/mev-refunds#stable-configuration) configuration. The `privacy` parameter allows you to customize privacy settings:
187187

188188
| Parameter | Type | Description |
189189
| ---------- | ------------ | -------------------------------------------------------------------- |

docs/flashbots-protect/gas-fee-refunds.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: Gas Fee Refunds
66

77
Flashbots Protect users are automatically eligible to receive gas fee refunds. If Flashbots can include your transaction on chain for a lower price, you are eligible to receive a refund. This applies to both the RPC and the private transaction API.
88

9-
Gas fee refunds do not change how transactions are executed and users do not need to make any changes to be eligible for them. Gas fee refunds are calculated separately, and applied in addition to, refunds from [MEV-Share](/flashbots-protect/mev-share).
9+
Gas fee refunds do not change how transactions are executed and users do not need to make any changes to be eligible for them. Gas fee refunds are calculated separately, and applied in addition to, MEV refunds from [MEV-Share](/flashbots-protect/mev-refunds).
1010

1111
## Where do refunds come from
1212

@@ -34,11 +34,11 @@ The Flashbots block builder does not land 100% of blocks. In order to improve in
3434

3535
There are two ways to share with other builders:
3636
* Use [fast mode](/flashbots-protect/quick-start#faster-transactions) to share with all registered builders
37-
* Choose [specific builders](/flashbots-protect/mev-share#builders) to share transactions with
37+
* Choose [specific builders](/flashbots-protect/settings-guide#builders) to share transactions with
3838

3939
## Who receives refunds
4040

41-
For the RPC: The refund recipient is the address specified in the first [refund parameter](/flashbots-protect/mev-share#refunds) on an RPC request, if one is provided. Otherwise, refunds are sent to the transaction originator (`tx.origin`) by default.
41+
For the RPC: The refund recipient is the address specified in the first [refund parameter](/flashbots-protect/settings-guide#refunds) on an RPC request, if one is provided. Otherwise, refunds are sent to the transaction originator (`tx.origin`) by default.
4242

4343
For the private transaction API: The refund recipient is the signer used on the `eth_sendPrivateTransaction` request.
4444

docs/flashbots-protect/large-transactions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Large transaction allowlist
2+
title: Large Transaction Allowlist
33
---
44

55
Some projects may need to post larger transactions (measured in bytes) than the transaction pool allows. Flashbots bundles are not subject to the transaction pool size constraints. However, at the RPC level only transactions to certain contracts are allowed to be over 128kb.
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
title: MEV Refunds
3+
---
4+
5+
import ProtectButton from '@site/src/components/ProtectButton';
6+
7+
## Introduction
8+
9+
Flashbots Protect users are automatically eligible to receive MEV refunds from [MEV-Share](/flashbots-mev-share/introduction). If your transaction (eg. a large DEX swap) generates MEV, MEV-Share can help you reclaim a significant portion of this value. The remainder is split with searchers and validators to facilitate transaction inclusion.
10+
11+
By default, all Protect transactions use the [default](/flashbots-protect/settings-guide#default) privacy setting which is continuously optimized by Flashbots to balance efficient execution and protection against harmful MEV. Advanced users can customize their settings when configuring their RPC or by manually editing the query parameters their Protect RPC request.
12+
13+
<ProtectButton />
14+
15+
## Common privacy settings
16+
17+
You can customize how much information is shared about your transactions in MEV-Share. Each piece of information is called a "hint". Sharing more hints can increase refunds, while sharing fewer hints can increase privacy. Below are some common hint choices for different levels of privacy. See the complete [settings page](/flashbots-protect/settings-guide) for a full list of all settings you can apply to your RPC request.
18+
19+
### Default
20+
21+
To use the default privacy settings, you don't need to specify any query parameters.
22+
23+
```url
24+
https://rpc.flashbots.net
25+
```
26+
27+
Currently, this configuration shares the following information:
28+
29+
- The `hash` of all transactions
30+
- `default_logs` Partial logs (the pool id and the fact that a swap was made) for curve, balancer, and uniswapV2/V3-style trades
31+
32+
### Max Privacy
33+
34+
To use Protect with full privacy, set _only_ the `hash` hint in your Protect RPC URL:
35+
36+
```url
37+
https://rpc.flashbots.net?hint=hash
38+
```
39+
40+
This configuration ensures that all identifiable transaction data sent to the MEV-Share Node is concealed from searchers. However, it's important to note that this could make it more challenging for searchers to spot MEV opportunities, leading to a very likely decrease in your MEV refund.
41+
42+
### Max Refund
43+
44+
To use Protect with the maximum refund, set _all_ hints in your Protect RPC URL:
45+
46+
```url
47+
https://rpc.flashbots.net?hint=calldata&hint=contract_address&hint=function_selector&hint=logs
48+
```
49+
50+
This configuration provides searchers with comprehensive details about your transaction, giving them a better chance to identify more MEV opportunities and return MEV refunds.

docs/flashbots-protect/mev-share.mdx

Lines changed: 0 additions & 119 deletions
This file was deleted.

0 commit comments

Comments
 (0)