message_api

package
v1.0.2 Latest Latest
Warning

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

 Go to latest Published: Jul 17, 2025 License: MIT Imports: 19 Imported by: 0

Documentation

Overview

Package message_api is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Package message_api is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

View Source 
const (
	ReplicationApi_SubscribeEnvelopes_FullMethodName    = "/xmtp.xmtpv4.message_api.ReplicationApi/SubscribeEnvelopes"
	ReplicationApi_QueryEnvelopes_FullMethodName        = "/xmtp.xmtpv4.message_api.ReplicationApi/QueryEnvelopes"
	ReplicationApi_PublishPayerEnvelopes_FullMethodName = "/xmtp.xmtpv4.message_api.ReplicationApi/PublishPayerEnvelopes"
	ReplicationApi_GetInboxIds_FullMethodName           = "/xmtp.xmtpv4.message_api.ReplicationApi/GetInboxIds"
	ReplicationApi_GetNewestEnvelope_FullMethodName     = "/xmtp.xmtpv4.message_api.ReplicationApi/GetNewestEnvelope"
)
View Source 
const (
	MisbehaviorApi_SubmitMisbehaviorReport_FullMethodName = "/xmtp.xmtpv4.message_api.MisbehaviorApi/SubmitMisbehaviorReport"
	MisbehaviorApi_QueryMisbehaviorReports_FullMethodName = "/xmtp.xmtpv4.message_api.MisbehaviorApi/QueryMisbehaviorReports"
)

Variables

View Source 
var (
	Misbehavior_name = map[int32]string{
		0: "MISBEHAVIOR_UNSPECIFIED",
		1: "MISBEHAVIOR_UNRESPONSIVE_NODE",
		2: "MISBEHAVIOR_SLOW_NODE",
		3: "MISBEHAVIOR_FAILED_REQUEST",
		4: "MISBEHAVIOR_OUT_OF_ORDER",
		5: "MISBEHAVIOR_DUPLICATE_SEQUENCE_ID",
		6: "MISBEHAVIOR_CAUSAL_ORDERING",
		7: "MISBEHAVIOR_INVALID_PAYLOAD",
		8: "MISBEHAVIOR_BLOCKCHAIN_INCONSISTENCY",
	}
	Misbehavior_value = map[string]int32{
		"MISBEHAVIOR_UNSPECIFIED":              0,
		"MISBEHAVIOR_UNRESPONSIVE_NODE":        1,
		"MISBEHAVIOR_SLOW_NODE":                2,
		"MISBEHAVIOR_FAILED_REQUEST":           3,
		"MISBEHAVIOR_OUT_OF_ORDER":             4,
		"MISBEHAVIOR_DUPLICATE_SEQUENCE_ID":    5,
		"MISBEHAVIOR_CAUSAL_ORDERING":          6,
		"MISBEHAVIOR_INVALID_PAYLOAD":          7,
		"MISBEHAVIOR_BLOCKCHAIN_INCONSISTENCY": 8,
	}
)

Enum value maps for Misbehavior.

View Source 
var File_xmtpv4_message_api_message_api_proto protoreflect.FileDescriptor
View Source 
var File_xmtpv4_message_api_misbehavior_api_proto protoreflect.FileDescriptor
View Source 
var MisbehaviorApi_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "xmtp.xmtpv4.message_api.MisbehaviorApi",
	HandlerType: (*MisbehaviorApiServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "SubmitMisbehaviorReport",
			Handler:    _MisbehaviorApi_SubmitMisbehaviorReport_Handler,
		},
		{
			MethodName: "QueryMisbehaviorReports",
			Handler:    _MisbehaviorApi_QueryMisbehaviorReports_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "xmtpv4/message_api/misbehavior_api.proto",
}

MisbehaviorApi_ServiceDesc is the grpc.ServiceDesc for MisbehaviorApi 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 ReplicationApi_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "xmtp.xmtpv4.message_api.ReplicationApi",
	HandlerType: (*ReplicationApiServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "QueryEnvelopes",
			Handler:    _ReplicationApi_QueryEnvelopes_Handler,
		},
		{
			MethodName: "PublishPayerEnvelopes",
			Handler:    _ReplicationApi_PublishPayerEnvelopes_Handler,
		},
		{
			MethodName: "GetInboxIds",
			Handler:    _ReplicationApi_GetInboxIds_Handler,
		},
		{
			MethodName: "GetNewestEnvelope",
			Handler:    _ReplicationApi_GetNewestEnvelope_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "SubscribeEnvelopes",
			Handler:       _ReplicationApi_SubscribeEnvelopes_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "xmtpv4/message_api/message_api.proto",
}

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

Functions

func RegisterMisbehaviorApiHandler 

func RegisterMisbehaviorApiHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterMisbehaviorApiHandler registers the http handlers for service MisbehaviorApi to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterMisbehaviorApiHandlerClient 

func RegisterMisbehaviorApiHandlerClient(ctx context.Context, mux *runtime.ServeMux, client MisbehaviorApiClient) error

RegisterMisbehaviorApiHandlerClient registers the http handlers for service MisbehaviorApi to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "MisbehaviorApiClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "MisbehaviorApiClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "MisbehaviorApiClient" to call the correct interceptors.

func RegisterMisbehaviorApiHandlerFromEndpoint 

func RegisterMisbehaviorApiHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterMisbehaviorApiHandlerFromEndpoint is same as RegisterMisbehaviorApiHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterMisbehaviorApiHandlerServer 

func RegisterMisbehaviorApiHandlerServer(ctx context.Context, mux *runtime.ServeMux, server MisbehaviorApiServer) error

RegisterMisbehaviorApiHandlerServer registers the http handlers for service MisbehaviorApi to "mux". UnaryRPC :call MisbehaviorApiServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterMisbehaviorApiHandlerFromEndpoint instead.

func RegisterMisbehaviorApiServer 

func RegisterMisbehaviorApiServer(s grpc.ServiceRegistrar, srv MisbehaviorApiServer)

func RegisterReplicationApiHandler 

func RegisterReplicationApiHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterReplicationApiHandler registers the http handlers for service ReplicationApi to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterReplicationApiHandlerClient 

func RegisterReplicationApiHandlerClient(ctx context.Context, mux *runtime.ServeMux, client ReplicationApiClient) error

RegisterReplicationApiHandlerClient registers the http handlers for service ReplicationApi to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "ReplicationApiClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "ReplicationApiClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "ReplicationApiClient" to call the correct interceptors.

func RegisterReplicationApiHandlerFromEndpoint 

func RegisterReplicationApiHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterReplicationApiHandlerFromEndpoint is same as RegisterReplicationApiHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterReplicationApiHandlerServer 

func RegisterReplicationApiHandlerServer(ctx context.Context, mux *runtime.ServeMux, server ReplicationApiServer) error

RegisterReplicationApiHandlerServer registers the http handlers for service ReplicationApi to "mux". UnaryRPC :call ReplicationApiServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterReplicationApiHandlerFromEndpoint instead.

func RegisterReplicationApiServer 

func RegisterReplicationApiServer(s grpc.ServiceRegistrar, srv ReplicationApiServer)

Types

type EnvelopesQuery 

type EnvelopesQuery struct {

	// Client queries
	Topics [][]byte `protobuf:"bytes,1,rep,name=topics,proto3" json:"topics,omitempty"`
	// Node queries
	OriginatorNodeIds []uint32          `protobuf:"varint,2,rep,packed,name=originator_node_ids,json=originatorNodeIds,proto3" json:"originator_node_ids,omitempty"`
	LastSeen          *envelopes.Cursor `protobuf:"bytes,3,opt,name=last_seen,json=lastSeen,proto3" json:"last_seen,omitempty"`
	// contains filtered or unexported fields
}

Query for envelopes, shared by query and subscribe endpoints Either topics or originator_node_ids may be set, but not both

func (*EnvelopesQuery) Descriptor deprecated 

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

Deprecated: Use EnvelopesQuery.ProtoReflect.Descriptor instead.

func (*EnvelopesQuery) GetLastSeen 

func (x *EnvelopesQuery) GetLastSeen() *envelopes.Cursor

func (*EnvelopesQuery) GetOriginatorNodeIds 

func (x *EnvelopesQuery) GetOriginatorNodeIds() []uint32

func (*EnvelopesQuery) GetTopics 

func (x *EnvelopesQuery) GetTopics() [][]byte

func (*EnvelopesQuery) ProtoMessage 

func (*EnvelopesQuery) ProtoMessage()

func (*EnvelopesQuery) ProtoReflect 

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

func (*EnvelopesQuery) Reset 

func (x *EnvelopesQuery) Reset()

func (*EnvelopesQuery) String 

func (x *EnvelopesQuery) String() string

type GetInboxIdsRequest 

type GetInboxIdsRequest struct {
	Requests []*GetInboxIdsRequest_Request `protobuf:"bytes,1,rep,name=requests,proto3" json:"requests,omitempty"`
	// contains filtered or unexported fields
}

Request to retrieve the XIDs for the given addresses

func (*GetInboxIdsRequest) Descriptor deprecated 

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

Deprecated: Use GetInboxIdsRequest.ProtoReflect.Descriptor instead.

func (*GetInboxIdsRequest) GetRequests 

func (x *GetInboxIdsRequest) GetRequests() []*GetInboxIdsRequest_Request

func (*GetInboxIdsRequest) ProtoMessage 

func (*GetInboxIdsRequest) ProtoMessage()

func (*GetInboxIdsRequest) ProtoReflect 

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

func (*GetInboxIdsRequest) Reset 

func (x *GetInboxIdsRequest) Reset()

func (*GetInboxIdsRequest) String 

func (x *GetInboxIdsRequest) String() string

type GetInboxIdsRequest_Request 

type GetInboxIdsRequest_Request struct {
	Identifier     string                      `protobuf:"bytes,1,opt,name=identifier,proto3" json:"identifier,omitempty"`
	IdentifierKind associations.IdentifierKind `` /* 151-byte string literal not displayed */
	// contains filtered or unexported fields
}

A single request for a given address

func (*GetInboxIdsRequest_Request) Descriptor deprecated 

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

Deprecated: Use GetInboxIdsRequest_Request.ProtoReflect.Descriptor instead.

func (*GetInboxIdsRequest_Request) GetIdentifier 

func (x *GetInboxIdsRequest_Request) GetIdentifier() string

func (*GetInboxIdsRequest_Request) GetIdentifierKind 

func (x *GetInboxIdsRequest_Request) GetIdentifierKind() associations.IdentifierKind

func (*GetInboxIdsRequest_Request) ProtoMessage 

func (*GetInboxIdsRequest_Request) ProtoMessage()

func (*GetInboxIdsRequest_Request) ProtoReflect 

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

