From f85c69635a67308da6fb27fe8a2b04d129598eb3 Mon Sep 17 00:00:00 2001 From: jlwllmr <95916148+jlwllmr@users.noreply.github.com> Date: Thu, 12 Sep 2024 14:31:02 +0100 Subject: [PATCH 01/18] Initial draft --- .../linea_getTransactionExclusionStatusV1.mdx | 81 +++++++++++++++++++ 1 file changed, 81 insertions(+) create mode 100644 docs/developers/reference/api/linea_getTransactionExclusionStatusV1.mdx diff --git a/docs/developers/reference/api/linea_getTransactionExclusionStatusV1.mdx b/docs/developers/reference/api/linea_getTransactionExclusionStatusV1.mdx new file mode 100644 index 000000000..27f79f63a --- /dev/null +++ b/docs/developers/reference/api/linea_getTransactionExclusionStatusV1.mdx @@ -0,0 +1,81 @@ +--- +title: linea_getTransactionExclusionStatusV1 +description: Reference content for the linea_getTransactionExclusionStatusV1 method. +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# `linea_getTransactionExclusionStatusV1` + +Queries a database maintained by the sequencer to check if a tranasction was rejected because it +exceeded limits that would prevent the prover from generating a proof for the block. + +If the transaction was rejected, the API call will be successful and provide details of why. + +Transactions that were not rejected for this reason will return a `Rejected transaction not available` +error. + +:::warning +Transactions older than 24 hours cannot be checked. +::: + +## Parameters + +`txHash`: [Required] The hash of the subject transaction. + +## Returns + +`txHash`: The hash of the subject transaction. +`from`: The public address of the account that sent the transaction. +`nonce`: The transaction nonce, hexadecimal. +`txRejectionStage`: A string detailing the point at which the transaction was rejected. One of: + - `SEQUENCER`: Rejected by the sequencer. + - `RPC`: + - `P2P`: +`reasonMessage`: Explains why the transaction was rejected. +`blockNumber`: The block that the transaction was rejected from, in hexadecimal format. +`timestamp`: Time of rejection, in ISO8601 format. + +## Example + +### Request + + + + ```bash + curl https://rpc.linea.build \ + -X POST + -H "Content-Type: application/json" \ + -d '{ + "jsonrpc": "2.0", + "id": "1", + "method": "linea_getTransactionExclusionStatusV1", + "params": ["0xf5bf951edfefbaa6d9ed78c88942147cf98c8ef1f3d3416f99d2534675096569"], + }' + ``` + + + +### Response + + + + ```json + { + "jsonrpc": "2.0", + "id": 53, + "result": { + "txHash": "0x526e56101cf39c1e717cef9cedf6fdddb42684711abda35bae51136dbb350ad7", + "from": "0x4d144d7b9c96b26361d6ac74dd1d8267edca4fc2", + "nonce": "0x64", + "txRejectionStage": "SEQUENCER", + "reasonMessage": "Transaction line count for module ADD=402 is above the limit 70", + "blockNumber": "0x3039", + "timestamp": "2024-08-22T09:18:51Z" + } + } + ``` + + + From 824cb139bd39f01bea971e28b333c821f721e3ea Mon Sep 17 00:00:00 2001 From: jlwllmr <95916148+jlwllmr@users.noreply.github.com> Date: Thu, 12 Sep 2024 14:32:29 +0100 Subject: [PATCH 02/18] Rename file and add to sidebar --- ...ionStatusV1.mdx => linea-gettransactionexclusionstatusv1.mdx} | 0 sidebars.js | 1 + 2 files changed, 1 insertion(+) rename docs/developers/reference/api/{linea_getTransactionExclusionStatusV1.mdx => linea-gettransactionexclusionstatusv1.mdx} (100%) diff --git a/docs/developers/reference/api/linea_getTransactionExclusionStatusV1.mdx b/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx similarity index 100% rename from docs/developers/reference/api/linea_getTransactionExclusionStatusV1.mdx rename to docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx diff --git a/sidebars.js b/sidebars.js index d0bb05bff..f1c76d230 100644 --- a/sidebars.js +++ b/sidebars.js @@ -435,6 +435,7 @@ const sidebars = { items: [ "developers/reference/api/eth-sendrawtransaction", "developers/reference/api/linea-estimategas", + "developers/reference/api/linea-gettransactionexclusionstatusv1", "developers/reference/api/linea-getproof", ], }, From 04a8c39e08c61dacf459528dd61903eb5993e39d Mon Sep 17 00:00:00 2001 From: jlwllmr <95916148+jlwllmr@users.noreply.github.com> Date: Thu, 12 Sep 2024 16:17:09 +0100 Subject: [PATCH 03/18] Update txRejectionStage string descriptions --- .../api/linea-gettransactionexclusionstatusv1.mdx | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx b/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx index 27f79f63a..22dce0320 100644 --- a/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx +++ b/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx @@ -31,10 +31,11 @@ Transactions older than 24 hours cannot be checked. `nonce`: The transaction nonce, hexadecimal. `txRejectionStage`: A string detailing the point at which the transaction was rejected. One of: - `SEQUENCER`: Rejected by the sequencer. - - `RPC`: - - `P2P`: + - `RPC`: Rejected by an RPC node (e.g. `https://rpc.linea.build`). + - `P2P`: Rejected by a P2P-connected node (e.g. an edge node). `reasonMessage`: Explains why the transaction was rejected. -`blockNumber`: The block that the transaction was rejected from, in hexadecimal format. +`blockNumber`: The block that the transaction was rejected from, in hexadecimal format. Only +returned for transactions rejected by the sequencer. `timestamp`: Time of rejection, in ISO8601 format. ## Example @@ -51,7 +52,7 @@ Transactions older than 24 hours cannot be checked. "jsonrpc": "2.0", "id": "1", "method": "linea_getTransactionExclusionStatusV1", - "params": ["0xf5bf951edfefbaa6d9ed78c88942147cf98c8ef1f3d3416f99d2534675096569"], + "params": ["0x526e56101cf39c1e717cef9cedf6fdddb42684711abda35bae51136dbb350ad7"], }' ``` @@ -64,7 +65,7 @@ Transactions older than 24 hours cannot be checked. ```json { "jsonrpc": "2.0", - "id": 53, + "id": "53", "result": { "txHash": "0x526e56101cf39c1e717cef9cedf6fdddb42684711abda35bae51136dbb350ad7", "from": "0x4d144d7b9c96b26361d6ac74dd1d8267edca4fc2", From 5e3f09988aa4862655912911f7e67a6f3d450611 Mon Sep 17 00:00:00 2001 From: jlwllmr <95916148+jlwllmr@users.noreply.github.com> Date: Mon, 16 Sep 2024 09:24:58 +0100 Subject: [PATCH 04/18] Update formatting and minor adjustments --- .../linea-gettransactionexclusionstatusv1.mdx | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx b/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx index 22dce0320..c124cb34a 100644 --- a/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx +++ b/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx @@ -26,17 +26,17 @@ Transactions older than 24 hours cannot be checked. ## Returns -`txHash`: The hash of the subject transaction. -`from`: The public address of the account that sent the transaction. -`nonce`: The transaction nonce, hexadecimal. -`txRejectionStage`: A string detailing the point at which the transaction was rejected. One of: +- `txHash`: The hash of the subject transaction. +- `from`: The public address of the account that sent the transaction. +- `nonce`: The transaction nonce, hexadecimal. +- `txRejectionStage`: A string detailing the point at which the transaction was rejected. One of: - `SEQUENCER`: Rejected by the sequencer. - `RPC`: Rejected by an RPC node (e.g. `https://rpc.linea.build`). - - `P2P`: Rejected by a P2P-connected node (e.g. an edge node). -`reasonMessage`: Explains why the transaction was rejected. -`blockNumber`: The block that the transaction was rejected from, in hexadecimal format. Only -returned for transactions rejected by the sequencer. -`timestamp`: Time of rejection, in ISO8601 format. + - `P2P`: Rejected by a P2P-connected node (e.g. an edge node). +- `reasonMessage`: Explains why the transaction was rejected. +- `blockNumber`: The block that the transaction was rejected from, in hexadecimal format. Only +returned for transactions rejected by the sequencer. +- `timestamp`: Time of rejection, in ISO8601 format. ## Example @@ -65,7 +65,7 @@ returned for transactions rejected by the sequencer. ```json { "jsonrpc": "2.0", - "id": "53", + "id": "1", "result": { "txHash": "0x526e56101cf39c1e717cef9cedf6fdddb42684711abda35bae51136dbb350ad7", "from": "0x4d144d7b9c96b26361d6ac74dd1d8267edca4fc2", From ba6c869b01e1d53d66555d442ca05f7ff53eba21 Mon Sep 17 00:00:00 2001 From: jlwllmr <95916148+jlwllmr@users.noreply.github.com> Date: Mon, 16 Sep 2024 09:26:51 +0100 Subject: [PATCH 05/18] Typos --- .../reference/api/linea-gettransactionexclusionstatusv1.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx b/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx index c124cb34a..3aea3185a 100644 --- a/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx +++ b/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx @@ -8,10 +8,10 @@ import TabItem from '@theme/TabItem'; # `linea_getTransactionExclusionStatusV1` -Queries a database maintained by the sequencer to check if a tranasction was rejected because it +Queries a database maintained by the sequencer to check if a transaction was rejected because it exceeded limits that would prevent the prover from generating a proof for the block. -If the transaction was rejected, the API call will be successful and provide details of why. +If the transaction was rejected, the API call will be successful and provide the reason. Transactions that were not rejected for this reason will return a `Rejected transaction not available` error. From 79cf5ff91129c966b4d58980a378b79d6c7bb9d5 Mon Sep 17 00:00:00 2001 From: jlwllmr <95916148+jlwllmr@users.noreply.github.com> Date: Mon, 16 Sep 2024 09:27:37 +0100 Subject: [PATCH 06/18] Adjust wording --- .../reference/api/linea-gettransactionexclusionstatusv1.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx b/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx index 3aea3185a..f85e29287 100644 --- a/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx +++ b/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx @@ -9,7 +9,7 @@ import TabItem from '@theme/TabItem'; # `linea_getTransactionExclusionStatusV1` Queries a database maintained by the sequencer to check if a transaction was rejected because it -exceeded limits that would prevent the prover from generating a proof for the block. +exceeded data line limits that would prevent the prover from generating a proof for the block. If the transaction was rejected, the API call will be successful and provide the reason. From e6a82557ae506f99fb2355574a8db01be98fcada Mon Sep 17 00:00:00 2001 From: jlwllmr <95916148+jlwllmr@users.noreply.github.com> Date: Tue, 17 Sep 2024 10:46:04 +0100 Subject: [PATCH 07/18] Address comments --- .../api/linea-gettransactionexclusionstatusv1.mdx | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx b/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx index f85e29287..09c2007e8 100644 --- a/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx +++ b/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx @@ -8,13 +8,14 @@ import TabItem from '@theme/TabItem'; # `linea_getTransactionExclusionStatusV1` -Queries a database maintained by the sequencer to check if a transaction was rejected because it -exceeded data line limits that would prevent the prover from generating a proof for the block. +Queries a database maintained by the transaction exclusion API service to check if a transaction +was rejected because it exceeded data line limits that would prevent the prover from generating a +proof for the block. The database is updated by a parallel write API endpoint called by the +sequencer, edge nodes, or RPC nodes. If the transaction was rejected, the API call will be successful and provide the reason. -Transactions that were not rejected for this reason will return a `Rejected transaction not available` -error. +Transactions that were not rejected for this reason will return `null` as the `result`. :::warning Transactions older than 24 hours cannot be checked. From 9cc865b4a66766f3e2d74ec8a56f1294065520ae Mon Sep 17 00:00:00 2001 From: jlwllmr <95916148+jlwllmr@users.noreply.github.com> Date: Tue, 17 Sep 2024 10:49:41 +0100 Subject: [PATCH 08/18] Add null result --- .../api/linea-gettransactionexclusionstatusv1.mdx | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx b/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx index 09c2007e8..3c4af0b5d 100644 --- a/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx +++ b/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx @@ -81,3 +81,13 @@ returned for transactions rejected by the sequencer. +If the transaction was not rejected for exceeding line limits, the transaction will not be found +in the database, and return a `null` result. For example: + +```json +{ + "jsonrpc": "2.0", + "id": 1, + "result": null +} +``` From b609dacb346d8fada52b65bb09c9a2b25a61c80f Mon Sep 17 00:00:00 2001 From: jlwllmr <95916148+jlwllmr@users.noreply.github.com> Date: Wed, 18 Sep 2024 10:37:55 +0100 Subject: [PATCH 09/18] Amendments --- .../linea-gettransactionexclusionstatusv1.mdx | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx b/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx index 3c4af0b5d..97c2d217d 100644 --- a/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx +++ b/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx @@ -8,8 +8,8 @@ import TabItem from '@theme/TabItem'; # `linea_getTransactionExclusionStatusV1` -Queries a database maintained by the transaction exclusion API service to check if a transaction -was rejected because it exceeded data line limits that would prevent the prover from generating a +Queries a temporary database maintained by the transaction exclusion API service to check if a +was rejected for exceeding data line limits that would prevent the prover from generating a proof for the block. The database is updated by a parallel write API endpoint called by the sequencer, edge nodes, or RPC nodes. @@ -18,7 +18,7 @@ If the transaction was rejected, the API call will be successful and provide the Transactions that were not rejected for this reason will return `null` as the `result`. :::warning -Transactions older than 24 hours cannot be checked. +Transactions older than 24 hours can't be checked. ::: ## Parameters @@ -37,7 +37,7 @@ Transactions older than 24 hours cannot be checked. - `reasonMessage`: Explains why the transaction was rejected. - `blockNumber`: The block that the transaction was rejected from, in hexadecimal format. Only returned for transactions rejected by the sequencer. -- `timestamp`: Time of rejection, in ISO8601 format. +- `timestamp`: Time of rejection, in ISO 8601 format. ## Example @@ -47,13 +47,13 @@ returned for transactions rejected by the sequencer. ```bash curl https://rpc.linea.build \ - -X POST + -X POST \ -H "Content-Type: application/json" \ -d '{ "jsonrpc": "2.0", "id": "1", "method": "linea_getTransactionExclusionStatusV1", - "params": ["0x526e56101cf39c1e717cef9cedf6fdddb42684711abda35bae51136dbb350ad7"], + "params": ["0x526e56101cf39c1e717cef9cedf6fdddb42684711abda35bae51136dbb350ad7"] }' ``` @@ -81,6 +81,13 @@ returned for transactions rejected by the sequencer. +:::note + +This example is purely representative; the database only retains transaction data for 24 hours, so +you will be unable to reproduce this response with the transaction in the above example. + +::: + If the transaction was not rejected for exceeding line limits, the transaction will not be found in the database, and return a `null` result. For example: From 750e3e2b4b5690ebcb9b2239e9e7cadb83db74e8 Mon Sep 17 00:00:00 2001 From: m4sterbunny Date: Wed, 18 Sep 2024 11:08:19 +0100 Subject: [PATCH 10/18] Update docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx moving this along for next edit --- .../reference/api/linea-gettransactionexclusionstatusv1.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx b/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx index 97c2d217d..0b2c91871 100644 --- a/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx +++ b/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx @@ -18,7 +18,7 @@ If the transaction was rejected, the API call will be successful and provide the Transactions that were not rejected for this reason will return `null` as the `result`. :::warning -Transactions older than 24 hours can't be checked. +Transaction rejection reason can only be checked within 24 hours of transaction attempt. ::: ## Parameters From 82ee07a201264ecca800f0693d6cf465c309669b Mon Sep 17 00:00:00 2001 From: jlwllmr <95916148+jlwllmr@users.noreply.github.com> Date: Wed, 18 Sep 2024 16:49:46 +0100 Subject: [PATCH 11/18] Address comments --- .../reference/api/linea-gettransactionexclusionstatusv1.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx b/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx index 0b2c91871..568c97cd7 100644 --- a/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx +++ b/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx @@ -18,7 +18,7 @@ If the transaction was rejected, the API call will be successful and provide the Transactions that were not rejected for this reason will return `null` as the `result`. :::warning -Transaction rejection reason can only be checked within 24 hours of transaction attempt. +Transaction rejection reason can only be checked within 24 hours of the transaction attempt. ::: ## Parameters @@ -89,7 +89,7 @@ you will be unable to reproduce this response with the transaction in the above ::: If the transaction was not rejected for exceeding line limits, the transaction will not be found -in the database, and return a `null` result. For example: +in the database, and a `null` result is returned. For example: ```json { From 952fafc454a6be0d6018919cfbb443eda3a4b944 Mon Sep 17 00:00:00 2001 From: jlwllmr <95916148+jlwllmr@users.noreply.github.com> Date: Thu, 19 Sep 2024 11:13:16 +0100 Subject: [PATCH 12/18] Add callout --- .../api/linea-gettransactionexclusionstatusv1.mdx | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx b/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx index 568c97cd7..426e2549a 100644 --- a/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx +++ b/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx @@ -8,6 +8,14 @@ import TabItem from '@theme/TabItem'; # `linea_getTransactionExclusionStatusV1` +:::info Only available on request + +This API method is only available via Infura endpoints on request. If you would like to have it +made available, please get in touch with technical support via the "Contact" button on our +[support page](https://support.linea.build/). + +::: + Queries a temporary database maintained by the transaction exclusion API service to check if a was rejected for exceeding data line limits that would prevent the prover from generating a proof for the block. The database is updated by a parallel write API endpoint called by the From 6cfc684965348a4fc796b5e7ef7886c0e9b25046 Mon Sep 17 00:00:00 2001 From: jlwllmr <95916148+jlwllmr@users.noreply.github.com> Date: Thu, 19 Sep 2024 16:11:22 +0100 Subject: [PATCH 13/18] Amend timeframe and correct typo --- .../api/linea-gettransactionexclusionstatusv1.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx b/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx index 426e2549a..5441350c5 100644 --- a/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx +++ b/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx @@ -17,16 +17,16 @@ made available, please get in touch with technical support via the "Contact" but ::: Queries a temporary database maintained by the transaction exclusion API service to check if a -was rejected for exceeding data line limits that would prevent the prover from generating a -proof for the block. The database is updated by a parallel write API endpoint called by the -sequencer, edge nodes, or RPC nodes. +transaction was rejected for exceeding data line limits that would prevent the prover from +generating a proof for the block. The database is updated by a parallel write API endpoint called +by the sequencer, edge nodes, or RPC nodes. If the transaction was rejected, the API call will be successful and provide the reason. Transactions that were not rejected for this reason will return `null` as the `result`. :::warning -Transaction rejection reason can only be checked within 24 hours of the transaction attempt. +Transaction rejection can only be checked within seven days of the transaction attempt. ::: ## Parameters From 8d4ea8a83b7c329d195b9ae52b2b85911166c3f3 Mon Sep 17 00:00:00 2001 From: jlwllmr <95916148+jlwllmr@users.noreply.github.com> Date: Wed, 25 Sep 2024 14:30:09 +0100 Subject: [PATCH 14/18] Amend timeframe to 7 days --- .../reference/api/linea-gettransactionexclusionstatusv1.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx b/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx index 5441350c5..8680a896f 100644 --- a/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx +++ b/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx @@ -91,7 +91,7 @@ returned for transactions rejected by the sequencer. :::note -This example is purely representative; the database only retains transaction data for 24 hours, so +This example is purely representative; the database only retains transaction data for seven days, so you will be unable to reproduce this response with the transaction in the above example. ::: From 0112e8669e78bf309e2631ed0949256bfa758ac7 Mon Sep 17 00:00:00 2001 From: jlwllmr <95916148+jlwllmr@users.noreply.github.com> Date: Thu, 26 Sep 2024 09:34:01 +0100 Subject: [PATCH 15/18] Address some changes --- .../linea-gettransactionexclusionstatusv1.mdx | 29 ++++++++++--------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx b/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx index 8680a896f..4d09c3ab3 100644 --- a/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx +++ b/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx @@ -10,25 +10,26 @@ import TabItem from '@theme/TabItem'; :::info Only available on request -This API method is only available via Infura endpoints on request. If you would like to have it -made available, please get in touch with technical support via the "Contact" button on our -[support page](https://support.linea.build/). +This API method is only available via Infura endpoints on request. [Contact support](https://support.linea.build/) +to request access to this method. ::: Queries a temporary database maintained by the transaction exclusion API service to check if a -transaction was rejected for exceeding data line limits that would prevent the prover from -generating a proof for the block. The database is updated by a parallel write API endpoint called +transaction was rejected for exceeding data line limits that would prevent the prover from by the sequencer, edge nodes, or RPC nodes. -If the transaction was rejected, the API call will be successful and provide the reason. +::: -Transactions that were not rejected for this reason will return `null` as the `result`. +You can only check for transaction rejection within seven days of the transaction attempt. -:::warning -Transaction rejection can only be checked within seven days of the transaction attempt. ::: +If the transaction was rejected, the API call will be successful and provide the reason. + +If the transaction is rejected, the API call will succeed and provide the reason; otherwise, it +will return `null`. + ## Parameters `txHash`: [Required] The hash of the subject transaction. @@ -37,7 +38,7 @@ Transaction rejection can only be checked within seven days of the transaction a - `txHash`: The hash of the subject transaction. - `from`: The public address of the account that sent the transaction. -- `nonce`: The transaction nonce, hexadecimal. +- `nonce`: Number of transaction made by the sender, in hexadecimal format. - `txRejectionStage`: A string detailing the point at which the transaction was rejected. One of: - `SEQUENCER`: Rejected by the sequencer. - `RPC`: Rejected by an RPC node (e.g. `https://rpc.linea.build`). @@ -91,13 +92,13 @@ returned for transactions rejected by the sequencer. :::note -This example is purely representative; the database only retains transaction data for seven days, so -you will be unable to reproduce this response with the transaction in the above example. +This example is purely representative; the database retains transaction data for only seven days, so +you'll be unable to reproduce this response with the above example. ::: -If the transaction was not rejected for exceeding line limits, the transaction will not be found -in the database, and a `null` result is returned. For example: +If a transaction was not rejected for exceeding line limits, it will not be found in the database, +and a `null` result is returned. For example: ```json { From 88a6c44b1f9631315dbe703ff3e65d0024493ba4 Mon Sep 17 00:00:00 2001 From: jlwllmr <95916148+jlwllmr@users.noreply.github.com> Date: Thu, 26 Sep 2024 11:59:39 +0100 Subject: [PATCH 16/18] Clarify null results for old transactions --- .../reference/api/linea-gettransactionexclusionstatusv1.mdx | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx b/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx index 4d09c3ab3..e17553681 100644 --- a/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx +++ b/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx @@ -21,7 +21,8 @@ by the sequencer, edge nodes, or RPC nodes. ::: -You can only check for transaction rejection within seven days of the transaction attempt. +You can only check for transaction rejection within seven days of the transaction attempt. Querying +transactions older than this will return a `null` response. ::: @@ -107,3 +108,5 @@ and a `null` result is returned. For example: "result": null } ``` + +A similar `null` result is also returned if the transaction is older than seven days. From 2f53a4aa7b87818cef077f4aa224e7034edcf719 Mon Sep 17 00:00:00 2001 From: jlwllmr <95916148+jlwllmr@users.noreply.github.com> Date: Thu, 26 Sep 2024 14:23:16 +0100 Subject: [PATCH 17/18] Update RPC endpoint to Infura --- .../reference/api/linea-gettransactionexclusionstatusv1.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx b/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx index e17553681..2ba7f8ebc 100644 --- a/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx +++ b/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx @@ -56,7 +56,7 @@ returned for transactions rejected by the sequencer. ```bash - curl https://rpc.linea.build \ + curl https://linea-mainnet.infura.io/v3/YOUR-API-KEY \ -X POST \ -H "Content-Type: application/json" \ -d '{ From c8a04db323af5fba64ba687e4214edb645c43f0a Mon Sep 17 00:00:00 2001 From: jlwllmr <95916148+jlwllmr@users.noreply.github.com> Date: Fri, 27 Sep 2024 09:45:33 +0100 Subject: [PATCH 18/18] Remove callout about entitlements --- .../api/linea-gettransactionexclusionstatusv1.mdx | 7 ------- 1 file changed, 7 deletions(-) diff --git a/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx b/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx index 2ba7f8ebc..f8dc4a2b1 100644 --- a/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx +++ b/docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx @@ -8,13 +8,6 @@ import TabItem from '@theme/TabItem'; # `linea_getTransactionExclusionStatusV1` -:::info Only available on request - -This API method is only available via Infura endpoints on request. [Contact support](https://support.linea.build/) -to request access to this method. - -::: - Queries a temporary database maintained by the transaction exclusion API service to check if a transaction was rejected for exceeding data line limits that would prevent the prover from by the sequencer, edge nodes, or RPC nodes.