Merge pull request #12 from flashbots/bundle-params-validity-fix

fix validity optionality & clean up MD errors
flashbots · May 22, 2023 · 013c691 · 013c691
2 parents 1e39ee2 + ff6fc3c
commit 013c691
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 9 deletions.
diff --git a/specs/bundles/refund-recipient.md b/specs/bundles/refund-recipient.md
@@ -3,7 +3,7 @@
 Matchmakers can use the `eth_sendBundle` method to send a bundle of transactions to a block builder. Specifically, the `refund-recipient` version of `eth_sendBundle` extends the [standard `eth_sendBundle` API](https://docs.flashbots.net/flashbots-auction/searchers/advanced/rpc-endpoint#eth_sendbundle) to support two additional fields (`refundPercent` and `refundRecipient`) which can optionally be set to specify how refunds from MEV-Share should be distributed.
 
 <!-- TOC -->
-* [`eth_sendBundle`](#ethsendbundle)
+* [`eth_sendBundle`](#eth_sendbundle)
  * [JSON-RPC Scheme](#json-rpc-scheme)
  * [`txs`](#txs)
  * [`blockNumber`](#blocknumber)
@@ -102,4 +102,4 @@ Response:
  "bundleHash": "0x2228f5d8954ce31dc1601a8ba264dbd401bf1428388ce88238932815c5d6f23f"
  }
 }
-```
+```
diff --git a/specs/bundles/v0.1.md b/specs/bundles/v0.1.md
@@ -3,16 +3,16 @@
 Users and searchers can use `mev_sendBundle` to send a bundle of transactions [and transaction hashes] to a MEV-Share Matchmaker. Matchmakers can use `mev_sendBundle` to send a bundle of transactions to a block builder.
 
 <!-- TOC -->
-* [`mev_sendBundle`](#mevsendbundle)
- * [JSON-RPC Request Scheme](#json-rpc-request-scheme)
+* [`mev_sendBundle`](#mev_sendbundle)
+ * [JSON-RPC Request](#json-rpc-request-scheme)
  * [`version`](#version)
  * [`inclusion`](#inclusion)
  * [`body`](#body)
  * [Example](#example)
  * [Bundle Composition](#bundle-composition)
  * [`validity`](#validity)
  * [`privacy`](#privacy)
- * [JSON-RPC Response Scheme](#json-rpc-response-scheme)
+ * [JSON-RPC Response](#json-rpc-response-scheme)
  * [`blockHash`](#blockhash)
 <!-- TOC -->
 
@@ -34,12 +34,12 @@ type requestBody = {
  { tx: string, canRevert: boolean } |
  { bundle: MevSendBundleParams }
  >,
- validity: {
+ validity? : {
  refund?: Array<{
  bodyIdx: number,
  percent: number,
  }>,
- refundConfig: Array<{
+ refundConfig?: Array<{
  address: string,
  percent: number,
  }>,
@@ -188,6 +188,7 @@ Preferences on what data should be shared about the bundle and its transactions.
 | `targetBuilders` | Array of strings; optional | Builders that have permission to receive this bundle and include it in a block. |
 
 ## JSON-RPC Response Scheme
+
 ```typescript
 type responseBody = {
  "blockHash": number[32]
@@ -196,5 +197,4 @@ type responseBody = {
 
 ### `blockHash`
 
-Hash of the list of bundle bodies defined by [bundle composition](#bundle-composition). If there is only one bundle in the list, 
-the `blockHash` returns the hash of that bundle body.
+Hash of the list of bundle bodies defined by [bundle composition](#bundle-composition). If there is only one bundle in the list, the `blockHash` returns the hash of that bundle body.