Skip to content

Commit

Permalink
single page client libs (#463)
Browse files Browse the repository at this point in the history
* update mev-share libs, add landing page for libs

* update link in bundle cancellations

* appease the docusaurus
  • Loading branch information
zeroXbrock authored Oct 19, 2023
1 parent 734e2d1 commit e1ce68d
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 7 deletions.
2 changes: 1 addition & 1 deletion docs/flashbots-auction/advanced/bundle-cancellations.mdx
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
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
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
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

1 comment on commit e1ce68d

@vercel
Copy link

@vercel vercel bot commented on e1ce68d Oct 19, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.