Enum RequestPayload 

pub enum RequestPayload {
    Handshake {
        module_id: String,
        module_name: String,
        version: String,
    },
    GetBlock {
        hash: [u8; 32],
    },
    GetBlockHeader {
        hash: [u8; 32],
    },
    GetTransaction {
        hash: [u8; 32],
    },
    HasTransaction {
        hash: [u8; 32],
    },
    GetChainTip,
    GetBlockHeight,
    GetUtxo {
        outpoint: OutPoint,
    },
    SubscribeEvents {
        event_types: Vec<EventType>,
    },
    GetMempoolTransactions,
    GetMempoolTransaction {
        tx_hash: [u8; 32],
    },
    GetMempoolSize,
    GetNetworkStats,
    GetNetworkPeers,
    GetChainInfo,
    GetBlockByHeight {
        height: u64,
    },
    GetBlockAndWitnesses {
        hash: [u8; 32],
    },
    GetLightningNodeUrl,
    GetLightningInfo,
    GetPaymentState {
        payment_id: String,
    },
    CheckTransactionInMempool {
        tx_hash: [u8; 32],
    },
    GetFeeEstimate {
        target_blocks: u32,
    },
    ReadFile {
        path: String,
    },
    WriteFile {
        path: String,
        data: Vec<u8>,
    },
    DeleteFile {
        path: String,
    },
    ListDirectory {
        path: String,
    },
    CreateDirectory {
        path: String,
    },
    GetFileMetadata {
        path: String,
    },
    RegisterRpcEndpoint {
        method: String,
        description: String,
    },
    UnregisterRpcEndpoint {
        method: String,
    },
    RegisterCoreRpcOverride {
        method: String,
        description: String,
    },
    UnregisterCoreRpcOverride {
        method: String,
    },
    RegisterTimer {
        interval_seconds: u64,
    },
    CancelTimer {
        timer_id: u64,
    },
    ScheduleTask {
        delay_seconds: u64,
    },
    ReportMetric {
        metric: Metric,
    },
    GetModuleMetrics {
        module_id: String,
    },
    GetAllMetrics,
    DiscoverModules,
    GetModuleInfo {
        module_id: String,
    },
    IsModuleAvailable {
        module_id: String,
    },
    PublishEvent {
        event_type: EventType,
        payload: EventPayload,
    },
    CallModule {
        target_module_id: Option<String>,
        method: String,
        params: Vec<u8>,
    },
    RegisterModuleApi {
        methods: Vec<String>,
        api_version: u32,
    },
    UnregisterModuleApi,
    GetModuleHealth {
        module_id: String,
    },
    GetAllModuleHealth,
    ReportModuleHealth {
        health: ModuleHealth,
    },
    SendMeshPacketToPeer {
        peer_addr: String,
        packet_data: Vec<u8>,
    },
    SendStratumV2MessageToPeer {
        peer_addr: String,
        message_data: Vec<u8>,
    },
    GetBlockTemplate {
        rules: Vec<String>,
        coinbase_script: Option<Vec<u8>>,
        coinbase_address: Option<String>,
    },
    SubmitBlock {
        block: Block,
    },
    QueueReceivedBlock {
        block_bytes: Vec<u8>,
    },
    MergeBlockServeDenylist {
        block_hashes: Vec<[u8; 32]>,
    },
    GetBlockServeDenylistSnapshot,
    ClearBlockServeDenylist,
    ReplaceBlockServeDenylist {
        block_hashes: Vec<[u8; 32]>,
    },
    MergeTxServeDenylist {
        tx_hashes: Vec<[u8; 32]>,
    },
    GetTxServeDenylistSnapshot,
    ClearTxServeDenylist,
    ReplaceTxServeDenylist {
        tx_hashes: Vec<[u8; 32]>,
    },
    GetSyncStatus,
    BanPeer {
        peer_addr: String,
        ban_duration_seconds: Option<u64>,
    },
    SetBlockServeMaintenanceMode {
        enabled: bool,
    },
    RegisterCliSpec {
        spec: CliSpec,
    },
    GetBlockTemplateWithOutputs {
        rules: Vec<String>,
        coinbase_script: Option<Vec<u8>>,
        coinbase_outputs: Vec<(i64, Vec<u8>)>,
    },
    GetBlockTemplateDeclared {
        rules: Vec<String>,
        coinbase_script: Option<Vec<u8>>,
        coinbase_outputs: Vec<(i64, Vec<u8>)>,
        declared_txids: Vec<[u8; 32]>,
    },
    SubmitMempoolTransaction {
        tx: Transaction,
        witnesses: Option<Vec<Vec<Vec<u8>>>>,
    },
    GetTxMetadata {
        txid: [u8; 32],
    },
    GetMempoolFeeRateSummary,
    SetAdvertisedServiceBits {
        bits: u64,
    },
    TimerCreate {
        spec: TimerSpec,
        mode: CreateMode,
    },
    TimerCancel {
        target: TimerTarget,
    },
    TimerPause {
        target: TimerTarget,
    },
    TimerResume {
        target: TimerTarget,
    },
    TimerTrigger {
        target: TimerTarget,
    },
    TimerGet {
        target: TimerTarget,
    },
    TimerList,
    HandshakeV2 {
        module_id: String,
        module_name: String,
        version: String,
        ipc_protocol: u32,
    },
    SubscribeModuleEventNames {
        names: Vec<String>,
    },
    HttpRequest {
        url: String,
        accept: Option<String>,
        timeout_ms: u32,
    },
    StreamSend {
        conn_id: u64,
        bytes: Vec<u8>,
    },
    StreamClose {
        conn_id: u64,
    },
    RegisterFeeEstimators {
        specs: Vec<FeeEstimatorSpecWire>,
    },
    SubmitFeeTable {
        table: ExternalFeeTableWire,
    },
    GetFeeTable {
        view: String,
        mode: String,
        targets: Vec<u32>,
    },
    HttpPost {
        url: String,
        content_type: String,
        body: Vec<u8>,
        timeout_ms: u32,
        authorization: Option<String>,
    },
}

