Default package

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: AdminMessage

• string circuit_id = 1

  the circuit being abandoned

• string member_node_id = 2

Used in: TwoPhaseCommitMessage

• uint64 epoch = 1

• string circuit = 1

  the name of the circuit the message is meant for

• string sender = 2

  id of the sender of the message

• string recipient = 3

  id of recipient of the message

• bytes payload = 4

  the request

• string correlation_id = 5

  id used to correlate the response with this request

• AdminMessage.Type message_type = 1

• bytes consensus_message = 2

• optional ProposedCircuit proposed_circuit = 3

• optional MemberReady member_ready = 4

• optional AbandonedCircuit abandoned_circuit = 5

• optional RemovedProposal removed_proposal = 6

• optional ServiceProtocolVersionRequest protocol_request = 100

  Messages to agree on protocol version

• optional ServiceProtocolVersionResponse protocol_response = 101

Used in: AdminMessage

• UNSET = 0

• CONSENSUS_MESSAGE = 1

• PROPOSED_CIRCUIT = 2

• MEMBER_READY = 3

• ABANDONED_CIRCUIT = 4

• REMOVED_PROPOSAL = 5

• SERVICE_PROTOCOL_VERSION_REQUEST = 100

• SERVICE_PROTOCOL_VERSION_RESPONSE = 101

Challenge nonce requests Sent to a node to request a nonce that can be used for challenge authorization

(message has no fields)

Challenge nonce response Returns the nonce that must be signed by the requesting node to prove their identity

• bytes nonce = 1

Challenge submit requests The connecting nodes public keys and the signatures created by signing the nonce received from the nonce response

• repeated SubmitRequest submit_requests = 1

v1 challenge response Returned if the signature and public key are valid

• bytes public_key = 1

Returned if authorization is complete

(message has no fields)

Authorization protocol agreement request message This message will allow for the two connecting nodes to agree on what authorization protocol version will be used

• uint32 auth_protocol_min = 1

• uint32 auth_protocol_max = 2

Authorization protocol agreement response message Contains the agreed upon protocol version and the list of supported authorization types

• uint32 auth_protocol = 1

• repeated AuthProtocolResponse.PeerAuthorizationType accepted_authorization_type = 2

Used in: AuthProtocolResponse

• UNSET_AUTHORIZATION_TYPE = 0

• TRUST = 1

• CHALLENGE = 2

v1 Trust request Contains the identity of the connecting node

• string identity = 1

v1 Trust response Returned if the identity was accepted

(message has no fields)

A message indicating an error in authorization. This includes failed authorizations, or invalid messages during the authorization handshake conversation.

• AuthorizationError.AuthorizationErrorType error_type = 1

  The type of error.

• string error_message = 2

  The error details.

Used in: AuthorizationError

• UNSET_AUTHORIZATION_ERROR_TYPE = 0

• AUTHORIZATION_REJECTED = 1

The authorization message envelope.

• AuthorizationMessageType message_type = 1

  The type of message.

• bytes payload = 2

  the payload.

The enumerated types of authorization messages.

Used in: AuthorizationMessage

• UNSET_AUTHORIZATION_MESSAGE_TYPE = 0

• CONNECT_REQUEST = 1

  Begin a Connection.

• CONNECT_RESPONSE = 2

• AUTHORIZE = 3

  Authorize a peer.

• AUTHORIZATION_ERROR = 4

  Authorization failure.

• TRUST_REQUEST = 10

  Trust.

• AUTH_COMPLETE = 100

  Start of v1 messages

• AUTH_PROTOCOL_REQUEST = 101

• AUTH_PROTOCOL_RESPONSE = 102

• AUTH_TRUST_REQUEST = 110

  v1 Trust authorization

• AUTH_TRUST_RESPONSE = 111

• AUTH_CHALLENGE_NONCE_REQUEST = 120

  Challenge Authorization

• AUTH_CHALLENGE_NONCE_RESPONSE = 121

• AUTH_CHALLENGE_SUBMIT_REQUEST = 122

• AUTH_CHALLENGE_SUBMIT_RESPONSE = 123

