abi

package
v0.24.0 Latest Latest
Warning

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

 Go to latest Published: Feb 27, 2019 License: Apache-2.0 Imports: 19 Imported by: 0

Documentation

Index

Constants

View Source 
const ElementSize = 32

EVM Solidity calls and return values are packed into pieces of 32 bytes, including a bool (wasting 255 out of 256 bits)

View Source 
const EventIDSize = 32
View Source 
const FunctionIDSize = 4

Variables

This section is empty.

Functions

func EncodeFunctionCall added in v0.24.0 

func EncodeFunctionCall(abiData, funcName string, args ...string) ([]byte, bool, error)

EncodeFunctionCall ABI encodes a function call based on ABI in string abiData and the arguments specified as strings. The fname specifies which function should called, if it doesn't exist exist the fallback function will be called. If fname is the empty string, the constructor is called. The arguments must be specified in args. The count must match the function being called. Returns the ABI encoded function call, whether the function is constant according to the ABI (which means it does not modified contract state)

func EncodeFunctionCallFromFile added in v0.24.0 

func EncodeFunctionCallFromFile(abiFileName, abiPath, funcName string, args []string) ([]byte, bool, error)

EncodeFunctionCallFromFile ABI encodes a function call based on ABI in file, and the arguments specified as strings. The abiFileName specifies the name of the ABI file, and abiPath the path where it can be found. The fname specifies which function should called, if it doesn't exist exist the fallback function will be called. If fname is the empty string, the constructor is called. The arguments must be specified in args. The count must match the function being called. Returns the ABI encoded function call, whether the function is constant according to the ABI (which means it does not modified contract state)

func GetPackingTypes added in v0.20.1 

func GetPackingTypes(args []Argument) []interface{}

func Pack added in v0.20.1 

func Pack(argSpec []Argument, args ...interface{}) ([]byte, error)

func PackIntoStruct added in v0.20.1 

func PackIntoStruct(argSpec []Argument, st interface{}) ([]byte, error)

func Signature added in v0.23.0 

func Signature(name string, args []Argument) (sig string)

func Unpack added in v0.20.1 

func Unpack(argSpec []Argument, data []byte, args ...interface{}) error

func UnpackEvent added in v0.22.0 

func UnpackEvent(eventSpec *EventSpec, topics []burrow_binary.Word256, data []byte, args ...interface{}) error

* Given a eventSpec, get all the fields (topic fields or not)

func UnpackIntoStruct added in v0.20.1 

func UnpackIntoStruct(argSpec []Argument, data []byte, st interface{}) error

func UnpackRevert added in v0.22.0 

func UnpackRevert(data []byte) (message *string, err error)

UnpackRevert decodes the revert reason if a contract called revert. If no reason was given, message will be nil else it will point to the string

Types

type AbiSpec added in v0.20.1 

type AbiSpec struct {
	Constructor FunctionSpec
	Fallback    FunctionSpec
	Functions   map[string]FunctionSpec
	Events      map[string]EventSpec
	EventsById  map[EventID]EventSpec
}
var RevertAbi *AbiSpec

RevertAbi exists to decode reverts. Any contract function call fail using revert(), assert() or require(). If a function exits this way, the this hardcoded ABI will be used.

func LoadPath added in v0.24.0 

func LoadPath(abiFileOrDir string) (*AbiSpec, error)

LoadPath loads one abi file or finds all files in a directory

func MergeAbiSpec added in v0.23.0 

func MergeAbiSpec(abiSpec []*AbiSpec) *AbiSpec

MergeAbiSpec takes multiple AbiSpecs and merges them into once structure. Note that the same function name or event name can occur in different abis, so there might be some information loss.

func ReadAbiSpec added in v0.20.1 

func ReadAbiSpec(specBytes []byte) (*AbiSpec, error)

func ReadAbiSpecFile added in v0.20.1 

func ReadAbiSpecFile(filename string) (*AbiSpec, error)

func (*AbiSpec) Pack added in v0.20.1 

func (abiSpec *AbiSpec) Pack(fname string, args ...interface{}) ([]byte, bool, error)

Pack ABI encodes a function call. The fname specifies which function should called, if it doesn't exist exist the fallback function will be called. If fname is the empty string, the constructor is called. The arguments must be specified in args. The count must match the function being called. Returns the ABI encoded function call, whether the function is constant according to the ABI (which means it does not modified contract state)

func (*AbiSpec) Unpack added in v0.22.0 

func (abiSpec *AbiSpec) Unpack(data []byte, fname string, args ...interface{}) error

func (*AbiSpec) UnpackWithID added in v0.22.0 

func (abiSpec *AbiSpec) UnpackWithID(data []byte, args ...interface{}) error

type AbiSpecJSON added in v0.20.1 

