Skip to main content

RequestPayload

Enum RequestPayload 

Source
pub enum RequestPayload {
Show 63 variants 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, }, 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, }, 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, },
}
Expand description

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
§

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
§

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

§

SendMeshPacketToPeer

Fields

§peer_addr: String
§packet_data: Vec<u8>
§

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
§

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

Trait Implementations§

Source§

impl Clone for RequestPayload

Source§

fn clone(&self) -> RequestPayload

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RequestPayload

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for RequestPayload

Source§

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. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,