update api text
This commit is contained in:
Joe
parent
dd6d413947
commit
74d3defd9d
@ -8,3 +8,8 @@ Resources:
|
||||
- some draft figma files for design sketching: https://www.figma.com/file/ekzIgwyeVKLtFSAcnA0Q0D/geth-website?node-id=6%3A31
|
||||
- content planning notes: https://www.notion.so/efdn/Content-Strategy-3252234338814a749374fa7f11049083
|
||||
- meeting notes: https://www.notion.so/efdn/Call-notes-46aa0202810a402ebfda07b046761cbd
|
||||
|
||||
|
||||
Notes:
|
||||
|
||||
**Dev note**: Remember that the fiules in `vulnerabilities` must be served at the same URLs as they are currently to avoid breaking some Geth functions related to security auditing.
|
||||
@ -3,11 +3,7 @@ title: clique Namespace
|
||||
sort_key: C
|
||||
---
|
||||
|
||||
The `clique` API provides access to the state of the clique consensus engine. You can use
|
||||
this API to manage signer votes and to check the health of a private network.
|
||||
|
||||
* TOC
|
||||
{:toc}
|
||||
The `clique` API provides access to the state of the clique consensus engine. This API cna be used to manage signer votes and to check the health of a private network.
|
||||
|
||||
### clique_getSnapshot
|
||||
|
||||
|
||||
@ -5,9 +5,6 @@ sort_key: C
|
||||
|
||||
Geth provides several extensions to the standard "eth" JSON-RPC namespace.
|
||||
|
||||
* TOC
|
||||
{:toc}
|
||||
|
||||
### eth_subscribe, eth_unsubscribe
|
||||
|
||||
These methods are used for real-time events through subscriptions. See the [subscription
|
||||
@ -188,8 +185,8 @@ curl --data '{"method":"eth_createAccessList","params":[{"from": "0x8cd02c6cbd83
|
||||
|
||||
The method `eth_createAccessList` returns list of addresses and storage keys used by the transaction, plus the gas consumed when the access list is added.
|
||||
|
||||
That is, it gives you the list of addresses and storage keys that will be used by that transaction, plus the gas consumed if the access list is included. Like `eth_estimateGas`, this is an estimation; the list could change when the transaction is actually mined.
|
||||
Adding an `accessList` to your transaction does not necessary result in lower gas usage compared to a transaction without an access list.
|
||||
That is, it gives the list of addresses and storage keys that will be used by that transaction, plus the gas consumed if the access list is included. Like `eth_estimateGas`, this is an estimation; the list could change when the transaction is actually mined.
|
||||
Adding an `accessList` to a transaction does not necessary result in lower gas usage compared to a transaction without an access list.
|
||||
|
||||
Example:
|
||||
```json
|
||||
|
||||
@ -3,7 +3,7 @@ title: les Namespace
|
||||
sort_key: C
|
||||
---
|
||||
|
||||
The `les` API allows you to manage LES server settings, including client parameters and payment settings for prioritized clients. It also provides functions to query checkpoint information in both server and client mode.
|
||||
The `les` API is for managing LES server settings, including client parameters and payment settings for prioritized clients. It also provides functions to query checkpoint information in both server and client mode.
|
||||
|
||||
* TOC
|
||||
{:toc}
|
||||
|
||||
@ -3,15 +3,11 @@ title: miner Namespace
|
||||
sort_key: C
|
||||
---
|
||||
|
||||
The `miner` API allows you to remote control the node's mining operation and set various
|
||||
mining specific settings.
|
||||
|
||||
* TOC
|
||||
{:toc}
|
||||
The `miner` API is **now deprecated** because mining was switched off at the transition to proof-of-stake. It existed to provide remote control the node's mining operation and set various mining specific settings. It is provided here for historical interest!
|
||||
|
||||
### miner_getHashrate
|
||||
|
||||
Get your hashrate in H/s (Hash operations per second).
|
||||
Get hashrate in H/s (Hash operations per second).
|
||||
|
||||
| Client | Method invocation |
|
||||
|:--------|-------------------------------------------------------------|
|
||||
@ -82,7 +78,7 @@ Sets the etherbase, where mining rewards will go.
|
||||
|
||||
### miner_setGasLimit
|
||||
|
||||
Sets the gas limit the miner will target when mining. Note: on networks where EIP-1559 is activated, this should be set to twice what you want the gas target (i.e. the effective gas used on average per block) to be.
|
||||
Sets the gas limit the miner will target when mining. Note: on networks where EIP-1559 is activated, this should be set to twice the gas target (i.e. the effective gas used on average per block) to be.
|
||||
|
||||
| Client | Method invocation |
|
||||
|:--------|-------------------------------------------------------------|
|
||||
|
||||
@ -5,8 +5,6 @@ sort_key: C
|
||||
|
||||
The `net` API provides insight about the networking aspect of the client.
|
||||
|
||||
* TOC
|
||||
{:toc}
|
||||
|
||||
### net_listening
|
||||
|
||||
|
||||
@ -5,9 +5,6 @@ sort_key: C
|
||||
|
||||
The personal API manages private keys in the key store.
|
||||
|
||||
* TOC
|
||||
{:toc}
|
||||
|
||||
### personal_deriveAccount
|
||||
|
||||
Requests a HD wallet to derive a new account, optionally pinning it for later reuse.
|
||||
@ -165,7 +162,7 @@ Supplying the passphrase and unlock duration as arguments:
|
||||
true
|
||||
```
|
||||
|
||||
If you want to type in the passphrase and stil override the default unlock duration,
|
||||
To type in the passphrase and still override the default unlock duration,
|
||||
pass `null` as the passphrase.
|
||||
|
||||
```
|
||||
@ -177,7 +174,7 @@ true
|
||||
|
||||
### personal_unpair
|
||||
|
||||
Deletes a pairing between wallet and geth.
|
||||
Deletes a pairing between wallet and Geth.
|
||||
|
||||
| Client | Method invocation |
|
||||
| :--------| ----------------------------------------------------------- |
|
||||
|
||||
@ -3,13 +3,10 @@ title: txpool Namespace
|
||||
sort_key: C
|
||||
---
|
||||
|
||||
The `txpool` API gives you access to several non-standard RPC methods to inspect the contents of the
|
||||
The `txpool` API gives access to several non-standard RPC methods to inspect the contents of the
|
||||
transaction pool containing all the currently pending transactions as well as the ones queued for
|
||||
future processing.
|
||||
|
||||
* TOC
|
||||
{:toc}
|
||||
|
||||
### txpool_content
|
||||
|
||||
The `content` inspection property can be queried to list the exact details of all the transactions
|
||||
|
||||
@ -19,7 +19,7 @@ The *transaction call object* contains all the necessary parameters for executin
|
||||
| `maxPriorityFeePerGas` | `Quantity` | <32 | Yes | Maximum tip per gas that's given directly to the miner. Relevant for type-2 transactions. |
|
||||
| `value` | `Quantity` | <32 | Yes | Amount of `wei` to simulate sending along with the transaction. Defaults to `0`. |
|
||||
| `nonce` | `Quantity` | <8 | Yes | Nonce of sender account. |
|
||||
| `input` | `Binary` | any | Yes | Binary data to send to the target contract. Generally the 4 byte hash of the method signature followed by the ABI encoded parameters. For details please see the [Ethereum Contract ABI](https://github.com/ethereum/wiki/wiki/Ethereum-Contract-ABI). This field was previously called `data`. |
|
||||
| `input` | `Binary` | any | Yes | Binary data to send to the target contract. Generally the 4 byte hash of the method signature followed by the ABI encoded parameters. For details please see the [Ethereum Contract ABI](https://docs.soliditylang.org/en/v0.7.0/abi-spec.html). This field was previously called `data`. |
|
||||
| `accessList` | `AccessList` | any | Yes | A list of addresses and storage keys that the transaction plans to access. Used in non-legacy, i.e. type 1 and 2 transactions. |
|
||||
| `chainId` | `Quantity` | <32 | Yes | Transaction only valid on networks with this chain ID. Used in non-legacy, i.e. type 1 and 2 transactions. |
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user