compiler

Documentation

Index

• func Compile(r io.Reader) ([]byte, error)
• func CompileAndSave(src string, o *Options) ([]byte, error)
• type ABI
• type DebugInfo
  • func CodeGen(info *buildInfo) ([]byte, *DebugInfo, error)
  • func CompileWithDebugInfo(r io.Reader) ([]byte, *DebugInfo, error)
• type DebugMethodName
  • func (d *DebugMethodName) MarshalJSON() ([]byte, error)
  • func (d *DebugMethodName) UnmarshalJSON(data []byte) error
• type DebugParam
  • func (d *DebugParam) MarshalJSON() ([]byte, error)
  • func (d *DebugParam) UnmarshalJSON(data []byte) error
• type DebugRange
  • func (d *DebugRange) MarshalJSON() ([]byte, error)
  • func (d *DebugRange) UnmarshalJSON(data []byte) error
• type DebugSeqPoint
  • func (d *DebugSeqPoint) MarshalJSON() ([]byte, error)
  • func (d *DebugSeqPoint) UnmarshalJSON(data []byte) error
• type Event
• type EventDebugInfo
• type Metadata
• type Method
• type MethodDebugInfo
• type Options

Functions

func Compile

func Compile(r io.Reader) ([]byte, error)

Compile compiles a Go program into bytecode that can run on the NEO virtual machine.

func CompileAndSave

func CompileAndSave(src string, o *Options) ([]byte, error)

CompileAndSave will compile and save the file to disk.

Types

type ABI

type ABI struct {
	Hash       util.Uint160 `json:"hash"`
	Metadata   Metadata     `json:"metadata"`
	EntryPoint string       `json:"entrypoint"`
	Functions  []Method     `json:"functions"`
	Events     []Event      `json:"events"`
}

ABI represents ABI contract info in compatible with NEO Blockchain Toolkit format

type DebugInfo

type DebugInfo struct {
	EntryPoint string            `json:"entrypoint"`
	Documents  []string          `json:"documents"`
	Methods    []MethodDebugInfo `json:"methods"`
	Events     []EventDebugInfo  `json:"events"`
}

DebugInfo represents smart-contract debug information.

func CodeGen

func CodeGen(info *buildInfo) ([]byte, *DebugInfo, error)

CodeGen compiles the program to bytecode.

func CompileWithDebugInfo

func CompileWithDebugInfo(r io.Reader) ([]byte, *DebugInfo, error)

CompileWithDebugInfo compiles a Go program into bytecode and emits debug info.

type DebugMethodName

type DebugMethodName struct {
	Namespace string
	Name      string
}

DebugMethodName is a combination of a namespace and name.

func (*DebugMethodName) MarshalJSON

func (d *DebugMethodName) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler interface.

func (*DebugMethodName) UnmarshalJSON

func (d *DebugMethodName) UnmarshalJSON(data []byte) error

UnmarshalJSON implements json.Unmarshaler interface.

type DebugParam

type DebugParam struct {
	Name string `json:"name"`
	Type string `json:"type"`
}

DebugParam represents variables's name and type.

func (*DebugParam) MarshalJSON

func (d *DebugParam) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler interface.

func (*DebugParam) UnmarshalJSON

func (d *DebugParam) UnmarshalJSON(data []byte) error

UnmarshalJSON implements json.Unmarshaler interface.

type DebugRange

type DebugRange struct {
	Start uint16
	End   uint16
}

DebugRange represents method's section in bytecode.

func (*DebugRange) MarshalJSON

func (d *DebugRange) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler interface.

func (*DebugRange) UnmarshalJSON

func (d *DebugRange) UnmarshalJSON(data []byte) error

UnmarshalJSON implements json.Unmarshaler interface.

type DebugSeqPoint

type DebugSeqPoint struct {
	// Opcode is an opcode's address.
	Opcode int
	// Document is an index of file where sequence point occurs.
	Document int
	// StartLine is the first line of the break-pointed statement.
	StartLine int
	// StartCol is the first column of the break-pointed statement.
	StartCol int
	// EndLine is the last line of the break-pointed statement.
	EndLine int
	// EndCol is the last column of the break-pointed statement.
	EndCol int
}

DebugSeqPoint represents break-point for debugger.

func (*DebugSeqPoint) MarshalJSON

func (d *DebugSeqPoint) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler interface.

func (*DebugSeqPoint) UnmarshalJSON

func (d *DebugSeqPoint) UnmarshalJSON(data []byte) error

UnmarshalJSON implements json.Unmarshaler interface.

type Event

type Event struct {
	Name       string       `json:"name"`
	Parameters []DebugParam `json:"parameters"`
}

Event represents ABI event's metadata.

type EventDebugInfo

type EventDebugInfo struct {
	ID string `json:"id"`
	// Name is a human-readable event name in a format "{namespace}-{name}".
	Name       string       `json:"name"`
	Parameters []DebugParam `json:"parameters"`
}

EventDebugInfo represents smart-contract's event debug information.

type Metadata

type Metadata struct {
	Author               string `json:"author"`
	Email                string `json:"email"`
	Version              string `json:"version"`
	Title                string `json:"title"`
	Description          string `json:"description"`
	HasStorage           bool   `json:"has-storage"`
	HasDynamicInvocation bool   `json:"has-dynamic-invoke"`
	IsPayable            bool   `json:"is-payable"`
}

Metadata represents ABI contract metadata

type Method

type Method struct {
	Name       string       `json:"name"`
	Parameters []DebugParam `json:"parameters"`
	ReturnType string       `json:"returntype"`
}

Method represents ABI method's metadata.

type MethodDebugInfo

type MethodDebugInfo struct {
	ID string `json:"id"`
	// Name is the name of the method together with the namespace it belongs to.
	Name DebugMethodName `json:"name"`
	// Range is the range of smart-contract's opcodes corresponding to the method.
	Range DebugRange `json:"range"`
	// Parameters is a list of method's parameters.
	Parameters []DebugParam `json:"params"`
	// ReturnType is method's return type.
	ReturnType string   `json:"return-type"`
	Variables  []string `json:"variables"`
	// SeqPoints is a map between source lines and byte-code instruction offsets.
	SeqPoints []DebugSeqPoint `json:"sequence-points"`
}

MethodDebugInfo represents smart-contract's method debug information.

type Options

type Options struct {
	// The extension of the output file default set to .avm
	Ext string

	// The name of the output file.
	Outfile string

	// The name of the output for debug info.
	DebugInfo string

	// The name of the output for application binary interface info.
	ABIInfo string

	// Contract metadata.
	ContractDetails *smartcontract.ContractDetails
}

Options contains all the parameters that affect the behaviour of the compiler.