Skip to content

docs: Auto-update docs #344

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.

Sign up for GitHub

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

Merged
rubo merged 1 commit into from
Jun 2, 2026
Merged

docs: Auto-update docs #344

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
902 changes: 850 additions & 52 deletions docs/fundamentals/configuration.md
View file
Open in desktop

Large diffs are not rendered by default.

48 changes: 29 additions & 19 deletions docs/interacting/json-rpc-ns/admin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ import TabItem from "@theme/TabItem";

### admin_addPeer

Adds given node.
Adds the given node as a static peer. The connection is maintained for the lifetime of the process. Set `persistent` to also write the peer to static-nodes.json so it is restored on restart.

<Tabs>
<TabItem value="params" label="Parameters">

1. `enode`: _string_

2. `addToStaticNodes`: _boolean_
2. `persistent`: _boolean_


</TabItem>
Expand All @@ -30,14 +30,14 @@ curl localhost:8545 \
"jsonrpc": "2.0",
"id": 0,
"method": "admin_addPeer",
"params": [enode, addToStaticNodes]
"params": [enode, persistent]
}'
```

</TabItem>
<TabItem value="response" label="Response">

Added node
`true` if the peer is in the static set after the call.

```json
{
Expand All @@ -47,20 +47,22 @@ Added node
}
```

`result`: _string_
`result`: _boolean_

</TabItem>
</Tabs>

### admin_addTrustedPeer

Adds given node as a trusted peer, allowing the node to always connect even if slots are full.
Adds the given node to the trusted peer set so it can always connect even when slots are full. Set `persistent` to also write the peer to trusted-nodes.json so it is restored on restart.

<Tabs>
<TabItem value="params" label="Parameters">

1. `enode`: _string_

2. `persistent`: _boolean_


</TabItem>
<TabItem value="request" label="Request" default>
Expand All @@ -73,14 +75,14 @@ curl localhost:8545 \
"jsonrpc": "2.0",
"id": 0,
"method": "admin_addTrustedPeer",
"params": [enode]
"params": [enode, persistent]
}'
```

</TabItem>
<TabItem value="response" label="Response">

Boolean indicating success
`true` if the peer is in the trusted set after the call.

