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

remove list of AsyncHTTPProvider-supported methods #2962

Merged
merged 2 commits into from May 24, 2023

Conversation

pacrob
Copy link
Contributor

@pacrob pacrob commented May 22, 2023

What was wrong?

AsyncHTTPProvider had a list of supported methods, but they're all supported now!

How was it fixed?

Removed the list and formatted the remaining differences from HTTPProvider
Created function headers for the async middleware in docs.

Todo:

Cute Animal Picture

image

@pacrob pacrob force-pushed the asynchttpprovider-supports-all-methods branch from 69550d9 to 96d6bcd Compare May 22, 2023 19:59
Copy link
Collaborator

@kclowes kclowes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! It seems like we should have some documentation around the async versions of the middleware that include examples, or at the very least list out what they're called. I'd be okay with adding a new issue for that though if you'd rather.

@pacrob pacrob force-pushed the asynchttpprovider-supports-all-methods branch 4 times, most recently from f8eecae to 74b734c Compare May 23, 2023 15:44
@pacrob pacrob requested a review from kclowes May 23, 2023 15:51
Copy link
Collaborator

@kclowes kclowes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Do you think it's worth adding a disclaimer up at the top that async middlewares can only be used with the async provider? or is that self-evident? I can see either way.

@@ -288,12 +291,13 @@ Web3 ships with non-default middleware, for your custom use. In addition to the
either use ``middleware_onion.add()`` from above, or add the default middlewares to your list of
new middlewares.

Below is a list of built-in middleware, which is not enabled by default.
Below is a list of available middlewares which are not enabled by default.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Much better wording :)

@pacrob pacrob force-pushed the asynchttpprovider-supports-all-methods branch from 74b734c to a88a0d2 Compare May 24, 2023 16:43
@pacrob
Copy link
Contributor Author

pacrob commented May 24, 2023

Good idea for choosing the correct version for your provider documentation. I've added.

@pacrob pacrob merged commit aa6ecd2 into ethereum:main May 24, 2023
69 checks passed
@pacrob pacrob deleted the asynchttpprovider-supports-all-methods branch May 24, 2023 17:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants