Add interactions involving filters & subscriptions #202
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
We have a PR in the extension repo which touches code around RPC
middleware for filter- and subscription-based RPC methods, and we want
to be able to test these methods manually to ensure they are still
working as designed. In order to accomplish this, I've added new cards
which allow the user to:
* Create and remove a filter.
* Currently there is support for creating a generic log filter via
`eth_newFilter` as well as a block filter via `eth_newBlockFilter`.
Once a filter is created, `eth_getFilterChanges` is then polled
every 2 seconds. Filters are removed via `eth_uninstallFilter`.
* I tried to add a button which created a pending transaction filter
via `eth_newPendingTransactionFilter`, but it appears that
`eth-json-rpc-filters` has a
[bug](MetaMask/eth-json-rpc-filters#81)
which prohibits this RPC method from working fully.
* Start and stop a subscription.
* As with filters, currently there is support for subscribing to new
blocks via the `newHeads` parameter to `eth_subscribe` as well as
new logs via the `logs` parameter. Subscriptions are stopped via
`eth_unsubscribe`.
* I also tried to add a button for subscribing to pending
transactions, but [this doesn't seem to be supported outright by
`eth-json-rpc-filters`](https://github.com/MetaMask/eth-json-rpc-filters/blob/5cbea3037b0655aa2c188d85b8ffe559a263dc0d/subscriptionManager.js#L50).
legobeat
reviewed
Dec 16, 2022
Comment on lines
+34
to
+37
| if (!['log', 'block', 'pendingTransaction'].includes(filterType)) { | ||
| throw new Error( | ||
| "filterType must be either 'log', 'block', or 'pendingTransaction'", | ||
| ); |
There was a problem hiding this comment.
Mostly to get rid of double-quotes ;)
Suggested change
| if (!['log', 'block', 'pendingTransaction'].includes(filterType)) { | |
| throw new Error( | |
| "filterType must be either 'log', 'block', or 'pendingTransaction'", | |
| ); | |
| const validFilterTypes = ['log', 'block', 'pendingTransaction']; | |
| if (!validFilterTypes.includes(filterType)) { | |
| throw new Error( | |
| `filterType must be one of: ${validFilterTypes.join(',')}.`, | |
| ); |
Gudahtt
reviewed
Dec 16, 2022
|
|
||
| newSubscriptionId = await ethereum.request({ | ||
| method: 'eth_subscribe', | ||
| params: [subscriptionType], |
There was a problem hiding this comment.
For the logs subscription type, this ends up being very noisy. Perhaps we could add a "topic" filter to reduce the volume?
8 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We have a PR in the extension repo which touches code around RPC middleware for filter- and subscription-based RPC methods, and we want to be able to test these methods manually to ensure they are still working as designed. In order to accomplish this, I've added new cards which allow the user to:
eth_newFilteras well as a block filter viaeth_newBlockFilter. Once a filter is created,eth_getFilterChangesis then polled every 2 seconds. Filters are removed viaeth_uninstallFilter.eth_newPendingTransactionFilter, but it appears thateth-json-rpc-filtershas a bug which prohibits this RPC method from working fully.newHeadsparameter toeth_subscribeas well as new logs via thelogsparameter. Subscriptions are stopped viaeth_unsubscribe.eth-json-rpc-filters.Screencaps
Screen.Recording.2022-12-15.at.5.24.28.PM.mov