2015-07-06 17:54:22 -07:00
|
|
|
// Copyright 2015 The go-ethereum Authors
|
2015-07-22 09:48:40 -07:00
|
|
|
// This file is part of the go-ethereum library.
|
2015-07-06 17:54:22 -07:00
|
|
|
//
|
2015-07-23 09:35:11 -07:00
|
|
|
// The go-ethereum library is free software: you can redistribute it and/or modify
|
2015-07-06 17:54:22 -07:00
|
|
|
// it under the terms of the GNU Lesser General Public License as published by
|
|
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
|
|
// (at your option) any later version.
|
|
|
|
//
|
2015-07-22 09:48:40 -07:00
|
|
|
// The go-ethereum library is distributed in the hope that it will be useful,
|
2015-07-06 17:54:22 -07:00
|
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
2015-07-22 09:48:40 -07:00
|
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
2015-07-06 17:54:22 -07:00
|
|
|
// GNU Lesser General Public License for more details.
|
|
|
|
//
|
|
|
|
// You should have received a copy of the GNU Lesser General Public License
|
2015-07-22 09:48:40 -07:00
|
|
|
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
|
2015-07-06 17:54:22 -07:00
|
|
|
|
2016-06-14 15:36:31 -07:00
|
|
|
// Package compiler wraps the Solidity compiler executable (solc).
|
2015-04-22 15:11:11 -07:00
|
|
|
package compiler
|
|
|
|
|
|
|
|
import (
|
|
|
|
"bytes"
|
|
|
|
"encoding/json"
|
2015-08-25 09:42:05 -07:00
|
|
|
"errors"
|
2015-04-22 15:11:11 -07:00
|
|
|
"fmt"
|
|
|
|
"io/ioutil"
|
|
|
|
"os/exec"
|
|
|
|
"regexp"
|
|
|
|
"strings"
|
|
|
|
|
|
|
|
"github.com/ethereum/go-ethereum/common"
|
|
|
|
"github.com/ethereum/go-ethereum/crypto"
|
|
|
|
)
|
|
|
|
|
|
|
|
var (
|
2015-09-14 15:35:22 -07:00
|
|
|
versionRegexp = regexp.MustCompile("[0-9]+\\.[0-9]+\\.[0-9]+")
|
2016-06-14 15:36:31 -07:00
|
|
|
solcParams = []string{
|
|
|
|
"--combined-json", "bin,abi,userdoc,devdoc",
|
2015-09-14 15:35:22 -07:00
|
|
|
"--add-std", // include standard lib contracts
|
|
|
|
"--optimize", // code optimizer switched on
|
2015-09-10 05:12:41 -07:00
|
|
|
}
|
2015-04-22 15:11:11 -07:00
|
|
|
)
|
|
|
|
|
|
|
|
type Contract struct {
|
|
|
|
Code string `json:"code"`
|
|
|
|
Info ContractInfo `json:"info"`
|
|
|
|
}
|
|
|
|
|
|
|
|
type ContractInfo struct {
|
|
|
|
Source string `json:"source"`
|
|
|
|
Language string `json:"language"`
|
|
|
|
LanguageVersion string `json:"languageVersion"`
|
|
|
|
CompilerVersion string `json:"compilerVersion"`
|
2015-09-10 05:12:41 -07:00
|
|
|
CompilerOptions string `json:"compilerOptions"`
|
2015-04-22 15:11:11 -07:00
|
|
|
AbiDefinition interface{} `json:"abiDefinition"`
|
|
|
|
UserDoc interface{} `json:"userDoc"`
|
|
|
|
DeveloperDoc interface{} `json:"developerDoc"`
|
|
|
|
}
|
|
|
|
|
2016-06-14 15:36:31 -07:00
|
|
|
// Solidity contains information about the solidity compiler.
|
2015-04-22 15:11:11 -07:00
|
|
|
type Solidity struct {
|
2016-06-14 15:36:31 -07:00
|
|
|
Path, Version, FullVersion string
|
2015-04-22 15:11:11 -07:00
|
|
|
}
|
|
|
|
|
2016-06-14 15:36:31 -07:00
|
|
|
// --combined-output format
|
|
|
|
type solcOutput struct {
|
|
|
|
Contracts map[string]struct{ Bin, Abi, Devdoc, Userdoc string }
|
|
|
|
Version string
|
|
|
|
}
|
2015-04-22 15:11:11 -07:00
|
|
|
|
2016-06-14 15:36:31 -07:00
|
|
|
// SolidityVersion runs solc and parses its version output.
|
|
|
|
func SolidityVersion(solc string) (*Solidity, error) {
|
|
|
|
if solc == "" {
|
|
|
|
solc = "solc"
|
|
|
|
}
|
2015-04-22 15:11:11 -07:00
|
|
|
var out bytes.Buffer
|
2016-06-14 15:36:31 -07:00
|
|
|
cmd := exec.Command(solc, "--version")
|
2015-04-22 15:11:11 -07:00
|
|
|
cmd.Stdout = &out
|
2016-06-14 15:36:31 -07:00
|
|
|
if err := cmd.Run(); err != nil {
|
|
|
|
return nil, err
|
2015-04-22 15:11:11 -07:00
|
|
|
}
|
2016-06-14 15:36:31 -07:00
|
|
|
s := &Solidity{
|
|
|
|
Path: cmd.Path,
|
|
|
|
FullVersion: out.String(),
|
|
|
|
Version: versionRegexp.FindString(out.String()),
|
2015-04-22 15:11:11 -07:00
|
|
|
}
|
2016-06-14 15:36:31 -07:00
|
|
|
return s, nil
|
2015-05-10 04:46:38 -07:00
|
|
|
}
|
|
|
|
|
2016-06-14 15:36:31 -07:00
|
|
|
// CompileSolidityString builds and returns all the contracts contained within a source string.
|
|
|
|
func CompileSolidityString(solc, source string) (map[string]*Contract, error) {
|
2015-04-22 15:11:11 -07:00
|
|
|
if len(source) == 0 {
|
2015-08-25 09:42:05 -07:00
|
|
|
return nil, errors.New("solc: empty source string")
|
2015-04-22 15:11:11 -07:00
|
|
|
}
|
2016-06-14 15:36:31 -07:00
|
|
|
if solc == "" {
|
|
|
|
solc = "solc"
|
|
|
|
}
|
2017-01-06 06:39:35 -08:00
|
|
|
args := append(solcParams, "--")
|
|
|
|
cmd := exec.Command(solc, append(args, "-")...)
|
|
|
|
cmd.Stdin = strings.NewReader(source)
|
|
|
|
return runsolc(cmd, source)
|
2016-06-14 15:36:31 -07:00
|
|
|
}
|
2015-08-25 09:42:05 -07:00
|
|
|
|
2016-06-14 15:36:31 -07:00
|
|
|
// CompileSolidity compiles all given Solidity source files.
|
|
|
|
func CompileSolidity(solc string, sourcefiles ...string) (map[string]*Contract, error) {
|
|
|
|
if len(sourcefiles) == 0 {
|
2017-01-06 06:39:35 -08:00
|
|
|
return nil, errors.New("solc: no source files")
|
2016-06-14 15:36:31 -07:00
|
|
|
}
|
|
|
|
source, err := slurpFiles(sourcefiles)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
if solc == "" {
|
|
|
|
solc = "solc"
|
2015-09-10 05:12:41 -07:00
|
|
|
}
|
2016-06-14 15:36:31 -07:00
|
|
|
args := append(solcParams, "--")
|
|
|
|
cmd := exec.Command(solc, append(args, sourcefiles...)...)
|
2017-01-06 06:39:35 -08:00
|
|
|
return runsolc(cmd, source)
|
|
|
|
}
|
|
|
|
|
|
|
|
func runsolc(cmd *exec.Cmd, source string) (map[string]*Contract, error) {
|
|
|
|
var stderr, stdout bytes.Buffer
|
2016-06-14 15:36:31 -07:00
|
|
|
cmd.Stderr = &stderr
|
|
|
|
cmd.Stdout = &stdout
|
2015-08-25 09:42:05 -07:00
|
|
|
if err := cmd.Run(); err != nil {
|
2016-06-14 15:36:31 -07:00
|
|
|
return nil, fmt.Errorf("solc: %v\n%s", err, stderr.Bytes())
|
2015-08-25 09:42:05 -07:00
|
|
|
}
|
2016-06-14 15:36:31 -07:00
|
|
|
var output solcOutput
|
|
|
|
if err := json.Unmarshal(stdout.Bytes(), &output); err != nil {
|
|
|
|
return nil, err
|
2015-04-22 15:11:11 -07:00
|
|
|
}
|
2016-06-14 15:36:31 -07:00
|
|
|
shortVersion := versionRegexp.FindString(output.Version)
|
2015-05-19 20:11:48 -07:00
|
|
|
|
2016-06-14 15:36:31 -07:00
|
|
|
// Compilation succeeded, assemble and return the contracts.
|
|
|
|
contracts := make(map[string]*Contract)
|
|
|
|
for name, info := range output.Contracts {
|
|
|
|
// Parse the individual compilation results.
|
2015-08-25 09:42:05 -07:00
|
|
|
var abi interface{}
|
2016-06-14 15:36:31 -07:00
|
|
|
if err := json.Unmarshal([]byte(info.Abi), &abi); err != nil {
|
|
|
|
return nil, fmt.Errorf("solc: error reading abi definition (%v)", err)
|
2015-05-19 20:11:48 -07:00
|
|
|
}
|
2015-08-25 09:42:05 -07:00
|
|
|
var userdoc interface{}
|
2016-06-14 15:36:31 -07:00
|
|
|
if err := json.Unmarshal([]byte(info.Userdoc), &userdoc); err != nil {
|
2015-08-25 09:42:05 -07:00
|
|
|
return nil, fmt.Errorf("solc: error reading user doc: %v", err)
|
2015-05-19 20:11:48 -07:00
|
|
|
}
|
2015-08-25 09:42:05 -07:00
|
|
|
var devdoc interface{}
|
2016-06-14 15:36:31 -07:00
|
|
|
if err := json.Unmarshal([]byte(info.Devdoc), &devdoc); err != nil {
|
2015-08-25 09:42:05 -07:00
|
|
|
return nil, fmt.Errorf("solc: error reading dev doc: %v", err)
|
|
|
|
}
|
2016-06-14 15:36:31 -07:00
|
|
|
contracts[name] = &Contract{
|
|
|
|
Code: "0x" + info.Bin,
|
2015-05-19 20:11:48 -07:00
|
|
|
Info: ContractInfo{
|
|
|
|
Source: source,
|
|
|
|
Language: "Solidity",
|
2016-06-14 15:36:31 -07:00
|
|
|
LanguageVersion: shortVersion,
|
|
|
|
CompilerVersion: shortVersion,
|
|
|
|
CompilerOptions: strings.Join(solcParams, " "),
|
2015-08-25 09:42:05 -07:00
|
|
|
AbiDefinition: abi,
|
|
|
|
UserDoc: userdoc,
|
|
|
|
DeveloperDoc: devdoc,
|
2015-05-19 20:11:48 -07:00
|
|
|
},
|
|
|
|
}
|
2015-04-22 15:11:11 -07:00
|
|
|
}
|
2015-08-25 09:42:05 -07:00
|
|
|
return contracts, nil
|
2015-04-22 15:11:11 -07:00
|
|
|
}
|
|
|
|
|
2016-06-14 15:36:31 -07:00
|
|
|
func slurpFiles(files []string) (string, error) {
|
|
|
|
var concat bytes.Buffer
|
|
|
|
for _, file := range files {
|
|
|
|
content, err := ioutil.ReadFile(file)
|
|
|
|
if err != nil {
|
|
|
|
return "", err
|
|
|
|
}
|
|
|
|
concat.Write(content)
|
|
|
|
}
|
|
|
|
return concat.String(), nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// SaveInfo serializes info to the given file and returns its Keccak256 hash.
|
|
|
|
func SaveInfo(info *ContractInfo, filename string) (common.Hash, error) {
|
2015-06-23 07:48:33 -07:00
|
|
|
infojson, err := json.Marshal(info)
|
2015-04-22 15:11:11 -07:00
|
|
|
if err != nil {
|
2016-06-14 15:36:31 -07:00
|
|
|
return common.Hash{}, err
|
2015-04-22 15:11:11 -07:00
|
|
|
}
|
2016-06-14 15:36:31 -07:00
|
|
|
contenthash := common.BytesToHash(crypto.Keccak256(infojson))
|
|
|
|
return contenthash, ioutil.WriteFile(filename, infojson, 0600)
|
2015-04-22 15:11:11 -07:00
|
|
|
}
|