solidity.go 5.7 KB
Newer Older
1
// Copyright 2015 The go-ethereum Authors
2
// This file is part of the go-ethereum library.
3
//
4
// The go-ethereum library is free software: you can redistribute it and/or modify
5 6 7 8
// 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.
//
9
// The go-ethereum library is distributed in the hope that it will be useful,
10
// but WITHOUT ANY WARRANTY; without even the implied warranty of
11
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 13 14
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
15
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
16

17
// Package compiler wraps the Solidity and Vyper compiler executables (solc; vyper).
18 19 20 21 22
package compiler

import (
	"bytes"
	"encoding/json"
23
	"errors"
24 25
	"fmt"
	"os/exec"
26
	"strconv"
27 28 29
	"strings"
)

30
// Solidity contains information about the solidity compiler.
31
type Solidity struct {
32
	Path, Version, FullVersion string
33
	Major, Minor, Patch        int
34 35
}

36 37
// --combined-output format
type solcOutput struct {
38
	Contracts map[string]struct {
39 40 41
		BinRuntime                                  string `json:"bin-runtime"`
		SrcMapRuntime                               string `json:"srcmap-runtime"`
		Bin, SrcMap, Abi, Devdoc, Userdoc, Metadata string
42
		Hashes                                      map[string]string
43 44 45 46 47 48
	}
	Version string
}

func (s *Solidity) makeArgs() []string {
	p := []string{
49
		"--combined-json", "bin,bin-runtime,srcmap,srcmap-runtime,abi,userdoc,devdoc",
50 51
		"--optimize",                  // code optimizer switched on
		"--allow-paths", "., ./, ../", // default to support relative paths
52 53
	}
	if s.Major > 0 || s.Minor > 4 || s.Patch > 6 {
54
		p[1] += ",metadata,hashes"
55 56
	}
	return p
57
}
58

59 60 61 62 63
// SolidityVersion runs solc and parses its version output.
func SolidityVersion(solc string) (*Solidity, error) {
	if solc == "" {
		solc = "solc"
	}
64
	var out bytes.Buffer
65
	cmd := exec.Command(solc, "--version")
66
	cmd.Stdout = &out
67 68 69 70 71 72 73 74 75 76
	err := cmd.Run()
	if err != nil {
		return nil, err
	}
	matches := versionRegexp.FindStringSubmatch(out.String())
	if len(matches) != 4 {
		return nil, fmt.Errorf("can't parse solc version %q", out.String())
	}
	s := &Solidity{Path: cmd.Path, FullVersion: out.String(), Version: matches[0]}
	if s.Major, err = strconv.Atoi(matches[1]); err != nil {
77
		return nil, err
78
	}
79 80 81 82 83
	if s.Minor, err = strconv.Atoi(matches[2]); err != nil {
		return nil, err
	}
	if s.Patch, err = strconv.Atoi(matches[3]); err != nil {
		return nil, err
84
	}
85
	return s, nil
86 87
}

88 89
// CompileSolidityString builds and returns all the contracts contained within a source string.
func CompileSolidityString(solc, source string) (map[string]*Contract, error) {
90
	if len(source) == 0 {
91
		return nil, errors.New("solc: empty source string")
92
	}
93 94 95
	s, err := SolidityVersion(solc)
	if err != nil {
		return nil, err
96
	}
97 98
	args := append(s.makeArgs(), "--")
	cmd := exec.Command(s.Path, append(args, "-")...)
99
	cmd.Stdin = strings.NewReader(source)
100
	return s.run(cmd, source)
101
}
102

103 104 105
// CompileSolidity compiles all given Solidity source files.
func CompileSolidity(solc string, sourcefiles ...string) (map[string]*Contract, error) {
	if len(sourcefiles) == 0 {
106
		return nil, errors.New("solc: no source files")
107 108 109 110 111
	}
	source, err := slurpFiles(sourcefiles)
	if err != nil {
		return nil, err
	}
112 113 114
	s, err := SolidityVersion(solc)
	if err != nil {
		return nil, err
115
	}
116 117 118
	args := append(s.makeArgs(), "--")
	cmd := exec.Command(s.Path, append(args, sourcefiles...)...)
	return s.run(cmd, source)
119 120
}

121
func (s *Solidity) run(cmd *exec.Cmd, source string) (map[string]*Contract, error) {
122
	var stderr, stdout bytes.Buffer
123 124
	cmd.Stderr = &stderr
	cmd.Stdout = &stdout
125
	if err := cmd.Run(); err != nil {
126
		return nil, fmt.Errorf("solc: %v\n%s", err, stderr.Bytes())
127
	}
128 129 130 131 132 133 134 135 136

	return ParseCombinedJSON(stdout.Bytes(), source, s.Version, s.Version, strings.Join(s.makeArgs(), " "))
}

// ParseCombinedJSON takes the direct output of a solc --combined-output run and
// parses it into a map of string contract name to Contract structs. The
// provided source, language and compiler version, and compiler options are all
// passed through into the Contract structs.
//
137
// The solc output is expected to contain ABI, source mapping, user docs, and dev docs.
138 139 140 141
//
// Returns an error if the JSON is malformed or missing data, or if the JSON
// embedded within the JSON is malformed.
func ParseCombinedJSON(combinedJSON []byte, source string, languageVersion string, compilerVersion string, compilerOptions string) (map[string]*Contract, error) {
142
	var output solcOutput
143
	if err := json.Unmarshal(combinedJSON, &output); err != nil {
144
		return nil, err
145
	}
146 147 148 149
	// Compilation succeeded, assemble and return the contracts.
	contracts := make(map[string]*Contract)
	for name, info := range output.Contracts {
		// Parse the individual compilation results.
150
		var abi interface{}
151 152
		if err := json.Unmarshal([]byte(info.Abi), &abi); err != nil {
			return nil, fmt.Errorf("solc: error reading abi definition (%v)", err)
153
		}
154 155 156 157
		var userdoc, devdoc interface{}
		json.Unmarshal([]byte(info.Userdoc), &userdoc)
		json.Unmarshal([]byte(info.Devdoc), &devdoc)

158
		contracts[name] = &Contract{
159 160
			Code:        "0x" + info.Bin,
			RuntimeCode: "0x" + info.BinRuntime,
161
			Hashes:      info.Hashes,
162 163 164
			Info: ContractInfo{
				Source:          source,
				Language:        "Solidity",
165 166 167
				LanguageVersion: languageVersion,
				CompilerVersion: compilerVersion,
				CompilerOptions: compilerOptions,
168 169
				SrcMap:          info.SrcMap,
				SrcMapRuntime:   info.SrcMapRuntime,
170 171 172
				AbiDefinition:   abi,
				UserDoc:         userdoc,
				DeveloperDoc:    devdoc,
173
				Metadata:        info.Metadata,
174 175
			},
		}
176
	}
177
	return contracts, nil
178
}