info

Documentation

Index

• type BasicInfo
  • func Basic(pkg *pbsubstreams.Package, graph *manifest.ModuleGraph) (*BasicInfo, error)
• type ExtendedInfo
  • func Extended(manifestPath string, outputModule string, skipValidation bool) (*ExtendedInfo, error)
  • func ExtendedWithPackage(pkg *pbsubstreams.Package, graph *manifest.ModuleGraph, outputModule string) (*ExtendedInfo, error)
• type ModuleInput
• type ModulesInfo
• type ProtoFileInfo
• type ProtoMessageInfo
• type ProtoPackageParser
  • func NewProtoPackageParser(files []*descriptorpb.FileDescriptorProto) (*ProtoPackageParser, error)
  • func (p *ProtoPackageParser) GetFilesSourceCode() map[string][]*SourceCodeInfo
  • func (p *ProtoPackageParser) GetPackagesList() []string
  • func (p *ProtoPackageParser) Parse() (map[string][]*ProtoMessageInfo, error)
• type SinkInfo
• type SourceCodeInfo

Types

type BasicInfo

type BasicInfo struct {
	Name                   string                             `json:"name"`
	Version                string                             `json:"version"`
	Documentation          *string                            `json:"documentation,omitempty"`
	Network                string                             `json:"network,omitempty"`
	Image                  []byte                             `json:"-"`
	Modules                []ModulesInfo                      `json:"modules"`
	SinkInfo               *SinkInfo                          `json:"sink_info,omitempty"`
	ProtoPackages          []string                           `json:"proto_packages"` // list of proto packages
	Networks               map[string]*manifest.NetworkParams `json:"networks,omitempty"`
	ProtoSourceCode        map[string][]*SourceCodeInfo       `json:"proto_source_code"`         // map of proto file name to .proto file contents
	ProtoMessagesByPackage map[string][]*ProtoMessageInfo     `json:"proto_messages_by_package"` // map of package name to a list of messages info in that package
}

func Basic

func Basic(pkg *pbsubstreams.Package, graph *manifest.ModuleGraph) (*BasicInfo, error)

type ExtendedInfo

type ExtendedInfo struct {
	*BasicInfo

	ExecutionStages [][][]string `json:"execution_stages,omitempty"`
}

func Extended

func Extended(manifestPath string, outputModule string, skipValidation bool) (*ExtendedInfo, error)

func ExtendedWithPackage

func ExtendedWithPackage(pkg *pbsubstreams.Package, graph *manifest.ModuleGraph, outputModule string) (*ExtendedInfo, error)

type ModuleInput

type ModuleInput struct {
	Type string  `json:"type"`
	Name string  `json:"name"`
	Mode *string `json:"mode,omitempty"` //for store inputs
}

type ModulesInfo

type ModulesInfo struct {
	Name          string                           `json:"name"`
	Kind          string                           `json:"kind"`
	Inputs        []ModuleInput                    `json:"inputs"`
	OutputType    *string                          `json:"output_type,omitempty"`   //for map inputs
	ValueType     *string                          `json:"value_type,omitempty"`    //for store inputs
	UpdatePolicy  *string                          `json:"update_policy,omitempty"` //for store inputs
	BlockFilter   *pbsubstreams.Module_BlockFilter `json:"block_filter,omitempty"`
	InitialBlock  uint64                           `json:"initial_block"`
	Documentation *string                          `json:"documentation,omitempty"`
	Hash          string                           `json:"hash"`
}

type ProtoFileInfo

type ProtoFileInfo struct {
	Name               *string                                `json:"name,omitempty"`
	Package            *string                                `json:"package,omitempty"`
	Dependencies       []string                               `json:"dependencies,omitempty"`
	PublicDependencies []int32                                `json:"public_dependencies,omitempty"`
	MessageType        []*descriptorpb.DescriptorProto        `json:"message_type,omitempty"`
	Services           []*descriptorpb.ServiceDescriptorProto `json:"services,omitempty"`
}

type ProtoMessageInfo

type ProtoMessageInfo struct {
	Name           string              `json:"name"`
	Package        string              `json:"package"`
	Type           string              `json:"type"`
	File           string              `json:"file"`
	Proto          string              `json:"proto"`
	Documentation  string              `json:"documentation"`
	NestedMessages []*ProtoMessageInfo `json:"nested_messages"`
}

type ProtoPackageParser

type ProtoPackageParser struct {
	// contains filtered or unexported fields
}

func NewProtoPackageParser

func NewProtoPackageParser(files []*descriptorpb.FileDescriptorProto) (*ProtoPackageParser, error)

func (*ProtoPackageParser) GetFilesSourceCode

func (p *ProtoPackageParser) GetFilesSourceCode() map[string][]*SourceCodeInfo

func (*ProtoPackageParser) GetPackagesList

func (p *ProtoPackageParser) GetPackagesList() []string

func (*ProtoPackageParser) Parse

func (p *ProtoPackageParser) Parse() (map[string][]*ProtoMessageInfo, error)

type SinkInfo

type SinkInfo struct {
	Configs string            `json:"desc"`
	TypeUrl string            `json:"type_url"`
	Files   map[string][]byte `json:"files"`
}

type SourceCodeInfo

type SourceCodeInfo struct {
	Filename string `json:"filename"`
	Source   string `json:"source"`
}