View @0x/sol-compiler on Snyk Open Source Advisor

Package Health Score

58 / 100

security
Security review needed
popularity
Limited
maintenance
Inactive
community
Active

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
4.8.5	\|	04/2023	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
4.7.9	\|	02/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.1.15	\|	09/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.0.2	\|	01/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.1.16	\|	12/2018		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

Apache-2.0

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (949)

GitHub Stars: 97
Forks: 63
Contributors: 90

Direct Usage Popularity

The npm package @0x/sol-compiler receives a total of 949 downloads a week. As such, we scored @0x/sol-compiler popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package @0x/sol-compiler, we found that it has been starred 97 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 90
Funding: No

With more than 10 contributors for the @0x/sol-compiler repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

Open Issues: 2
Open PR: 8
Last Release: 2 years ago
Last Commit: 25 days ago

Further analysis of the maintenance status of @0x/sol-compiler based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for @0x/sol-compiler is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=6.12

Age: 6 years
Dependencies: 23 Direct
Versions: 88
Install Size: 173 kB
Dist-tags: 2
# of Files: 70
Maintainers: 9
TS Typings: Yes

@0x/sol-compiler has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Not sure how to use @0x/sol-compiler?

To help you get started, we've collected the most common ways that @0x/sol-compiler is being used within popular public projects.

0xProject / 0x-monorepo / packages / sol-meta / src / solc_wrapper.ts View on Github

export const compile = async (sources: SourceCollection, ast: S.SourceUnit) => {
    // Extract required version from pragma of ast
    const version =
        _.map(utils.pragmaNodes(ast).filter(({ name }) => name === 'solidity'), ({ value }) => value)[0] || 'latest';

    // Get Solidity compiler
    const compiler = await Solc.getSolcAsync(version);

    // Solidity standard JSON input
    // TODO: Typescript typings
    // See: https://solidity.readthedocs.io/en/develop/using-the-compiler.html#compiler-input-and-output-json-description
    const input = {
        language: 'Solidity',
        sources: {
            ...utils.objectMap(sources, ({ source: content }) => ({ content })),
            TARGET_: { content: unparse(ast) },
        },
        settings: {
            remappings: {
                // TODO
            },
        },
        outputSelection: {

View more ways to use @0x/sol-compiler

@0x/sol-compiler

Sol-compiler is a wrapper around solc-js that adds:

Smart re-compilation: Only recompiles when smart contracts have changed
Ability to compile an entire project instead of only individual .sol files
Compilation using the Solidity version specified at the top of each individual .sol file
Proper parsing of Solidity version ranges
Support for the standard input description for what information you'd like added to the resulting artifacts file (i.e 100% configurable artifacts content).

Read the Documentation.

Installation

CLI Installation

yarn global add @0x/sol-compiler

API Installation

yarn add @0x/sol-compiler

If your project is in TypeScript, add the following to your tsconfig.json:

"compilerOptions": {
    "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"],
}

Import

import { Compiler } from '@0x/sol-compiler';

var Compiler = require('@0x/sol-compiler').Compiler;

Contributing

We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository.

Please read our contribution guidelines before getting started.

Install dependencies

If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:

yarn config set workspaces-experimental true

Then install dependencies

yarn install

Build

To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:

PKG=@0x/sol-compiler yarn build

Or continuously rebuild on change:

PKG=@0x/sol-compiler yarn watch

Clean

yarn clean

Lint

yarn lint

Run Tests

yarn test

FAQs

What is @0x/sol-compiler?

Solidity compiler wrapper and artifactor. Visit Snyk Advisor to see a full health score report for @0x/sol-compiler, including popularity, security, maintenance & community analysis.

Is @0x/sol-compiler popular?

The npm package @0x/sol-compiler receives a total of 949 weekly downloads. As such, @0x/sol-compiler popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @0x/sol-compiler well maintained?

We found indications that @0x/sol-compiler is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is @0x/sol-compiler safe to use?

While scanning the latest version of @0x/sol-compiler, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 4 November-2024, at 10:47 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP