Migrate json-rpc information from ethdocs/eth.wiki #5922
Conversation
github-actions
bot
added
content 🖋️
Gatsby Cloud Build Reportethereum-org-website-dev 🎉 Your build was successful! See the Deploy preview here. Build Details🕐 Build time: 9m PerformanceLighthouse report
|
jmcook1186
requested review from
samajammin,
wackerow,
corwintines,
pettinarip and
minimalsm
as code owners
| @@ -24,6 +19,202 @@ Ethereum clients each may utilize different programming languages when implement | |||
|
|
|||
| While you may choose to interact directly with Ethereum clients via the JSON-RPC API, there are often easier options for dapp developers. Many [JavaScript](/developers/docs/apis/javascript/#available-libraries) and [backend API](/developers/docs/apis/backend/#available-libraries) libraries exist to provide wrappers on top of the JSON-RPC API. With these libraries, developers can write intuitive, one-line methods in the programming language of their choice to initialize JSON-RPC requests (under the hood) that interact with Ethereum. | |||
|
|
|||
| ## Spec {#spec} | |||
|
|
|||
| The full JSON-RPC API spec is available [here](https://github.com/ethereum/execution-apis). | |||
There was a problem hiding this comment.
|
|
||
| #### Hex value encoding {#hex-encoding} | ||
|
|
||
| At present there are two key datatypes that are passed over JSON: unformatted byte arrays and quantities. Both are passed with a hex encoding, however with different requirements to formatting: |
There was a problem hiding this comment.
At present
Is this going to change?
|
Left a few comments, but I'm in no position to comment on whether it covers the right things or not 😅. However, it is fairly clear and reads well so it gets my blessing. |
Co-authored-by: Joshua <[email protected]>
Co-authored-by: Joshua <[email protected]>
There was a problem hiding this comment.
@jmcook1186 Looks good, fills this page out nicely. Left a couple small code tweak suggestions which shouldn't be controversial.
Only other thought I had related to this would be potentially breaking the nested tutorial here off into an actual tutorial for the /developers/tutorials section of the site. I think this is great for now though and we can discuss that potentially in the future.
There was a problem hiding this comment.
@jmcook1186 Went ahead and committed the small adjustments I suggested. Will double check that this all builds correctly before merging, but think this is good to go! 🎉
|
Murggginnnn 🚀 |
Description
This PR adds information from eth,wiki and ethdocs.org to ethereum.org/en/developers/docs/apis/json-rpc/.
Note that the key information is really the JSON-RPC API spec, which used to be included in full on the wiki but is not held externally - I have linked out to it.
In the preservationist spirit, and because I thought it was useful information not available elsewhere, I incorporated the short RPC contract deployment tutorial from ethdocs.org into this page.
Related Issue
#5731 and #5690