Pre-General Availability: 2026-02-23

Jump to

• Request
• Response

Sign and Submit a Transaction

post

/v1/besu/signTransaction

Signs and submits a transaction to the configured Besu node.

Supports:

• Eth transfer between accounts
• Contract deployment
• Contract execution, with support for encoding for functionSignature/functionArgs

Request

Header Parameters

• X-Besu-Url: string
  Optional upstream JSON-RPC URL override. When provided, the request is sent to this URL.
• X-Request-Id: string
  Optional request correlation identifier. Echoed in responses when provided.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Input for signing and submitting a transaction

Show Source

• abi: array abi
  Contract ABI; required if constructorArgs provided
• bytecode: string
  Contract bytecode (0x-hex); required for deployment
• constructorArgs: array constructorArgs
  Constructor arguments as strings (optional)
• contractAbi: array contractAbi
  Optional ABI used to infer parameter types when functionSignature omits types (name-only). For overloaded functions, the entry with matching parameter count is selected. If omitted and toAddress is provided, the gateway may resolve the ABI by address when available.
• data: string
  Hex calldata; for contract deployment you may provide full bytecode+constructor params here and omit bytecode/abi
• decode: object DecodeOptions
  Selective decode options; flags default to false when omitted.
• ethValue: string
  Amount in wei as string (for example, "10000000000000000")
• fromAddress: string
  Sender address to sign with. The gateway signs directly via wallets/{address}/sign. Must belong to the current user.
• functionArgs: array functionArgs
  Function arguments as strings aligned with the parameter order. Scalars: address, bool, string, int/uint (any width), bytes/bytesN (1..32). Arrays (1-D) and tuples are supported by passing JSON strings: - Dynamic/fixed arrays: for example, '["0xabc...", "0xdef..."]' or '["1","2","3"]' - Tuples (and nested): for example, '["0xabc...", "42"]' For function name without types, contractAbi is used to infer param types (overloads resolved by arity).
• functionSignature: string
  Function selector for ABI encoding when data is absent. You may provide: - Fully-specified signature (for example, "approve(address,uint256)"), or - Function name only (for example, "approve"); parameter types are inferred from the provided ABI (overloads resolved by argument count). If contractAbi is not supplied and toAddress is provided, the gateway may resolve the ABI by address when available.
• gasFeeCap: string
  EIP-1559 max fee per gas
• gasLimit: integer
  Gas limit (required for contract deployment; optional otherwise)
• gasPrice: string
  Legacy only; if omitted, fetched via eth_gasPrice
• gasTipCap: string
  EIP-1559 priority fee per gas
• nonce: integer
  Nonce; if omitted, fetched via eth_getTransactionCount (pending)
• receiptMaxTries: integer
  Default Value: 60

  Max number of receipt polls (default 60)
• receiptWaitMs: integer
  Default Value: 1500

  Milliseconds to wait between receipt polls (default 1500)
• storageLayout: object storageLayout
  Optional Solidity compiler storage layout JSON
• toAddress: string
  Recipient address (omit for contract deployment)
• txByHash: boolean
  Default Value: false

  Include eth_getTransactionByHash result in response
• type: integer
  Default Value: 2

  Allowed Values: [ 0, 2 ]

  Transaction type (0=legacy, 2=EIP-1559)
• waitForReceipt: boolean
  Default Value: true

  If true, gateway polls for transaction receipt before responding (default: true)

