123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224 |
- // Copyright 2015 The go-ethereum Authors
- // This file is part of the go-ethereum library.
- //
- // The go-ethereum library is free software: you can redistribute it and/or modify
- // 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.
- //
- // The go-ethereum library is distributed in the hope that it will be useful,
- // but WITHOUT ANY WARRANTY; without even the implied warranty of
- // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- // GNU Lesser General Public License for more details.
- //
- // You should have received a copy of the GNU Lesser General Public License
- // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
- // Package compiler wraps the Solidity and Vyper compiler executables (solc; vyper).
- package compiler
- import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "os/exec"
- "strconv"
- "strings"
- )
- // Solidity contains information about the solidity compiler.
- type Solidity struct {
- Path, Version, FullVersion string
- Major, Minor, Patch int
- }
- // --combined-output format
- type solcOutput struct {
- Contracts map[string]struct {
- BinRuntime string `json:"bin-runtime"`
- SrcMapRuntime string `json:"srcmap-runtime"`
- Bin, SrcMap, Abi, Devdoc, Userdoc, Metadata string
- Hashes map[string]string
- }
- Version string
- }
- // solidity v.0.8 changes the way ABI, Devdoc and Userdoc are serialized
- type solcOutputV8 struct {
- Contracts map[string]struct {
- BinRuntime string `json:"bin-runtime"`
- SrcMapRuntime string `json:"srcmap-runtime"`
- Bin, SrcMap, Metadata string
- Abi interface{}
- Devdoc interface{}
- Userdoc interface{}
- Hashes map[string]string
- }
- Version string
- }
- func (s *Solidity) makeArgs() []string {
- p := []string{
- "--combined-json", "bin,bin-runtime,srcmap,srcmap-runtime,abi,userdoc,devdoc",
- "--optimize", // code optimizer switched on
- "--allow-paths", "., ./, ../", // default to support relative paths
- }
- if s.Major > 0 || s.Minor > 4 || s.Patch > 6 {
- p[1] += ",metadata,hashes"
- }
- return p
- }
- // SolidityVersion runs solc and parses its version output.
- func SolidityVersion(solc string) (*Solidity, error) {
- if solc == "" {
- solc = "solc"
- }
- var out bytes.Buffer
- cmd := exec.Command(solc, "--version")
- cmd.Stdout = &out
- 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 {
- return nil, err
- }
- 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
- }
- return s, nil
- }
- // CompileSolidityString builds and returns all the contracts contained within a source string.
- func CompileSolidityString(solc, source string) (map[string]*Contract, error) {
- if len(source) == 0 {
- return nil, errors.New("solc: empty source string")
- }
- s, err := SolidityVersion(solc)
- if err != nil {
- return nil, err
- }
- args := append(s.makeArgs(), "--")
- cmd := exec.Command(s.Path, append(args, "-")...)
- cmd.Stdin = strings.NewReader(source)
- return s.run(cmd, source)
- }
- // CompileSolidity compiles all given Solidity source files.
- func CompileSolidity(solc string, sourcefiles ...string) (map[string]*Contract, error) {
- if len(sourcefiles) == 0 {
- return nil, errors.New("solc: no source files")
- }
- source, err := slurpFiles(sourcefiles)
- if err != nil {
- return nil, err
- }
- s, err := SolidityVersion(solc)
- if err != nil {
- return nil, err
- }
- args := append(s.makeArgs(), "--")
- cmd := exec.Command(s.Path, append(args, sourcefiles...)...)
- return s.run(cmd, source)
- }
- func (s *Solidity) run(cmd *exec.Cmd, source string) (map[string]*Contract, error) {
- var stderr, stdout bytes.Buffer
- cmd.Stderr = &stderr
- cmd.Stdout = &stdout
- if err := cmd.Run(); err != nil {
- return nil, fmt.Errorf("solc: %v\n%s", err, stderr.Bytes())
- }
- 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.
- //
- // The solc output is expected to contain ABI, source mapping, user docs, and dev docs.
- //
- // 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) {
- var output solcOutput
- if err := json.Unmarshal(combinedJSON, &output); err != nil {
- // Try to parse the output with the new solidity v.0.8.0 rules
- return parseCombinedJSONV8(combinedJSON, source, languageVersion, compilerVersion, compilerOptions)
- }
- // Compilation succeeded, assemble and return the contracts.
- contracts := make(map[string]*Contract)
- for name, info := range output.Contracts {
- // Parse the individual compilation results.
- var abi interface{}
- if err := json.Unmarshal([]byte(info.Abi), &abi); err != nil {
- return nil, fmt.Errorf("solc: error reading abi definition (%v)", err)
- }
- var userdoc, devdoc interface{}
- json.Unmarshal([]byte(info.Userdoc), &userdoc)
- json.Unmarshal([]byte(info.Devdoc), &devdoc)
- contracts[name] = &Contract{
- Code: "0x" + info.Bin,
- RuntimeCode: "0x" + info.BinRuntime,
- Hashes: info.Hashes,
- Info: ContractInfo{
- Source: source,
- Language: "Solidity",
- LanguageVersion: languageVersion,
- CompilerVersion: compilerVersion,
- CompilerOptions: compilerOptions,
- SrcMap: info.SrcMap,
- SrcMapRuntime: info.SrcMapRuntime,
- AbiDefinition: abi,
- UserDoc: userdoc,
- DeveloperDoc: devdoc,
- Metadata: info.Metadata,
- },
- }
- }
- return contracts, nil
- }
- // parseCombinedJSONV8 parses the direct output of solc --combined-output
- // and parses it using the rules from solidity v.0.8.0 and later.
- func parseCombinedJSONV8(combinedJSON []byte, source string, languageVersion string, compilerVersion string, compilerOptions string) (map[string]*Contract, error) {
- var output solcOutputV8
- if err := json.Unmarshal(combinedJSON, &output); err != nil {
- return nil, err
- }
- // Compilation succeeded, assemble and return the contracts.
- contracts := make(map[string]*Contract)
- for name, info := range output.Contracts {
- contracts[name] = &Contract{
- Code: "0x" + info.Bin,
- RuntimeCode: "0x" + info.BinRuntime,
- Hashes: info.Hashes,
- Info: ContractInfo{
- Source: source,
- Language: "Solidity",
- LanguageVersion: languageVersion,
- CompilerVersion: compilerVersion,
- CompilerOptions: compilerOptions,
- SrcMap: info.SrcMap,
- SrcMapRuntime: info.SrcMapRuntime,
- AbiDefinition: info.Abi,
- UserDoc: info.Userdoc,
- DeveloperDoc: info.Devdoc,
- Metadata: info.Metadata,
- },
- }
- }
- return contracts, nil
- }
|