package gateway

Get desktop application:
View/edit binary Protocol Buffers messages

The Gateway API for evaluating and submitting transactions via the gateway. Transaction evaluation (query) requires the invocation of the Evaluate service Transaction submission (ledger updates) is a two step process invoking Endorse followed by Submit. A third step, invoking CommitStatus, is required if the clients wish to wait for a Transaction to be committed. The proposal and transaction must be signed by the client before each step.

• rpc ChaincodeEvents (SignedChaincodeEventsRequest, stream ChaincodeEventsResponse)

  gateway.proto:57

  The ChaincodeEvents service supplies a stream of responses, each containing all the events emitted by the requested chaincode for a specific block. The streamed responses are ordered by ascending block number. Responses are only returned for blocks that contain the requested events, while blocks not containing any of the requested events are skipped.

  message SignedChaincodeEventsRequest

  gateway.proto:146

  SignedChaincodeEventsRequest contains a serialized ChaincodeEventsRequest message, and a digital signature for the serialized request message.

  • bytes request = 1

    Serialized ChaincodeEventsRequest message.

  • bytes signature = 2

    Signature for request message.

  message ChaincodeEventsResponse

  gateway.proto:170

  ChaincodeEventsResponse returns chaincode events emitted from a specific block.

  • repeated protos.ChaincodeEvent events = 1

    Chaincode events emitted by the requested chaincode. The events are presented in the same order that the transactions that emitted them appear within the block.

  • uint64 block_number = 2

    Block number in which the chaincode events were emitted.

• rpc CommitStatus (SignedCommitStatusRequest, CommitStatusResponse)

  gateway.proto:46

  The CommitStatus service will indicate whether a prepared transaction previously submitted to the Submit service has been committed. It will wait for the commit to occur if it hasn’t already committed.

  message SignedCommitStatusRequest

  gateway.proto:98

  SignedCommitStatusRequest contains a serialized CommitStatusRequest message, and a digital signature for the serialized request message.

  • bytes request = 1

    Serialized CommitStatusRequest message.

  • bytes signature = 2

    Signature for request message.

  message CommitStatusResponse

  gateway.proto:117

  CommitStatusResponse returns the result of committing a transaction.

  • protos.TxValidationCode result = 1

    The result of the transaction commit, as defined in peer/transaction.proto.

  • uint64 block_number = 2

    Block number that contains the transaction.

• rpc Endorse (EndorseRequest, EndorseResponse)

  gateway.proto:35

  The Endorse service passes a proposed transaction to the gateway in order to obtain sufficient endorsement. The gateway will determine the endorsement plan for the requested chaincode and forward to the appropriate peers for endorsement. It will return to the client a prepared transaction in the form of an Envelope message as defined in common/common.proto. The client must sign the contents of this envelope before invoking the Submit service.

  message EndorseRequest

  gateway.proto:62

  EndorseRequest contains the details required to obtain sufficient endorsements for a transaction to be committed to the ledger.

  • string transaction_id = 1

    The unique identifier for the transaction.

  • string channel_id = 2

    Identifier of the channel this request is bound for.

  • optional protos.SignedProposal proposed_transaction = 3

    The signed proposal ready for endorsement.

  • repeated string endorsing_organizations = 4

    If targeting the peers of specific organizations (e.g. for private data scenarios), the list of organizations' MSPIDs should be supplied here.

  message EndorseResponse

  gateway.proto:75

  EndorseResponse returns the result of endorsing a transaction.

  • optional common.Envelope prepared_transaction = 1

    The unsigned set of transaction responses from the endorsing peers for signing by the client before submitting to ordering service (via gateway).

• rpc Evaluate (EvaluateRequest, EvaluateResponse)

  gateway.proto:51

  The Evaluate service passes a proposed transaction to the gateway in order to invoke the transaction function and return the result to the client. No ledger updates are made. The gateway will select an appropriate peer to query based on block height and load.

  message EvaluateRequest

  gateway.proto:125

  EvaluateRequest contains the details required to evaluate a transaction (query the ledger).

  • string transaction_id = 1

    Identifier of the transaction to evaluate.

  • string channel_id = 2

    Identifier of the channel this request is bound for.

  • optional protos.SignedProposal proposed_transaction = 3

    The signed proposal ready for evaluation.

  • repeated string target_organizations = 4

    If targeting the peers of specific organizations (e.g. for private data scenarios), the list of organizations' MSPIDs should be supplied here.

  message EvaluateResponse

  gateway.proto:138

  EvaluateResponse returns the result of evaluating a transaction.

  • optional protos.Response result = 1

    The response that is returned by the transaction function, as defined in peer/proposal_response.proto.

• rpc Submit (SubmitRequest, SubmitResponse)

  gateway.proto:41

  The Submit service will process the prepared transaction returned from Endorse service once it has been signed by the client. It will wait for the transaction to be submitted to the ordering service but the client must invoke the CommitStatus service to wait for the transaction to be committed.

  message SubmitRequest

  gateway.proto:82

  SubmitRequest contains the details required to submit a transaction (update the ledger).

  • string transaction_id = 1

    Identifier of the transaction to submit.

  • string channel_id = 2

    Identifier of the channel this request is bound for.

  • optional common.Envelope prepared_transaction = 3

    The signed set of endorsed transaction responses to submit.

  message SubmitResponse

  gateway.proto:92

  SubmitResponse returns the result of submitting a transaction.

  Nothing yet

  (message has no fields)

ChaincodeEventsRequest contains details of the chaincode events that the caller wants to receive.

• string channel_id = 1

  Identifier of the channel this request is bound for.

• string chaincode_id = 2

  Name of the chaincode for which events are requested.

• bytes identity = 3

  Client requestor identity.

• optional orderer.SeekPosition start_position = 4

  Position within the ledger at which to start reading events.

• string after_transaction_id = 5

  Only returns events after this transaction ID. Transactions up to and including this one should be ignored. This is used to allow resume of event listening from a certain position within a start block specified by start_position.

CommitStatusRequest contains the details required to check whether a transaction has been successfully committed.

• string transaction_id = 1

  Identifier of the transaction to check.

• string channel_id = 2

  Identifier of the channel this request is bound for.

• bytes identity = 3

  Client requestor identity.

If any of the functions in the Gateway service returns an error, then it will be in the format of a google.rpc.Status message. The 'details' field of this message will be populated with extra information if the error is a result of one or more failed requests to remote peers or orderer nodes. ErrorDetail contains details of errors that are received by any of the endorsing peers as a result of processing the Evaluate or Endorse services, or from the ordering node(s) as a result of processing the Submit service.

• string address = 1

  The address of the endorsing peer or ordering node that returned an error.

• string msp_id = 2

  The MSP Identifier of this node.

• string message = 3

  The error message returned by this node.

PreparedTransaction contains the details required for offline signing prior to submitting a transaction.

• string transaction_id = 1

  Identifier of the prepared transaction.

• optional common.Envelope envelope = 2

  The transaction envelope.

ProposedTransaction contains the details required for offline signing prior to evaluating or endorsing a transaction.

• string transaction_id = 1

  Identifier of the proposed transaction.

• optional protos.SignedProposal proposal = 2

  The signed proposal.

• repeated string endorsing_organizations = 3

  The list of endorsing organizations.