Documentation
¶
Index ¶
- Constants
- Variables
- func RegisterEndpointInfoServer(s grpc.ServiceRegistrar, srv EndpointInfoServer)
- func RegisterFetchServer(s grpc.ServiceRegistrar, srv FetchServer)
- func RegisterStreamServer(s grpc.ServiceRegistrar, srv StreamServer)
- type BlockMetadata
- func (*BlockMetadata) Descriptor() ([]byte, []int)deprecated
- func (x *BlockMetadata) GetId() string
- func (x *BlockMetadata) GetLibNum() uint64
- func (x *BlockMetadata) GetNum() uint64
- func (x *BlockMetadata) GetParentId() string
- func (x *BlockMetadata) GetParentNum() uint64
- func (x *BlockMetadata) GetTime() *timestamppb.Timestamp
- func (*BlockMetadata) ProtoMessage()
- func (x *BlockMetadata) ProtoReflect() protoreflect.Message
- func (x *BlockMetadata) Reset()
- func (x *BlockMetadata) String() string
- type EndpointInfoClient
- type EndpointInfoServer
- type FetchClient
- type FetchServer
- type ForkStep
- type InfoRequest
- type InfoResponse
- func (*InfoResponse) Descriptor() ([]byte, []int)deprecated
- func (x *InfoResponse) GetBlockFeatures() []string
- func (x *InfoResponse) GetBlockIdEncoding() InfoResponse_BlockIdEncoding
- func (x *InfoResponse) GetChainName() string
- func (x *InfoResponse) GetChainNameAliases() []string
- func (x *InfoResponse) GetFirstStreamableBlockId() string
- func (x *InfoResponse) GetFirstStreamableBlockNum() uint64
- func (*InfoResponse) ProtoMessage()
- func (x *InfoResponse) ProtoReflect() protoreflect.Message
- func (x *InfoResponse) Reset()
- func (x *InfoResponse) String() string
- type InfoResponse_BlockIdEncoding
- func (InfoResponse_BlockIdEncoding) Descriptor() protoreflect.EnumDescriptor
- func (x InfoResponse_BlockIdEncoding) Enum() *InfoResponse_BlockIdEncoding
- func (InfoResponse_BlockIdEncoding) EnumDescriptor() ([]byte, []int)deprecated
- func (x InfoResponse_BlockIdEncoding) Number() protoreflect.EnumNumber
- func (x InfoResponse_BlockIdEncoding) String() string
- func (InfoResponse_BlockIdEncoding) Type() protoreflect.EnumType
- type Request
- func (*Request) Descriptor() ([]byte, []int)deprecated
- func (x *Request) GetCursor() string
- func (x *Request) GetFinalBlocksOnly() bool
- func (x *Request) GetStartBlockNum() int64
- func (x *Request) GetStopBlockNum() uint64
- func (x *Request) GetTransforms() []*anypb.Any
- func (*Request) ProtoMessage()
- func (x *Request) ProtoReflect() protoreflect.Message
- func (x *Request) Reset()
- func (x *Request) String() string
- type Response
- func (*Response) Descriptor() ([]byte, []int)deprecated
- func (x *Response) GetBlock() *anypb.Any
- func (x *Response) GetCursor() string
- func (x *Response) GetMetadata() *BlockMetadata
- func (x *Response) GetStep() ForkStep
- func (*Response) ProtoMessage()
- func (x *Response) ProtoReflect() protoreflect.Message
- func (x *Response) Reset()
- func (x *Response) String() string
- type SingleBlockRequest
- func (*SingleBlockRequest) Descriptor() ([]byte, []int)deprecated
- func (x *SingleBlockRequest) GetBlockHashAndNumber() *SingleBlockRequest_BlockHashAndNumber
- func (x *SingleBlockRequest) GetBlockNumber() *SingleBlockRequest_BlockNumber
- func (x *SingleBlockRequest) GetCursor() *SingleBlockRequest_Cursor
- func (x *SingleBlockRequest) GetReference() isSingleBlockRequest_Reference
- func (x *SingleBlockRequest) GetTransforms() []*anypb.Any
- func (*SingleBlockRequest) ProtoMessage()
- func (x *SingleBlockRequest) ProtoReflect() protoreflect.Message
- func (x *SingleBlockRequest) Reset()
- func (x *SingleBlockRequest) String() string
- type SingleBlockRequest_BlockHashAndNumber
- func (*SingleBlockRequest_BlockHashAndNumber) Descriptor() ([]byte, []int)deprecated
- func (x *SingleBlockRequest_BlockHashAndNumber) GetHash() string
- func (x *SingleBlockRequest_BlockHashAndNumber) GetNum() uint64
- func (*SingleBlockRequest_BlockHashAndNumber) ProtoMessage()
- func (x *SingleBlockRequest_BlockHashAndNumber) ProtoReflect() protoreflect.Message
- func (x *SingleBlockRequest_BlockHashAndNumber) Reset()
- func (x *SingleBlockRequest_BlockHashAndNumber) String() string
- type SingleBlockRequest_BlockHashAndNumber_
- type SingleBlockRequest_BlockNumber
- func (*SingleBlockRequest_BlockNumber) Descriptor() ([]byte, []int)deprecated
- func (x *SingleBlockRequest_BlockNumber) GetNum() uint64
- func (*SingleBlockRequest_BlockNumber) ProtoMessage()
- func (x *SingleBlockRequest_BlockNumber) ProtoReflect() protoreflect.Message
- func (x *SingleBlockRequest_BlockNumber) Reset()
- func (x *SingleBlockRequest_BlockNumber) String() string
- type SingleBlockRequest_BlockNumber_
- type SingleBlockRequest_Cursor
- func (*SingleBlockRequest_Cursor) Descriptor() ([]byte, []int)deprecated
- func (x *SingleBlockRequest_Cursor) GetCursor() string
- func (*SingleBlockRequest_Cursor) ProtoMessage()
- func (x *SingleBlockRequest_Cursor) ProtoReflect() protoreflect.Message
- func (x *SingleBlockRequest_Cursor) Reset()
- func (x *SingleBlockRequest_Cursor) String() string
- type SingleBlockRequest_Cursor_
- type SingleBlockResponse
- func (*SingleBlockResponse) Descriptor() ([]byte, []int)deprecated
- func (x *SingleBlockResponse) GetBlock() *anypb.Any
- func (x *SingleBlockResponse) GetMetadata() *BlockMetadata
- func (*SingleBlockResponse) ProtoMessage()
- func (x *SingleBlockResponse) ProtoReflect() protoreflect.Message
- func (x *SingleBlockResponse) Reset()
- func (x *SingleBlockResponse) String() string
- type StreamClient
- type StreamServer
- type Stream_BlocksClient
- type Stream_BlocksServer
- type UnimplementedEndpointInfoServer
- type UnimplementedFetchServer
- type UnimplementedStreamServer
- type UnsafeEndpointInfoServer
- type UnsafeFetchServer
- type UnsafeStreamServer
Constants ¶
const (
EndpointInfo_Info_FullMethodName = "/sf.firehose.v2.EndpointInfo/Info"
)
const (
Fetch_Block_FullMethodName = "/sf.firehose.v2.Fetch/Block"
)
const (
Stream_Blocks_FullMethodName = "/sf.firehose.v2.Stream/Blocks"
)
Variables ¶
var ( ForkStep_name = map[int32]string{ 0: "STEP_UNSET", 1: "STEP_NEW", 2: "STEP_UNDO", 3: "STEP_FINAL", } ForkStep_value = map[string]int32{ "STEP_UNSET": 0, "STEP_NEW": 1, "STEP_UNDO": 2, "STEP_FINAL": 3, } )
Enum value maps for ForkStep.
var ( InfoResponse_BlockIdEncoding_name = map[int32]string{ 0: "BLOCK_ID_ENCODING_UNSET", 1: "BLOCK_ID_ENCODING_HEX", 2: "BLOCK_ID_ENCODING_0X_HEX", 3: "BLOCK_ID_ENCODING_BASE58", 4: "BLOCK_ID_ENCODING_BASE64", 5: "BLOCK_ID_ENCODING_BASE64URL", } InfoResponse_BlockIdEncoding_value = map[string]int32{ "BLOCK_ID_ENCODING_UNSET": 0, "BLOCK_ID_ENCODING_HEX": 1, "BLOCK_ID_ENCODING_0X_HEX": 2, "BLOCK_ID_ENCODING_BASE58": 3, "BLOCK_ID_ENCODING_BASE64": 4, "BLOCK_ID_ENCODING_BASE64URL": 5, } )
Enum value maps for InfoResponse_BlockIdEncoding.
var EndpointInfo_ServiceDesc = grpc.ServiceDesc{ ServiceName: "sf.firehose.v2.EndpointInfo", HandlerType: (*EndpointInfoServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "Info", Handler: _EndpointInfo_Info_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "sf/firehose/v2/firehose.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)
var Fetch_ServiceDesc = grpc.ServiceDesc{ ServiceName: "sf.firehose.v2.Fetch", HandlerType: (*FetchServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "Block", Handler: _Fetch_Block_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "sf/firehose/v2/firehose.proto", }
Fetch_ServiceDesc is the grpc.ServiceDesc for Fetch service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
var File_sf_firehose_v2_firehose_proto protoreflect.FileDescriptor
var Stream_ServiceDesc = grpc.ServiceDesc{ ServiceName: "sf.firehose.v2.Stream", HandlerType: (*StreamServer)(nil), Methods: []grpc.MethodDesc{}, Streams: []grpc.StreamDesc{ { StreamName: "Blocks", Handler: _Stream_Blocks_Handler, ServerStreams: true, }, }, Metadata: "sf/firehose/v2/firehose.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 ¶
func RegisterEndpointInfoServer(s grpc.ServiceRegistrar, srv EndpointInfoServer)
func RegisterFetchServer ¶
func RegisterFetchServer(s grpc.ServiceRegistrar, srv FetchServer)
func RegisterStreamServer ¶
func RegisterStreamServer(s grpc.ServiceRegistrar, srv StreamServer)
Types ¶
type BlockMetadata ¶
type BlockMetadata struct { // Num is the block number of this response's block. Num uint64 `protobuf:"varint,1,opt,name=num,proto3" json:"num,omitempty"` // ID is the block ID of this response's block. The ID actual representation is chain specific. // - Antelope & Ethereum uses hex. // - NEAR & Solana uses base58. // // Refer to the chain documentation for more details. Id string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"` // ParentNum is the block number of the parent of this response's block ParentNum uint64 `protobuf:"varint,3,opt,name=parent_num,json=parentNum,proto3" json:"parent_num,omitempty"` // ParentID is the block ID of the parent of this response's block. If this response is the genesis block, // this field is empty. // // The ID actual representation is chain specific. // - Antelope & Ethereum uses hex. // - NEAR & Solana uses base58. // // Refer to the chain documentation for more details. ParentId string `protobuf:"bytes,4,opt,name=parent_id,json=parentId,proto3" json:"parent_id,omitempty"` // LibNum is the block number of the last irreversible block (a.k.a last finalized block) at the time of this // response' block. It determines the finality of the block. LibNum uint64 `protobuf:"varint,5,opt,name=lib_num,json=libNum,proto3" json:"lib_num,omitempty"` // Time is the time at which the block was produced. Time *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=time,proto3" json:"time,omitempty"` // contains filtered or unexported fields }
func (*BlockMetadata) Descriptor
deprecated
func (*BlockMetadata) Descriptor() ([]byte, []int)
Deprecated: Use BlockMetadata.ProtoReflect.Descriptor instead.
func (*BlockMetadata) GetId ¶
func (x *BlockMetadata) GetId() string
func (*BlockMetadata) GetLibNum ¶
func (x *BlockMetadata) GetLibNum() uint64
func (*BlockMetadata) GetNum ¶
func (x *BlockMetadata) GetNum() uint64
func (*BlockMetadata) GetParentId ¶
func (x *BlockMetadata) GetParentId() string
func (*BlockMetadata) GetParentNum ¶
func (x *BlockMetadata) GetParentNum() uint64
func (*BlockMetadata) GetTime ¶
func (x *BlockMetadata) GetTime() *timestamppb.Timestamp
func (*BlockMetadata) ProtoMessage ¶
func (*BlockMetadata) ProtoMessage()
func (*BlockMetadata) ProtoReflect ¶
func (x *BlockMetadata) ProtoReflect() protoreflect.Message
func (*BlockMetadata) Reset ¶
func (x *BlockMetadata) Reset()
func (*BlockMetadata) String ¶
func (x *BlockMetadata) String() string
type EndpointInfoClient ¶
type EndpointInfoClient interface {
Info(ctx context.Context, in *InfoRequest, opts ...grpc.CallOption) (*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 ¶
func NewEndpointInfoClient(cc grpc.ClientConnInterface) EndpointInfoClient
type EndpointInfoServer ¶
type EndpointInfoServer interface {
Info(context.Context, *InfoRequest) (*InfoResponse, error)
}
EndpointInfoServer is the server API for EndpointInfo service. All implementations should embed UnimplementedEndpointInfoServer for forward compatibility.
type FetchClient ¶
type FetchClient interface {
Block(ctx context.Context, in *SingleBlockRequest, opts ...grpc.CallOption) (*SingleBlockResponse, error)
}
FetchClient is the client API for Fetch 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 NewFetchClient ¶
func NewFetchClient(cc grpc.ClientConnInterface) FetchClient
type FetchServer ¶
type FetchServer interface {
Block(context.Context, *SingleBlockRequest) (*SingleBlockResponse, error)
}
FetchServer is the server API for Fetch service. All implementations should embed UnimplementedFetchServer for forward compatibility.
type ForkStep ¶
type ForkStep int32
const ( ForkStep_STEP_UNSET ForkStep = 0 // Incoming block ForkStep_STEP_NEW ForkStep = 1 // A reorg caused this specific block to be excluded from the chain ForkStep_STEP_UNDO ForkStep = 2 // Block is now final and can be committed (finality is chain specific, // see chain documentation for more details) ForkStep_STEP_FINAL ForkStep = 3 )
func (ForkStep) Descriptor ¶
func (ForkStep) Descriptor() protoreflect.EnumDescriptor
func (ForkStep) EnumDescriptor
deprecated
func (ForkStep) Number ¶
func (x ForkStep) Number() protoreflect.EnumNumber
func (ForkStep) Type ¶
func (ForkStep) Type() protoreflect.EnumType
type InfoRequest ¶
type InfoRequest struct {
// contains filtered or unexported fields
}
func (*InfoRequest) Descriptor
deprecated
func (*InfoRequest) Descriptor() ([]byte, []int)
Deprecated: Use InfoRequest.ProtoReflect.Descriptor instead.
func (*InfoRequest) ProtoMessage ¶
func (*InfoRequest) ProtoMessage()
func (*InfoRequest) ProtoReflect ¶
func (x *InfoRequest) ProtoReflect() protoreflect.Message
func (*InfoRequest) Reset ¶
func (x *InfoRequest) Reset()
func (*InfoRequest) String ¶
func (x *InfoRequest) String() string
type InfoResponse ¶
type InfoResponse struct { // Canonical chain name from https://thegraph.com/docs/en/developing/supported-networks/ (ex: matic, mainnet ...) ChainName string `protobuf:"bytes,1,opt,name=chain_name,json=chainName,proto3" json:"chain_name,omitempty"` // Alternate names for the chain. ChainNameAliases []string `protobuf:"bytes,2,rep,name=chain_name_aliases,json=chainNameAliases,proto3" json:"chain_name_aliases,omitempty"` // First block that is served by this endpoint. This should usually be the genesis block, // but some providers may have truncated history. FirstStreamableBlockNum uint64 `` /* 135-byte string literal not displayed */ FirstStreamableBlockId string `` /* 131-byte string literal not displayed */ // This informs the client on how to decode the `block_id` field inside the "Clock" message // as well as the `first_streamable_block_id` above. BlockIdEncoding InfoResponse_BlockIdEncoding `` /* 158-byte string literal not displayed */ // features describes the blocks. Popular values for EVM chains include `base`, `extended` or `hybrid`. BlockFeatures []string `protobuf:"bytes,10,rep,name=block_features,json=blockFeatures,proto3" json:"block_features,omitempty"` // contains filtered or unexported fields }
func (*InfoResponse) Descriptor
deprecated
func (*InfoResponse) Descriptor() ([]byte, []int)
Deprecated: Use InfoResponse.ProtoReflect.Descriptor instead.
func (*InfoResponse) GetBlockFeatures ¶
func (x *InfoResponse) GetBlockFeatures() []string
func (*InfoResponse) GetBlockIdEncoding ¶
func (x *InfoResponse) GetBlockIdEncoding() InfoResponse_BlockIdEncoding
func (*InfoResponse) GetChainName ¶
func (x *InfoResponse) GetChainName() string
func (*InfoResponse) GetChainNameAliases ¶
func (x *InfoResponse) GetChainNameAliases() []string
func (*InfoResponse) GetFirstStreamableBlockId ¶
func (x *InfoResponse) GetFirstStreamableBlockId() string
func (*InfoResponse) GetFirstStreamableBlockNum ¶
func (x *InfoResponse) GetFirstStreamableBlockNum() uint64
func (*InfoResponse) ProtoMessage ¶
func (*InfoResponse) ProtoMessage()
func (*InfoResponse) ProtoReflect ¶
func (x *InfoResponse) ProtoReflect() protoreflect.Message
func (*InfoResponse) Reset ¶
func (x *InfoResponse) Reset()
func (*InfoResponse) String ¶
func (x *InfoResponse) String() string
type InfoResponse_BlockIdEncoding ¶
type InfoResponse_BlockIdEncoding int32
const ( InfoResponse_BLOCK_ID_ENCODING_UNSET InfoResponse_BlockIdEncoding = 0 InfoResponse_BLOCK_ID_ENCODING_HEX InfoResponse_BlockIdEncoding = 1 InfoResponse_BLOCK_ID_ENCODING_0X_HEX InfoResponse_BlockIdEncoding = 2 InfoResponse_BLOCK_ID_ENCODING_BASE58 InfoResponse_BlockIdEncoding = 3 InfoResponse_BLOCK_ID_ENCODING_BASE64 InfoResponse_BlockIdEncoding = 4 InfoResponse_BLOCK_ID_ENCODING_BASE64URL InfoResponse_BlockIdEncoding = 5 )
func (InfoResponse_BlockIdEncoding) Descriptor ¶
func (InfoResponse_BlockIdEncoding) Descriptor() protoreflect.EnumDescriptor
func (InfoResponse_BlockIdEncoding) Enum ¶
func (x InfoResponse_BlockIdEncoding) Enum() *InfoResponse_BlockIdEncoding
func (InfoResponse_BlockIdEncoding) EnumDescriptor
deprecated
func (InfoResponse_BlockIdEncoding) EnumDescriptor() ([]byte, []int)
Deprecated: Use InfoResponse_BlockIdEncoding.Descriptor instead.
func (InfoResponse_BlockIdEncoding) Number ¶
func (x InfoResponse_BlockIdEncoding) Number() protoreflect.EnumNumber
func (InfoResponse_BlockIdEncoding) String ¶
func (x InfoResponse_BlockIdEncoding) String() string
func (InfoResponse_BlockIdEncoding) Type ¶
func (InfoResponse_BlockIdEncoding) Type() protoreflect.EnumType
type Request ¶
type Request struct { // Controls where the stream of blocks will start. // // The stream will start **inclusively** at the requested block num. // // When not provided, starts at first streamable block of the chain. Not all // chain starts at the same block number, so you might get an higher block than // requested when using default value of 0. // // Can be negative, will be resolved relative to the chain head block, assuming // a chain at head block #100, then using `-50` as the value will start at block // #50. If it resolves before first streamable block of chain, we assume start // of chain. // // If `start_cursor` is given, this value is ignored and the stream instead starts // immediately after the Block pointed by the opaque `start_cursor` value. StartBlockNum int64 `protobuf:"varint,1,opt,name=start_block_num,json=startBlockNum,proto3" json:"start_block_num,omitempty"` // Controls where the stream of blocks will start which will be immediately after // the Block pointed by this opaque cursor. // // Obtain this value from a previously received `Response.cursor`. // // This value takes precedence over `start_block_num`. Cursor string `protobuf:"bytes,2,opt,name=cursor,proto3" json:"cursor,omitempty"` // When non-zero, controls where the stream of blocks will stop. // // The stream will close **after** that block has passed so the boundary is // **inclusive**. 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 with STEP_FINAL // Default behavior will send blocks as STEP_NEW, with occasional STEP_UNDO FinalBlocksOnly bool `protobuf:"varint,4,opt,name=final_blocks_only,json=finalBlocksOnly,proto3" json:"final_blocks_only,omitempty"` Transforms []*anypb.Any `protobuf:"bytes,10,rep,name=transforms,proto3" json:"transforms,omitempty"` // contains filtered or unexported fields }
func (*Request) Descriptor
deprecated
func (*Request) GetFinalBlocksOnly ¶
func (*Request) GetStartBlockNum ¶
func (*Request) GetStopBlockNum ¶
func (*Request) GetTransforms ¶
func (*Request) ProtoMessage ¶
func (*Request) ProtoMessage()
func (*Request) ProtoReflect ¶
func (x *Request) ProtoReflect() protoreflect.Message
type Response ¶
type Response struct { // Chain specific block payload, ex: // - sf.eosio.type.v1.Block // - sf.ethereum.type.v1.Block // - sf.near.type.v1.Block Block *anypb.Any `protobuf:"bytes,1,opt,name=block,proto3" json:"block,omitempty"` Step ForkStep `protobuf:"varint,6,opt,name=step,proto3,enum=sf.firehose.v2.ForkStep" json:"step,omitempty"` Cursor string `protobuf:"bytes,10,opt,name=cursor,proto3" json:"cursor,omitempty"` // Metadata about the block, added in some Firehose version, so consumer // should be ready to handle the absence of this field. Metadata *BlockMetadata `protobuf:"bytes,12,opt,name=metadata,proto3" json:"metadata,omitempty"` // contains filtered or unexported fields }
func (*Response) Descriptor
deprecated
func (*Response) GetMetadata ¶
func (x *Response) GetMetadata() *BlockMetadata
func (*Response) ProtoMessage ¶
func (*Response) ProtoMessage()
func (*Response) ProtoReflect ¶
func (x *Response) ProtoReflect() protoreflect.Message
type SingleBlockRequest ¶
type SingleBlockRequest struct { // Types that are valid to be assigned to Reference: // // *SingleBlockRequest_BlockNumber_ // *SingleBlockRequest_BlockHashAndNumber_ // *SingleBlockRequest_Cursor_ Reference isSingleBlockRequest_Reference `protobuf_oneof:"reference"` Transforms []*anypb.Any `protobuf:"bytes,6,rep,name=transforms,proto3" json:"transforms,omitempty"` // contains filtered or unexported fields }
func (*SingleBlockRequest) Descriptor
deprecated
func (*SingleBlockRequest) Descriptor() ([]byte, []int)
Deprecated: Use SingleBlockRequest.ProtoReflect.Descriptor instead.
func (*SingleBlockRequest) GetBlockHashAndNumber ¶
func (x *SingleBlockRequest) GetBlockHashAndNumber() *SingleBlockRequest_BlockHashAndNumber
func (*SingleBlockRequest) GetBlockNumber ¶
func (x *SingleBlockRequest) GetBlockNumber() *SingleBlockRequest_BlockNumber
func (*SingleBlockRequest) GetCursor ¶
func (x *SingleBlockRequest) GetCursor() *SingleBlockRequest_Cursor
func (*SingleBlockRequest) GetReference ¶
func (x *SingleBlockRequest) GetReference() isSingleBlockRequest_Reference
func (*SingleBlockRequest) GetTransforms ¶
func (x *SingleBlockRequest) GetTransforms() []*anypb.Any
func (*SingleBlockRequest) ProtoMessage ¶
func (*SingleBlockRequest) ProtoMessage()
func (*SingleBlockRequest) ProtoReflect ¶
func (x *SingleBlockRequest) ProtoReflect() protoreflect.Message
func (*SingleBlockRequest) Reset ¶
func (x *SingleBlockRequest) Reset()
func (*SingleBlockRequest) String ¶
func (x *SingleBlockRequest) String() string
type SingleBlockRequest_BlockHashAndNumber ¶
type SingleBlockRequest_BlockHashAndNumber struct { Num uint64 `protobuf:"varint,1,opt,name=num,proto3" json:"num,omitempty"` Hash string `protobuf:"bytes,2,opt,name=hash,proto3" json:"hash,omitempty"` // contains filtered or unexported fields }
Get the current block with specific hash and number
func (*SingleBlockRequest_BlockHashAndNumber) Descriptor
deprecated
func (*SingleBlockRequest_BlockHashAndNumber) Descriptor() ([]byte, []int)
Deprecated: Use SingleBlockRequest_BlockHashAndNumber.ProtoReflect.Descriptor instead.
func (*SingleBlockRequest_BlockHashAndNumber) GetHash ¶
func (x *SingleBlockRequest_BlockHashAndNumber) GetHash() string
func (*SingleBlockRequest_BlockHashAndNumber) GetNum ¶
func (x *SingleBlockRequest_BlockHashAndNumber) GetNum() uint64
func (*SingleBlockRequest_BlockHashAndNumber) ProtoMessage ¶
func (*SingleBlockRequest_BlockHashAndNumber) ProtoMessage()
func (*SingleBlockRequest_BlockHashAndNumber) ProtoReflect ¶
func (x *SingleBlockRequest_BlockHashAndNumber) ProtoReflect() protoreflect.Message
func (*SingleBlockRequest_BlockHashAndNumber) Reset ¶
func (x *SingleBlockRequest_BlockHashAndNumber) Reset()
func (*SingleBlockRequest_BlockHashAndNumber) String ¶
func (x *SingleBlockRequest_BlockHashAndNumber) String() string
type SingleBlockRequest_BlockHashAndNumber_ ¶
type SingleBlockRequest_BlockHashAndNumber_ struct {
BlockHashAndNumber *SingleBlockRequest_BlockHashAndNumber `protobuf:"bytes,4,opt,name=block_hash_and_number,json=blockHashAndNumber,proto3,oneof"`
}
type SingleBlockRequest_BlockNumber ¶
type SingleBlockRequest_BlockNumber struct { Num uint64 `protobuf:"varint,1,opt,name=num,proto3" json:"num,omitempty"` // contains filtered or unexported fields }
Get the current known canonical version of a block at with this number
func (*SingleBlockRequest_BlockNumber) Descriptor
deprecated
func (*SingleBlockRequest_BlockNumber) Descriptor() ([]byte, []int)
Deprecated: Use SingleBlockRequest_BlockNumber.ProtoReflect.Descriptor instead.
func (*SingleBlockRequest_BlockNumber) GetNum ¶
func (x *SingleBlockRequest_BlockNumber) GetNum() uint64
func (*SingleBlockRequest_BlockNumber) ProtoMessage ¶
func (*SingleBlockRequest_BlockNumber) ProtoMessage()
func (*SingleBlockRequest_BlockNumber) ProtoReflect ¶
func (x *SingleBlockRequest_BlockNumber) ProtoReflect() protoreflect.Message
func (*SingleBlockRequest_BlockNumber) Reset ¶
func (x *SingleBlockRequest_BlockNumber) Reset()
func (*SingleBlockRequest_BlockNumber) String ¶
func (x *SingleBlockRequest_BlockNumber) String() string
type SingleBlockRequest_BlockNumber_ ¶
type SingleBlockRequest_BlockNumber_ struct {
BlockNumber *SingleBlockRequest_BlockNumber `protobuf:"bytes,3,opt,name=block_number,json=blockNumber,proto3,oneof"`
}
type SingleBlockRequest_Cursor ¶
type SingleBlockRequest_Cursor struct { Cursor string `protobuf:"bytes,1,opt,name=cursor,proto3" json:"cursor,omitempty"` // contains filtered or unexported fields }
Get the block that generated a specific cursor
func (*SingleBlockRequest_Cursor) Descriptor
deprecated
func (*SingleBlockRequest_Cursor) Descriptor() ([]byte, []int)
Deprecated: Use SingleBlockRequest_Cursor.ProtoReflect.Descriptor instead.
func (*SingleBlockRequest_Cursor) GetCursor ¶
func (x *SingleBlockRequest_Cursor) GetCursor() string
func (*SingleBlockRequest_Cursor) ProtoMessage ¶
func (*SingleBlockRequest_Cursor) ProtoMessage()
func (*SingleBlockRequest_Cursor) ProtoReflect ¶
func (x *SingleBlockRequest_Cursor) ProtoReflect() protoreflect.Message
func (*SingleBlockRequest_Cursor) Reset ¶
func (x *SingleBlockRequest_Cursor) Reset()
func (*SingleBlockRequest_Cursor) String ¶
func (x *SingleBlockRequest_Cursor) String() string
type SingleBlockRequest_Cursor_ ¶
type SingleBlockRequest_Cursor_ struct {
Cursor *SingleBlockRequest_Cursor `protobuf:"bytes,5,opt,name=cursor,proto3,oneof"`
}
type SingleBlockResponse ¶
type SingleBlockResponse struct { Block *anypb.Any `protobuf:"bytes,1,opt,name=block,proto3" json:"block,omitempty"` // Metadata about the block, added in some Firehose version, so consumer // should be ready to handle the absence of this field. Metadata *BlockMetadata `protobuf:"bytes,2,opt,name=metadata,proto3" json:"metadata,omitempty"` // contains filtered or unexported fields }
func (*SingleBlockResponse) Descriptor
deprecated
func (*SingleBlockResponse) Descriptor() ([]byte, []int)
Deprecated: Use SingleBlockResponse.ProtoReflect.Descriptor instead.
func (*SingleBlockResponse) GetBlock ¶
func (x *SingleBlockResponse) GetBlock() *anypb.Any
func (*SingleBlockResponse) GetMetadata ¶
func (x *SingleBlockResponse) GetMetadata() *BlockMetadata
func (*SingleBlockResponse) ProtoMessage ¶
func (*SingleBlockResponse) ProtoMessage()
func (*SingleBlockResponse) ProtoReflect ¶
func (x *SingleBlockResponse) ProtoReflect() protoreflect.Message
func (*SingleBlockResponse) Reset ¶
func (x *SingleBlockResponse) Reset()
func (*SingleBlockResponse) String ¶
func (x *SingleBlockResponse) String() string
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 ¶
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 ¶
func (UnimplementedEndpointInfoServer) Info(context.Context, *InfoRequest) (*InfoResponse, error)
type UnimplementedFetchServer ¶
type UnimplementedFetchServer struct{}
UnimplementedFetchServer 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 (UnimplementedFetchServer) Block ¶
func (UnimplementedFetchServer) Block(context.Context, *SingleBlockRequest) (*SingleBlockResponse, 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 ¶
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 UnsafeFetchServer ¶
type UnsafeFetchServer interface {
// contains filtered or unexported methods
}
UnsafeFetchServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to FetchServer 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.