{
    "type":"object",
    "description":"Input for signing and submitting a transaction",
    "properties":{
        "toAddress":{
            "type":"string",
            "description":"Recipient address (omit for contract deployment)"
        },
        "fromAddress":{
            "type":"string",
            "description":"Sender address to sign with. The gateway signs directly via wallets/{address}/sign. Must belong to the current user."
        },
        "ethValue":{
            "type":"string",
            "description":"Amount in wei as string (for example, \"10000000000000000\")"
        },
        "data":{
            "type":"string",
            "description":"Hex calldata; for contract deployment you may provide full bytecode+constructor params here and omit bytecode/abi"
        },
        "functionSignature":{
            "type":"string",
            "description":"Function selector for ABI encoding when data is absent.\nYou may provide:\n  - Fully-specified signature (for example, \"approve(address,uint256)\"), or\n  - Function name only (for example, \"approve\"); parameter types are inferred from the provided ABI (overloads resolved by argument count). If contractAbi is not supplied and toAddress is provided, the gateway may resolve the ABI by address when available.\n"
        },
        "functionArgs":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"Function arguments as strings aligned with the parameter order.\nScalars: address, bool, string, int/uint (any width), bytes/bytesN (1..32).\nArrays (1-D) and tuples are supported by passing JSON strings:\n  - Dynamic/fixed arrays: for example, '[\"0xabc...\", \"0xdef...\"]' or '[\"1\",\"2\",\"3\"]'\n  - Tuples (and nested): for example, '[\"0xabc...\", \"42\"]'\nFor function name without types, contractAbi is used to infer param types (overloads resolved by arity).\n"
        },
        "contractAbi":{
            "type":"array",
            "description":"Optional ABI used to infer parameter types when functionSignature omits types (name-only). For overloaded functions, the entry with matching parameter count is selected. If omitted and toAddress is provided, the gateway may resolve the ABI by address when available.\n",
            "items":{
                "type":"object"
            }
        },
        "type":{
            "type":"integer",
            "enum":[
                0,
                2
            ],
            "default":2,
            "description":"Transaction type (0=legacy, 2=EIP-1559)"
        },
        "gasLimit":{
            "type":"integer",
            "description":"Gas limit (required for contract deployment; optional otherwise)"
        },
        "gasPrice":{
            "type":"string",
            "description":"Legacy only; if omitted, fetched via eth_gasPrice"
        },
        "gasTipCap":{
            "type":"string",
            "description":"EIP-1559 priority fee per gas"
        },
        "gasFeeCap":{
            "type":"string",
            "description":"EIP-1559 max fee per gas"
        },
        "nonce":{
            "type":"integer",
            "description":"Nonce; if omitted, fetched via eth_getTransactionCount (pending)"
        },
        "bytecode":{
            "type":"string",
            "description":"Contract bytecode (0x-hex); required for deployment"
        },
        "abi":{
            "type":"array",
            "description":"Contract ABI; required if constructorArgs provided",
            "items":{
                "type":"object"
            }
        },
        "constructorArgs":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"Constructor arguments as strings (optional)"
        },
        "storageLayout":{
            "type":"object",
            "description":"Optional Solidity compiler storage layout JSON"
        },
        "decode":{
            "$ref":"#/components/schemas/DecodeOptions"
        },
        "waitForReceipt":{
            "type":"boolean",
            "default":true,
            "description":"If true, gateway polls for transaction receipt before responding (default: true)"
        },
        "receiptWaitMs":{
            "type":"integer",
            "default":1500,
            "description":"Milliseconds to wait between receipt polls (default 1500)"
        },
        "receiptMaxTries":{
            "type":"integer",
            "default":60,
            "description":"Max number of receipt polls (default 60)"
        },
        "txByHash":{
            "type":"boolean",
            "default":false,
            "description":"Include eth_getTransactionByHash result in response"
        }
    }
}

Nested Schema : abi

Type: array

Contract ABI; required if constructorArgs provided

Show Source

• Array of: object items

{
    "type":"array",
    "description":"Contract ABI; required if constructorArgs provided",
    "items":{
        "type":"object"
    }
}

Nested Schema : constructorArgs

Type: array

Constructor arguments as strings (optional)

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"Constructor arguments as strings (optional)"
}

Nested Schema : contractAbi

Type: array

Optional ABI used to infer parameter types when functionSignature omits types (name-only). For overloaded functions, the entry with matching parameter count is selected. If omitted and toAddress is provided, the gateway may resolve the ABI by address when available.

Show Source

• Array of: object items

{
    "type":"array",
    "description":"Optional ABI used to infer parameter types when functionSignature omits types (name-only). For overloaded functions, the entry with matching parameter count is selected. If omitted and toAddress is provided, the gateway may resolve the ABI by address when available.\n",
    "items":{
        "type":"object"
    }
}

Nested Schema : DecodeOptions

Type: object

Selective decode options; flags default to false when omitted.

Show Source

• errors: boolean
  Decode revert reasons (both endpoints)
• events: boolean
  Decode event logs (signTransaction)
• inputs: boolean
  Decode function inputs (signTransaction)
• outputs: boolean
  Decode function outputs (query)

{
    "type":"object",
    "description":"Selective decode options; flags default to false when omitted.",
    "properties":{
        "inputs":{
            "type":"boolean",
            "description":"Decode function inputs (signTransaction)"
        },
        "outputs":{
            "type":"boolean",
            "description":"Decode function outputs (query)"
        },
        "events":{
            "type":"boolean",
            "description":"Decode event logs (signTransaction)"
        },
        "errors":{
            "type":"boolean",
            "description":"Decode revert reasons (both endpoints)"
        }
    }
}

Nested Schema : functionArgs

Type: array

Function arguments as strings aligned with the parameter order. Scalars: address, bool, string, int/uint (any width), bytes/bytesN (1..32). Arrays (1-D) and tuples are supported by passing JSON strings: - Dynamic/fixed arrays: for example, '["0xabc...", "0xdef..."]' or '["1","2","3"]' - Tuples (and nested): for example, '["0xabc...", "42"]' For function name without types, contractAbi is used to infer param types (overloads resolved by arity).

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"Function arguments as strings aligned with the parameter order.\nScalars: address, bool, string, int/uint (any width), bytes/bytesN (1..32).\nArrays (1-D) and tuples are supported by passing JSON strings:\n  - Dynamic/fixed arrays: for example, '[\"0xabc...\", \"0xdef...\"]' or '[\"1\",\"2\",\"3\"]'\n  - Tuples (and nested): for example, '[\"0xabc...\", \"42\"]'\nFor function name without types, contractAbi is used to infer param types (overloads resolved by arity).\n"
}

