generated from Consensys/doctools.template-site
-
Notifications
You must be signed in to change notification settings - Fork 425
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
linea_getTransactionExclusionStatusV1
API reference (#739)
* Initial draft * Rename file and add to sidebar * Update txRejectionStage string descriptions * Update formatting and minor adjustments * Typos * Adjust wording * Address comments * Add null result * Amendments * Update docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx moving this along for next edit * Address comments * Add callout * Amend timeframe and correct typo * Amend timeframe to 7 days * Address some changes * Clarify null results for old transactions * Update RPC endpoint to Infura * Remove callout about entitlements --------- Co-authored-by: m4sterbunny <[email protected]>
- Loading branch information
1 parent
ad89f14
commit 285f78b
Showing
2 changed files
with
106 additions
and
0 deletions.
There are no files selected for viewing
105 changes: 105 additions & 0 deletions
105
docs/developers/reference/api/linea-gettransactionexclusionstatusv1.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,105 @@ | ||
--- | ||
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 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. | ||
|
||
::: | ||
|
||
You can only check for transaction rejection within seven days of the transaction attempt. Querying | ||
transactions older than this will return a `null` response. | ||
|
||
::: | ||
|
||
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. | ||
|
||
## Returns | ||
|
||
- `txHash`: The hash of the subject transaction. | ||
- `from`: The public address of the account that sent the transaction. | ||
- `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`). | ||
- `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 ISO 8601 format. | ||
|
||
## Example | ||
|
||
### Request | ||
|
||
<Tabs> | ||
<TabItem value="cURL"> | ||
```bash | ||
curl https://linea-mainnet.infura.io/v3/YOUR-API-KEY \ | ||
-X POST \ | ||
-H "Content-Type: application/json" \ | ||
-d '{ | ||
"jsonrpc": "2.0", | ||
"id": "1", | ||
"method": "linea_getTransactionExclusionStatusV1", | ||
"params": ["0x526e56101cf39c1e717cef9cedf6fdddb42684711abda35bae51136dbb350ad7"] | ||
}' | ||
``` | ||
</TabItem> | ||
</Tabs> | ||
|
||
### Response | ||
|
||
<Tabs> | ||
<TabItem value="JSON"> | ||
```json | ||
{ | ||
"jsonrpc": "2.0", | ||
"id": "1", | ||
"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" | ||
} | ||
} | ||
``` | ||
</TabItem> | ||
</Tabs> | ||
|
||
:::note | ||
|
||
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 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 | ||
{ | ||
"jsonrpc": "2.0", | ||
"id": 1, | ||
"result": null | ||
} | ||
``` | ||
A similar `null` result is also returned if the transaction is older than seven days. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters