aboutsummaryrefslogtreecommitdiffstats
path: root/accounts/abi/bind/template.go
blob: 7225794a17f69401c0d5b3c4f019da3c33face64 (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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
// Copyright 2016 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 bind

import "github.com/ethereum/go-ethereum/accounts/abi"

// tmplData is the data structure required to fill the binding template.
type tmplData struct {
    Package   string                   // Name of the package to place the generated file in
    Contracts map[string]*tmplContract // List of contracts to generate into this file
}

// tmplContract contains the data needed to generate an individual contract binding.
type tmplContract struct {
    Type        string                 // Type name of the main contract binding
    InputABI    string                 // JSON ABI used as the input to generate the binding from
    InputBin    string                 // Optional EVM bytecode used to denetare deploy code from
    Constructor abi.Method             // Contract constructor for deploy parametrization
    Calls       map[string]*tmplMethod // Contract calls that only read state data
    Transacts   map[string]*tmplMethod // Contract calls that write state data
}

// tmplMethod is a wrapper around an abi.Method that contains a few preprocessed
// and cached data fields.
type tmplMethod struct {
    Original   abi.Method // Original method as parsed by the abi package
    Normalized abi.Method // Normalized version of the parsed method (capitalized names, non-anonymous args/returns)
    Structured bool       // Whether the returns should be accumulated into a contract
}

// tmplSource is language to template mapping containing all the supported
// programming languages the package can generate to.
var tmplSource = map[Lang]string{
    LangGo:   tmplSourceGo,
    LangJava: tmplSourceJava,
}

// tmplSourceGo is the Go source template use to generate the contract binding
// based on.
const tmplSourceGo = `
// This file is an automatically generated Go binding. Do not modify as any
// change will likely be lost upon the next re-generation!

package {{.Package}}

{{range $contract := .Contracts}}
    // {{.Type}}ABI is the input ABI used to generate the binding from.
    const {{.Type}}ABI = "{{.InputABI}}"

    {{if .InputBin}}
        // {{.Type}}Bin is the compiled bytecode used for deploying new contracts.
        const {{.Type}}Bin = ` + "`" + `{{.InputBin}}` + "`" + `

        // Deploy{{.Type}} deploys a new Ethereum contract, binding an instance of {{.Type}} to it.
        func Deploy{{.Type}}(auth *bind.TransactOpts, backend bind.ContractBackend {{range .Constructor.Inputs}}, {{.Name}} {{bindtype .Type}}{{end}}) (common.Address, *types.Transaction, *{{.Type}}, error) {
          parsed, err := abi.JSON(strings.NewReader({{.Type}}ABI))
          if err != nil {
            return common.Address{}, nil, nil, err
          }
          address, tx, contract, err := bind.DeployContract(auth, parsed, common.FromHex({{.Type}}Bin), backend {{range .Constructor.Inputs}}, {{.Name}}{{end}})
          if err != nil {
            return common.Address{}, nil, nil, err
          }
          return address, tx, &{{.Type}}{ {{.Type}}Caller: {{.Type}}Caller{contract: contract}, {{.Type}}Transactor: {{.Type}}Transactor{contract: contract} }, nil
        }
    {{end}}

    // {{.Type}} is an auto generated Go binding around an Ethereum contract.
    type {{.Type}} struct {
      {{.Type}}Caller     // Read-only binding to the contract
      {{.Type}}Transactor // Write-only binding to the contract
    }

    // {{.Type}}Caller is an auto generated read-only Go binding around an Ethereum contract.
    type {{.Type}}Caller struct {
      contract *bind.BoundContract // Generic contract wrapper for the low level calls
    }

    // {{.Type}}Transactor is an auto generated write-only Go binding around an Ethereum contract.
    type {{.Type}}Transactor struct {
      contract *bind.BoundContract // Generic contract wrapper for the low level calls
    }

    // {{.Type}}Session is an auto generated Go binding around an Ethereum contract,
    // with pre-set call and transact options.
    type {{.Type}}Session struct {
      Contract     *{{.Type}}        // Generic contract binding to set the session for
      CallOpts     bind.CallOpts     // Call options to use throughout this session
      TransactOpts bind.TransactOpts // Transaction auth options to use throughout this session
    }

    // {{.Type}}CallerSession is an auto generated read-only Go binding around an Ethereum contract,
    // with pre-set call options.
    type {{.Type}}CallerSession struct {
      Contract *{{.Type}}Caller // Generic contract caller binding to set the session for
      CallOpts bind.CallOpts    // Call options to use throughout this session
    }

    // {{.Type}}TransactorSession is an auto generated write-only Go binding around an Ethereum contract,
    // with pre-set transact options.
    type {{.Type}}TransactorSession struct {
      Contract     *{{.Type}}Transactor // Generic contract transactor binding to set the session for
      TransactOpts bind.TransactOpts    // Transaction auth options to use throughout this session
    }

    // {{.Type}}Raw is an auto generated low-level Go binding around an Ethereum contract.
    type {{.Type}}Raw struct {
      Contract *{{.Type}} // Generic contract binding to access the raw methods on
    }

    // {{.Type}}CallerRaw is an auto generated low-level read-only Go binding around an Ethereum contract.
    type {{.Type}}CallerRaw struct {
        Contract *{{.Type}}Caller // Generic read-only contract binding to access the raw methods on
    }

    // {{.Type}}TransactorRaw is an auto generated low-level write-only Go binding around an Ethereum contract.
    type {{.Type}}TransactorRaw struct {
        Contract *{{.Type}}Transactor // Generic write-only contract binding to access the raw methods on
    }

    // New{{.Type}} creates a new instance of {{.Type}}, bound to a specific deployed contract.
    func New{{.Type}}(address common.Address, backend bind.ContractBackend) (*{{.Type}}, error) {
      contract, err := bind{{.Type}}(address, backend, backend)
      if err != nil {
        return nil, err
      }
      return &{{.Type}}{ {{.Type}}Caller: {{.Type}}Caller{contract: contract}, {{.Type}}Transactor: {{.Type}}Transactor{contract: contract} }, nil
    }

    // New{{.Type}}Caller creates a new read-only instance of {{.Type}}, bound to a specific deployed contract.
    func New{{.Type}}Caller(address common.Address, caller bind.ContractCaller) (*{{.Type}}Caller, error) {
      contract, err := bind{{.Type}}(address, caller, nil)
      if err != nil {
        return nil, err
      }
      return &{{.Type}}Caller{contract: contract}, nil
    }

    // New{{.Type}}Transactor creates a new write-only instance of {{.Type}}, bound to a specific deployed contract.
    func New{{.Type}}Transactor(address common.Address, transactor bind.ContractTransactor) (*{{.Type}}Transactor, error) {
      contract, err := bind{{.Type}}(address, nil, transactor)
      if err != nil {
        return nil, err
      }
      return &{{.Type}}Transactor{contract: contract}, nil
    }

    // bind{{.Type}} binds a generic wrapper to an already deployed contract.
    func bind{{.Type}}(address common.Address, caller bind.ContractCaller, transactor bind.ContractTransactor) (*bind.BoundContract, error) {
      parsed, err := abi.JSON(strings.NewReader({{.Type}}ABI))
      if err != nil {
        return nil, err
      }
      return bind.NewBoundContract(address, parsed, caller, transactor), nil
    }

    // Call invokes the (constant) contract method with params as input values and
    // sets the output to result. The result type might be a single field for simple
    // returns, a slice of interfaces for anonymous returns and a struct for named
    // returns.
    func (_{{$contract.Type}} *{{$contract.Type}}Raw) Call(opts *bind.CallOpts, result interface{}, method string, params ...interface{}) error {
        return _{{$contract.Type}}.Contract.{{$contract.Type}}Caller.contract.Call(opts, result, method, params...)
    }

    // Transfer initiates a plain transaction to move funds to the contract, calling
    // its default method if one is available.
    func (_{{$contract.Type}} *{{$contract.Type}}Raw) Transfer(opts *bind.TransactOpts) (*types.Transaction, error) {
        return _{{$contract.Type}}.Contract.{{$contract.Type}}Transactor.contract.Transfer(opts)
    }

    // Transact invokes the (paid) contract method with params as input values.
    func (_{{$contract.Type}} *{{$contract.Type}}Raw) Transact(opts *bind.TransactOpts, method string, params ...interface{}) (*types.Transaction, error) {
        return _{{$contract.Type}}.Contract.{{$contract.Type}}Transactor.contract.Transact(opts, method, params...)
    }

    // Call invokes the (constant) contract method with params as input values and
    // sets the output to result. The result type might be a single field for simple
    // returns, a slice of interfaces for anonymous returns and a struct for named
    // returns.
    func (_{{$contract.Type}} *{{$contract.Type}}CallerRaw) Call(opts *bind.CallOpts, result interface{}, method string, params ...interface{}) error {
        return _{{$contract.Type}}.Contract.contract.Call(opts, result, method, params...)
    }

    // Transfer initiates a plain transaction to move funds to the contract, calling
    // its default method if one is available.
    func (_{{$contract.Type}} *{{$contract.Type}}TransactorRaw) Transfer(opts *bind.TransactOpts) (*types.Transaction, error) {
        return _{{$contract.Type}}.Contract.contract.Transfer(opts)
    }

    // Transact invokes the (paid) contract method with params as input values.
    func (_{{$contract.Type}} *{{$contract.Type}}TransactorRaw) Transact(opts *bind.TransactOpts, method string, params ...interface{}) (*types.Transaction, error) {
        return _{{$contract.Type}}.Contract.contract.Transact(opts, method, params...)
    }

    {{range .Calls}}
        // {{.Normalized.Name}} is a free data retrieval call binding the contract method 0x{{printf "%x" .Original.Id}}.
        //
        // Solidity: {{.Original.String}}
        func (_{{$contract.Type}} *{{$contract.Type}}Caller) {{.Normalized.Name}}(opts *bind.CallOpts {{range .Normalized.Inputs}}, {{.Name}} {{bindtype .Type}} {{end}}) ({{if .Structured}}struct{ {{range .Normalized.Outputs}}{{.Name}} {{bindtype .Type}};{{end}} },{{else}}{{range .Normalized.Outputs}}{{bindtype .Type}},{{end}}{{end}} error) {
            {{if .Structured}}ret := new(struct{
                {{range .Normalized.Outputs}}{{.Name}} {{bindtype .Type}}
                {{end}}
            }){{else}}var (
                {{range $i, $_ := .Normalized.Outputs}}ret{{$i}} = new({{bindtype .Type}})
                {{end}}
            ){{end}}
            out := {{if .Structured}}ret{{else}}{{if eq (len .Normalized.Outputs) 1}}ret0{{else}}&[]interface{}{
                {{range $i, $_ := .Normalized.Outputs}}ret{{$i}},
                {{end}}
            }{{end}}{{end}}
            err := _{{$contract.Type}}.contract.Call(opts, out, "{{.Original.Name}}" {{range .Normalized.Inputs}}, {{.Name}}{{end}})
            return {{if .Structured}}*ret,{{else}}{{range $i, $_ := .Normalized.Outputs}}*ret{{$i}},{{end}}{{end}} err
        }

        // {{.Normalized.Name}} is a free data retrieval call binding the contract method 0x{{printf "%x" .Original.Id}}.
        //
        // Solidity: {{.Original.String}}
        func (_{{$contract.Type}} *{{$contract.Type}}Session) {{.Normalized.Name}}({{range $i, $_ := .Normalized.Inputs}}{{if ne $i 0}},{{end}} {{.Name}} {{bindtype .Type}} {{end}}) ({{if .Structured}}struct{ {{range .Normalized.Outputs}}{{.Name}} {{bindtype .Type}};{{end}} }, {{else}} {{range .Normalized.Outputs}}{{bindtype .Type}},{{end}} {{end}} error) {
          return _{{$contract.Type}}.Contract.{{.Normalized.Name}}(&_{{$contract.Type}}.CallOpts {{range .Normalized.Inputs}}, {{.Name}}{{end}})
        }

        // {{.Normalized.Name}} is a free data retrieval call binding the contract method 0x{{printf "%x" .Original.Id}}.
        //
        // Solidity: {{.Original.String}}
        func (_{{$contract.Type}} *{{$contract.Type}}CallerSession) {{.Normalized.Name}}({{range $i, $_ := .Normalized.Inputs}}{{if ne $i 0}},{{end}} {{.Name}} {{bindtype .Type}} {{end}}) ({{if .Structured}}struct{ {{range .Normalized.Outputs}}{{.Name}} {{bindtype .Type}};{{end}} }, {{else}} {{range .Normalized.Outputs}}{{bindtype .Type}},{{end}} {{end}} error) {
          return _{{$contract.Type}}.Contract.{{.Normalized.Name}}(&_{{$contract.Type}}.CallOpts {{range .Normalized.Inputs}}, {{.Name}}{{end}})
        }
    {{end}}

    {{range .Transacts}}
        // {{.Normalized.Name}} is a paid mutator transaction binding the contract method 0x{{printf "%x" .Original.Id}}.
        //
        // Solidity: {{.Original.String}}
        func (_{{$contract.Type}} *{{$contract.Type}}Transactor) {{.Normalized.Name}}(opts *bind.TransactOpts {{range .Normalized.Inputs}}, {{.Name}} {{bindtype .Type}} {{end}}) (*types.Transaction, error) {
            return _{{$contract.Type}}.contract.Transact(opts, "{{.Original.Name}}" {{range .Normalized.Inputs}}, {{.Name}}{{end}})
        }

        // {{.Normalized.Name}} is a paid mutator transaction binding the contract method 0x{{printf "%x" .Original.Id}}.
        //
        // Solidity: {{.Original.String}}
        func (_{{$contract.Type}} *{{$contract.Type}}Session) {{.Normalized.Name}}({{range $i, $_ := .Normalized.Inputs}}{{if ne $i 0}},{{end}} {{.Name}} {{bindtype .Type}} {{end}}) (*types.Transaction, error) {
          return _{{$contract.Type}}.Contract.{{.Normalized.Name}}(&_{{$contract.Type}}.TransactOpts {{range $i, $_ := .Normalized.Inputs}}, {{.Name}}{{end}})
        }

        // {{.Normalized.Name}} is a paid mutator transaction binding the contract method 0x{{printf "%x" .Original.Id}}.
        //
        // Solidity: {{.Original.String}}
        func (_{{$contract.Type}} *{{$contract.Type}}TransactorSession) {{.Normalized.Name}}({{range $i, $_ := .Normalized.Inputs}}{{if ne $i 0}},{{end}} {{.Name}} {{bindtype .Type}} {{end}}) (*types.Transaction, error) {
          return _{{$contract.Type}}.Contract.{{.Normalized.Name}}(&_{{$contract.Type}}.TransactOpts {{range $i, $_ := .Normalized.Inputs}}, {{.Name}}{{end}})
        }
    {{end}}
{{end}}
`

// tmplSourceJava is the Java source template use to generate the contract binding
// based on.
const tmplSourceJava = `
// This file is an automatically generated Java binding. Do not modify as any
// change will likely be lost upon the next re-generation!

package {{.Package}};

import org.ethereum.geth.*;
import org.ethereum.geth.internal.*;

{{range $contract := .Contracts}}
    public class {{.Type}} {
        // ABI is the input ABI used to generate the binding from.
        public final static String ABI = "{{.InputABI}}";

        {{if .InputBin}}
            // Bytecode is the compiled bytecode used for deploying new contracts.
            public final static byte[] Bytecode = "{{.InputBin}}".getBytes();

            // deploy deploys a new Ethereum contract, binding an instance of {{.Type}} to it.
            public static {{.Type}} deploy(TransactOpts auth, EthereumClient client{{range .Constructor.Inputs}}, {{bindtype .Type}} {{.Name}}{{end}}) throws Exception {
                Interfaces args = Geth.newInterfaces({{(len .Constructor.Inputs)}});
                {{range $index, $element := .Constructor.Inputs}}
                  args.set({{$index}}, Geth.newInterface()); args.get({{$index}}).set{{namedtype (bindtype .Type) .Type}}({{.Name}});
                {{end}}
                return new {{.Type}}(Geth.deployContract(auth, ABI, Bytecode, client, args));
            }

            // Internal constructor used by contract deployment.
            private {{.Type}}(BoundContract deployment) {
                this.Address  = deployment.getAddress();
                this.Deployer = deployment.getDeployer();
                this.Contract = deployment;
            }
        {{end}}

        // Ethereum address where this contract is located at.
        public final Address Address;

        // Ethereum transaction in which this contract was deployed (if known!).
        public final Transaction Deployer;

        // Contract instance bound to a blockchain address.
        private final BoundContract Contract;

        // Creates a new instance of {{.Type}}, bound to a specific deployed contract.
        public {{.Type}}(Address address, EthereumClient client) throws Exception {
            this(Geth.bindContract(address, ABI, client));
        }

        {{range .Calls}}
            {{if gt (len .Normalized.Outputs) 1}}
            // {{capitalise .Normalized.Name}}Results is the output of a call to {{.Normalized.Name}}.
            public class {{capitalise .Normalized.Name}}Results {
                {{range $index, $item := .Normalized.Outputs}}public {{bindtype .Type}} {{if ne .Name ""}}{{.Name}}{{else}}Return{{$index}}{{end}};
                {{end}}
            }
            {{end}}

            // {{.Normalized.Name}} is a free data retrieval call binding the contract method 0x{{printf "%x" .Original.Id}}.
            //
            // Solidity: {{.Original.String}}
            public {{if gt (len .Normalized.Outputs) 1}}{{capitalise .Normalized.Name}}Results{{else}}{{range .Normalized.Outputs}}{{bindtype .Type}}{{end}}{{end}} {{.Normalized.Name}}(CallOpts opts{{range .Normalized.Inputs}}, {{bindtype .Type}} {{.Name}}{{end}}) throws Exception {
                Interfaces args = Geth.newInterfaces({{(len .Normalized.Inputs)}});
                {{range $index, $item := .Normalized.Inputs}}args.set({{$index}}, Geth.newInterface()); args.get({{$index}}).set{{namedtype (bindtype .Type) .Type}}({{.Name}});
                {{end}}

                Interfaces results = Geth.newInterfaces({{(len .Normalized.Outputs)}});
                {{range $index, $item := .Normalized.Outputs}}Interface result{{$index}} = Geth.newInterface(); result{{$index}}.setDefault{{namedtype (bindtype .Type) .Type}}(); results.set({{$index}}, result{{$index}});
                {{end}}

                if (opts == null) {
                    opts = Geth.newCallOpts();
                }
                this.Contract.call(opts, results, "{{.Original.Name}}", args);
                {{if gt (len .Normalized.Outputs) 1}}
                    {{capitalise .Normalized.Name}}Results result = new {{capitalise .Normalized.Name}}Results();
                    {{range $index, $item := .Normalized.Outputs}}result.{{if ne .Name ""}}{{.Name}}{{else}}Return{{$index}}{{end}} = results.get({{$index}}).get{{namedtype (bindtype .Type) .Type}}();
                    {{end}}
                    return result;
                {{else}}{{range .Normalized.Outputs}}return results.get(0).get{{namedtype (bindtype .Type) .Type}}();{{end}}
                {{end}}
            }
        {{end}}

        {{range .Transacts}}
            // {{.Normalized.Name}} is a paid mutator transaction binding the contract method 0x{{printf "%x" .Original.Id}}.
            //
            // Solidity: {{.Original.String}}
            public Transaction {{.Normalized.Name}}(TransactOpts opts{{range .Normalized.Inputs}}, {{bindtype .Type}} {{.Name}}{{end}}) throws Exception {
                Interfaces args = Geth.newInterfaces({{(len .Normalized.Inputs)}});
                {{range $index, $item := .Normalized.Inputs}}args.set({{$index}}, Geth.newInterface()); args.get({{$index}}).set{{namedtype (bindtype .Type) .Type}}({{.Name}});
                {{end}}

                return this.Contract.transact(opts, "{{.Original.Name}}"    , args);
            }
        {{end}}
    }
{{end}}
`