Skip to main content

Module protocol

Module protocol 

Source
Expand description

IPC Protocol Types

Re-export from blvm-node.

Defines the message types and serialization for IPC communication between modules and the base node.

Structs§

CliArgSpec
CLI argument spec
CliSpec
CLI spec for module commands (JSON-serializable structure)
CliSubcommandSpec
CLI subcommand spec
EventMessage
Event message from node to subscribed modules
ExternalFeeTableWire
One pushed table. The session supplies the module id.
FeeEstimatorRegistrationWire
Accepted names and the typed rejection for each refused name.
FeeEstimatorSpecWire
One name a module wants to publish quotes under.
FeeNameRejectionWire
A name the node refused.
FeeQuoteWire
One native quote on the wire.
FileMetadata
File metadata for filesystem operations
InvocationMessage
Invocation from node to module (CLI or RPC dispatch)
InvocationResultMessage
Invocation result from module to node
LogMessage
Log message from module to node
NativeFeeTableWire
Native fee table for the requested targets. Missing quotes are None.
RequestMessage
Request message from module to node
ResponseMessage
Response message from node to module
TimerFire
TimerId
16 random bytes. Displayed as 32 lowercase hex characters.
TimerInfo
TimerSpec

Enums§

CreateMode
EventPayload
Event payload types
InvocationResultPayload
InvocationType
LogLevel
Log level for module logging
MessageType
Message type classification
ModuleMessage
Main IPC message wrapper
RequestPayload
Request payload types
ResponsePayload
Response payload types
TimerAck
What a module returns for one fire.
TimerState
TimerTarget

Type Aliases§

CorrelationId
Correlation ID for matching requests with responses