mirror of
https://gitlab.com/pulsechaincom/go-pulse.git
synced 2024-12-25 04:47:17 +00:00
00064ddcfb
* accounts/abi: implement new fackball functions In Solidity v0.6.0, the original fallback is separated into two different sub types: fallback and receive. This PR addes the support for parsing new format abi and the relevant abigen functionalities. * accounts/abi: fix unit tests * accounts/abi: minor fixes * accounts/abi, mobile: support jave binding * accounts/abi: address marius's comment * accounts/abi: Work around the uin64 conversion issue Co-authored-by: Guillaume Ballet <gballet@gmail.com>
273 lines
8.3 KiB
Go
273 lines
8.3 KiB
Go
// 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 (
|
|
"bytes"
|
|
"encoding/json"
|
|
"errors"
|
|
"fmt"
|
|
"io"
|
|
|
|
"github.com/ethereum/go-ethereum/common"
|
|
)
|
|
|
|
// 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
|
|
|
|
// Additional "special" functions introduced in solidity v0.6.0.
|
|
// It's separated from the original default fallback. Each contract
|
|
// can only define one fallback and receive function.
|
|
Fallback Method // Note it's also used to represent legacy fallback before v0.6.0
|
|
Receive Method
|
|
}
|
|
|
|
// 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
|
|
if name == "" {
|
|
// constructor
|
|
arguments, err := abi.Constructor.Inputs.Pack(args...)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return arguments, nil
|
|
}
|
|
method, exist := abi.Methods[name]
|
|
if !exist {
|
|
return nil, fmt.Errorf("method '%s' not found", name)
|
|
}
|
|
arguments, err := method.Inputs.Pack(args...)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
// Pack up the method ID too if not a constructor and return
|
|
return append(method.ID(), arguments...), nil
|
|
}
|
|
|
|
// Unpack output in v according to the abi specification
|
|
func (abi ABI) Unpack(v interface{}, name string, data []byte) (err error) {
|
|
// since there can't be naming collisions with contracts and events,
|
|
// we need to decide whether we're calling a method or an event
|
|
if method, ok := abi.Methods[name]; ok {
|
|
if len(data)%32 != 0 {
|
|
return fmt.Errorf("abi: improperly formatted output: %s - Bytes: [%+v]", string(data), data)
|
|
}
|
|
return method.Outputs.Unpack(v, data)
|
|
}
|
|
if event, ok := abi.Events[name]; ok {
|
|
return event.Inputs.Unpack(v, data)
|
|
}
|
|
return fmt.Errorf("abi: could not locate named method or event")
|
|
}
|
|
|
|
// UnpackIntoMap unpacks a log into the provided map[string]interface{}
|
|
func (abi ABI) UnpackIntoMap(v map[string]interface{}, name string, data []byte) (err error) {
|
|
// since there can't be naming collisions with contracts and events,
|
|
// we need to decide whether we're calling a method or an event
|
|
if method, ok := abi.Methods[name]; ok {
|
|
if len(data)%32 != 0 {
|
|
return fmt.Errorf("abi: improperly formatted output")
|
|
}
|
|
return method.Outputs.UnpackIntoMap(v, data)
|
|
}
|
|
if event, ok := abi.Events[name]; ok {
|
|
return event.Inputs.UnpackIntoMap(v, data)
|
|
}
|
|
return fmt.Errorf("abi: could not locate named method or event")
|
|
}
|
|
|
|
// UnmarshalJSON implements json.Unmarshaler interface
|
|
func (abi *ABI) UnmarshalJSON(data []byte) error {
|
|
var fields []struct {
|
|
Type string
|
|
Name string
|
|
Inputs []Argument
|
|
Outputs []Argument
|
|
|
|
// Status indicator which can be: "pure", "view",
|
|
// "nonpayable" or "payable".
|
|
StateMutability string
|
|
|
|
// Deprecated Status indicators, but removed in v0.6.0.
|
|
Constant bool // True if function is either pure or view
|
|
Payable bool // True if function is payable
|
|
|
|
// Event relevant indicator represents the event is
|
|
// declared as anonymous.
|
|
Anonymous bool
|
|
}
|
|
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,
|
|
|
|
// Note for constructor the `StateMutability` can only
|
|
// be payable or nonpayable according to the output of
|
|
// compiler. So constant is always false.
|
|
StateMutability: field.StateMutability,
|
|
|
|
// Legacy fields, keep them for backward compatibility
|
|
Constant: field.Constant,
|
|
Payable: field.Payable,
|
|
}
|
|
case "function":
|
|
name := field.Name
|
|
_, ok := abi.Methods[name]
|
|
for idx := 0; ok; idx++ {
|
|
name = fmt.Sprintf("%s%d", field.Name, idx)
|
|
_, ok = abi.Methods[name]
|
|
}
|
|
abi.Methods[name] = Method{
|
|
Name: name,
|
|
RawName: field.Name,
|
|
StateMutability: field.StateMutability,
|
|
Inputs: field.Inputs,
|
|
Outputs: field.Outputs,
|
|
|
|
// Legacy fields, keep them for backward compatibility
|
|
Constant: field.Constant,
|
|
Payable: field.Payable,
|
|
}
|
|
case "fallback":
|
|
// New introduced function type in v0.6.0, check more detail
|
|
// here https://solidity.readthedocs.io/en/v0.6.0/contracts.html#fallback-function
|
|
if abi.HasFallback() {
|
|
return errors.New("only single fallback is allowed")
|
|
}
|
|
abi.Fallback = Method{
|
|
Name: "",
|
|
RawName: "",
|
|
|
|
// The `StateMutability` can only be payable or nonpayable,
|
|
// so the constant is always false.
|
|
StateMutability: field.StateMutability,
|
|
IsFallback: true,
|
|
|
|
// Fallback doesn't have any input or output
|
|
Inputs: nil,
|
|
Outputs: nil,
|
|
|
|
// Legacy fields, keep them for backward compatibility
|
|
Constant: field.Constant,
|
|
Payable: field.Payable,
|
|
}
|
|
case "receive":
|
|
// New introduced function type in v0.6.0, check more detail
|
|
// here https://solidity.readthedocs.io/en/v0.6.0/contracts.html#fallback-function
|
|
if abi.HasReceive() {
|
|
return errors.New("only single receive is allowed")
|
|
}
|
|
if field.StateMutability != "payable" {
|
|
return errors.New("the statemutability of receive can only be payable")
|
|
}
|
|
abi.Receive = Method{
|
|
Name: "",
|
|
RawName: "",
|
|
|
|
// The `StateMutability` can only be payable, so constant
|
|
// is always true while payable is always false.
|
|
StateMutability: field.StateMutability,
|
|
IsReceive: true,
|
|
|
|
// Receive doesn't have any input or output
|
|
Inputs: nil,
|
|
Outputs: nil,
|
|
|
|
// Legacy fields, keep them for backward compatibility
|
|
Constant: field.Constant,
|
|
Payable: field.Payable,
|
|
}
|
|
case "event":
|
|
name := field.Name
|
|
_, ok := abi.Events[name]
|
|
for idx := 0; ok; idx++ {
|
|
name = fmt.Sprintf("%s%d", field.Name, idx)
|
|
_, ok = abi.Events[name]
|
|
}
|
|
abi.Events[name] = Event{
|
|
Name: name,
|
|
RawName: field.Name,
|
|
Anonymous: field.Anonymous,
|
|
Inputs: field.Inputs,
|
|
}
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// MethodById looks up a method by the 4-byte id
|
|
// returns nil if none found
|
|
func (abi *ABI) MethodById(sigdata []byte) (*Method, error) {
|
|
if len(sigdata) < 4 {
|
|
return nil, fmt.Errorf("data too short (%d bytes) for abi method lookup", len(sigdata))
|
|
}
|
|
for _, method := range abi.Methods {
|
|
if bytes.Equal(method.ID(), sigdata[:4]) {
|
|
return &method, nil
|
|
}
|
|
}
|
|
return nil, fmt.Errorf("no method with id: %#x", sigdata[:4])
|
|
}
|
|
|
|
// EventByID looks an event up by its topic hash in the
|
|
// ABI and returns nil if none found.
|
|
func (abi *ABI) EventByID(topic common.Hash) (*Event, error) {
|
|
for _, event := range abi.Events {
|
|
if bytes.Equal(event.ID().Bytes(), topic.Bytes()) {
|
|
return &event, nil
|
|
}
|
|
}
|
|
return nil, fmt.Errorf("no event with id: %#x", topic.Hex())
|
|
}
|
|
|
|
// HasFallback returns an indicator whether a fallback function is included.
|
|
func (abi *ABI) HasFallback() bool {
|
|
return abi.Fallback.IsFallback
|
|
}
|
|
|
|
// HasReceive returns an indicator whether a receive function is included.
|
|
func (abi *ABI) HasReceive() bool {
|
|
return abi.Receive.IsReceive
|
|
}
|