@0x/sol-compiler 中文文档教程

Question

@0x/sol-compiler

Sol-compiler 是 solc-js 的包装器，它添加了：

• 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

如果您的项目位于 TypeScript，将以下内容添加到您的 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

我们欢迎来自更广泛社区的改进和修复！ 要报告此包中的错误，请在此存储库中创建一个问题。

请在开始之前阅读我们的贡献指南。

Install dependencies

如果您没有启用 yarn workspaces (Yarn < v1.0) - 启用它们：

yarn config set workspaces-experimental true

然后安装依赖

yarn install

Build

项 要构建此包和它所依赖的所有其他 monorepo 包，请从 monorepo 根目录运行以下命令：

PKG=@0x/sol-compiler yarn build

或持续重建关于改变：

PKG=@0x/sol-compiler yarn watch

Clean

yarn clean

Lint

yarn lint

Run Tests

yarn test