type AbiSpecJSON struct {
	Name            string
	Type            string
	Inputs          []ArgumentJSON
	Outputs         []ArgumentJSON
	Constant        bool
	Payable         bool
	StateMutability string
	Anonymous       bool
}

type Argument added in v0.20.1 

type Argument struct {
	Name        string
	EVM         EVMType
	IsArray     bool
	Indexed     bool
	Hashed      bool
	ArrayLength uint64
}

func EVMTypeFromReflect added in v0.20.1 

func EVMTypeFromReflect(v reflect.Type) Argument

type ArgumentJSON added in v0.20.1 

type ArgumentJSON struct {
	Name       string
	Type       string
	Components []ArgumentJSON
	Indexed    bool
}

type EVMAddress added in v0.20.1 

type EVMAddress struct {
}

func (EVMAddress) Dynamic added in v0.24.0 

func (e EVMAddress) Dynamic() bool

func (EVMAddress) GetSignature added in v0.20.1 

func (e EVMAddress) GetSignature() string

type EVMBool added in v0.20.1 

type EVMBool struct {
}

func (EVMBool) Dynamic added in v0.24.0 

func (e EVMBool) Dynamic() bool

func (EVMBool) GetSignature added in v0.20.1 

func (e EVMBool) GetSignature() string

type EVMBytes added in v0.20.1 

type EVMBytes struct {
	M uint64
}

func (EVMBytes) Dynamic added in v0.24.0 

func (e EVMBytes) Dynamic() bool

func (EVMBytes) GetSignature added in v0.20.1 

func (e EVMBytes) GetSignature() string

type EVMFixed added in v0.20.1 

type EVMFixed struct {
	N, M uint64
	// contains filtered or unexported fields
}

func (EVMFixed) Dynamic added in v0.24.0 

func (e EVMFixed) Dynamic() bool

func (EVMFixed) GetSignature added in v0.20.1 

func (e EVMFixed) GetSignature() string

type EVMInt added in v0.20.1 

type EVMInt struct {
	M uint64
}

func (EVMInt) Dynamic added in v0.24.0 

func (e EVMInt) Dynamic() bool

func (EVMInt) GetSignature added in v0.20.1 

func (e EVMInt) GetSignature() string

type EVMString added in v0.20.1 

type EVMString struct {
}

func (EVMString) Dynamic added in v0.24.0 

func (e EVMString) Dynamic() bool

func (EVMString) GetSignature added in v0.20.1 

func (e EVMString) GetSignature() string

type EVMType added in v0.20.1 

type EVMType interface {
	GetSignature() string

	Dynamic() bool
	// contains filtered or unexported methods
}

type EVMUint added in v0.20.1 

type EVMUint struct {
	M uint64
}

func (EVMUint) Dynamic added in v0.24.0 

func (e EVMUint) Dynamic() bool

func (EVMUint) GetSignature added in v0.20.1 

func (e EVMUint) GetSignature() string

type EventID added in v0.23.0 

type EventID [EventIDSize]byte

func GetEventID added in v0.23.0 

func GetEventID(signature string) (id EventID)

func (EventID) Bytes added in v0.23.0 

func (fs EventID) Bytes() []byte

type EventSpec added in v0.23.0 

type EventSpec struct {
	EventID   EventID
	Inputs    []Argument
	Name      string
	Anonymous bool
}

type FunctionID 

type FunctionID [FunctionIDSize]byte

func GetFunctionID added in v0.20.1 

func GetFunctionID(signature string) (id FunctionID)

func (FunctionID) Bytes added in v0.20.1 

func (fs FunctionID) Bytes() []byte

type FunctionSpec added in v0.20.1 

type FunctionSpec struct {
	FunctionID FunctionID
	Constant   bool
	Inputs     []Argument
	Outputs    []Argument
}

func SpecFromFunctionReflect added in v0.20.1 

func SpecFromFunctionReflect(fname string, v reflect.Value, skipIn, skipOut int) *FunctionSpec

func SpecFromStructReflect added in v0.20.1 

func SpecFromStructReflect(fname string, args reflect.Type, rets reflect.Type) *FunctionSpec

SpecFromStructReflect generates a FunctionSpec where the arguments and return values are described a struct. Both args and rets should be set to the return value of reflect.TypeOf() with the respective struct as an argument.

func (*FunctionSpec) SetFunctionID added in v0.20.1 

func (functionSpec *FunctionSpec) SetFunctionID(functionName string)

type Variable added in v0.20.1 

type Variable struct {
	Name  string
	Value string
}

Variable exist to unpack return values into, so have both the return value and its name

func DecodeFunctionReturnFromFile added in v0.24.0 

func DecodeFunctionReturnFromFile(abiLocation, binPath, funcName string, resultRaw []byte) ([]*Variable, error)

DecodeFunctionReturnFromFile ABI decodes the return value from a contract function call.

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.