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

Accidental breaking change introduced in v18.1.0 #389

Closed
Gudahtt opened this issue Nov 27, 2024 · 0 comments · Fixed by #390
Closed

Accidental breaking change introduced in v18.1.0 #389

Gudahtt opened this issue Nov 27, 2024 · 0 comments · Fixed by #390
Assignees
Labels
bug Something isn't working team-wallet-framework

Comments

@Gudahtt
Copy link
Member

Gudahtt commented Nov 27, 2024

This PR was included in v18.1.0: #381

It included a breaking change to initializeProvider, namely that the parameter jsonRpcStreamName is now required when it was functionally optional before. The change was made to fix a type error; the MetaMaskInpageProvider mistakenly had typed that parameter is required, but the intention was for it to be optional.

@Gudahtt Gudahtt added the bug Something isn't working label Nov 27, 2024
Gudahtt added a commit that referenced this issue Nov 27, 2024
The `MetaMaskInpageProvider` type was mistakenly typed to require the
`jsonRpcStreamName` as a constructor parameter, despite the author
clearly intending this to be optional. This type error was fixed.

This type error motivated a different bug, which is that validation for
`jsonRpcStreamName` was added to `initializeInapgeProvider` in #381,
constituting an undocumented breaking change (currently blocking us
from updating this package in `metamask-extension`). This validation
has been removed now that it's no longer needed.

Fixes #389
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working team-wallet-framework
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants