Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

protocol

package

Go to main page

Versions in this module

v1

v1.0.14

Jan 22, 2026

v1.0.13

Jan 22, 2026

v1.0.12

Jan 21, 2026

v1.0.11

Jan 21, 2026

v1.0.10

Jan 13, 2026

Changes in this version

type ShannonEndpointErrorType

+ const ShannonEndpointErrorType_SHANNON_ENDPOINT_ERROR_RAW_PAYLOAD_SESSION_MISMATCH

v1.0.9

Dec 4, 2025

v1.0.8

Dec 4, 2025

v1.0.7

Dec 4, 2025

v1.0.6

Dec 4, 2025

v1.0.5

Dec 2, 2025

v1.0.4

Nov 29, 2025

v1.0.3

Nov 28, 2025

v1.0.2

Nov 27, 2025

v1.0.1

Nov 27, 2025

Changes in this version

+ var File_path_protocol_observations_proto protoreflect.FileDescriptor

+ var File_path_protocol_shannon_proto protoreflect.FileDescriptor

+ var ShannonEndpointErrorType_name = map[int32]string

+ var ShannonEndpointErrorType_value = map[string]int32

+ var ShannonRequestErrorType_name = map[int32]string

+ var ShannonRequestErrorType_value = map[string]int32

+ var ShannonSanctionType_name = map[int32]string

+ var ShannonSanctionType_value = map[string]int32

+ var ShannonWebsocketConnectionObservation_ConnectionEventType_name = map[int32]string

+ var ShannonWebsocketConnectionObservation_ConnectionEventType_value = map[string]int32

+ type Observations struct

+ BlockHeight uint64

+ Shannon *ShannonObservationsList

+ func (*Observations) Descriptor() ([]byte, []int)

+ func (*Observations) ProtoMessage()

+ func (x *Observations) GetBlockHeight() uint64

+ func (x *Observations) GetShannon() *ShannonObservationsList

+ func (x *Observations) ProtoReflect() protoreflect.Message

+ func (x *Observations) Reset()

+ func (x *Observations) String() string

+ type ShannonEndpointErrorType int32

+ const ShannonEndpointErrorType_SHANNON_ENDPOINT_ERROR_CONFIG

+ const ShannonEndpointErrorType_SHANNON_ENDPOINT_ERROR_HTTP_BAD_RESPONSE

+ const ShannonEndpointErrorType_SHANNON_ENDPOINT_ERROR_HTTP_BROKEN_PIPE

+ const ShannonEndpointErrorType_SHANNON_ENDPOINT_ERROR_HTTP_CONNECTION_REFUSED

+ const ShannonEndpointErrorType_SHANNON_ENDPOINT_ERROR_HTTP_CONNECTION_RESET

+ const ShannonEndpointErrorType_SHANNON_ENDPOINT_ERROR_HTTP_CONNECTION_TIMEOUT

+ const ShannonEndpointErrorType_SHANNON_ENDPOINT_ERROR_HTTP_CONTEXT_DEADLINE_EXCEEDED

+ const ShannonEndpointErrorType_SHANNON_ENDPOINT_ERROR_HTTP_INVALID_STATUS

+ const ShannonEndpointErrorType_SHANNON_ENDPOINT_ERROR_HTTP_IO_TIMEOUT

+ const ShannonEndpointErrorType_SHANNON_ENDPOINT_ERROR_HTTP_NETWORK_UNREACHABLE

+ const ShannonEndpointErrorType_SHANNON_ENDPOINT_ERROR_HTTP_NON_2XX_STATUS

+ const ShannonEndpointErrorType_SHANNON_ENDPOINT_ERROR_HTTP_NO_ROUTE_TO_HOST

+ const ShannonEndpointErrorType_SHANNON_ENDPOINT_ERROR_HTTP_TRANSPORT_ERROR

+ const ShannonEndpointErrorType_SHANNON_ENDPOINT_ERROR_HTTP_UNKNOWN

+ const ShannonEndpointErrorType_SHANNON_ENDPOINT_ERROR_INTERNAL

+ const ShannonEndpointErrorType_SHANNON_ENDPOINT_ERROR_NIL_SUPPLIER_PUBKEY

+ const ShannonEndpointErrorType_SHANNON_ENDPOINT_ERROR_PAYLOAD_UNMARSHAL_ERR

+ const ShannonEndpointErrorType_SHANNON_ENDPOINT_ERROR_RAW_PAYLOAD_BACKEND_SERVICE

+ const ShannonEndpointErrorType_SHANNON_ENDPOINT_ERROR_RAW_PAYLOAD_CONNECTION_REFUSED

+ const ShannonEndpointErrorType_SHANNON_ENDPOINT_ERROR_RAW_PAYLOAD_DNS_RESOLUTION

+ const ShannonEndpointErrorType_SHANNON_ENDPOINT_ERROR_RAW_PAYLOAD_HTTP_TRANSPORT

+ const ShannonEndpointErrorType_SHANNON_ENDPOINT_ERROR_RAW_PAYLOAD_PROTOCOL_RELAY_REQUEST

+ const ShannonEndpointErrorType_SHANNON_ENDPOINT_ERROR_RAW_PAYLOAD_PROTOCOL_WIRE_TYPE

+ const ShannonEndpointErrorType_SHANNON_ENDPOINT_ERROR_RAW_PAYLOAD_RESPONSE_SIZE_EXCEEDED

+ const ShannonEndpointErrorType_SHANNON_ENDPOINT_ERROR_RAW_PAYLOAD_SERVER_CLOSED_CONNECTION

+ const ShannonEndpointErrorType_SHANNON_ENDPOINT_ERROR_RAW_PAYLOAD_SERVICE_NOT_CONFIGURED

+ const ShannonEndpointErrorType_SHANNON_ENDPOINT_ERROR_RAW_PAYLOAD_SUPPLIERS_NOT_REACHABLE

+ const ShannonEndpointErrorType_SHANNON_ENDPOINT_ERROR_RAW_PAYLOAD_TCP_CONNECTION

+ const ShannonEndpointErrorType_SHANNON_ENDPOINT_ERROR_RAW_PAYLOAD_TLS_HANDSHAKE

+ const ShannonEndpointErrorType_SHANNON_ENDPOINT_ERROR_RAW_PAYLOAD_UNEXPECTED_EOF

+ const ShannonEndpointErrorType_SHANNON_ENDPOINT_ERROR_RAW_PAYLOAD_UNKNOWN

+ const ShannonEndpointErrorType_SHANNON_ENDPOINT_ERROR_RELAY_MINER_HTTP_4XX

+ const ShannonEndpointErrorType_SHANNON_ENDPOINT_ERROR_RELAY_MINER_HTTP_5XX

+ const ShannonEndpointErrorType_SHANNON_ENDPOINT_ERROR_RESPONSE_GET_PUBKEY_ERR

+ const ShannonEndpointErrorType_SHANNON_ENDPOINT_ERROR_RESPONSE_SIGNATURE_VALIDATION_ERR

+ const ShannonEndpointErrorType_SHANNON_ENDPOINT_ERROR_RESPONSE_VALIDATION_ERR

+ const ShannonEndpointErrorType_SHANNON_ENDPOINT_ERROR_TIMEOUT

+ const ShannonEndpointErrorType_SHANNON_ENDPOINT_ERROR_UNKNOWN

+ const ShannonEndpointErrorType_SHANNON_ENDPOINT_ERROR_UNSPECIFIED

+ const ShannonEndpointErrorType_SHANNON_ENDPOINT_ERROR_WEBSOCKET_CONNECTION_FAILED

+ const ShannonEndpointErrorType_SHANNON_ENDPOINT_ERROR_WEBSOCKET_RELAY_RESPONSE_VALIDATION_FAILED

+ const ShannonEndpointErrorType_SHANNON_ENDPOINT_ERROR_WEBSOCKET_REQUEST_SIGNING_FAILED