Request payload types

Variants

Handshake

Handshake: Module identifies itself (first message)

Fields

module_id: String

module_name: String

version: String

GetBlock

Fields

hash: [u8; 32]

GetBlockHeader

Fields

hash: [u8; 32]

GetTransaction

Fields

hash: [u8; 32]

HasTransaction

Fields

hash: [u8; 32]

GetChainTip

GetBlockHeight

GetUtxo

Fields

outpoint: OutPoint

SubscribeEvents

Fields

event_types: Vec<EventType>

GetMempoolTransactions

GetMempoolTransaction

Fields

tx_hash: [u8; 32]

GetMempoolSize

GetNetworkStats

GetNetworkPeers

GetChainInfo

GetBlockByHeight

Fields

height: u64

GetBlockAndWitnesses

Fields

hash: [u8; 32]

GetLightningNodeUrl

GetLightningInfo

GetPaymentState

Fields

payment_id: String

CheckTransactionInMempool

Fields

tx_hash: [u8; 32]

GetFeeEstimate

Fields

target_blocks: u32

ReadFile

Fields

path: String

WriteFile

Fields

path: String

data: Vec<u8>

DeleteFile

Fields

path: String

ListDirectory

Fields

path: String

CreateDirectory

Fields

path: String

GetFileMetadata

Fields

path: String

RegisterRpcEndpoint

Fields

method: String

description: String

UnregisterRpcEndpoint

Fields

method: String

RegisterCoreRpcOverride

Fields

method: String

description: String

UnregisterCoreRpcOverride

Fields

method: String

RegisterTimer

Fields

interval_seconds: u64

CancelTimer

Fields

timer_id: u64

ScheduleTask

Fields

delay_seconds: u64

ReportMetric

Fields

metric: Metric

GetModuleMetrics

Fields

module_id: String

GetAllMetrics

DiscoverModules

GetModuleInfo

Fields

module_id: String

IsModuleAvailable

Fields

module_id: String

PublishEvent

Fields

event_type: EventType

payload: EventPayload

CallModule

Fields

target_module_id: Option<String>

method: String

params: Vec<u8>

RegisterModuleApi

Fields

methods: Vec<String>

api_version: u32

UnregisterModuleApi

GetModuleHealth

Fields

module_id: String

GetAllModuleHealth

ReportModuleHealth

Fields

health: ModuleHealth

