pbsubstreamsrpc

package
v1.10.6 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 19, 2024 License: Apache-2.0 Imports: 12 Imported by: 14

Documentation

Index

Constants

View Source 
const (
	EndpointInfo_Info_FullMethodName = "/sf.substreams.rpc.v2.EndpointInfo/Info"
)
View Source 
const (
	Stream_Blocks_FullMethodName = "/sf.substreams.rpc.v2.Stream/Blocks"
)

Variables

View Source 
var (
	StoreDelta_Operation_name = map[int32]string{
		0: "UNSET",
		1: "CREATE",
		2: "UPDATE",
		3: "DELETE",
	}
	StoreDelta_Operation_value = map[string]int32{
		"UNSET":  0,
		"CREATE": 1,
		"UPDATE": 2,
		"DELETE": 3,
	}
)

Enum value maps for StoreDelta_Operation.

View Source 
var EndpointInfo_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "sf.substreams.rpc.v2.EndpointInfo",
	HandlerType: (*EndpointInfoServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Info",
			Handler:    _EndpointInfo_Info_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "sf/substreams/rpc/v2/service.proto",
}

EndpointInfo_ServiceDesc is the grpc.ServiceDesc for EndpointInfo service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var File_sf_substreams_rpc_v2_service_proto protoreflect.FileDescriptor
View Source 
var Stream_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "sf.substreams.rpc.v2.Stream",
	HandlerType: (*StreamServer)(nil),
	Methods:     []grpc.MethodDesc{},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "Blocks",
			Handler:       _Stream_Blocks_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "sf/substreams/rpc/v2/service.proto",
}

Stream_ServiceDesc is the grpc.ServiceDesc for Stream service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterEndpointInfoServer added in v1.10.0 

func RegisterEndpointInfoServer(s grpc.ServiceRegistrar, srv EndpointInfoServer)

func RegisterStreamServer 

func RegisterStreamServer(s grpc.ServiceRegistrar, srv StreamServer)

func TestNewMapModule 

func TestNewMapModule(name string) *pbsubstreams.Module

func TestNewStoreModule 

func TestNewStoreModule(name string) *pbsubstreams.Module

Types

type AnyModuleOutput 

type AnyModuleOutput struct {
	MapOutput   *MapModuleOutput
	StoreOutput *StoreModuleOutput
}

func (*AnyModuleOutput) DebugInfo 

func (a *AnyModuleOutput) DebugInfo() *OutputDebugInfo

func (*AnyModuleOutput) IsEmpty 

func (a *AnyModuleOutput) IsEmpty() bool

func (*AnyModuleOutput) IsMap 

func (a *AnyModuleOutput) IsMap() bool

func (*AnyModuleOutput) IsStore 

func (a *AnyModuleOutput) IsStore() bool

func (*AnyModuleOutput) Name 

func (a *AnyModuleOutput) Name() string

type BlockRange 

type BlockRange struct {
	StartBlock uint64 `protobuf:"varint,2,opt,name=start_block,json=startBlock,proto3" json:"start_block,omitempty"`
	EndBlock   uint64 `protobuf:"varint,3,opt,name=end_block,json=endBlock,proto3" json:"end_block,omitempty"`
	// contains filtered or unexported fields
}

func (*BlockRange) Descriptor deprecated 

func (*BlockRange) Descriptor() ([]byte, []int)

Deprecated: Use BlockRange.ProtoReflect.Descriptor instead.

func (*BlockRange) GetEndBlock 

func (x *BlockRange) GetEndBlock() uint64

func (*BlockRange) GetStartBlock 

func (x *BlockRange) GetStartBlock() uint64

func (*BlockRange) ProtoMessage 

func (*BlockRange) ProtoMessage()

func (*BlockRange) ProtoReflect 

func (x *BlockRange) ProtoReflect() protoreflect.Message

func (*BlockRange) Reset 

func (x *BlockRange) Reset()

func (*BlockRange) String 

func (x *BlockRange) String() string

type BlockScopedData 

type BlockScopedData struct {
	Output *MapModuleOutput `protobuf:"bytes,1,opt,name=output,proto3" json:"output,omitempty"`
	Clock  *v1.Clock        `protobuf:"bytes,2,opt,name=clock,proto3" json:"clock,omitempty"`
	Cursor string           `protobuf:"bytes,3,opt,name=cursor,proto3" json:"cursor,omitempty"`
	// Non-deterministic, allows substreams-sink to let go of their undo data.
	FinalBlockHeight  uint64               `protobuf:"varint,4,opt,name=final_block_height,json=finalBlockHeight,proto3" json:"final_block_height,omitempty"`
	DebugMapOutputs   []*MapModuleOutput   `protobuf:"bytes,10,rep,name=debug_map_outputs,json=debugMapOutputs,proto3" json:"debug_map_outputs,omitempty"`
	DebugStoreOutputs []*StoreModuleOutput `protobuf:"bytes,11,rep,name=debug_store_outputs,json=debugStoreOutputs,proto3" json:"debug_store_outputs,omitempty"`
	// contains filtered or unexported fields
}

func (*BlockScopedData) AllModuleOutputs 

func (bd *BlockScopedData) AllModuleOutputs() (out []*AnyModuleOutput)

func (*BlockScopedData) Descriptor deprecated 

func (*BlockScopedData) Descriptor() ([]byte, []int)

Deprecated: Use BlockScopedData.ProtoReflect.Descriptor instead.

func (*BlockScopedData) GetClock 

func (x *BlockScopedData) GetClock() *v1.Clock

func (*BlockScopedData) GetCursor 

func (x *BlockScopedData) GetCursor() string

func (*BlockScopedData) GetDebugMapOutputs 

func (x *BlockScopedData) GetDebugMapOutputs() []*MapModuleOutput

func (*BlockScopedData) GetDebugStoreOutputs 

func (x *BlockScopedData) GetDebugStoreOutputs() []*StoreModuleOutput

func (*BlockScopedData) GetFinalBlockHeight 

func (x *BlockScopedData) GetFinalBlockHeight() uint64

func (*BlockScopedData) GetOutput 

func (x *BlockScopedData) GetOutput() *MapModuleOutput

func (*BlockScopedData) ProtoMessage 

func (*BlockScopedData) ProtoMessage()

func (*BlockScopedData) ProtoReflect 

func (x *BlockScopedData) ProtoReflect() protoreflect.Message

func (*BlockScopedData) Reset 

func (x *BlockScopedData) Reset()

func (*BlockScopedData) String 

func (x *BlockScopedData) String() string

type BlockUndoSignal 

type BlockUndoSignal struct {
	LastValidBlock  *v1.BlockRef `protobuf:"bytes,1,opt,name=last_valid_block,json=lastValidBlock,proto3" json:"last_valid_block,omitempty"`
	LastValidCursor string       `protobuf:"bytes,2,opt,name=last_valid_cursor,json=lastValidCursor,proto3" json:"last_valid_cursor,omitempty"`
	// contains filtered or unexported fields
}

BlockUndoSignal informs you that every bit of data with a block number above 'last_valid_block' has been reverted on-chain. Delete that data and restart from 'last_valid_cursor'

func (*BlockUndoSignal) Descriptor deprecated 

func (*BlockUndoSignal) Descriptor() ([]byte, []int)

Deprecated: Use BlockUndoSignal.ProtoReflect.Descriptor instead.

func (*BlockUndoSignal) GetLastValidBlock 

func (x *BlockUndoSignal) GetLastValidBlock() *v1.BlockRef

func (*BlockUndoSignal) GetLastValidCursor 

func (x *BlockUndoSignal) GetLastValidCursor() string

func (*BlockUndoSignal) ProtoMessage 

func (*BlockUndoSignal) ProtoMessage()

func (*BlockUndoSignal) ProtoReflect 

func (x *BlockUndoSignal) ProtoReflect() protoreflect.Message

func (*BlockUndoSignal) Reset 

func (x *BlockUndoSignal) Reset()

func (*BlockUndoSignal) String 

func (x *BlockUndoSignal) String() string

type EndpointInfoClient added in v1.10.0 

type EndpointInfoClient interface {
	Info(ctx context.Context, in *v2.InfoRequest, opts ...grpc.CallOption) (*v2.InfoResponse, error)
}

EndpointInfoClient is the client API for EndpointInfo service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewEndpointInfoClient added in v1.10.0 

func NewEndpointInfoClient(cc grpc.ClientConnInterface) EndpointInfoClient

type EndpointInfoServer added in v1.10.0 

type EndpointInfoServer interface {
	Info(context.Context, *v2.InfoRequest) (*v2.InfoResponse, error)
}

EndpointInfoServer is the server API for EndpointInfo service. All implementations should embed UnimplementedEndpointInfoServer for forward compatibility.

type Error added in v1.1.12 

type Error struct {
	Module string   `protobuf:"bytes,1,opt,name=module,proto3" json:"module,omitempty"`
	Reason string   `protobuf:"bytes,2,opt,name=reason,proto3" json:"reason,omitempty"`
	Logs   []string `protobuf:"bytes,3,rep,name=logs,proto3" json:"logs,omitempty"`
	// FailureLogsTruncated is a flag that tells you if you received all the logs or if they
	// were truncated because you logged too much (fixed limit currently is set to 128 KiB).
	LogsTruncated bool `protobuf:"varint,4,opt,name=logs_truncated,json=logsTruncated,proto3" json:"logs_truncated,omitempty"`
	// contains filtered or unexported fields
}

func (*Error) Descriptor deprecated added in v1.1.12 

func (*Error) Descriptor() ([]byte, []int)

Deprecated: Use Error.ProtoReflect.Descriptor instead.

func (*Error) GetLogs added in v1.1.12 

func (x *Error) GetLogs() []string

func (*Error) GetLogsTruncated added in v1.1.12 

func (x *Error) GetLogsTruncated() bool

func (*Error) GetModule added in v1.1.12 

func (x *Error) GetModule() string

func (*Error) GetReason added in v1.1.12 

func (x *Error) GetReason() string

func (*Error) ProtoMessage added in v1.1.12 

func (*Error) ProtoMessage()

func (*Error) ProtoReflect added in v1.1.12 

func (x *Error) ProtoReflect() protoreflect.Message

func (*Error) Reset added in v1.1.12 

func (x *Error) Reset()

func (*Error) String added in v1.1.12 

func (x *Error) String() string

type ExternalCallMetric added in v1.1.12 

type ExternalCallMetric struct {
	Name   string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Count  uint64 `protobuf:"varint,2,opt,name=count,proto3" json:"count,omitempty"`
	TimeMs uint64 `protobuf:"varint,3,opt,name=time_ms,json=timeMs,proto3" json:"time_ms,omitempty"`
	// contains filtered or unexported fields
}

func (*ExternalCallMetric) Descriptor deprecated added in v1.1.12 

func (*ExternalCallMetric) Descriptor() ([]byte, []int)

Deprecated: Use ExternalCallMetric.ProtoReflect.Descriptor instead.

func (*ExternalCallMetric) GetCount added in v1.1.12 

func (x *ExternalCallMetric) GetCount() uint64

func (*ExternalCallMetric) GetName added in v1.1.12 

func (x *ExternalCallMetric) GetName() string

func (*ExternalCallMetric) GetTimeMs added in v1.1.12 