Nested Schema : storageLayout

Type: object

Optional Solidity compiler storage layout JSON

Nested Schema : items

Type: object

Nested Schema : items

Type: object

Examples

Select an example Legacy transfer (type=0) EIP-1559 transfer (type=2) Contract deployment Contract deployment (data-only) ERC20 approve(address,uint256) via functionSignature Sign + decode inputs/events/errors Name-only functionSignature with contractAbi Name-only functionSignature without contractAbi Decode event logs from receipt EIP-1559 transfer signed by address (no walletId preflight)

Back to Top

Response

Supported Media Types

• application/json

200 Response

Transaction signed and submitted

Body ()

Root Schema : SignTransactionResponse

Type: object

Show Source

• contractAddress: string
  Present for contract deployments once mined
• data: string
  Hex calldata (or "0x") for the transaction
• decoded: object DecodedResult
  Aggregate decoded information for the transaction or call
• encodedFromSignature: boolean
  True if calldata was generated from functionSignature
• nonce: string
  Nonce used for the transaction
• to: string
  Target address (empty for contract deployment)
• transactionByHash: object transactionByHash
  Additional Properties Allowed: true

  Transaction object from eth_getTransactionByHash; present when requested and available
• transactionReceipt: object transactionReceipt
  Transaction receipt object (may be null if not yet mined)
• txHash: string
  Hash of the submitted transaction

{
    "type":"object",
    "properties":{
        "txHash":{
            "type":"string",
            "description":"Hash of the submitted transaction"
        },
        "transactionReceipt":{
            "type":"object",
            "nullable":true,
            "description":"Transaction receipt object (may be null if not yet mined)"
        },
        "transactionByHash":{
            "type":"object",
            "nullable":true,
            "description":"Transaction object from eth_getTransactionByHash; present when requested and available",
            "additionalProperties":true
        },
        "contractAddress":{
            "nullable":true,
            "type":"string",
            "description":"Present for contract deployments once mined"
        },
        "to":{
            "type":"string",
            "description":"Target address (empty for contract deployment)"
        },
        "data":{
            "type":"string",
            "description":"Hex calldata (or \"0x\") for the transaction"
        },
        "nonce":{
            "type":"string",
            "description":"Nonce used for the transaction"
        },
        "encodedFromSignature":{
            "type":"boolean",
            "description":"True if calldata was generated from functionSignature"
        },
        "decoded":{
            "$ref":"#/components/schemas/DecodedResult",
            "nullable":true,
            "description":"Optional decoded info when decode flags requested"
        }
    }
}

Nested Schema : DecodedResult

Type: object

Aggregate decoded information for the transaction or call

Show Source

• error: object DecodedError
• events: array events
• function: object DecodedFunctionInfo
• input: object DecodedInput
  Decoded function input arguments
• meta: object DecodedMeta
• output: object DecodedOutput
  Decoded function return values

{
    "type":"object",
    "description":"Aggregate decoded information for the transaction or call",
    "properties":{
        "meta":{
            "$ref":"#/components/schemas/DecodedMeta"
        },
        "function":{
            "$ref":"#/components/schemas/DecodedFunctionInfo"
        },
        "input":{
            "$ref":"#/components/schemas/DecodedInput"
        },
        "output":{
            "$ref":"#/components/schemas/DecodedOutput"
        },
        "events":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DecodedEvent"
            }
        },
        "error":{
            "$ref":"#/components/schemas/DecodedError"
        }
    }
}

Nested Schema : transactionByHash

Type: object

Additional Properties Allowed: true

Transaction object from eth_getTransactionByHash; present when requested and available

Nested Schema : transactionReceipt

Type: object

Transaction receipt object (may be null if not yet mined)

Nested Schema : DecodedError

Type: object

Show Source

• customError: object customError
  Decoded custom error as defined in the contract ABI
• standardError: object standardError
  Decoded standard Error(string) revert
• standardPanic: object standardPanic
  Decoded Panic(uint256) revert