+ const ShannonEndpointErrorType_SHANNON_ENDPOINT_REQUEST_CANCELED_BY_PATH

+ func (ShannonEndpointErrorType) Descriptor() protoreflect.EnumDescriptor

+ func (ShannonEndpointErrorType) EnumDescriptor() ([]byte, []int)

+ func (ShannonEndpointErrorType) Type() protoreflect.EnumType

+ func (x ShannonEndpointErrorType) Enum() *ShannonEndpointErrorType

+ func (x ShannonEndpointErrorType) Number() protoreflect.EnumNumber

+ func (x ShannonEndpointErrorType) String() string

+ type ShannonEndpointObservation struct

+ EndpointAppAddress string

+ EndpointBackendServiceHttpResponsePayloadSize *int64

+ EndpointBackendServiceHttpResponseStatusCode *int32

+ EndpointQueryTimestamp *timestamppb.Timestamp

+ EndpointResponseTimestamp *timestamppb.Timestamp

+ EndpointUrl string

+ ErrorDetails *string

+ ErrorType *ShannonEndpointErrorType

+ IsFallbackEndpoint bool

+ RecommendedSanction *ShannonSanctionType

+ RelayMinerError *ShannonRelayMinerError

+ SessionEndHeight int64

+ SessionId string

+ SessionServiceId string

+ SessionStartHeight int64

+ Supplier string

+ func (*ShannonEndpointObservation) Descriptor() ([]byte, []int)

+ func (*ShannonEndpointObservation) ProtoMessage()

+ func (x *ShannonEndpointObservation) GetEndpointAppAddress() string

+ func (x *ShannonEndpointObservation) GetEndpointBackendServiceHttpResponsePayloadSize() int64

+ func (x *ShannonEndpointObservation) GetEndpointBackendServiceHttpResponseStatusCode() int32

+ func (x *ShannonEndpointObservation) GetEndpointQueryTimestamp() *timestamppb.Timestamp

+ func (x *ShannonEndpointObservation) GetEndpointResponseTimestamp() *timestamppb.Timestamp

+ func (x *ShannonEndpointObservation) GetEndpointUrl() string

+ func (x *ShannonEndpointObservation) GetErrorDetails() string

+ func (x *ShannonEndpointObservation) GetErrorType() ShannonEndpointErrorType

+ func (x *ShannonEndpointObservation) GetIsFallbackEndpoint() bool

+ func (x *ShannonEndpointObservation) GetRecommendedSanction() ShannonSanctionType

+ func (x *ShannonEndpointObservation) GetRelayMinerError() *ShannonRelayMinerError

+ func (x *ShannonEndpointObservation) GetSessionEndHeight() int64

+ func (x *ShannonEndpointObservation) GetSessionId() string

+ func (x *ShannonEndpointObservation) GetSessionServiceId() string

+ func (x *ShannonEndpointObservation) GetSessionStartHeight() int64

+ func (x *ShannonEndpointObservation) GetSupplier() string

+ func (x *ShannonEndpointObservation) ProtoReflect() protoreflect.Message

+ func (x *ShannonEndpointObservation) Reset()

+ func (x *ShannonEndpointObservation) String() string

+ type ShannonHTTPEndpointObservations struct

+ EndpointObservations []*ShannonEndpointObservation

+ func (*ShannonHTTPEndpointObservations) Descriptor() ([]byte, []int)

+ func (*ShannonHTTPEndpointObservations) ProtoMessage()

+ func (x *ShannonHTTPEndpointObservations) GetEndpointObservations() []*ShannonEndpointObservation

+ func (x *ShannonHTTPEndpointObservations) ProtoReflect() protoreflect.Message

+ func (x *ShannonHTTPEndpointObservations) Reset()

+ func (x *ShannonHTTPEndpointObservations) String() string

+ type ShannonObservationsList struct

+ Observations []*ShannonRequestObservations

+ func (*ShannonObservationsList) Descriptor() ([]byte, []int)