func (*GetInboxIdsRequest_Request) Reset 

func (x *GetInboxIdsRequest_Request) Reset()

func (*GetInboxIdsRequest_Request) String 

func (x *GetInboxIdsRequest_Request) String() string

type GetInboxIdsResponse 

type GetInboxIdsResponse struct {
	Responses []*GetInboxIdsResponse_Response `protobuf:"bytes,1,rep,name=responses,proto3" json:"responses,omitempty"`
	// contains filtered or unexported fields
}

Response with the XIDs for the requested addresses

func (*GetInboxIdsResponse) Descriptor deprecated 

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

Deprecated: Use GetInboxIdsResponse.ProtoReflect.Descriptor instead.

func (*GetInboxIdsResponse) GetResponses 

func (x *GetInboxIdsResponse) GetResponses() []*GetInboxIdsResponse_Response

func (*GetInboxIdsResponse) ProtoMessage 

func (*GetInboxIdsResponse) ProtoMessage()

func (*GetInboxIdsResponse) ProtoReflect 

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

func (*GetInboxIdsResponse) Reset 

func (x *GetInboxIdsResponse) Reset()

func (*GetInboxIdsResponse) String 

func (x *GetInboxIdsResponse) String() string

type GetInboxIdsResponse_Response 

type GetInboxIdsResponse_Response struct {
	Identifier     string                      `protobuf:"bytes,1,opt,name=identifier,proto3" json:"identifier,omitempty"`
	InboxId        *string                     `protobuf:"bytes,2,opt,name=inbox_id,json=inboxId,proto3,oneof" json:"inbox_id,omitempty"`
	IdentifierKind associations.IdentifierKind `` /* 151-byte string literal not displayed */
	// contains filtered or unexported fields
}

A single response for a given address

func (*GetInboxIdsResponse_Response) Descriptor deprecated 

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

Deprecated: Use GetInboxIdsResponse_Response.ProtoReflect.Descriptor instead.

func (*GetInboxIdsResponse_Response) GetIdentifier 

func (x *GetInboxIdsResponse_Response) GetIdentifier() string

func (*GetInboxIdsResponse_Response) GetIdentifierKind 

func (x *GetInboxIdsResponse_Response) GetIdentifierKind() associations.IdentifierKind

func (*GetInboxIdsResponse_Response) GetInboxId 

func (x *GetInboxIdsResponse_Response) GetInboxId() string

func (*GetInboxIdsResponse_Response) ProtoMessage 

func (*GetInboxIdsResponse_Response) ProtoMessage()

func (*GetInboxIdsResponse_Response) ProtoReflect 

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

func (*GetInboxIdsResponse_Response) Reset 

func (x *GetInboxIdsResponse_Response) Reset()

func (*GetInboxIdsResponse_Response) String 

func (x *GetInboxIdsResponse_Response) String() string

type GetNewestEnvelopeRequest 

type GetNewestEnvelopeRequest struct {
	Topics [][]byte `protobuf:"bytes,1,rep,name=topics,proto3" json:"topics,omitempty"`
	// contains filtered or unexported fields
}

Request to get the newest envelope for a given topic

func (*GetNewestEnvelopeRequest) Descriptor deprecated 

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

Deprecated: Use GetNewestEnvelopeRequest.ProtoReflect.Descriptor instead.

func (*GetNewestEnvelopeRequest) GetTopics 

func (x *GetNewestEnvelopeRequest) GetTopics() [][]byte

func (*GetNewestEnvelopeRequest) ProtoMessage 

func (*GetNewestEnvelopeRequest) ProtoMessage()

func (*GetNewestEnvelopeRequest) ProtoReflect 

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

func (*GetNewestEnvelopeRequest) Reset 

func (x *GetNewestEnvelopeRequest) Reset()

func (*GetNewestEnvelopeRequest) String 

func (x *GetNewestEnvelopeRequest) String() string

type GetNewestEnvelopeResponse 

type GetNewestEnvelopeResponse struct {

	// The newest envelope for the given topic OR null if there are no envelopes on the topic
	Results []*GetNewestEnvelopeResponse_Response `protobuf:"bytes,1,rep,name=results,proto3" json:"results,omitempty"`
	// contains filtered or unexported fields
}

Response to GetNewestEnvelopeRequest

func (*GetNewestEnvelopeResponse) Descriptor deprecated 

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

Deprecated: Use GetNewestEnvelopeResponse.ProtoReflect.Descriptor instead.

func (*GetNewestEnvelopeResponse) GetResults 

func (x *GetNewestEnvelopeResponse) GetResults() []*GetNewestEnvelopeResponse_Response

func (*GetNewestEnvelopeResponse) ProtoMessage 

func (*GetNewestEnvelopeResponse) ProtoMessage()

func (*GetNewestEnvelopeResponse) ProtoReflect 

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

func (*GetNewestEnvelopeResponse) Reset 

func (x *GetNewestEnvelopeResponse) Reset()

func (*GetNewestEnvelopeResponse) String 

func (x *GetNewestEnvelopeResponse) String() string

type GetNewestEnvelopeResponse_Response 

type GetNewestEnvelopeResponse_Response struct {
	OriginatorEnvelope *envelopes.OriginatorEnvelope `protobuf:"bytes,1,opt,name=originator_envelope,json=originatorEnvelope,proto3,oneof" json:"originator_envelope,omitempty"`
	// contains filtered or unexported fields
}