{
    "type":"object",
    "properties":{
        "standardError":{
            "nullable":true,
            "type":"object",
            "description":"Decoded standard Error(string) revert",
            "properties":{
                "selector":{
                    "type":"string",
                    "example":"0x08c379a0"
                },
                "message":{
                    "type":"string",
                    "nullable":true,
                    "description":"Revert message string"
                }
            }
        },
        "standardPanic":{
            "nullable":true,
            "type":"object",
            "description":"Decoded Panic(uint256) revert",
            "properties":{
                "selector":{
                    "type":"string",
                    "example":"0x4e487b71"
                },
                "code":{
                    "type":"string",
                    "nullable":true,
                    "description":"Panic code value (hex or decimal string)"
                },
                "meaning":{
                    "type":"string",
                    "nullable":true,
                    "description":"Human-readable interpretation of the panic code, when known"
                }
            }
        },
        "customError":{
            "nullable":true,
            "type":"object",
            "description":"Decoded custom error as defined in the contract ABI",
            "properties":{
                "name":{
                    "type":"string"
                },
                "signature":{
                    "type":"string"
                },
                "selector":{
                    "type":"string"
                },
                "args":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/DecodedArgument"
                    }
                }
            }
        }
    }
}

Nested Schema : events

Type: array

Show Source

• Array of: object DecodedEvent

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DecodedEvent"
    }
}

Nested Schema : DecodedFunctionInfo

Type: object

Show Source

• name: string
  Function name without parameter types
• selector: string
  4-byte function selector (0x-prefixed hex)
• signature: string
  Canonical function signature including parameter types (for example, "approve(address,uint256)")

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Function name without parameter types"
        },
        "signature":{
            "type":"string",
            "description":"Canonical function signature including parameter types (for example, \"approve(address,uint256)\")"
        },
        "selector":{
            "type":"string",
            "description":"4-byte function selector (0x-prefixed hex)"
        }
    }
}

Nested Schema : DecodedInput

Type: object

Decoded function input arguments

Show Source

• args: array args

{
    "type":"object",
    "description":"Decoded function input arguments",
    "properties":{
        "args":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DecodedArgument"
            }
        }
    }
}

Nested Schema : DecodedMeta

Type: object

Show Source

• abiSource: string
  Allowed Values: [ "request", "registry", "none" ]

  Where ABI was resolved from
• warnings: array warnings
  Non-fatal issues encountered while attempting to decode

{
    "type":"object",
    "properties":{
        "abiSource":{
            "type":"string",
            "description":"Where ABI was resolved from",
            "enum":[
                "request",
                "registry",
                "none"
            ]
        },
        "warnings":{
            "type":"array",
            "description":"Non-fatal issues encountered while attempting to decode",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : DecodedOutput

Type: object

Decoded function return values

Show Source

• returns: array returns

{
    "type":"object",
    "description":"Decoded function return values",
    "properties":{
        "returns":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DecodedArgument"
            }
        }
    }
}

Nested Schema : customError

Type: object

Decoded custom error as defined in the contract ABI

Show Source

• args: array args
• name: string
• selector: string
• signature: string

{
    "nullable":true,
    "type":"object",
    "description":"Decoded custom error as defined in the contract ABI",
    "properties":{
        "name":{
            "type":"string"
        },
        "signature":{
            "type":"string"
        },
        "selector":{
            "type":"string"
        },
        "args":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DecodedArgument"
            }
        }
    }
}

Nested Schema : standardError

Type: object

Decoded standard Error(string) revert

Show Source

• message: string
  Revert message string
• selector: string
  Example: 0x08c379a0

{
    "nullable":true,
    "type":"object",
    "description":"Decoded standard Error(string) revert",
    "properties":{
        "selector":{
            "type":"string",
            "example":"0x08c379a0"
        },
        "message":{
            "type":"string",
            "nullable":true,
            "description":"Revert message string"
        }
    }
}

Nested Schema : standardPanic

Type: object

Decoded Panic(uint256) revert

Show Source

• code: string
  Panic code value (hex or decimal string)
• meaning: string
  Human-readable interpretation of the panic code, when known
• selector: string
  Example: 0x4e487b71

{
    "nullable":true,
    "type":"object",
    "description":"Decoded Panic(uint256) revert",
    "properties":{
        "selector":{
            "type":"string",
            "example":"0x4e487b71"
        },
        "code":{
            "type":"string",
            "nullable":true,
            "description":"Panic code value (hex or decimal string)"
        },
        "meaning":{
            "type":"string",
            "nullable":true,
            "description":"Human-readable interpretation of the panic code, when known"
        }
    }
}

Nested Schema : args

Type: array

Show Source

• Array of: object DecodedArgument

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DecodedArgument"
    }
}

Nested Schema : DecodedArgument

Type: object

Show Source

• indexed: boolean
  Only for event parameters
• name: string
  May be empty if unknown
• type: string
  Canonical ABI type (for example, uint256, address, (uint256,address), uint256[])
• value:
  Normalized JSON value (address lowercase hex, bigints as decimal strings, bytes as 0x-hex)

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"May be empty if unknown"
        },
        "type":{
            "type":"string",
            "description":"Canonical ABI type (for example, uint256, address, (uint256,address), uint256[])"
        },
        "value":{
            "nullable":true,
            "description":"Normalized JSON value (address lowercase hex, bigints as decimal strings, bytes as 0x-hex)"
        },
        "indexed":{
            "type":"boolean",
            "nullable":true,
            "description":"Only for event parameters"
        }
    }
}

