abi

package
v1.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 24, 2023 License: Apache-2.0 Imports: 16 Imported by: 4

Documentation

Overview

Package abi implements the Ethereum ABI (Application Binary Interface).

The Ethereum ABI is strongly typed, known at compile time and static. This ABI will handle basic type casting; unsigned to signed and visa versa. It does not handle slice casting such as unsigned slice to signed slice. Bit size type casting is also handled. ints with a bit size of 32 will be properly cast to int256, etc.

Index

Examples

Constants

View Source 
const (
	IntTy byte = iota
	UintTy
	BoolTy
	StringTy
	SliceTy
	ArrayTy
	AddressTy
	FixedBytesTy
	BytesTy
	HashTy
	FixedPointTy
	FunctionTy
)

Type enumerator

View Source 
const UNIT = 64

Variables

This section is empty.

Functions

func ByteArrayToString 

func ByteArrayToString(v interface{}) (string, error)

ByteArrayToString transfer a byte array to string

func FuncSelector 

func FuncSelector(funcName string, argsType []string) string

FuncSelector convert func and args to ABI set(uint256) -> 60fe47b1

func TypeConversion 

func TypeConversion(gvalue string, gtype string) string

TypeConversion conversion go type to binary

func U256 

func U256(n *big.Int) []byte

U256 converts a big Int into a 256bit EVM number.

Types

type ABI 

type ABI struct {
	Constructor Method
	Methods     map[string]Method
	Events      map[string]Event
	// contains filtered or unexported fields
}

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.

func JSON 

func JSON(reader io.Reader) (ABI, error)

JSON returns a parsed ABI interface and error if it failed.

Example 
const definition = `[{"constant":true,"inputs":[{"name":"","type":"address"}],"name":"isBar","outputs":[{"name":"","type":"bool"}],"type":"function"}]`

abi, err := JSON(strings.NewReader(definition))
if err != nil {
	log.Fatalln(err)
}
out, err := abi.Pack("isBar", common.HexToAddress("01"))
if err != nil {
	log.Fatalln(err)
}

fmt.Printf("%x\n", out)

Output:

1f2c40920000000000000000000000000000000000000000000000000000000000000001

func (ABI) Decode 

func (abi ABI) Decode(funcName string, result []byte) (interface{}, error)

funcName is the function name of contract result is the return value of invocation solidity contract

func (ABI) Encode 

func (abi ABI) Encode(funcName string, args ...interface{}) ([]byte, error)

funcName is the function name of contract args is the arguments of function, should be string or []interface{}

func (ABI) GetEvent 

func (abi ABI) GetEvent(eventSig string) (*Event, error)

GetEvent is used to get event using event signature

func (ABI) GetMethod 

func (abi ABI) GetMethod(methodSig string) (*Method, error)

GetMethod is used to get method using method signature

func (ABI) GetPayload 

func (abi ABI) GetPayload(funcName string, args ...string) string

GetPayload is used to convert func and args to binary

func (*ABI) MethodById 

func (abi *ABI) MethodById(sigdata []byte) (*Method, error)

MethodById looks up a method by the 4-byte id returns nil if none found

func (ABI) Pack 

func (abi ABI) Pack(name string, args ...interface{}) ([]byte, error)

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) UnmarshalJSON 

func (abi *ABI) UnmarshalJSON(data []byte) error

UnmarshalJSON implements json.Unmarshaler interface

func (ABI) Unpack 

func (abi ABI) Unpack(v interface{}, name string, output []byte) (err error)

Unpack output in v according to the abi specification

func (*ABI) UnpackInput 

func (abi *ABI) UnpackInput(v interface{}, methodName string, data []byte) (err error)

UnpackInput unpack method input

func (*ABI) UnpackInputWithoutMethod 

func (abi *ABI) UnpackInputWithoutMethod(v interface{}, data []byte) (err error)

UnpackInputWithoutMethod unpack input

func (ABI) UnpackLog 

