abi

Documentation

Index

• func Decode(t *Type, input []byte) (interface{}, error)
• func DecodeStruct(t *Type, input []byte, out interface{}) error
• func Encode(v interface{}, t *Type) ([]byte, error)
• func EncodeTopic(t *Type, val interface{}) (ethgo.Hash, error)
• func ParseLog(args *Type, log *ethgo.Log) (map[string]interface{}, error)
• func ParseTopic(t *Type, topic ethgo.Hash) (interface{}, error)
• func ParseTopics(args *Type, topics []ethgo.Hash) ([]interface{}, error)
• func UnpackRevertError(b []byte) (string, error)
• type ABI
  • func MustNewABI(s string) *ABI
  • func NewABI(s string) (*ABI, error)
  • func NewABIFromList(humanReadableAbi []string) (*ABI, error)
  • func NewABIFromReader(r io.Reader) (*ABI, error)
  • func NewABIFromSlice(abi []compiler.AbiField) (*ABI, error)
  • func (a *ABI) GetMethod(name string) *Method
  • func (a *ABI) GetMethodBySignature(methodSignature string) *Method
  • func (a *ABI) UnmarshalJSON(data []byte) error
• type ABIEncoder
• type Error
  • func NewError(name string) (*Error, error)
• type Event
  • func MustNewEvent(name string) *Event
  • func NewEvent(name string) (*Event, error)
  • func NewEventFromType(name string, typ *Type) *Event
  • func (e *Event) ID() (res ethgo.Hash)
  • func (e *Event) Match(log *ethgo.Log) bool
  • func (e *Event) ParseLog(log *ethgo.Log) (map[string]interface{}, error)
  • func (e *Event) Sig() string
• type Kind
  • func (k Kind) String() string
• type Method
  • func MustNewMethod(name string) *Method
  • func NewMethod(name string) (*Method, error)
  • func (m *Method) Decode(data []byte) (map[string]interface{}, error)
  • func (m *Method) Encode(args interface{}) ([]byte, error)
  • func (m *Method) ID() []byte
  • func (m *Method) Sig() string
• type TupleElem
• type Type
  • func MustNewType(s string) *Type
  • func NewTupleType(inputs []*TupleElem) *Type
  • func NewTupleTypeFromFields(inputs []*compiler.IOField) (*Type, error)
  • func NewType(s string) (*Type, error)
  • func NewTypeFromField(arg *compiler.IOField) (*Type, error)
  • func (t *Type) Decode(input []byte) (interface{}, error)
  • func (t *Type) DecodeStruct(input []byte, out interface{}) error
  • func (t *Type) Elem() *Type
  • func (t *Type) Encode(v interface{}) ([]byte, error)
  • func (t *Type) Format(includeArgs bool) string
  • func (t *Type) GoType() reflect.Type
  • func (t *Type) InternalType() string
  • func (t *Type) Kind() Kind
  • func (t *Type) ParseLog(log *ethgo.Log) (map[string]interface{}, error)
  • func (t *Type) Size() int
  • func (t *Type) String() string
  • func (t *Type) TupleElems() []*TupleElem

Functions

func Decode

func Decode(t *Type, input []byte) (interface{}, error)

Decode decodes the input with a given type

func DecodeStruct

func DecodeStruct(t *Type, input []byte, out interface{}) error

DecodeStruct decodes the input with a type to a struct

func Encode

func Encode(v interface{}, t *Type) ([]byte, error)

Encode encodes a value

func EncodeTopic

func EncodeTopic(t *Type, val interface{}) (ethgo.Hash, error)

EncodeTopic encodes a topic

func ParseLog

func ParseLog(args *Type, log *ethgo.Log) (map[string]interface{}, error)

ParseLog parses an event log

func ParseTopic

func ParseTopic(t *Type, topic ethgo.Hash) (interface{}, error)

ParseTopic parses an individual topic

func ParseTopics

func ParseTopics(args *Type, topics []ethgo.Hash) ([]interface{}, error)

ParseTopics parses topics from a log event

func UnpackRevertError

func UnpackRevertError(b []byte) (string, error)

Types

type ABI

type ABI struct {
	Constructor        *Method
	Methods            map[string]*Method
	MethodsBySignature map[string]*Method
	Events             map[string]*Event
	Errors             map[string]*Error
}

ABI represents the ethereum abi format

func MustNewABI

func MustNewABI(s string) *ABI

MustNewABI returns a parsed ABI contract or panics if fails

func NewABI

func NewABI(s string) (*ABI, error)

NewABI returns a parsed ABI struct

func NewABIFromList

func NewABIFromList(humanReadableAbi []string) (*ABI, error)

func NewABIFromReader

func NewABIFromReader(r io.Reader) (*ABI, error)

NewABIFromReader returns an ABI object from a reader

func NewABIFromSlice

func NewABIFromSlice(abi []compiler.AbiField) (*ABI, error)

NewABIFromSlice returns a parsed ABI struct from a slice of ABI fields that represent the contract

func (*ABI) GetMethod

func (a *ABI) GetMethod(name string) *Method

func (*ABI) GetMethodBySignature

