aboutsummaryrefslogtreecommitdiffstats
path: root/accounts/abi/type.go
blob: 16d7491e7cf6d6fb01e58bfc4a2ad0bf9722ce2e (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
// 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 (
    "fmt"
    "reflect"
    "regexp"
    "strconv"

    "github.com/ethereum/go-ethereum/common"
)

const (
    IntTy byte = iota
    UintTy
    BoolTy
    SliceTy
    AddressTy
    RealTy
)

// Type is the reflection of the supported argument type
type Type struct {
    Kind       reflect.Kind
    Type       reflect.Type
    Size       int
    T          byte   // Our own type checking
    stringKind string // holds the unparsed string for deriving signatures
}

// NewType returns a fully parsed Type given by the input string or an error if it  can't be parsed.
//
// Strings can be in the format of:
//
//  Input  = Type [ "[" [ Number ] "]" ] Name .
//  Type   = [ "u" ] "int" [ Number ] .
//
// Examples:
//
//      string     int       uint       real
//      string32   int8      uint8      uint[]
//      address    int256    uint256    real[2]
func NewType(t string) (typ Type, err error) {
    // 1. full string 2. type 3. (opt.) is slice 4. (opt.) size
    freg, err := regexp.Compile("([a-zA-Z0-9]+)(\\[([0-9]*)?\\])?")
    if err != nil {
        return Type{}, err
    }
    res := freg.FindAllStringSubmatch(t, -1)[0]
    var (
        isslice bool
        size    int
    )
    switch {
    case res[3] != "":
        // err is ignored. Already checked for number through the regexp
        size, _ = strconv.Atoi(res[3])
        isslice = true
    case res[2] != "":
        isslice = true
        size = -1
    case res[0] == "":
        return Type{}, fmt.Errorf("type parse error for `%s`", t)
    }

    treg, err := regexp.Compile("([a-zA-Z]+)([0-9]*)?")
    if err != nil {
        return Type{}, err
    }

    parsedType := treg.FindAllStringSubmatch(res[1], -1)[0]
    vsize, _ := strconv.Atoi(parsedType[2])
    vtype := parsedType[1]
    // substitute canonical representation
    if vsize == 0 && (vtype == "int" || vtype == "uint") {
        vsize = 256
        t += "256"
    }

    if isslice {
        typ.Kind = reflect.Slice
        typ.Size = size
        switch vtype {
        case "int":
            typ.Type = big_ts
        case "uint":
            typ.Type = ubig_ts
        default:
            return Type{}, fmt.Errorf("unsupported arg slice type: %s", t)
        }
    } else {
        switch vtype {
        case "int":
            typ.Kind = reflect.Ptr
            typ.Type = big_t
            typ.Size = 256
            typ.T = IntTy
        case "uint":
            typ.Kind = reflect.Ptr
            typ.Type = ubig_t
            typ.Size = 256
            typ.T = UintTy
        case "bool":
            typ.Kind = reflect.Bool
        case "real": // TODO
            typ.Kind = reflect.Invalid
        case "address":
            typ.Kind = reflect.Slice
            typ.Type = byte_ts
            typ.Size = 20
            typ.T = AddressTy
        case "string":
            typ.Kind = reflect.String
            typ.Size = -1
            if vsize > 0 {
                typ.Size = 32
            }
        case "bytes":
            typ.Kind = reflect.Slice
            typ.Type = byte_ts
            typ.Size = vsize
        default:
            return Type{}, fmt.Errorf("unsupported arg type: %s", t)
        }
    }
    typ.stringKind = t

    return
}

func (t Type) String() (out string) {
    return t.stringKind
}

// Test the given input parameter `v` and checks if it matches certain
// criteria
// * Big integers are checks for ptr types and if the given value is
//   assignable
// * Integer are checked for size
// * Strings, addresses and bytes are checks for type and size
func (t Type) pack(v interface{}) ([]byte, error) {
    value := reflect.ValueOf(v)
    switch kind := value.Kind(); kind {
    case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64:
        if t.Type != ubig_t {
            return nil, fmt.Errorf("type mismatch: %s for %T", t.Type, v)
        }
        return packNum(value, t.T), nil
    case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
        if t.Type != ubig_t {
            return nil, fmt.Errorf("type mismatch: %s for %T", t.Type, v)
        }
        return packNum(value, t.T), nil
    case reflect.Ptr:
        // If the value is a ptr do a assign check (only used by
        // big.Int for now)
        if t.Type == ubig_t && value.Type() != ubig_t {
            return nil, fmt.Errorf("type mismatch: %s for %T", t.Type, v)
        }
        return packNum(value, t.T), nil
    case reflect.String:
        if t.Size > -1 && value.Len() > t.Size {
            return nil, fmt.Errorf("%v out of bound. %d for %d", value.Kind(), value.Len(), t.Size)
        }
        return []byte(common.LeftPadString(t.String(), 32)), nil
    case reflect.Slice:
        if t.Size > -1 && value.Len() > t.Size {
            return nil, fmt.Errorf("%v out of bound. %d for %d", value.Kind(), value.Len(), t.Size)
        }

        // Address is a special slice. The slice acts as one rather than a list of elements.
        if t.T == AddressTy {
            return common.LeftPadBytes(v.([]byte), 32), nil
        }

        // Signed / Unsigned check
        if (t.T != IntTy && isSigned(value)) || (t.T == UintTy && isSigned(value)) {
            return nil, fmt.Errorf("slice of incompatible types.")
        }

        var packed []byte
        for i := 0; i < value.Len(); i++ {
            packed = append(packed, packNum(value.Index(i), t.T)...)
        }
        return packed, nil
    case reflect.Bool:
        if value.Bool() {
            return common.LeftPadBytes(common.Big1.Bytes(), 32), nil
        } else {
            return common.LeftPadBytes(common.Big0.Bytes(), 32), nil
        }
    case reflect.Array:
        if v, ok := value.Interface().(common.Address); ok {
            return t.pack(v[:])
        } else if v, ok := value.Interface().(common.Hash); ok {
            return t.pack(v[:])
        }
    }

    return nil, fmt.Errorf("ABI: bad input given %T", value.Kind())
}