livepeer / livepeer/protocol

Convert the javascript code to typescript

Open
#569 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
155
Forks
50
PR merge metrics
No merged PRs in 30d

Description

**Context**
A lot of the protocol tests are implemented in javascript, which is very error-prone - especially when it comes to its lack of type safety.

**Proposal**
I think that moving from javascript to typescript might be worth the effort. The priority, however, should be not to break any of the existing logic/tests. One way we could gradually tackle the javascript<>typescript refactoring might be related to https://github.com/livepeer/protocol/issues/568, whereby we could start writing the shared behaviors of the tests in typescript right away and then 'plug them in' the existing test suites & replace the javascript parts

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 by reviewing the protocol tests and the approach proposed in issue 568 for shared behaviors. Identify which JavaScript test suites can adopt shared TypeScript behaviors first, then verify that existing logic and tests continue to pass after each migration step.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, typescript
Domain
testing-qa
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.