A successful authorization message. This message is returned after either a TrustResponse or a ChallengeResponse has been returned by the connecting node.

(message has no fields)

Used in: CircuitCreateRequest, CircuitJoinRequest, CircuitProposal

• string circuit_id = 1

  The unique circuit name

• repeated SplinterService roster = 2

  The list of services (service ids) that are allowed to connect to the circuit

• repeated SplinterNode members = 3

  The SplinterNodes that are a part of the circuit

• Circuit.AuthorizationType authorization_type = 4

  Circuit specific authorization type

• Circuit.PersistenceType persistence = 5

  Whether the circuit connections need to be persisted

• Circuit.DurabilityType durability = 6

  Whether the connection must be durable

• Circuit.RouteType routes = 7

  Routes a message is allowed to take from one service to another

• string circuit_management_type = 8

  The circuit management type indicates the application authorization handler that will handle this circuit's change proposals.

• bytes application_metadata = 9

  Opaque bytes that can be used by applications

• string comments = 10

  Human-readable comments about the circuit

• string display_name = 11

  Human-readable display name for the circuit

• int32 circuit_version = 12

  The schema version of the circuit

• Circuit.CircuitStatus circuit_status = 13

  The status of the circuit

Used in: Circuit

• UNSET_AUTHORIZATION_TYPE = 0

• TRUST_AUTHORIZATION = 1

  Connections are trusted, and no authorization is done

• CHALLENGE_AUTHORIZATION = 2

  Connections must prove their identity by signing bytes and providing their public key

Used in: Circuit

• UNSET_CIRCUIT_STATUS = 0

• ACTIVE = 1

• DISBANDED = 2

  The circuit has been disbanded and no longer has networking capabilities

• ABANDONED = 3

  The circuit has been abandoned and may be removed from storage

Used in: Circuit

• UNSET_DURABILITY_TYPE = 0

• NO_DURABILITY = 1

  The message will be dropped if the connection is not available

Used in: Circuit

• UNSET_PERSISTENCE_TYPE = 0

• ANY_PERSISTENCE = 1

  The circuit does not have a preference for if the connection is persisted

Used in: Circuit

• UNSET_ROUTE_TYPE = 0

• ANY_ROUTE = 1

  The circuit can use any route to deliver the message

Used in: CircuitManagementPayload

• string circuit_id = 1

  The unique circuit name

This message will be submitted to a splinter node by an administrator that wishes to add a new Circuit to the network

Used in: CircuitManagementPayload

• optional Circuit circuit = 1

• string circuit = 1

  the name of the circuit the message is meant for

• string sender = 2

  id of the sender of the message

• string recipient = 3

  id of recipient of the message

• bytes payload = 4

  the request

• string correlation_id = 5

  id used to correlate the response with this request

Used in: CircuitManagementPayload

• string circuit_id = 1

  The unique circuit name

• string correlation_id = 1

  id that correlates response to a request

• string service_id = 2

  service id of the sender of the message

• string circuit_name = 3

  circuit id of the sender of the message

• CircuitError.Error error = 4

  enum of the network specific error that was encountered

• string error_message = 5

  explanation of the error

Used in: CircuitError

• UNSET_ERROR = 0

• ERROR_CIRCUIT_DOES_NOT_EXIST = 1

• ERROR_RECIPIENT_NOT_IN_CIRCUIT_ROSTER = 2

• ERROR_SENDER_NOT_IN_CIRCUIT_ROSTER = 3

• ERROR_RECIPIENT_NOT_IN_DIRECTORY = 4

• ERROR_SENDER_NOT_IN_DIRECTORY = 5

This message is used to notify the new node of the circuit definition, as well as ask for confirmation that they wish to join the node.

Used in: CircuitManagementPayload

• optional Circuit circuit = 1

Used in: ProposedCircuit

• bytes header = 1

  Serialized header

• bytes signature = 2

  The signature derived from signing the header included in this request

• optional CircuitProposalVote circuit_proposal_vote = 3

• optional CircuitCreateRequest circuit_create_request = 4

• optional CircuitUpdateRosterRequest circuit_update_roster_request = 5

• optional CircuitUpdateAddNodeRequest circuit_update_add_node = 6

