uport-project / ethr-did

Create ethr DIDs
Apache License 2.0
268 stars 54 forks source link

add section warning about web3 http provider sendAsync to readme #14

Closed mi-xu closed 6 years ago

mi-xu commented 6 years ago

The reported issue is caused by an issue originating from a specific version of a user-supplied third party dependency.

I propose addressing it by including a section in the readme to warn developers about when it occurs and providing a couple workarounds. The rationale is that fixing the root issue is outside the responsibility of this library, and changing code to deal with the specific scenario is a bad pattern for a variety of reasons.

I also considered checking for an undefined sendAsync in configureProvider() and logging a warning to the user, but generalizing that to validating the entire provider object doesn't seem like a great idea. What do people think about that?

Any suggestions for alternate ways to either communicate or supply a fix for this issue are welcome.