Skip to content

Commit 585b994

Browse files
quiet-nodequiet-node
committed
docs: added specification for debug_traceBlockByNumber
Signed-off-by: Logan Nguyen <logan.nguyen@swirldslabs.com>
1 parent ddc5cad commit 585b994

File tree

1 file changed

+138
-1
lines changed

1 file changed

+138
-1
lines changed

‎docs/openrpc.json

Lines changed: 138 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
{
2020
"name": "Previewnet",
2121
"url": "https://previewnet.hashio.io/api",
22-
"description": "Hedera Previewnet endpoint, hosted by [Hashio](https://swirldslabs.com/hashio/), a JSON-RPC Relay Community Service. Rate limited based [on IP address](https://github.com/hiero-ledger/hiero-json-rpc-relay/blob/main/docs/rate-limiting.md) and [on global HBAR spend](https://github.com/hiero-ledger/hiero-json-rpc-relay/blob/main/docs/hbar-limiting.md)."
22+
"description": "Hedera Previewnet endpoint, hosted by [Hashio](https://swirldslabs.com/hashio/), a JSON-RPC Relay Community Service. Rate limited based [on IP address](https://github.com/hiero-ledger/hiero-json-rpc-relay/blob/main/docs/rate-limiting.png) and [on global HBAR spend](https://github.com/hiero-ledger/hiero-json-rpc-relay/blob/main/docs/hbar-limiting.md)."
2323
},
2424
{
2525
"name": "localhost",
@@ -1105,6 +1105,138 @@
11051105
},
11061106
"description": "The trace object containing detailed information about the transaction execution, encapsulated in a call frame."
11071107
}
1108+
},
1109+
{
1110+
"name": "debug_traceBlockByNumber",
1111+
"summary": "Returns the tracing result for all transactions in the block specified by number with a tracer.",
1112+
"description": "![](https://raw.githubusercontent.com/hiero-ledger/hiero-json-rpc-relay/main/docs/images/http_label.png)",
1113+
"params": [
1114+
{
1115+
"name": "blockNumber",
1116+
"required": true,
1117+
"schema": {
1118+
"$ref": "#/components/schemas/BlockNumberOrTag"
1119+
},
1120+
"description": "The block number or tag (e.g., 'latest', 'earliest', 'pending', 'safe', 'finalized')."
1121+
},
1122+
{
1123+
"name": "tracerOptions",
1124+
"required": false,
1125+
"schema": {
1126+
"type": "object",
1127+
"properties": {
1128+
"tracer": {
1129+
"$ref": "#/components/schemas/BlockTracerType",
1130+
"description": "The type of tracer to use. Either 'callTracer' or 'prestateTracer'."
1131+
},
1132+
"tracerConfig": {
1133+
"type": "object",
1134+
"description": "Configuration options for the specified tracer",
1135+
"properties": {
1136+
"onlyTopCall": {
1137+
"type": "boolean",
1138+
"description": "When set to true, this will only trace the primary (top-level) call and not any sub-calls."
1139+
}
1140+
}
1141+
}
1142+
}
1143+
},
1144+
"description": "Specifies the type of tracer and optional configuration. Supported tracers are 'callTracer' and 'prestateTracer'."
1145+
}
1146+
],
1147+
"result": {
1148+
"name": "traces",
1149+
"schema": {
1150+
"type": "array",
1151+
"items": {
1152+
"oneOf": [
1153+
{
1154+
"type": "object",
1155+
"description": "callTracer response format",
1156+
"properties": {
1157+
"type": {
1158+
"type": "string",
1159+
"enum": ["CALL", "CREATE"],
1160+
"description": "The type of action (CALL for function calls or CREATE for contract creation)."
1161+
},
1162+
"from": {
1163+
"$ref": "#/components/schemas/address",
1164+
"description": "The address of the sender."
1165+
},
1166+
"to": {
1167+
"$ref": "#/components/schemas/address",
1168+
"description": "The address of the receiver. In the case of a contract creation, this might be null."
1169+
},
1170+
"value": {
1171+
"$ref": "#/components/schemas/uint",
1172+
"description": "The value transferred with the call, in hexadecimal."
1173+
},
1174+
"gas": {
1175+
"$ref": "#/components/schemas/uint",
1176+
"description": "The gas provided for the call, in hexadecimal."
1177+
},
1178+
"gasUsed": {
1179+
"$ref": "#/components/schemas/uint",
1180+
"description": "The gas used during the call, in hexadecimal."
1181+
},
1182+
"input": {
1183+
"$ref": "#/components/schemas/bytes",
1184+
"description": "The input data sent with the call."
1185+
},
1186+
"output": {
1187+
"$ref": "#/components/schemas/bytes",
1188+
"description": "The output data returned by the call."
1189+
},
1190+
"error": {
1191+
"type": "string",
1192+
"description": "Error encountered during the call, if any."
1193+
},
1194+
"revertReason": {
1195+
"type": "string",
1196+
"description": "Solidity revert reason, if applicable."
1197+
},
1198+
"calls": {
1199+
"type": "array",
1200+
"items": {
1201+
"$ref": "#/components/schemas/subcall"
1202+
},
1203+
"description": "Sub-calls made during this call frame."
1204+
}
1205+
}
1206+
},
1207+
{
1208+
"type": "object",
1209+
"description": "prestateTracer response format",
1210+
"additionalProperties": {
1211+
"type": "object",
1212+
"properties": {
1213+
"balance": {
1214+
"$ref": "#/components/schemas/uint",
1215+
"description": "Account balance at execution time"
1216+
},
1217+
"nonce": {
1218+
"$ref": "#/components/schemas/uint",
1219+
"description": "Account latest nonce. Historical nonces are not stored due to performance and storage concerns."
1220+
},
1221+
"code": {
1222+
"$ref": "#/components/schemas/bytes",
1223+
"description": "Contract code at execution time"
1224+
},
1225+
"storage": {
1226+
"type": "object",
1227+
"description": "Storage slots at execution time",
1228+
"additionalProperties": {
1229+
"$ref": "#/components/schemas/bytes32"
1230+
}
1231+
}
1232+
}
1233+
}
1234+
}
1235+
]
1236+
}
1237+
},
1238+
"description": "An array of trace objects containing detailed information about the execution of all transactions in the block. The format depends on the tracer used."
1239+
}
11081240
}
11091241
],
11101242
"components": {
@@ -1448,6 +1580,11 @@
14481580
}
14491581
}
14501582
},
1583+
"BlockTracerType": {
1584+
"title": "Block tracer type",
1585+
"type": "string",
1586+
"enum": ["callTracer", "prestateTracer"]
1587+
},
14511588
"TransactionWithSender": {
14521589
"title": "Transaction object with sender",
14531590
"type": "object",

0 commit comments

Comments
 (0)