package pruntime_rpc
Get desktop application:
View/edit binary Protocol Buffers messages
service PhactoryAPI
pruntime_rpc.proto:9The Phactory Runtime service definition.
rpc GetInfo (, )
pruntime_rpc.proto:11Get basic information about Phactory state.
message
pruntime_rpc.proto:138Basic information about a Phactory instance.
bool initialized = 1
Whether the init_runtime has been called successfully.
bool registered = 2
Whether the worker has been registered on-chain. (Deprecated, use .system.registered instead)
optional string genesis_block_hash = 4
Genesis block header hash passed in by init_runtime.
optional string public_key = 5
Public key of the worker. (Deprecated, use .system.public_key instead)
optional string ecdh_public_key = 6
ECDH public key of the worker. (Deprecated, use .system.ecdh_public_key instead)
uint32 headernum = 7
The relaychain/solochain header number synchronized to.
uint32 para_headernum = 8
The parachain header number synchronized to. (parachain mode only)
uint32 blocknum = 9
The changes block number synchronized to.
string state_root = 10
Current chain storage's state root.
bool dev_mode = 11
Whether the worker is running in dev mode.
uint64 pending_messages = 12
The number of mq messages in the egress queue.
uint64 score = 13
Local estimated benchmark score.
optional gatekeeper = 14
Status of gatekeeper. (Deprecated, use .system.gatekeeper instead)
string version = 15
The App version
string git_revision = 16
The git commit hash which this binary was built from
optional memory_usage = 18
The heap memory usage of the enclave.
bool waiting_for_paraheaders = 21
Some relay chain header synced, waiting for parachain headers.
optional system = 23
System info
bool can_load_chain_state = 24
Whether the pruntime support to load state from arbitrary block.
uint32 safe_mode_level = 25
Safe mode level
uint64 current_block_time = 26
The timestamp of current block in milliseconds.
string max_supported_pink_runtime_version = 27
The max pink runtime version can be deployed in this version of pruntime.
repeated string supported_attestation_methods = 28
The supported attestation methods
uint32 live_sidevm_instances = 29
The number of live sidevm instances.
uint32 query_timeout = 30
The timeout for contract query in seconds.
rpc SyncHeader (, )
pruntime_rpc.proto:14Sync the parent chain header
message
pruntime_rpc.proto:244Request 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 SyncParaHeader (, )
pruntime_rpc.proto:17Sync the parachain header
message
pruntime_rpc.proto:253Request parameters for SyncParaHeader.
bytes encoded_headers = 1
The parachain headers to be synced. @codec scale crate::blocks::Headers
repeated bytes proof = 2
aka StorageProof
Sync a combined batch of relaychain & parachain headers NOTE: - The two latest headers MUST be aligned with each other by the `Para.Heads` read from the relaychain storage. - The operation is not guaranteed to be atomical. If the parachain header is rejected, the already synced relaychain headers will keep it's progress.
message
pruntime_rpc.proto:262Request parameters for SyncCombinedHeaders.
bytes encoded_relaychain_headers = 1
The relaychain headers to be synced. @codec scale crate::blocks::HeadersToSync
optional bytes authority_set_change = 2
@codec scale crate::blocks::AuthoritySetChange
bytes encoded_parachain_headers = 3
The parachain headers to be synced. @codec scale crate::blocks::Headers
repeated bytes proof = 4
aka StorageProof
message
pruntime_rpc.proto:276Response to SyncCombinedHeaders.
uint32 relaychain_synced_to = 1
uint32 parachain_synced_to = 2
rpc DispatchBlocks (, )
pruntime_rpc.proto:27Dispatch blocks (Sync storage changes)
message
pruntime_rpc.proto:282Request parameters for DispatchBlocks.
bytes encoded_blocks = 1
The blocks to be synced. @codec scale Vec<crate::blocks::BlockHeaderWithChanges>
rpc InitRuntime (, )
pruntime_rpc.proto:30Init the Phactory runtime
message
pruntime_rpc.proto:289Request 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 this worker, which has the permission to bind it's miner. @codec scale chain::AccountId
bool is_parachain = 6
Init the runtime for parachain.
optional bytes attestation_provider = 7
Attestation provider; @codec scale phala_types::AttestationProvider
rpc GetRuntimeInfo (, )
pruntime_rpc.proto:33Get the cached Phactory runtime init response
message
pruntime_rpc.proto:312Request parameters for GetRuntimeInfo.
bool force_refresh_ra = 1
Force to refresh the RA report.
optional bytes encoded_operator = 2
Reset the operator of this worker. @codec scale chain::AccountId
Get pending egress messages
message
pruntime_rpc.proto:351Response for GetEgressMessages
bytes encoded_messages = 1
@codec scale EgressMessages
rpc ContractQuery (, )
pruntime_rpc.proto:39Send a query to a contract
message
pruntime_rpc.proto:357Request parameters for ContractQuery
bytes encoded_encrypted_data = 1
The query data. @codec scale crate::crypto::EncryptedData
optional signature = 2
The signature infomation
message
pruntime_rpc.proto:404bytes encoded_encrypted_data = 1
The query result. @codec scale crate::crypto::EncryptedData
rpc GetWorkerState (, )
pruntime_rpc.proto:42Get given worker's state from a GK.
message
pruntime_rpc.proto:411Request parameters for GetWorkerState
bytes public_key = 1
The worker's public key.
message
pruntime_rpc.proto:424Response for GetWorkerState
bool registered = 1
bool unresponsive = 2
optional bench_state = 3
optional working_state = 4
repeated uint32 waiting_heartbeats = 5
optional tokenomic_info = 10
optional stat = 11
rpc AddEndpoint (, )
pruntime_rpc.proto:45Init the endpoint
message
pruntime_rpc.proto:494bytes encoded_endpoint_type = 1
@codec scale crate::endpoints::EndpointType
string endpoint = 2
Refresh the endpoint signing time
rpc GetEndpointInfo (, )
pruntime_rpc.proto:51Get endpoint info
Sign the given endpoint info
message
pruntime_rpc.proto:506bytes encoded_endpoints = 1
@codec scale Vec<String>
Get prouter private key
message
pruntime_rpc.proto:511bytes phala_i2p_key = 1
rpc Echo (, )
pruntime_rpc.proto:60A echo rpc to measure network RTT.
message
pruntime_rpc.proto:484bytes echo_msg = 1
Key Handover Server: Get challenge for worker key handover from another pRuntime
rpc HandoverStart (, )
pruntime_rpc.proto:66Key Handover Server: Get worker key with RA report on challenge from another pRuntime
Key Handover Client: Process HandoverChallenge and return RA report
rpc HandoverReceive (, )
pruntime_rpc.proto:72Key Handover Client: Receive encrypted worker key
Dcap Key Handover Server: Get challenge for worker key handover from another pRuntime
Dcap Key Handover Server: Get worker key with RA report on challenge from another pRuntime
Dcap Key Handover Client: Process DcapHandoverChallenge and return LA report
Dcap Key Handover Client: Receive encrypted worker key
rpc ConfigNetwork (, )
pruntime_rpc.proto:87Config the pRuntime's network (currently, SOCKS5 proxy only)
rpc HttpFetch (, )
pruntime_rpc.proto:90Fetch resource from the internet.
message
pruntime_rpc.proto:567Parameters for the RPC HttpFetch
string url = 1
The destination URL to request to
string method = 2
The HTTP method
repeated headers = 3
A list of raw headers
bytes body = 4
The body payload
message
pruntime_rpc.proto:579Return type for HttpFetch
uint32 status_code = 1
The HTTP status code
repeated headers = 2
A list of raw headers
bytes body = 3
The body payload
rpc GetContractInfo (, )
pruntime_rpc.proto:93Get basic information about given contract
message
pruntime_rpc.proto:589Parameters for RPC GetContractInfo
repeated string contracts = 1
The ids of contracts to query about. Leave empty to query all.
message
pruntime_rpc.proto:595Response for RPC GetContractInfo
repeated contracts = 1
A list of contract informations
rpc GetClusterInfo (, )
pruntime_rpc.proto:96Get basic information about clusters
message
pruntime_rpc.proto:633Response to GetClusters
optional info = 1
Upload sidevm code to given contract. An ink contract can deploy a placeholder sidevm instance without upload the code via the blockchain and then upload the code via this RPC later.
message
pruntime_rpc.proto:656Sidevm code
bytes contract = 1
The target contract_id
bytes code = 2
The code
Calculate contract id with given deployment parameters
message
pruntime_rpc.proto:663string deployer = 1
string cluster_id = 2
string code_hash = 3
string salt = 4
message
pruntime_rpc.proto:670string id = 1
Get network configuration
message
pruntime_rpc.proto:546Network config
optional uint32 public_rpc_port = 1
The public rpc port with ACL enabled. This is the port serving contract queries.
optional config = 2
The current config set by The RPC ConfigNetwork. Nil if the ConfigNetwork hasn't been called.
rpc LoadChainState (, )
pruntime_rpc.proto:110Load given chain state into the pruntime
message
pruntime_rpc.proto:674uint32 block_number = 1
bytes encoded_state = 2
@codec scale crate::blocks::StorageState
rpc Stop (, )
pruntime_rpc.proto:113Stop and optionally remove checkpoints
message
pruntime_rpc.proto:680bool remove_checkpoints = 1
Remove checkpoints before stop
Partially load values into the pruntime's chain storage.
message
pruntime_rpc.proto:685repeated bytes proof = 1
rpc TakeCheckpoint (, )
pruntime_rpc.proto:119Take checkpoint. Returns the current block number of the saved state.
rpc Statistics (, )
pruntime_rpc.proto:122Get networks statistics for contracts
message
pruntime_rpc.proto:690Used to specify the contracts addresses for which statistics should be returned.
repeated string contracts = 1
A list of contract addresses that to be queried.
bool all = 2
Query for all contracts.
message
pruntime_rpc.proto:698The statistics that are returned by the RPC service.
uint64 uptime = 1
The number of seconds the worker has been running. The counters are reset to zero on each restart.
uint32 cores = 2
Number of serving cores available to the worker.
optional query = 3
Statistics for contract queries.
optional http_egress = 4
Statistics for HTTP egress made by ink contracts.
Generate a request to send to another worker in the same cluster to get the cluster state.
Save the current cluster state to filesystem
Load the cluster state from filesystem
Load the cluster state from filesystem
message
pruntime_rpc.proto:762uint32 major = 1
The major version of the pink runtime
uint32 minor = 2
The minor version of the pink runtime
message
pruntime_rpc.proto:335Used in: , ,
int32 version = 1
string provider = 2
optional payload = 3
Retired
bytes encoded_report = 5
uint64 timestamp = 4
message
pruntime_rpc.proto:344Retired
Used in:
string report = 1
bytes signature = 2
bytes signing_cert = 3
message
pruntime_rpc.proto:472Used in:
uint32 start_block = 1
uint64 start_time = 2
uint32 duration = 4
message
pruntime_rpc.proto:375Used in:
bytes encoded_body = 1
The body of the certificate @codec scale crate::crypto::CertificateBody
optional signature = 2
An optional signature of the body signed by a parent certificate. @boxed
message
pruntime_rpc.proto:638Information about a cluster
Used in:
string id = 1
The cluster id.
string runtime_version = 2
The version of the current contract execution engine
string state_root = 3
The state root of it's storage.
string system_contract = 5
The address of the system contract.
string logger_contract = 6
The address of the log server.
uint64 number_of_contracts = 7
Number of contracts deployed
string js_runtime = 8
The Js Runtime code hash
message
pruntime_rpc.proto:601Infomation about a contract
Used in:
string id = 1
The contract id
string code_hash = 2
The blake2 256 hash of the contract
uint32 weight = 3
The scheduling weight
optional sidevm = 4
Infomation about it's sidevm if exists
message
pruntime_rpc.proto:453Used as request type in: PhactoryAPI.DcapHandoverAcceptChallenge
Used as response type in: PhactoryAPI.DcapHandoverCreateChallenge
bytes encoded_challenge = 1
@codec scale phala_types::DcapHandoverChallenge<chain::BlockNumber>
message
pruntime_rpc.proto:458Used as request type in: PhactoryAPI.DcapHandoverStart
Used as response type in: PhactoryAPI.DcapHandoverAcceptChallenge
bytes encoded_challenge_handler = 1
@codec scale phala_types::DcapChallengeHandlerInfo<chain::BlockNumber>
bytes la_report = 2
The sgx local attestation report of the client
message
pruntime_rpc.proto:465Used as request type in: PhactoryAPI.DcapHandoverReceive
Used as response type in: PhactoryAPI.DcapHandoverStart
bytes encoded_worker_key = 1
@codec scale phala_types::EncryptedWorkerKey
bytes la_report = 2
The sgx local attestation report
Used in:
None = 0
Dummy = 1
Active = 2
message
pruntime_rpc.proto:217Used in: ,
GatekeeperRole role = 1
The Gatekeeper role of the worker.
string master_public_key = 2
The master public key, empty if not a Gatekeeper
message
pruntime_rpc.proto:500Used as response type in: PhactoryAPI.AddEndpoint, PhactoryAPI.GetEndpointInfo, PhactoryAPI.RefreshEndpointSigningTime, PhactoryAPI.SignEndpointInfo
optional bytes encoded_endpoint_payload = 1
@codec scale phala_types::WorkerEndpointPayload
optional bytes signature = 2
message
pruntime_rpc.proto:434Used as request type in: PhactoryAPI.HandoverAcceptChallenge
Used as response type in: PhactoryAPI.HandoverCreateChallenge
bytes encoded_challenge = 1
@codec scale phala_types::HandoverChallenge<chain::BlockNumber>
message
pruntime_rpc.proto:439Used as request type in: PhactoryAPI.HandoverStart
Used as response type in: PhactoryAPI.HandoverAcceptChallenge
bytes encoded_challenge_handler = 1
@codec scale phala_types::ChallengeHandlerInfo<chain::BlockNumber>
optional attestation = 2
The sgx attestation on the challenge handler hash
message
pruntime_rpc.proto:446Used as request type in: PhactoryAPI.HandoverReceive
Used as response type in: PhactoryAPI.HandoverStart
bytes encoded_worker_key = 1
@codec scale phala_types::EncryptedWorkerKey
optional attestation = 2
The sgx attestation on the encrypted worker key hash
message
pruntime_rpc.proto:737Counters for HTTP egress.
Used in:
uint64 requests = 1
The number of HTTP requests sent.
uint64 failures = 2
The number of failed HTTP requests.
map<uint32, uint64> by_status_code = 3
The number of HTTP requests for each status code.
message
pruntime_rpc.proto:729HTTP egress statistics for contracts.
Used in:
optional global = 1
Overall HTTP egress statistics.
map<string, > by_contract = 2
HTTP egress statistics for each contract.
message
pruntime_rpc.proto:561Used in: ,
string name = 1
string value = 2
message
pruntime_rpc.proto:320Used as response type in: PhactoryAPI.GetRuntimeInfo, PhactoryAPI.InitRuntime
bytes encoded_runtime_info = 1
@codec scale phala_types::WorkerRegistrationInfoV2<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 phala_types::WorkerPublicKey
bytes encoded_ecdh_public_key = 4
@codec scale phala_types::EcdhPublicKey
optional attestation = 5
The sgx attestation
message
pruntime_rpc.proto:224Used in:
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.
message
pruntime_rpc.proto:554Parameters for the RPC ConfigNetwork
Used as request type in: PhactoryAPI.ConfigNetwork
Used as field type in:
string all_proxy = 2
The SOCKS5 proxy for outbound tcp connections.
string i2p_proxy = 3
The SOCKS5 proxy for outbound tcp connections to a i2p address.
message
pruntime_rpc.proto:719Counters for queries.
Used in:
uint64 total = 1
Total number of queries.
uint64 dropped = 2
The number of dropped queries.
uint64 time = 3
The served time in milliseconds.
message
pruntime_rpc.proto:711Statistics for queries.
Used in:
optional global = 1
Overall query statistics.
map<string, > by_contract = 2
Statistics of query for each contract.
Used in:
NoEvent = 0
EnterUnresponsive = 1
ExitUnresponsive = 2
message
pruntime_rpc.proto:746Used as request type in: PhactoryAPI.SaveClusterState
Used as response type in: PhactoryAPI.GenerateClusterStateRequest
string receiver = 1
The pubkey for the worker to receive the state.
uint32 min_block_number = 2
The state must later than this block number.
string signature = 3
Signature to ensure the request is from the dest worker.
message
pruntime_rpc.proto:755Used as request type in: PhactoryAPI.LoadClusterState
Used as response type in: PhactoryAPI.SaveClusterState
uint32 block_number = 1
The block number of the saved state.
string filename = 2
The filename to download the state.
message
pruntime_rpc.proto:613Infomation about a sidevm
Used in:
string state = 1
Sidevm state. running/stopped
string code_hash = 2
The blake2 256 hash of the current running sidevm.
string start_time = 3
The start time of the instance.
string stop_reason = 4
The latest stop reason if stopped
uint32 max_memory_pages = 5
The max memory pages configuration
uint64 vital_capacity = 6
The vital_capacity configuration
uint32 deadline = 7
Run until the given block number
uint32 max_code_size = 8
The max code size configuration
message
pruntime_rpc.proto:366Used in: ,
optional 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:
Ed25519 = 0
Sr25519 = 1
Ecdsa = 2
Ed25519WrapBytes = 3
Sr25519WrapBytes = 4
EcdsaWrapBytes = 5
Eip712 = 6
EvmEcdsa = 7
EvmEcdsaWrapBytes = 8
message
pruntime_rpc.proto:238Response to SyncHeader & SyncParaHeader.
Used as response type in: PhactoryAPI.DispatchBlocks, PhactoryAPI.SyncHeader, PhactoryAPI.SyncParaHeader, PhactoryAPI.TakeCheckpoint
uint32 synced_to = 1
The final actual block number synced to.
message
pruntime_rpc.proto:192Basic information for the initialized runtime
Used in:
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.
optional gatekeeper = 4
Status of gatekeeper
uint64 number_of_clusters = 5
The number of clusters created
uint64 number_of_contracts = 6
The number of contracts deployed
uint32 max_supported_consensus_version = 7
The max supported consensus version used of this version of pRuntime
uint32 genesis_block = 8
The block that the pruntime loaded the genesis state from.
message
pruntime_rpc.proto:526Used in:
string v = 1
string v_init = 2
string v_deductible = 19
string share = 20
uint64 v_update_at = 4
uint32 v_update_block = 5
uint64 iteration_last = 6
uint64 challenge_time_last = 7
string p_bench = 8
string p_instant = 9
uint32 confidence_level = 10
optional stat = 21
next: 22
message
pruntime_rpc.proto:515Used in:
string last_payout = 1
uint32 last_payout_at_block = 2
string total_payout = 3
uint32 total_payout_count = 4
string last_slash = 5
uint32 last_slash_at_block = 6
string total_slash = 7
uint32 total_slash_count = 8
message
pruntime_rpc.proto:416Used in:
uint32 last_heartbeat_for_block = 1
uint32 last_heartbeat_at_block = 2
ResponsiveEvent last_gk_responsive_event = 3
uint32 last_gk_responsive_event_at_block = 4
message
pruntime_rpc.proto:478Used in:
uint32 session_id = 1
bool paused = 2
uint64 start_time = 3