+ func (*ShannonObservationsList) ProtoMessage()

+ func (x *ShannonObservationsList) GetObservations() []*ShannonRequestObservations

+ func (x *ShannonObservationsList) ProtoReflect() protoreflect.Message

+ func (x *ShannonObservationsList) Reset()

+ func (x *ShannonObservationsList) String() string

+ type ShannonRelayMinerError struct

+ Code uint32

+ Codespace string

+ Message string

+ func (*ShannonRelayMinerError) Descriptor() ([]byte, []int)

+ func (*ShannonRelayMinerError) ProtoMessage()

+ func (x *ShannonRelayMinerError) GetCode() uint32

+ func (x *ShannonRelayMinerError) GetCodespace() string

+ func (x *ShannonRelayMinerError) GetMessage() string

+ func (x *ShannonRelayMinerError) ProtoReflect() protoreflect.Message

+ func (x *ShannonRelayMinerError) Reset()

+ func (x *ShannonRelayMinerError) String() string

+ type ShannonRequestError struct

+ ErrorDetails string

+ ErrorType ShannonRequestErrorType

+ func (*ShannonRequestError) Descriptor() ([]byte, []int)

+ func (*ShannonRequestError) ProtoMessage()

+ func (x *ShannonRequestError) GetErrorDetails() string

+ func (x *ShannonRequestError) GetErrorType() ShannonRequestErrorType

+ func (x *ShannonRequestError) ProtoReflect() protoreflect.Message

+ func (x *ShannonRequestError) Reset()

+ func (x *ShannonRequestError) String() string

+ type ShannonRequestErrorType int32

+ const ShannonRequestErrorType_SHANNON_REQUEST_ERROR_INTERNAL

+ const ShannonRequestErrorType_SHANNON_REQUEST_ERROR_INTERNAL_CENTRALIZED_MODE_APP_DELEGATION

+ const ShannonRequestErrorType_SHANNON_REQUEST_ERROR_INTERNAL_CENTRALIZED_MODE_APP_FETCH_ERR

+ const ShannonRequestErrorType_SHANNON_REQUEST_ERROR_INTERNAL_CENTRALIZED_MODE_NO_APPS_FOR_SERVICE

+ const ShannonRequestErrorType_SHANNON_REQUEST_ERROR_INTERNAL_CENTRALIZED_MODE_NO_SESSIONS

+ const ShannonRequestErrorType_SHANNON_REQUEST_ERROR_INTERNAL_DELEGATED_APP_DOES_NOT_DELEGATE

+ const ShannonRequestErrorType_SHANNON_REQUEST_ERROR_INTERNAL_DELEGATED_FETCH_APP

+ const ShannonRequestErrorType_SHANNON_REQUEST_ERROR_INTERNAL_DELEGATED_GET_APP_HTTP

+ const ShannonRequestErrorType_SHANNON_REQUEST_ERROR_INTERNAL_NO_ENDPOINTS_AVAILABLE

+ const ShannonRequestErrorType_SHANNON_REQUEST_ERROR_INTERNAL_SIGNER_SETUP_ERROR

+ const ShannonRequestErrorType_SHANNON_REQUEST_ERROR_UNSPECIFIED

+ func (ShannonRequestErrorType) Descriptor() protoreflect.EnumDescriptor

+ func (ShannonRequestErrorType) EnumDescriptor() ([]byte, []int)

+ func (ShannonRequestErrorType) Type() protoreflect.EnumType

+ func (x ShannonRequestErrorType) Enum() *ShannonRequestErrorType

+ func (x ShannonRequestErrorType) Number() protoreflect.EnumNumber

+ func (x ShannonRequestErrorType) String() string

+ type ShannonRequestObservations struct

+ ObservationData isShannonRequestObservations_ObservationData

+ RequestError *ShannonRequestError

+ ServiceId string

+ func (*ShannonRequestObservations) Descriptor() ([]byte, []int)

+ func (*ShannonRequestObservations) ProtoMessage()

