package vmware.concord.client.request.v1

Get desktop application:
View/edit binary Protocol Buffers messages

The RequestService allows the caller to submit requests to the blockchain network, and receive the result of the request in a synchronous response. You can use the EventService below for asynchronously consuming the events of submitted requests.

• rpc Send (Request, Response)

  request.proto:33

  Send a single request via the Concord Client to the blockchain network. Errors: DEADLINE_EXCEEDED: if the request couldn't be processed before the given timeout expired. INVALID_ARGUMENT: if a required field is not set. RESOURCE_EXHAUSTED: if Concord Client is overloaded. The caller should retry with a backoff. UNAVAILABLE: if Concord Client is currently unable to process any requests. The caller should retry with a backoff. ABORTED: if Concord has a contention between concurrently running requests or if execution engine has rejected requests. The caller should retry. INTERNAL: if Concord Client cannot progress independent of the request.

  message Request

  request.proto:36

  • oneof application_request

    Required application request which gets evaluated by the execution engine.

    • bytes raw_request = 1

    • google.protobuf.Any typed_request = 6

  • optional google.protobuf.Duration timeout = 2

    Required timeout which defines the maximum amount of time the caller is willing to wait for the request to be processed by a quorum of replicas. Returns DEADLINE_EXCEEDED if the request times out. Returns INVALID_ARGUMENT if the timeout is zero.

  • optional bool read_only = 3

    Optional flag to mark the request as read-only. A read-only request doesn't go through consensus. Concord Client makes sure it receives matching replies from a quorum of replicas. `read_only` and `pre_execute` are mutually exclusive. INVALID_ARGUMENT if read_only and pre_execute are set.

  • optional bool pre_execute = 4

    Optional flag to enable request pre-execution. Pre-execution evaluates the request before consensus as opposed to after. If pre-execution is successful and no conflicts are detected during the execution phase then consensus will speed up for all requests in the system. `read_only` and `pre_execute` are mutually exclusive. INVALID_ARGUMENT if `read_only` and `pre_execute` are set.

  • optional string correlation_id = 5

    Optional request identifier. At runtime, Concord Client maps the `correlation_id` to a sequence number which can be used to track the request in log messages in the blockchain network.

  • optional bool primary_only = 7

    Optional flag to mark the request as primary-only. A primary-only request is a read-only request intended to be served by primary validator node only and this request is ignored by other non-primary validator nodes. Concord Client acknowledges replies from primary node only.

  message Response

  request.proto:82

  • oneof application_response

    Application data returned by the execution engine.

    • bytes raw_response = 1

    • google.protobuf.Any typed_response = 6

  • repeated Signature signatures = 7

Error messages corresponding to the error returned by request service.

• CONCORD_ERROR_UNSPECIFIED = 0

• CONCORD_ERROR_INVALID_REQUEST = 1

  Invalid request if required field is not set.

• CONCORD_ERROR_NOT_READY = 2

  Concord is unavailable.

• CONCORD_ERROR_TIMEOUT = 3

  Request couldn't be processed before the given timeout expired.

• CONCORD_ERROR_EXEC_DATA_TOO_LARGE = 4

  Execution data is too large.

• CONCORD_ERROR_EXEC_DATA_EMPTY = 5

  Execution data is empty.

• CONCORD_ERROR_CONFLICT_DETECTED = 6

  Concord has a contention between concurrently running requests.

• CONCORD_ERROR_OVERLOADED = 7

  Clients are occupied.

• CONCORD_ERROR_EXECUTION_ENGINE_REJECTED = 8

  Execution Engine rejected request.

• CONCORD_ERROR_INTERNAL = 9

  Internal error.

Used in: Response

• int32 id = 1

• bytes signature = 2