func (x *ExternalCallMetric) GetTimeMs() uint64

func (*ExternalCallMetric) ProtoMessage added in v1.1.12 

func (*ExternalCallMetric) ProtoMessage()

func (*ExternalCallMetric) ProtoReflect added in v1.1.12 

func (x *ExternalCallMetric) ProtoReflect() protoreflect.Message

func (*ExternalCallMetric) Reset added in v1.1.12 

func (x *ExternalCallMetric) Reset()

func (*ExternalCallMetric) String added in v1.1.12 

func (x *ExternalCallMetric) String() string

type InitialSnapshotComplete 

type InitialSnapshotComplete struct {
	Cursor string `protobuf:"bytes,1,opt,name=cursor,proto3" json:"cursor,omitempty"`
	// contains filtered or unexported fields
}

func (*InitialSnapshotComplete) Descriptor deprecated 

func (*InitialSnapshotComplete) Descriptor() ([]byte, []int)

Deprecated: Use InitialSnapshotComplete.ProtoReflect.Descriptor instead.

func (*InitialSnapshotComplete) GetCursor 

func (x *InitialSnapshotComplete) GetCursor() string

func (*InitialSnapshotComplete) ProtoMessage 

func (*InitialSnapshotComplete) ProtoMessage()

func (*InitialSnapshotComplete) ProtoReflect 

func (x *InitialSnapshotComplete) ProtoReflect() protoreflect.Message

func (*InitialSnapshotComplete) Reset 

func (x *InitialSnapshotComplete) Reset()

func (*InitialSnapshotComplete) String 

func (x *InitialSnapshotComplete) String() string

type InitialSnapshotData 

type InitialSnapshotData struct {
	ModuleName string        `protobuf:"bytes,1,opt,name=module_name,json=moduleName,proto3" json:"module_name,omitempty"`
	Deltas     []*StoreDelta `protobuf:"bytes,2,rep,name=deltas,proto3" json:"deltas,omitempty"`
	SentKeys   uint64        `protobuf:"varint,4,opt,name=sent_keys,json=sentKeys,proto3" json:"sent_keys,omitempty"`
	TotalKeys  uint64        `protobuf:"varint,3,opt,name=total_keys,json=totalKeys,proto3" json:"total_keys,omitempty"`
	// contains filtered or unexported fields
}

func (*InitialSnapshotData) Descriptor deprecated 

func (*InitialSnapshotData) Descriptor() ([]byte, []int)

Deprecated: Use InitialSnapshotData.ProtoReflect.Descriptor instead.

func (*InitialSnapshotData) GetDeltas 

func (x *InitialSnapshotData) GetDeltas() []*StoreDelta

func (*InitialSnapshotData) GetModuleName 

func (x *InitialSnapshotData) GetModuleName() string

func (*InitialSnapshotData) GetSentKeys 

func (x *InitialSnapshotData) GetSentKeys() uint64

func (*InitialSnapshotData) GetTotalKeys 

func (x *InitialSnapshotData) GetTotalKeys() uint64

func (*InitialSnapshotData) ProtoMessage 

func (*InitialSnapshotData) ProtoMessage()

func (*InitialSnapshotData) ProtoReflect 

func (x *InitialSnapshotData) ProtoReflect() protoreflect.Message

func (*InitialSnapshotData) Reset 

func (x *InitialSnapshotData) Reset()

func (*InitialSnapshotData) String 

func (x *InitialSnapshotData) String() string

type Job added in v1.1.12 

type Job struct {
	Stage           uint32 `protobuf:"varint,1,opt,name=stage,proto3" json:"stage,omitempty"`
	StartBlock      uint64 `protobuf:"varint,2,opt,name=start_block,json=startBlock,proto3" json:"start_block,omitempty"`
	StopBlock       uint64 `protobuf:"varint,3,opt,name=stop_block,json=stopBlock,proto3" json:"stop_block,omitempty"`
	ProcessedBlocks uint64 `protobuf:"varint,4,opt,name=processed_blocks,json=processedBlocks,proto3" json:"processed_blocks,omitempty"`
	DurationMs      uint64 `protobuf:"varint,5,opt,name=duration_ms,json=durationMs,proto3" json:"duration_ms,omitempty"`
	// contains filtered or unexported fields
}

func (*Job) Descriptor deprecated added in v1.1.12 

func (*Job) Descriptor() ([]byte, []int)

Deprecated: Use Job.ProtoReflect.Descriptor instead.

func (*Job) GetDurationMs added in v1.1.12 

func (x *Job) GetDurationMs() uint64

func (*Job) GetProcessedBlocks added in v1.1.12 

func (x *Job) GetProcessedBlocks() uint64

func (*Job) GetStage added in v1.1.12 

func (x *Job) GetStage() uint32

func (*Job) GetStartBlock added in v1.1.12 

func (x *Job) GetStartBlock() uint64

func (*Job) GetStopBlock added in v1.1.12 

func (x *Job) GetStopBlock() uint64

func (*Job) ProtoMessage added in v1.1.12 

func (*Job) ProtoMessage()

func (*Job) ProtoReflect added in v1.1.12 

func (x *Job) ProtoReflect() protoreflect.Message

func (*Job) Reset added in v1.1.12 

func (x *Job) Reset()

func (*Job) String added in v1.1.12 

func (x *Job) String() string

type MapModuleOutput 

