Skip to content

Commit 0d06071

Browse files
authored
Update dApp docs according to the OEV Network changes (#260)
* Update dApp docs according to the OEV Network changes * Reintroduce the mixed oracle design section * Remove the best practices page from the sidebar
1 parent 40e47c1 commit 0d06071

File tree

6 files changed

+13
-98
lines changed

6 files changed

+13
-98
lines changed

docs/dapps/index.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,11 @@ Rent-seeking third parties can exploit this fact to extract funds from data feed
3636

3737
[Oracle Extractable Value (OEV)](https://medium.com/api3/oracle-extractable-value-oev-13c1b6d53c5b) is a subset of MEV that oracles have priority in extracting by batching additional operations with their updates.
3838
Furthermore, instead of searching for such OEV opportunities themselves, oracles can auction off this privilege.
39-
Api3 holds transparent and permissionless auctions for OEV opportunities on OEV Network, and [pays](/dapps/oev-rewards/) 80% of the auction proceeds to the respective dApps.
40-
OEV Rewards serves as a new and sustainable revenue stream for dApps.
39+
Api3 facilitates the capturing of such OEV opportunities, and pays 80% of the associated revenue to the respective partner dApps in the form of [OEV Rewards](/dapps/oev-rewards/), which serves as a new and sustainable revenue stream for them.
4140

4241
::: info ⚠️ Disclaimer
4342

44-
We refer you to the Api3 [terms and conditions](https://api3.org/terms-and-conditions/), which apply to all services and software provided by Api3 (including but not limited to data feeds, OEV Network, and any example OEV bots).
43+
We refer you to the Api3 [terms and conditions](https://api3.org/terms-and-conditions/), which apply to all services and software provided by Api3 (including but not limited to data feeds, and any example OEV bots).
4544
Nothing in this documentation nor related materials should be interpreted as financial, business, nor professional advice.
4645

4746
:::

docs/dapps/integration/contract-integration.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -150,12 +150,8 @@ For example, you can combine an `ETH/USD` Api3ReaderProxyV1 contract and a `wstE
150150
Some dApps choose to mix oracle solutions, either by refusing service if they are not in consensus, or by using one primarily and deferring to another in case of inconsistency.
151151

152152
In such setups, Api3 data feeds need to be treated differently due to OEV considerations.
153-
Specifically, the vast majority of OEV is extracted during times of volatility, and allowing other oracle solutions interfere during such times may result in the loss of a significant amount of OEV revenue.
154-
In practice, this will play out as an OEV searcher bidding a significant amount for a detected OEV opportunity, only to realize after the auction ends that the dApp now defers to a non-Api3 data feed and the OEV opportunity no longer exists.
155-
Such ambiguity will deter OEV searchers from your dApp or cause them to bid much less to hedge their risk, reducing your [OEV Rewards](/dapps/oev-rewards/).
156-
157-
The golden standard is only using Api3 data feeds, in which case OEV searchers will be able to bid on OEV opportunities with full confidence, knowing that they will be able to extract if they win the auction.
158-
If you must use Api3 data feeds as your primary source with another solution as a fallback, you should tolerate as much inconsistency as possible.
153+
Specifically, the vast majority of OEV is extracted during times of volatility, and allowing other oracle solutions interfere during such times may result in the loss of a significant amount of OEV revenue, reducing your [OEV Rewards](/dapps/oev-rewards/).
154+
The golden standard is only using Api3 data feeds, and if you must use Api3 data feeds as your primary source with another solution as a fallback, you should tolerate as much inconsistency as possible.
159155

160156
::: info 💡 Tip
161157

@@ -167,7 +163,7 @@ Based on our analysis, any less will hinder OEV extraction during times of high
167163
Note that using Api3 data feeds for only some asset prices still counts as a mixed design.
168164
Consider a lending platform that uses the ETH/USD Api3 data feed and the USDT/USD data feed from another oracle solution.
169165
A user takes out a USDT loan with ETH collateral, and the following price action renders the position liquidatable once the ETH/USD data feed is updated.
170-
Even if an OEV searcher detects the opportunity, they must consider that a rogue USDT/USD update by the other oracle solution may expose it to the public before they can claim it, leading them to avoid bidding a fair amount.
166+
However, a rogue USDT/USD update by the other oracle solution may expose the OEV opportunity to the public before it can be claimed for you.
171167

172168
::: info 💰 Financial
173169

docs/dapps/integration/security-considerations.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -95,14 +95,7 @@ Similarly, our OEV implementation uses this mechanism, ensuring OEV updates cont
9595
OEV updates provide identical guarantees to regular updates—they are on-chain aggregations of API provider-signed data—so they introduce no additional [data correctness](#data-correctness) risk.
9696
The OEV auction mechanism allows winners to frontrun updates of an artificially delayed base feed, a tradeoff designed to benefit the dApp.
9797

98-
Here's how the process works for auctions with a length of 30 seconds.
99-
The lifecycle of a data point consists of three phases:
100-
101-
1. From 0-30 seconds: OEV searchers examine the data point and place bids on potential OEV opportunities.
102-
2. From 30-60 seconds: If valid bids exist, the auction winner can update the data feed to capture OEV opportunities.
103-
3. After 60 seconds: The data point becomes publicly available for updates, including our update parameter-based updates.
104-
105-
dApps using our system will experience a 30–60 second delay in their data feed.
98+
dApps using our system will experience a 0–30 second delay in their data feed.
10699
While this delay concerns some users, we can evaluate its impact through a simple framework:
107100
Consider a dApp that generates `X1` revenue with its current oracle solution.
108101
Using Api3 data feeds would generate `X2` revenue (potentially lower than `X1` due to the delay) plus `Y` in OEV Rewards.

docs/dapps/oev-rewards/best-practices.md

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

docs/dapps/oev-rewards/index.md

Lines changed: 6 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ pageHeader: dApps → OEV Rewards
99

1010
dApps that use traditional data feeds are constantly exploited by MEV bots that manipulate the order of operations around individual data feed updates.
1111
In practice, this causes dApps to suffer significant and continuous financial losses.
12-
As the antidote, Api3's OEV Network auctions off to OEV searchers the privilege to determine the order of operations around data feed updates.
13-
80% of the [resulting revenue](#breaking-down-oev-rewards) is paid to the dApp in the form of OEV Rewards.
12+
As the antidote, Api3 enables OEV searchers to determine the order of operations around data feed updates.
13+
80% of the resulting revenue is paid to the dApp in the form of OEV Rewards.
1414

1515
::: info 💰 Financial
1616

@@ -22,46 +22,25 @@ There is none; OEV Rewards come at the expense of third parties who would otherw
2222

2323
Api3 data feeds work identically to traditional data feeds, which means that you do not need to modify your contracts in any way to use them.
2424
You can drop in Api3 data feeds to replace your current data feeds and immediately start earning OEV Rewards.
25-
If you want to maximize your OEV Rewards, make sure to check out our [guide for best practices.](/dapps/oev-rewards/best-practices)
2625

2726
## How to get onboard
2827

2928
Use [this form](https://api3dao.typeform.com/to/FHhFIL41) to get in contact with an Api3 representative who will walk you through the following steps:
3029

3130
1. We register your dApp for it to show up on the Api3 Market [integration page.](/dapps/integration/index.md#integration-information)
32-
2. You let us know which chains you operate on so we can start running the respective auctions.
31+
2. You let us know which chains you operate on and which data feeds you will use.
3332
::: info 💡 Tip
34-
Don't forget to notify us if you expand to new chains later on.
33+
Don't forget to notify us if you expand to new chains and data feeds later on.
3534
:::
36-
3. You let us know which data feeds you will use.
3735
If a gas grant is applicable, we purchase subscriptions for you and deploy an OEV Rewards-enabled Api3ReaderProxyV1 contract for each data feed.
3836
::: info 💡 Tip
3937
Alternatively, you can complete this step on your own using [Api3 Market.](https://market.api3.org/)
4038
:::
41-
4. You let us know an address where to receive the OEV Rewards.
39+
3. You let us know an address where to receive the OEV Rewards.
4240
::: info 💡 Tip
4341
OEV Rewards are paid in the native currency of your dApp's chain.
4442
The receiving address must be an EOA you control or a contract capable of receiving native currency payments.
4543
:::
46-
5. You [integrate](/dapps/integration/contract-integration) the OEV Rewards-enabled Api3ReaderProxyV1 contracts.
44+
4. You [integrate](/dapps/integration/contract-integration) the OEV Rewards-enabled Api3ReaderProxyV1 contracts.
4745

4846
At the end of each month, Api3 will make available a report and 80% of the OEV revenue in the native gas token of the network where your dApp is deployed, with the remainder retained as the protocol fee.
49-
50-
## Breaking down OEV Rewards
51-
52-
dApps receive 80% of the OEV revenue in the form of OEV Rewards.
53-
This revenue can be broken down into three parts:
54-
55-
1. Proceeds of the auctions held on OEV Network
56-
2. Revenue from OEV searching activity facilitated by Api3 to ensure a baseline level of competition in the auctions (e.g., with a 20% profit margin, which should be easily beaten by organic searchers)
57-
3. Revenue from MEV searching activity facilitated by Api3 as a failsafe for the above
58-
59-
::: info ℹ️ Info
60-
61-
The OEV and MEV searching activity facilitated by Api3 is strictly limited to using data that is already available to the public, as documented in the [OEV searcher docs.](/oev-searchers/)
62-
This can be audited retrospectively by referring to data on OEV Network and the chain that the dApp is on.
63-
64-
A side-effect of the above is that once organic searcher activity takes hold for a dApp, Api3 will no longer be able to generate searcher revenue, and the auction proceeds will constitute the entirety of the OEV Rewards.
65-
This will result in more efficient and robust capturing of OEV, and thus is a desirable outcome for the dApp.
66-
67-
:::

docs/dapps/sidebar.js

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,6 @@ module.exports = [
3333
{
3434
text: 'OEV Rewards',
3535
collapsed: false,
36-
items: [
37-
{ text: 'Getting paid', link: '/dapps/oev-rewards/' },
38-
{ text: 'Best practices', link: '/dapps/oev-rewards/best-practices' },
39-
],
36+
items: [{ text: 'Getting paid', link: '/dapps/oev-rewards/' }],
4037
},
4138
];

0 commit comments

Comments
 (0)