Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Documentation of the Ethereum Connector does not appear to match the implementation #1566

Open
davidkel opened this issue May 3, 2024 · 4 comments
Labels
bug Something isn't working documentation Related to the documentation

Comments

@davidkel
Copy link
Contributor

davidkel commented May 3, 2024

I'm no expert here but looking at the code there appears to be at least 2 properties which are not covered in the network configuration and there could be more

  • chainId
  • privacy
@davidkel davidkel added bug Something isn't working documentation Related to the documentation labels May 3, 2024
@Ayush9026
Copy link

@davidkel sir I will solve this issue.

@duckling69
Copy link
Contributor

Hi, @davidkel I went through the code you mentioned ethereum.js which I assume is this and also went through the Ethereum connector docs but I've some doubts. By covering those properties in the documentation. do you simply mean adding a description of those properties in the documentation or is there more to it?

@davidkel
Copy link
Contributor Author

@duckling69 I've not looked into the implementation really (not my area), but noticed that there were properties in the implementation that were not documented. What is really needed is to ensure that the documentation matches the implementation so an understanding of the capabilities of the implementation are required and then the documentation to be adjusted accordingly

@duckling69
Copy link
Contributor

I think I got the issue which is inconsistency between docs and implementation.
Can you assign me the issue so I'll start working on it as it may take sometime and will also require some code reviews // @davidkel

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Related to the documentation
Projects
None yet
Development

No branches or pull requests

3 participants