Skip to main content

Try It Now Dialog

engine_getPayloadBodiesByHashV1

Method​

  • JSON-RPC method name: engine_getPayloadBodiesByHashV1
  • JSON-RPC version: 2.0

Parameters​

NameTypeRequiredDescription
Array of block hashesstring[]yes

Parameter schema​

{
  "Array of block hashes": {
    "required": true,
    "schema": {
      "type": "array",
      "items": {
        "title": "32 byte hex value",
        "type": "string",
        "pattern": "^0x[0-9a-f]{64}$"
      }
    }
  }
}

Result​

  • Name: Execution payload bodies
  • Type: object[]

Result schema​

{
  "type": "array",
  "items": {
    "title": "Execution payload body object V1",
    "type": "object",
    "required": [
      "transactions"
    ],
    "properties": {
      "transactions": {
        "title": "Transactions",
        "type": "array",
        "items": {
          "title": "hex encoded bytes",
          "type": "string",
          "pattern": "^0x[0-9a-f]*$"
        }
      },
      "withdrawals": {
        "title": "Withdrawals",
        "type": [
          "array",
          "null"
        ],
        "items": {
          "title": "Withdrawal object V1",
          "type": "object",
          "required": [
            "index",
            "validatorIndex",
            "address",
            "amount"
          ],
          "properties": {
            "index": {
              "title": "Withdrawal index",
              "type": "string",
              "pattern": "^0x(0|[1-9a-f][0-9a-f]{0,15})$"
            },
            "validatorIndex": {
              "title": "Validator index",
              "type": "string",
              "pattern": "^0x(0|[1-9a-f][0-9a-f]{0,15})$"
            },
            "address": {
              "title": "Withdrawal address",
              "type": "string",
              "pattern": "^0x[0-9a-fA-F]{40}$"
            },
            "amount": {
              "title": "Withdrawal amount",
              "type": "string",
              "pattern": "^0x(0|[1-9a-f][0-9a-f]{0,15})$"
            }
          }
        }
      }
    }
  }
}

Positional parameters​

Parameter order:

  1. Array of block hashes

Errors​

This method may return JSON-RPC standard errors (e.g. -32600, -32601, -32602, -32603) as well as application-specific errors.

TODO: Document method-specific error codes and conditions.

Named Parameters
{
  "jsonrpc": "2.0",
  "method": "engine_getPayloadBodiesByHashV1",
  "params": {
    "Array of block hashes": [
      "string"
    ]
  },
  "id": 1
}
Successful Response
{
  "jsonrpc": "2.0",
  "result": [
    {
      "transactions": [
        "string"
      ],
      "withdrawals": "example"
    }
  ],
  "id": 1
}
Positional Parameters
{
  "jsonrpc": "2.0",
  "method": "engine_getPayloadBodiesByHashV1",
  "params": [
    [
      "string"
    ]
  ],
  "id": 2
}
Successful Response
{
  "jsonrpc": "2.0",
  "result": [
    {
      "transactions": [
        "string"
      ],
      "withdrawals": "example"
    }
  ],
  "id": 2
}