accounts/abi: satisfy most of the linter warnings
+ adding missing comments + small cleanups which won't significantly change function body. + unify Method receiver name
This commit is contained in:
parent
0ed8b838a9
commit
95461e8b22
@ -89,7 +89,7 @@ func (abi ABI) Unpack(v interface{}, name string, output []byte) (err error) {
|
|||||||
} else if event, ok := abi.Events[name]; ok {
|
} else if event, ok := abi.Events[name]; ok {
|
||||||
unpack = event
|
unpack = event
|
||||||
} else {
|
} else {
|
||||||
return fmt.Errorf("abi: could not locate named method or event.")
|
return fmt.Errorf("abi: could not locate named method or event")
|
||||||
}
|
}
|
||||||
|
|
||||||
// requires a struct to unpack into for a tuple return...
|
// requires a struct to unpack into for a tuple return...
|
||||||
@ -99,6 +99,7 @@ func (abi ABI) Unpack(v interface{}, name string, output []byte) (err error) {
|
|||||||
return unpack.singleUnpack(v, output)
|
return unpack.singleUnpack(v, output)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// UnmarshalJSON implements json.Unmarshaler interface
|
||||||
func (abi *ABI) UnmarshalJSON(data []byte) error {
|
func (abi *ABI) UnmarshalJSON(data []byte) error {
|
||||||
var fields []struct {
|
var fields []struct {
|
||||||
Type string
|
Type string
|
||||||
|
@ -29,6 +29,7 @@ type Argument struct {
|
|||||||
Indexed bool // indexed is only used by events
|
Indexed bool // indexed is only used by events
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// UnmarshalJSON implements json.Unmarshaler interface
|
||||||
func (a *Argument) UnmarshalJSON(data []byte) error {
|
func (a *Argument) UnmarshalJSON(data []byte) error {
|
||||||
var extarg struct {
|
var extarg struct {
|
||||||
Name string
|
Name string
|
||||||
|
@ -120,7 +120,7 @@ func (e Event) singleUnpack(v interface{}, output []byte) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if e.Inputs[0].Indexed {
|
if e.Inputs[0].Indexed {
|
||||||
return fmt.Errorf("abi: attempting to unpack indexed variable into element.")
|
return fmt.Errorf("abi: attempting to unpack indexed variable into element")
|
||||||
}
|
}
|
||||||
|
|
||||||
value := valueOf.Elem()
|
value := valueOf.Elem()
|
||||||
@ -129,8 +129,5 @@ func (e Event) singleUnpack(v interface{}, output []byte) error {
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
if err := set(value, reflect.ValueOf(marshalledValue), e.Inputs[0]); err != nil {
|
return set(value, reflect.ValueOf(marshalledValue), e.Inputs[0])
|
||||||
return err
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
}
|
||||||
|
@ -24,7 +24,7 @@ import (
|
|||||||
"github.com/ethereum/go-ethereum/crypto"
|
"github.com/ethereum/go-ethereum/crypto"
|
||||||
)
|
)
|
||||||
|
|
||||||
// Callable method given a `Name` and whether the method is a constant.
|
// Method represents a callable given a `Name` and whether the method is a constant.
|
||||||
// If the method is `Const` no transaction needs to be created for this
|
// If the method is `Const` no transaction needs to be created for this
|
||||||
// particular Method call. It can easily be simulated using a local VM.
|
// particular Method call. It can easily be simulated using a local VM.
|
||||||
// For example a `Balance()` method only needs to retrieve something
|
// For example a `Balance()` method only needs to retrieve something
|
||||||
@ -91,7 +91,7 @@ func (method Method) pack(args ...interface{}) ([]byte, error) {
|
|||||||
// unpacks a method return tuple into a struct of corresponding go types
|
// unpacks a method return tuple into a struct of corresponding go types
|
||||||
//
|
//
|
||||||
// Unpacking can be done into a struct or a slice/array.
|
// Unpacking can be done into a struct or a slice/array.
|
||||||
func (method Method) tupleUnpack(v interface{}, output []byte) error {
|
func (method Method) tupleUnpack(v interface{}, outputSlice []byte) error {
|
||||||
// make sure the passed value is a pointer
|
// make sure the passed value is a pointer
|
||||||
valueOf := reflect.ValueOf(v)
|
valueOf := reflect.ValueOf(v)
|
||||||
if reflect.Ptr != valueOf.Kind() {
|
if reflect.Ptr != valueOf.Kind() {
|
||||||
@ -108,16 +108,15 @@ func (method Method) tupleUnpack(v interface{}, output []byte) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
j := 0
|
j := 0
|
||||||
for i := 0; i < len(method.Outputs); i++ {
|
for i, output := range method.Outputs {
|
||||||
toUnpack := method.Outputs[i]
|
marshalledValue, err := toGoType((i+j)*32, ouptut.Type, outputSlice)
|
||||||
marshalledValue, err := toGoType((i+j)*32, toUnpack.Type, output)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
if toUnpack.Type.T == ArrayTy {
|
if output.Type.T == ArrayTy {
|
||||||
// combined index ('i' + 'j') need to be adjusted only by size of array, thus
|
// combined index ('i' + 'j') need to be adjusted only by size of array, thus
|
||||||
// we need to decrement 'j' because 'i' was incremented
|
// we need to decrement 'j' because 'i' was incremented
|
||||||
j += toUnpack.Type.Size - 1
|
j += output.Type.Size - 1
|
||||||
}
|
}
|
||||||
reflectValue := reflect.ValueOf(marshalledValue)
|
reflectValue := reflect.ValueOf(marshalledValue)
|
||||||
|
|
||||||
@ -126,8 +125,8 @@ func (method Method) tupleUnpack(v interface{}, output []byte) error {
|
|||||||
for j := 0; j < typ.NumField(); j++ {
|
for j := 0; j < typ.NumField(); j++ {
|
||||||
field := typ.Field(j)
|
field := typ.Field(j)
|
||||||
// TODO read tags: `abi:"fieldName"`
|
// TODO read tags: `abi:"fieldName"`
|
||||||
if field.Name == strings.ToUpper(method.Outputs[i].Name[:1])+method.Outputs[i].Name[1:] {
|
if field.Name == strings.ToUpper(output.Name[:1])+output.Name[1:] {
|
||||||
if err := set(value.Field(j), reflectValue, method.Outputs[i]); err != nil {
|
if err := set(value.Field(j), reflectValue, output); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -137,7 +136,7 @@ func (method Method) tupleUnpack(v interface{}, output []byte) error {
|
|||||||
if err := requireAssignable(v, reflectValue); err != nil {
|
if err := requireAssignable(v, reflectValue); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
if err := set(v.Elem(), reflectValue, method.Outputs[i]); err != nil {
|
if err := set(v.Elem(), reflectValue, output); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -160,10 +159,7 @@ func (method Method) singleUnpack(v interface{}, output []byte) error {
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
if err := set(value, reflect.ValueOf(marshalledValue), method.Outputs[0]); err != nil {
|
return set(value, reflect.ValueOf(marshalledValue), method.Outputs[0])
|
||||||
return err
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Sig returns the methods string signature according to the ABI spec.
|
// Sig returns the methods string signature according to the ABI spec.
|
||||||
@ -173,35 +169,35 @@ func (method Method) singleUnpack(v interface{}, output []byte) error {
|
|||||||
// function foo(uint32 a, int b) = "foo(uint32,int256)"
|
// function foo(uint32 a, int b) = "foo(uint32,int256)"
|
||||||
//
|
//
|
||||||
// Please note that "int" is substitute for its canonical representation "int256"
|
// Please note that "int" is substitute for its canonical representation "int256"
|
||||||
func (m Method) Sig() string {
|
func (method Method) Sig() string {
|
||||||
types := make([]string, len(m.Inputs))
|
types := make([]string, len(method.Inputs))
|
||||||
i := 0
|
i := 0
|
||||||
for _, input := range m.Inputs {
|
for _, input := range method.Inputs {
|
||||||
types[i] = input.Type.String()
|
types[i] = input.Type.String()
|
||||||
i++
|
i++
|
||||||
}
|
}
|
||||||
return fmt.Sprintf("%v(%v)", m.Name, strings.Join(types, ","))
|
return fmt.Sprintf("%v(%v)", method.Name, strings.Join(types, ","))
|
||||||
}
|
}
|
||||||
|
|
||||||
func (m Method) String() string {
|
func (method Method) String() string {
|
||||||
inputs := make([]string, len(m.Inputs))
|
inputs := make([]string, len(method.Inputs))
|
||||||
for i, input := range m.Inputs {
|
for i, input := range method.Inputs {
|
||||||
inputs[i] = fmt.Sprintf("%v %v", input.Name, input.Type)
|
inputs[i] = fmt.Sprintf("%v %v", input.Name, input.Type)
|
||||||
}
|
}
|
||||||
outputs := make([]string, len(m.Outputs))
|
outputs := make([]string, len(method.Outputs))
|
||||||
for i, output := range m.Outputs {
|
for i, output := range method.Outputs {
|
||||||
if len(output.Name) > 0 {
|
if len(output.Name) > 0 {
|
||||||
outputs[i] = fmt.Sprintf("%v ", output.Name)
|
outputs[i] = fmt.Sprintf("%v ", output.Name)
|
||||||
}
|
}
|
||||||
outputs[i] += output.Type.String()
|
outputs[i] += output.Type.String()
|
||||||
}
|
}
|
||||||
constant := ""
|
constant := ""
|
||||||
if m.Const {
|
if method.Const {
|
||||||
constant = "constant "
|
constant = "constant "
|
||||||
}
|
}
|
||||||
return fmt.Sprintf("function %v(%v) %sreturns(%v)", m.Name, strings.Join(inputs, ", "), constant, strings.Join(outputs, ", "))
|
return fmt.Sprintf("function %v(%v) %sreturns(%v)", method.Name, strings.Join(inputs, ", "), constant, strings.Join(outputs, ", "))
|
||||||
}
|
}
|
||||||
|
|
||||||
func (m Method) Id() []byte {
|
func (method Method) Id() []byte {
|
||||||
return crypto.Keccak256([]byte(m.Sig()))[:4]
|
return crypto.Keccak256([]byte(method.Sig()))[:4]
|
||||||
}
|
}
|
||||||
|
@ -48,9 +48,8 @@ func packElement(t Type, reflectValue reflect.Value) []byte {
|
|||||||
case BoolTy:
|
case BoolTy:
|
||||||
if reflectValue.Bool() {
|
if reflectValue.Bool() {
|
||||||
return math.PaddedBigBytes(common.Big1, 32)
|
return math.PaddedBigBytes(common.Big1, 32)
|
||||||
} else {
|
|
||||||
return math.PaddedBigBytes(common.Big0, 32)
|
|
||||||
}
|
}
|
||||||
|
return math.PaddedBigBytes(common.Big0, 32)
|
||||||
case BytesTy:
|
case BytesTy:
|
||||||
if reflectValue.Kind() == reflect.Array {
|
if reflectValue.Kind() == reflect.Array {
|
||||||
reflectValue = mustArrayToByteSlice(reflectValue)
|
reflectValue = mustArrayToByteSlice(reflectValue)
|
||||||
|
@ -24,6 +24,7 @@ import (
|
|||||||
"strings"
|
"strings"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// Type enumerator
|
||||||
const (
|
const (
|
||||||
IntTy byte = iota
|
IntTy byte = iota
|
||||||
UintTy
|
UintTy
|
||||||
@ -100,69 +101,66 @@ func NewType(t string) (typ Type, err error) {
|
|||||||
return Type{}, fmt.Errorf("invalid formatting of array type")
|
return Type{}, fmt.Errorf("invalid formatting of array type")
|
||||||
}
|
}
|
||||||
return typ, err
|
return typ, err
|
||||||
} else {
|
}
|
||||||
// parse the type and size of the abi-type.
|
// parse the type and size of the abi-type.
|
||||||
parsedType := typeRegex.FindAllStringSubmatch(t, -1)[0]
|
parsedType := typeRegex.FindAllStringSubmatch(t, -1)[0]
|
||||||
// varSize is the size of the variable
|
// varSize is the size of the variable
|
||||||
var varSize int
|
var varSize int
|
||||||
if len(parsedType[3]) > 0 {
|
if len(parsedType[3]) > 0 {
|
||||||
var err error
|
var err error
|
||||||
varSize, err = strconv.Atoi(parsedType[2])
|
varSize, err = strconv.Atoi(parsedType[2])
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return Type{}, fmt.Errorf("abi: error parsing variable size: %v", err)
|
return Type{}, fmt.Errorf("abi: error parsing variable size: %v", err)
|
||||||
}
|
|
||||||
} else {
|
|
||||||
if parsedType[0] == "uint" || parsedType[0] == "int" {
|
|
||||||
// this should fail because it means that there's something wrong with
|
|
||||||
// the abi type (the compiler should always format it to the size...always)
|
|
||||||
return Type{}, fmt.Errorf("unsupported arg type: %s", t)
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
// varType is the parsed abi type
|
} else {
|
||||||
varType := parsedType[1]
|
if parsedType[0] == "uint" || parsedType[0] == "int" {
|
||||||
|
// this should fail because it means that there's something wrong with
|
||||||
switch varType {
|
// the abi type (the compiler should always format it to the size...always)
|
||||||
case "int":
|
|
||||||
typ.Kind, typ.Type = reflectIntKindAndType(false, varSize)
|
|
||||||
typ.Size = varSize
|
|
||||||
typ.T = IntTy
|
|
||||||
case "uint":
|
|
||||||
typ.Kind, typ.Type = reflectIntKindAndType(true, varSize)
|
|
||||||
typ.Size = varSize
|
|
||||||
typ.T = UintTy
|
|
||||||
case "bool":
|
|
||||||
typ.Kind = reflect.Bool
|
|
||||||
typ.T = BoolTy
|
|
||||||
typ.Type = reflect.TypeOf(bool(false))
|
|
||||||
case "address":
|
|
||||||
typ.Kind = reflect.Array
|
|
||||||
typ.Type = address_t
|
|
||||||
typ.Size = 20
|
|
||||||
typ.T = AddressTy
|
|
||||||
case "string":
|
|
||||||
typ.Kind = reflect.String
|
|
||||||
typ.Type = reflect.TypeOf("")
|
|
||||||
typ.T = StringTy
|
|
||||||
case "bytes":
|
|
||||||
if varSize == 0 {
|
|
||||||
typ.T = BytesTy
|
|
||||||
typ.Kind = reflect.Slice
|
|
||||||
typ.Type = reflect.SliceOf(reflect.TypeOf(byte(0)))
|
|
||||||
} else {
|
|
||||||
typ.T = FixedBytesTy
|
|
||||||
typ.Kind = reflect.Array
|
|
||||||
typ.Size = varSize
|
|
||||||
typ.Type = reflect.ArrayOf(varSize, reflect.TypeOf(byte(0)))
|
|
||||||
}
|
|
||||||
case "function":
|
|
||||||
typ.Kind = reflect.Array
|
|
||||||
typ.T = FunctionTy
|
|
||||||
typ.Size = 24
|
|
||||||
typ.Type = reflect.ArrayOf(24, reflect.TypeOf(byte(0)))
|
|
||||||
default:
|
|
||||||
return Type{}, fmt.Errorf("unsupported arg type: %s", t)
|
return Type{}, fmt.Errorf("unsupported arg type: %s", t)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
// varType is the parsed abi type
|
||||||
|
switch varType := parsedType[1]; varType {
|
||||||
|
case "int":
|
||||||
|
typ.Kind, typ.Type = reflectIntKindAndType(false, varSize)
|
||||||
|
typ.Size = varSize
|
||||||
|
typ.T = IntTy
|
||||||
|
case "uint":
|
||||||
|
typ.Kind, typ.Type = reflectIntKindAndType(true, varSize)
|
||||||
|
typ.Size = varSize
|
||||||
|
typ.T = UintTy
|
||||||
|
case "bool":
|
||||||
|
typ.Kind = reflect.Bool
|
||||||
|
typ.T = BoolTy
|
||||||
|
typ.Type = reflect.TypeOf(bool(false))
|
||||||
|
case "address":
|
||||||
|
typ.Kind = reflect.Array
|
||||||
|
typ.Type = address_t
|
||||||
|
typ.Size = 20
|
||||||
|
typ.T = AddressTy
|
||||||
|
case "string":
|
||||||
|
typ.Kind = reflect.String
|
||||||
|
typ.Type = reflect.TypeOf("")
|
||||||
|
typ.T = StringTy
|
||||||
|
case "bytes":
|
||||||
|
if varSize == 0 {
|
||||||
|
typ.T = BytesTy
|
||||||
|
typ.Kind = reflect.Slice
|
||||||
|
typ.Type = reflect.SliceOf(reflect.TypeOf(byte(0)))
|
||||||
|
} else {
|
||||||
|
typ.T = FixedBytesTy
|
||||||
|
typ.Kind = reflect.Array
|
||||||
|
typ.Size = varSize
|
||||||
|
typ.Type = reflect.ArrayOf(varSize, reflect.TypeOf(byte(0)))
|
||||||
|
}
|
||||||
|
case "function":
|
||||||
|
typ.Kind = reflect.Array
|
||||||
|
typ.T = FunctionTy
|
||||||
|
typ.Size = 24
|
||||||
|
typ.Type = reflect.ArrayOf(24, reflect.TypeOf(byte(0)))
|
||||||
|
default:
|
||||||
|
return Type{}, fmt.Errorf("unsupported arg type: %s", t)
|
||||||
|
}
|
||||||
|
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
@ -79,7 +79,7 @@ func readBool(word []byte) (bool, error) {
|
|||||||
// This enforces that standard by always presenting it as a 24-array (address + sig = 24 bytes)
|
// This enforces that standard by always presenting it as a 24-array (address + sig = 24 bytes)
|
||||||
func readFunctionType(t Type, word []byte) (funcTy [24]byte, err error) {
|
func readFunctionType(t Type, word []byte) (funcTy [24]byte, err error) {
|
||||||
if t.T != FunctionTy {
|
if t.T != FunctionTy {
|
||||||
return [24]byte{}, fmt.Errorf("abi: invalid type in call to make function type byte array.")
|
return [24]byte{}, fmt.Errorf("abi: invalid type in call to make function type byte array")
|
||||||
}
|
}
|
||||||
if garbage := binary.BigEndian.Uint64(word[24:32]); garbage != 0 {
|
if garbage := binary.BigEndian.Uint64(word[24:32]); garbage != 0 {
|
||||||
err = fmt.Errorf("abi: got improperly encoded function type, got %v", word)
|
err = fmt.Errorf("abi: got improperly encoded function type, got %v", word)
|
||||||
@ -92,7 +92,7 @@ func readFunctionType(t Type, word []byte) (funcTy [24]byte, err error) {
|
|||||||
// through reflection, creates a fixed array to be read from
|
// through reflection, creates a fixed array to be read from
|
||||||
func readFixedBytes(t Type, word []byte) (interface{}, error) {
|
func readFixedBytes(t Type, word []byte) (interface{}, error) {
|
||||||
if t.T != FixedBytesTy {
|
if t.T != FixedBytesTy {
|
||||||
return nil, fmt.Errorf("abi: invalid type in call to make fixed byte array.")
|
return nil, fmt.Errorf("abi: invalid type in call to make fixed byte array")
|
||||||
}
|
}
|
||||||
// convert
|
// convert
|
||||||
array := reflect.New(t.Type).Elem()
|
array := reflect.New(t.Type).Elem()
|
||||||
|
Loading…
Reference in New Issue
Block a user