func (*GetNewestEnvelopeResponse_Response) Descriptor deprecated 

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

Deprecated: Use GetNewestEnvelopeResponse_Response.ProtoReflect.Descriptor instead.

func (*GetNewestEnvelopeResponse_Response) GetOriginatorEnvelope 

func (x *GetNewestEnvelopeResponse_Response) GetOriginatorEnvelope() *envelopes.OriginatorEnvelope

func (*GetNewestEnvelopeResponse_Response) ProtoMessage 

func (*GetNewestEnvelopeResponse_Response) ProtoMessage()

func (*GetNewestEnvelopeResponse_Response) ProtoReflect 

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

func (*GetNewestEnvelopeResponse_Response) Reset 

func (x *GetNewestEnvelopeResponse_Response) Reset()

func (*GetNewestEnvelopeResponse_Response) String 

func (x *GetNewestEnvelopeResponse_Response) String() string

type LivenessFailure 

type LivenessFailure struct {
	ResponseTimeNs uint32 `protobuf:"varint,1,opt,name=response_time_ns,json=responseTimeNs,proto3" json:"response_time_ns,omitempty"`
	// Types that are valid to be assigned to Request:
	//
	//	*LivenessFailure_Subscribe
	//	*LivenessFailure_Query
	//	*LivenessFailure_Publish
	Request isLivenessFailure_Request `protobuf_oneof:"request"`
	// contains filtered or unexported fields
}

func (*LivenessFailure) Descriptor deprecated 

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

Deprecated: Use LivenessFailure.ProtoReflect.Descriptor instead.

func (*LivenessFailure) GetPublish 

func (x *LivenessFailure) GetPublish() *PublishPayerEnvelopesRequest

func (*LivenessFailure) GetQuery 

func (x *LivenessFailure) GetQuery() *QueryEnvelopesRequest

func (*LivenessFailure) GetRequest 

func (x *LivenessFailure) GetRequest() isLivenessFailure_Request

func (*LivenessFailure) GetResponseTimeNs 

func (x *LivenessFailure) GetResponseTimeNs() uint32

func (*LivenessFailure) GetSubscribe 

func (x *LivenessFailure) GetSubscribe() *SubscribeEnvelopesRequest

func (*LivenessFailure) ProtoMessage 

func (*LivenessFailure) ProtoMessage()

func (*LivenessFailure) ProtoReflect 

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

func (*LivenessFailure) Reset 

func (x *LivenessFailure) Reset()

func (*LivenessFailure) String 

func (x *LivenessFailure) String() string

type LivenessFailure_Publish 

type LivenessFailure_Publish struct {
	Publish *PublishPayerEnvelopesRequest `protobuf:"bytes,4,opt,name=publish,proto3,oneof"`
}

type LivenessFailure_Query 

type LivenessFailure_Query struct {
	Query *QueryEnvelopesRequest `protobuf:"bytes,3,opt,name=query,proto3,oneof"`
}

type LivenessFailure_Subscribe 

type LivenessFailure_Subscribe struct {
	Subscribe *SubscribeEnvelopesRequest `protobuf:"bytes,2,opt,name=subscribe,proto3,oneof"`
}

type Misbehavior 

type Misbehavior int32
const (
	Misbehavior_MISBEHAVIOR_UNSPECIFIED              Misbehavior = 0
	Misbehavior_MISBEHAVIOR_UNRESPONSIVE_NODE        Misbehavior = 1
	Misbehavior_MISBEHAVIOR_SLOW_NODE                Misbehavior = 2
	Misbehavior_MISBEHAVIOR_FAILED_REQUEST           Misbehavior = 3
	Misbehavior_MISBEHAVIOR_OUT_OF_ORDER             Misbehavior = 4
	Misbehavior_MISBEHAVIOR_DUPLICATE_SEQUENCE_ID    Misbehavior = 5
	Misbehavior_MISBEHAVIOR_CAUSAL_ORDERING          Misbehavior = 6
	Misbehavior_MISBEHAVIOR_INVALID_PAYLOAD          Misbehavior = 7
	Misbehavior_MISBEHAVIOR_BLOCKCHAIN_INCONSISTENCY Misbehavior = 8
)

func (Misbehavior) Descriptor 

func (Misbehavior) Descriptor() protoreflect.EnumDescriptor

func (Misbehavior) Enum 

func (x Misbehavior) Enum() *Misbehavior

func (Misbehavior) EnumDescriptor deprecated 

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

Deprecated: Use Misbehavior.Descriptor instead.

func (Misbehavior) Number 

func (x Misbehavior) Number() protoreflect.EnumNumber

func (Misbehavior) String 

func (x Misbehavior) String() string

func (Misbehavior) Type 

func (Misbehavior) Type() protoreflect.EnumType

type MisbehaviorApiClient 

type MisbehaviorApiClient interface {
	SubmitMisbehaviorReport(ctx context.Context, in *SubmitMisbehaviorReportRequest, opts ...grpc.CallOption) (*SubmitMisbehaviorReportResponse, error)
	QueryMisbehaviorReports(ctx context.Context, in *QueryMisbehaviorReportsRequest, opts ...grpc.CallOption) (*QueryMisbehaviorReportsResponse, error)
}

MisbehaviorApiClient is the client API for MisbehaviorApi 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 NewMisbehaviorApiClient 

func NewMisbehaviorApiClient(cc grpc.ClientConnInterface) MisbehaviorApiClient

type MisbehaviorApiServer 

