Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Add an OpenRPC Document #114

Closed
Nana-EC opened this issue May 28, 2022 · 2 comments · Fixed by #360
Closed

Add an OpenRPC Document #114

Nana-EC opened this issue May 28, 2022 · 2 comments · Fixed by #360
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request limechain P2
Milestone

Comments

@Nana-EC
Copy link
Collaborator

Nana-EC commented May 28, 2022

Problem

We currently don't have complete documentation for the endpoints provided

Solution

We should utilize the OpenRPC standard and the OpenRPC Playground

See Open RPC examples and OpenRPC in the wild for notable examples

Alternatives

No response

@Nana-EC Nana-EC added enhancement New feature or request P2 documentation Improvements or additions to documentation labels May 28, 2022
@Nana-EC Nana-EC added this to the 0.2.0 milestone May 31, 2022
@Nana-EC Nana-EC removed this from the 0.2.0 milestone Jun 16, 2022
@Nana-EC Nana-EC added this to the 0.3.0 milestone Jun 20, 2022
@Nana-EC Nana-EC modified the milestones: 0.3.0, 0.4.0 Jun 30, 2022
@Nana-EC Nana-EC added limechain P3 and removed P2 labels Jul 5, 2022
@Nana-EC Nana-EC modified the milestones: 0.4.0, 0.5.0 Jul 14, 2022
@ar-conmit
Copy link
Collaborator

The ticket has some progress in this branch. The following methods are already documented:
eth_getBlockByHash
eth_getBlockByNumber
eth_getBlockTransactionCountByHash
eth_getBlockTransactionCountByNumber
eth_getUncleCountByBlockHash
eth_getUncleCountByBlockNumber
eth_protocolVersion
eth_chainId
eth_syncing
eth_coinbase
eth_accounts
eth_blockNumber

@Nana-EC Nana-EC added P2 and removed P3 labels Jul 18, 2022
@Nana-EC
Copy link
Collaborator Author

Nana-EC commented Jul 19, 2022

Great work.
If possible please update server.ts to serve the document up, so it's available for every deployment.

@Nana-EC Nana-EC mentioned this issue Jul 20, 2022
2 tasks
Repository owner moved this from Todo to Done in Smart Contract Sprint Board Jul 21, 2022
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request limechain P2
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants