package orderer

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc Broadcast (stream common.Envelope, stream BroadcastResponse)

  ab.proto:82

  broadcast receives a reply of Acknowledgement for each common.Envelope in order, indicating success or type of failure

  message BroadcastResponse

  ab.proto:14

  • common.Status status = 1

    Status code, which may be used to programatically respond to success/failure

  • string info = 2

    Info string which may contain additional information about the status returned

• rpc Deliver (stream common.Envelope, stream DeliverResponse)

  ab.proto:85

  deliver first requires an Envelope of type DELIVER_SEEK_INFO with Payload data as a mashaled SeekInfo message, then a stream of block replies is received.

  message DeliverResponse

  ab.proto:73

  • oneof Type

    • common.Status status = 1

    • common.Block block = 2

Cluster defines communication between cluster members.

• rpc Step (stream StepRequest, stream StepResponse)

  cluster.proto:17

  Step passes an implementation-specific message to another cluster member.

  message StepRequest

  cluster.proto:21

  StepRequest wraps a message that is sent to a cluster member.

  • oneof payload

    • ConsensusRequest consensus_request = 1

      consensus_request is a consensus specific message.

    • SubmitRequest submit_request = 2

      submit_request is a relay of a transaction.

  message StepResponse

  cluster.proto:31

  StepResponse is a message received from a cluster member.

  • oneof payload

    • SubmitResponse submit_res = 1

• uint32 max_message_count = 1

  Simply specified as number of messages for now, in the future we may want to allow this to be specified by size in bytes

• uint32 absolute_max_bytes = 2

  The byte count of the serialized messages in a batch cannot exceed this value.

• uint32 preferred_max_bytes = 3

  The byte count of the serialized messages in a batch should not exceed this value.

• string timeout = 1

  Any duration string parseable by ParseDuration(): https://golang.org/pkg/time/#ParseDuration

ChannelRestrictions is the mssage which conveys restrictions on channel creation for an orderer

• uint64 max_count = 1

  The max count of channels to allow to be created, a value of 0 indicates no limit

ConsensusRequest is a consensus specific message sent to a cluster member.

Used in: StepRequest

• string channel = 1

• bytes payload = 2

• bytes metadata = 3

• string type = 1

  The consensus type: "solo", "kafka" or "etcdraft".

• bytes metadata = 2

  Opaque metadata, dependent on the consensus type.

• ConsensusType.State state = 3

  The state signals the ordering service to go into maintenance mode, typically for consensus-type migration.

State defines the orderer mode of operation, typically for consensus-type migration. NORMAL is during normal operation, when consensus-type migration is not, and can not, take place. MAINTENANCE is when the consensus-type can be changed.

Used in: ConsensusType

• STATE_NORMAL = 0

• STATE_MAINTENANCE = 1

Carries a list of bootstrap brokers, i.e. this is not the exclusive set of brokers an ordering service

• repeated string brokers = 1

  Each broker here should be identified using the (IP|host):port notation, e.g. 127.0.0.1:7050, or localhost:7050 are valid entries

KafkaMessage is a wrapper type for the messages that the Kafka-based orderer deals with.

• oneof Type

  • KafkaMessageRegular regular = 1

  • KafkaMessageTimeToCut time_to_cut = 2

  • KafkaMessageConnect connect = 3

KafkaMessageConnect is posted by an orderer upon booting up. It is used to prevent the panic that would be caused if we were to consume an empty partition. It is ignored by all orderers when processing the partition.

Used in: KafkaMessage

• bytes payload = 1

KafkaMessageRegular wraps a marshalled envelope.

Used in: KafkaMessage

• bytes payload = 1

• uint64 config_seq = 2

• KafkaMessageRegular.Class class = 3

• int64 original_offset = 4

Used in: KafkaMessageRegular

• UNKNOWN = 0

• NORMAL = 1

• CONFIG = 2

KafkaMessageTimeToCut is used to signal to the orderers that it is time to cut block <block_number>.

Used in: KafkaMessage

• uint64 block_number = 1

KafkaMetadata is encoded into the ORDERER block to keep track of Kafka-related metadata associated with this block.

• int64 last_offset_persisted = 1

  LastOffsetPersisted is the encoded value for the Metadata message which is encoded in the ORDERER block metadata index for the case of the Kafka-based orderer.

• int64 last_original_offset_processed = 2

  LastOriginalOffsetProcessed is used to keep track of the newest offset processed if a message is re-validated and re-ordered. This value is used to deduplicate re-submitted messages from multiple orderer so that we don't bother re-processing it again.

• int64 last_resubmitted_config_offset = 3

  LastResubmittedConfigOffset is used to capture the newest offset of CONFIG kafka message, which is revalidated and resubmitted. By comparing this with LastOriginalOffsetProcessed, we could detemine whether there are still CONFIG messages that have been resubmitted but NOT processed yet. It's used as condition to block ingress messages, so we could reduce the overhead of repeatedly resubmitting messages as config seq keeps advancing.

SeekInfo specifies the range of requested blocks to return If the start position is not found, an error is immediately returned Otherwise, blocks are returned until a missing block is encountered, then behavior is dictated by the SeekBehavior specified.

• optional SeekPosition start = 1

  The position to start the deliver from

• optional SeekPosition stop = 2

  The position to stop the deliver

• SeekInfo.SeekBehavior behavior = 3

  The behavior when a missing block is encountered

• SeekInfo.SeekErrorResponse error_response = 4

  How to respond to errors reported to the deliver service

If BLOCK_UNTIL_READY is specified, the reply will block until the requested blocks are available, if FAIL_IF_NOT_READY is specified, the reply will return an error indicating that the block is not found. To request that all blocks be returned indefinitely as they are created, behavior should be set to BLOCK_UNTIL_READY and the stop should be set to specified with a number of MAX_UINT64

Used in: SeekInfo

• BLOCK_UNTIL_READY = 0

• FAIL_IF_NOT_READY = 1

SeekErrorTolerance indicates to the server how block provider errors should be tolerated. By default, if the deliver service detects a problem in the underlying block source (typically, in the orderer, a consenter error), it will begin to reject deliver requests. This is to prevent a client from waiting for blocks from an orderer which is stuck in an errored state. This is almost always the desired behavior and clients should stick with the default STRICT checking behavior. However, in some scenarios, particularly when attempting to recover from a crash or other corruption, it's desirable to force an orderer to respond with blocks on a best effort basis, even if the backing consensus implementation is in an errored state. In this case, set the SeekErrorResponse to BEST_EFFORT to ignore the consenter errors.

Used in: SeekInfo

• STRICT = 0

• BEST_EFFORT = 1

Used in: SeekPosition

(message has no fields)

SeekNextCommit refers to the next block that will be committed

Used in: SeekPosition

(message has no fields)

Used in: SeekPosition

(message has no fields)

Used in: SeekInfo

• oneof Type

  • SeekNewest newest = 1

  • SeekOldest oldest = 2

  • SeekSpecified specified = 3

  • SeekNextCommit next_commit = 4

Used in: SeekPosition

• uint64 number = 1

SubmitRequest wraps a transaction to be sent for ordering.

Used in: StepRequest

• string channel = 1

• uint64 last_validation_seq = 2

  last_validation_seq denotes the last configuration sequence at which the sender validated this message.

• optional common.Envelope payload = 3

  content is the fabric transaction that is forwarded to the cluster member.

SubmitResponse returns a success or failure status to the sender.

Used in: StepResponse

• string channel = 1

• common.Status status = 2

  Status code, which may be used to programatically respond to success/failure.

• string info = 3

  Info string which may contain additional information about the returned status.