• optional CircuitUpdateRemoveNodeRequest circuit_update_remove_node = 7

• optional CircuitUpdateApplicationMetadataRequest circuit_update_application_metadata_request = 8

• optional CircuitJoinRequest circuit_join_request = 9

• optional CircuitDisbandRequest circuit_disband_request = 10

• optional CircuitPurgeRequest circuit_purge_request = 11

• optional CircuitAbandon circuit_abandon = 12

• optional ProposalRemoveRequest proposal_remove_request = 13

Used in: Header

• ACTION_UNSET = 0

• CIRCUIT_PROPOSAL_VOTE = 1

• CIRCUIT_CREATE_REQUEST = 2

• CIRCUIT_UPDATE_ROSTER_REQUEST = 3

• CIRCUIT_UPDATE_ADD_NODE = 4

• CIRCUIT_UPDATE_REMOVE_NODE = 5

• CIRCUIT_UPDATE_APPLICATION_METADATA_REQUEST = 6

• CIRCUIT_JOIN_REQUEST = 7

• CIRCUIT_DISBAND_REQUEST = 8

• CIRCUIT_PURGE_REQUEST = 9

• CIRCUIT_ABANDON = 10

• PROPOSAL_REMOVE_REQUEST = 11

• Action action = 1

• bytes requester = 2

  Public key of agent submitting the payload

• bytes payload_sha512 = 3

  A hash of the circuit management payload action in bytes

• string requester_node_id = 4

  the node the requester is submitting the payload for

• CircuitMessageType message_type = 1

  The message type for the payload

• bytes payload = 2

  either a message defined below or another message envelope

Used in: CircuitMessage

• UNSET_CIRCUIT_MESSAGE_TYPE = 0

• CIRCUIT_ERROR_MESSAGE = 1

  Circuit Message

• NETWORK_ERROR_MESSAGE = 2

• CIRCUIT_DIRECT_MESSAGE = 3

• SERVICE_CONNECT_REQUEST = 4

• SERVICE_CONNECT_RESPONSE = 5

• SERVICE_DISCONNECT_REQUEST = 7

• SERVICE_DISCONNECT_RESPONSE = 8

• ADMIN_DIRECT_MESSAGE = 100

Contains the vote counts for a given proposal.

Used in: CircuitProposalList

• CircuitProposal.ProposalType proposal_type = 1

  What is being changed

• string circuit_id = 2

  The id of the circuit being proposed/updated

• string circuit_hash = 3

  The sha256 hash of the final state of the new circuit definition in bytes

• optional Circuit circuit_proposal = 4

  The new circuit state created by the proposal

• repeated CircuitProposal.VoteRecord votes = 5

  List of votes

• bytes requester = 6

  The public key that the request originated from a vote does not need to come from the node this public key is associated with

• string requester_node_id = 7

  the node the requester created the proposal for

Used in: CircuitProposal

• UNSET_PROPOSAL_TYPE = 0

• CREATE = 1

• UPDATE_ROSTER = 2

• ADD_NODE = 3

• REMOVE_NODE = 4

• DISBAND = 5

An individual vote record

Used in: CircuitProposal

• bytes public_key = 1

  The public key of the voter

• CircuitProposalVote.Vote vote = 2

  The voter's actual vote

• string voter_node_id = 3

  the node the vote came from

Contains all the circuit proposals up for a vote.

• repeated CircuitProposal candidates = 1

Used in: CircuitManagementPayload

• string circuit_id = 1

  The id of the circuit being updated

• string circuit_hash = 2

  The sha256 hash of the final state of the new circuit definition in bytes

• CircuitProposalVote.Vote vote = 3

Used in: CircuitProposal.VoteRecord, CircuitProposalVote

• UNSET_VOTE = 0

• ACCEPT = 1

• REJECT = 2

Used in: CircuitManagementPayload

• string circuit_id = 1

  The unique circuit id of the inactive circuit to be purged

This message will be submitted to a splinter node by an administrator that wishes to add a splinter node to the circuit

Used in: CircuitManagementPayload

• string circuit_id = 1

  The unique circuit id

