diff --git a/README.md b/README.md index d93e8e7d..bd5dde01 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,7 @@ Environment Variables ===================== - **ETHEREUM_RPC_URL** - Ethereum RPC endpoint. Can not be the same as FLASHBOTS_RPC_URL - **PRIVATE_KEY** - Private key for the Ethereum EOA that will be submitting Flashbots Ethereum transactions +- **BUNDLE_EXECUTOR_ADDRESS** - BundleExecutor.sol deployed address - **FLASHBOTS_RELAY_SIGNING_KEY** _[Optional, default: random]_ - Flashbots submissions require an Ethereum private key to sign transaction payloads. This newly-created account does not need to hold any funds or correlate to any on-chain activity, it just needs to be used across multiple Flashbots RPC requests to identify requests related to same searcher. Please see https://docs.flashbots.net/flashbots-auction/searchers/faq#do-i-need-authentication-to-access-the-flashbots-relay - **HEALTHCHECK_URL** _[Optional]_ - Health check URL, hit only after successfully submitting a bundle. - **MINER_REWARD_PERCENTAGE** _[Optional, default 80]_ - 0 -> 100, what percentage of overall profitability to send to miner. @@ -15,7 +16,7 @@ Environment Variables Usage ====================== 1. Generate a new bot wallet address and extract the private key into a raw 32-byte format. -2. Deploy the included BundleExecutor.sol to Ethereum, from a secured account, with the address of the newly created wallet as the constructor argument +2. Deploy the included BundleExecutor.sol to Ethereum, from a secured account, with the address of the newly created wallet as the constructor argument, and set the BUNDLE_EXECUTOR_ADDRESS env variable to the contract address 3. Transfer WETH to the newly deployed BundleExecutor _It is important to keep both the bot wallet private key and bundleExecutor owner private key secure. The bot wallet attempts to not lose WETH inside an arbitrage, but a malicious user would be able to drain the contract._