aboutsummaryrefslogtreecommitdiffstats
path: root/accounts/abi/type.go
blob: 2235bad611a848434b60742c06ffa7b4a6b2c063 (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
// 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"
)

const (
    IntTy byte = iota
    UintTy
    BoolTy
    StringTy
    SliceTy
    AddressTy
    FixedBytesTy
    BytesTy
    HashTy
    RealTy
)

// Type is the reflection of the supported argument type
type Type struct {
    IsSlice, IsArray bool
    SliceSize        int

    Elem *Type

    Kind reflect.Kind
    Type reflect.Type
    Size int
    T    byte // Our own type checking

    stringKind string // holds the unparsed string for deriving signatures
}

var (
    // fullTypeRegex parses the abi types
    //
    // Types 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]
    fullTypeRegex = regexp.MustCompile("([a-zA-Z0-9]+)(\\[([0-9]*)?\\])?")
    // typeRegex parses the abi sub types
    typeRegex = regexp.MustCompile("([a-zA-Z]+)([0-9]*)?")
)

// NewType creates a new reflection type of abi type given in t.
func NewType(t string) (typ Type, err error) {
    res := fullTypeRegex.FindAllStringSubmatch(t, -1)[0]
    // check if type is slice and parse type.
    switch {
    case res[3] != "":
        // err is ignored. Already checked for number through the regexp
        typ.SliceSize, _ = strconv.Atoi(res[3])
        typ.IsArray = true
    case res[2] != "":
        typ.IsSlice, typ.SliceSize = true, -1
    case res[0] == "":
        return Type{}, fmt.Errorf("abi: type parse error: %s", t)
    }
    if typ.IsArray || typ.IsSlice {
        sliceType, err := NewType(res[1])
        if err != nil {
            return Type{}, err
        }
        typ.Elem = &sliceType
        typ.stringKind = sliceType.stringKind + t[len(res[1]):]
        return typ, nil
    }

    // parse the type and size of the abi-type.
    parsedType := typeRegex.FindAllStringSubmatch(res[1], -1)[0]
    // varSize is the size of the variable
    var varSize int
    if len(parsedType[2]) > 0 {
        var err error
        varSize, err = strconv.Atoi(parsedType[2])
        if err != nil {
            return Type{}, fmt.Errorf("abi: error parsing variable size: %v", err)
        }
    }
    // varType is the parsed abi type
    varType := parsedType[1]
    // substitute canonical integer
    if varSize == 0 && (varType == "int" || varType == "uint") {
        varSize = 256
        t += "256"
    }
    typ.stringKind = t

    switch varType {
    case "int":
        typ.Kind = reflectIntKind(false, varSize)
        typ.Type = big_t
        typ.Size = varSize
        typ.T = IntTy
    case "uint":
        typ.Kind = reflectIntKind(true, varSize)
        typ.Type = ubig_t
        typ.Size = varSize
        typ.T = UintTy
    case "bool":
        typ.Kind = reflect.Bool
        typ.T = BoolTy
    case "address":
        typ.Kind = reflect.Array
        typ.Type = address_t
        typ.Size = 20
        typ.T = AddressTy
    case "string":
        typ.Kind = reflect.String
        typ.Size = -1
        typ.T = StringTy
    case "bytes":
        sliceType, _ := NewType("uint8")
        typ.Elem = &sliceType
        if varSize == 0 {
            typ.IsSlice = true
            typ.T = BytesTy
            typ.SliceSize = -1
        } else {
            typ.IsArray = true
            typ.T = FixedBytesTy
            typ.SliceSize = varSize
        }
    default:
        return Type{}, fmt.Errorf("unsupported arg type: %s", t)
    }

    return
}

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

func (t Type) pack(v reflect.Value) ([]byte, error) {
    // dereference pointer first if it's a pointer
    v = indirect(v)

    if err := typeCheck(t, v); err != nil {
        return nil, err
    }

    if (t.IsSlice || t.IsArray) && t.T != BytesTy && t.T != FixedBytesTy {
        var packed []byte
        for i := 0; i < v.Len(); i++ {
            val, err := t.Elem.pack(v.Index(i))
            if err != nil {
                return nil, err
            }
            packed = append(packed, val...)
        }
        return packBytesSlice(packed, v.Len()), nil
    }

    return packElement(t, v), nil
}

// requireLengthPrefix returns whether the type requires any sort of length
// prefixing.
func (t Type) requiresLengthPrefix() bool {
    return t.T != FixedBytesTy && (t.T == StringTy || t.T == BytesTy || t.IsSlice || t.IsArray)
}