type MapModuleOutput struct {
	Name      string     `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	MapOutput *anypb.Any `protobuf:"bytes,2,opt,name=map_output,json=mapOutput,proto3" json:"map_output,omitempty"`
	// DebugOutputInfo is available in non-production mode only
	DebugInfo *OutputDebugInfo `protobuf:"bytes,10,opt,name=debug_info,json=debugInfo,proto3" json:"debug_info,omitempty"`
	// contains filtered or unexported fields
}

func (*MapModuleOutput) Descriptor deprecated 

func (*MapModuleOutput) Descriptor() ([]byte, []int)

Deprecated: Use MapModuleOutput.ProtoReflect.Descriptor instead.

func (*MapModuleOutput) GetDebugInfo 

func (x *MapModuleOutput) GetDebugInfo() *OutputDebugInfo

func (*MapModuleOutput) GetMapOutput 

func (x *MapModuleOutput) GetMapOutput() *anypb.Any

func (*MapModuleOutput) GetName 

func (x *MapModuleOutput) GetName() string

func (*MapModuleOutput) ProtoMessage 

func (*MapModuleOutput) ProtoMessage()

func (*MapModuleOutput) ProtoReflect 

func (x *MapModuleOutput) ProtoReflect() protoreflect.Message

func (*MapModuleOutput) Reset 

func (x *MapModuleOutput) Reset()

func (*MapModuleOutput) String 

func (x *MapModuleOutput) String() string

func (*MapModuleOutput) ToAny 

func (m *MapModuleOutput) ToAny() *AnyModuleOutput

type ModuleStats added in v1.1.12 

type ModuleStats struct {

	// name of the module
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// total_processed_blocks is the sum of blocks sent to that module code
	TotalProcessedBlockCount uint64 `` /* 138-byte string literal not displayed */
	// total_processing_time_ms is the sum of all time spent running that module code
	TotalProcessingTimeMs uint64 `` /* 129-byte string literal not displayed */
	// // external_calls are chain-specific intrinsics, like "Ethereum RPC calls".
	ExternalCallMetrics []*ExternalCallMetric `protobuf:"bytes,4,rep,name=external_call_metrics,json=externalCallMetrics,proto3" json:"external_call_metrics,omitempty"`
	// total_store_operation_time_ms is the sum of all time spent running that module code waiting for a store operation (ex: read, write, delete...)
	TotalStoreOperationTimeMs uint64 `` /* 143-byte string literal not displayed */
	// total_store_read_count is the sum of all the store Read operations called from that module code
	TotalStoreReadCount uint64 `protobuf:"varint,6,opt,name=total_store_read_count,json=totalStoreReadCount,proto3" json:"total_store_read_count,omitempty"`
	// total_store_write_count is the sum of all store Write operations called from that module code (store-only)
	TotalStoreWriteCount uint64 `` /* 127-byte string literal not displayed */
	// total_store_deleteprefix_count is the sum of all store DeletePrefix operations called from that module code (store-only)
	// note that DeletePrefix can be a costly operation on large stores
	TotalStoreDeleteprefixCount uint64 `` /* 148-byte string literal not displayed */
	// store_size_bytes is the uncompressed size of the full KV store for that module, from the last 'merge' operation (store-only)
	StoreSizeBytes uint64 `protobuf:"varint,12,opt,name=store_size_bytes,json=storeSizeBytes,proto3" json:"store_size_bytes,omitempty"`
	// total_store_merging_time_ms is the time spent merging partial stores into a full KV store for that module (store-only)
	TotalStoreMergingTimeMs uint64 `` /* 138-byte string literal not displayed */
	// store_currently_merging is true if there is a merging operation (partial store to full KV store) on the way.
	StoreCurrentlyMerging bool `` /* 128-byte string literal not displayed */
	// highest_contiguous_block is the highest block in the highest merged full KV store of that module (store-only)
	HighestContiguousBlock uint64 `` /* 131-byte string literal not displayed */
	// contains filtered or unexported fields
}

ModuleStats gathers metrics and statistics from each module, running on tier1 or tier2 All the 'count' and 'time_ms' values may include duplicate for each stage going over that module

func (*ModuleStats) Descriptor deprecated added in v1.1.12 

func (*ModuleStats) Descriptor() ([]byte, []int)

Deprecated: Use ModuleStats.ProtoReflect.Descriptor instead.

func (*ModuleStats) GetExternalCallMetrics added in v1.1.12 

func (x *ModuleStats) GetExternalCallMetrics() []*ExternalCallMetric

func (*ModuleStats) GetHighestContiguousBlock added in v1.1.12 

func (x *ModuleStats) GetHighestContiguousBlock() uint64

func (*ModuleStats) GetName added in v1.1.12 

func (x *ModuleStats) GetName() string

func (*ModuleStats) GetStoreCurrentlyMerging added in v1.1.12 

func (x *ModuleStats) GetStoreCurrentlyMerging() bool

func (*ModuleStats) GetStoreSizeBytes added in v1.1.12 

func (x *ModuleStats) GetStoreSizeBytes() uint64

func (*ModuleStats) GetTotalProcessedBlockCount added in v1.1.12 

func (x *ModuleStats) GetTotalProcessedBlockCount() uint64

func (*ModuleStats) GetTotalProcessingTimeMs added in v1.1.12 

func (x *ModuleStats) GetTotalProcessingTimeMs() uint64

func (*ModuleStats) GetTotalStoreDeleteprefixCount added in v1.1.12 

func (x *ModuleStats) GetTotalStoreDeleteprefixCount() uint64

func (*ModuleStats) GetTotalStoreMergingTimeMs added in v1.1.12 

func (x *ModuleStats) GetTotalStoreMergingTimeMs() uint64

func (*ModuleStats) GetTotalStoreOperationTimeMs added in v1.1.12 

func (x *ModuleStats) GetTotalStoreOperationTimeMs() uint64

func (*ModuleStats) GetTotalStoreReadCount added in v1.1.12 

func (x *ModuleStats) GetTotalStoreReadCount() uint64

func (*ModuleStats) GetTotalStoreWriteCount added in v1.1.12 

func (x *ModuleStats) GetTotalStoreWriteCount() uint64

func (*ModuleStats) ProtoMessage added in v1.1.12 

func (*ModuleStats) ProtoMessage()

func (*ModuleStats) ProtoReflect added in v1.1.12 

func (x *ModuleStats) ProtoReflect() protoreflect.Message

func (*ModuleStats) Reset added in v1.1.12 

func (x *ModuleStats) Reset()

func (*ModuleStats) String added in v1.1.12 

func (x *ModuleStats) String() string

type ModulesProgress 

type ModulesProgress struct {

	// List of jobs running on tier2 servers
	RunningJobs []*Job `protobuf:"bytes,2,rep,name=running_jobs,json=runningJobs,proto3" json:"running_jobs,omitempty"`
	// Execution statistics for each module
	ModulesStats []*ModuleStats `protobuf:"bytes,3,rep,name=modules_stats,json=modulesStats,proto3" json:"modules_stats,omitempty"`
	// Stages definition and completed block ranges
	Stages         []*Stage        `protobuf:"bytes,4,rep,name=stages,proto3" json:"stages,omitempty"`
	ProcessedBytes *ProcessedBytes `protobuf:"bytes,5,opt,name=processed_bytes,json=processedBytes,proto3" json:"processed_bytes,omitempty"`
	// contains filtered or unexported fields
}

ModulesProgress is a message that is sent every 500ms

func (*ModulesProgress) Descriptor deprecated 

func (*ModulesProgress) Descriptor() ([]byte, []int)

Deprecated: Use ModulesProgress.ProtoReflect.Descriptor instead.

func (*ModulesProgress) GetModulesStats added in v1.1.12 

func (x *ModulesProgress) GetModulesStats() []*ModuleStats

func (*ModulesProgress) GetProcessedBytes added in v1.1.12 

func (x *ModulesProgress) GetProcessedBytes() *ProcessedBytes

func (*ModulesProgress) GetRunningJobs added in v1.1.12 

func (x *ModulesProgress) GetRunningJobs() []*Job

func (*ModulesProgress) GetStages added in v1.1.12 

func (x *ModulesProgress) GetStages() []*Stage

func (*ModulesProgress) ProtoMessage 

func (*ModulesProgress) ProtoMessage()

func (*ModulesProgress) ProtoReflect 

func (x *ModulesProgress) ProtoReflect() protoreflect.Message

func (*ModulesProgress) Reset 

func (x *ModulesProgress) Reset()

func (*ModulesProgress) String 

func (x *ModulesProgress) String() string

type OutputDebugInfo 

type OutputDebugInfo struct {
	Logs []string `protobuf:"bytes,1,rep,name=logs,proto3" json:"logs,omitempty"`
	// LogsTruncated is a flag that tells you if you received all the logs or if they
	// were truncated because you logged too much (fixed limit currently is set to 128 KiB).
	LogsTruncated bool `protobuf:"varint,2,opt,name=logs_truncated,json=logsTruncated,proto3" json:"logs_truncated,omitempty"`
	Cached        bool `protobuf:"varint,3,opt,name=cached,proto3" json:"cached,omitempty"`
	// contains filtered or unexported fields
}

func (*OutputDebugInfo) Descriptor deprecated 

func (*OutputDebugInfo) Descriptor() ([]byte, []int)

Deprecated: Use OutputDebugInfo.ProtoReflect.Descriptor instead.

func (*OutputDebugInfo) GetCached 

func (x *OutputDebugInfo) GetCached() bool

func (*OutputDebugInfo) GetLogs 

func (x *OutputDebugInfo) GetLogs() []string

func (*OutputDebugInfo) GetLogsTruncated 

func (x *OutputDebugInfo) GetLogsTruncated() bool

func (*OutputDebugInfo) ProtoMessage 

func (*OutputDebugInfo) ProtoMessage()

func (*OutputDebugInfo) ProtoReflect 

func (x *OutputDebugInfo) ProtoReflect() protoreflect.Message

func (*OutputDebugInfo) Reset 

func (x *OutputDebugInfo) Reset()

func (*OutputDebugInfo) String 

func (x *OutputDebugInfo) String() string

type ProcessedBytes added in v1.1.12 

type ProcessedBytes struct {
	TotalBytesRead    uint64 `protobuf:"varint,1,opt,name=total_bytes_read,json=totalBytesRead,proto3" json:"total_bytes_read,omitempty"`
	TotalBytesWritten uint64 `protobuf:"varint,2,opt,name=total_bytes_written,json=totalBytesWritten,proto3" json:"total_bytes_written,omitempty"`
	// contains filtered or unexported fields
}

func (*ProcessedBytes) Descriptor deprecated added in v1.1.12 

func (*ProcessedBytes) Descriptor() ([]byte, []int)

Deprecated: Use ProcessedBytes.ProtoReflect.Descriptor instead.

func (*ProcessedBytes) GetTotalBytesRead added in v1.1.12 

func (x *ProcessedBytes) GetTotalBytesRead() uint64

func (*ProcessedBytes) GetTotalBytesWritten added in v1.1.12 

func (x *ProcessedBytes) GetTotalBytesWritten() uint64

func (*ProcessedBytes) ProtoMessage added in v1.1.12 

func (*ProcessedBytes) ProtoMessage()

func (*ProcessedBytes) ProtoReflect added in v1.1.12 

func (x *ProcessedBytes) ProtoReflect() protoreflect.Message

func (*ProcessedBytes) Reset added in v1.1.12 

func (x *ProcessedBytes) Reset()

func (*ProcessedBytes) String added in v1.1.12 

func (x *ProcessedBytes) String() string

type Request 

type Request struct {
	StartBlockNum int64  `protobuf:"varint,1,opt,name=start_block_num,json=startBlockNum,proto3" json:"start_block_num,omitempty"`
	StartCursor   string `protobuf:"bytes,2,opt,name=start_cursor,json=startCursor,proto3" json:"start_cursor,omitempty"`
	StopBlockNum  uint64 `protobuf:"varint,3,opt,name=stop_block_num,json=stopBlockNum,proto3" json:"stop_block_num,omitempty"`
	// With final_block_only, you only receive blocks that are irreversible:
	// 'final_block_height' will be equal to current block and no 'undo_signal' will ever be sent
	FinalBlocksOnly bool `protobuf:"varint,4,opt,name=final_blocks_only,json=finalBlocksOnly,proto3" json:"final_blocks_only,omitempty"`
	// Substreams has two mode when executing your module(s) either development mode or production
	// mode. Development and production modes impact the execution of Substreams, important aspects
	// of execution include:
	// * The time required to reach the first byte.
	// * The speed that large ranges get executed.
	// * The module logs and outputs sent back to the client.
	//
	// By default, the engine runs in developer mode, with richer and deeper output. Differences
	// between production and development modes include:
	// * Forward parallel execution is enabled in production mode and disabled in development mode
	// * The time required to reach the first byte in development mode is faster than in production mode.
	//
	// Specific attributes of development mode include:
	// * The client will receive all of the executed module's logs.
	// * It's possible to request specific store snapshots in the execution tree (via `debug_initial_store_snapshot_for_modules`).
	// * Multiple module's output is possible.
	//
	// With production mode`, however, you trade off functionality for high speed enabling forward
	// parallel execution of module ahead of time.
	ProductionMode bool        `protobuf:"varint,5,opt,name=production_mode,json=productionMode,proto3" json:"production_mode,omitempty"`
	OutputModule   string      `protobuf:"bytes,6,opt,name=output_module,json=outputModule,proto3" json:"output_module,omitempty"`
	Modules        *v1.Modules `protobuf:"bytes,7,opt,name=modules,proto3" json:"modules,omitempty"`
	// Available only in developer mode
	DebugInitialStoreSnapshotForModules []string `` /* 175-byte string literal not displayed */
	NoopMode                            bool     `protobuf:"varint,11,opt,name=noop_mode,json=noopMode,proto3" json:"noop_mode,omitempty"`
	// contains filtered or unexported fields
}

