Skip to content

Commit 4a43308

Browse files
shaspitzshaspitz
authored
Merge pull request #256 from primev/v1.2
2 parents db4a4f7 + 01d84b5 commit 4a43308

File tree

127 files changed

+5604
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

127 files changed

+5604
-0
lines changed

‎docs.json‎

Lines changed: 200 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,206 @@
1010
"favicon": "favicon.svg",
1111
"navigation": {
1212
"versions": [
13+
{
14+
"version": "v1.2.x",
15+
"tabs": [
16+
{
17+
"tab": "Documentation",
18+
"groups": [
19+
{
20+
"group": "Get Started",
21+
"pages": [
22+
"v1.2.x/get-started/welcome-to-primev",
23+
"v1.2.x/get-started/quickstart",
24+
"v1.2.x/get-started/fastrpc",
25+
{
26+
"group": "Bridge",
27+
"icon": "bridge",
28+
"pages": [
29+
"v1.2.x/get-started/bridge/bridge",
30+
"v1.2.x/get-started/bridge/bridge-cli"
31+
]
32+
},
33+
{
34+
"group": "Validators",
35+
"icon": "list-check",
36+
"pages": [
37+
"v1.2.x/get-started/validators/validator-guide",
38+
"v1.2.x/get-started/validators/eigenlayer",
39+
"v1.2.x/get-started/validators/symbiotic",
40+
"v1.2.x/get-started/validators/vanilla"
41+
]
42+
},
43+
"v1.2.x/get-started/relays",
44+
{
45+
"group": "Bidders",
46+
"icon": "user-bounty-hunter",
47+
"pages": [
48+
"v1.2.x/get-started/bidders/best-practices",
49+
"v1.2.x/get-started/bidders/bidder-node-commands",
50+
"v1.2.x/get-started/bidders/bidder-cli"
51+
]
52+
},
53+
{
54+
"group": "Providers",
55+
"icon": "network-wired",
56+
"pages": [
57+
"v1.2.x/get-started/providers/registering-a-provider",
58+
"v1.2.x/get-started/providers/consuming-bids",
59+
"v1.2.x/get-started/providers/sending-commitments",
60+
"v1.2.x/get-started/providers/Querying-for-proposers",
61+
"v1.2.x/get-started/providers/withdraw"
62+
]
63+
}
64+
]
65+
},
66+
{
67+
"group": "Concepts",
68+
"pages": [
69+
"v1.2.x/concepts/what-is-mev-commit",
70+
"v1.2.x/concepts/actors",
71+
"v1.2.x/concepts/network-overview",
72+
"v1.2.x/concepts/privacy",
73+
"v1.2.x/concepts/commitments",
74+
"v1.2.x/concepts/solvers",
75+
"v1.2.x/concepts/builder-attribution",
76+
{
77+
"group": "Bids",
78+
"pages": [
79+
"v1.2.x/concepts/bids/bid-structure",
80+
"v1.2.x/concepts/bids/reverting-txns",
81+
"v1.2.x/concepts/bids/bidder-deposit",
82+
"v1.2.x/concepts/bids/bid-decay-mechanism"
83+
]
84+
},
85+
{
86+
"group": "Mev-commit Chain",
87+
"pages": [
88+
"v1.2.x/concepts/mev-commit-chain/chain-details",
89+
"v1.2.x/concepts/mev-commit-chain/differences-between-ethereum-and-mev-commit-chain",
90+
"v1.2.x/concepts/mev-commit-chain/bridging-details"
91+
]
92+
},
93+
{
94+
"group": "Rewards and Slashing",
95+
"pages": [
96+
"v1.2.x/concepts/rewards-and-slashing/rewards-and-slashing",
97+
"v1.2.x/concepts/rewards-and-slashing/points"
98+
]
99+
},
100+
"v1.2.x/concepts/oracle",
101+
"v1.2.x/concepts/validator-considerations"
102+
]
103+
},
104+
{
105+
"group": "Developers",
106+
"pages": [
107+
{
108+
"group": "Networks",
109+
"pages": [
110+
"v1.2.x/developers/networks/mainnet",
111+
"v1.2.x/developers/networks/hyperliquid",
112+
"v1.2.x/developers/networks/testnet"
113+
]
114+
},
115+
"v1.2.x/developers/system-requirements",
116+
"v1.2.x/developers/fast-rpc-api",
117+
"v1.2.x/developers/provider-api",
118+
{
119+
"group": "Bidder API",
120+
"pages": [
121+
"v1.2.x/developers/bidder-api/bidder-api",
122+
"v1.2.x/developers/bidder-api/bidder-deposit",
123+
"v1.2.x/developers/bidder-api/docker-bidder",
124+
"v1.2.x/developers/bidder-api/tools-for-bid-submission"
125+
]
126+
},
127+
"v1.2.x/developers/contracts",
128+
"v1.2.x/developers/debugging",
129+
"v1.2.x/developers/manual-start-mev-commit",
130+
"v1.2.x/developers/run-mev-commit-chain-node"
131+
]
132+
}
133+
]
134+
},
135+
{
136+
"tab": "API Reference",
137+
"groups": [
138+
{
139+
"group": "API Reference",
140+
"pages": [
141+
"v1.2.x/api-reference/introduction"
142+
]
143+
},
144+
{
145+
"group": "Provider",
146+
"pages": [
147+
"v1.2.x/api-reference/provider/receivebids",
148+
"v1.2.x/api-reference/provider/sendprocessedbids",
149+
"v1.2.x/api-reference/provider/registerstake",
150+
"v1.2.x/api-reference/provider/getminstake",
151+
"v1.2.x/api-reference/provider/getstake",
152+
"v1.2.x/api-reference/provider/unstake",
153+
"v1.2.x/api-reference/provider/withdraw_stake",
154+
"v1.2.x/api-reference/provider/getcommitmentinfo",
155+
"v1.2.x/api-reference/provider/withdrawproviderreward"
156+
]
157+
},
158+
{
159+
"group": "Bidder",
160+
"pages": [
161+
"v1.2.x/api-reference/bidder/sendbid",
162+
"v1.2.x/api-reference/bidder/getdeposit",
163+
"v1.2.x/api-reference/bidder/deposit",
164+
"v1.2.x/api-reference/bidder/withdraw",
165+
"v1.2.x/api-reference/bidder/withdrawfromwindows",
166+
"v1.2.x/api-reference/bidder/autodeposit",
167+
"v1.2.x/api-reference/bidder/autodepositstatus",
168+
"v1.2.x/api-reference/bidder/cancelautodeposit",
169+
"v1.2.x/api-reference/bidder/getbidinfo",
170+
"v1.2.x/api-reference/bidder/claimslashedfunds",
171+
"v1.2.x/api-reference/validator/getvalidators"
172+
]
173+
},
174+
{
175+
"group": "Notifications",
176+
"pages": [
177+
"v1.2.x/api-reference/notifications/subscribe"
178+
]
179+
},
180+
{
181+
"group": "Debug",
182+
"pages": [
183+
"v1.2.x/api-reference/debug/canceltx",
184+
"v1.2.x/api-reference/debug/pendingtxs",
185+
"v1.2.x/api-reference/debug/topology"
186+
]
187+
}
188+
]
189+
},
190+
{
191+
"tab": "Knowledge Base",
192+
"groups": [
193+
{
194+
"group": "Knowledge Base",
195+
"pages": [
196+
"v1.2.x/knowledge-base/introduction",
197+
"v1.2.x/knowledge-base/what-is-deposit-amount",
198+
"v1.2.x/knowledge-base/how-do-i-fix-the-error-failed-to-read-msg-stream-reset",
199+
"v1.2.x/knowledge-base/what-is-foundry",
200+
"v1.2.x/knowledge-base/why-is-cast-necessary-for-mev-commit-chain-interactions",
201+
"v1.2.x/knowledge-base/why-do-i-receive-the-same-commitment-when-resending-a-bid",
202+
"v1.2.x/knowledge-base/what-is-execution-preconfirmations",
203+
"v1.2.x/knowledge-base/how-to-price-a-bid",
204+
"v1.2.x/knowledge-base/what-happens-during-an-execution-preconf",
205+
"v1.2.x/knowledge-base/how-do-preconfs-work",
206+
"v1.2.x/knowledge-base/eigenlayer-operator-registration"
207+
]
208+
}
209+
]
210+
}
211+
]
212+
},
13213
{
14214
"version": "v1.1.0",
15215
"tabs": [

‎v1.2.x/api-reference/bidder/autodeposit.mdx‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: Add Auto Deposit
3+
openapi: post /v1/bidder/auto_deposit/{amount}
4+
---

‎v1.2.x/api-reference/bidder/autodepositstatus.mdx‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: Get Auto Deposit Status
3+
openapi: get /v1/bidder/auto_deposit_status
4+
---

‎v1.2.x/api-reference/bidder/cancelautodeposit.mdx‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: Cancel Auto Deposit
3+
openapi: post /v1/bidder/cancel_auto_deposit
4+
---

‎v1.2.x/api-reference/bidder/claimslashedfunds.mdx‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: Claim slashed funds
3+
openapi: post /v1/bidder/claim_slashed_funds
4+
---

‎v1.2.x/api-reference/bidder/deposit.mdx‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: Add Deposit
3+
openapi: post /v1/bidder/deposit/{amount}
4+
---

‎v1.2.x/api-reference/bidder/getbidinfo.mdx‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: Get bid info
3+
openapi: get /v1/bidder/get_bid_info
4+
---

‎v1.2.x/api-reference/bidder/getdeposit.mdx‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: Retrieve Deposit
3+
openapi: get /v1/bidder/get_deposit
4+
---

‎v1.2.x/api-reference/bidder/sendbid.mdx‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: Send Bid
3+
openapi: post /v1/bidder/bid
4+
---

‎v1.2.x/api-reference/bidder/withdraw.mdx‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: Withdraw Deposit
3+
openapi: post /v1/bidder/withdraw
4+
---

0 commit comments

Comments
 (0)