ergoplatform/ergo

Wrap primitive types in communication between API and the core

Open

#1,005 opened on Dec 18, 2019

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Scala (201 forks)github user discovery
A-apiB-100 Ergbountyhelp wanted

Repository metrics

Stars
 (519 stars)
PR merge metrics
 (Avg merge 12d 5h) (13 merged PRs in 30d)

Description

Currently in many places core is responding with primitive Scala types to requests from API method implementations.

One concrete example is InitWallet / RestoreWallet.

It would be more descriptive to use logic-related types by using (case class) wrappers or type aliases.

Contributor guide

Research direction
Identify all core methods that return primitive types to the API and replace them with descriptive case classes or type aliases.
Tech stack
scala
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Scala
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75