From 3963eb03302f3662c2497f9412471dad12ba7a5f Mon Sep 17 00:00:00 2001 From: Ashar2shahid <31223740+Ashar2shahid@users.noreply.github.com> Date: Mon, 8 Jul 2024 12:41:25 -0400 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Derek Croote --- .../oev-network/searchers/collateral-protocol-fee.md | 8 ++++---- .../oev-network/searchers/understanding-auctioneer.md | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/reference/oev-network/searchers/collateral-protocol-fee.md b/docs/reference/oev-network/searchers/collateral-protocol-fee.md index ae078cc0..73574158 100644 --- a/docs/reference/oev-network/searchers/collateral-protocol-fee.md +++ b/docs/reference/oev-network/searchers/collateral-protocol-fee.md @@ -28,17 +28,17 @@ In the event that the oracle update is fulfilled, the searcher is refunded the collateral and is charged a protocol fee. The protocol fee is also a percentage of the bid amount. -If the oracle update is not fulfilled, the collateral is slashed +The collateral and protocol fee rates are configurable parameters within the +OevAuctionHouse contract and are configured by the API3 DAO. | Parameter | Value | | ------------------------ | ----- | | collateralInBasisPoints | 1000 | | protocolFeeInBasisPoints | 0000 | -::: tip +::: warning -The collateral and protocol fee rates are configurable parameters within the -OevAuctionHouse contract and are configured by the API3 DAO. +If the oracle update is not fulfilled, the collateral is slashed ::: diff --git a/docs/reference/oev-network/searchers/understanding-auctioneer.md b/docs/reference/oev-network/searchers/understanding-auctioneer.md index f2daab5b..4d3e8f3e 100644 --- a/docs/reference/oev-network/searchers/understanding-auctioneer.md +++ b/docs/reference/oev-network/searchers/understanding-auctioneer.md @@ -32,7 +32,7 @@ computed. This is because the validity of a bid is at most meaning that the state of the auctioneer can be computed using the logs from the last 48 hours (accounting for fulfillment reporting window). -All relevant OevAuctionHouse logs are fetched ordered chronologically and +All relevant OevAuctionHouse logs are fetched, ordered chronologically, and processed in sequence. For each PlacedBid event, the bid details are decoded and stored. If the bid is for an unknown chain/proxy combination it is ignored. Similarly, the bid is ignored if the bid details cannot be decoded.