aboutsummaryrefslogtreecommitdiffstats
path: root/common/compiler/solidity.go
blob: 4d5ffb473e0f93ef4965c19cc60e0b46ff3e919f (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
package compiler

import (
    "bytes"
    "encoding/json"
    "fmt"
    "io/ioutil"
    "os"
    "os/exec"
    "path/filepath"
    "regexp"
    "strings"

    "github.com/ethereum/go-ethereum/common"
    "github.com/ethereum/go-ethereum/crypto"
    "github.com/ethereum/go-ethereum/logger"
    "github.com/ethereum/go-ethereum/logger/glog"
)

const (
    // flair           = "Christian <c@ethdev.com> and Lefteris <lefteris@ethdev.com> (c) 2014-2015"
    flair           = ""
    languageVersion = "0"
)

var (
    versionRegExp = regexp.MustCompile("[0-9]+.[0-9]+.[0-9]+")
    params        = []string{
        "--binary",       // Request to output the contract in binary (hexadecimal).
        "file",           //
        "--json-abi",     // Request to output the contract's JSON ABI interface.
        "file",           //
        "--natspec-user", // Request to output the contract's Natspec user documentation.
        "file",           //
        "--natspec-dev",  // Request to output the contract's Natspec developer documentation.
        "file",
        "--add-std",
        "1",
    }
)

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"`
    AbiDefinition   interface{} `json:"abiDefinition"`
    UserDoc         interface{} `json:"userDoc"`
    DeveloperDoc    interface{} `json:"developerDoc"`
}

type Solidity struct {
    solcPath string
    version  string
}

func New(solcPath string) (sol *Solidity, err error) {
    // set default solc
    if len(solcPath) == 0 {
        solcPath = "solc"
    }
    solcPath, err = exec.LookPath(solcPath)
    if err != nil {
        return
    }

    cmd := exec.Command(solcPath, "--version")
    var out bytes.Buffer
    cmd.Stdout = &out
    err = cmd.Run()
    if err != nil {
        return
    }

    version := versionRegExp.FindString(out.String())
    sol = &Solidity{
        solcPath: solcPath,
        version:  version,
    }
    glog.V(logger.Info).Infoln(sol.Info())
    return
}

func (sol *Solidity) Info() string {
    return fmt.Sprintf("solc v%s\nSolidity Compiler: %s\n%s", sol.version, sol.solcPath, flair)
}

func (sol *Solidity) Version() string {
    return sol.version
}

func (sol *Solidity) Compile(source string) (contracts map[string]*Contract, err error) {

    if len(source) == 0 {
        err = fmt.Errorf("empty source")
        return
    }

    wd, err := ioutil.TempDir("", "solc")
    if err != nil {
        return
    }
    defer os.RemoveAll(wd)

    in := strings.NewReader(source)
    var out bytes.Buffer
    // cwd set to temp dir
    cmd := exec.Command(sol.solcPath, params...)
    cmd.Dir = wd
    cmd.Stdin = in
    cmd.Stdout = &out
    err = cmd.Run()
    if err != nil {
        err = fmt.Errorf("solc error: %v", err)
        return
    }

    matches, _ := filepath.Glob(wd + "/*.binary")
    if len(matches) < 1 {
        err = fmt.Errorf("solc error: missing code output")
        return
    }

    contracts = make(map[string]*Contract)
    for _, path := range matches {
        _, file := filepath.Split(path)
        base := strings.Split(file, ".")[0]

        codeFile := filepath.Join(wd, base+".binary")
        abiDefinitionFile := filepath.Join(wd, base+".abi")
        userDocFile := filepath.Join(wd, base+".docuser")
        developerDocFile := filepath.Join(wd, base+".docdev")

        var code, abiDefinitionJson, userDocJson, developerDocJson []byte
        code, err = ioutil.ReadFile(codeFile)
        if err != nil {
            err = fmt.Errorf("error reading compiler output for code: %v", err)
            return
        }
        abiDefinitionJson, err = ioutil.ReadFile(abiDefinitionFile)
        if err != nil {
            err = fmt.Errorf("error reading compiler output for abiDefinition: %v", err)
            return
        }
        var abiDefinition interface{}
        err = json.Unmarshal(abiDefinitionJson, &abiDefinition)

        userDocJson, err = ioutil.ReadFile(userDocFile)
        if err != nil {
            err = fmt.Errorf("error reading compiler output for userDoc: %v", err)
            return
        }
        var userDoc interface{}
        err = json.Unmarshal(userDocJson, &userDoc)

        developerDocJson, err = ioutil.ReadFile(developerDocFile)
        if err != nil {
            err = fmt.Errorf("error reading compiler output for developerDoc: %v", err)
            return
        }
        var developerDoc interface{}
        err = json.Unmarshal(developerDocJson, &developerDoc)

        contract := &Contract{
            Code: "0x" + string(code),
            Info: ContractInfo{
                Source:          source,
                Language:        "Solidity",
                LanguageVersion: languageVersion,
                CompilerVersion: sol.version,
                AbiDefinition:   abiDefinition,
                UserDoc:         userDoc,
                DeveloperDoc:    developerDoc,
            },
        }

        contracts[base] = contract
    }

    return
}

func SaveInfo(info *ContractInfo, filename string) (contenthash common.Hash, err error) {
    infojson, err := json.Marshal(info)
    if err != nil {
        return
    }
    contenthash = common.BytesToHash(crypto.Sha3(infojson))
    err = ioutil.WriteFile(filename, infojson, 0600)
    return
}