-
Notifications
You must be signed in to change notification settings - Fork 63
Conversation
Oops, my bad. I didn't realized that those new Some tests broke because of this. They were using private APIs, so I'm not sure what's the best way to move forward. The easiest way of fixing this is to make things |
I went ahead and implemented this to keep this PR small. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great thanks, together with the TS update from @whymarrh really a milestone for this library, will directly prepare some release PR so that we can get this out! 😀
Some notes:
- This large inlined doc comment on the constructor should be broken down and especially the opts dict described by annotation tags, the deprecation note can probably be dropped
- This hidden tagging is not so beautiful and bloats the code especially on private variables, we should eventually dig deeper if this can be alternatively addressed
Both no blockers though, we can handle in subsequent PRs iteratively.
Some other notes:
|
(these can also be addressed later/separate) |
This PR fixes #95, updating the docs to be compatible with the
ethereumjs-config
setup.It mostly moves the docs from the
README.md
to the sources, with some formatting changes.Note I didn't find places where the doc was outdated, but I'm not that familiar with this library yet, so I may have missed something.
Finally, I'm not sure how to document
Blockchain.prototype.db
,Blockchain.prototype.dbManager
, andBlockchain.prototype.ethash
. I suspect they should have beenprivate
fields. Apart from that, it is ready for review.