argotorg / argotorg/solc-js

Change compile to take in a JS object rather than a string.

Open
#358 0 comments 0 reactions 0 assignees View on GitHub
refactor
Dominant language
TypeScript
Stars
1.5k
Forks
349
Avg merge
8m
Merged PRs (30d)
1

Description

The `compile` function takes in a string, when really it wants a well described JS object. In JS, this isn't much of a difference but when using something like TypeScript or Flow the difference is pretty significant as one gives you compile-time errors/warnings and auto-complete while the other (string input) gives you nothing useful.

An initial pass at the TS definitions can be found at https://github.com/MicahZoltu/solc-js/blob/ts-definitions/index.d.ts and discussion can be found at #205.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the TypeScript definitions in index.d.ts and read the discussion in #205, then trace the compile API described in the issue. The change is complete when compile uses a well-described JavaScript object input and the TypeScript definitions provide useful type checking and autocomplete.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, typescript
Domain
compilers, devtools
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.