type MisbehaviorApiServer interface {
	SubmitMisbehaviorReport(context.Context, *SubmitMisbehaviorReportRequest) (*SubmitMisbehaviorReportResponse, error)
	QueryMisbehaviorReports(context.Context, *QueryMisbehaviorReportsRequest) (*QueryMisbehaviorReportsResponse, error)
	// contains filtered or unexported methods
}

MisbehaviorApiServer is the server API for MisbehaviorApi service. All implementations must embed UnimplementedMisbehaviorApiServer for forward compatibility

type MisbehaviorReport 

type MisbehaviorReport struct {

	// Server time when the report was stored. Used only for querying reports.
	// This field is not signed.
	ServerTimeNs              uint64 `protobuf:"varint,1,opt,name=server_time_ns,json=serverTimeNs,proto3" json:"server_time_ns,omitempty"`
	UnsignedMisbehaviorReport []byte `` /* 138-byte string literal not displayed */
	// Signed by the node hosting the report
	Signature *associations.RecoverableEcdsaSignature `protobuf:"bytes,3,opt,name=signature,proto3" json:"signature,omitempty"`
	// contains filtered or unexported fields
}

func (*MisbehaviorReport) Descriptor deprecated 

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

Deprecated: Use MisbehaviorReport.ProtoReflect.Descriptor instead.

func (*MisbehaviorReport) GetServerTimeNs 

func (x *MisbehaviorReport) GetServerTimeNs() uint64

func (*MisbehaviorReport) GetSignature 

func (x *MisbehaviorReport) GetSignature() *associations.RecoverableEcdsaSignature

func (*MisbehaviorReport) GetUnsignedMisbehaviorReport 

func (x *MisbehaviorReport) GetUnsignedMisbehaviorReport() []byte

func (*MisbehaviorReport) ProtoMessage 

func (*MisbehaviorReport) ProtoMessage()

func (*MisbehaviorReport) ProtoReflect 

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

func (*MisbehaviorReport) Reset 

func (x *MisbehaviorReport) Reset()

func (*MisbehaviorReport) String 

func (x *MisbehaviorReport) String() string

type PublishPayerEnvelopesRequest 

type PublishPayerEnvelopesRequest struct {
	PayerEnvelopes []*envelopes.PayerEnvelope `protobuf:"bytes,1,rep,name=payer_envelopes,json=payerEnvelopes,proto3" json:"payer_envelopes,omitempty"`
	// contains filtered or unexported fields
}

func (*PublishPayerEnvelopesRequest) Descriptor deprecated 

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

Deprecated: Use PublishPayerEnvelopesRequest.ProtoReflect.Descriptor instead.

func (*PublishPayerEnvelopesRequest) GetPayerEnvelopes 

func (x *PublishPayerEnvelopesRequest) GetPayerEnvelopes() []*envelopes.PayerEnvelope

func (*PublishPayerEnvelopesRequest) ProtoMessage 

func (*PublishPayerEnvelopesRequest) ProtoMessage()

func (*PublishPayerEnvelopesRequest) ProtoReflect 

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

func (*PublishPayerEnvelopesRequest) Reset 

func (x *PublishPayerEnvelopesRequest) Reset()

func (*PublishPayerEnvelopesRequest) String 

func (x *PublishPayerEnvelopesRequest) String() string

type PublishPayerEnvelopesResponse 

type PublishPayerEnvelopesResponse struct {
	OriginatorEnvelopes []*envelopes.OriginatorEnvelope `protobuf:"bytes,1,rep,name=originator_envelopes,json=originatorEnvelopes,proto3" json:"originator_envelopes,omitempty"`
	// contains filtered or unexported fields
}

func (*PublishPayerEnvelopesResponse) Descriptor deprecated 

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

Deprecated: Use PublishPayerEnvelopesResponse.ProtoReflect.Descriptor instead.

func (*PublishPayerEnvelopesResponse) GetOriginatorEnvelopes 

func (x *PublishPayerEnvelopesResponse) GetOriginatorEnvelopes() []*envelopes.OriginatorEnvelope

func (*PublishPayerEnvelopesResponse) ProtoMessage 

func (*PublishPayerEnvelopesResponse) ProtoMessage()

func (*PublishPayerEnvelopesResponse) ProtoReflect 

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

func (*PublishPayerEnvelopesResponse) Reset 

func (x *PublishPayerEnvelopesResponse) Reset()

func (*PublishPayerEnvelopesResponse) String 

func (x *PublishPayerEnvelopesResponse) String() string

type QueryEnvelopesRequest 

type QueryEnvelopesRequest struct {
	Query *EnvelopesQuery `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"`
	Limit uint32          `protobuf:"varint,2,opt,name=limit,proto3" json:"limit,omitempty"`
	// contains filtered or unexported fields
}

Query envelopes request

func (*QueryEnvelopesRequest) Descriptor deprecated 

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

Deprecated: Use QueryEnvelopesRequest.ProtoReflect.Descriptor instead.

func (*QueryEnvelopesRequest) GetLimit 

func (x *QueryEnvelopesRequest) GetLimit() uint32

func (*QueryEnvelopesRequest) GetQuery 

func (x *QueryEnvelopesRequest) GetQuery() *EnvelopesQuery

func (*QueryEnvelopesRequest) ProtoMessage 

func (*QueryEnvelopesRequest) ProtoMessage()

func (*QueryEnvelopesRequest) ProtoReflect 

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

func (*QueryEnvelopesRequest) Reset 