```json
{
Expand Down Expand Up @@ -319,6 +321,7 @@ Information about this node
- `eip1014Transition`: _string_ (hex integer)
- `eip1052Transition`: _string_ (hex integer)
- `eip1108Transition`: _string_ (hex integer)
- `eip1153Transition`: _string_ (hex integer)
- `eip1153TransitionTimestamp`: _string_ (hex integer)
- `eip1283DisableTransition`: _string_ (hex integer)
- `eip1283ReenableTransition`: _string_ (hex integer)
Expand Down Expand Up @@ -358,42 +361,48 @@ Information about this node
- `eip3529Transition`: _string_ (hex integer)
- `eip3541Transition`: _string_ (hex integer)
- `eip3607Transition`: _string_ (hex integer)
- `eip3651Transition`: _string_ (hex integer)
- `eip3651TransitionTimestamp`: _string_ (hex integer)
- `eip3855Transition`: _string_ (hex integer)
- `eip3855TransitionTimestamp`: _string_ (hex integer)
- `eip3860Transition`: _string_ (hex integer)
- `eip3860TransitionTimestamp`: _string_ (hex integer)
- `eip4788ContractAddress`: _string_ (address)
- `eip4788TransitionTimestamp`: _string_ (hex integer)
- `eip4844BlobGasPriceUpdateFraction`: _string_ (hex integer)
- `eip4844FeeCollectorTransitionTimestamp`: _string_ (hex integer)
- `eip4844MinBlobGasPrice`: _string_ (hex integer)
- `eip4844Transition`: _string_ (hex integer)
- `eip4844TransitionTimestamp`: _string_ (hex integer)
- `eip4895TransitionTimestamp`: _string_ (hex integer)
- `eip5656Transition`: _string_ (hex integer)
- `eip5656TransitionTimestamp`: _string_ (hex integer)
- `eip6110TransitionTimestamp`: _string_ (hex integer)
- `eip658Transition`: _string_ (hex integer)
- `eip6780Transition`: _string_ (hex integer)
- `eip6780TransitionTimestamp`: _string_ (hex integer)
- `eip7002ContractAddress`: _string_ (address)
- `eip7002TransitionTimestamp`: _string_ (hex integer)
- `eip7251ContractAddress`: _string_ (address)
- `eip7251TransitionTimestamp`: _string_ (hex integer)
- `eip7594TransitionTimestamp`: _string_ (hex integer)
- `eip7623TransitionTimestamp`: _string_ (hex integer)
- `eip7692TransitionTimestamp`: _string_ (hex integer)
- `eip7702TransitionTimestamp`: _string_ (hex integer)
- `eip7708TransitionTimestamp`: _string_ (hex integer)
- `eip7778TransitionTimestamp`: _string_ (hex integer)
- `eip7823TransitionTimestamp`: _string_ (hex integer)
- `eip7825TransitionTimestamp`: _string_ (hex integer)
- `eip7843TransitionTimestamp`: _string_ (hex integer)
- `eip7883TransitionTimestamp`: _string_ (hex integer)
- `eip7907TransitionTimestamp`: _string_ (hex integer)
- `eip7918TransitionTimestamp`: _string_ (hex integer)
- `eip7928TransitionTimestamp`: _string_ (hex integer)
- `eip7934MaxRlpBlockSize`: _string_ (hex integer)
- `eip7934TransitionTimestamp`: _string_ (hex integer)
- `eip7939TransitionTimestamp`: _string_ (hex integer)
- `eip7951TransitionTimestamp`: _string_ (hex integer)
- `eip7954TransitionTimestamp`: _string_ (hex integer)
- `eip7976TransitionTimestamp`: _string_ (hex integer)
- `eip7981TransitionTimestamp`: _string_ (hex integer)
- `eip7Transition`: _string_ (hex integer)
- `eip8024TransitionTimestamp`: _string_ (hex integer)
- `eip8037TransitionTimestamp`: _string_ (hex integer)
Expand All @@ -413,7 +422,6 @@ Information about this node
- `opIsthmusTransitionTimestamp`: _string_ (hex integer)
- `registrar`: _string_ (address)
- `rip7212TransitionTimestamp`: _string_ (hex integer)
- `rip7728TransitionTimestamp`: _string_ (hex integer)
- `terminalPoWBlockNumber`: _string_ (hex integer)
- `terminalTotalDifficulty`: _string_ (hex integer)
- `transactionPermissionContract`: _string_ (address)
Expand Down Expand Up @@ -563,14 +571,14 @@ curl localhost:8545 \

### admin_removePeer

Removes given node.
Removes the given node from the static peer set and disconnects any active session. Set `persistent` to also remove the peer from static-nodes.json so it is not restored on restart.

<Tabs>
<TabItem value="params" label="Parameters">

1. `enode`: _string_

2. `removeFromStaticNodes`: _boolean_
2. `persistent`: _boolean_


</TabItem>
Expand All @@ -584,14 +592,14 @@ curl localhost:8545 \
"jsonrpc": "2.0",
"id": 0,
"method": "admin_removePeer",
"params": [enode, removeFromStaticNodes]
"params": [enode, persistent]
}'
```

</TabItem>
<TabItem value="response" label="Response">

Removed node
`true` if the input enode was valid and the removal was attempted.

```json
{
Expand All @@ -601,20 +609,22 @@ Removed node
}
```

`result`: _string_
`result`: _boolean_

</TabItem>
</Tabs>

### admin_removeTrustedPeer

Removes the given node from the trusted peers list.
Removes the given node from the trusted peer set. Set `persistent` to also remove the peer from trusted-nodes.json so it is not re-trusted on restart.

<Tabs>
<TabItem value="params" label="Parameters">

1. `enode`: _string_

2. `persistent`: _boolean_


</TabItem>
<TabItem value="request" label="Request" default>
Expand All @@ -627,14 +637,14 @@ curl localhost:8545 \
"jsonrpc": "2.0",
"id": 0,
"method": "admin_removeTrustedPeer",
"params": [enode]
"params": [enode, persistent]
}'
```

</TabItem>
<TabItem value="response" label="Response">

Boolean indicating success
`true` if the input enode was valid and the removal was attempted.

```json
{
Expand Down
Loading