scroll-tech / scroll-tech/frontends

[BUG] Network type interpreted as ANY

Open
#964 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
63
Forks
79
Avg merge
16h 15m
Merged PRs (30d)
10

Description

Describe the bug
EmptyNetwork is defined using ValidNetwork<string, never>, which suggests that ValidNetwork was intended to be a generic type. However, ValidNetwork is defined as a concrete type with specific properties and does not accept generic parameters. This is why TypeScript interprets EmptyNetwork as any.

To Reproduce
Steps to reproduce the behavior:

  1. Go to: src/types/network.d.ts
  2. Check type of EmptyNetwork

Expected behavior
If the goal is to create a type EmptyNetwork that represents a "network" with potentially missing or empty fields based on ValidNetwork, generics should not be used in this case.
Instead, you can use utility types like Partial for making all properties optional or use other TypeScript features to modify the existing ValidNetwork type.

Screenshots
image

Additional context
In the current implementation the type of Network is quite useless, because it implies being "any" because of this incosistency with EmptyNetwork.
Possible solution would look something like this:

type EmptyNetwork = Partial<ValidNetwork>;

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in src/types/network.d.ts by inspecting the EmptyNetwork and ValidNetwork declarations and how TypeScript infers Network. Update the type relationship so EmptyNetwork no longer causes an any type, then verify that Network has the intended type and the project's TypeScript checks pass.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
networking
Issue type
Bug
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.