• optional SplinterNode node = 2

  The node that should be added to the circuit

Used in: CircuitManagementPayload

• string circuit_id = 1

  The unique circuit name

• bytes application_metedata = 2

  the new application metadata that should be stored in the circuit

This message will be submitted to a splinter node by an administrator that wishes to remove a splinter node to the circuit

Used in: CircuitManagementPayload

• string circuit_id = 1

  The unique circuit name

• string node_id = 2

  The node that should be removed from the circuit

This message will be submitted to a splinter node by an administrator that wishes to modify a circuit's roster of services.

Used in: CircuitManagementPayload

• string circuit_id = 1

  The unique circuit id

• repeated SplinterService add_services = 2

  The list of services that should be added to the circuit

• repeated SplinterService remove_services = 3

  The list of services that should be removed from the circuit

Used in: TwoPhaseCommitMessage

• uint64 epoch = 1

This message is used to keep connections alive

(message has no fields)

The component message envelope. All message sent to local components will be wrapped in one of these.

• ComponentMessageType message_type = 1

  The type of component message

• bytes payload = 2

  The envelope contents.

Used in: ComponentMessage

• UNSET_COMPONENT_MESSAGE_TYPE = 0

• COMPONENT_HEARTBEAT = 2

  Mimics the NETWORK_HEARTBEAT

• SERVICE = 100

A connection request message. This message provides information from the incoming connection.

• ConnectRequest.HandshakeMode handshake_mode = 1

Used in: ConnectRequest

• UNSET_HANDSHAKE_MODE = 0

• UNIDIRECTIONAL = 1

• BIDIRECTIONAL = 2

A connection response message. This message provides information for the incoming peer regarding the types of authorization accepted.

• repeated ConnectResponse.AuthorizationType accepted_authorization_types = 1

  A list of available authorization types accepted by the sending node.

Used in: ConnectResponse

• UNSET_AUTHORIZATION_TYPE = 0

• TRUST = 1

• bytes message = 1

  An opaque message that is interpreted by the consensus algorithm

• bytes origin_id = 2

  ID of the service that created this message

Used in: TwoPhaseCommitMessage

• uint64 epoch = 1

Used in: TwoPhaseCommitMessage

• uint64 epoch = 1

Used in: AdminMessage

• string circuit_id = 1

• string member_node_id = 2

This message is used for debugging

• bytes payload = 1

• string recipient = 2

• int32 time_to_live = 3

• string correlation_id = 1

  id that correlates response to a request

• NetworkError.Error error = 2

  enum of the network specific error that was encountered

• string error_message = 3

  explanation of the error

Used in: NetworkError

• UNSET_ERROR = 0

• ERROR_COULD_NOT_DELIVER = 1

• ERROR_QUEUE_FULL = 2

This message is used to keep connections alive

(message has no fields)

• NetworkMessageType message_type = 1

  The message type for the payload

• bytes payload = 2

  either a message defined below or another message envelope

Used in: NetworkMessage

• UNSET_NETWORK_MESSAGE_TYPE = 0

• NETWORK_ECHO = 1

  Network Message

• NETWORK_HEARTBEAT = 2

• CIRCUIT = 100

  Message types that indicate that the payload is another message envelope

• AUTHORIZATION = 101

• bytes id = 1

  The proposal’s identifier, which is a hash of `previous_id`, `proposal_height`, and `summary`

• bytes previous_id = 2

  The identifier of the proposal’s immediate predecessor

• uint64 proposal_height = 3

  The number of proposals preceding this one (used for ordering purposes)

• bytes summary = 4

  A summary of the data this proposal represents

• bytes consensus_data = 5

  Opaque data that is provided by the consensus algorithm

Used in: CircuitManagementPayload

• string circuit_id = 1

  The unique circuit name

Used in: ScabbardMessage

• bytes proposal = 1

• bytes batch = 2

• string service_id = 3

Used in: AdminMessage

• optional CircuitManagementPayload circuit_payload = 1

  the payload that needs to be sent to all members of a circuit

• bytes expected_hash = 2

  the hash of the expected circuit proposal that is generated by the included request

• bytes required_verifiers = 3

