{"type": "project", "title": "REST wrapper", "logoImg": "bafkreicpap4l7c2wjdjxlgwahczbval5ecxmiwfqw26ajbaxp3zzuzo2tq", "website": "https://github.com/Rest-Wrapper/ethRPCtoREST", "bannerImg": "bafkreic7su33wgufdrzm67eewyzjjzbdlpjxc2up3gwzsf3wvppp4fwpgu", "createdAt": 1700894262151, "userGithub": "Amit0617", "credentials": {"github": {"type": ["VerifiableCredential"], "proof": {"jws": "eyJhbGciOiJFZERTQSIsImNyaXQiOlsiYjY0Il0sImI2NCI6ZmFsc2V9..8ptGA4Mf3LLtY6B6WOdSZo1HqSDtKO9-54-1LWpbRg7teyNCCn_i3ew6Y-LXDe7yy5W17sw7l3ImqaN-kRLVCw", "type": "Ed25519Signature2018", "created": "2023-11-25T07:37:01.909Z", "proofPurpose": "assertionMethod", "verificationMethod": "did:key:z6MkghvGHLobLEdj1bgRLhS4LPGJAvbMA1tn2zcRyqmYU5LC#z6MkghvGHLobLEdj1bgRLhS4LPGJAvbMA1tn2zcRyqmYU5LC"}, "issuer": "did:key:z6MkghvGHLobLEdj1bgRLhS4LPGJAvbMA1tn2zcRyqmYU5LC", "@context": ["https://www.w3.org/2018/credentials/v1"], "issuanceDate": "2023-11-25T07:37:01.909Z", "expirationDate": "2024-02-23T07:37:01.909Z", "credentialSubject": {"id": "did:pkh:eip155:1:0x47c0C4eb25b0Aa4bC5D1E6341F5eE9A6aD2B596c", "hash": "v0.0.0:N66xrVTejtTsFA7ybhX+tH1FC5y2D0vzYkqHDgHgN04=", "@context": [{"hash": "https://schema.org/Text", "provider": "https://schema.org/Text"}], "provider": "ClearTextGithubOrg#Rest-Wrapper#71893015"}}}, "description": "Introduction:\nWe are proposing the development of ethRPCtoREST, an open-source project that aims to create a REST wrapper around the JSON-RPC APIs of the execution layer of Ethereum nodes. This project will serve as a simplified interface for programmers to interact with the Ethereum network, making it more convenient and human-friendly. The project also includes auto-generated OpenAPI documentation with a better developer experience which will benefit other Ethereum projects when documenting their APIs.\nNecessity:\nThe current RPC interface of the execution layer is inconvenient difficult for for programmers who aren\u2019t already familiar with Ethereum or themselves power users. For example, The responses returned by the nodes are hex-encoded, making them difficult to understand and work with., and some common emergent primitives (like deploying a smart contract) require careful orchestration of many RPC endpoints to achieve. Libraries do exist which abstract away some of these painpoints however given the lack of a standardised REST API in the first place using any one library is opting in to specifically that interface. This creates a barrier for developers who want to build applications on top of Ethereum. By developing ethRPCtoREST, we can simplify the interaction process and make it more accessible for programmers. who are newer to the ecosystem or who want a simpler development experience.\nImpact:\nThe impact of this project will be significant. By providing a REST API interface, we can attract more developers to build on Ethereum and contribute to its ecosystem. This will lead to an increase in the number of applications and services available on the network, ultimately driving adoption and usage. Additionally, by simplifying the interaction process, we can lower the barrier for entry and encourage more developers to experiment with Ethereum. Having API documentation generated from a more lightweight and easy to use toolchain also allows new applications (themselves perhaps exposing their own REST API), and also equally importantly Ethereum\u2019s existing APIs, to be more thoroughly documented (for instance, not manually editing OpenAPI JSON or YAML files) and easier to iterate on. The lower the complexity to contribution the more likely a contribution will occur.\nProgress:\nThe development of ethRPCtoREST started during the Ethereum Protocol Fellowship from July 10th, 2023, to October 29th, 2023. Since then, significant progress has been made. Around 17 REST endpoints have been developed, covering approximately 18 execution layer methods. These endpoints act as wrappers around multiple methods or consolidate multiple methods into a single endpoint for ease of use. Weekly development updates have been recorded and are available for transparency. OpenAPI documentation for OAS 3.1.0 currently covers general REST API needs (e.g. template paths, query parameters, request bodies), adding patterns to cover all REST API patterns continues.\nEligibility:\nethRPCtoREST meets all relevant eligibility criteria for funding. It is an open-source project that aims to develop and advance the broader Ethereum ecosystem by providing a simplified interface for developers. The ongoing progress and meaningful GitHub activity within the past three months demonstrate our commitment to continuous development and improvement.\nBy supporting ethRPCtoREST, you will contribute to the growth and accessibility of the Ethereum network. Your donation will help us maintain and enhance the project, ensuring that developers have a user-friendly interface to interact with Ethereum's execution layer. Together, we can empower more developers to build innovative applications on Ethereum and drive the adoption of Web3 technologies.\n", "logoImgData": {}, "bannerImgData": {}, "projectGithub": "Rest-Wrapper"}
REST wrapper
Introduction:
We are proposing the development of ethRPCtoREST, an open-source project that aims to create a REST wrapper around the JSON-RPC APIs of the execution layer of Ethereum nodes. This project will serve as a simplified interface for programmers to interact with the Ethereum network, making it more convenient and human-friendly. The project also includes auto-generated OpenAPI documentation with a better developer experience which will benefit other Ethereum projects when documenting their APIs.
Necessity:
The current RPC interface of the execution layer is inconvenient difficult for for programmers who aren’t already familiar with Ethereum or themselves power users. For example, The responses returned by the nodes are hex-encoded, making them difficult to understand and work with., and some common emergent primitives (like deploying a smart contract) require careful orchestration of many RPC endpoints to achieve. Libraries do exist which abstract away some of these painpoints however given the lack of a standardised REST API in the first place using any one library is opting in to specifically that interface. This creates a barrier for developers who want to build applications on top of Ethereum. By developing ethRPCtoREST, we can simplify the interaction process and make it more accessible for programmers. who are newer to the ecosystem or who want a simpler development experience.
Impact:
The impact of this project will be significant. By providing a REST API interface, we can attract more developers to build on Ethereum and contribute to its ecosystem. This will lead to an increase in the number of applications and services available on the network, ultimately driving adoption and usage. Additionally, by simplifying the interaction process, we can lower the barrier for entry and encourage more developers to experiment with Ethereum. Having API documentation generated from a more lightweight and easy to use toolchain also allows new applications (themselves perhaps exposing their own REST API), and also equally importantly Ethereum’s existing APIs, to be more thoroughly documented (for instance, not manually editing OpenAPI JSON or YAML files) and easier to iterate on. The lower the complexity to contribution the more likely a contribution will occur.
Progress:
The development of ethRPCtoREST started during the Ethereum Protocol Fellowship from July 10th, 2023, to October 29th, 2023. Since then, significant progress has been made. Around 17 REST endpoints have been developed, covering approximately 18 execution layer methods. These endpoints act as wrappers around multiple methods or consolidate multiple methods into a single endpoint for ease of use. Weekly development updates have been recorded and are available for transparency. OpenAPI documentation for OAS 3.1.0 currently covers general REST API needs (e.g. template paths, query parameters, request bodies), adding patterns to cover all REST API patterns continues.
Eligibility:
ethRPCtoREST meets all relevant eligibility criteria for funding. It is an open-source project that aims to develop and advance the broader Ethereum ecosystem by providing a simplified interface for developers. The ongoing progress and meaningful GitHub activity within the past three months demonstrate our commitment to continuous development and improvement.
By supporting ethRPCtoREST, you will contribute to the growth and accessibility of the Ethereum network. Your donation will help us maintain and enhance the project, ensuring that developers have a user-friendly interface to interact with Ethereum's execution layer. Together, we can empower more developers to build innovative applications on Ethereum and drive the adoption of Web3 technologies.

REST wrapper