package ceseal_rpc

Get desktop application:
View/edit binary Protocol Buffers messages

The Ceseal service definition.

• rpc GetInfo (google.protobuf.Empty, CesealInfo)

  ceseal_rpc.proto:11

  Get basic information about Ceseal state.

  message CesealInfo

  ceseal_rpc.proto:70

  Basic information about a Ceseal instance.

  • bool initialized = 1

    Whether the init_runtime has been called successfully.

  • optional string genesis_block_hash = 2

    Genesis block header hash passed in by init_runtime.

  • uint32 headernum = 3

    The chain header number synchronized to.

  • uint32 blocknum = 4

    The changes block number synchronized to.

  • string state_root = 5

    Current chain storage's state root.

  • bool dev_mode = 6

    Whether the worker is running in dev mode.

  • uint64 pending_messages = 7

    The number of mq messages in the egress queue.

  • string version = 9

    The App version

  • string git_revision = 10

    The git commit hash which this binary was built from

  • optional MemoryUsage memory_usage = 11

    The heap memory usage of the enclave.

  • optional SystemInfo system = 12

    System info

  • bool can_load_chain_state = 13

    Whether the ceseal support to load state from arbitrary block.

  • uint32 safe_mode_level = 14

    Safe mode level

  • uint64 current_block_time = 15

    The timestamp of current block in milliseconds.

  • ExternalServerState external_server_state = 16

    The External Server state

• rpc SyncHeader (HeadersToSync, SyncedTo)

  ceseal_rpc.proto:14

  Sync the parent chain header

  message HeadersToSync

  ceseal_rpc.proto:137

  Request parameters for SyncHeader.

  • bytes encoded_headers = 1

    The relaychain headers to be synced. @codec scale crate::blocks::HeadersToSync

  • optional bytes encoded_authority_set_change = 2

    @codec scale crate::blocks::AuthoritySetChange

• rpc DispatchBlocks (Blocks, SyncedTo)

  ceseal_rpc.proto:17

  Dispatch blocks (Sync storage changes)

  message Blocks

  ceseal_rpc.proto:146

  Request parameters for DispatchBlocks.

  • bytes encoded_blocks = 1

    The blocks to be synced. @codec scale Vec<crate::blocks::BlockHeaderWithChanges>

• rpc InitRuntime (InitRuntimeRequest, InitRuntimeResponse)

  ceseal_rpc.proto:20

  Init the Ceseal runtime

  message InitRuntimeRequest

  ceseal_rpc.proto:153

  Request parameters for InitRuntime.

  • bool skip_ra = 1

    Retired Skip the remote attestation report.

  • bytes encoded_genesis_info = 2

    Genesis block infomation for light validation. @codec scale crate::blocks::GenesisBlockInfo

  • optional bytes debug_set_key = 3

    Worker identity key for dev mode.

  • bytes encoded_genesis_state = 4

    The parachain's genesis storage state. @codec scale crate::blocks::StorageState

  • optional bytes encoded_operator = 5

    The operator of of this worker, which has the permission to bind it's miner. @codec scale chain::AccountId

  • optional bytes attestation_provider = 6

    Attestation provider; @codec scale ces_types::AttestationProvider

  • bool grandpa_note_stalled = 7

    Has Granpa been note-stalled

• rpc GetRuntimeInfo (GetRuntimeInfoRequest, InitRuntimeResponse)

  ceseal_rpc.proto:23

  Get the cached Ceseal runtime init response

  message GetRuntimeInfoRequest

  ceseal_rpc.proto:176

  Request parameters for GetRuntimeInfo.

  • bool force_refresh_ra = 1

    Force to refresh the RA report.

  • optional bytes encoded_operator = 2

    Reset the operator of of this worker. @codec scale chain::AccountId

• rpc GetEgressMessages (google.protobuf.Empty, GetEgressMessagesResponse)

  ceseal_rpc.proto:26

  Get pending egress messages

  message GetEgressMessagesResponse

  ceseal_rpc.proto:215

  Response for GetEgressMessages

  • bytes encoded_messages = 1

    @codec scale EgressMessages

