Skip to main content

Module types

Module types 

Source
Expand description

Canonical Hashtree mesh wire types. The non-WebRTC build re-exports the same codec instead of maintaining a second framing implementation.

Structs§

DataChunk
Quoted data chunk delivered after payment negotiation.
DataPayment
Payment message body for chunk-by-chunk settlement.
DataPaymentAck
Payment acknowledgement for quoted chunk settlement.
DataQuoteRequest
Quote request message body
DataQuoteResponse
Quote response message body
DataRequest
Data request message body
DataResponse
Data response message body
PeerHints
Private signaling hints exchanged over an established peer link.
PubsubFrame
Pubsub data frame delivered over mesh peer links.
PubsubInterest
Pubsub interest advertisement.
PubsubInventory
Pubsub inventory announcement for inventory-first delivery.
PubsubWant
Pubsub want request for inventory-first delivery.

Enums§

DataMessage
Parsed data message

Constants§

MAX_HTL
Default HTL (Hops To Live) budget for mesh blob retrieval.

Functions§

encode_chunk
Encode a quoted data chunk to wire format.
encode_payment
Encode a payment message to wire format.
encode_payment_ack
Encode a payment acknowledgement to wire format.
encode_peer_hints
Encode private peer hints to wire format.
encode_pubsub_frame
Encode a pubsub data frame to wire format.
encode_pubsub_interest
Encode a pubsub interest to wire format.
encode_pubsub_inventory
Encode a pubsub inventory announcement to wire format.
encode_pubsub_want
Encode a pubsub want request to wire format.
encode_quote_request
Encode a quote request message to wire format.
encode_quote_response
Encode a quote response message to wire format.
encode_request
Encode a request message to wire format Uses named/map encoding for compatibility with hashtree-ts and to support optional fields
encode_response
Encode a response message to wire format Uses named/map encoding for compatibility with hashtree-ts and to support optional fields
parse_message
Parse a wire format message