+ func (x *ShannonRequestObservations) GetHttpObservations() *ShannonHTTPEndpointObservations

+ func (x *ShannonRequestObservations) GetObservationData() isShannonRequestObservations_ObservationData

+ func (x *ShannonRequestObservations) GetRequestError() *ShannonRequestError

+ func (x *ShannonRequestObservations) GetServiceId() string

+ func (x *ShannonRequestObservations) GetWebsocketConnectionObservation() *ShannonWebsocketConnectionObservation

+ func (x *ShannonRequestObservations) GetWebsocketMessageObservation() *ShannonWebsocketMessageObservation

+ func (x *ShannonRequestObservations) ProtoReflect() protoreflect.Message

+ func (x *ShannonRequestObservations) Reset()

+ func (x *ShannonRequestObservations) String() string

+ type ShannonRequestObservations_HttpObservations struct

+ HttpObservations *ShannonHTTPEndpointObservations

+ type ShannonRequestObservations_WebsocketConnectionObservation struct

+ WebsocketConnectionObservation *ShannonWebsocketConnectionObservation

+ type ShannonRequestObservations_WebsocketMessageObservation struct

+ WebsocketMessageObservation *ShannonWebsocketMessageObservation

+ type ShannonSanctionType int32

+ const ShannonSanctionType_SHANNON_SANCTION_DO_NOT_SANCTION

+ const ShannonSanctionType_SHANNON_SANCTION_PERMANENT

+ const ShannonSanctionType_SHANNON_SANCTION_SESSION

+ const ShannonSanctionType_SHANNON_SANCTION_UNSPECIFIED

+ func (ShannonSanctionType) Descriptor() protoreflect.EnumDescriptor

+ func (ShannonSanctionType) EnumDescriptor() ([]byte, []int)

+ func (ShannonSanctionType) Type() protoreflect.EnumType

+ func (x ShannonSanctionType) Enum() *ShannonSanctionType

+ func (x ShannonSanctionType) Number() protoreflect.EnumNumber

+ func (x ShannonSanctionType) String() string

+ type ShannonWebsocketConnectionObservation struct

+ ConnectionClosedTimestamp *timestamppb.Timestamp

+ ConnectionEstablishedTimestamp *timestamppb.Timestamp

+ EndpointAppAddress string

+ EndpointUrl string

+ ErrorDetails *string

+ ErrorType *ShannonEndpointErrorType

+ EventType ShannonWebsocketConnectionObservation_ConnectionEventType

+ IsFallbackEndpoint bool

+ RecommendedSanction *ShannonSanctionType

+ SessionEndHeight int64

+ SessionId string

+ SessionServiceId string

+ SessionStartHeight int64

+ Supplier string

+ func (*ShannonWebsocketConnectionObservation) Descriptor() ([]byte, []int)

+ func (*ShannonWebsocketConnectionObservation) ProtoMessage()

+ func (x *ShannonWebsocketConnectionObservation) GetConnectionClosedTimestamp() *timestamppb.Timestamp

+ func (x *ShannonWebsocketConnectionObservation) GetConnectionEstablishedTimestamp() *timestamppb.Timestamp

+ func (x *ShannonWebsocketConnectionObservation) GetEndpointAppAddress() string

+ func (x *ShannonWebsocketConnectionObservation) GetEndpointUrl() string

+ func (x *ShannonWebsocketConnectionObservation) GetErrorDetails() string

+ func (x *ShannonWebsocketConnectionObservation) GetErrorType() ShannonEndpointErrorType

+ func (x *ShannonWebsocketConnectionObservation) GetEventType() ShannonWebsocketConnectionObservation_ConnectionEventType

+ func (x *ShannonWebsocketConnectionObservation) GetIsFallbackEndpoint() bool

+ func (x *ShannonWebsocketConnectionObservation) GetRecommendedSanction() ShannonSanctionType

+ func (x *ShannonWebsocketConnectionObservation) GetSessionEndHeight() int64

+ func (x *ShannonWebsocketConnectionObservation) GetSessionId() string

