package ircontrol

Get desktop application:
View/edit binary Protocol Buffers messages

`ControlService` provides an interface for internal work with the Inner Ring node.

• rpc HealthCheck (HealthCheckRequest, HealthCheckResponse)

  service.proto:12

  Performs health check of the IR node.

  message HealthCheckRequest

  service.proto:25

  Health check request.

  • optional HealthCheckRequest.Body body = 1

    Body of health check request message.

  • optional Signature signature = 2

    Body signature. Should be signed by node key or one of the keys configured by the node.

  message HealthCheckResponse

  service.proto:40

  Health check response.

  • optional HealthCheckResponse.Body body = 1

    Body of health check response message.

  • optional Signature signature = 2

    Body signature.

• rpc NotaryList (NotaryListRequest, NotaryListResponse)

  service.proto:15

  NotaryList list notary requests from the network.

  message NotaryListRequest

  service.proto:55

  NotaryList request.

  • optional NotaryListRequest.Body body = 1

    Body of request message.

  • optional Signature signature = 2

    Body signature.

  message NotaryListResponse

  service.proto:68

  NotaryList response.

  • optional NotaryListResponse.Body body = 1

    Body of request message.

  • optional Signature signature = 2

    Body signature.

• rpc NotaryRequest (NotaryRequestRequest, NotaryRequestResponse)

  service.proto:18

  NotaryRequest create and send notary request to the network.

  message NotaryRequestRequest

  service.proto:83

  NotaryRequest request.

  • optional NotaryRequestRequest.Body body = 1

    Body of request message.

  • optional Signature signature = 2

    Body signature.

  message NotaryRequestResponse

  service.proto:98

  NotaryRequest response.

  • optional NotaryRequestResponse.Body body = 1

    Body of request message.

  • optional Signature signature = 2

    Body signature.

• rpc NotarySign (NotarySignRequest, NotarySignResponse)

  service.proto:21

  NotarySign sign a notary request by it hash.

  message NotarySignRequest

  service.proto:113

  NotarySign request.

  • optional NotarySignRequest.Body body = 1

    Body of request message.

  • optional Signature signature = 2

    Body signature.

  message NotarySignResponse

  service.proto:128

  NotarySign response.

  • optional NotarySignResponse.Body body = 1

    Body of request message.

  • optional Signature signature = 2

    Body signature.

Health check request body.

Used in: HealthCheckRequest

(message has no fields)

Health check response body

Used in: HealthCheckResponse

• HealthStatus health_status = 1

  Health status of IR node application.

Health status of the IR application.

Used in: HealthCheckResponse.Body

• HEALTH_STATUS_UNDEFINED = 0

  Undefined status, default value.

• STARTING = 1

  IR application is starting.

• READY = 2

  IR application is started and serves all services.

• SHUTTING_DOWN = 3

  IR application is shutting down.

• INITIALIZING_NETWORK = 4

  Initializing Neo network

Request body structure.

Used in: NotaryListRequest

(message has no fields)

Request body structure.

Used in: NotaryListResponse

• repeated TransactionInfo transactions = 1

  Transaction of the notary request.

Request body structure.

Used in: NotaryRequestRequest

• string method = 1

• repeated bytes args = 2

Request body structure.

Used in: NotaryRequestResponse

• bytes hash = 1

  Result hash of transaction.

Request body structure.

Used in: NotarySignRequest

• bytes hash = 1

  Hash of transaction that need to be signed.

Request body structure.

Used in: NotarySignResponse

(message has no fields)

Signature of some message.

Used in: HealthCheckRequest, HealthCheckResponse, NotaryListRequest, NotaryListResponse, NotaryRequestRequest, NotaryRequestResponse, NotarySignRequest, NotarySignResponse

• bytes key = 1

  Public key used for signing.

• bytes sign = 2

  Binary signature.

Info about transaction.

Used in: NotaryListResponse.Body

• bytes hash = 1

  Hash of transaction.