func TestNewRequest 

func TestNewRequest(startBlockNum int64, opts ...testNewRequestOption) *Request

func (*Request) Descriptor deprecated 

func (*Request) Descriptor() ([]byte, []int)

Deprecated: Use Request.ProtoReflect.Descriptor instead.

func (*Request) GetDebugInitialStoreSnapshotForModules 

func (x *Request) GetDebugInitialStoreSnapshotForModules() []string

func (*Request) GetFinalBlocksOnly 

func (x *Request) GetFinalBlocksOnly() bool

func (*Request) GetModules 

func (x *Request) GetModules() *v1.Modules

func (*Request) GetNoopMode added in v1.8.1 

func (x *Request) GetNoopMode() bool

func (*Request) GetOutputModule 

func (x *Request) GetOutputModule() string

func (*Request) GetProductionMode 

func (x *Request) GetProductionMode() bool

func (*Request) GetStartBlockNum 

func (x *Request) GetStartBlockNum() int64

func (*Request) GetStartCursor 

func (x *Request) GetStartCursor() string

func (*Request) GetStopBlockNum 

func (x *Request) GetStopBlockNum() uint64

func (*Request) ProtoMessage 

func (*Request) ProtoMessage()

func (*Request) ProtoReflect 

func (x *Request) ProtoReflect() protoreflect.Message