func (x *QueryEnvelopesRequest) Reset()

func (*QueryEnvelopesRequest) String 

func (x *QueryEnvelopesRequest) String() string

type QueryEnvelopesResponse 

type QueryEnvelopesResponse struct {
	Envelopes []*envelopes.OriginatorEnvelope `protobuf:"bytes,1,rep,name=envelopes,proto3" json:"envelopes,omitempty"`
	// contains filtered or unexported fields
}

Query envelopes response

func (*QueryEnvelopesResponse) Descriptor deprecated 

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

Deprecated: Use QueryEnvelopesResponse.ProtoReflect.Descriptor instead.

func (*QueryEnvelopesResponse) GetEnvelopes 

func (x *QueryEnvelopesResponse) GetEnvelopes() []*envelopes.OriginatorEnvelope

func (*QueryEnvelopesResponse) ProtoMessage 

func (*QueryEnvelopesResponse) ProtoMessage()

func (*QueryEnvelopesResponse) ProtoReflect 

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

func (*QueryEnvelopesResponse) Reset 

func (x *QueryEnvelopesResponse) Reset()

func (*QueryEnvelopesResponse) String 

func (x *QueryEnvelopesResponse) String() string

type QueryMisbehaviorReportsRequest 

type QueryMisbehaviorReportsRequest struct {
	AfterNs uint64 `protobuf:"varint,1,opt,name=after_ns,json=afterNs,proto3" json:"after_ns,omitempty"`
	// contains filtered or unexported fields
}

func (*QueryMisbehaviorReportsRequest) Descriptor deprecated 

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

Deprecated: Use QueryMisbehaviorReportsRequest.ProtoReflect.Descriptor instead.

func (*QueryMisbehaviorReportsRequest) GetAfterNs 

func (x *QueryMisbehaviorReportsRequest) GetAfterNs() uint64

func (*QueryMisbehaviorReportsRequest) ProtoMessage 

func (*QueryMisbehaviorReportsRequest) ProtoMessage()

func (*QueryMisbehaviorReportsRequest) ProtoReflect 

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

func (*QueryMisbehaviorReportsRequest) Reset 

func (x *QueryMisbehaviorReportsRequest) Reset()

func (*QueryMisbehaviorReportsRequest) String 

func (x *QueryMisbehaviorReportsRequest) String() string

type QueryMisbehaviorReportsResponse 

type QueryMisbehaviorReportsResponse struct {
	Reports []*MisbehaviorReport `protobuf:"bytes,1,rep,name=reports,proto3" json:"reports,omitempty"`
	// contains filtered or unexported fields
}

func (*QueryMisbehaviorReportsResponse) Descriptor deprecated 

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

Deprecated: Use QueryMisbehaviorReportsResponse.ProtoReflect.Descriptor instead.

func (*QueryMisbehaviorReportsResponse) GetReports 

func (x *QueryMisbehaviorReportsResponse) GetReports() []*MisbehaviorReport

func (*QueryMisbehaviorReportsResponse) ProtoMessage 

func (*QueryMisbehaviorReportsResponse) ProtoMessage()

func (*QueryMisbehaviorReportsResponse) ProtoReflect 

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

func (*QueryMisbehaviorReportsResponse) Reset 

func (x *QueryMisbehaviorReportsResponse) Reset()

func (*QueryMisbehaviorReportsResponse) String 

func (x *QueryMisbehaviorReportsResponse) String() string

type ReplicationApiClient 

type ReplicationApiClient interface {
	SubscribeEnvelopes(ctx context.Context, in *SubscribeEnvelopesRequest, opts ...grpc.CallOption) (ReplicationApi_SubscribeEnvelopesClient, error)
	QueryEnvelopes(ctx context.Context, in *QueryEnvelopesRequest, opts ...grpc.CallOption) (*QueryEnvelopesResponse, error)
	PublishPayerEnvelopes(ctx context.Context, in *PublishPayerEnvelopesRequest, opts ...grpc.CallOption) (*PublishPayerEnvelopesResponse, error)
	GetInboxIds(ctx context.Context, in *GetInboxIdsRequest, opts ...grpc.CallOption) (*GetInboxIdsResponse, error)
	// Get the newest envelope for each topic
	GetNewestEnvelope(ctx context.Context, in *GetNewestEnvelopeRequest, opts ...grpc.CallOption) (*GetNewestEnvelopeResponse, error)
}

ReplicationApiClient is the client API for ReplicationApi 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 NewReplicationApiClient 

func NewReplicationApiClient(cc grpc.ClientConnInterface) ReplicationApiClient

type ReplicationApiServer 

type ReplicationApiServer interface {
	SubscribeEnvelopes(*SubscribeEnvelopesRequest, ReplicationApi_SubscribeEnvelopesServer) error
	QueryEnvelopes(context.Context, *QueryEnvelopesRequest) (*QueryEnvelopesResponse, error)
	PublishPayerEnvelopes(context.Context, *PublishPayerEnvelopesRequest) (*PublishPayerEnvelopesResponse, error)
	GetInboxIds(context.Context, *GetInboxIdsRequest) (*GetInboxIdsResponse, error)
	// Get the newest envelope for each topic
	GetNewestEnvelope(context.Context, *GetNewestEnvelopeRequest) (*GetNewestEnvelopeResponse, error)
	// contains filtered or unexported methods
}

ReplicationApiServer is the server API for ReplicationApi service. All implementations must embed UnimplementedReplicationApiServer for forward compatibility

