Document engine_getBlobsV1 (#1706)

hyperledger · Oct 10, 2024 · ea197e7 · ea197e7
1 parent 3d2aea0
commit ea197e7
Show file tree

Hide file tree

Showing 3 changed files with 71 additions and 1 deletion.
diff --git a/docs/public-networks/reference/engine-api/index.md b/docs/public-networks/reference/engine-api/index.md
@@ -224,6 +224,67 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"engine_forkchoiceUpdatedV1","par
 
 </Tabs>
 
+### `engine_getBlobsV1`
+
+Returns the blobs corresponding to the specified blob versioned hashes.
+
+#### Parameters
+
+`versionedHashes`: *array* of *strings* - Array of blob versioned hashes
+
+#### Returns
+
+`engineGetBlobsResultV1`: *array* of *objects* - Array of [blob and proof objects](objects.md#blob-and-proof-object),
+items of which can be `null`
+
+<Tabs>
+
+<TabItem value="curl HTTP" label="curl HTTP" default>
+
+```bash
+curl -X POST --data '{"jsonrpc":"2.0","method":"engine_getBlobsV1","params":[["0x010657f37554c781402a22917dee2f75def7ab966d7b770905398eba3c444014","0x01f3a5c9d8e7b6a4c2d1e0f9b8a7c6d5e4f3a2b1c0d9e8f7b6a5c4d3e2f1a0b9"]],"id":1}' http://127.0.0.1:8550
+```
+
+</TabItem>
+
+<TabItem value="wscat WS" label="wscat WS">
+
+```json
+{
+  "jsonrpc": "2.0",
+  "method": "engine_getBlobsV1",
+  "params": [
+    [
+      "0x010657f37554c781402a22917dee2f75def7ab966d7b770905398eba3c444014",
+      "0x01f3a5c9d8e7b6a4c2d1e0f9b8a7c6d5e4f3a2b1c0d9e8f7b6a5c4d3e2f1a0b9"
+    ]
+  ],
+  "id": 67
+}
+```
+
+</TabItem>
+
+<TabItem value="JSON result" label="JSON result">
+
+```json
+{
+  "jsonrpc": "2.0",
+  "id": 67,
+  "result": [
+    {
+      "blob": "0x722662154e6d76b2b2b92e70c0cac3ccf534f9b74eb5b89819ec509083d00a503ae5c198d17634e79059c2cd735491...",
+      "proof": "0x80c5f2e1eb23939cf3600f61872e3e9964d0acafb440634e530d6139a193b889c56a0c07d737729dbe0626706fc9f25f"
+    },
+    null
+  ]
+}
+```
+
+</TabItem>
+
+</Tabs>
+
 ### `engine_getPayloadBodiesByHashV1`
 
 Returns the bodies of the execution payloads corresponding to the specified block hashes.

diff --git a/docs/public-networks/reference/engine-api/objects.md b/docs/public-networks/reference/engine-api/objects.md
@@ -9,6 +9,15 @@ tags:
 
 The following objects are parameters for or returned by the [Engine API methods](index.md).
 
+## Blob and proof object
+
+Returned by [`engine_getBlobsV1`](index.md#engine_getblobsv1).
+
+| Key | Type | Value |
+| --- | :-: | --- |
+| `blob` | _Data_, 131072 Bytes | An SSZ-encoded `Blob` as defined in [EIP-4844](https://eips.ethereum.org/EIPS/eip-4844). |
+| `proof` | _Data_, 48 Bytes | A `KZGProof` as defined in [EIP-4844](https://eips.ethereum.org/EIPS/eip-4844). |
+
 ## Execution payload object
 
 Parameter for [`engine_newPayloadV1`](index.md#engine_newpayloadv1). Returned by [`engine_getPayloadV1`](index.md#engine_getpayloadv1).

diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -220,7 +220,7 @@ const config = {
       prism: {
         theme: lightCodeTheme,
         darkTheme: darkCodeTheme,
-        additionalLanguages: ["solidity", "toml", "java"],
+        additionalLanguages: ["solidity", "toml", "java", "bash"],
       },
       mermaid: {
         options: {