template

Documentation

Index

• type Contract
• type Data
• type Event
• type Field
• type Method
• type Struct

Types

type Contract

type Contract struct {
	Type        string // Type name of the main contract binding
	Address     string
	TxHash      string
	CreatedAt   string
	InputABI    string             // JSON ABI used as the input to generate the binding from
	Constructor abi.Method         // Contract constructor for deploy parametrization
	Calls       map[string]*Method // Contract calls that only read state data
	Transacts   map[string]*Method // Contract calls that write state data
	Events      map[string]*Event  // Contract events accessors
	Libraries   map[string]string  // Same as Data, but filtered to only keep what the contract needs
	Structs     map[string]*Struct // Contract struct type definitions
	Library     bool
}

Contract contains the data needed to generate an individual contract binding.

type Data

type Data struct {
	Package  string            // Name of the package to place the generated file in
	Imports  map[string]string // List of custom imports to push into this file
	Contract *Contract         // List of contracts to generate into this file
}

Data is the data structure required to fill the binding template.

type Event

type Event struct {
	Original   abi.Event // Original event as parsed by the abi package
	Normalized abi.Event // Normalized version of the parsed fields
}

Event is a wrapper around an a

type Field

type Field struct {
	Type    string   // Field type representation depends on target binding language
	Name    string   // Field name converted from the raw user-defined field name
	SolKind abi.Type // Raw abi type information
}

Field is a wrapper around a struct field with binding language struct type definition and relative filed name.

type Method

type Method struct {
	Original   abi.Method // Original method as parsed by the abi package
	Normalized abi.Method // Normalized version of the parsed method (capitalized names, non-anonymous args/returns)
	Structured bool       // Whether the returns should be accumulated into a struct
}

Method is a wrapper around an abi.Method that contains a few preprocessed and cached data fields.

type Struct

type Struct struct {
	Name   string   // Auto-generated struct name(We can't obtain the raw struct name through abi)
	Fields []*Field // Struct fields definition depends on the binding language.
}

Struct is a wrapper around an abi.tuple contains a auto-generated struct name.