Pre-General Availability: 2026-02-23

Jump to

• Request
• Response

Read-only Contract Query

post

/v1/besu/query

Executes an eth_call 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 read-only contract query

Show Source

• blockTag: string
  Block tag ("latest", "pending", "earliest", hex or decimal block number)
• contractAbi: array contractAbi
  Optional ABI used to infer parameter types when functionSignature omits types (name-only). If omitted and toAddress is provided, the gateway may resolve the ABI by address when available.
• data: string
  Hex calldata; if absent and functionSignature provided, gateway encodes it
• decode: object DecodeOptions
  Selective decode options; flags default to false when omitted.
• ethValue: string
  Optional wei value for eth_call
• fromAddress: string
  Optional call sender; defaults to zero-address if omitted
• functionArgs: array functionArgs
  Function arguments as strings. Scalars as plain strings; arrays/tuples as JSON strings (for example, '["1","2"]').
• functionSignature: string
  Function selector for ABI encoding. Provide fully specified signature (for example, "balanceOf(address)") or name-only. For name-only, parameter types are inferred from contractAbi when provided; if absent and toAddress is provided, the gateway may resolve the ABI by address when available.
• gasLimit: integer
  Optional gas limit for eth_call execution
• toAddress(required): string
  Target contract address

{
    "type":"object",
    "description":"Input for read-only contract query",
    "properties":{
        "toAddress":{
            "type":"string",
            "description":"Target contract address"
        },
        "data":{
            "type":"string",
            "description":"Hex calldata; if absent and functionSignature provided, gateway encodes it"
        },
        "functionSignature":{
            "type":"string",
            "description":"Function selector for ABI encoding. Provide fully specified signature (for example, \"balanceOf(address)\") or name-only. For name-only, parameter types are inferred from contractAbi when provided; if absent 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. Scalars as plain strings; arrays/tuples as JSON strings (for example, '[\"1\",\"2\"]').\n"
        },
        "contractAbi":{
            "type":"array",
            "items":{
                "type":"object"
            },
            "description":"Optional ABI used to infer parameter types when functionSignature omits types (name-only). If omitted and toAddress is provided, the gateway may resolve the ABI by address when available.\n"
        },
        "fromAddress":{
            "type":"string",
            "description":"Optional call sender; defaults to zero-address if omitted"
        },
        "gasLimit":{
            "type":"integer",
            "description":"Optional gas limit for eth_call execution"
        },
        "ethValue":{
            "type":"string",
            "description":"Optional wei value for eth_call"
        },
        "blockTag":{
            "type":"string",
            "description":"Block tag (\"latest\", \"pending\", \"earliest\", hex or decimal block number)"
        },
        "decode":{
            "$ref":"#/components/schemas/DecodeOptions"
        }
    },
    "required":[
        "toAddress"
    ]
}

Nested Schema : contractAbi

Type: array

Optional ABI used to infer parameter types when functionSignature omits types (name-only). If omitted and toAddress is provided, the gateway may resolve the ABI by address when available.

Show Source

• Array of: object items

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

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. Scalars as plain strings; arrays/tuples as JSON strings (for example, '["1","2"]').

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"Function arguments as strings. Scalars as plain strings; arrays/tuples as JSON strings (for example, '[\"1\",\"2\"]').\n"
}

Nested Schema : items

Type: object

Examples

Select an example ERC20 balanceOf via fully-specified signature name-only signature with contractAbi to infer types Provide pre-encoded calldata directly Decode outputs for balanceOf Name-only signature without contractAbi

Back to Top

Response

Supported Media Types

• application/json

200 Response

eth_call executed

Body ()

Root Schema : QueryResponse

Type: object

Show Source

• blockTag: string
  Block parameter used for the call ("latest", "pending", "earliest", or a block number)
• data: string
  0x-hex encoded calldata used for the call
• decoded: object DecodedResult
  Aggregate decoded information for the transaction or call
• encodedFromSignature: boolean
  True if calldata was generated from functionSignature
• from: string
  Sender address used to execute the eth_call
• rawResult: string
  0x-hex return data from eth_call
• to: string
  Target contract address for the call

{
    "type":"object",
    "properties":{
        "to":{
            "type":"string",
            "description":"Target contract address for the call"
        },
        "from":{
            "type":"string",
            "description":"Sender address used to execute the eth_call"
        },
        "data":{
            "type":"string",
            "description":"0x-hex encoded calldata used for the call"
        },
        "blockTag":{
            "type":"string",
            "description":"Block parameter used for the call (\"latest\", \"pending\", \"earliest\", or a block number)"
        },
        "rawResult":{
            "type":"string",
            "description":"0x-hex return data from eth_call"
        },
        "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 : 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 success Returns decoded output when requested

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"
        }
    }
}

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"
        }
    }
}

Examples

Select an example Decoded standard Error(string) Decoded standard Panic(uint256) Decoded custom error

Back to Top