• rpc SetEndpoint (SetEndpointRequest, GetEndpointResponse)

  ceseal_rpc.proto:29

  Init the endpoint

  message SetEndpointRequest

  ceseal_rpc.proto:279

  • string endpoint = 1

• rpc RefreshEndpointSigningTime (google.protobuf.Empty, GetEndpointResponse)

  ceseal_rpc.proto:32

  Refresh the endpoint signing time

• rpc GetEndpointInfo (google.protobuf.Empty, GetEndpointResponse)

  ceseal_rpc.proto:35

  Get endpoint info

• rpc Echo (EchoMessage, EchoMessage)

  ceseal_rpc.proto:38

  A echo rpc to measure network RTT.

  message EchoMessage

  ceseal_rpc.proto:275

  • bytes echo_msg = 1

• rpc HandoverCreateChallenge (google.protobuf.Empty, HandoverChallenge)

  ceseal_rpc.proto:41

  Key Handover Server: Get challenge for worker key handover from another ceSeal

• rpc HandoverStart (HandoverChallengeResponse, HandoverWorkerKey)

  ceseal_rpc.proto:44

  Key Handover Server: Get worker key with RA report on challenge from another ceSeal

• rpc HandoverAcceptChallenge (HandoverChallenge, HandoverChallengeResponse)

  ceseal_rpc.proto:47

  Key Handover Client: Process HandoverChallenge and return RA report

• rpc HandoverReceive (HandoverWorkerKey, google.protobuf.Empty)

  ceseal_rpc.proto:50

  Key Handover Client: Receive encrypted worker key

• rpc LoadChainState (ChainState, google.protobuf.Empty)

  ceseal_rpc.proto:53

  Load given chain state into the ceseal

  message ChainState

  ceseal_rpc.proto:289

  • uint32 block_number = 1

  • bytes encoded_state = 2

    @codec scale crate::blocks::StorageState

• rpc Stop (StopOptions, google.protobuf.Empty)

  ceseal_rpc.proto:56

  Stop and optionally remove checkpoints

  message StopOptions

  ceseal_rpc.proto:295

  • bool remove_checkpoints = 1

    Remove checkpoints before stop

• rpc LoadStorageProof (StorageProof, google.protobuf.Empty)

  ceseal_rpc.proto:59

  Partially load values into the ceseal's chain storage.

  message StorageProof

  ceseal_rpc.proto:300

  • repeated bytes proof = 1

• rpc TakeCheckpoint (google.protobuf.Empty, SyncedTo)

  ceseal_rpc.proto:62

  Take checkpoint. Returns the current block number of the saved state.

• rpc GetMasterKeyApply (google.protobuf.Empty, GetMasterKeyApplyResponse)

  ceseal_rpc.proto:64

  message GetMasterKeyApplyResponse

  ceseal_rpc.proto:304

  • optional bytes encoded_payload = 1

    @codec scale ces_types::MasterKeyApplyPayload

  • optional bytes signature = 2

• rpc OperateExternalServer (ExternalServerOperation, google.protobuf.Empty)

  ceseal_rpc.proto:66

  message ExternalServerOperation

  ceseal_rpc.proto:315

  • ExternalServerCmd cmd = 1

Used in: HandoverChallengeResponse, HandoverWorkerKey, InitRuntimeResponse

• int32 version = 1

• string provider = 2

• optional AttestationReport payload = 3

  Retired

• bytes encoded_report = 5

• uint64 timestamp = 4

Retired

Used in: Attestation

• string report = 1

• bytes signature = 2

• bytes signing_cert = 3

Used in: Signature

• bytes encoded_body = 1

  The body of the certificate @codec scale crate::crypto::CertificateBody

• optional Signature signature = 2

  An optinal signature of the body signed by a parent certificate. @boxed