func (*Request) Reset 

func (x *Request) Reset()

func (*Request) String 

func (x *Request) String() string

func (*Request) Validate 

func (req *Request) Validate() error

type Response 

type Response struct {

	// Types that are assignable to Message:
	//
	//	*Response_Session
	//	*Response_Progress
	//	*Response_BlockScopedData
	//	*Response_BlockUndoSignal
	//	*Response_FatalError
	//	*Response_DebugSnapshotData
	//	*Response_DebugSnapshotComplete
	Message isResponse_Message `protobuf_oneof:"message"`
	// contains filtered or unexported fields
}

func (*Response) Descriptor deprecated 

func (*Response) Descriptor() ([]byte, []int)

Deprecated: Use Response.ProtoReflect.Descriptor instead.

func (*Response) GetBlockScopedData 

func (x *Response) GetBlockScopedData() *BlockScopedData

func (*Response) GetBlockUndoSignal 

func (x *Response) GetBlockUndoSignal() *BlockUndoSignal

func (*Response) GetDebugSnapshotComplete 

func (x *Response) GetDebugSnapshotComplete() *InitialSnapshotComplete

func (*Response) GetDebugSnapshotData 

func (x *Response) GetDebugSnapshotData() *InitialSnapshotData

func (*Response) GetFatalError added in v1.1.12 

func (x *Response) GetFatalError() *Error

func (*Response) GetMessage 

func (m *Response) GetMessage() isResponse_Message

func (*Response) GetProgress 

func (x *Response) GetProgress() *ModulesProgress

func (*Response) GetSession 

func (x *Response) GetSession() *SessionInit

func (*Response) ProtoMessage 

func (*Response) ProtoMessage()

func (*Response) ProtoReflect 

func (x *Response) ProtoReflect() protoreflect.Message

func (*Response) Reset 

func (x *Response) Reset()

func (*Response) String 

func (x *Response) String() string

type Response_BlockScopedData 