SendMeshPacketToPeer

Fields

peer_addr: String

packet_data: Vec<u8>

SendStratumV2MessageToPeer

See MessageType::SendStratumV2MessageToPeer.

Fields

peer_addr: String

message_data: Vec<u8>

GetBlockTemplate

Fields

rules: Vec<String>

coinbase_script: Option<Vec<u8>>

coinbase_address: Option<String>

SubmitBlock

Fields

block: Block

QueueReceivedBlock

Serialized block (same encoding as BlockReceived: bincode of Block).

Fields

block_bytes: Vec<u8>

MergeBlockServeDenylist

Block hashes that must not be answered with a full block on the wire (e.g. getdata).

Fields

block_hashes: Vec<[u8; 32]>

GetBlockServeDenylistSnapshot

ClearBlockServeDenylist

ReplaceBlockServeDenylist

Fields

block_hashes: Vec<[u8; 32]>

MergeTxServeDenylist

Fields

tx_hashes: Vec<[u8; 32]>

GetTxServeDenylistSnapshot

ClearTxServeDenylist

ReplaceTxServeDenylist

Fields

tx_hashes: Vec<[u8; 32]>

GetSyncStatus

BanPeer

Fields

peer_addr: String

ban_duration_seconds: Option<u64>

SetBlockServeMaintenanceMode

Fields

enabled: bool

RegisterCliSpec

Register CLI spec (module → node on connect)

Fields

spec: CliSpec

GetBlockTemplateWithOutputs

Fields

rules: Vec<String>

coinbase_script: Option<Vec<u8>>

coinbase_outputs: Vec<(i64, Vec<u8>)>

GetBlockTemplateDeclared

Stage 3b: named mempool txids in order. Empty list is coinbase-only.

Fields

rules: Vec<String>

coinbase_script: Option<Vec<u8>>

coinbase_outputs: Vec<(i64, Vec<u8>)>

declared_txids: Vec<[u8; 32]>

SubmitMempoolTransaction

Parsed Bitcoin tx + optional witness stacks. Already-in-mempool is ok.

Fields

tx: Transaction

witnesses: Option<Vec<Vec<Vec<u8>>>>

GetTxMetadata

Fields

txid: [u8; 32]

GetMempoolFeeRateSummary

SetAdvertisedServiceBits

bits must be NODE_FIBRE (1 << 26). The node keys the bit by the calling module.

Fields

bits: u64

TimerCreate

Fields

spec: TimerSpec

mode: CreateMode

TimerCancel

Fields

target: TimerTarget

TimerPause

Fields

target: TimerTarget

TimerResume

Fields

target: TimerTarget

TimerTrigger

Fields

target: TimerTarget

TimerGet

Fields

target: TimerTarget

TimerList

HandshakeV2

Same as RequestPayload::Handshake, plus the IPC layout version.

Fields

module_id: String

module_name: String

version: String

ipc_protocol: u32

SubscribeModuleEventNames

Names a subscriber wants for EventType::ModuleEvent. An empty list clears the filter.

Fields

names: Vec<String>

HttpRequest

GET only. The node enforces the operator allow-list.

Fields

url: String

accept: Option<String>

timeout_ms: u32

StreamSend

Bytes from the module onto a hosted stream connection.

Fields

conn_id: u64

bytes: Vec<u8>

StreamClose

The module closes a hosted stream connection.

Fields

conn_id: u64

RegisterFeeEstimators

Replace this module’s estimator names. module_id comes from the session.

Fields

specs: Vec<FeeEstimatorSpecWire>

SubmitFeeTable

Push one table. module_id comes from the session.

Fields

table: ExternalFeeTableWire

GetFeeTable

Native columns only. view is combined, history, or mempool.

Fields

view: String

mode: String

targets: Vec<u32>

HttpPost

POST a body. The node enforces the same origin allow-list as HttpRequest.

Fields

url: String

content_type: String

body: Vec<u8>

timeout_ms: u32

authorization: Option<String>

Authorization header value. Not logged.

Trait Implementations

impl Clone for RequestPayload

fn clone(&self) -> RequestPayload

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RequestPayload

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RequestPayload

fn deserialize<__D>( __deserializer: __D, ) -> Result<RequestPayload, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RequestPayload

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.