binding

Documentation

Index

• func Generate(cfg Config) error
• type Config
  • func NewConfig() Config
• type ContractTmpl
  • func TemplateFromManifest(cfg Config, ...) ContractTmpl
• type ExtendedType
• type FieldExtendedType
• type MethodTmpl
• type Override
  • func NewOverrideFromString(s string) Override
  • func (o Override) MarshalYAML() (interface{}, error)
  • func (o *Override) UnmarshalYAML(unmarshal func(interface{}) error) error
• type ParamTmpl

Functions

func Generate

func Generate(cfg Config) error

Generate writes Go file containing smartcontract bindings to the `cfg.Output`. It doesn't check manifest from Config for validity, incorrect manifest can lead to unexpected results.

Types

type Config

type Config struct {
	Package    string                       `yaml:"package,omitempty"`
	Manifest   *manifest.Manifest           `yaml:"-"`
	Hash       util.Uint160                 `yaml:"hash,omitempty"`
	Overrides  map[string]Override          `yaml:"overrides,omitempty"`
	CallFlags  map[string]callflag.CallFlag `yaml:"callflags,omitempty"`
	NamedTypes map[string]ExtendedType      `yaml:"namedtypes,omitempty"`
	Types      map[string]ExtendedType      `yaml:"types,omitempty"`
	Output     io.Writer                    `yaml:"-"`
}

Config contains parameter for the generated binding.

func NewConfig

func NewConfig() Config

NewConfig initializes and returns a new config instance.

type ContractTmpl

type ContractTmpl struct {
	PackageName  string
	ContractName string
	Imports      []string
	Hash         string
	Methods      []MethodTmpl
}

func TemplateFromManifest

func TemplateFromManifest(cfg Config, scTypeConverter func(string, smartcontract.ParamType, *Config) (string, string)) ContractTmpl

TemplateFromManifest create a contract template using the given configuration and type conversion function. It assumes manifest to be present in the configuration and assumes it to be correct (passing IsValid check).

type ExtendedType

type ExtendedType struct {
	Base      smartcontract.ParamType `yaml:"base"`
	Name      string                  `yaml:"name,omitempty"`      // Structure name, omitted for arrays, interfaces and maps.
	Interface string                  `yaml:"interface,omitempty"` // Interface type name, "iterator" only for now.
	Key       smartcontract.ParamType `yaml:"key,omitempty"`       // Key type (only simple types can be used for keys) for maps.
	Value     *ExtendedType           `yaml:"value,omitempty"`     // Value type for iterators and arrays.
	Fields    []FieldExtendedType     `yaml:"fields,omitempty"`    // Ordered type data for structure fields.
}

type FieldExtendedType

type FieldExtendedType struct {
	Field        string `yaml:"field"`
	ExtendedType `yaml:",inline"`
}

type MethodTmpl

type MethodTmpl struct {
	Name       string
	NameABI    string
	CallFlag   string
	Comment    string
	Arguments  []ParamTmpl
	ReturnType string
}

type Override

type Override struct {
	// Package contains a fully-qualified package name.
	Package string
	// TypeName contains type name together with a package alias.
	TypeName string
}

Override contains a package and a type to replace manifest method parameter type with.

func NewOverrideFromString

func NewOverrideFromString(s string) Override

NewOverrideFromString parses s and returns method parameter type override spec.

func (Override) MarshalYAML

func (o Override) MarshalYAML() (interface{}, error)

MarshalYAML implements the YAML marshaler interface.

func (*Override) UnmarshalYAML

func (o *Override) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements the YAML Unmarshaler interface.

type ParamTmpl

type ParamTmpl struct {
	Name string
	Type string
}