Used in: AdminMessage

• string circuit_id = 1

  the proposal being removed

Message to be set in consensus data to tell the consensus engine who needs to approve the proposal

• repeated bytes verifiers = 1

• string correlation_id = 1

  ID used to correlate the response with this request

• SMConnectResponse.Status status = 1

• string error_message = 2

  Explanation of the error (optional)

• string correlation_id = 3

  ID used to correlate this response with the request

Used in: SMConnectResponse

• UNSET_STATUS = 0

• OK = 1

• ERROR_CIRCUIT_DOES_NOT_EXIST = 2

• ERROR_SERVICE_NOT_IN_CIRCUIT_REGISTRY = 3

• ERROR_SERVICE_ALREADY_REGISTERED = 4

• ERROR_NOT_AN_ALLOWED_NODE = 5

• ERROR_QUEUE_FULL = 6

• ERROR_INTERNAL_ERROR = 7

• string correlation_id = 3

  ID used to correlate the response with this request

• SMDisconnectResponse.Status status = 1

• string error_message = 2

  Explanation of the error (optional)

• string correlation_id = 3

  ID used to correlate this response with the request

Used in: SMDisconnectResponse

• UNSET_STATUS = 0

• OK = 1

• ERROR_CIRCUIT_DOES_NOT_EXIST = 2

• ERROR_SERVICE_NOT_IN_CIRCUIT_REGISTRY = 3

• ERROR_SERVICE_NOT_REGISTERED = 4

• ERROR_QUEUE_FULL = 5

• ERROR_INTERNAL_ERROR = 6

• ScabbardMessage.Type message_type = 1

• bytes consensus_message = 2

  Set if type is CONSENSUS_MESSAGE

• optional ProposedBatch proposed_batch = 3

  Set if type is PROPOSED_BATCH

• bytes new_batch = 4

  Set if type is NEW_BATCH

Used in: ScabbardMessage

• UNSET = 0

• CONSENSUS_MESSAGE = 1

• PROPOSED_BATCH = 2

• NEW_BATCH = 3

• TOO_MANY_REQUESTS = 10

• ACCEPTING_REQUESTS = 11

• ScabbardMessageV3.Type message_type = 1

• bytes consensus_message = 2

  Set if type is CONSENSUS_MESSAGE

Used in: ScabbardMessageV3

• UNSET = 0

• CONSENSUS_MESSAGE = 1

• string circuit = 1

  the name of the circuit the message is meant for

• string service_id = 2

  the unique id of the service that is connecting to the circuit

• string correlation_id = 3

  id used to correlate the response with this request

• string circuit = 1

  the name of the circuit the message is meant for

• string service_id = 2

  the unique id of the service that is connecting to the circuit

• ServiceConnectResponse.Status status = 3

• string error_message = 4

  explanation of the error (optional)

• string correlation_id = 5

  id used to correlate this response with the request

Used in: ServiceConnectResponse

• UNSET_STATUS = 0

• OK = 1

• ERROR_CIRCUIT_DOES_NOT_EXIST = 2

• ERROR_SERVICE_NOT_IN_CIRCUIT_REGISTRY = 3

• ERROR_SERVICE_ALREADY_REGISTERED = 4

• ERROR_NOT_AN_ALLOWED_NODE = 5

• ERROR_QUEUE_FULL = 6

• string circuit = 1

  the name of the circuit the message is meant for

• string service_id = 2

  the unique id of the service that is connecting to the circuit

• string correlation_id = 3

  id used to correlate the response with this request

• string circuit = 1

  the name of the circuit the message is meant for

• string service_id = 2

  the unique id of the service that is connecting to the circuit

• ServiceDisconnectResponse.Status status = 3

• string error_message = 4

  explanation of the error (optional)

• string correlation_id = 5

  id used to correlate this response with the request

Used in: ServiceDisconnectResponse

• UNSET_ERROR = 0

• OK = 1

• ERROR_CIRCUIT_DOES_NOT_EXIST = 2

• ERROR_SERVICE_NOT_IN_CIRCUIT_REGISTRY = 3

• ERROR_SERVICE_NOT_REGISTERED = 4

