Expand description
Wire protocol for the Polkadot app host-api.
Message = Struct { requestId: str, payload: Enum { …76+ variants… } }
Each payload variant is itself a versioned enum (currently only “v1” = tag 0). Inside the version wrapper, the actual data is method-specific.
Tag indices are determined by the insertion order of methods in the protocol definition, expanded as: request methods → _request, _response; subscription methods → _start, _stop, _interrupt, _receive.
Structs§
- Account
- An account returned by host_get_non_product_accounts.
Enums§
- Host
Request - Decoded incoming request from the app.
- Host
Response - Outgoing response to the app.
Constants§
- PROTOCOL_
VERSION - Protocol version (JAM_CODEC_PROTOCOL_ID).
- TAG_
ACCOUNT_ CREATE_ PROOF_ REQ - TAG_
ACCOUNT_ CREATE_ PROOF_ RESP - TAG_
ACCOUNT_ GET_ ALIAS_ REQ - TAG_
ACCOUNT_ GET_ ALIAS_ RESP - TAG_
ACCOUNT_ GET_ REQ - TAG_
ACCOUNT_ GET_ RESP - TAG_
ACCOUNT_ STATUS_ INTERRUPT - TAG_
ACCOUNT_ STATUS_ RECEIVE - TAG_
ACCOUNT_ STATUS_ START - TAG_
ACCOUNT_ STATUS_ STOP - TAG_
CHAIN_ HEAD_ BODY_ REQ - TAG_
CHAIN_ HEAD_ BODY_ RESP - TAG_
CHAIN_ HEAD_ CALL_ REQ - TAG_
CHAIN_ HEAD_ CALL_ RESP - TAG_
CHAIN_ HEAD_ CONTINUE_ REQ - TAG_
CHAIN_ HEAD_ CONTINUE_ RESP - TAG_
CHAIN_ HEAD_ FOLLOW_ INTERRUPT - TAG_
CHAIN_ HEAD_ FOLLOW_ RECEIVE - TAG_
CHAIN_ HEAD_ FOLLOW_ START - TAG_
CHAIN_ HEAD_ FOLLOW_ STOP - TAG_
CHAIN_ HEAD_ HEADER_ REQ - TAG_
CHAIN_ HEAD_ HEADER_ RESP - TAG_
CHAIN_ HEAD_ STOP_ OP_ REQ - TAG_
CHAIN_ HEAD_ STOP_ OP_ RESP - TAG_
CHAIN_ HEAD_ STORAGE_ REQ - TAG_
CHAIN_ HEAD_ STORAGE_ RESP - TAG_
CHAIN_ HEAD_ UNPIN_ REQ - TAG_
CHAIN_ HEAD_ UNPIN_ RESP - TAG_
CHAIN_ SPEC_ GENESIS_ REQ - TAG_
CHAIN_ SPEC_ GENESIS_ RESP - TAG_
CHAIN_ SPEC_ NAME_ REQ - TAG_
CHAIN_ SPEC_ NAME_ RESP - TAG_
CHAIN_ SPEC_ PROPS_ REQ - TAG_
CHAIN_ SPEC_ PROPS_ RESP - TAG_
CHAIN_ TX_ BROADCAST_ REQ - TAG_
CHAIN_ TX_ BROADCAST_ RESP - TAG_
CHAIN_ TX_ STOP_ REQ - TAG_
CHAIN_ TX_ STOP_ RESP - TAG_
CHAT_ ACTION_ INTERRUPT - TAG_
CHAT_ ACTION_ RECEIVE - TAG_
CHAT_ ACTION_ START - TAG_
CHAT_ ACTION_ STOP - TAG_
CHAT_ CREATE_ ROOM_ REQ - TAG_
CHAT_ CREATE_ ROOM_ RESP - TAG_
CHAT_ CUSTOM_ MSG_ INTERRUPT - TAG_
CHAT_ CUSTOM_ MSG_ RECEIVE - TAG_
CHAT_ CUSTOM_ MSG_ START - TAG_
CHAT_ CUSTOM_ MSG_ STOP - TAG_
CHAT_ LIST_ INTERRUPT - TAG_
CHAT_ LIST_ RECEIVE - TAG_
CHAT_ LIST_ START - TAG_
CHAT_ LIST_ STOP - TAG_
CHAT_ POST_ MSG_ REQ - TAG_
CHAT_ POST_ MSG_ RESP - TAG_
CHAT_ REGISTER_ BOT_ REQ - TAG_
CHAT_ REGISTER_ BOT_ RESP - TAG_
CREATE_ TRANSACTION_ REQ - TAG_
CREATE_ TRANSACTION_ RESP - TAG_
CREATE_ TX_ NON_ PRODUCT_ REQ - TAG_
CREATE_ TX_ NON_ PRODUCT_ RESP - TAG_
DEVICE_ PERMISSION_ REQ - TAG_
DEVICE_ PERMISSION_ RESP - TAG_
FEATURE_ SUPPORTED_ REQ - TAG_
FEATURE_ SUPPORTED_ RESP - TAG_
GET_ NON_ PRODUCT_ ACCOUNTS_ REQ - TAG_
GET_ NON_ PRODUCT_ ACCOUNTS_ RESP - TAG_
HANDSHAKE_ REQ - TAG_
HANDSHAKE_ RESP - TAG_
JSONRPC_ SEND_ REQ - TAG_
JSONRPC_ SEND_ RESP - TAG_
JSONRPC_ SUB_ INTERRUPT - TAG_
JSONRPC_ SUB_ RECEIVE - TAG_
JSONRPC_ SUB_ START - TAG_
JSONRPC_ SUB_ STOP - TAG_
LOCAL_ STORAGE_ CLEAR_ REQ - TAG_
LOCAL_ STORAGE_ CLEAR_ RESP - TAG_
LOCAL_ STORAGE_ READ_ REQ - TAG_
LOCAL_ STORAGE_ READ_ RESP - TAG_
LOCAL_ STORAGE_ WRITE_ REQ - TAG_
LOCAL_ STORAGE_ WRITE_ RESP - TAG_
NAVIGATE_ TO_ REQ - TAG_
NAVIGATE_ TO_ RESP - TAG_
PREIMAGE_ LOOKUP_ INTERRUPT - TAG_
PREIMAGE_ LOOKUP_ RECEIVE - TAG_
PREIMAGE_ LOOKUP_ START - TAG_
PREIMAGE_ LOOKUP_ STOP - TAG_
PREIMAGE_ SUBMIT_ REQ - TAG_
PREIMAGE_ SUBMIT_ RESP - TAG_
PUSH_ NOTIFICATION_ REQ - TAG_
PUSH_ NOTIFICATION_ RESP - TAG_
REMOTE_ PERMISSION_ REQ - TAG_
REMOTE_ PERMISSION_ RESP - TAG_
SIGN_ PAYLOAD_ REQ - TAG_
SIGN_ PAYLOAD_ RESP - TAG_
SIGN_ RAW_ REQ - TAG_
SIGN_ RAW_ RESP - TAG_
STATEMENT_ PROOF_ REQ - TAG_
STATEMENT_ PROOF_ RESP - TAG_
STATEMENT_ STORE_ INTERRUPT - TAG_
STATEMENT_ STORE_ RECEIVE - TAG_
STATEMENT_ STORE_ START - TAG_
STATEMENT_ STORE_ STOP - TAG_
STATEMENT_ SUBMIT_ REQ - TAG_
STATEMENT_ SUBMIT_ RESP
Functions§
- decode_
message - Decode a raw binary message into (request_id, HostRequest).
- encode_
account_ status - Encode an account_connection_status_receive message.
- encode_
feature_ response - Encode a feature_supported response (Result::Ok(bool)).
- encode_
jsonrpc_ send_ error - Encode a
host_jsonrpc_senderror response. - encode_
jsonrpc_ send_ response - Encode a
host_jsonrpc_sendresponse. - encode_
jsonrpc_ sub_ receive - Encode a
host_jsonrpc_subscribereceive message. - encode_
navigate_ response - Encode a navigate_to response (Result::Ok(void)).
- encode_
response - Encode a response into a wire message.
- encode_
sign_ error - Encode a sign_payload or sign_raw error response (user rejected, wallet locked, etc).
- encode_
sign_ response - Encode a sign_payload or sign_raw success response. Result::Ok { id: u32, signature: Bytes }
- encode_
storage_ read_ response - Encode a local_storage_read response.
- encode_
storage_ write_ response - Encode a local_storage_write/clear response (Result::Ok(void)).