Nested Schema : DecodedEvent

Type: object

Show Source

• address: string
  Contract address that emitted the log
• args: array args
  Decoded event arguments (indexed indicates topic-encoded parameter)
• data: string
  Event data payload (0x-hex)
• logIndex: integer
  Zero-based index of the log within the block
• name: string
  Event name without parameter types
• signature: string
  Canonical event signature including parameter types
• topics: array topics
  Log topics as 0x-hex values

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Event name without parameter types"
        },
        "signature":{
            "type":"string",
            "description":"Canonical event signature including parameter types"
        },
        "address":{
            "type":"string",
            "description":"Contract address that emitted the log"
        },
        "logIndex":{
            "type":"integer",
            "nullable":true,
            "description":"Zero-based index of the log within the block"
        },
        "topics":{
            "type":"array",
            "description":"Log topics as 0x-hex values",
            "items":{
                "type":"string"
            }
        },
        "data":{
            "type":"string",
            "description":"Event data payload (0x-hex)"
        },
        "args":{
            "type":"array",
            "description":"Decoded event arguments (indexed indicates topic-encoded parameter)",
            "items":{
                "$ref":"#/components/schemas/DecodedArgument"
            }
        }
    }
}

Nested Schema : args

Type: array

Decoded event arguments (indexed indicates topic-encoded parameter)

Show Source

• Array of: object DecodedArgument

{
    "type":"array",
    "description":"Decoded event arguments (indexed indicates topic-encoded parameter)",
    "items":{
        "$ref":"#/components/schemas/DecodedArgument"
    }
}

Nested Schema : topics

Type: array

Log topics as 0x-hex values

Show Source

• Array of: string

{
    "type":"array",
    "description":"Log topics as 0x-hex values",
    "items":{
        "type":"string"
    }
}

Nested Schema : args

Type: array

Show Source

• Array of: object DecodedArgument

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DecodedArgument"
    }
}

Nested Schema : warnings

Type: array

Non-fatal issues encountered while attempting to decode

Show Source

• Array of: string

{
    "type":"array",
    "description":"Non-fatal issues encountered while attempting to decode",
    "items":{
        "type":"string"
    }
}

Nested Schema : returns

Type: array

Show Source

• Array of: object DecodedArgument

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DecodedArgument"
    }
}

Examples

Select an example Minimal success (no decoded block) Success with decoded inputs/events Success with receipt and contractAddress Success with decoded events

400 Response

Validation error or invalid input

Body ()

Root Schema : ErrorResponse

Type: object

Show Source

• decodedError: object DecodedError
• error: string
  Short error summary suitable for display
• hint: string
  Optional guidance that may help resolve the error
• message: string
  Additional error details, when available
• requestId: string
  Client-provided correlation ID echoed in responses
• upstreamCode: integer
  Upstream node error code (if provided by the RPC endpoint)
• upstreamData: string
  Raw upstream error data payload (0x-hex or JSON), if available

{
    "type":"object",
    "properties":{
        "error":{
            "type":"string",
            "description":"Short error summary suitable for display"
        },
        "message":{
            "type":"string",
            "nullable":true,
            "description":"Additional error details, when available"
        },
        "hint":{
            "type":"string",
            "nullable":true,
            "description":"Optional guidance that may help resolve the error"
        },
        "upstreamCode":{
            "type":"integer",
            "nullable":true,
            "description":"Upstream node error code (if provided by the RPC endpoint)"
        },
        "upstreamData":{
            "type":"string",
            "nullable":true,
            "description":"Raw upstream error data payload (0x-hex or JSON), if available"
        },
        "decodedError":{
            "$ref":"#/components/schemas/DecodedError",
            "nullable":true,
            "description":"Optional decoded revert error when available"
        },
        "requestId":{
            "type":"string",
            "nullable":true,
            "description":"Client-provided correlation ID echoed in responses"
        }
    }
}

Nested Schema : DecodedError

Type: object

Show Source

• customError: object customError
  Decoded custom error as defined in the contract ABI
• standardError: object standardError
  Decoded standard Error(string) revert
• standardPanic: object standardPanic
  Decoded Panic(uint256) revert