Used in: ExternalServerOperation

• Start = 0

• Shutdown = 1

Used in: CesealInfo

• Closed = 0

• Serving = 1

Used as response type in: CesealApi.GetEndpointInfo, CesealApi.RefreshEndpointSigningTime, CesealApi.SetEndpoint

• optional bytes encoded_endpoint_payload = 1

  @codec scale ces_types::WorkerEndpointPayload

• optional bytes signature = 2

Used as request type in: CesealApi.HandoverAcceptChallenge

Used as response type in: CesealApi.HandoverCreateChallenge

• bytes encoded_challenge = 1

  @codec scale ces_types::HandoverChallenge<chain::BlockNumber>

Used as request type in: CesealApi.HandoverStart

Used as response type in: CesealApi.HandoverAcceptChallenge

• bytes encoded_challenge_handler = 1

  @codec scale ces_types::ChallengeHandlerInfo<chain::BlockNumber>

• optional Attestation attestation = 2

  The sgx attestation on the challenge handler hash

Used as request type in: CesealApi.HandoverReceive

Used as response type in: CesealApi.HandoverStart

• bytes encoded_worker_key = 1

  @codec scale ces_types::EncryptedWorkerKey

• optional Attestation attestation = 2

  The sgx attestation on the encrypted worker key hash

Used as response type in: CesealApi.GetRuntimeInfo, CesealApi.InitRuntime

• bytes encoded_runtime_info = 1

  @codec scale ces_types::WorkerRegistrationInfo<chain::AccountId>

• bytes encoded_genesis_block_hash = 2

  The hash of the first synced relaychain header. @codec scale chain::Hash

• bytes encoded_public_key = 3

  The worker's public key. @codec scale ces_types::WorkerPublicKey

• bytes encoded_ecdh_public_key = 4

  @codec scale ces_types::EcdhPublicKey

• optional Attestation attestation = 5

  The sgx attestation

Used in: CesealInfo

• uint64 rust_used = 1

  The current heap usage of Rust codes.

• uint64 rust_peak_used = 2

  The peak heap usage of Rust codes.

• uint64 total_peak_used = 3

  The entire peak heap memory usage of the enclave.

• uint64 free = 4

  The memory left.

• uint64 rust_spike = 5

  The peak heap usage of Rust codes in a recent short-term.

Used in: Certificate

• optional Certificate signed_by = 1

  The certificate of the signer

• SignatureType signature_type = 2

  The signature type

• bytes signature = 3

  The signature of the data

Supported signature types. Each signature type also has its corresponding "WrapBytes" version as defined in Polkadot.js: https://github.com/polkadot-js/extension/blob/e4ce268b1cad5e39e75a2195e3aa6d0344de7745/packages/extension-dapp/src/wrapBytes.ts In wrapped version, the message will have tags wrapped around the actual message (`<Bytes>{msg}</Bytes>`). This was introduced in Polkadot.js to reduce the risk it's abused to sign regular transaction. However, we have to support it as well because it's the only message format the Polkadot.js Extension can sign.

Used in: Signature

• Ed25519 = 0

• Sr25519 = 1

• Ecdsa = 2

• Ed25519WrapBytes = 3

• Sr25519WrapBytes = 4

• EcdsaWrapBytes = 5

  Eip712 = 6;

Response to SyncHeader & SyncParaHeader.

Used as response type in: CesealApi.DispatchBlocks, CesealApi.SyncHeader, CesealApi.TakeCheckpoint

• uint32 synced_to = 1

  The final actual block number synced to.

Basic information for the initialized runtime

Used in: CesealInfo

• bool registered = 1

  Whether the worker has been registered on-chain.

• string public_key = 2

  Public key of the worker.

• string ecdh_public_key = 3

  ECDH public key of the worker.

• string master_public_key = 4

  The master public key, empty if the master key not ready

• uint32 genesis_block = 5

  The block that the ceseal loaded the genesis state from.