docs: fix JSON-RPC links (#558)

* RPC method docs

* forgot readme

* cleanup

* add table and fill in missing details

* update table

* fix tip block

* add the rest of the eth methods

* added the rest of the namespaces

* get rid of extra space

* doc bug fixes

* Update docs/.vuepress/config.js

* fix adr md comment

Co-authored-by: Federico Kunze <federico.kunze94@gmail.com>
Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com>
This commit is contained in:
Justin Thompson 2020-10-01 00:53:42 -06:00 committed by GitHub
parent 1be4b7167d
commit 3ed790b8cd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 139 additions and 140 deletions

View File

@ -8,6 +8,7 @@ module.exports = {
themeConfig: { themeConfig: {
repo: 'ChainSafe/ethermint', repo: 'ChainSafe/ethermint',
docsRepo: 'ChainSafe/ethermint', docsRepo: 'ChainSafe/ethermint',
docsBranch: 'development',
docsDir: 'docs', docsDir: 'docs',
editLinks: true, editLinks: true,
custom: true, custom: true,
@ -41,7 +42,6 @@ module.exports = {
}, },
gutter: { gutter: {
title: 'Help & Support', title: 'Help & Support',
editLink: true,
chat: { chat: {
title: 'Developer Chat', title: 'Developer Chat',
text: 'Chat with Ethermint developers on Discord.', text: 'Chat with Ethermint developers on Discord.',
@ -58,7 +58,6 @@ module.exports = {
github: { github: {
title: 'Found an Issue?', title: 'Found an Issue?',
text: 'Help us improve this page by suggesting edits on GitHub.', text: 'Help us improve this page by suggesting edits on GitHub.',
url: 'https://github.com/ChainSafe/ethermint/edit/development/docs/README.md',
bg: '#F8F9FC' bg: '#F8F9FC'
} }
}, },

View File

@ -1,8 +1,8 @@
<!-- <!--
order: false order: false
parent: parent:
order: false order: 0
---> -->
# Architecture Decision Records (ADR) # Architecture Decision Records (ADR)

View File

@ -13,140 +13,140 @@ Check the JSON-RPC methods and namespaces supported on Ethermint. {synopsis}
## JSON-RPC Methods ## JSON-RPC Methods
| Method | Namespace | Implemented | Notes | | Method | Namespace | Implemented | Notes |
|-----------------------------------------------------------------------------------|-----------|-------------|-------------------------------------------------------------------------------------------------------------------------------| |-----------------------------------------------------------------------------------|-----------|-------------|---------------------------|
| [`web3_clientVersion`](#web3_clientVersion) | Web3 | ✔ | | | [`web3_clientVersion`](#web3-clientversion) | Web3 | ✔ | |
| [`web3_sha3`](#web3_sha3) | Web3 | ✔ | | | [`web3_sha3`](#web3-sha3) | Web3 | ✔ | |
| [`net_version`](#net_version) | Net | ✔ | | | [`net_version`](#net-version) | Net | ✔ | |
| `net_peerCount` | Net | | | | `net_peerCount` | Net | | |
| `net_listening` | Net | | | | `net_listening` | Net | | |
| [`eth_protocolVersion`](#eth_protocolVersion) | Eth | ✔ | | | [`eth_protocolVersion`](#eth-protocolversion) | Eth | ✔ | |
| [`eth_syncing`](#eth_syncing) | Eth | ✔ | | | [`eth_syncing`](#eth-syncing) | Eth | ✔ | |
| [`eth_gasPrice`](#eth_gasPrice) | Eth | ✔ | | | [`eth_gasPrice`](#eth-gasprice) | Eth | ✔ | |
| [`eth_accounts`](#eth_accounts) | Eth | ✔ | | | [`eth_accounts`](#eth-accounts) | Eth | ✔ | |
| [`eth_blockNumber`](#eth_blockNumber) | Eth | ✔ | | | [`eth_blockNumber`](#eth-blocknumber) | Eth | ✔ | |
| [`eth_getBalance`](#eth_getBalance) | Eth | ✔ | | | [`eth_getBalance`](#eth-getbalance) | Eth | ✔ | |
| [`eth_getStorageAt`](#eth_getStorageAt) | Eth | ✔ | | | [`eth_getStorageAt`](#eth-getstorageat) | Eth | ✔ | |
| [`eth_getTransactionCount`](#eth_getTransactionCount) | Eth | ✔ | | | [`eth_getTransactionCount`](#eth-gettransactioncount) | Eth | ✔ | |
| [`eth_getBlockTransactionCountByNumber`](#eth_getBlokTransactionCountByNumber) | Eth | ✔ | | | [`eth_getBlockTransactionCountByNumber`](#eth-getblocktransactioncountbynumber) | Eth | ✔ | |
| [`eth_getBlockTransactionCountByHash`](#eth_getBlockTransactionCountByHash) | Eth | ✔ | | | [`eth_getBlockTransactionCountByHash`](#eth-getblocktransactioncountbyhash) | Eth | ✔ | |
| [`eth_getCode`](#eth_getCode) | Eth | ✔ | | | [`eth_getCode`](#eth-getcode) | Eth | ✔ | |
| [`eth_sign`](#eth_sign) | Eth | ✔ | | | [`eth_sign`](#eth-sign) | Eth | ✔ | |
| [`eth_sendTransaction`](#eth_sendTransaction) | Eth | ✔ | | | [`eth_sendTransaction`](#eth-sendtransaction) | Eth | ✔ | |
| [`eth_sendRawTransaction`](#eth_sendRawTransaction) | Eth | ✔ | | | [`eth_sendRawTransaction`](#eth-sendrawtransaction) | Eth | ✔ | |
| [`eth_call`](#eth_call) | Eth | ✔ | | | [`eth_call`](#eth-call) | Eth | ✔ | |
| [`eth_estimateGas`](#eth_estimateGas) | Eth | ✔ | | | [`eth_estimateGas`](#eth-estimategas) | Eth | ✔ | |
| [`eth_getBlockByNumber`](#eth_getBlockByNumber) | Eth | ✔ | | | [`eth_getBlockByNumber`](#eth-getblockbynumber) | Eth | ✔ | |
| [`eth_getBlockByHash`](#eth_getBlockByHash) | Eth | ✔ | | | [`eth_getBlockByHash`](#eth-getblockbyhash) | Eth | ✔ | |
| [`eth_getTransactionByHash`](#eth_getTransactionByHash) | Eth | ✔ | | | [`eth_getTransactionByHash`](#eth-gettransactionbyhash) | Eth | ✔ | |
| [`eth_getTransactionByBlockHashAndIndex`](#eth_getTransactionByBlockHashAndIndex) | Eth | ✔ | | | [`eth_getTransactionByBlockHashAndIndex`](#eth-gettransactionbyblockhashandindex) | Eth | ✔ | |
| [`eth_getTransactionReceipt`](#eth_getTransactionReceipt) | Eth | ✔ | | | [`eth_getTransactionReceipt`](#eth-gettransactionreceipt) | Eth | ✔ | |
| [`eth_newFilter`](#eth_newFilter) | Eth | ✔ | | | [`eth_newFilter`](#eth-newfilter) | Eth | ✔ | |
| [`eth_newBlockFilter`](#eth_newBlockFilter) | Eth | ✔ | | | [`eth_newBlockFilter`](#eth-newblockfilter) | Eth | ✔ | |
| [`eth_newPendingTransactionFilter`](#eth_newPendingTransactionFilter) | Eth | ✔ | | | [`eth_newPendingTransactionFilter`](#eth-newpendingtransactionfilter) | Eth | ✔ | |
| [`eth_uninstallFilter`](#eth_uninstallFilter) | Eth | ✔ | | | [`eth_uninstallFilter`](#eth-uninstallfilter) | Eth | ✔ | |
| [`eth_getFilterChanges`](#eth_getFilterChanges) | Eth | ✔ | | | [`eth_getFilterChanges`](#eth-getfilterchanges) | Eth | ✔ | |
| [`eth_getLogs`](#eth_getLogs) | Eth | ✔ | | | [`eth_getLogs`](#eth-getlogs) | Eth | ✔ | |
| `eth_getTransactionbyBlockNumberAndIndex` | Eth | | | | `eth_getTransactionbyBlockNumberAndIndex` | Eth | | |
| `eth_getWork` | Eth | | | | `eth_getWork` | Eth | | |
| `eth_submitWork` | Eth | | | | `eth_submitWork` | Eth | | |
| `eth_submitHashrate` | Eth | | | | `eth_submitHashrate` | Eth | | |
| `eth_getCompilers` | Eth | | | | `eth_getCompilers` | Eth | | |
| `eth_compileLLL` | Eth | | | | `eth_compileLLL` | Eth | | |
| `eth_compileSolidity` | Eth | | | | `eth_compileSolidity` | Eth | | |
| `eth_compileSerpent` | Eth | | | | `eth_compileSerpent` | Eth | | |
| `eth_signTransaction` | Eth | | | | `eth_signTransaction` | Eth | | |
| `eth_mining` | Eth | N/A | Not relevant to Ethermint | | `eth_mining` | Eth | N/A | Not relevant to Ethermint |
| `eth_coinbase` | Eth | N/A | Not relevant to Ethermint | | `eth_coinbase` | Eth | N/A | Not relevant to Ethermint |
| `eth_hashrate` | Eth | N/A | Not relevant to Ethermint | | `eth_hashrate` | Eth | N/A | Not relevant to Ethermint |
| `eth_getUncleCountByBlockHash` | Eth | N/A | Not relevant to Ethermint | | `eth_getUncleCountByBlockHash` | Eth | N/A | Not relevant to Ethermint |
| `eth_getUncleCountByBlockNumber` | Eth | N/A | Not relevant to Ethermint | | `eth_getUncleCountByBlockNumber` | Eth | N/A | Not relevant to Ethermint |
| `eth_getUncleByBlockHashAndIndex` | Eth | N/A | Not relevant to Ethermint | | `eth_getUncleByBlockHashAndIndex` | Eth | N/A | Not relevant to Ethermint |
| `eth_getUncleByBlockNumberAndIndex` | Eth | N/A | Not relevant to Ethermint | | `eth_getUncleByBlockNumberAndIndex` | Eth | N/A | Not relevant to Ethermint |
| [`eth_subscribe`](#eth_subscribe) | Websocket | ✔ | | | [`eth_subscribe`](#eth-subscribe) | Websocket | ✔ | |
| [`eth_unsubscribe`](#eth_unsubscribe) | Websocket | ✔ | | | [`eth_unsubscribe`](#eth-unsubscribe) | Websocket | ✔ | |
| [`personal_importRawKey`](#personal_importRawKey) | Personal | ✔ | | | [`personal_importRawKey`](#personal-importrawkey) | Personal | ✔ | |
| [`personal_listAccounts`](#personal_listAccounts) | Personal | ✔ | | | [`personal_listAccounts`](#personal-listaccounts) | Personal | ✔ | |
| [`personal_lockAccount`](#personal_lockAccount) | Personal | ✔ | | | [`personal_lockAccount`](#personal-lockaccount) | Personal | ✔ | |
| [`personal_newAccount`](#personal_newAccount) | Personal | ✔ | | | [`personal_newAccount`](#personal-newaccount) | Personal | ✔ | |
| [`personal_unlockAccount`](#personal_unlockAccount) | Personal | ✔ | | | [`personal_unlockAccount`](#personal-unlockaccount) | Personal | ✔ | |
| [`personal_sendTransaction`](#personal_sendTransaction) | Personal | ✔ | | | [`personal_sendTransaction`](#personal-sendtransaction) | Personal | ✔ | |
| [`personal_sign`](#personal_sign) | Personal | ✔ | | | [`personal_sign`](#personal-sign) | Personal | ✔ | |
| [`personal_ecRecover`](#personal_ecRecover) | Personal | ✔ | | | [`personal_ecRecover`](#personal-ecrecover) | Personal | ✔ | |
| `db_putString` | DB | | | | `db_putString` | DB | | |
| `db_getString` | DB | | | | `db_getString` | DB | | |
| `db_putHex` | DB | | | | `db_putHex` | DB | | |
| `db_getHex` | DB | | | | `db_getHex` | DB | | |
| `shh_post` | SSH | | | | `shh_post` | SSH | | |
| `shh_version` | SSH | | | | `shh_version` | SSH | | |
| `shh_newIdentity` | SSH | | | | `shh_newIdentity` | SSH | | |
| `shh_hasIdentity` | SSH | | | | `shh_hasIdentity` | SSH | | |
| `shh_newGroup` | SSH | | | | `shh_newGroup` | SSH | | |
| `shh_addToGroup` | SSH | | | | `shh_addToGroup` | SSH | | |
| `shh_newFilter` | SSH | | | | `shh_newFilter` | SSH | | |
| `shh_uninstallFilter` | SSH | | | | `shh_uninstallFilter` | SSH | | |
| `shh_getFilterChanges` | SSH | | | | `shh_getFilterChanges` | SSH | | |
| `shh_getMessages` | SSH | | | | `shh_getMessages` | SSH | | |
| `admin_addPeer` | Admin | | | | `admin_addPeer` | Admin | | |
| `admin_datadir` | Admin | | | | `admin_datadir` | Admin | | |
| `admin_nodeInfo` | Admin | | | | `admin_nodeInfo` | Admin | | |
| `admin_peers` | Admin | | | | `admin_peers` | Admin | | |
| `admin_startRPC` | Admin | | | | `admin_startRPC` | Admin | | |
| `admin_startWS` | Admin | | | | `admin_startWS` | Admin | | |
| `admin_stopRPC` | Admin | | | | `admin_stopRPC` | Admin | | |
| `admin_stopWS` | Admin | | | | `admin_stopWS` | Admin | | |
| `clique_getSnapshot` | Clique | | | | `clique_getSnapshot` | Clique | | |
| `clique_getSnapshotAtHash` | Clique | | | | `clique_getSnapshotAtHash` | Clique | | |
| `clique_getSigners` | Clique | | | | `clique_getSigners` | Clique | | |
| `clique_proposals` | Clique | | | | `clique_proposals` | Clique | | |
| `clique_propose` | Clique | | | | `clique_propose` | Clique | | |
| `clique_discard` | Clique | | | | `clique_discard` | Clique | | |
| `clique_status` | Clique | | | | `clique_status` | Clique | | |
| `debug_backtraceAt` | Debug | | | | `debug_backtraceAt` | Debug | | |
| `debug_blockProfile` | Debug | | | | `debug_blockProfile` | Debug | | |
| `debug_cpuProfile` | Debug | | | | `debug_cpuProfile` | Debug | | |
| `debug_dumpBlock` | Debug | | | | `debug_dumpBlock` | Debug | | |
| `debug_gcStats` | Debug | | | | `debug_gcStats` | Debug | | |
| `debug_getBlockRlp` | Debug | | | | `debug_getBlockRlp` | Debug | | |
| `debug_goTrace` | Debug | | | | `debug_goTrace` | Debug | | |
| `debug_memStats` | Debug | | | | `debug_memStats` | Debug | | |
| `debug_seedHash` | Debug | | | | `debug_seedHash` | Debug | | |
| `debug_setHead` | Debug | | | | `debug_setHead` | Debug | | |
| `debug_setBlockProfileRate` | Debug | | | | `debug_setBlockProfileRate` | Debug | | |
| `debug_stacks` | Debug | | | | `debug_stacks` | Debug | | |
| `debug_startCPUProfile` | Debug | | | | `debug_startCPUProfile` | Debug | | |
| `debug_startGoTrace` | Debug | | | | `debug_startGoTrace` | Debug | | |
| `debug_stopCPUProfile` | Debug | | | | `debug_stopCPUProfile` | Debug | | |
| `debug_stopGoTrace` | Debug | | | | `debug_stopGoTrace` | Debug | | |
| `debug_traceBlock` | Debug | | | | `debug_traceBlock` | Debug | | |
| `debug_traceBlockByNumber` | Debug | | | | `debug_traceBlockByNumber` | Debug | | |
| `debug_traceBlockByHash` | Debug | | | | `debug_traceBlockByHash` | Debug | | |
| `debug_traceBlockFromFile` | Debug | | | | `debug_traceBlockFromFile` | Debug | | |
| `debug_standardTraceBlockToFile` | Debug | | | | `debug_standardTraceBlockToFile` | Debug | | |
| `debug_standardTraceBadBlockToFile` | Debug | | | | `debug_standardTraceBadBlockToFile` | Debug | | |
| `debug_traceTransaction` | Debug | | | | `debug_traceTransaction` | Debug | | |
| `debug_verbosity` | Debug | | | | `debug_verbosity` | Debug | | |
| `debug_vmodule` | Debug | | | | `debug_vmodule` | Debug | | |
| `debug_writeBlockProfile` | Debug | | | | `debug_writeBlockProfile` | Debug | | |
| `debug_writeMemProfile` | Debug | | | | `debug_writeMemProfile` | Debug | | |
| `les_serverInfo` | Les | | | | `les_serverInfo` | Les | | |
| `les_clientInfo` | Les | | | | `les_clientInfo` | Les | | |
| `les_priorityClientInfo` | Les | | | | `les_priorityClientInfo` | Les | | |
| `les_addBalance` | Les | | | | `les_addBalance` | Les | | |
| `les_setClientParams` | Les | | | | `les_setClientParams` | Les | | |
| `les_setDefaultParams` | Les | | | | `les_setDefaultParams` | Les | | |
| `les_latestCheckpoint` | Les | | | | `les_latestCheckpoint` | Les | | |
| `les_getCheckpoint` | Les | | | | `les_getCheckpoint` | Les | | |
| `les_getCheckpointContractAddress` | Les | | | | `les_getCheckpointContractAddress` | Les | | |
| `miner_getHashrate` | Miner | | | | `miner_getHashrate` | Miner | | |
| `miner_setExtra` | Miner | | | | `miner_setExtra` | Miner | | |
| `miner_setGasPrice` | Miner | | | | `miner_setGasPrice` | Miner | | |
| `miner_start` | Miner | | | | `miner_start` | Miner | | |
| `miner_stop` | Miner | | | | `miner_stop` | Miner | | |
| `miner_setEtherbase` | Miner | | | | `miner_setEtherbase` | Miner | | |
| `txpool_content` | TXPool | | | | `txpool_content` | TXPool | | |
| `txpool_inspect` | TXPool | | | | `txpool_inspect` | TXPool | | |
| `txpool_status` | TXPool | | | | `txpool_status` | TXPool | | |
:::tip :::tip