abi

README

refer:

• go-ethereum/accounts/abi/ GNU Lesser General Public License v3.0
• go-vite/vm/abi/ GNU General Public License v3.0

Documentation

Index

• Constants
• func U256(n *big.Int) []byte
• type ABIContract
  • func JSONToABIContract(reader io.Reader) (ABIContract, error)
  • func ModuleToABIContract(code []byte) (ABIContract, error)
  • func (abi *ABIContract) MethodById(sigdata []byte) (*Method, error)
  • func (abi ABIContract) PackMethod(name string, args ...interface{}) ([]byte, error)
  • func (abi ABIContract) PackVariable(name string, args ...interface{}) ([]byte, error)
  • func (abi *ABIContract) UnmarshalJSON(data []byte) error
  • func (abi ABIContract) UnpackEvent(v interface{}, name string, output []byte) (err error)
  • func (abi ABIContract) UnpackMethod(v interface{}, name string, output []byte) (err error)
  • func (abi ABIContract) UnpackVariable(v interface{}, name string, output []byte) (err error)
• type Argument
  • func (argument *Argument) UnmarshalJSON(data []byte) error
• type Arguments
  • func (arguments Arguments) LengthNonIndexed() int
  • func (arguments Arguments) NonIndexed() Arguments
  • func (arguments Arguments) Pack(args ...interface{}) ([]byte, error)
  • func (arguments Arguments) PackValues(args []interface{}) ([]byte, error)
  • func (arguments Arguments) Unpack(v interface{}, data []byte) error
  • func (arguments Arguments) UnpackValues(data []byte) ([]interface{}, error)
• type Event
  • func (e Event) Id() types.Hash
  • func (e Event) String() string
• type Method
  • func (method Method) Id() []byte
  • func (method Method) Sig() string
  • func (method Method) String() string
• type Type
  • func NewType(t string) (typ Type, err error)
  • func (t Type) String() (out string)
• type Variable
  • func (v Variable) String() string

Constants

const (
	IntTy byte = iota
	UintTy
	BoolTy
	StringTy
	SliceTy
	ArrayTy
	AddressTy
	TokenIdTy
	FixedBytesTy
	BytesTy
	HashTy
	FunctionTy
	BalanceTy
	SignatureTy
)

Type enumerator

Functions

func U256

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

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

Types

type ABIContract

type ABIContract struct {
	Constructor Method
	Methods     map[string]Method
	Events      map[string]Event
	Variables   map[string]Variable
}

The ABIContract 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 JSONToABIContract

func JSONToABIContract(reader io.Reader) (ABIContract, error)

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

func ModuleToABIContract

func ModuleToABIContract(code []byte) (ABIContract, error)

TODO: implement

func (*ABIContract) MethodById

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

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

func (ABIContract) PackMethod

func (abi ABIContract) PackMethod(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 (ABIContract) PackVariable

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

func (*ABIContract) UnmarshalJSON

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

UnmarshalJSON implements json.Unmarshaler interface

func (ABIContract) UnpackEvent

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

UnpackEvent output in v according to the abi specification

func (ABIContract) UnpackMethod

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

UnpackMethod output in v according to the abi specification

func (ABIContract) UnpackVariable

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

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) 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 VM'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() types.Hash

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

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

type Variable

type Variable struct {
	Name   string
	Inputs Arguments
}

Variable is used only in precompiled contracts

func (Variable) String

func (v Variable) String() string