Auto-Generate JSON-RPC API docs

[Tbaut]

Originally from https://github.com/paritytech/wiki/issues/58 but transferred here for better visibility.

We have 2 tools

1. Generate markdown docs from js files (should be run during the CI to make sure we document methods in JS format)
2. Make sure that no rust RPC is missing in JS files (can be automated to make a PR to wiki for example.)

@tomusdrw can you add anything relevant for this issue to be picked up as a task or bounty?

[tomusdrw]

Have a look at this: https://github.com/parity-js/jsonrpc It pretty much has all we want

[Tbaut]

Thanks,
From npm run build:markdown

ERROR:	parity_allTransactions is defined in Rust traits, but not in js/src/jsonrpc/interfaces
ERROR:	parity_call is defined in Rust traits, but not in js/src/jsonrpc/interfaces
ERROR:	parity_nodeHealth is defined in Rust traits, but not in js/src/jsonrpc/interfaces
ERROR:	personal_ecRecover is defined in Rust traits, but not in js/src/jsonrpc/interfaces
ERROR:	personal_sign is defined in Rust traits, but not in js/src/jsonrpc/interfaces
ERROR:	personal_signTransaction is defined in Rust traits, but not in js/src/jsonrpc/interfaces
ERROR:	private_composeDeploymentTransaction is defined in Rust traits, but not in js/src/jsonrpc/interfaces
ERROR:	private_contractKey is defined in Rust traits, but not in js/src/jsonrpc/interfaces
ERROR:	secretstore_decrypt is defined in Rust traits, but not in js/src/jsonrpc/interfaces
ERROR:	secretstore_encrypt is defined in Rust traits, but not in js/src/jsonrpc/interfaces
ERROR:	secretstore_generateDocumentKey is defined in Rust traits, but not in js/src/jsonrpc/interfaces
ERROR:	secretstore_serversSetHash is defined in Rust traits, but not in js/src/jsonrpc/interfaces
ERROR:	secretstore_shadowDecrypt is defined in Rust traits, but not in js/src/jsonrpc/interfaces
ERROR:	secretstore_signRawHash is defined in Rust traits, but not in js/src/jsonrpc/interfaces
ERROR:	trace_callMany is defined in Rust traits, but not in js/src/jsonrpc/interfaces
ERROR:	trace_replayBlockTransactions is defined in Rust traits, but not in js/src/jsonrpc/interfaces
INFO:	Skipping db_getHex: Not present in Rust code
INFO:	Skipping db_getString: Not present in Rust code
INFO:	Skipping db_putHex: Not present in Rust code
INFO:	Skipping db_putString: Not present in Rust code
INFO:	Skipping eth_fetchQueuedTransactions: Not present in Rust code
INFO:	Skipping eth_flush: Not present in Rust code
INFO:	eth_getBlockByNumber has a request example and only text description for response
INFO:	Skipping eth_getFilterChangesEx: Not present in Rust code
INFO:	eth_getFilterLogs has a request example and only text description for response
INFO:	Skipping eth_getFilterLogsEx: Not present in Rust code
INFO:	eth_getLogs has a request example and only text description for response
INFO:	Skipping eth_getLogsEx: Not present in Rust code
INFO:	eth_getTransactionByBlockHashAndIndex has a request example and only text description for response
INFO:	eth_getTransactionByBlockNumberAndIndex has a request example and only text description for response
INFO:	eth_getUncleByBlockHashAndIndex has a request example and only text description for response
INFO:	eth_getUncleByBlockNumberAndIndex has a request example and only text description for response
INFO:	Skipping eth_inspectTransaction: Not present in Rust code
INFO:	Skipping eth_newFilterEx: Not present in Rust code
INFO:	Skipping eth_notePassword: Not present in Rust code
INFO:	Skipping eth_pendingTransactions: Not present in Rust code
INFO:	Skipping eth_register: Not present in Rust code
INFO:	Skipping eth_unregister: Not present in Rust code
ERROR:	shh_addPrivateKey is defined in js/src/jsonrpc/interfaces, but not in Rust traits
ERROR:	shh_addPrivateKey has no examples
ERROR:	shh_deleteKey is defined in js/src/jsonrpc/interfaces, but not in Rust traits
ERROR:	shh_deleteKey has no examples
ERROR:	shh_deleteMessageFilter is defined in js/src/jsonrpc/interfaces, but not in Rust traits
ERROR:	shh_deleteMessageFilter has no examples
ERROR:	shh_getFilterMessages is defined in js/src/jsonrpc/interfaces, but not in Rust traits
ERROR:	shh_getFilterMessages has no examples
INFO:	Skipping shh_getFilterMesssages: Not present in Rust code
ERROR:	shh_getPrivateKey is defined in js/src/jsonrpc/interfaces, but not in Rust traits
ERROR:	shh_getPrivateKey has no examples
ERROR:	shh_getPublicKey is defined in js/src/jsonrpc/interfaces, but not in Rust traits
ERROR:	shh_getPublicKey has no examples
ERROR:	shh_getSymKey is defined in js/src/jsonrpc/interfaces, but not in Rust traits
ERROR:	shh_getSymKey has no examples
ERROR:	shh_info is defined in js/src/jsonrpc/interfaces, but not in Rust traits
WARN:	shh_info has a request example but not a response example
ERROR:	shh_newKeyPair is defined in js/src/jsonrpc/interfaces, but not in Rust traits
WARN:	shh_newKeyPair has a request example but not a response example
ERROR:	shh_newMessageFilter is defined in js/src/jsonrpc/interfaces, but not in Rust traits
ERROR:	shh_newMessageFilter has no examples
ERROR:	shh_newSymKey is defined in js/src/jsonrpc/interfaces, but not in Rust traits
WARN:	shh_newSymKey has a request example but not a response example
ERROR:	shh_post is defined in js/src/jsonrpc/interfaces, but not in Rust traits
ERROR:	shh_post has no examples
ERROR:	shh_subscribe is defined in js/src/jsonrpc/interfaces, but not in Rust traits
ERROR:	shh_subscribe has no examples
ERROR:	shh_unsubscribe is defined in js/src/jsonrpc/interfaces, but not in Rust traits
ERROR:	shh_unsubscribe has no examples
INFO:	Skipping signer_signerEnabled: Not present in Rust code

[gitcoinbot]

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

---

This issue now has a funding of 0.25 ETH (129.73 USD @ $518.93/ETH) attached to it.

• If you would like to work on this issue you can 'start work' on the Gitcoin Issue Details page.
• Questions? Checkout Gitcoin Help or the Gitcoin Slack
• $24,961.53 more funded OSS Work available on the Gitcoin Issue Explorer

[gitcoinbot]

@dilatebrave Hello from Gitcoin Core - are you still working on this issue? Please submit a WIP PR or comment back within the next 3 days or you will be removed from this ticket and it will be returned to an ‘Open’ status. Please let us know if you have questions!

• warning (3 days)
• escalation to mods (6 days)

Funders only: Snooze warnings for 1 day | 3 days | 5 days | 10 days | 100 days

[dilatebrave]

i'm sill working on this issue

[gitcoinbot]

@dilatebrave Hello from Gitcoin Core - are you still working on this issue? Please submit a WIP PR or comment back within the next 3 days or you will be removed from this ticket and it will be returned to an ‘Open’ status. Please let us know if you have questions!

• warning (3 days)
• escalation to mods (6 days)

Funders only: Snooze warnings for 1 day | 3 days | 5 days | 10 days | 100 days