NethermindEth / NethermindEth/docs

Add Instructions on how to use and turn off authentication for json rpc.

Open
#247 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement good first issue help wanted
Dominant language
JavaScript
Stars
10
Forks
44
Avg merge
1d 12h
Merged PRs (30d)
6

Description

Add a section within developers that explains how to disable authentication for the json rpc.
Very useful during local development.

Also add a section on

  • how generate the authentication token,
  • important fields
  • and format to use when sending the request to the client.

This doesn't currently exist, the only reference to "authentication" is in the engine section of the doc's page which is less than sufficient.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in the Developers documentation and inspect the existing Engine section's authentication reference. Add guidance covering how to disable JSON-RPC authentication locally, generate a token, identify important fields, and format client requests. Done means these authentication workflows are documented in a clear Developers section.

Written by the indexing model from the issue text.

Assessment

Domain
api, authentication, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
Half a day
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.