priliminary OEV Network docs #12

Ashar2shahid · 2024-06-21T16:41:16Z

No description provided.

github-actions · 2024-06-21T16:44:06Z

Visit the preview URL for this PR (updated for commit 04d6ca8):

https://oev-docs--pr12-new-oev-docs-0y2wddya.web.app

_{(expires Wed, 10 Jul 2024 04:23:48 GMT)}

_{🔥 via Firebase Hosting GitHub Action 🌎}

_{Sign: 6915b094b5ba83fde754632ba50c1ee9406d433f}

Siegrift

In general 👍 LGTM - gj.

I read all of the content and commented on everything that stand out to me.

docs/reference/oev-network/overview/oev-network.md

docs/reference/oev-network/overview/auction-cycle.md

docs/reference/oev-network/searchers/understanding-auctioneer.md

docs/reference/oev-network/searchers/auctioneer-reference.md

Co-authored-by: Emanuel Tesař <[email protected]>

docs/reference/oev-network/searchers/submit-bids.md

docs/reference/oev-network/searchers/understanding-auctioneer.md

aquarat · 2024-06-24T08:57:42Z

I made some suggestions, looking good!

aquarat · 2024-06-24T09:47:44Z

Another note:
If you look at the preview site: https://oev-docs--pr12-new-oev-docs-0y2wddya.web.app/reference/oev-network/
I feel like this page needs something, like a pretty graphic or something. It's one of the user's first entry points into the docs of OEV.

aquarat · 2024-06-24T09:54:01Z

I've noticed that there's no specific section on reporting fulfilments (see https://oev-docs--pr12-new-oev-docs-0y2wddya.web.app/reference/oev-network/searchers/submit-bids.html#performing-the-oracle-update-using-the-awarded-bid ). There are sections for placing a bid, executing the award, etc.

Co-authored-by: Aaron Scheiner <[email protected]>

andreogle

I used ChatGPT (v4o) to review and edit two of the pages - specifically the "OEV Network" and "Auction Cycle" pages. It's much more useful (and probably accurate) than me trying to point out any of the small syntax/grammar/spelling errors. I think the results are also quite a bit more readable. Let me know what you think and if I should keep going

docs/reference/oev-network/overview/oev-network.md

docs/reference/oev-network/overview/auction-cycle.md

docs/reference/oev-network/searchers/submit-bids.md

docs/reference/oev-network/searchers/arguments.md

docs/reference/oev-network/searchers/auctioneer-reference.md

andreogle · 2024-06-26T12:22:49Z

docs/reference/oev-network/searchers/collateral-protocol-fee.md

+const api3Contracts = require('@api3/contracts');
+
+const oevNetworkProvider = new JsonRpcProvider(OEV_NETWORK_RPC_URL);
+const OevAuctionHouseArtifact = await hre.artifacts.readArtifact(


I think it would be nice if this could be copy-pasted. It currently depends on hre, which isn't obvious to readers where it comes from. It also depends on the OevAuctionHouse contract being present somewhere and an undefined OEV_NETWORK_RPC_URL variable

docs/reference/oev-network/overview/auction-cycle.md

Siegrift

@Ashar2shahid Can you resolve all the PR suggestions that are done? They clutter the PR.

Some generic feedback:

When you go to https://oev-docs--pr12-new-oev-docs-0y2wddya.web.app/ there is no mention of OEV network. There should be a button for that and potentially hide other buttons (such as Airnode, etc...).

docs/reference/oev-network/dapps/index.md

docs/reference/oev-network/overview/assets/oev-auction-sequence.png

docs/reference/oev-network/overview/auction-cycle.md

docs/reference/oev-network/searchers/submit-bids.md

docs/reference/oev-network/searchers/understanding-auctioneer.md

Co-authored-by: Emanuel Tesař <[email protected]>

Siegrift

👍 LGTM

Feel free to merge anytime and I'll do final pass and create a new PR with my suggestions. @dcroote wanted to do the same, but we don't want to extend the scope of this PR more.

Ashar2shahid added 3 commits June 17, 2024 12:41

update sidebar changes

4c49124

update docs for new oev-network

2bfc705

Merge branch 'main' into new_oev_docs

6cde9da

Siegrift reviewed Jun 21, 2024

View reviewed changes

Ashar2shahid and others added 25 commits June 23, 2024 21:09

Update docs/reference/oev-network/overview/oev-network.md

6c3f975

Co-authored-by: Emanuel Tesař <[email protected]>

Update docs/reference/oev-network/overview/auction-cycle.md

3cea0a2

Co-authored-by: Emanuel Tesař <[email protected]>

Update docs/reference/oev-network/searchers/understanding-auctioneer.md

580d9ad

Co-authored-by: Emanuel Tesař <[email protected]>

Update docs/reference/oev-network/overview/auction-cycle.md

db90d3f

Co-authored-by: Emanuel Tesař <[email protected]>

Update docs/reference/oev-network/overview/auction-cycle.md

2a74412

Co-authored-by: Emanuel Tesař <[email protected]>

Update docs/reference/oev-network/overview/auction-cycle.md

542a299

Co-authored-by: Emanuel Tesař <[email protected]>

Update docs/reference/oev-network/overview/auction-cycle.md

3bcc334

Co-authored-by: Emanuel Tesař <[email protected]>

Update docs/reference/oev-network/overview/auction-cycle.md

ff184ee

Co-authored-by: Emanuel Tesař <[email protected]>

Update docs/reference/oev-network/overview/auction-cycle.md

8a130ac

Co-authored-by: Emanuel Tesař <[email protected]>

Update docs/reference/oev-network/overview/auction-cycle.md

309fbba

Co-authored-by: Emanuel Tesař <[email protected]>

Update docs/reference/oev-network/searchers/submit-bids.md

2eeb0b6

Co-authored-by: Emanuel Tesař <[email protected]>

Update docs/reference/oev-network/searchers/submit-bids.md

bdc388c

Co-authored-by: Emanuel Tesař <[email protected]>

Update docs/reference/oev-network/searchers/submit-bids.md

00dd8dd

Co-authored-by: Emanuel Tesař <[email protected]>

Update docs/reference/oev-network/searchers/submit-bids.md

3722394

Co-authored-by: Emanuel Tesař <[email protected]>

Update docs/reference/oev-network/searchers/submit-bids.md

f61d098

Co-authored-by: Emanuel Tesař <[email protected]>

Update docs/reference/oev-network/searchers/submit-bids.md

48d8d62

Co-authored-by: Emanuel Tesař <[email protected]>

Update docs/reference/oev-network/searchers/submit-bids.md

2318bc8

Co-authored-by: Emanuel Tesař <[email protected]>

Update docs/reference/oev-network/searchers/submit-bids.md

ec93f7d

Co-authored-by: Emanuel Tesař <[email protected]>

Update docs/reference/oev-network/searchers/submit-bids.md

a19b9b3

Co-authored-by: Emanuel Tesař <[email protected]>

Update docs/reference/oev-network/searchers/understanding-auctioneer.md

40bd92e

Co-authored-by: Emanuel Tesař <[email protected]>

Update docs/reference/oev-network/searchers/understanding-auctioneer.md

e510fd2

Co-authored-by: Emanuel Tesař <[email protected]>

Update docs/reference/oev-network/searchers/understanding-auctioneer.md

82cb5a3

Co-authored-by: Emanuel Tesař <[email protected]>

Update docs/reference/oev-network/searchers/understanding-auctioneer.md

8523b57

Co-authored-by: Emanuel Tesař <[email protected]>

Update docs/reference/oev-network/searchers/understanding-auctioneer.md

250a0be

Co-authored-by: Emanuel Tesař <[email protected]>

Update docs/reference/oev-network/searchers/understanding-auctioneer.md

7ac3165

Co-authored-by: Emanuel Tesař <[email protected]>