func (a *ABI) GetMethodBySignature(methodSignature string) *Method

func (*ABI) UnmarshalJSON

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

UnmarshalJSON implements json.Unmarshaler interface

type ABIEncoder

type ABIEncoder interface {
	// EncodeAbi contains logic for encoding arbitrary data into ABI format
	EncodeAbi() ([]byte, error)
	// DecodeAbi contains logic for decoding given ABI data
	DecodeAbi(b []byte) error
}

ABIEncoder declares functions that are encoding and decoding data to/from ABI format

type Error

type Error struct {
	Name   string
	Inputs *Type
}

Error is a solidity error object

func NewError

func NewError(name string) (*Error, error)

NewError creates a new solidity error object

type Event

type Event struct {
	Name      string
	Anonymous bool
	Inputs    *Type
}

Event is a triggered log mechanism

func MustNewEvent

func MustNewEvent(name string) *Event

MustNewEvent creates a new solidity event object or fails

func NewEvent

func NewEvent(name string) (*Event, error)

NewEvent creates a new solidity event object using the signature

func NewEventFromType

func NewEventFromType(name string, typ *Type) *Event

NewEventFromType creates a new solidity event object using the name and type

func (*Event) ID

func (e *Event) ID() (res ethgo.Hash)

ID returns the id of the event used during logs

func (*Event) Match

func (e *Event) Match(log *ethgo.Log) bool

Match checks wheter the log is from this event

func (*Event) ParseLog

func (e *Event) ParseLog(log *ethgo.Log) (map[string]interface{}, error)

ParseLog parses a log with this event

func (*Event) Sig

func (e *Event) Sig() string

Sig returns the signature of the event

type Kind

type Kind int

Kind represents the kind of abi type

const (
	// KindBool is a boolean
	KindBool Kind = iota

	// KindUInt is an uint
	KindUInt

	// KindInt is an int
	KindInt

	// KindString is a string
	KindString

	// KindArray is an array
	KindArray

	// KindSlice is a slice
	KindSlice

	// KindAddress is an address
	KindAddress

	// KindBytes is a bytes array
	KindBytes

	// KindFixedBytes is a fixed bytes
	KindFixedBytes

	// KindFixedPoint is a fixed point
	KindFixedPoint

	// KindTuple is a tuple
	KindTuple

	// KindFunction is a function
	KindFunction
)

func (Kind) String

func (k Kind) String() string

type Method

type Method struct {
	Name    string
	Const   bool
	Inputs  *Type
	Outputs *Type
}

Method is a callable function in the contract

func MustNewMethod

func MustNewMethod(name string) *Method

MustNewMethod creates a new solidity method object or fails

func NewMethod

func NewMethod(name string) (*Method, error)

func (*Method) Decode

func (m *Method) Decode(data []byte) (map[string]interface{}, error)

Decode decodes the output with this function

func (*Method) Encode

func (m *Method) Encode(args interface{}) ([]byte, error)

Encode encodes the inputs with this function

func (*Method) ID

func (m *Method) ID() []byte

ID returns the id of the method

func (*Method) Sig

func (m *Method) Sig() string

Sig returns the signature of the method

type TupleElem

type TupleElem struct {
	Name    string
	Elem    *Type
	Indexed bool
}

TupleElem is an element of a tuple

type Type

type Type struct {
	// contains filtered or unexported fields
}

Type is an ABI type

func MustNewType

func MustNewType(s string) *Type

MustNewType parses a type in string format or panics if its invalid

func NewTupleType

func NewTupleType(inputs []*TupleElem) *Type

func NewTupleTypeFromFields

func NewTupleTypeFromFields(inputs []*compiler.IOField) (*Type, error)

func NewType

func NewType(s string) (*Type, error)

NewType parses a type in string format

func NewTypeFromField

func NewTypeFromField(arg *compiler.IOField) (*Type, error)

NewTypeFromField parses an abi type from an argument

func (*Type) Decode

func (t *Type) Decode(input []byte) (interface{}, error)

Decode decodes an object using this type

func (*Type) DecodeStruct

func (t *Type) DecodeStruct(input []byte, out interface{}) error

DecodeStruct decodes an object using this type to the out param

func (*Type) Elem

func (t *Type) Elem() *Type

Elem returns the elem value for slice and arrays

func (*Type) Encode

func (t *Type) Encode(v interface{}) ([]byte, error)

Encode encodes an object using this type

func (*Type) Format

func (t *Type) Format(includeArgs bool) string

String returns the raw representation of the type

func (*Type) GoType

func (t *Type) GoType() reflect.Type

GoType returns the go type

func (*Type) InternalType

func (t *Type) InternalType() string

InternalType returns the internal type

func (*Type) Kind

func (t *Type) Kind() Kind

Kind returns the kind of the type

func (*Type) ParseLog

func (t *Type) ParseLog(log *ethgo.Log) (map[string]interface{}, error)

ParseLog parses a log using this type

func (*Type) Size

func (t *Type) Size() int

Size returns the size of the type

func (*Type) String

func (t *Type) String() string

func (*Type) TupleElems

func (t *Type) TupleElems() []*TupleElem

TupleElems returns the elems of the tuple