Skip to content
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.

Sign up for GitHub

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

single page client libs #463

Merged
merged 3 commits into from
Oct 19, 2023
Merged

single page client libs #463

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7353163
update mev-share libs, add landing page for libs
zeroXbrock Oct 19, 2023
1bc5eeb
update link in bundle cancellations
zeroXbrock Oct 19, 2023
204993f
appease the docusaurus
zeroXbrock Oct 19, 2023
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
2 changes: 1 addition & 1 deletion docs/flashbots-auction/advanced/bundle-cancellations.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ To replace a bundle, send the new bundle via `eth_sendBundle` with the same `rep

### Canceling bundles

Canceling a bundle will prevent Flashbots builders from including it on-chain. To cancel a bundle, call the [`eth_cancelBundle`](/flashbots-auction/advanced/rpc-endpoint#eth_cancelbundle) endpoint, or use the `cancelBundle` function in your preferred [Flashbots library](/flashbots-auction/libraries/ethers-js-provider).
Canceling a bundle will prevent Flashbots builders from including it on-chain. To cancel a bundle, call the [`eth_cancelBundle`](/flashbots-auction/advanced/rpc-endpoint#eth_cancelbundle) endpoint, or use the `cancelBundle` function in your preferred [Flashbots library](/flashbots-auction/libraries/bundle-relay).

```json
{
Expand Down
12 changes: 12 additions & 0 deletions docs/flashbots-auction/libraries/bundle-relay.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: Bundle Relay Clients
---

The following clients connect to the Bundle Relay API, which exposes [these JSON-RPC methods](/docs/flashbots-auction/advanced/rpc-endpoint.mdx).

- [ethers-js](/docs/flashbots-auction/libraries/ethers-js-provider.md)
- [golang](/docs/flashbots-auction/libraries/golang.md)
- [web3.py](/docs/flashbots-auction/libraries/web3py-provider.md)
- [Alchemy API](/docs/flashbots-auction/libraries/alchemyprovider.md)

MEV-Share endpoints (e.g. `mev_sendBundle`) are implemented in [their own libraries](/docs/flashbots-auction/libraries/mev-share-clients.md).
11 changes: 6 additions & 5 deletions docs/flashbots-auction/libraries/mev-share-clients.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@
title: MEV-Share Clients
---

### Typescript
* [mev-share-client-ts](https://github.com/flashbots/mev-share-client-ts)
* [mev-share-rs](https://github.com/paradigmxyz/mev-share-rs)
* [mev-share-go](https://github.com/duoxehyon/mev-share-go)
* [mev-share-java](https://github.com/optimism-java/mev-share-java)
* [mev-share-py](https://github.com/ZigaMr/mev-share-py)

* [mev-share-client-ts](https://github.com/flashbots/mev-share-client-ts) - reference implementation in Typescript
* [mev-share-rs](https://github.com/paradigmxyz/mev-share-rs) - Rust implementation

> :eyes: If you are writing (or want to write) a client library for MEV-Share, please [reach out](/flashbots-mev-share/searchers/tutorials/limit-order/more-resources). We love client diversity!
> :eyes: If you want to write a MEV-Share client for another language, please [reach out](/flashbots-mev-share/searchers/tutorials/limit-order/more-resources). We love client diversity!
3 changes: 2 additions & 1 deletion docs/sidebars.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,12 @@ module.exports = {
'flashbots-auction/example-searchers/synthetix-searcher',
],
"Libraries": [
'flashbots-auction/libraries/bundle-relay',
'flashbots-auction/libraries/mev-share-clients',
'flashbots-auction/libraries/golang',
'flashbots-auction/libraries/ethers-js-provider',
'flashbots-auction/libraries/web3py-provider',
'flashbots-auction/libraries/alchemyprovider',
'flashbots-auction/libraries/mev-share-clients',
],
"Advanced Concepts": [
'flashbots-auction/advanced/understanding-bundles',
Expand Down
Loading