Struct SubspaceRpc

pub struct SubspaceRpc<Block, Client, SO, AS>
where
    Block: BlockT,
    SO: SyncOracle + Send + Sync + Clone + 'static,
{ /* private fields */ }

Implements the SubspaceRpcApiServer trait for interacting with Subspace.

Implementations

impl<Block, Client, SO, AS> SubspaceRpc<Block, Client, SO, AS>

where Block: BlockT, Client: ProvideRuntimeApi<Block> + HeaderBackend<Block>, Client::Api: SubspaceApi<Block, PublicKey>, SO: SyncOracle + Send + Sync + Clone + 'static, AS: AuxStore + Send + Sync + 'static,

SubspaceRpc is used for notifying subscribers about arrival of new slots and for submission of solutions (or lack thereof).

Internally every time slot notifier emits information about new slot, notification is sent to every subscriber, after which RPC server waits for the same number of subspace_submitSolutionResponse requests with SolutionResponse in them or until timeout is exceeded. The first valid solution for a particular slot wins, others are ignored.

pub fn new(config: SubspaceRpcConfig<Client, SO, AS>) -> Result<Self, ApiError>

Creates a new instance of the SubspaceRpc handler.

Trait Implementations

impl<Block, Client, SO, AS> SubspaceRpcApiServer for SubspaceRpc<Block, Client, SO, AS>

where Block: BlockT, Client: ProvideRuntimeApi<Block> + HeaderBackend<Block> + BlockBackend<Block> + Send + Sync + 'static, Client::Api: ObjectsApi<Block>, SO: SyncOracle + Send + Sync + Clone + 'static, AS: AuxStore + Send + Sync + 'static,

fn get_farmer_app_info(&self) -> Result<FarmerAppInfo, Error>

Get metadata necessary for farmer operation

fn submit_solution_response( &self, ext: &Extensions, solution_response: SolutionResponse, ) -> Result<(), Error>

fn subscribe_slot_info( &self, pending: PendingSubscriptionSink, ext: &Extensions, )

Slot info subscription

fn subscribe_reward_signing( &self, pending: PendingSubscriptionSink, ext: &Extensions, )

Sign block subscription

fn submit_reward_signature( &self, ext: &Extensions, reward_signature: RewardSignatureResponse, ) -> Result<(), Error>

fn subscribe_archived_segment_header( &self, pending: PendingSubscriptionSink, ext: &Extensions, )

Archived segment header subscription

fn acknowledge_archived_segment_header<'life0, 'life1, 'async_trait>( &'life0 self, ext: &'life1 Extensions, segment_index: SegmentIndex, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

fn piece( &self, ext: &Extensions, requested_piece_index: PieceIndex, ) -> Result<Option<Piece>, Error>

fn segment_headers<'life0, 'async_trait>( &'life0 self, segment_indexes: Vec<SegmentIndex>, ) -> Pin<Box<dyn Future<Output = Result<Vec<Option<SegmentHeader>>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn last_segment_headers<'life0, 'async_trait>( &'life0 self, limit: u32, ) -> Pin<Box<dyn Future<Output = Result<Vec<Option<SegmentHeader>>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn subscribe_object_mappings( &self, pending: PendingSubscriptionSink, ext: &Extensions, )

DSN object mappings subscription

fn subscribe_filtered_object_mappings( &self, pending: PendingSubscriptionSink, ext: &Extensions, hashes: Vec<Blake3Hash>, )

Filtered DSN object mappings subscription

fn into_rpc(self) -> RpcModule<Self>

Collects all the methods and subscriptions defined in the trait and adds them into a single RpcModule.