+ func (x *ShannonWebsocketConnectionObservation) GetSessionServiceId() string

+ func (x *ShannonWebsocketConnectionObservation) GetSessionStartHeight() int64

+ func (x *ShannonWebsocketConnectionObservation) GetSupplier() string

+ func (x *ShannonWebsocketConnectionObservation) ProtoReflect() protoreflect.Message

+ func (x *ShannonWebsocketConnectionObservation) Reset()

+ func (x *ShannonWebsocketConnectionObservation) String() string

+ type ShannonWebsocketConnectionObservation_ConnectionEventType int32

+ const ShannonWebsocketConnectionObservation_CONNECTION_CLOSED

+ const ShannonWebsocketConnectionObservation_CONNECTION_ESTABLISHED

+ const ShannonWebsocketConnectionObservation_CONNECTION_ESTABLISHMENT_FAILED

+ const ShannonWebsocketConnectionObservation_CONNECTION_EVENT_TYPE_UNSPECIFIED

+ func (ShannonWebsocketConnectionObservation_ConnectionEventType) Descriptor() protoreflect.EnumDescriptor

+ func (ShannonWebsocketConnectionObservation_ConnectionEventType) EnumDescriptor() ([]byte, []int)

+ func (ShannonWebsocketConnectionObservation_ConnectionEventType) Type() protoreflect.EnumType

+ func (x ShannonWebsocketConnectionObservation_ConnectionEventType) Enum() *ShannonWebsocketConnectionObservation_ConnectionEventType

+ func (x ShannonWebsocketConnectionObservation_ConnectionEventType) Number() protoreflect.EnumNumber

+ func (x ShannonWebsocketConnectionObservation_ConnectionEventType) String() string

+ type ShannonWebsocketMessageObservation struct

+ EndpointAppAddress string

+ EndpointUrl string

+ ErrorDetails *string

+ ErrorType *ShannonEndpointErrorType

+ IsFallbackEndpoint bool

+ MessagePayloadSize int64

+ MessageTimestamp *timestamppb.Timestamp

+ RecommendedSanction *ShannonSanctionType

+ RelayMinerError *ShannonRelayMinerError

+ SessionEndHeight int64

+ SessionId string

+ SessionServiceId string

+ SessionStartHeight int64

+ Supplier string

+ func (*ShannonWebsocketMessageObservation) Descriptor() ([]byte, []int)

+ func (*ShannonWebsocketMessageObservation) ProtoMessage()

+ func (x *ShannonWebsocketMessageObservation) GetEndpointAppAddress() string

+ func (x *ShannonWebsocketMessageObservation) GetEndpointUrl() string

+ func (x *ShannonWebsocketMessageObservation) GetErrorDetails() string

+ func (x *ShannonWebsocketMessageObservation) GetErrorType() ShannonEndpointErrorType

+ func (x *ShannonWebsocketMessageObservation) GetIsFallbackEndpoint() bool

+ func (x *ShannonWebsocketMessageObservation) GetMessagePayloadSize() int64

+ func (x *ShannonWebsocketMessageObservation) GetMessageTimestamp() *timestamppb.Timestamp

+ func (x *ShannonWebsocketMessageObservation) GetRecommendedSanction() ShannonSanctionType

+ func (x *ShannonWebsocketMessageObservation) GetRelayMinerError() *ShannonRelayMinerError

+ func (x *ShannonWebsocketMessageObservation) GetSessionEndHeight() int64

+ func (x *ShannonWebsocketMessageObservation) GetSessionId() string

+ func (x *ShannonWebsocketMessageObservation) GetSessionServiceId() string

+ func (x *ShannonWebsocketMessageObservation) GetSessionStartHeight() int64

+ func (x *ShannonWebsocketMessageObservation) GetSupplier() string

+ func (x *ShannonWebsocketMessageObservation) ProtoReflect() protoreflect.Message

+ func (x *ShannonWebsocketMessageObservation) Reset()

+ func (x *ShannonWebsocketMessageObservation) String() string