type ReplicationApi_SubscribeEnvelopesClient 

type ReplicationApi_SubscribeEnvelopesClient interface {
	Recv() (*SubscribeEnvelopesResponse, error)
	grpc.ClientStream
}

type ReplicationApi_SubscribeEnvelopesServer 

type ReplicationApi_SubscribeEnvelopesServer interface {
	Send(*SubscribeEnvelopesResponse) error
	grpc.ServerStream
}

type SafetyFailure 

type SafetyFailure struct {
	Envelopes []*envelopes.OriginatorEnvelope `protobuf:"bytes,1,rep,name=envelopes,proto3" json:"envelopes,omitempty"`
	// contains filtered or unexported fields
}

func (*SafetyFailure) Descriptor deprecated 

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

Deprecated: Use SafetyFailure.ProtoReflect.Descriptor instead.

func (*SafetyFailure) GetEnvelopes 

func (x *SafetyFailure) GetEnvelopes() []*envelopes.OriginatorEnvelope

func (*SafetyFailure) ProtoMessage 

func (*SafetyFailure) ProtoMessage()

func (*SafetyFailure) ProtoReflect 

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

func (*SafetyFailure) Reset 

func (x *SafetyFailure) Reset()

func (*SafetyFailure) String 

func (x *SafetyFailure) String() string

type SubmitMisbehaviorReportRequest 

type SubmitMisbehaviorReportRequest struct {
	Report *UnsignedMisbehaviorReport `protobuf:"bytes,1,opt,name=report,proto3" json:"report,omitempty"`
	// contains filtered or unexported fields
}

func (*SubmitMisbehaviorReportRequest) Descriptor deprecated 

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

Deprecated: Use SubmitMisbehaviorReportRequest.ProtoReflect.Descriptor instead.

func (*SubmitMisbehaviorReportRequest) GetReport 

func (x *SubmitMisbehaviorReportRequest) GetReport() *UnsignedMisbehaviorReport

func (*SubmitMisbehaviorReportRequest) ProtoMessage 

func (*SubmitMisbehaviorReportRequest) ProtoMessage()

func (*SubmitMisbehaviorReportRequest) ProtoReflect 

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

func (*SubmitMisbehaviorReportRequest) Reset 

func (x *SubmitMisbehaviorReportRequest) Reset()

func (*SubmitMisbehaviorReportRequest) String 

func (x *SubmitMisbehaviorReportRequest) String() string

type SubmitMisbehaviorReportResponse 

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

func (*SubmitMisbehaviorReportResponse) Descriptor deprecated 

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

Deprecated: Use SubmitMisbehaviorReportResponse.ProtoReflect.Descriptor instead.

func (*SubmitMisbehaviorReportResponse) ProtoMessage 

func (*SubmitMisbehaviorReportResponse) ProtoMessage()

func (*SubmitMisbehaviorReportResponse) ProtoReflect 

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

func (*SubmitMisbehaviorReportResponse) Reset 

func (x *SubmitMisbehaviorReportResponse) Reset()

func (*SubmitMisbehaviorReportResponse) String 

func (x *SubmitMisbehaviorReportResponse) String() string

type SubscribeEnvelopesRequest 

type SubscribeEnvelopesRequest struct {
	Query *EnvelopesQuery `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"`
	// contains filtered or unexported fields
}

Batch subscribe to envelopes

func (*SubscribeEnvelopesRequest) Descriptor deprecated 

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

Deprecated: Use SubscribeEnvelopesRequest.ProtoReflect.Descriptor instead.

func (*SubscribeEnvelopesRequest) GetQuery 

func (x *SubscribeEnvelopesRequest) GetQuery() *EnvelopesQuery

func (*SubscribeEnvelopesRequest) ProtoMessage 

func (*SubscribeEnvelopesRequest) ProtoMessage()

func (*SubscribeEnvelopesRequest) ProtoReflect 

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

func (*SubscribeEnvelopesRequest) Reset 

func (x *SubscribeEnvelopesRequest) Reset()

func (*SubscribeEnvelopesRequest) String 

func (x *SubscribeEnvelopesRequest) String() string

type SubscribeEnvelopesResponse 

type SubscribeEnvelopesResponse struct {
	Envelopes []*envelopes.OriginatorEnvelope `protobuf:"bytes,1,rep,name=envelopes,proto3" json:"envelopes,omitempty"`
	// contains filtered or unexported fields
}

Streamed response for batch subscribe - can be multiple envelopes at once

func (*SubscribeEnvelopesResponse) Descriptor deprecated 

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

Deprecated: Use SubscribeEnvelopesResponse.ProtoReflect.Descriptor instead.

func (*SubscribeEnvelopesResponse) GetEnvelopes 

func (x *SubscribeEnvelopesResponse) GetEnvelopes() []*envelopes.OriginatorEnvelope

func (*SubscribeEnvelopesResponse) ProtoMessage 

func (*SubscribeEnvelopesResponse) ProtoMessage()

func (*SubscribeEnvelopesResponse) ProtoReflect 

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

func (*SubscribeEnvelopesResponse) Reset 

func (x *SubscribeEnvelopesResponse) Reset()

func (*SubscribeEnvelopesResponse) String 

func (x *SubscribeEnvelopesResponse) String() string

type UnimplementedMisbehaviorApiServer 

type UnimplementedMisbehaviorApiServer struct {
}

UnimplementedMisbehaviorApiServer must be embedded to have forward compatible implementations.

