MetaMask / MetaMask/metamask-extension

Formalize our supported (provider) interface

Open
#3,943 6 comments 0 reactions 0 assignees View on GitHub
area-documentation type-enhancement
Dominant language
TypeScript
Stars
13.2k
Forks
5.6k
Avg merge
2d 5h
Merged PRs (30d)
451

Description

Our supported provider is not really documented at all. We need to add docs to what API exactly we support, and enforce it with tests.

Must include:
- Accepted param types
- Tests for accepted param types

We should also throw errors on non-accepted param types, to ensure devs don't think things are working when they aren't.

Contributor guide

Open the contributing guide

Research direction

Locate the supported provider interface and any existing provider tests, then read how provider parameters are currently handled. Document the accepted parameter types, add tests for them, and verify that unsupported types produce errors; the issue is complete when the interface behavior is explicit and enforced.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api, documentation, testing-qa
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.