{
    "type":"object",
    "properties":{
        "standardError":{
            "nullable":true,
            "type":"object",
            "description":"Decoded standard Error(string) revert",
            "properties":{
                "selector":{
                    "type":"string",
                    "example":"0x08c379a0"
                },
                "message":{
                    "type":"string",
                    "nullable":true,
                    "description":"Revert message string"
                }
            }
        },
        "standardPanic":{
            "nullable":true,
            "type":"object",
            "description":"Decoded Panic(uint256) revert",
            "properties":{
                "selector":{
                    "type":"string",
                    "example":"0x4e487b71"
                },
                "code":{
                    "type":"string",
                    "nullable":true,
                    "description":"Panic code value (hex or decimal string)"
                },
                "meaning":{
                    "type":"string",
                    "nullable":true,
                    "description":"Human-readable interpretation of the panic code, when known"
                }
            }
        },
        "customError":{
            "nullable":true,
            "type":"object",
            "description":"Decoded custom error as defined in the contract ABI",
            "properties":{
                "name":{
                    "type":"string"
                },
                "signature":{
                    "type":"string"
                },
                "selector":{
                    "type":"string"
                },
                "args":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/DecodedArgument"
                    }
                }
            }
        }
    }
}

Nested Schema : customError

Type: object

Decoded custom error as defined in the contract ABI

Show Source

• args: array args
• name: string
• selector: string
• signature: string

{
    "nullable":true,
    "type":"object",
    "description":"Decoded custom error as defined in the contract ABI",
    "properties":{
        "name":{
            "type":"string"
        },
        "signature":{
            "type":"string"
        },
        "selector":{
            "type":"string"
        },
        "args":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DecodedArgument"
            }
        }
    }
}

Nested Schema : standardError

Type: object

Decoded standard Error(string) revert

Show Source

• message: string
  Revert message string
• selector: string
  Example: 0x08c379a0

{
    "nullable":true,
    "type":"object",
    "description":"Decoded standard Error(string) revert",
    "properties":{
        "selector":{
            "type":"string",
            "example":"0x08c379a0"
        },
        "message":{
            "type":"string",
            "nullable":true,
            "description":"Revert message string"
        }
    }
}

Nested Schema : standardPanic

Type: object

Decoded Panic(uint256) revert

Show Source

• code: string
  Panic code value (hex or decimal string)
• meaning: string
  Human-readable interpretation of the panic code, when known
• selector: string
  Example: 0x4e487b71

{
    "nullable":true,
    "type":"object",
    "description":"Decoded Panic(uint256) revert",
    "properties":{
        "selector":{
            "type":"string",
            "example":"0x4e487b71"
        },
        "code":{
            "type":"string",
            "nullable":true,
            "description":"Panic code value (hex or decimal string)"
        },
        "meaning":{
            "type":"string",
            "nullable":true,
            "description":"Human-readable interpretation of the panic code, when known"
        }
    }
}

Nested Schema : args

Type: array

Show Source

• Array of: object DecodedArgument

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DecodedArgument"
    }
}

Nested Schema : DecodedArgument

Type: object

Show Source

• indexed: boolean
  Only for event parameters
• name: string
  May be empty if unknown
• type: string
  Canonical ABI type (for example, uint256, address, (uint256,address), uint256[])
• value:
  Normalized JSON value (address lowercase hex, bigints as decimal strings, bytes as 0x-hex)

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"May be empty if unknown"
        },
        "type":{
            "type":"string",
            "description":"Canonical ABI type (for example, uint256, address, (uint256,address), uint256[])"
        },
        "value":{
            "nullable":true,
            "description":"Normalized JSON value (address lowercase hex, bigints as decimal strings, bytes as 0x-hex)"
        },
        "indexed":{
            "type":"boolean",
            "nullable":true,
            "description":"Only for event parameters"
        }
    }
}

500 Response

Internal error (for example, failed to estimate gasLimit)

Body ()

Root Schema : ErrorResponse

Type: object

Show Source

• decodedError: object DecodedError
• error: string
  Short error summary suitable for display
• hint: string
  Optional guidance that may help resolve the error
• message: string
  Additional error details, when available
• requestId: string
  Client-provided correlation ID echoed in responses
• upstreamCode: integer
  Upstream node error code (if provided by the RPC endpoint)
• upstreamData: string
  Raw upstream error data payload (0x-hex or JSON), if available

{
    "type":"object",
    "properties":{
        "error":{
            "type":"string",
            "description":"Short error summary suitable for display"
        },
        "message":{
            "type":"string",
            "nullable":true,
            "description":"Additional error details, when available"
        },
        "hint":{
            "type":"string",
            "nullable":true,
            "description":"Optional guidance that may help resolve the error"
        },
        "upstreamCode":{
            "type":"integer",
            "nullable":true,
            "description":"Upstream node error code (if provided by the RPC endpoint)"
        },
        "upstreamData":{
            "type":"string",
            "nullable":true,
            "description":"Raw upstream error data payload (0x-hex or JSON), if available"
        },
        "decodedError":{
            "$ref":"#/components/schemas/DecodedError",
            "nullable":true,
            "description":"Optional decoded revert error when available"
        },
        "requestId":{
            "type":"string",
            "nullable":true,
            "description":"Client-provided correlation ID echoed in responses"
        }
    }
}

Nested Schema : DecodedError

Type: object

Show Source

• customError: object customError
  Decoded custom error as defined in the contract ABI
• standardError: object standardError
  Decoded standard Error(string) revert
• standardPanic: object standardPanic
  Decoded Panic(uint256) revert

{
    "type":"object",
    "properties":{
        "standardError":{
            "nullable":true,
            "type":"object",
            "description":"Decoded standard Error(string) revert",
            "properties":{
                "selector":{
                    "type":"string",
                    "example":"0x08c379a0"
                },
                "message":{
                    "type":"string",
                    "nullable":true,
                    "description":"Revert message string"
                }
            }
        },
        "standardPanic":{
            "nullable":true,
            "type":"object",
            "description":"Decoded Panic(uint256) revert",
            "properties":{
                "selector":{
                    "type":"string",
                    "example":"0x4e487b71"
                },
                "code":{
                    "type":"string",
                    "nullable":true,
                    "description":"Panic code value (hex or decimal string)"
                },
                "meaning":{
                    "type":"string",
                    "nullable":true,
                    "description":"Human-readable interpretation of the panic code, when known"
                }
            }
        },
        "customError":{
            "nullable":true,
            "type":"object",
            "description":"Decoded custom error as defined in the contract ABI",
            "properties":{
                "name":{
                    "type":"string"
                },
                "signature":{
                    "type":"string"
                },
                "selector":{
                    "type":"string"
                },
                "args":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/DecodedArgument"
                    }
                }
            }
        }
    }
}

Nested Schema : customError

Type: object

Decoded custom error as defined in the contract ABI

Show Source

• args: array args
• name: string
• selector: string
• signature: string

{
    "nullable":true,
    "type":"object",
    "description":"Decoded custom error as defined in the contract ABI",
    "properties":{
        "name":{
            "type":"string"
        },
        "signature":{
            "type":"string"
        },
        "selector":{
            "type":"string"
        },
        "args":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DecodedArgument"
            }
        }
    }
}

Nested Schema : standardError

Type: object

Decoded standard Error(string) revert

Show Source

• message: string
  Revert message string
• selector: string
  Example: 0x08c379a0

{
    "nullable":true,
    "type":"object",
    "description":"Decoded standard Error(string) revert",
    "properties":{
        "selector":{
            "type":"string",
            "example":"0x08c379a0"
        },
        "message":{
            "type":"string",
            "nullable":true,
            "description":"Revert message string"
        }
    }
}

Nested Schema : standardPanic

Type: object

Decoded Panic(uint256) revert

Show Source

• code: string
  Panic code value (hex or decimal string)
• meaning: string
  Human-readable interpretation of the panic code, when known
• selector: string
  Example: 0x4e487b71

{
    "nullable":true,
    "type":"object",
    "description":"Decoded Panic(uint256) revert",
    "properties":{
        "selector":{
            "type":"string",
            "example":"0x4e487b71"
        },
        "code":{
            "type":"string",
            "nullable":true,
            "description":"Panic code value (hex or decimal string)"
        },
        "meaning":{
            "type":"string",
            "nullable":true,
            "description":"Human-readable interpretation of the panic code, when known"
        }
    }
}

Nested Schema : args

Type: array

Show Source

• Array of: object DecodedArgument

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DecodedArgument"
    }
}

Nested Schema : DecodedArgument

Type: object

Show Source

• indexed: boolean
  Only for event parameters
• name: string
  May be empty if unknown
• type: string
  Canonical ABI type (for example, uint256, address, (uint256,address), uint256[])
• value:
  Normalized JSON value (address lowercase hex, bigints as decimal strings, bytes as 0x-hex)

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"May be empty if unknown"
        },
        "type":{
            "type":"string",
            "description":"Canonical ABI type (for example, uint256, address, (uint256,address), uint256[])"
        },
        "value":{
            "nullable":true,
            "description":"Normalized JSON value (address lowercase hex, bigints as decimal strings, bytes as 0x-hex)"
        },
        "indexed":{
            "type":"boolean",
            "nullable":true,
            "description":"Only for event parameters"
        }
    }
}

502 Response

Upstream Besu error

Body ()

Root Schema : ErrorResponse

Type: object

Show Source

• decodedError: object DecodedError
• error: string
  Short error summary suitable for display
• hint: string
  Optional guidance that may help resolve the error
• message: string
  Additional error details, when available
• requestId: string
  Client-provided correlation ID echoed in responses
• upstreamCode: integer
  Upstream node error code (if provided by the RPC endpoint)
• upstreamData: string
  Raw upstream error data payload (0x-hex or JSON), if available

{
    "type":"object",
    "properties":{
        "error":{
            "type":"string",
            "description":"Short error summary suitable for display"
        },
        "message":{
            "type":"string",
            "nullable":true,
            "description":"Additional error details, when available"
        },
        "hint":{
            "type":"string",
            "nullable":true,
            "description":"Optional guidance that may help resolve the error"
        },
        "upstreamCode":{
            "type":"integer",
            "nullable":true,
            "description":"Upstream node error code (if provided by the RPC endpoint)"
        },
        "upstreamData":{
            "type":"string",
            "nullable":true,
            "description":"Raw upstream error data payload (0x-hex or JSON), if available"
        },
        "decodedError":{
            "$ref":"#/components/schemas/DecodedError",
            "nullable":true,
            "description":"Optional decoded revert error when available"
        },
        "requestId":{
            "type":"string",
            "nullable":true,
            "description":"Client-provided correlation ID echoed in responses"
        }
    }
}

Nested Schema : DecodedError

Type: object

Show Source

• customError: object customError
  Decoded custom error as defined in the contract ABI
• standardError: object standardError
  Decoded standard Error(string) revert
• standardPanic: object standardPanic
  Decoded Panic(uint256) revert

{
    "type":"object",
    "properties":{
        "standardError":{
            "nullable":true,
            "type":"object",
            "description":"Decoded standard Error(string) revert",
            "properties":{
                "selector":{
                    "type":"string",
                    "example":"0x08c379a0"
                },
                "message":{
                    "type":"string",
                    "nullable":true,
                    "description":"Revert message string"
                }
            }
        },
        "standardPanic":{
            "nullable":true,
            "type":"object",
            "description":"Decoded Panic(uint256) revert",
            "properties":{
                "selector":{
                    "type":"string",
                    "example":"0x4e487b71"
                },
                "code":{
                    "type":"string",
                    "nullable":true,
                    "description":"Panic code value (hex or decimal string)"
                },
                "meaning":{
                    "type":"string",
                    "nullable":true,
                    "description":"Human-readable interpretation of the panic code, when known"
                }
            }
        },
        "customError":{
            "nullable":true,
            "type":"object",
            "description":"Decoded custom error as defined in the contract ABI",
            "properties":{
                "name":{
                    "type":"string"
                },
                "signature":{
                    "type":"string"
                },
                "selector":{
                    "type":"string"
                },
                "args":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/DecodedArgument"
                    }
                }
            }
        }
    }
}

Nested Schema : customError

Type: object

Decoded custom error as defined in the contract ABI

Show Source

• args: array args
• name: string
• selector: string
• signature: string

{
    "nullable":true,
    "type":"object",
    "description":"Decoded custom error as defined in the contract ABI",
    "properties":{
        "name":{
            "type":"string"
        },
        "signature":{
            "type":"string"
        },
        "selector":{
            "type":"string"
        },
        "args":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DecodedArgument"
            }
        }
    }
}

Nested Schema : standardError

Type: object

Decoded standard Error(string) revert

Show Source

• message: string
  Revert message string
• selector: string
  Example: 0x08c379a0

{
    "nullable":true,
    "type":"object",
    "description":"Decoded standard Error(string) revert",
    "properties":{
        "selector":{
            "type":"string",
            "example":"0x08c379a0"
        },
        "message":{
            "type":"string",
            "nullable":true,
            "description":"Revert message string"
        }
    }
}

Nested Schema : standardPanic

Type: object

Decoded Panic(uint256) revert

Show Source

• code: string
  Panic code value (hex or decimal string)
• meaning: string
  Human-readable interpretation of the panic code, when known
• selector: string
  Example: 0x4e487b71

{
    "nullable":true,
    "type":"object",
    "description":"Decoded Panic(uint256) revert",
    "properties":{
        "selector":{
            "type":"string",
            "example":"0x4e487b71"
        },
        "code":{
            "type":"string",
            "nullable":true,
            "description":"Panic code value (hex or decimal string)"
        },
        "meaning":{
            "type":"string",
            "nullable":true,
            "description":"Human-readable interpretation of the panic code, when known"
        }
    }
}

Nested Schema : args

Type: array

Show Source

• Array of: object DecodedArgument

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DecodedArgument"
    }
}

Nested Schema : DecodedArgument

Type: object

Show Source

• indexed: boolean
  Only for event parameters
• name: string
  May be empty if unknown
• type: string
  Canonical ABI type (for example, uint256, address, (uint256,address), uint256[])
• value:
  Normalized JSON value (address lowercase hex, bigints as decimal strings, bytes as 0x-hex)

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"May be empty if unknown"
        },
        "type":{
            "type":"string",
            "description":"Canonical ABI type (for example, uint256, address, (uint256,address), uint256[])"
        },
        "value":{
            "nullable":true,
            "description":"Normalized JSON value (address lowercase hex, bigints as decimal strings, bytes as 0x-hex)"
        },
        "indexed":{
            "type":"boolean",
            "nullable":true,
            "description":"Only for event parameters"
        }
    }
}

Back to Top