func (UnimplementedMisbehaviorApiServer) QueryMisbehaviorReports 

func (UnimplementedMisbehaviorApiServer) QueryMisbehaviorReports(context.Context, *QueryMisbehaviorReportsRequest) (*QueryMisbehaviorReportsResponse, error)

func (UnimplementedMisbehaviorApiServer) SubmitMisbehaviorReport 

func (UnimplementedMisbehaviorApiServer) SubmitMisbehaviorReport(context.Context, *SubmitMisbehaviorReportRequest) (*SubmitMisbehaviorReportResponse, error)

type UnimplementedReplicationApiServer 

type UnimplementedReplicationApiServer struct {
}

UnimplementedReplicationApiServer must be embedded to have forward compatible implementations.

func (UnimplementedReplicationApiServer) GetInboxIds 

func (UnimplementedReplicationApiServer) GetInboxIds(context.Context, *GetInboxIdsRequest) (*GetInboxIdsResponse, error)

func (UnimplementedReplicationApiServer) GetNewestEnvelope 

func (UnimplementedReplicationApiServer) GetNewestEnvelope(context.Context, *GetNewestEnvelopeRequest) (*GetNewestEnvelopeResponse, error)

func (UnimplementedReplicationApiServer) PublishPayerEnvelopes 

func (UnimplementedReplicationApiServer) PublishPayerEnvelopes(context.Context, *PublishPayerEnvelopesRequest) (*PublishPayerEnvelopesResponse, error)

func (UnimplementedReplicationApiServer) QueryEnvelopes 

func (UnimplementedReplicationApiServer) QueryEnvelopes(context.Context, *QueryEnvelopesRequest) (*QueryEnvelopesResponse, error)

func (UnimplementedReplicationApiServer) SubscribeEnvelopes 

func (UnimplementedReplicationApiServer) SubscribeEnvelopes(*SubscribeEnvelopesRequest, ReplicationApi_SubscribeEnvelopesServer) error

type UnsafeMisbehaviorApiServer 

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

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

type UnsafeReplicationApiServer 

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

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

type UnsignedMisbehaviorReport 

type UnsignedMisbehaviorReport struct {
	ReporterTimeNs    uint64      `protobuf:"varint,1,opt,name=reporter_time_ns,json=reporterTimeNs,proto3" json:"reporter_time_ns,omitempty"`
	MisbehavingNodeId uint32      `protobuf:"varint,2,opt,name=misbehaving_node_id,json=misbehavingNodeId,proto3" json:"misbehaving_node_id,omitempty"`
	Type              Misbehavior `protobuf:"varint,3,opt,name=type,proto3,enum=xmtp.xmtpv4.message_api.Misbehavior" json:"type,omitempty"`
	// Types that are valid to be assigned to Failure:
	//
	//	*UnsignedMisbehaviorReport_Liveness
	//	*UnsignedMisbehaviorReport_Safety
	Failure isUnsignedMisbehaviorReport_Failure `protobuf_oneof:"failure"`
	// Nodes must verify this field is false for client-submitted reports
	SubmittedByNode bool `protobuf:"varint,6,opt,name=submitted_by_node,json=submittedByNode,proto3" json:"submitted_by_node,omitempty"`
	// contains filtered or unexported fields
}

func (*UnsignedMisbehaviorReport) Descriptor deprecated 

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

Deprecated: Use UnsignedMisbehaviorReport.ProtoReflect.Descriptor instead.

func (*UnsignedMisbehaviorReport) GetFailure 

func (x *UnsignedMisbehaviorReport) GetFailure() isUnsignedMisbehaviorReport_Failure

func (*UnsignedMisbehaviorReport) GetLiveness 

func (x *UnsignedMisbehaviorReport) GetLiveness() *LivenessFailure

func (*UnsignedMisbehaviorReport) GetMisbehavingNodeId 

func (x *UnsignedMisbehaviorReport) GetMisbehavingNodeId() uint32

func (*UnsignedMisbehaviorReport) GetReporterTimeNs 

func (x *UnsignedMisbehaviorReport) GetReporterTimeNs() uint64

func (*UnsignedMisbehaviorReport) GetSafety 

func (x *UnsignedMisbehaviorReport) GetSafety() *SafetyFailure

func (*UnsignedMisbehaviorReport) GetSubmittedByNode 

func (x *UnsignedMisbehaviorReport) GetSubmittedByNode() bool

func (*UnsignedMisbehaviorReport) GetType 

func (x *UnsignedMisbehaviorReport) GetType() Misbehavior

func (*UnsignedMisbehaviorReport) ProtoMessage 

func (*UnsignedMisbehaviorReport) ProtoMessage()

func (*UnsignedMisbehaviorReport) ProtoReflect 

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

func (*UnsignedMisbehaviorReport) Reset 

func (x *UnsignedMisbehaviorReport) Reset()

func (*UnsignedMisbehaviorReport) String 

func (x *UnsignedMisbehaviorReport) String() string

type UnsignedMisbehaviorReport_Liveness 

type UnsignedMisbehaviorReport_Liveness struct {
	Liveness *LivenessFailure `protobuf:"bytes,4,opt,name=liveness,proto3,oneof"`
}

type UnsignedMisbehaviorReport_Safety 

type UnsignedMisbehaviorReport_Safety struct {
	Safety *SafetyFailure `protobuf:"bytes,5,opt,name=safety,proto3,oneof"`
}

Source Files

View all Source files

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.