-
Notifications
You must be signed in to change notification settings - Fork 35
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
Express Relay Docs #339
Changes from 2 commits
Commits
Show all changes
55 commits
Select commit
Hold shift + click to select a range
ba754df
Initial commit
aditya520 bf983a1
added some framework to docs
aditya520 e758759
protocol guide wip
aditya520 52c3346
add intro express relay docs
anihamde 8d46c78
Merge branch '(feat)-add-express-relay' of github.com:pyth-network/do…
anihamde 8cb8c04
up - up - update
aditya520 0e4d456
updated guide
aditya520 f45490f
additional resources
aditya520 0a56469
tiny changes
aditya520 d524fd3
uhh
aditya520 73aca99
(WIP) Express relay docs
aditya520 27fbecc
(WIP) API refernce
aditya520 9cf9fec
(WIP) Express relay docs
aditya520 e1c5734
details around auction, opportunities, and permissioning
anihamde a1ebb8d
Merge branch '(feat)-add-express-relay' of github.com:pyth-network/do…
anihamde ce9082d
(WIP) Express relay docs
aditya520 d16b669
(WIP) Express relay docs
aditya520 ecb7ca6
add some moar content
anihamde a9d32cd
(WIP) Express relay docs
aditya520 f044075
content dump
anihamde b0df6fb
Merge branch '(feat)-add-express-relay' of github.com:pyth-network/do…
anihamde 59b1992
Suggested edits (#360)
jayantk 1780065
(WIP) Express relay docs- Yaser comments
aditya520 0ee5829
Update tables
m30m 6ad0182
Change MEV definition from the old one
m30m 703c905
added searcher guide to auction-server
anihamde 31eb98f
finalize opportunity adapter docs dump
anihamde 59227c3
Use cards for the main CTAs
m30m cf27a2e
Separate websocket api reference
m30m bc60b80
WIP-Searcher-guide
aditya520 9979e89
WIP-searcher-guide-refactor
aditya520 2bda439
wip
aditya520 c35641d
WIP-searcher-guide-refactor
aditya520 6901e48
Reorg searcher docs
m30m 56d8802
WIP-protocol-guide-refactor
aditya520 4f2f9e4
WIP-searcher-guide-refactor
aditya520 d172628
WIP-ER
aditya520 e24d4b6
Update docs
m30m fb63c4e
some minor changes
anihamde 47ea3f0
WIP-searcher-guide-refactor
aditya520 84d8831
WIP-searcher-guide-refactor
aditya520 078f9f0
WIP-searcher-guide-refactor
aditya520 d3263cc
WIP-comments-resolved
aditya520 d816fed
address change
aditya520 d028c8d
WIP-comments-resolved
aditya520 2448bc8
WIP-comments-resolved
aditya520 a842125
few small fixes pt 1
anihamde 04826af
WIP-intro page
aditya520 5d3e43e
few small fixes pt 2
anihamde c9963d9
Merge branch '(feat)-add-express-relay' of github.com:pyth-network/do…
anihamde 1338c14
wip docs
aditya520 c97754c
Express Relay docs v1
aditya520 78cb484
index change
aditya520 59459ce
Changed example reference to example repo
aditya520 dee1c14
Express Relay v1.xx
aditya520 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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" | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# API Reference | ||
|
||
Link to swagger |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# Contract Address |
Empty file.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# Design Overview |
Empty file.
Empty file.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# How to Integrate Express Relay as a Protocol |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# How to Integrate Express Relay as a Searcher |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.