PkgFoundry
Catalog npm
Back to packageRELEASE DETAILS

0.5.3

npm

@0xproject/sol-compiler

Solidity compiler wrapper and artifactor

Published9 Jul 2018
Direct dependencies39
Transitive dependenciesNot calculated

README

Current package documentation

@0xproject/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 @0xproject/sol-compiler

API Installation

yarn add @0xproject/sol-compiler

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

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

Import

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

or

var Compiler = require('@0xproject/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=@0xproject/sol-compiler yarn build

Or continuously rebuild on change:

PKG=@0xproject/sol-compiler yarn watch

Clean

yarn clean

Lint

yarn lint

Run Tests

yarn test

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Declared dependencies 39

Native requirements
39 direct targetsNot calculated transitive count
Package / targetRequirementRelationship
@0xproject/json-schemas
Environment
{
  "local_name": "@0xproject/json-schemas",
  "alias": false,
  "peer_metadata": null
}
^0.8.2runtime
@0xproject/sol-resolver
Environment
{
  "local_name": "@0xproject/sol-resolver",
  "alias": false,
  "peer_metadata": null
}
^0.0.8runtime
@0xproject/types
Environment
{
  "local_name": "@0xproject/types",
  "alias": false,
  "peer_metadata": null
}
^0.8.2runtime
@0xproject/typescript-typings
Environment
{
  "local_name": "@0xproject/typescript-typings",
  "alias": false,
  "peer_metadata": null
}
^0.4.2runtime
@0xproject/utils
Environment
{
  "local_name": "@0xproject/utils",
  "alias": false,
  "peer_metadata": null
}
^0.7.2runtime
@0xproject/web3-wrapper
Environment
{
  "local_name": "@0xproject/web3-wrapper",
  "alias": false,
  "peer_metadata": null
}
^0.7.2runtime
@types/yargs
Environment
{
  "local_name": "@types/yargs",
  "alias": false,
  "peer_metadata": null
}
10.0.2runtime
chalk
Environment
{
  "local_name": "chalk",
  "alias": false,
  "peer_metadata": null
}
2.3.2runtime
ethereumjs-util
Environment
{
  "local_name": "ethereumjs-util",
  "alias": false,
  "peer_metadata": null
}
5.1.5runtime
isomorphic-fetch
Environment
{
  "local_name": "isomorphic-fetch",
  "alias": false,
  "peer_metadata": null
}
2.2.1runtime
lodash
Environment
{
  "local_name": "lodash",
  "alias": false,
  "peer_metadata": null
}
4.17.10runtime
mkdirp
Environment
{
  "local_name": "mkdirp",
  "alias": false,
  "peer_metadata": null
}
0.5.1runtime
require-from-string
Environment
{
  "local_name": "require-from-string",
  "alias": false,
  "peer_metadata": null
}
2.0.1runtime
semver
Environment
{
  "local_name": "semver",
  "alias": false,
  "peer_metadata": null
}
5.5.0runtime
solc
Environment
{
  "local_name": "solc",
  "alias": false,
  "peer_metadata": null
}
0.4.23runtime
web3
Environment
{
  "local_name": "web3",
  "alias": false,
  "peer_metadata": null
}
0.20.6runtime
web3-eth-abi
Environment
{
  "local_name": "web3-eth-abi",
  "alias": false,
  "peer_metadata": null
}
1.0.0-beta.33runtime
yargs
Environment
{
  "local_name": "yargs",
  "alias": false,
  "peer_metadata": null
}
11.1.0runtime
@0xproject/dev-utils
Environment
{
  "local_name": "@0xproject/dev-utils",
  "alias": false,
  "peer_metadata": null
}
^0.4.5development
@0xproject/monorepo-scripts
Environment
{
  "local_name": "@0xproject/monorepo-scripts",
  "alias": false,
  "peer_metadata": null
}
^0.2.2development
@0xproject/tslint-config
Environment
{
  "local_name": "@0xproject/tslint-config",
  "alias": false,
  "peer_metadata": null
}
^0.4.21development
@types/mkdirp
Environment
{
  "local_name": "@types/mkdirp",
  "alias": false,
  "peer_metadata": null
}
0.5.2development
@types/require-from-string
Environment
{
  "local_name": "@types/require-from-string",
  "alias": false,
  "peer_metadata": null
}
1.2.0development
@types/semver
Environment
{
  "local_name": "@types/semver",
  "alias": false,
  "peer_metadata": null
}
5.5.0development
chai
Environment
{
  "local_name": "chai",
  "alias": false,
  "peer_metadata": null
}
4.1.2development
chai-as-promised
Environment
{
  "local_name": "chai-as-promised",
  "alias": false,
  "peer_metadata": null
}
7.1.1development
copyfiles
Environment
{
  "local_name": "copyfiles",
  "alias": false,
  "peer_metadata": null
}
1.2.0development
dirty-chai
Environment
{
  "local_name": "dirty-chai",
  "alias": false,
  "peer_metadata": null
}
2.0.1development
make-promises-safe
Environment
{
  "local_name": "make-promises-safe",
  "alias": false,
  "peer_metadata": null
}
1.1.0development
mocha
Environment
{
  "local_name": "mocha",
  "alias": false,
  "peer_metadata": null
}
4.1.0development
npm-run-all
Environment
{
  "local_name": "npm-run-all",
  "alias": false,
  "peer_metadata": null
}
4.1.2development
nyc
Environment
{
  "local_name": "nyc",
  "alias": false,
  "peer_metadata": null
}
11.6.0development
shx
Environment
{
  "local_name": "shx",
  "alias": false,
  "peer_metadata": null
}
0.2.2development
tslint
Environment
{
  "local_name": "tslint",
  "alias": false,
  "peer_metadata": null
}
5.8.0development
typedoc
Environment
{
  "local_name": "typedoc",
  "alias": false,
  "peer_metadata": null
}
0xProject/typedocdevelopment
types-bn
Environment
{
  "local_name": "types-bn",
  "alias": false,
  "peer_metadata": null
}
0.0.1development
typescript
Environment
{
  "local_name": "typescript",
  "alias": false,
  "peer_metadata": null
}
2.7.1development
web3-typescript-typings
Environment
{
  "local_name": "web3-typescript-typings",
  "alias": false,
  "peer_metadata": null
}
0.10.2development
zeppelin-solidity
Environment
{
  "local_name": "zeppelin-solidity",
  "alias": false,
  "peer_metadata": null
}
1.8.0development

Distribution files

1 collected
Distribution 1

Source distribution

Source file
Checksums from source
{
  "shasum": "c2926655fc4b6270ca4a4c864258b0874e2929d8",
  "tarball": "https://registry.npmjs.org/@0xproject/sol-compiler/-/sol-compiler-0.5.3.tgz",
  "fileCount": 47,
  "unpackedSize": 24748272,
  "integrity": "sha512-/aDF6R8rXLZCQGJeo6cLkR3ieySAQpQVQeIFjQBN9ayKGeHLpVNMxtBHZZK7tPJx6ov2q6ELGGd4hoKJV1ENrg==",
  "signatures": [
    {
      "keyid": "SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA",
      "sig": "MEQCIDNWMNv8aSevO32bTS6xS/RlDfjwrRtzin4mjoiksVtQAiB7BMIMQ45ZG7UkOlusguCpst61+0Az1q1s4eKsKDqtaw=="
    }
  ]
}

Repository

PENDING
0xproject/0x-monorepo

Shared repository data · GitHub

License detected in repository
Not collected

Metadata history

Meaningful changes
Current collected state Current

Observed since 21 Oct, 09:33 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package_version:70b233ca05b300a4c8dc19e62dc65d0d7fa4e744aff183bdf31cf9204ce8b99e

Other collected versions

1.1.74 Oct1.1.628 Sept1.1.525 Sept1.1.425 Sept1.1.321 Sept1.1.25 SeptView all collected versions →