This repository was archived by the owner on Oct 16, 2025. It is now read-only.
Align Provider type w/ other packages & re-expose #117
Conversation
This file contains hidden or 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
|
The SafeEventEmitterProvider type from |
|
Also — and we've discussed this on Slack — in the future we should extract SafeEventEmitterProvider to another package so that both |
legobeat
previously approved these changes
Nov 27, 2022
The Provider type which is used internally by this package is not
compatible with the SafeEventEmitterProvider type used by
`eth-json-rpc-middleware`. This means that whenever using this package
with `eth-json-rpc-middleware` we have to resort to the following
hackery:
```
import { PollingBlockTracker, Provider } from 'eth-block-tracker';
import { JsonRpcEngine } from 'json-rpc-engine';
import { providerFromEngine } from '../src';
const engine = new JsonRpcEngine();
const provider = providerFromEngine(engine);
const blockTracker = new PollingBlockTracker({
// Notice the typecasting here
provider: provider as Provider,
});
```
SafeEventEmitterProvider is the more accurate type here in this case,
because it correctly types the `error` argument for the callback that
`sendAsync` calls as `unknown` rather than `Error`, so we follow suit
here.
Additionally, this package used to expose the Provider type and that was
changed in 6.0.0 without being documented, probably because it was
located in the same file as BaseBlockTracker. So here we move the type
to a more obvious place and re-expose it.
mcmire
force-pushed
the
fix-provider-type
branch
from
29e12f9 to
afa7351
Compare
|
Tested this with |
This was referenced Dec 7, 2022
Merged
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
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.
The Provider type which is used internally by this package is not compatible with the SafeEventEmitterProvider type used by
eth-json-rpc-middleware. This means that whenever using this package witheth-json-rpc-middlewarewe have to resort to the following hackery:SafeEventEmitterProvider is the more accurate type here in this case, because it correctly types the
errorargument for the callback thatsendAsynccalls asunknownrather thanError, so we follow suit here.Additionally, this package used to expose the Provider type and that was changed in 6.0.0 without being documented, probably because it was located in the same file as BaseBlockTracker. So here we move the type to a more obvious place and re-expose it.
Fixes #114.