From db44d7b1895d9a88e52ed82703e1fbda64fcd34f Mon Sep 17 00:00:00 2001 From: Tesa Ho <49603019+tesaho@users.noreply.github.com> Date: Thu, 6 Jun 2024 22:00:36 +0800 Subject: [PATCH] Update mev-share.mdx Updated for grammar. --- docs/flashbots-protect/mev-share.mdx | 30 +++++++++++++++------------- 1 file changed, 16 insertions(+), 14 deletions(-) diff --git a/docs/flashbots-protect/mev-share.mdx b/docs/flashbots-protect/mev-share.mdx index 015cf1e5..35538521 100644 --- a/docs/flashbots-protect/mev-share.mdx +++ b/docs/flashbots-protect/mev-share.mdx @@ -10,7 +10,7 @@ import ProtectButton from '@site/src/components/ProtectButton'; MEV-Share enables users to reclaim up to 90% of the MEV generated by their transactions, the rest of which is paid to searchers and builders. By default, transactions from Protect users are directed to the Flashbots [MEV-Share Node](/flashbots-mev-share/introduction), which facilitates this return. Users are automatically connected to the [Stable](/flashbots-protect/mev-share#stable-configuration) configuration, a setting continuously optimized by Flashbots to balance efficient execution and protection against harmful MEV. This document provides a guide on the mechanism and various configurations of MEV-Share. -Advanced users can exert more control over their transactions and preferences through the advanced panel or by manually configuring their Protect RPC request. +Advanced users can customize their transactions and preferences through the advanced panel or by manually configuring their Protect RPC request. @@ -21,7 +21,7 @@ Advanced users can exert more control over their transactions and preferences th The Stable configuration is the default configuration for Protect RPC. No query parameters are specified to use it. ```url -https://rpc.flashbots.net +https://rpc.flashbots.net/fast ``` Currently, this configuration shares the following information: @@ -30,7 +30,7 @@ Currently, this configuration shares the following information: - `default_logs` Partial logs (the pool id and the fact that a swap was made) for curve, balancer, and uniswapV2/V3-style trades - Transactions are only forwarded to the Flashbots block builder -This may change over time as we gather more data and fine-tune the configuration to maximize benefits. +This may change as the configuration is tuned to maximize benefits. ### Max Privacy @@ -50,7 +50,7 @@ To use Protect with the maximum kickback, set _all_ hints in your Protect RPC UR https://rpc.flashbots.net?hint=calldata&hint=contract_address&hint=function_selector&hint=logs&hint=hash ``` -This configuration provides searchers with comprehensive details about your transaction, giving them better chance to identify more MEV opportunities and to return more MEV kickback to you. +This configuration provides searchers with comprehensive details about your transaction, giving them a better chance to identify more MEV opportunities and return MEV refunds. ## Examples @@ -58,7 +58,7 @@ Here are some examples of configurations that you might choose, depending on you |
Goal
| Flashbots Protect RPC URL | | --- | --- | -| Stable | `https://rpc.flashbots.net` | +| Stable | `https://rpc.flashbots.net/fast` | | Max Privacy | `https://rpc.flashbots.net?hint=hash` | | Max Kickback | `https://rpc.flashbots.net/?hint=calldata&hint=contract_address&hint=function_selector&hint=logs&hint=hash` | | Add Builders (share with other builders for faster inclusion) | `https://rpc.flashbots.net?builder=flashbots&builder=XYZ` | @@ -70,7 +70,7 @@ The Protect RPC uses query parameters within the URL to convey your preferences. ### Hints -To customize your hint setup, use the hint parameter to control the visibility of your transaction data to searchers. If no hints are provided, the default [Stable](/flashbots-protect/mev-share#stable-configuration) hint configuration will be used. If you specify one or more hints, any hint that is _not_ included will be disabled. +To customize your hint setup, use the hint parameter to control the visibility of your transaction data to searchers. The default [Stable](/flashbots-protect/mev-share#stable-configuration) hint configuration will be used if no hints are provided. If you specify one or more hints, any hint that is _not_ included will be disabled. @@ -80,11 +80,11 @@ Here is an example: https://rpc.flashbots.net?hint=calldata&hint=logs&hint=hash ``` -This configuration shares the calldata, logs, and hash of your transaction with searchers. It does not share the contract address or function selector. +This configuration shares calldata, logs, and transaction hash with searchers. It does not share the contract address or function selector. ### Builders -To designate the builders who will receive your transactions, use the `builder` parameter. This parameter can be repeated multiple times to include multiple builders. The builders listed below are currently supported. +Designate which builders will receive your transaction with the `builder` parameter. This parameter can be repeated multiple times to include different builders. The builders listed below are currently supported. Note that all transactions are shared with the Flashbots block builder, even if it is not explicitly specified. @@ -96,22 +96,24 @@ It's important to understand that while adding more builders can increase your t https://rpc.flashbots.net?builder=ABC&builder=XYZ ``` -This configuration sends your transaction to the ABC block builder and the XYZ block builder, as well as the Flashbots block builder. +This configuration sends your transaction to ABC block builder, XYZ block builder, and Flashbots block builder. ### Refunds -You can tailor your refund settings using the refund parameter. This determines the distribution of the searcher's payment among different addresses if your transaction is bundled. If not specified, the transaction originator (tx.origin) will by default receive 90% of the searcher's payment. +You can tailor your refund settings using the refund parameter. This determines the distribution of the searcher's payment among different addresses for bundled transactions. If not specified, the transaction originator (tx.origin) will by default receive 90% of the searcher's payment. -The refund parameter contains two colon-separated values: an address for the refund and the percentage of the searcher's payment to be refunded. To distribute the payment across multiple addresses, append a new refund parameter for each. +The refund parameter contains two colon-separated values: an address for the refund and the percentage of the searcher's payment to be refunded. To distribute the payment across multiple addresses, append a new refund parameter for each address. Here is an example of a refund parameter that sends 10% of the searcher's payment to the address `userAddr`: -```url +```URL https://rpc.flashbots.net?refund=userAddr:10 ``` -All percentages in the refund parameters must total less than 100. The remaining percentage, inferred from 100 - total refund percentages, is the payment to the validator. Note that keeping a larger percentage of the refund may result in longer inclusion times, because it reduces the payment to the validator. +The sum of all refund percentages must be less than 100. The remaining percentage, inferred from 100 - total refund percentages, is the payment to the validator. + +**Note**: Keeping a larger percentage of the refund may result in longer block inclusion times as it reduces the payment to the validator. ### Priority fee -When sending private transaction to rpc endpoint you should set priority fee (tips) to be strictly greater than zero. Transactions with 0 priority fee will not be shared with block builders and included on chain, unless they are bundled by a searcher via MEV-Share. +When sending a private transaction to an RPC endpoint, the priority fee (tips) should be greater than zero. A transaction with a 0 priority fee will not be shared with block builders and will only be included on-chain if a searcher bundles them via MEV-Share.