model

Documentation

Index

• Constants
• Variables
• type DefElt
• type DefEltList
  • func (l DefEltList) Len() int
  • func (l DefEltList) Less(i, j int) bool
  • func (l DefEltList) Swap(i, j int)
• type DefMap
  • func (m DefMap) ToStringMap() StringMap
• type DefMapMap
  • func (m DefMapMap) ToStringMapMap() StringMapMap
• type DefNameMap
• type DefNameMapMap
• type Field
  • func (f *Field) Compile(s *Schema, fldNameDef, fldTypeDef *DefElt) error
• type FieldMap
• type Func
• type FuncDef
• type FuncDefMap
  • func (m FuncDefMap) ToRawFuncDefMap() RawFuncDefMap
• type FuncNameDefMap
• type JSONSchemaDef
• type RawFuncDef
• type RawFuncDefMap
  • func (m RawFuncDefMap) ToFuncDefMap() FuncDefMap
• type RawSchemaDef
  • func (s *RawSchemaDef) ToSchemaDef() *SchemaDef
• type Schema
  • func NewSchema() *Schema
  • func (s *Schema) Compile(schemaDef *SchemaDef) error
• type SchemaDef
  • func NewSchemaDef() *SchemaDef
  • func (s *SchemaDef) ToRawSchemaDef() *RawSchemaDef
• type StringMap
  • func (mm StringMap) ToDefMap() DefMap
• type StringMapMap
  • func (mm StringMapMap) ToDefMapMap() DefMapMap
• type Struct

Constants

const (
	DefaultVersion = "0.0.1"
)

Variables

var FieldTypes = map[string]bool{
	"Address":   true,
	"AgentID":   true,
	"BigInt":    true,
	"Bool":      true,
	"Bytes":     true,
	"ChainID":   true,
	"Hash":      true,
	"Hname":     true,
	"Int8":      true,
	"Int16":     true,
	"Int32":     true,
	"Int64":     true,
	"NftID":     true,
	"RequestID": true,
	"String":    true,
	"TokenID":   true,
	"Uint8":     true,
	"Uint16":    true,
	"Uint32":    true,
	"Uint64":    true,
}

Types

type DefElt

type DefElt struct {
	Val     string
	Comment string
	Line    int
}

type DefEltList

type DefEltList []DefElt

func (DefEltList) Len

func (l DefEltList) Len() int

func (DefEltList) Less

func (l DefEltList) Less(i, j int) bool

func (DefEltList) Swap

func (l DefEltList) Swap(i, j int)

type DefMap

type DefMap map[DefElt]*DefElt

func (DefMap) ToStringMap

func (m DefMap) ToStringMap() StringMap

type DefMapMap

type DefMapMap map[DefElt]*DefMap

func (DefMapMap) ToStringMapMap

func (m DefMapMap) ToStringMapMap() StringMapMap

type DefNameMap

type DefNameMap map[string]*DefElt

type DefNameMapMap

type DefNameMapMap map[string]*DefMap

type Field

type Field struct {
	Name       string // external name for this field
	Alias      string // internal name alias, can be different from Name
	Comment    string
	FldComment string
	IsArray    bool
	IsBaseType bool
	IsOptional bool
	Line       int // the line number originally in yaml file
	MapKey     string
	Type       string
}

func (*Field) Compile

func (f *Field) Compile(s *Schema, fldNameDef, fldTypeDef *DefElt) error

type FieldMap

type FieldMap map[string]*Field

type Func

type Func struct {
	Name    string
	Alias   string
	Access  DefElt
	Comment string
	Hname   isc.Hname
	Kind    string
	Line    int
	Params  []*Field
	Results []*Field
}

type FuncDef

type FuncDef struct {
	Access  DefElt
	Params  DefMap
	Results DefMap
	Line    int
	Comment string
}

type FuncDefMap

type FuncDefMap map[DefElt]*FuncDef

func (FuncDefMap) ToRawFuncDefMap

func (m FuncDefMap) ToRawFuncDefMap() RawFuncDefMap

type FuncNameDefMap

type FuncNameDefMap map[string]*FuncDef

type JSONSchemaDef

type JSONSchemaDef RawSchemaDef

type RawFuncDef

type RawFuncDef struct {
	Access  string    `yaml:"access,omitempty"`
	Params  StringMap `yaml:"params,omitempty"`
	Results StringMap `yaml:"results,omitempty"`
}

type RawFuncDefMap

type RawFuncDefMap map[string]*RawFuncDef

func (RawFuncDefMap) ToFuncDefMap

func (m RawFuncDefMap) ToFuncDefMap() FuncDefMap

type RawSchemaDef

type RawSchemaDef struct {
	Copyright   string        `yaml:"copyright"`
	Name        string        `yaml:"name"`
	Version     string        `yaml:"version"`
	Description string        `yaml:"description"`
	Author      string        `yaml:"author"`
	License     string        `yaml:"license"`
	Repository  string        `yaml:"repository"`
	Events      StringMapMap  `yaml:"events"`
	Structs     StringMapMap  `yaml:"structs"`
	Typedefs    StringMap     `yaml:"typedefs"`
	State       StringMap     `yaml:"state"`
	Funcs       RawFuncDefMap `yaml:"funcs"`
	Views       RawFuncDefMap `yaml:"views"`
}

func (*RawSchemaDef) ToSchemaDef

func (s *RawSchemaDef) ToSchemaDef() *SchemaDef

type Schema

type Schema struct {
	ContractName  string
	PackageName   string
	Author        string
	Copyright     string
	Description   string
	License       string
	Repository    string
	Version       string
	CoreContracts bool
	SchemaTime    time.Time
	Events        []*Struct
	Funcs         []*Func
	Params        []*Field
	Results       []*Field
	StateVars     []*Field
	Structs       []*Struct
	Typedefs      []*Field
}

func NewSchema

func NewSchema() *Schema

func (*Schema) Compile

func (s *Schema) Compile(schemaDef *SchemaDef) error

type SchemaDef

type SchemaDef struct {
	Name        DefElt
	Author      DefElt
	Copyright   string
	Description DefElt
	License     DefElt
	Repository  DefElt
	Version     DefElt
	Events      DefMapMap
	Structs     DefMapMap
	Typedefs    DefMap
	State       DefMap
	Funcs       FuncDefMap
	Views       FuncDefMap
}

func NewSchemaDef

func NewSchemaDef() *SchemaDef

func (*SchemaDef) ToRawSchemaDef

func (s *SchemaDef) ToRawSchemaDef() *RawSchemaDef

type StringMap

type StringMap map[string]string

func (StringMap) ToDefMap

func (mm StringMap) ToDefMap() DefMap

type StringMapMap

type StringMapMap map[string]StringMap

func (StringMapMap) ToDefMapMap

func (mm StringMapMap) ToDefMapMap() DefMapMap

type Struct

type Struct struct {
	Name   DefElt
	Fields []*Field
}