使用编译器
使用命令行编译器
Solidity库的构建目标之一是solc,即solidity命令行编译器。 使用solc --help
可以为您提供所有选项的解释。 编译器可以生成各种输出,从简单的二进制文件和通过抽象语法树(解析树)的汇编到气体使用的估计。 如果你只想编译一个文件,你可以运行它作为solc -bin sourceFile.sol
,它将打印二进制文件。 在部署合同之前,请先使用solc --optimize --bin sourceFile.sol
进行编译时激活优化器。 如果要获取一些更高级的solc的输出变量,最好使用solc -o outputDirectory --bin --ast --asm sourceFile.sol
将其输出到单独的文件中。
命令行编译器将自动从文件系统读取导入的文件,但也可以通过以下方式使用prefix = path
提供路径重定向:
solc github.com/ethereum/dapp-bin/=/usr/local/lib/dapp-bin/ =/usr/local/lib/fallback file.sol
这本质上指示编译器搜索任何从/usr/local/lib/dapp-bin
下的github.com/ethereum/dapp-bin/
开始的任何东西,如果没有找到该文件,它将会看/usr/local/lib/fallback
(空前缀总是匹配)。 solc将不会从位于重映射目标之外的文件系统读取文件,而是在显式指定的源文件所在目录之外,因此import "/etc/passwd";
只有在添加=/
作为重映射时才可以工作。
如果重新映射有多个匹配项,则选择具有最长公用前缀的匹配项。
为了安全起见,编译器可以限制可以访问哪些目录。 允许在命令行上指定的源文件的路径(及其子目录)和重新映射定义的路径用于导入语句,但其他所有内容都被拒绝。 额外的路径(及其子目录)可以通--allow-paths /sample/path,/another/sample/path
来实现。
如果您的合约使用库,您会注意到字节码中包含__LibraryName ___
形式的子字符串。 您可以使用solc
作为链接器,这意味着它会在这些点插入库地址:
添加--libraries "Math:0x12345678901234567890 Heap:0xabcdef0123456"
命令为每个库提供一个地址或将该字符串存储在一个文件(每行一个库)中,并使用--libraries fileName
运行solc
。
如果使用选项--link
调用solc
,所有输入文件将被解释为上面给出的__LibraryName ____
格式中的未链接二进制文件(十六进制编码),并且是原位置的(如果输入是从stdin读取的,则写入 到stdout)。 在这种情况下,除了--libraries
之外的所有选项都将被忽略(包括-o)。
如果使用--standard-json
选项调用solc
,则会在标准输入上输入JSON输入(如下所述),并在标准输出上返回一个JSON输出。
编译器输入和输出JSON描述
这些JSON格式由编译器API使用,也可以通过solc获得。 这些都可以更改,一些字段是可选的(如所指出),但其目的仅在于向后兼容的更改。
编译器API期望使用JSON格式的输入,并以JSON格式输出输出编译结果。
输入说明
{
// 必须: 源代码用的语言, such as "Solidity", "serpent", "lll", "assembly", etc.
language: "Solidity",
// 必须
sources:
{
// The keys here are the "global" names of the source files,
// imports can use other files via remappings (see below).
"myFile.sol":
{
// Optional: keccak256 hash of the source file
// It is used to verify the retrieved content if imported via URLs.
"keccak256": "0x123...",
// Required (unless "content" is used, see below): URL(s) to the source file.
// URL(s) should be imported in this order and the result checked against the
// keccak256 hash (if available). If the hash doesn't match or none of the
// URL(s) result in success, an error should be raised.
"urls":
[
"bzzr://56ab...",
"ipfs://Qma...",
"file:///tmp/path/to/file.sol"
]
},
"mortal":
{
// Optional: keccak256 hash of the source file
"keccak256": "0x234...",
// Required (unless "urls" is used): literal contents of the source file
"content": "contract mortal is owned { function kill() { if (msg.sender == owner) selfdestruct(owner); } }"
}
},
// Optional
settings:
{
// Optional: Sorted list of remappings
remappings: [ ":g/dir" ],
// Optional: Optimizer settings (enabled defaults to false)
optimizer: {
enabled: true,
runs: 500
},
// Metadata settings (optional)
metadata: {
// Use only literal content and not URLs (false by default)
useLiteralContent: true
},
// Addresses of the libraries. If not all libraries are given here, it can result in unlinked objects whose output data is different.
libraries: {
// The top level key is the the name of the source file where the library is used.
// If remappings are used, this source file should match the global path after remappings were applied.
// If this key is an empty string, that refers to a global level.
"myFile.sol": {
"MyLib": "0x123123..."
}
}
// The following can be used to select desired outputs.
// If this field is omitted, then the compiler loads and does type checking, but will not generate any outputs apart from errors.
// The first level key is the file name and the second is the contract name, where empty contract name refers to the file itself,
// while the star refers to all of the contracts.
//
// The available output types are as follows:
// abi - ABI
// ast - AST of all source files
// legacyAST - legacy AST of all source files
// devdoc - Developer documentation (natspec)
// userdoc - User documentation (natspec)
// metadata - Metadata
// ir - New assembly format before desugaring
// evm.assembly - New assembly format after desugaring
// evm.legacyAssembly - Old-style assembly format in JSON
// evm.bytecode.object - Bytecode object
// evm.bytecode.opcodes - Opcodes list
// evm.bytecode.sourceMap - Source mapping (useful for debugging)
// evm.bytecode.linkReferences - Link references (if unlinked object)
// evm.deployedBytecode* - Deployed bytecode (has the same options as evm.bytecode)
// evm.methodIdentifiers - The list of function hashes
// evm.gasEstimates - Function gas estimates
// ewasm.wast - eWASM S-expressions format (not supported atm)
// ewasm.wasm - eWASM binary format (not supported atm)
//
// Note that using a using `evm`, `evm.bytecode`, `ewasm`, etc. will select every
// target part of that output.
//
outputSelection: {
// Enable the metadata and bytecode outputs of every single contract.
"*": {
"*": [ "metadata", "evm.bytecode" ]
},
// Enable the abi and opcodes output of MyContract defined in file def.
"def": {
"MyContract": [ "abi", "evm.opcodes" ]
},
// Enable the source map output of every single contract.
"*": {
"*": [ "evm.sourceMap" ]
},
// Enable the legacy AST output of every single file.
"*": {
"": [ "legacyAST" ]
}
}
}
}
输出描述
{
// Optional: not present if no errors/warnings were encountered
errors: [
{
// Optional: Location within the source file.
sourceLocation: {
file: "sourceFile.sol",
start: 0,
end: 100
],
// Mandatory: Error type, such as "TypeError", "InternalCompilerError", "Exception", etc
type: "TypeError",
// Mandatory: Component where the error originated, such as "general", "ewasm", etc.
component: "general",
// Mandatory ("error" or "warning")
severity: "error",
// Mandatory
message: "Invalid keyword"
// Optional: the message formatted with source location
formattedMessage: "sourceFile.sol:100: Invalid keyword"
}
],
// This contains the file-level outputs. In can be limited/filtered by the outputSelection settings.
sources: {
"sourceFile.sol": {
// Identifier (used in source maps)
id: 1,
// The AST object
ast: {},
// The legacy AST object
legacyAST: {}
}
},
// This contains the contract-level outputs. It can be limited/filtered by the outputSelection settings.
contracts: {
"sourceFile.sol": {
// If the language used has no contract names, this field should equal to an empty string.
"ContractName": {
// The Ethereum Contract ABI. If empty, it is represented as an empty array.
// See https://github.com/ethereum/wiki/wiki/Ethereum-Contract-ABI
abi: [],
// See the Metadata Output documentation (serialised JSON string)
metadata: "{...}",
// User documentation (natspec)
userdoc: {},
// Developer documentation (natspec)
devdoc: {},
// Intermediate representation (string)
ir: "",
// EVM-related outputs
evm: {
// Assembly (string)
assembly: "",
// Old-style assembly (object)
legacyAssembly: {},
// Bytecode and related details.
bytecode: {
// The bytecode as a hex string.
object: "00fe",
// Opcodes list (string)
opcodes: "",
// The source mapping as a string. See the source mapping definition.
sourceMap: "",
// If given, this is an unlinked object.
linkReferences: {
"libraryFile.sol": {
// Byte offsets into the bytecode. Linking replaces the 20 bytes located there.
"Library1": [
{ start: 0, length: 20 },
{ start: 200, length: 20 }
]
}
}
},
// The same layout as above.
deployedBytecode: { },
// The list of function hashes
methodIdentifiers: {
"delegate(address)": "5c19a95c"
},
// Function gas estimates
gasEstimates: {
creation: {
codeDepositCost: "420000",
executionCost: "infinite",
totalCost: "infinite"
},
external: {
"delegate(address)": "25000"
},
internal: {
"heavyLifting()": "infinite"
}
}
},
// eWASM related outputs
ewasm: {
// S-expressions format
wast: "",
// Binary format (hex string)
wasm: ""
}
}
}
}
}