Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add getMessagesStatus endpoint #223

Merged
merged 1 commit into from
Sep 18, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 51 additions & 1 deletion api/starknet_api_openrpc.json
Original file line number Diff line number Diff line change
Expand Up @@ -260,6 +260,52 @@
}
]
},
{
"name": "starknet_getMessagesStatus",
"summary": "Given an l1 tx hash, returns the associated l1_handler tx hashes and statuses for all L1 -> L2 messages sent by the l1 ransaction, ordered by the l1 tx sending order",
"paramStructure": "by-name",
"params": [
{
"name": "transaction_hash",
"summary": "The hash of the L1 transaction that sent L1->L2 messages",
"required": true,
"schema": {
"title": "Transaction hash",
"$ref": "#/components/schemas/L1_TXN_HASH"
}
}
],
"result": {
"name": "result",
"schema": {
"type": "array",
"items": {
"type": "object",
"title": "status",
"properties": {
"transaction_hash": {
"$ref": "#/components/schemas/TXN_HASH"
},
"finality_status": {
"title": "finality status",
"$ref": "#/components/schemas/TXN_STATUS"
},
"failure_reason": {
"title": "failure reason",
"description": "the failure reason, only appears if finality_status is REJECTED",
"type": "string"
}
},
"required": ["transaction_hash", "finality_status"]
}
}
},
"errors": [
{
"$ref": "#/components/errors/TXN_HASH_NOT_FOUND"
}
]
},
{
"name": "starknet_getTransactionByHash",
"summary": "Get the details and status of a submitted transaction",
Expand Down Expand Up @@ -1293,9 +1339,13 @@
},
"TXN_HASH": {
"$ref": "#/components/schemas/FELT",
"description": "The transaction hash, as assigned in StarkNet",
"description": "The hash of a Starknet transaction",
"title": "Transaction hash"
},
"L1_TXN_HASH": {
"$ref": "#/components/schemas/NUM_AS_HEX",
"description": "The hash of an Ethereum transaction"
},
"FELT": {
"type": "string",
"title": "Field element",
Expand Down