Skip to content

Commit

Permalink
feat(ref): act-1566 - updated linea ref pages (#1722)
Browse files Browse the repository at this point in the history
  • Loading branch information
TrofimovAnton85 authored Nov 8, 2024
1 parent 55afd8e commit 46244bf
Show file tree
Hide file tree
Showing 5 changed files with 40 additions and 230 deletions.
Original file line number Diff line number Diff line change
@@ -1,40 +1,13 @@
---
title: "eth_getUncleByBlockHashAndIndex"
hide_title: true
hide_table_of_contents: true
---

import Tabs from "@theme/Tabs"
import TabItem from "@theme/TabItem"
import ParserOpenRPC from "@site/src/components/ParserOpenRPC"
import { NETWORK_NAMES } from "@site/src/plugins/plugin-json-rpc"

import Description from "/services/reference/_partials/_eth_getunclebyblockhashandindex-description.mdx"

<Description />

## Parameters

import Params from "/services/reference/_partials/_eth_getunclebyblockhashandindex-parameters.mdx"

<Params />

## Returns

import Returns from "/services/reference/_partials/_eth_getunclebyblockhashandindex-returns.mdx"

<Returns />

## Example

import Example from "/services/reference/_partials/_eth_getunclebyblockhashandindex-example.mdx"

<Example />

### Request

import Request from "./_eth_getunclebyblockhashandindex-request.mdx"

<Request />

### Response

import Response from "/services/reference/_partials/_eth_getunclebyblockhashandindex-response.mdx"

<Response />
<ParserOpenRPC
network={NETWORK_NAMES.linea}
method="eth_getUncleByBlockHashAndIndex"
/>
Original file line number Diff line number Diff line change
@@ -1,40 +1,13 @@
---
title: "eth_getUncleCountByBlockHash"
hide_title: true
hide_table_of_contents: true
---

import Tabs from "@theme/Tabs"
import TabItem from "@theme/TabItem"
import ParserOpenRPC from "@site/src/components/ParserOpenRPC"
import { NETWORK_NAMES } from "@site/src/plugins/plugin-json-rpc"

import Description from "/services/reference/_partials/_eth_getunclecountbyblockhash-description.mdx"

<Description />

## Parameters

import Params from "/services/reference/_partials/_eth_getunclecountbyblockhash-parameters.mdx"

<Params />

## Returns

import Returns from "/services/reference/_partials/_eth_getunclecountbyblockhash-returns.mdx"

<Returns />

## Example

import Example from "/services/reference/_partials/_eth_getunclecountbyblockhash-example.mdx"

<Example />

### Request

import Request from "./_eth_getunclecountbyblockhash-request.mdx"

<Request />

### Response

import Response from "/services/reference/_partials/_eth_getunclecountbyblockhash-response.mdx"

<Response />
<ParserOpenRPC
network={NETWORK_NAMES.linea}
method="eth_getUncleCountByBlockHash"
/>
Original file line number Diff line number Diff line change
@@ -1,40 +1,13 @@
---
title: "eth_getUncleCountByBlockNumber"
hide_title: true
hide_table_of_contents: true
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import ParserOpenRPC from "@site/src/components/ParserOpenRPC"
import { NETWORK_NAMES } from "@site/src/plugins/plugin-json-rpc"

import Description from "/services/reference/_partials/_eth_getunclecountbyblocknumber-description.mdx";

<Description />

## Parameters

import Params from "./_eth_block-parameter.mdx";

<Params />

## Returns

import Returns from "/services/reference/_partials/_eth_getunclecountbyblocknumber-returns.mdx";

<Returns />

## Example

import Example from "/services/reference/_partials/_eth_getunclecountbyblocknumber-example.mdx";

<Example />

### Request

import Request from "./_eth_getunclecountbyblocknumber-request.mdx";

<Request />

### Response

import Response from "/services/reference/_partials/_eth_getunclecountbyblocknumber-response.mdx";

<Response />
<ParserOpenRPC
network={NETWORK_NAMES.linea}
method="eth_getUncleCountByBlockNumber"
/>
Original file line number Diff line number Diff line change
@@ -1,95 +1,13 @@
---
title: "linea_getTransactionExclusionStatusV1"
hide_title: true
hide_table_of_contents: true
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import ParserOpenRPC from "@site/src/components/ParserOpenRPC"
import { NETWORK_NAMES } from "@site/src/plugins/plugin-json-rpc"

Checks if a transaction was rejected for exceeding data line limits, preventing the prover from generating
a proof to be included in a block.

:::warning

You can only check for rejected transactions within seven days of the transaction attempt. Querying
transactions older than this returns a `null` response.

:::

The API call provides the rejection reason if the transaction fails.
It returns `null` if the transaction succeeds.

## Parameters

`transaction hash`: _\[Required]_ A string representing the hash (32 bytes) of a transaction.

## Returns

- `txHash`: The hash of the transaction.
- `from`: The address of the sender.
- `nonce`: Number of transactions made by the sender.
- `txRejectionStage`: The point at which the transaction was rejected. One of:
- `SEQUENCER`: Rejected by the sequencer.
- `RPC`: Rejected by an RPC node.
- `P2P`: Rejected by a P2P-connected node.
- `reasonMessage`: The reason 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

Replace `<YOUR-API-KEY>` with an API key from your [Infura dashboard](https://infura.io/dashboard).

### 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>
<TabItem value="WSS">

```bash
wscat -c wss://linea-mainnet.infura.io/ws/v3/<YOUR-API-KEY> -x '{"jsonrpc": "2.0", "method": "linea_getTransactionExclusionStatusV1", "params": ["0x526e56101cf39c1e717cef9cedf6fdddb42684711abda35bae51136dbb350ad7"], "id": 1}'
```

</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>

The API returns a `null` result if the transaction does not exceed line limits or is older than seven days.
In these cases, the database does not contain the transaction. For example:

```json
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
```
<ParserOpenRPC
network={NETWORK_NAMES.linea}
method="linea_getTransactionExclusionStatusV1"
/>
43 changes: 8 additions & 35 deletions services/reference/linea/json-rpc-methods/net_version.mdx
Original file line number Diff line number Diff line change
@@ -1,40 +1,13 @@
---
title: "net_version"
hide_title: true
hide_table_of_contents: true
---

import Tabs from "@theme/Tabs"
import TabItem from "@theme/TabItem"
import ParserOpenRPC from "@site/src/components/ParserOpenRPC"
import { NETWORK_NAMES } from "@site/src/plugins/plugin-json-rpc"

import Description from "/services/reference/_partials/_net_version-description.mdx"

<Description />

## Parameters

import Params from "/services/reference/_partials/_net_version-parameters.mdx"

<Params />

## Returns

import Returns from "/services/reference/_partials/_net_version-returns.mdx"

<Returns />

## Example

import Example from "/services/reference/_partials/_net_version-example.mdx"

<Example />

### Request

import Request from "./_net_version-request.mdx"

<Request />

### Response

import Response from "/services/reference/_partials/_net_version-response.mdx"

<Response />
<ParserOpenRPC
network={NETWORK_NAMES.linea}
method="net_version"
/>

0 comments on commit 46244bf

Please sign in to comment.