type Response_BlockScopedData struct {
	BlockScopedData *BlockScopedData `protobuf:"bytes,3,opt,name=block_scoped_data,json=blockScopedData,proto3,oneof"`
}

type Response_BlockUndoSignal 

type Response_BlockUndoSignal struct {
	BlockUndoSignal *BlockUndoSignal `protobuf:"bytes,4,opt,name=block_undo_signal,json=blockUndoSignal,proto3,oneof"`
}

type Response_DebugSnapshotComplete 

type Response_DebugSnapshotComplete struct {
	// Available only in developer mode, and only if `debug_initial_store_snapshot_for_modules` is set.
	DebugSnapshotComplete *InitialSnapshotComplete `protobuf:"bytes,11,opt,name=debug_snapshot_complete,json=debugSnapshotComplete,proto3,oneof"`
}

type Response_DebugSnapshotData 

type Response_DebugSnapshotData struct {
	// Available only in developer mode, and only if `debug_initial_store_snapshot_for_modules` is set.
	DebugSnapshotData *InitialSnapshotData `protobuf:"bytes,10,opt,name=debug_snapshot_data,json=debugSnapshotData,proto3,oneof"`
}

type Response_FatalError added in v1.1.12 

type Response_FatalError struct {
	FatalError *Error `protobuf:"bytes,5,opt,name=fatal_error,json=fatalError,proto3,oneof"`
}

type Response_Progress 

type Response_Progress struct {
	Progress *ModulesProgress `protobuf:"bytes,2,opt,name=progress,proto3,oneof"` // Progress of data preparation, before sending in the stream of `data` events.
}

type Response_Session 

type Response_Session struct {
	Session *SessionInit `protobuf:"bytes,1,opt,name=session,proto3,oneof"` // Always sent first
}

type SessionInit 

type SessionInit struct {
	TraceId            string `protobuf:"bytes,1,opt,name=trace_id,json=traceId,proto3" json:"trace_id,omitempty"`
	ResolvedStartBlock uint64 `protobuf:"varint,2,opt,name=resolved_start_block,json=resolvedStartBlock,proto3" json:"resolved_start_block,omitempty"`
	LinearHandoffBlock uint64 `protobuf:"varint,3,opt,name=linear_handoff_block,json=linearHandoffBlock,proto3" json:"linear_handoff_block,omitempty"`
	MaxParallelWorkers uint64 `protobuf:"varint,4,opt,name=max_parallel_workers,json=maxParallelWorkers,proto3" json:"max_parallel_workers,omitempty"`
	// contains filtered or unexported fields
}

func (*SessionInit) Descriptor deprecated 

func (*SessionInit) Descriptor() ([]byte, []int)

Deprecated: Use SessionInit.ProtoReflect.Descriptor instead.

func (*SessionInit) GetLinearHandoffBlock added in v1.1.5 

func (x *SessionInit) GetLinearHandoffBlock() uint64

func (*SessionInit) GetMaxParallelWorkers added in v1.1.5 

func (x *SessionInit) GetMaxParallelWorkers() uint64

func (*SessionInit) GetResolvedStartBlock added in v1.1.5 

func (x *SessionInit) GetResolvedStartBlock() uint64

func (*SessionInit) GetTraceId 

func (x *SessionInit) GetTraceId() string

func (*SessionInit) ProtoMessage 

func (*SessionInit) ProtoMessage()

func (*SessionInit) ProtoReflect 

func (x *SessionInit) ProtoReflect() protoreflect.Message

func (*SessionInit) Reset 

func (x *SessionInit) Reset()

func (*SessionInit) String 

func (x *SessionInit) String() string

type Stage added in v1.1.12 

type Stage struct {
	Modules         []string      `protobuf:"bytes,1,rep,name=modules,proto3" json:"modules,omitempty"`
	CompletedRanges []*BlockRange `protobuf:"bytes,2,rep,name=completed_ranges,json=completedRanges,proto3" json:"completed_ranges,omitempty"`
	// contains filtered or unexported fields
}

func (*Stage) Descriptor deprecated added in v1.1.12 

func (*Stage) Descriptor() ([]byte, []int)

Deprecated: Use Stage.ProtoReflect.Descriptor instead.

func (*Stage) GetCompletedRanges added in v1.1.12 

func (x *Stage) GetCompletedRanges() []*BlockRange

func (*Stage) GetModules added in v1.1.12 

func (x *Stage) GetModules() []string

func (*Stage) ProtoMessage added in v1.1.12 

func (*Stage) ProtoMessage()

func (*Stage) ProtoReflect added in v1.1.12 

func (x *Stage) ProtoReflect() protoreflect.Message

func (*Stage) Reset added in v1.1.12 

func (x *Stage) Reset()

func (*Stage) String added in v1.1.12 

func (x *Stage) String() string

type StoreDelta 

type StoreDelta struct {
	Operation StoreDelta_Operation `protobuf:"varint,1,opt,name=operation,proto3,enum=sf.substreams.rpc.v2.StoreDelta_Operation" json:"operation,omitempty"`
	Ordinal   uint64               `protobuf:"varint,2,opt,name=ordinal,proto3" json:"ordinal,omitempty"`
	Key       string               `protobuf:"bytes,3,opt,name=key,proto3" json:"key,omitempty"`
	OldValue  []byte               `protobuf:"bytes,4,opt,name=old_value,json=oldValue,proto3" json:"old_value,omitempty"`
	NewValue  []byte               `protobuf:"bytes,5,opt,name=new_value,json=newValue,proto3" json:"new_value,omitempty"`
	// contains filtered or unexported fields
}

func (*StoreDelta) Descriptor deprecated 

func (*StoreDelta) Descriptor() ([]byte, []int)

Deprecated: Use StoreDelta.ProtoReflect.Descriptor instead.

func (*StoreDelta) GetKey 

func (x *StoreDelta) GetKey() string

func (*StoreDelta) GetNewValue 

func (x *StoreDelta) GetNewValue() []byte

func (*StoreDelta) GetOldValue 

func (x *StoreDelta) GetOldValue() []byte

func (*StoreDelta) GetOperation 

func (x *StoreDelta) GetOperation() StoreDelta_Operation

func (*StoreDelta) GetOrdinal 

func (x *StoreDelta) GetOrdinal() uint64

func (*StoreDelta) ProtoMessage 

func (*StoreDelta) ProtoMessage()

func (*StoreDelta) ProtoReflect 

func (x *StoreDelta) ProtoReflect() protoreflect.Message

func (*StoreDelta) Reset 

func (x *StoreDelta) Reset()

func (*StoreDelta) String 

func (x *StoreDelta) String() string

type StoreDelta_Operation 

type StoreDelta_Operation int32
const (
	StoreDelta_UNSET  StoreDelta_Operation = 0
	StoreDelta_CREATE StoreDelta_Operation = 1
	StoreDelta_UPDATE StoreDelta_Operation = 2
	StoreDelta_DELETE StoreDelta_Operation = 3
)

func (StoreDelta_Operation) Descriptor 

func (StoreDelta_Operation) Descriptor() protoreflect.EnumDescriptor

func (StoreDelta_Operation) Enum 

func (x StoreDelta_Operation) Enum() *StoreDelta_Operation

func (StoreDelta_Operation) EnumDescriptor deprecated 

func (StoreDelta_Operation) EnumDescriptor() ([]byte, []int)

Deprecated: Use StoreDelta_Operation.Descriptor instead.

func (StoreDelta_Operation) Number 

func (x StoreDelta_Operation) Number() protoreflect.EnumNumber

func (StoreDelta_Operation) String 

func (x StoreDelta_Operation) String() string

func (StoreDelta_Operation) Type 

func (StoreDelta_Operation) Type() protoreflect.EnumType

type StoreModuleOutput 

type StoreModuleOutput struct {
	Name             string           `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	DebugStoreDeltas []*StoreDelta    `protobuf:"bytes,2,rep,name=debug_store_deltas,json=debugStoreDeltas,proto3" json:"debug_store_deltas,omitempty"`
	DebugInfo        *OutputDebugInfo `protobuf:"bytes,10,opt,name=debug_info,json=debugInfo,proto3" json:"debug_info,omitempty"`
	// contains filtered or unexported fields
}

StoreModuleOutput are produced for store modules in development mode. It is not possible to retrieve store models in production, with parallelization enabled. If you need the deltas directly, write a pass through mapper module that will get them down to you.

func (*StoreModuleOutput) Descriptor deprecated 

func (*StoreModuleOutput) Descriptor() ([]byte, []int)

Deprecated: Use StoreModuleOutput.ProtoReflect.Descriptor instead.

func (*StoreModuleOutput) GetDebugInfo 

func (x *StoreModuleOutput) GetDebugInfo() *OutputDebugInfo

func (*StoreModuleOutput) GetDebugStoreDeltas 

func (x *StoreModuleOutput) GetDebugStoreDeltas() []*StoreDelta

func (*StoreModuleOutput) GetName 

func (x *StoreModuleOutput) GetName() string

func (*StoreModuleOutput) ProtoMessage 

func (*StoreModuleOutput) ProtoMessage()

func (*StoreModuleOutput) ProtoReflect 

func (x *StoreModuleOutput) ProtoReflect() protoreflect.Message

func (*StoreModuleOutput) Reset 

func (x *StoreModuleOutput) Reset()

func (*StoreModuleOutput) String 

func (x *StoreModuleOutput) String() string

func (*StoreModuleOutput) ToAny 

func (s *StoreModuleOutput) ToAny() *AnyModuleOutput

type StreamClient 

type StreamClient interface {
	Blocks(ctx context.Context, in *Request, opts ...grpc.CallOption) (grpc.ServerStreamingClient[Response], error)
}

StreamClient is the client API for Stream service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewStreamClient 

func NewStreamClient(cc grpc.ClientConnInterface) StreamClient

type StreamServer 

type StreamServer interface {
	Blocks(*Request, grpc.ServerStreamingServer[Response]) error
}

StreamServer is the server API for Stream service. All implementations should embed UnimplementedStreamServer for forward compatibility.

type Stream_BlocksClient 

type Stream_BlocksClient = grpc.ServerStreamingClient[Response]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type Stream_BlocksServer 

type Stream_BlocksServer = grpc.ServerStreamingServer[Response]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type UnimplementedEndpointInfoServer added in v1.10.0 

type UnimplementedEndpointInfoServer struct{}

UnimplementedEndpointInfoServer should be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedEndpointInfoServer) Info added in v1.10.0 

func (UnimplementedEndpointInfoServer) Info(context.Context, *v2.InfoRequest) (*v2.InfoResponse, error)

type UnimplementedStreamServer 

type UnimplementedStreamServer struct{}

UnimplementedStreamServer should be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedStreamServer) Blocks 

func (UnimplementedStreamServer) Blocks(*Request, grpc.ServerStreamingServer[Response]) error

type UnsafeEndpointInfoServer added in v1.10.0 

type UnsafeEndpointInfoServer interface {
	// contains filtered or unexported methods
}

UnsafeEndpointInfoServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to EndpointInfoServer will result in compilation errors.

type UnsafeStreamServer 

type UnsafeStreamServer interface {
	// contains filtered or unexported methods
}

UnsafeStreamServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to StreamServer will result in compilation errors.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.