-
Notifications
You must be signed in to change notification settings - Fork 246
/
lib.rs
963 lines (838 loc) · 37.5 KB
/
lib.rs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
// Copyright (C) 2020-2021 Parity Technologies (UK) Ltd.
// Copyright (C) 2021 Subspace Labs, Inc.
// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.
//! RPC api for Subspace.
#![feature(try_blocks)]
use futures::channel::mpsc;
use futures::{future, stream, FutureExt, StreamExt};
use jsonrpsee::core::async_trait;
use jsonrpsee::proc_macros::rpc;
use jsonrpsee::types::{ErrorObject, ErrorObjectOwned};
use jsonrpsee::{Extensions, PendingSubscriptionSink};
use parking_lot::Mutex;
use sc_client_api::{AuxStore, BlockBackend};
use sc_consensus_subspace::archiver::{
recreate_genesis_segment, ArchivedSegmentNotification, ObjectMappingNotification,
SegmentHeadersStore,
};
use sc_consensus_subspace::notification::SubspaceNotificationStream;
use sc_consensus_subspace::slot_worker::{
NewSlotNotification, RewardSigningNotification, SubspaceSyncOracle,
};
use sc_rpc::utils::{BoundedVecDeque, PendingSubscription};
use sc_rpc::SubscriptionTaskExecutor;
use sc_rpc_api::{check_if_safe, UnsafeRpcError};
use sc_utils::mpsc::TracingUnboundedSender;
use schnellru::{ByLength, LruMap};
use sp_api::{ApiError, ProvideRuntimeApi};
use sp_blockchain::HeaderBackend;
use sp_consensus::SyncOracle;
use sp_consensus_subspace::{ChainConstants, SubspaceApi};
use sp_core::H256;
use sp_objects::ObjectsApi;
use sp_runtime::traits::Block as BlockT;
use std::collections::hash_map::Entry;
use std::collections::{HashMap, HashSet};
use std::marker::PhantomData;
use std::sync::atomic::{AtomicU64, Ordering};
use std::sync::{Arc, Weak};
use std::time::Duration;
use subspace_archiving::archiver::NewArchivedSegment;
use subspace_core_primitives::hashes::Blake3Hash;
use subspace_core_primitives::objects::GlobalObjectMapping;
use subspace_core_primitives::pieces::{Piece, PieceIndex};
use subspace_core_primitives::segments::{HistorySize, SegmentHeader, SegmentIndex};
use subspace_core_primitives::solutions::Solution;
use subspace_core_primitives::{BlockHash, BlockNumber, PublicKey, SlotNumber};
use subspace_erasure_coding::ErasureCoding;
use subspace_farmer_components::FarmerProtocolInfo;
use subspace_kzg::Kzg;
use subspace_networking::libp2p::Multiaddr;
use subspace_rpc_primitives::{
FarmerAppInfo, RewardSignatureResponse, RewardSigningInfo, SlotInfo, SolutionResponse,
MAX_SEGMENT_HEADERS_PER_REQUEST,
};
use tracing::{debug, error, warn};
const SUBSPACE_ERROR: i32 = 9000;
/// This is essentially equal to expected number of votes per block, one more is added implicitly by
/// the fact that channel sender exists
const SOLUTION_SENDER_CHANNEL_CAPACITY: usize = 9;
const REWARD_SIGNING_TIMEOUT: Duration = Duration::from_millis(500);
/// The number of object mappings to include in each subscription response message.
///
/// This is a tradeoff between `RPC_DEFAULT_MESSAGE_CAPACITY_PER_CONN` and
/// `RPC_DEFAULT_MAX_RESPONSE_SIZE_MB`. We estimate 500K mappings per segment,
/// and the minimum hex-encoded mapping size is 88 bytes.
// TODO: make this into a CLI option, or calculate this from other CLI options
const OBJECT_MAPPING_BATCH_SIZE: usize = 1000;
/// The maximum number of object hashes allowed in a subscription filter.
///
/// Each hash takes up 64 bytes in JSON, and 32 bytes in memory.
// TODO: make this into a CLI option, or calculate this from other CLI options
const MAX_OBJECT_HASHES_PER_SUBSCRIPTION: usize = 1000;
// TODO: More specific errors instead of `StringError`
/// Top-level error type for the RPC handler.
#[derive(Debug, thiserror::Error)]
pub enum Error {
/// Errors that can be formatted as a String
#[error("{0}")]
StringError(String),
/// Call to an unsafe RPC was denied.
#[error(transparent)]
UnsafeRpcCalled(#[from] UnsafeRpcError),
}
impl From<Error> for ErrorObjectOwned {
fn from(error: Error) -> Self {
match error {
Error::StringError(e) => ErrorObject::owned(SUBSPACE_ERROR + 1, e, None::<()>),
Error::UnsafeRpcCalled(e) => e.into(),
}
}
}
/// Provides rpc methods for interacting with Subspace.
#[rpc(client, server)]
pub trait SubspaceRpcApi {
/// Get metadata necessary for farmer operation
#[method(name = "subspace_getFarmerAppInfo")]
fn get_farmer_app_info(&self) -> Result<FarmerAppInfo, Error>;
#[method(name = "subspace_submitSolutionResponse", with_extensions)]
fn submit_solution_response(&self, solution_response: SolutionResponse) -> Result<(), Error>;
/// Slot info subscription
#[subscription(
name = "subspace_subscribeSlotInfo" => "subspace_slot_info",
unsubscribe = "subspace_unsubscribeSlotInfo",
item = SlotInfo,
with_extensions,
)]
fn subscribe_slot_info(&self);
/// Sign block subscription
#[subscription(
name = "subspace_subscribeRewardSigning" => "subspace_reward_signing",
unsubscribe = "subspace_unsubscribeRewardSigning",
item = RewardSigningInfo,
with_extensions,
)]
fn subscribe_reward_signing(&self);
#[method(name = "subspace_submitRewardSignature", with_extensions)]
fn submit_reward_signature(
&self,
reward_signature: RewardSignatureResponse,
) -> Result<(), Error>;
/// Archived segment header subscription
#[subscription(
name = "subspace_subscribeArchivedSegmentHeader" => "subspace_archived_segment_header",
unsubscribe = "subspace_unsubscribeArchivedSegmentHeader",
item = SegmentHeader,
with_extensions,
)]
fn subscribe_archived_segment_header(&self);
#[method(name = "subspace_segmentHeaders")]
async fn segment_headers(
&self,
segment_indexes: Vec<SegmentIndex>,
) -> Result<Vec<Option<SegmentHeader>>, Error>;
#[method(name = "subspace_piece", blocking, with_extensions)]
fn piece(&self, piece_index: PieceIndex) -> Result<Option<Piece>, Error>;
#[method(name = "subspace_acknowledgeArchivedSegmentHeader", with_extensions)]
async fn acknowledge_archived_segment_header(
&self,
segment_index: SegmentIndex,
) -> Result<(), Error>;
#[method(name = "subspace_lastSegmentHeaders")]
async fn last_segment_headers(&self, limit: u32) -> Result<Vec<Option<SegmentHeader>>, Error>;
/// DSN object mappings subscription
#[subscription(
name = "subspace_subscribeObjectMappings" => "subspace_object_mappings",
unsubscribe = "subspace_unsubscribeObjectMappings",
item = ObjectMappingResponse,
with_extensions,
)]
fn subscribe_object_mappings(&self);
/// Filtered DSN object mappings subscription
#[subscription(
name = "subspace_subscribeFilteredObjectMappings" => "subspace_filtered_object_mappings",
unsubscribe = "subspace_unsubscribeFilteredObjectMappings",
item = ObjectMappingResponse,
with_extensions,
)]
fn subscribe_filtered_object_mappings(&self, hashes: Vec<Blake3Hash>);
}
#[derive(Default)]
struct ArchivedSegmentHeaderAcknowledgementSenders {
segment_index: SegmentIndex,
senders: HashMap<u64, TracingUnboundedSender<()>>,
}
#[derive(Default)]
struct BlockSignatureSenders {
current_hash: H256,
senders: Vec<async_oneshot::Sender<RewardSignatureResponse>>,
}
/// In-memory cache of last archived segment, such that when request comes back right after
/// archived segment notification, RPC server is able to answer quickly.
///
/// We store weak reference, such that archived segment is not persisted for longer than
/// necessary occupying RAM.
enum CachedArchivedSegment {
/// Special case for genesis segment when requested over RPC
Genesis(Arc<NewArchivedSegment>),
Weak(Weak<NewArchivedSegment>),
}
impl CachedArchivedSegment {
fn get(&self) -> Option<Arc<NewArchivedSegment>> {
match self {
CachedArchivedSegment::Genesis(archived_segment) => Some(Arc::clone(archived_segment)),
CachedArchivedSegment::Weak(weak_archived_segment) => weak_archived_segment.upgrade(),
}
}
}
/// Response to object mapping subscription, including a block height.
/// Large responses are batched, so the block height can be repeated in different responses.
#[derive(Debug, Clone, PartialEq, Eq, Ord, PartialOrd, serde::Serialize, serde::Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ObjectMappingResponse {
/// The block number that the object mapping is from.
pub block_number: BlockNumber,
/// The object mappings.
#[serde(flatten)]
pub objects: GlobalObjectMapping,
}
/// Subspace RPC configuration
pub struct SubspaceRpcConfig<Client, SO, AS>
where
SO: SyncOracle + Send + Sync + Clone + 'static,
AS: AuxStore + Send + Sync + 'static,
{
/// Substrate client
pub client: Arc<Client>,
/// Task executor that is being used by RPC subscriptions
pub subscription_executor: SubscriptionTaskExecutor,
/// New slot notification stream
pub new_slot_notification_stream: SubspaceNotificationStream<NewSlotNotification>,
/// Reward signing notification stream
pub reward_signing_notification_stream: SubspaceNotificationStream<RewardSigningNotification>,
/// Archived mapping notification stream
pub object_mapping_notification_stream: SubspaceNotificationStream<ObjectMappingNotification>,
/// Archived segment notification stream
pub archived_segment_notification_stream:
SubspaceNotificationStream<ArchivedSegmentNotification>,
/// DSN bootstrap nodes
pub dsn_bootstrap_nodes: Vec<Multiaddr>,
/// Segment headers store
pub segment_headers_store: SegmentHeadersStore<AS>,
/// Subspace sync oracle
pub sync_oracle: SubspaceSyncOracle<SO>,
/// Kzg instance
pub kzg: Kzg,
/// Erasure coding instance
pub erasure_coding: ErasureCoding,
}
/// Implements the [`SubspaceRpcApiServer`] trait for interacting with Subspace.
pub struct SubspaceRpc<Block, Client, SO, AS>
where
Block: BlockT,
SO: SyncOracle + Send + Sync + Clone + 'static,
{
client: Arc<Client>,
subscription_executor: SubscriptionTaskExecutor,
new_slot_notification_stream: SubspaceNotificationStream<NewSlotNotification>,
reward_signing_notification_stream: SubspaceNotificationStream<RewardSigningNotification>,
object_mapping_notification_stream: SubspaceNotificationStream<ObjectMappingNotification>,
archived_segment_notification_stream: SubspaceNotificationStream<ArchivedSegmentNotification>,
#[allow(clippy::type_complexity)]
solution_response_senders: Arc<Mutex<LruMap<SlotNumber, mpsc::Sender<Solution<PublicKey>>>>>,
reward_signature_senders: Arc<Mutex<BlockSignatureSenders>>,
dsn_bootstrap_nodes: Vec<Multiaddr>,
segment_headers_store: SegmentHeadersStore<AS>,
cached_archived_segment: Arc<Mutex<Option<CachedArchivedSegment>>>,
archived_segment_acknowledgement_senders:
Arc<Mutex<ArchivedSegmentHeaderAcknowledgementSenders>>,
next_subscription_id: AtomicU64,
sync_oracle: SubspaceSyncOracle<SO>,
genesis_hash: BlockHash,
chain_constants: ChainConstants,
max_pieces_in_sector: u16,
kzg: Kzg,
erasure_coding: ErasureCoding,
_block: PhantomData<Block>,
}
/// [`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.
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,
{
/// Creates a new instance of the `SubspaceRpc` handler.
pub fn new(config: SubspaceRpcConfig<Client, SO, AS>) -> Result<Self, ApiError> {
let info = config.client.info();
let best_hash = info.best_hash;
let genesis_hash = BlockHash::try_from(info.genesis_hash.as_ref())
.expect("Genesis hash must always be convertable into BlockHash; qed");
let runtime_api = config.client.runtime_api();
let chain_constants = runtime_api.chain_constants(best_hash)?;
// While the number can technically change in runtime, farmer will not adjust to it on the
// fly and previous value will remain valid (number only expected to increase), so it is
// fine to query it only once
let max_pieces_in_sector = runtime_api.max_pieces_in_sector(best_hash)?;
let block_authoring_delay = u64::from(chain_constants.block_authoring_delay());
let block_authoring_delay = usize::try_from(block_authoring_delay)
.expect("Block authoring delay will never exceed usize on any platform; qed");
let solution_response_senders_capacity = u32::try_from(block_authoring_delay)
.expect("Always a tiny constant in the protocol; qed");
Ok(Self {
client: config.client,
subscription_executor: config.subscription_executor,
new_slot_notification_stream: config.new_slot_notification_stream,
reward_signing_notification_stream: config.reward_signing_notification_stream,
object_mapping_notification_stream: config.object_mapping_notification_stream,
archived_segment_notification_stream: config.archived_segment_notification_stream,
solution_response_senders: Arc::new(Mutex::new(LruMap::new(ByLength::new(
solution_response_senders_capacity,
)))),
reward_signature_senders: Arc::default(),
dsn_bootstrap_nodes: config.dsn_bootstrap_nodes,
segment_headers_store: config.segment_headers_store,
cached_archived_segment: Arc::default(),
archived_segment_acknowledgement_senders: Arc::default(),
next_subscription_id: AtomicU64::default(),
sync_oracle: config.sync_oracle,
genesis_hash,
chain_constants,
max_pieces_in_sector,
kzg: config.kzg,
erasure_coding: config.erasure_coding,
_block: PhantomData,
})
}
}
#[async_trait]
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> {
let last_segment_index = self
.segment_headers_store
.max_segment_index()
.unwrap_or(SegmentIndex::ZERO);
let farmer_app_info: Result<FarmerAppInfo, ApiError> = try {
let chain_constants = &self.chain_constants;
let protocol_info = FarmerProtocolInfo {
history_size: HistorySize::from(last_segment_index),
max_pieces_in_sector: self.max_pieces_in_sector,
recent_segments: chain_constants.recent_segments(),
recent_history_fraction: chain_constants.recent_history_fraction(),
min_sector_lifetime: chain_constants.min_sector_lifetime(),
};
FarmerAppInfo {
genesis_hash: self.genesis_hash,
dsn_bootstrap_nodes: self.dsn_bootstrap_nodes.clone(),
syncing: self.sync_oracle.is_major_syncing(),
farming_timeout: chain_constants
.slot_duration()
.as_duration()
.mul_f64(SlotNumber::from(chain_constants.block_authoring_delay()) as f64),
protocol_info,
}
};
farmer_app_info.map_err(|error| {
error!("Failed to get data from runtime API: {}", error);
Error::StringError("Internal error".to_string())
})
}
fn submit_solution_response(
&self,
ext: &Extensions,
solution_response: SolutionResponse,
) -> Result<(), Error> {
check_if_safe(ext)?;
let slot = solution_response.slot_number;
let mut solution_response_senders = self.solution_response_senders.lock();
let success = solution_response_senders
.peek_mut(&slot)
.and_then(|sender| sender.try_send(solution_response.solution).ok())
.is_some();
if !success {
warn!(
%slot,
"Solution was ignored, likely because farmer was too slow"
);
return Err(Error::StringError("Solution was ignored".to_string()));
}
Ok(())
}
fn subscribe_slot_info(&self, pending: PendingSubscriptionSink, ext: &Extensions) {
let executor = self.subscription_executor.clone();
let solution_response_senders = self.solution_response_senders.clone();
let allow_solutions = check_if_safe(ext).is_ok();
let handle_slot_notification = move |new_slot_notification| {
let NewSlotNotification {
new_slot_info,
mut solution_sender,
} = new_slot_notification;
let slot_number = SlotNumber::from(new_slot_info.slot);
// Only handle solution responses in case unsafe APIs are allowed
if allow_solutions {
// Store solution sender so that we can retrieve it when solution comes from
// the farmer
let mut solution_response_senders = solution_response_senders.lock();
if solution_response_senders.peek(&slot_number).is_none() {
let (response_sender, mut response_receiver) =
mpsc::channel(SOLUTION_SENDER_CHANNEL_CAPACITY);
solution_response_senders.insert(slot_number, response_sender);
// Wait for solutions and transform proposed proof of space solutions
// into data structure `sc-consensus-subspace` expects
let forward_solution_fut = async move {
while let Some(solution) = response_receiver.next().await {
let public_key = solution.public_key;
let sector_index = solution.sector_index;
let solution = Solution {
public_key,
reward_address: solution.reward_address,
sector_index,
history_size: solution.history_size,
piece_offset: solution.piece_offset,
record_commitment: solution.record_commitment,
record_witness: solution.record_witness,
chunk: solution.chunk,
chunk_witness: solution.chunk_witness,
proof_of_space: solution.proof_of_space,
};
if solution_sender.try_send(solution).is_err() {
warn!(
slot = %slot_number,
%sector_index,
%public_key,
"Solution receiver is closed, likely because farmer was too slow"
);
}
}
};
executor.spawn(
"subspace-slot-info-forward",
Some("rpc"),
Box::pin(forward_solution_fut),
);
}
}
let global_challenge = new_slot_info
.proof_of_time
.derive_global_randomness()
.derive_global_challenge(slot_number);
// This will be sent to the farmer
SlotInfo {
slot_number,
global_challenge,
solution_range: new_slot_info.solution_range,
voting_solution_range: new_slot_info.voting_solution_range,
}
};
let stream = self
.new_slot_notification_stream
.subscribe()
.map(handle_slot_notification);
self.subscription_executor.spawn(
"subspace-slot-info-subscription",
Some("rpc"),
PendingSubscription::from(pending)
.pipe_from_stream(stream, BoundedVecDeque::default())
.boxed(),
);
}
fn subscribe_reward_signing(&self, pending: PendingSubscriptionSink, ext: &Extensions) {
if check_if_safe(ext).is_err() {
debug!("Unsafe subscribe_reward_signing ignored");
return;
}
let executor = self.subscription_executor.clone();
let reward_signature_senders = self.reward_signature_senders.clone();
let stream = self.reward_signing_notification_stream.subscribe().map(
move |reward_signing_notification| {
let RewardSigningNotification {
hash,
public_key,
signature_sender,
} = reward_signing_notification;
let (response_sender, response_receiver) = async_oneshot::oneshot();
// Store signature sender so that we can retrieve it when solution comes from
// the farmer
{
let mut reward_signature_senders = reward_signature_senders.lock();
if reward_signature_senders.current_hash != hash {
reward_signature_senders.current_hash = hash;
reward_signature_senders.senders.clear();
}
reward_signature_senders.senders.push(response_sender);
}
// Wait for solutions and transform proposed proof of space solutions into
// data structure `sc-consensus-subspace` expects
let forward_signature_fut = async move {
if let Ok(reward_signature) = response_receiver.await {
if let Some(signature) = reward_signature.signature {
let _ = signature_sender.unbounded_send(signature);
}
}
};
// Run above future with timeout
executor.spawn(
"subspace-block-signing-forward",
Some("rpc"),
future::select(
futures_timer::Delay::new(REWARD_SIGNING_TIMEOUT),
Box::pin(forward_signature_fut),
)
.map(|_| ())
.boxed(),
);
// This will be sent to the farmer
RewardSigningInfo {
hash: hash.into(),
public_key,
}
},
);
self.subscription_executor.spawn(
"subspace-block-signing-subscription",
Some("rpc"),
PendingSubscription::from(pending)
.pipe_from_stream(stream, BoundedVecDeque::default())
.boxed(),
);
}
fn submit_reward_signature(
&self,
ext: &Extensions,
reward_signature: RewardSignatureResponse,
) -> Result<(), Error> {
check_if_safe(ext)?;
let reward_signature_senders = self.reward_signature_senders.clone();
// TODO: This doesn't track what client sent a solution, allowing some clients to send
// multiple (https://github.com/paritytech/jsonrpsee/issues/452)
let mut reward_signature_senders = reward_signature_senders.lock();
if reward_signature_senders.current_hash == reward_signature.hash.into() {
if let Some(mut sender) = reward_signature_senders.senders.pop() {
let _ = sender.send(reward_signature);
}
}
Ok(())
}
fn subscribe_archived_segment_header(
&self,
pending: PendingSubscriptionSink,
ext: &Extensions,
) {
let archived_segment_acknowledgement_senders =
self.archived_segment_acknowledgement_senders.clone();
let cached_archived_segment = Arc::clone(&self.cached_archived_segment);
let subscription_id = self.next_subscription_id.fetch_add(1, Ordering::Relaxed);
let allow_acknowledgements = check_if_safe(ext).is_ok();
let stream = self
.archived_segment_notification_stream
.subscribe()
.filter_map(move |archived_segment_notification| {
let ArchivedSegmentNotification {
archived_segment,
acknowledgement_sender,
} = archived_segment_notification;
let segment_index = archived_segment.segment_header.segment_index();
// Store acknowledgment sender so that we can retrieve it when acknowledgement
// comes from the farmer, but only if unsafe APIs are allowed
let maybe_archived_segment_header = if allow_acknowledgements {
let mut archived_segment_acknowledgement_senders =
archived_segment_acknowledgement_senders.lock();
if archived_segment_acknowledgement_senders.segment_index != segment_index {
archived_segment_acknowledgement_senders.segment_index = segment_index;
archived_segment_acknowledgement_senders.senders.clear();
}
let maybe_archived_segment_header =
match archived_segment_acknowledgement_senders
.senders
.entry(subscription_id)
{
Entry::Occupied(_) => {
// No need to do anything, farmer is processing request
None
}
Entry::Vacant(entry) => {
entry.insert(acknowledgement_sender);
// This will be sent to the farmer
Some(archived_segment.segment_header)
}
};
cached_archived_segment
.lock()
.replace(CachedArchivedSegment::Weak(Arc::downgrade(
&archived_segment,
)));
maybe_archived_segment_header
} else {
// In case unsafe APIs are not allowed, just return segment header without
// requiring it to be acknowledged
Some(archived_segment.segment_header)
};
Box::pin(async move { maybe_archived_segment_header })
});
let archived_segment_acknowledgement_senders =
self.archived_segment_acknowledgement_senders.clone();
let fut = async move {
PendingSubscription::from(pending)
.pipe_from_stream(stream, BoundedVecDeque::default())
.await;
let mut archived_segment_acknowledgement_senders =
archived_segment_acknowledgement_senders.lock();
archived_segment_acknowledgement_senders
.senders
.remove(&subscription_id);
};
self.subscription_executor.spawn(
"subspace-archived-segment-header-subscription",
Some("rpc"),
fut.boxed(),
);
}
async fn acknowledge_archived_segment_header(
&self,
ext: &Extensions,
segment_index: SegmentIndex,
) -> Result<(), Error> {
check_if_safe(ext)?;
let archived_segment_acknowledgement_senders =
self.archived_segment_acknowledgement_senders.clone();
let maybe_sender = {
let mut archived_segment_acknowledgement_senders_guard =
archived_segment_acknowledgement_senders.lock();
(archived_segment_acknowledgement_senders_guard.segment_index == segment_index)
.then(|| {
let last_key = *archived_segment_acknowledgement_senders_guard
.senders
.keys()
.next()?;
archived_segment_acknowledgement_senders_guard
.senders
.remove(&last_key)
})
.flatten()
};
if let Some(sender) = maybe_sender {
if let Err(error) = sender.unbounded_send(()) {
if !error.is_closed() {
warn!("Failed to acknowledge archived segment: {error}");
}
}
}
debug!(%segment_index, "Acknowledged archived segment.");
Ok(())
}
// Note: this RPC uses the cached archived segment, which is only updated by archived segments subscriptions
fn piece(
&self,
ext: &Extensions,
requested_piece_index: PieceIndex,
) -> Result<Option<Piece>, Error> {
check_if_safe(ext)?;
let archived_segment = {
let mut cached_archived_segment = self.cached_archived_segment.lock();
match cached_archived_segment
.as_ref()
.and_then(CachedArchivedSegment::get)
{
Some(archived_segment) => archived_segment,
None => {
if requested_piece_index > SegmentIndex::ZERO.last_piece_index() {
return Ok(None);
}
debug!(%requested_piece_index, "Re-creating genesis segment on demand");
// Try to re-create genesis segment on demand
match recreate_genesis_segment(
&*self.client,
self.kzg.clone(),
self.erasure_coding.clone(),
) {
Ok(Some(archived_segment)) => {
let archived_segment = Arc::new(archived_segment);
cached_archived_segment.replace(CachedArchivedSegment::Genesis(
Arc::clone(&archived_segment),
));
archived_segment
}
Ok(None) => {
return Ok(None);
}
Err(error) => {
error!(%error, "Failed to re-create genesis segment");
return Err(Error::StringError(
"Failed to re-create genesis segment".to_string(),
));
}
}
}
}
};
if requested_piece_index.segment_index() == archived_segment.segment_header.segment_index()
{
return Ok(archived_segment
.pieces
.pieces()
.nth(requested_piece_index.position() as usize));
}
Ok(None)
}
async fn segment_headers(
&self,
segment_indexes: Vec<SegmentIndex>,
) -> Result<Vec<Option<SegmentHeader>>, Error> {
if segment_indexes.len() > MAX_SEGMENT_HEADERS_PER_REQUEST {
error!(
"segment_indexes length exceed the limit: {} ",
segment_indexes.len()
);
return Err(Error::StringError(format!(
"segment_indexes length exceed the limit {MAX_SEGMENT_HEADERS_PER_REQUEST}"
)));
};
Ok(segment_indexes
.into_iter()
.map(|segment_index| self.segment_headers_store.get_segment_header(segment_index))
.collect())
}
async fn last_segment_headers(&self, limit: u32) -> Result<Vec<Option<SegmentHeader>>, Error> {
if limit as usize > MAX_SEGMENT_HEADERS_PER_REQUEST {
error!(
"Request limit ({}) exceed the server limit: {} ",
limit, MAX_SEGMENT_HEADERS_PER_REQUEST
);
return Err(Error::StringError(format!(
"Request limit ({}) exceed the server limit: {} ",
limit, MAX_SEGMENT_HEADERS_PER_REQUEST
)));
};
let last_segment_index = self
.segment_headers_store
.max_segment_index()
.unwrap_or(SegmentIndex::ZERO);
let mut last_segment_headers = (SegmentIndex::ZERO..=last_segment_index)
.rev()
.take(limit as usize)
.map(|segment_index| self.segment_headers_store.get_segment_header(segment_index))
.collect::<Vec<_>>();
last_segment_headers.reverse();
Ok(last_segment_headers)
}
fn subscribe_object_mappings(&self, pending: PendingSubscriptionSink, ext: &Extensions) {
if check_if_safe(ext).is_err() {
debug!("Unsafe subscribe_object_mappings ignored");
return;
}
let mapping_stream = self
.object_mapping_notification_stream
.subscribe()
.flat_map(|object_mapping_notification| {
let objects = object_mapping_notification.object_mapping;
let block_number = object_mapping_notification.block_number;
stream::iter(objects)
.ready_chunks(OBJECT_MAPPING_BATCH_SIZE)
.map(move |chunk| ObjectMappingResponse {
block_number,
objects: GlobalObjectMapping::from_objects(chunk.iter().cloned()),
})
});
self.subscription_executor.spawn(
"subspace-archived-object-mappings-subscription",
Some("rpc"),
PendingSubscription::from(pending)
.pipe_from_stream(mapping_stream, BoundedVecDeque::default())
.boxed(),
);
}
fn subscribe_filtered_object_mappings(
&self,
pending: PendingSubscriptionSink,
ext: &Extensions,
hashes: Vec<Blake3Hash>,
) {
if check_if_safe(ext).is_err() {
debug!("Unsafe subscribe_filtered_object_mappings ignored");
return;
}
if hashes.len() > MAX_OBJECT_HASHES_PER_SUBSCRIPTION {
error!(
"Request hash count ({}) exceed the server limit: {} ",
hashes.len(),
MAX_OBJECT_HASHES_PER_SUBSCRIPTION
);
let err_fut = pending.reject(Error::StringError(format!(
"Request hash count ({}) exceed the server limit: {} ",
hashes.len(),
MAX_OBJECT_HASHES_PER_SUBSCRIPTION
)));
self.subscription_executor.spawn(
"subspace-filtered-object-mappings-subscription",
Some("rpc"),
err_fut.boxed(),
);
return;
};
let mut hashes = HashSet::<Blake3Hash>::from_iter(hashes);
let hash_count = hashes.len();
let mut object_count = 0;
let mapping_stream = self
.object_mapping_notification_stream
.subscribe()
.flat_map(move |object_mapping_notification| {
let objects = object_mapping_notification.object_mapping;
let block_number = object_mapping_notification.block_number;
let filtered_objects = objects
.into_iter()
.filter(|object| hashes.remove(&object.hash))
.collect::<Vec<_>>();
stream::iter(filtered_objects)
// Typically batches will be larger than the hash limit, but we want to allow
// CLI options to change that in future.
.ready_chunks(OBJECT_MAPPING_BATCH_SIZE)
.map(move |chunk| ObjectMappingResponse {
block_number,
objects: GlobalObjectMapping::from_objects(chunk.iter().cloned()),
})
})
// Stop when we've returned mappings for all the hashes. Since we only yield each hash
// once, we don't need to check if hashes is empty here.
.take_while(move |mappings| {
object_count += mappings.objects.objects().len();
future::ready(object_count <= hash_count)
});
self.subscription_executor.spawn(
"subspace-filtered-object-mappings-subscription",
Some("rpc"),
PendingSubscription::from(pending)
.pipe_from_stream(mapping_stream, BoundedVecDeque::default())
.boxed(),
);
}
}