Skip to content

Commit

Permalink
Update for consistency
Browse files Browse the repository at this point in the history
  • Loading branch information
Wazzymandias committed May 5, 2023
1 parent e2bb470 commit 12370fe
Showing 1 changed file with 13 additions and 4 deletions.
17 changes: 13 additions & 4 deletions specs/events/v0.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@

Events on MEV-Share are distributed via an SSE endpoint. Searchers listen to this endpoint to receive a stream of new events, which contain data they can use in their bundles.

<!-- TOC -->
* [event-stream](#event-stream)
* [Event Scheme](#event-scheme)
* [`hash`](#hash)
* [`logs`](#logs)
* [`tx`](#tx)
* [Stream Logic](#stream-logic)
<!-- TOC -->

## Event Scheme

```typescript
Expand All @@ -18,15 +27,15 @@ Events on MEV-Share are distributed via an SSE endpoint. Searchers listen to thi

_NOTE: Optional fields are marked with a `?`._

## `hash`
### `hash`

Hex-string of the transaction or bundle hash.

## `logs`
### `logs`

Array of JSON-encoded event logs emitted by executing the transaction.

## `tx`
### `tx`

Transactions from the event. If the event itself is a transaction, txs will only have one entry. Bundle events may have more.

Expand All @@ -35,7 +44,7 @@ Transactions from the event. If the event itself is a transaction, txs will only
| `functionSelector` | Hex-string | 4-byte function selector. |
| `callData` | Hex-string | Calldata of the transaction. |

## Stream Logic
### Stream Logic

Users subscribe to the stream by making an HTTP GET request on the stream endpoint.

Expand Down

0 comments on commit 12370fe

Please sign in to comment.