Skip to content

Express Relay Docs #339

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 55 commits into from
Jul 11, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
55 commits
Select commit Hold shift + click to select a range
ba754df
Initial commit
aditya520 Jun 11, 2024
bf983a1
added some framework to docs
aditya520 Jun 12, 2024
e758759
protocol guide wip
aditya520 Jun 12, 2024
52c3346
add intro express relay docs
anihamde Jun 12, 2024
8d46c78
Merge branch '(feat)-add-express-relay' of github.com:pyth-network/do…
anihamde Jun 12, 2024
8cb8c04
up - up - update
aditya520 Jun 13, 2024
0e4d456
updated guide
aditya520 Jun 24, 2024
f45490f
additional resources
aditya520 Jun 24, 2024
0a56469
tiny changes
aditya520 Jun 25, 2024
d524fd3
uhh
aditya520 Jun 25, 2024
73aca99
(WIP) Express relay docs
aditya520 Jun 25, 2024
27fbecc
(WIP) API refernce
aditya520 Jun 25, 2024
9cf9fec
(WIP) Express relay docs
aditya520 Jun 25, 2024
e1c5734
details around auction, opportunities, and permissioning
anihamde Jun 26, 2024
a1ebb8d
Merge branch '(feat)-add-express-relay' of github.com:pyth-network/do…
anihamde Jun 26, 2024
ce9082d
(WIP) Express relay docs
aditya520 Jun 26, 2024
d16b669
(WIP) Express relay docs
aditya520 Jun 27, 2024
ecb7ca6
add some moar content
anihamde Jun 28, 2024
a9d32cd
(WIP) Express relay docs
aditya520 Jun 28, 2024
f044075
content dump
anihamde Jun 28, 2024
b0df6fb
Merge branch '(feat)-add-express-relay' of github.com:pyth-network/do…
anihamde Jun 28, 2024
59b1992
Suggested edits (#360)
jayantk Jul 1, 2024
1780065
(WIP) Express relay docs- Yaser comments
aditya520 Jul 1, 2024
0ee5829
Update tables
m30m Jul 2, 2024
6ad0182
Change MEV definition from the old one
m30m Jul 2, 2024
703c905
added searcher guide to auction-server
anihamde Jul 2, 2024
31eb98f
finalize opportunity adapter docs dump
anihamde Jul 3, 2024
59227c3
Use cards for the main CTAs
m30m Jul 4, 2024
cf27a2e
Separate websocket api reference
m30m Jul 4, 2024
bc60b80
WIP-Searcher-guide
aditya520 Jul 4, 2024
9979e89
WIP-searcher-guide-refactor
aditya520 Jul 5, 2024
2bda439
wip
aditya520 Jul 5, 2024
c35641d
WIP-searcher-guide-refactor
aditya520 Jul 5, 2024
6901e48
Reorg searcher docs
m30m Jul 5, 2024
56d8802
WIP-protocol-guide-refactor
aditya520 Jul 5, 2024
4f2f9e4
WIP-searcher-guide-refactor
aditya520 Jul 5, 2024
d172628
WIP-ER
aditya520 Jul 8, 2024
e24d4b6
Update docs
m30m Jul 8, 2024
fb63c4e
some minor changes
anihamde Jul 9, 2024
47ea3f0
WIP-searcher-guide-refactor
aditya520 Jul 9, 2024
84d8831
WIP-searcher-guide-refactor
aditya520 Jul 9, 2024
078f9f0
WIP-searcher-guide-refactor
aditya520 Jul 9, 2024
d3263cc
WIP-comments-resolved
aditya520 Jul 9, 2024
d816fed
address change
aditya520 Jul 9, 2024
d028c8d
WIP-comments-resolved
aditya520 Jul 10, 2024
2448bc8
WIP-comments-resolved
aditya520 Jul 10, 2024
a842125
few small fixes pt 1
anihamde Jul 10, 2024
04826af
WIP-intro page
aditya520 Jul 10, 2024
5d3e43e
few small fixes pt 2
anihamde Jul 10, 2024
c9963d9
Merge branch '(feat)-add-express-relay' of github.com:pyth-network/do…
anihamde Jul 10, 2024
1338c14
wip docs
aditya520 Jul 10, 2024
c97754c
Express Relay docs v1
aditya520 Jul 10, 2024
78cb484
index change
aditya520 Jul 11, 2024
59459ce
Changed example reference to example repo
aditya520 Jul 11, 2024
dee1c14
Express Relay v1.xx
aditya520 Jul 11, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions pages/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@
"type": "page"
},

"express-relay": {
"title": "Express Relay",
"type": "page"
},

"get-in-touch": {
"title": "Get In Touch ↗",
"type": "page",
Expand Down
38 changes: 38 additions & 0 deletions pages/express-relay/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
{
"documentation-home": {
"title": "← Documentation Home",
"href": "/home"
},

"-- Express Relay": {
"title": "Express Relay",
"type": "separator"
},
"index": "Introduction",

"-- How-to Guides": {
"title": "How-To Guides",
"type": "separator"
},

"integrate-express-relay": "Integrate Express Relay",

"-- Reference Material": {
"title": "Reference Material",
"type": "separator"
},

"api-reference": "API Reference",
"contract-addresses": "Contract Addresses",
"error-codes": "Error Codes",

"examples": {
"title": "Example Application ↗"
},
"-- Understand Express Relay": {
"title": "Understanding Express Relay",
"type": "separator"
},

"how-express-relay-works": "How Express Relay Works"
}
3 changes: 3 additions & 0 deletions pages/express-relay/api-reference.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# API Reference

Link to swagger
1 change: 1 addition & 0 deletions pages/express-relay/contract-addresses.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Contract Address
Empty file.
1 change: 1 addition & 0 deletions pages/express-relay/how-express-relay-works.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Design Overview
Empty file.
Empty file.
13 changes: 13 additions & 0 deletions pages/express-relay/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Introduction

Express Relay

(Insert minimalistic architecture diagram here)

## What is Express Relay?

### How does Express Relay work? (Maximum 2-3 lines)

### Different types of actors in Express Relay

## Links to other pages
9 changes: 9 additions & 0 deletions pages/express-relay/integrate-express-relay.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# How to Integrate Express Relay



3-4 lines about Express Relay integration.


- [Searchers](./integrate-express-relay/searchers.mdx)
- [Protocols](./integrate-express-relay/protocols.mdx)
1 change: 1 addition & 0 deletions pages/express-relay/integrate-express-relay/protocols.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# How to Integrate Express Relay as a Protocol
1 change: 1 addition & 0 deletions pages/express-relay/integrate-express-relay/searchers.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# How to Integrate Express Relay as a Searcher
5 changes: 5 additions & 0 deletions pages/home/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,11 @@
"href": "/entropy"
},

"Express Relay": {
"title": "Express Relay →",
"href": "/express-relay"
},

"--- Additional Information": {
"title": "Additional Information",
"type": "separator"
Expand Down
1 change: 1 addition & 0 deletions pages/home/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Pyth Network offers several products for developers:
Aptos, Sui, NEAR, and several Cosmos chains.
- [Benchmarks](../benchmarks) provides historical Pyth prices for both on- and off-chain use.
- [Entropy](../entropy) allows developers to generate secure random numbers on the blockchain.
- [Express Relay](../express-relay/)

Please follow the links above to learn about each product and how to integrate them into your application.

Expand Down
Loading