types

Documentation

Index

• type Event
  • func NewEvent(e abi.Event) Event
  • func (e Event) Sig() common.Hash
• type Field
• type Log
• type Method
  • func NewMethod(m abi.Method) Method
  • func (m Method) Sig() common.Hash
• type Mode
  • func (mode Mode) IsValid() bool
  • func (mode Mode) String() string
• type Result

Types

type Event

type Event struct {
	Name      string
	Anonymous bool
	Fields    []Field
}

Event is our custom event type

func NewEvent

func NewEvent(e abi.Event) Event

NewEvent unpacks abi.Event into our custom Event struct

func (Event) Sig

func (e Event) Sig() common.Hash

Sig returns the hash signature for an event

type Field

type Field struct {
	abi.Argument        // Name, Type, Indexed
	PgType       string // Holds type used when committing data held in this field to postgres
}

Field is our custom event field type which associates a postgres type with the field

type Log

type Log struct {
	ID     int64             // VulcanizeIdLog for full sync and header ID for header sync contract watcher
	Values map[string]string // Map of event input names to their values

	// Used for full sync only
	Block int64
	Tx    string

	// Used for headerSync only
	LogIndex         uint
	TransactionIndex uint
	Raw              []byte // json.Unmarshalled byte array of geth/core/types.Log{}
}

Log is used to hold instance of an event log data

type Method

type Method struct {
	Name   string
	Const  bool
	Args   []Field
	Return []Field
}

Method is our custom method struct

func NewMethod

func NewMethod(m abi.Method) Method

NewMethod unpacks abi.Method into our custom Method struct

func (Method) Sig

func (m Method) Sig() common.Hash

Sig returns the hash signature for the method

type Mode

type Mode int

Mode is used to explicitly represent the operating mode of the transformer

const (
	HeaderSync Mode = iota
	FullSync
)

Mode enums

func (Mode) IsValid

func (mode Mode) IsValid() bool

IsValid returns true is the Mode is valid

func (Mode) String

func (mode Mode) String() string

String returns the string representation of the mode

type Result

type Result struct {
	Method
	Inputs []interface{} // Will only use addresses
	Output interface{}
	PgType string // Holds output pg type
	Block  int64
}

Result is used to hold instance of result from method call with given inputs and block