Merge pull request #34 from starkware-libs/liors/pending-txn-receipt

add pending transaction receipt
starkware-libs · Jul 25, 2022 · 30e5baf · 30e5baf
2 parents e89f9de + 219b360
commit 30e5baf
Showing 1 changed file with 71 additions and 24 deletions.
diff --git a/api/starknet_api_openrpc.json b/api/starknet_api_openrpc.json
@@ -1266,37 +1266,41 @@
                     "block_number"
                 ]
             },
+            "INVOKE_TXN_RECEIPT_PROPERTIES": {
+                "description": "Properties specific to invoke transaction",
+                "type": "object",
+                "properties": {
+                    "messages_sent": {
+                        "type": "array",
+                        "items": {
+                            "$ref": "#/components/schemas/MSG_TO_L1"
+                        }
+                    },
+                    "l1_origin_message": {
+                        "description": "In case this transaction was an L1 handler, this is the original message that invoked it",
+                        "$ref": "#/components/schemas/MSG_TO_L2"
+                    },
+                    "events": {
+                        "description": "The events emitted as part of this transaction",
+                        "type": "array",
+                        "items": {
+                            "$ref": "#/components/schemas/EVENT"
+                        }
+                    }
+                },
+                "required": [
+                    "messages_sent",
+                    "events"
+                ]
+            },
             "INVOKE_TXN_RECEIPT": {
                 "title": "Invoke Transaction Receipt",
                 "allOf": [
                     {
                         "$ref": "#/components/schemas/COMMON_RECEIPT_PROPERTIES"
                     },
                     {
-                        "type": "object",
-                        "properties": {
-                            "messages_sent": {
-                                "type": "array",
-                                "items": {
-                                    "$ref": "#/components/schemas/MSG_TO_L1"
-                                }
-                            },
-                            "l1_origin_message": {
-                                "description": "In case this transaction was an L1 handler, this is the original message that invoked it",
-                                "$ref": "#/components/schemas/MSG_TO_L2"
-                            },
-                            "events": {
-                                "description": "The events emitted as part of this transaction",
-                                "type": "array",
-                                "items": {
-                                    "$ref": "#/components/schemas/EVENT"
-                                }
-                            }
-                        },
-                        "required": [
-                            "messages_sent",
-                            "events"
-                        ]
+                        "$ref": "#/components/schemas/INVOKE_TXN_RECEIPT_PROPERTIES"
                     }
                 ]
             },
@@ -1318,6 +1322,49 @@
                     },
                     {
                         "$ref": "#/components/schemas/DEPLOY_TXN_RECEIPT"
+                    },
+                    {
+                        "$ref": "#/components/schemas/PENDING_TXN_RECEIPT"
+                    }
+                ]
+            },
+            "PENDING_COMMON_RECEIPT_PROPERTIES": {
+                "title": "Common properties for a pending transaction receipt",
+                "type": "object",
+                "properties": {
+                    "transaction_hash": {
+                        "$ref": "#/components/schemas/TXN_HASH",
+                        "description": "The hash identifying the transaction"
+                    },
+                    "actual_fee": {
+                        "$ref": "#/components/schemas/FELT",
+                        "description": "The fee that was charged by the sequencer"
+                    }
+                },
+                "required": [
+                    "transaction_hash",
+                    "actual_fee"
+                ]
+            },
+            "PENDING_INVOKE_TXN_RECEIPT": {
+                "title": "Pending Invoke Transaction Receipt",
+                "allOf": [
+                    {
+                        "$ref": "#/components/schemas/PENDING_COMMON_RECEIPT_PROPERTIES"
+                    },
+                    {
+                        "$ref": "#/components/schemas/INVOKE_TXN_RECEIPT_PROPERTIES"
+                    }
+                ]
+            },
+            "PENDING_TXN_RECEIPT": {
+                "oneOf": [
+                    {
+                        "$ref": "#/components/schemas/PENDING_INVOKE_TXN_RECEIPT"
+                    },
+                    {
+                        "$comment": "Used for deploy and declare transaction receipts",
+                        "$ref": "#/components/schemas/PENDING_COMMON_RECEIPT_PROPERTIES"
                     }
                 ]
             },