• ERROR_QUEUE_FULL = 5

• ServiceMessageType message_type = 1

  The message type for the payload

• string circuit = 2

  The name of the circuit the message is meant for

• string service_id = 3

  The unique ID of the service that is connecting to the circuit

• bytes payload = 4

  Either a message defined below or another message envelope

Used in: ServiceMessage

• UNSET_SERVICE_MESSAGE_TYPE = 0

• SM_SERVICE_CONNECT_REQUEST = 100

  Registration-related messages

• SM_SERVICE_CONNECT_RESPONSE = 101

• SM_SERVICE_DISCONNECT_REQUEST = 102

• SM_SERVICE_DISCONNECT_RESPONSE = 103

• SM_SERVICE_PROCESSOR_MESSAGE = 200

  Opaque message contents, with routing information.

• string sender = 1

  ID of the sender of the message

• string recipient = 2

  ID of recipient of the message

• bytes payload = 3

  The request payload

• string correlation_id = 4

  ID used to correlate the response with this request (optional)

This message is sent to a connection AdminService to agree upon protocol version. The sending service will provide the min and max protocol versions they support.

Used in: AdminMessage

• uint32 protocol_min = 1

• uint32 protocol_max = 2

This message is a response ServiceProtocolVersionRequest. It contains the protocol version that the responder can support. If no matching protocol can be supported 0 is returned.

Used in: AdminMessage

• uint32 protocol = 1

The Setting protobuf (copied from Sawtooth) is required for setting the admin keys when Sabre starts Setting Container for on-chain configuration key/value pairs

• repeated Setting.Entry entries = 1

  List of setting entries - more than one implies a state key collision

Contains a setting entry (or entries, in the case of collisions).

Used in: Setting

• string key = 1

• string value = 2

Represents a splinter node on the splinter network

Used in: Circuit, CircuitUpdateAddNodeRequest

• string node_id = 1

  unique id of a splinter node

• repeated string endpoints = 2

  The endpoints the splinter node is available on

• bytes public_key = 3

  The public key that must be used for identification if authorization is set to challenge. This does not need to be set if using Trust.

Used in: Circuit, CircuitUpdateRosterRequest

• string service_id = 1

• string service_type = 2

• repeated string allowed_nodes = 3

• repeated SplinterService.Argument arguments = 4

Used in: SplinterService

• string key = 1

• string value = 2

Used in: AuthChallengeSubmitRequest

• bytes public_key = 1

• bytes signature = 2

A trust request. A trust request is sent in response to a Connect Message, if the node is using trust authentication as its means of allowing a node to connect.

• string identity = 1

  The requesting node's identity.

• TwoPhaseCommitMessage.Type message_type = 1

• optional VoteRequest vote_request = 2

• optional VoteResponse vote_response = 3

• optional Commit commit = 4

• optional Abort abort = 5

• optional DecisionRequest decision_request = 6

• optional DecisionAck decision_ack = 7

Used in: TwoPhaseCommitMessage

• UNSET = 0

• VOTE_REQUEST = 1

• VOTE_RESPONSE = 2

• COMMIT = 3

• ABORT = 4

• DECISION_REQUEST = 5

• DECISION_ACK = 6

• TwoPhaseMessage.Type message_type = 1

• bytes proposal_id = 2

• TwoPhaseMessage.ProposalVerificationResponse proposal_verification_response = 3

• TwoPhaseMessage.ProposalResult proposal_result = 4

Used in: TwoPhaseMessage

• UNSET_RESULT = 0

• APPLY = 1

• REJECT = 2

Used in: TwoPhaseMessage

• UNSET_VERIFICATION_RESPONSE = 0

• VERIFIED = 1

• FAILED = 2

Used in: TwoPhaseMessage

• UNSET_TYPE = 0

• PROPOSAL_VERIFICATION_REQUEST = 1

• PROPOSAL_VERIFICATION_RESPONSE = 2

• PROPOSAL_RESULT = 3

Used in: TwoPhaseCommitMessage

• uint64 epoch = 1

• bytes value = 2

Used in: TwoPhaseCommitMessage

• uint64 epoch = 1

• bool response = 2