func (abi ABI) UnpackLog(v interface{}, name string, data string, topics []string) (err error)

Unpack log output in v according to the abi specification param data means the Data field of TxLog, params topics means the Topics field of TxLog

warn: try to decode a dynamic type indexed event param(like: bytes in solidity) will cause panic

func (*ABI) UnpackResult 

func (abi *ABI) UnpackResult(v interface{}, name, data string) (err error)

UnpackResult use abi to decode data from solidity return

type Argument 

type Argument struct {
	Name    string
	Type    Type
	Indexed bool // indexed is only used by events
}

Argument holds the name of the argument and the corresponding type. Types are used when packing and testing arguments.

func (*Argument) UnmarshalJSON 

func (argument *Argument) UnmarshalJSON(data []byte) error

UnmarshalJSON implements json.Unmarshaler interface

type Arguments 

type Arguments []Argument

func (Arguments) Indexed 

func (arguments Arguments) Indexed() Arguments

NonIndexed returns the arguments with indexed arguments filtered out

func (Arguments) LengthNonIndexed 

func (arguments Arguments) LengthNonIndexed() int

LengthNonIndexed returns the number of arguments when not counting 'indexed' ones. Only events can ever have 'indexed' arguments, it should always be false on arguments for method input/output

func (Arguments) NonIndexed 

func (arguments Arguments) NonIndexed() Arguments

NonIndexed returns the arguments with indexed arguments filtered out

func (Arguments) Pack 

func (arguments Arguments) Pack(args ...interface{}) ([]byte, error)

Pack performs the operation Go format -> Hexdata

func (Arguments) PackValues 

func (arguments Arguments) PackValues(args []interface{}) ([]byte, error)

PackValues performs the operation Go format -> Hexdata It is the semantic opposite of UnpackValues

func (Arguments) Unpack 

func (arguments Arguments) Unpack(v interface{}, data []byte) error

Unpack performs the operation hexdata -> Go format

func (Arguments) UnpackValues 

func (arguments Arguments) UnpackValues(data []byte) ([]interface{}, error)

UnpackValues can be used to unpack ABI-encoded hexdata according to the ABI-specification, without supplying a struct to unpack into. Instead, this method returns a list containing the values. An atomic argument will be a list with one element.

type Event 

type Event struct {
	Name      string
	Anonymous bool
	Inputs    Arguments
}

Event is an event potentially triggered by the EVM's LOG mechanism. The Event holds type information (inputs) about the yielded output. Anonymous events don't get the signature canonical representation as the first LOG topic.

func (Event) Id 

func (e Event) Id() common.Hash

Id returns the canonical representation of the event's signature used by the abi definition to identify event names and types.

func (Event) Sig 

func (e Event) Sig() string

func (Event) String 

func (e Event) String() string

type Method 

type Method struct {
	Name    string
	Const   bool
	Inputs  Arguments
	Outputs Arguments
}

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 particular Method call. It can easily be simulated using a local VM. For example a `Balance()` method only needs to retrieve something from the storage and therefor requires no Tx to be send to the network. A method such as `Transact` does require a Tx and thus will be flagged `true`. Input specifies the required input parameters for this gives method.

func (Method) Id 

func (method Method) Id() []byte

func (Method) Sig 

func (method Method) Sig() string

Sig returns the methods string signature according to the ABI spec.

Example 

function foo(uint32 a, int b)    =    "foo(uint32,int256)"

Please note that "int" is substitute for its canonical representation "int256"

func (Method) String 

func (method Method) String() string

type Type 

type Type struct {
	Elem *Type

	Kind reflect.Kind
	Type reflect.Type
	Size int
	T    byte // Our own type checking
	// contains filtered or unexported fields
}

Type is the reflection of the supported argument type

func NewType 

func NewType(t string) (typ Type, err error)

NewType creates a new reflection type of abi type given in t.

func (Type) String 

func (t Type) String() (out string)

String implements Stringer

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.