aboutsummaryrefslogtreecommitdiffstats
path: root/accounts/abi/abi.go
blob: 02b4fa472cb80d43aa7de6f115e64066940beaf9 (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
// 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 abi

import (
    "encoding/json"
    "fmt"
    "io"
)

// The ABI holds information about a contract's context and available
// invokable methods. It will allow you to type check function calls and
// packs data accordingly.
type ABI struct {
    Constructor Method
    Methods     map[string]Method
    Events      map[string]Event
}

// JSON returns a parsed ABI interface and error if it failed.
func JSON(reader io.Reader) (ABI, error) {
    dec := json.NewDecoder(reader)

    var abi ABI
    if err := dec.Decode(&abi); err != nil {
        return ABI{}, err
    }

    return abi, nil
}

// Pack the given method name to conform the ABI. Method call's data
// will consist of method_id, args0, arg1, ... argN. Method id consists
// of 4 bytes and arguments are all 32 bytes.
// Method ids are created from the first 4 bytes of the hash of the
// methods string signature. (signature = baz(uint32,string32))
func (abi ABI) Pack(name string, args ...interface{}) ([]byte, error) {
    // Fetch the ABI of the requested method
    var method Method

    if name == "" {
        method = abi.Constructor
    } else {
        m, exist := abi.Methods[name]
        if !exist {
            return nil, fmt.Errorf("method '%s' not found", name)
        }
        method = m
    }
    arguments, err := method.pack(args...)
    if err != nil {
        return nil, err
    }
    // Pack up the method ID too if not a constructor and return
    if name == "" {
        return arguments, nil
    }
    return append(method.Id(), arguments...), nil
}

// Unpack output in v according to the abi specification
func (abi ABI) Unpack(v interface{}, name string, output []byte) (err error) {
    if len(output) == 0 {
        return fmt.Errorf("abi: unmarshalling empty output")
    }

    // since there can't be naming collisions with contracts and events,
    // we need to decide whether we're calling a method or an event
    var unpack unpacker
    if method, ok := abi.Methods[name]; ok {
        if len(output)%32 != 0 {
            return fmt.Errorf("abi: improperly formatted output")
        }
        unpack = method
    } else if event, ok := abi.Events[name]; ok {
        unpack = event
    } else {
        return fmt.Errorf("abi: could not locate named method or event.")
    }

    // requires a struct to unpack into for a tuple return...
    if unpack.isTupleReturn() {
        return unpack.tupleUnpack(v, output)
    }
    return unpack.singleUnpack(v, output)
}

func (abi *ABI) UnmarshalJSON(data []byte) error {
    var fields []struct {
        Type      string
        Name      string
        Constant  bool
        Indexed   bool
        Anonymous bool
        Inputs    []Argument
        Outputs   []Argument
    }

    if err := json.Unmarshal(data, &fields); err != nil {
        return err
    }

    abi.Methods = make(map[string]Method)
    abi.Events = make(map[string]Event)
    for _, field := range fields {
        switch field.Type {
        case "constructor":
            abi.Constructor = Method{
                Inputs: field.Inputs,
            }
        // empty defaults to function according to the abi spec
        case "function", "":
            abi.Methods[field.Name] = Method{
                Name:    field.Name,
                Const:   field.Constant,
                Inputs:  field.Inputs,
                Outputs: field.Outputs,
            }
        case "event":
            abi.Events[field.Name] = Event{
                Name:      field.Name,
                Anonymous: field.Anonymous,
                Inputs:    field.Inputs,
            }
        }
    }

    return nil
}