1186 lines
41 KiB
Rust
1186 lines
41 KiB
Rust
//! The `pubsub` module implements a threaded subscription service on client RPC request
|
|
|
|
use crate::commitment::BlockCommitmentCache;
|
|
use core::hash::Hash;
|
|
use jsonrpc_core::futures::Future;
|
|
use jsonrpc_pubsub::{
|
|
typed::{Sink, Subscriber},
|
|
SubscriptionId,
|
|
};
|
|
use serde::Serialize;
|
|
use solana_client::rpc_response::{
|
|
Response, RpcAccount, RpcKeyedAccount, RpcResponseContext, RpcSignatureResult,
|
|
};
|
|
use solana_ledger::{bank_forks::BankForks, blockstore::Blockstore};
|
|
use solana_runtime::bank::Bank;
|
|
use solana_sdk::{
|
|
account::Account,
|
|
clock::Slot,
|
|
commitment_config::{CommitmentConfig, CommitmentLevel},
|
|
pubkey::Pubkey,
|
|
signature::Signature,
|
|
transaction,
|
|
};
|
|
use std::sync::{
|
|
atomic::{AtomicBool, Ordering},
|
|
mpsc::{Receiver, RecvTimeoutError, SendError, Sender},
|
|
};
|
|
use std::thread::{Builder, JoinHandle};
|
|
use std::time::Duration;
|
|
use std::{
|
|
collections::{HashMap, HashSet},
|
|
iter,
|
|
sync::{Arc, Mutex, RwLock},
|
|
};
|
|
use tokio::runtime::{Builder as RuntimeBuilder, Runtime, TaskExecutor};
|
|
|
|
const RECEIVE_DELAY_MILLIS: u64 = 100;
|
|
|
|
#[derive(Serialize, Deserialize, Clone, Copy, Debug)]
|
|
pub struct SlotInfo {
|
|
pub slot: Slot,
|
|
pub parent: Slot,
|
|
pub root: Slot,
|
|
}
|
|
|
|
enum NotificationEntry {
|
|
Slot(SlotInfo),
|
|
Root(Slot),
|
|
Bank(Slot),
|
|
}
|
|
|
|
impl std::fmt::Debug for NotificationEntry {
|
|
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
|
|
match self {
|
|
NotificationEntry::Root(root) => write!(f, "Root({})", root),
|
|
NotificationEntry::Slot(slot_info) => write!(f, "Slot({:?})", slot_info),
|
|
NotificationEntry::Bank(current_slot) => {
|
|
write!(f, "Bank({{current_slot: {:?}}})", current_slot)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
struct SubscriptionData<S> {
|
|
sink: Sink<S>,
|
|
commitment: CommitmentConfig,
|
|
last_notified_slot: RwLock<Slot>,
|
|
}
|
|
type RpcAccountSubscriptions =
|
|
RwLock<HashMap<Pubkey, HashMap<SubscriptionId, SubscriptionData<Response<RpcAccount>>>>>;
|
|
type RpcProgramSubscriptions =
|
|
RwLock<HashMap<Pubkey, HashMap<SubscriptionId, SubscriptionData<Response<RpcKeyedAccount>>>>>;
|
|
type RpcSignatureSubscriptions = RwLock<
|
|
HashMap<Signature, HashMap<SubscriptionId, SubscriptionData<Response<RpcSignatureResult>>>>,
|
|
>;
|
|
type RpcSlotSubscriptions = RwLock<HashMap<SubscriptionId, Sink<SlotInfo>>>;
|
|
type RpcRootSubscriptions = RwLock<HashMap<SubscriptionId, Sink<Slot>>>;
|
|
|
|
fn add_subscription<K, S>(
|
|
subscriptions: &mut HashMap<K, HashMap<SubscriptionId, SubscriptionData<S>>>,
|
|
hashmap_key: K,
|
|
commitment: Option<CommitmentConfig>,
|
|
sub_id: SubscriptionId,
|
|
subscriber: Subscriber<S>,
|
|
last_notified_slot: Slot,
|
|
) where
|
|
K: Eq + Hash,
|
|
S: Clone,
|
|
{
|
|
let sink = subscriber.assign_id(sub_id.clone()).unwrap();
|
|
let commitment = commitment.unwrap_or_else(CommitmentConfig::recent);
|
|
let subscription_data = SubscriptionData {
|
|
sink,
|
|
commitment,
|
|
last_notified_slot: RwLock::new(last_notified_slot),
|
|
};
|
|
if let Some(current_hashmap) = subscriptions.get_mut(&hashmap_key) {
|
|
current_hashmap.insert(sub_id, subscription_data);
|
|
return;
|
|
}
|
|
let mut hashmap = HashMap::new();
|
|
hashmap.insert(sub_id, subscription_data);
|
|
subscriptions.insert(hashmap_key, hashmap);
|
|
}
|
|
|
|
fn remove_subscription<K, S>(
|
|
subscriptions: &mut HashMap<K, HashMap<SubscriptionId, SubscriptionData<S>>>,
|
|
sub_id: &SubscriptionId,
|
|
) -> bool
|
|
where
|
|
K: Eq + Hash,
|
|
S: Clone,
|
|
{
|
|
let mut found = false;
|
|
subscriptions.retain(|_, v| {
|
|
v.retain(|k, _| {
|
|
let retain = k != sub_id;
|
|
if !retain {
|
|
found = true;
|
|
}
|
|
retain
|
|
});
|
|
!v.is_empty()
|
|
});
|
|
found
|
|
}
|
|
|
|
#[allow(clippy::type_complexity)]
|
|
fn check_commitment_and_notify<K, S, B, F, X>(
|
|
subscriptions: &HashMap<K, HashMap<SubscriptionId, SubscriptionData<Response<S>>>>,
|
|
hashmap_key: &K,
|
|
bank_forks: &Arc<RwLock<BankForks>>,
|
|
block_commitment_cache: &Arc<RwLock<BlockCommitmentCache>>,
|
|
bank_method: B,
|
|
filter_results: F,
|
|
notifier: &RpcNotifier,
|
|
) -> HashSet<SubscriptionId>
|
|
where
|
|
K: Eq + Hash + Clone + Copy,
|
|
S: Clone + Serialize,
|
|
B: Fn(&Bank, &K) -> X,
|
|
F: Fn(X, Slot) -> (Box<dyn Iterator<Item = S>>, Slot),
|
|
X: Clone + Serialize + Default,
|
|
{
|
|
let r_block_commitment_cache = block_commitment_cache.read().unwrap();
|
|
let current_slot = r_block_commitment_cache.slot();
|
|
let node_root = r_block_commitment_cache.root();
|
|
let largest_confirmed_root = r_block_commitment_cache.largest_confirmed_root();
|
|
drop(r_block_commitment_cache);
|
|
|
|
let mut notified_set: HashSet<SubscriptionId> = HashSet::new();
|
|
if let Some(hashmap) = subscriptions.get(hashmap_key) {
|
|
for (
|
|
sub_id,
|
|
SubscriptionData {
|
|
sink,
|
|
commitment,
|
|
last_notified_slot,
|
|
},
|
|
) in hashmap.iter()
|
|
{
|
|
let slot = match commitment.commitment {
|
|
CommitmentLevel::Max => largest_confirmed_root,
|
|
CommitmentLevel::Recent => current_slot,
|
|
CommitmentLevel::Root => node_root,
|
|
};
|
|
let results = {
|
|
let bank_forks = bank_forks.read().unwrap();
|
|
bank_forks
|
|
.get(slot)
|
|
.map(|desired_bank| bank_method(&desired_bank, hashmap_key))
|
|
.unwrap_or_default()
|
|
};
|
|
let mut w_last_notified_slot = last_notified_slot.write().unwrap();
|
|
let (filter_results, result_slot) = filter_results(results, *w_last_notified_slot);
|
|
for result in filter_results {
|
|
notifier.notify(
|
|
Response {
|
|
context: RpcResponseContext { slot },
|
|
value: result,
|
|
},
|
|
sink,
|
|
);
|
|
notified_set.insert(sub_id.clone());
|
|
*w_last_notified_slot = result_slot;
|
|
}
|
|
}
|
|
}
|
|
notified_set
|
|
}
|
|
|
|
struct RpcNotifier(TaskExecutor);
|
|
|
|
impl RpcNotifier {
|
|
fn notify<T>(&self, value: T, sink: &Sink<T>)
|
|
where
|
|
T: serde::Serialize,
|
|
{
|
|
self.0
|
|
.spawn(sink.notify(Ok(value)).map(|_| ()).map_err(|_| ()));
|
|
}
|
|
}
|
|
|
|
fn filter_account_result(
|
|
result: Option<(Account, Slot)>,
|
|
last_notified_slot: Slot,
|
|
) -> (Box<dyn Iterator<Item = RpcAccount>>, Slot) {
|
|
if let Some((account, fork)) = result {
|
|
if fork != last_notified_slot {
|
|
return (Box::new(iter::once(RpcAccount::encode(account))), fork);
|
|
}
|
|
}
|
|
(Box::new(iter::empty()), last_notified_slot)
|
|
}
|
|
|
|
fn filter_signature_result(
|
|
result: Option<transaction::Result<()>>,
|
|
last_notified_slot: Slot,
|
|
) -> (Box<dyn Iterator<Item = RpcSignatureResult>>, Slot) {
|
|
(
|
|
Box::new(
|
|
result
|
|
.into_iter()
|
|
.map(|result| RpcSignatureResult { err: result.err() }),
|
|
),
|
|
last_notified_slot,
|
|
)
|
|
}
|
|
|
|
fn filter_program_results(
|
|
accounts: Vec<(Pubkey, Account)>,
|
|
last_notified_slot: Slot,
|
|
) -> (Box<dyn Iterator<Item = RpcKeyedAccount>>, Slot) {
|
|
(
|
|
Box::new(
|
|
accounts
|
|
.into_iter()
|
|
.map(|(pubkey, account)| RpcKeyedAccount {
|
|
pubkey: pubkey.to_string(),
|
|
account: RpcAccount::encode(account),
|
|
}),
|
|
),
|
|
last_notified_slot,
|
|
)
|
|
}
|
|
|
|
#[derive(Clone)]
|
|
struct Subscriptions {
|
|
account_subscriptions: Arc<RpcAccountSubscriptions>,
|
|
program_subscriptions: Arc<RpcProgramSubscriptions>,
|
|
signature_subscriptions: Arc<RpcSignatureSubscriptions>,
|
|
slot_subscriptions: Arc<RpcSlotSubscriptions>,
|
|
root_subscriptions: Arc<RpcRootSubscriptions>,
|
|
}
|
|
|
|
pub struct RpcSubscriptions {
|
|
subscriptions: Subscriptions,
|
|
notification_sender: Arc<Mutex<Sender<NotificationEntry>>>,
|
|
t_cleanup: Option<JoinHandle<()>>,
|
|
notifier_runtime: Option<Runtime>,
|
|
bank_forks: Arc<RwLock<BankForks>>,
|
|
block_commitment_cache: Arc<RwLock<BlockCommitmentCache>>,
|
|
exit: Arc<AtomicBool>,
|
|
}
|
|
|
|
impl Drop for RpcSubscriptions {
|
|
fn drop(&mut self) {
|
|
self.shutdown().unwrap_or_else(|err| {
|
|
warn!("RPC Notification - shutdown error: {:?}", err);
|
|
});
|
|
}
|
|
}
|
|
|
|
impl RpcSubscriptions {
|
|
pub fn new(
|
|
exit: &Arc<AtomicBool>,
|
|
bank_forks: Arc<RwLock<BankForks>>,
|
|
block_commitment_cache: Arc<RwLock<BlockCommitmentCache>>,
|
|
) -> Self {
|
|
let (notification_sender, notification_receiver): (
|
|
Sender<NotificationEntry>,
|
|
Receiver<NotificationEntry>,
|
|
) = std::sync::mpsc::channel();
|
|
|
|
let account_subscriptions = Arc::new(RpcAccountSubscriptions::default());
|
|
let program_subscriptions = Arc::new(RpcProgramSubscriptions::default());
|
|
let signature_subscriptions = Arc::new(RpcSignatureSubscriptions::default());
|
|
let slot_subscriptions = Arc::new(RpcSlotSubscriptions::default());
|
|
let root_subscriptions = Arc::new(RpcRootSubscriptions::default());
|
|
let notification_sender = Arc::new(Mutex::new(notification_sender));
|
|
|
|
let _bank_forks = bank_forks.clone();
|
|
let _block_commitment_cache = block_commitment_cache.clone();
|
|
let exit_clone = exit.clone();
|
|
let subscriptions = Subscriptions {
|
|
account_subscriptions,
|
|
program_subscriptions,
|
|
signature_subscriptions,
|
|
slot_subscriptions,
|
|
root_subscriptions,
|
|
};
|
|
let _subscriptions = subscriptions.clone();
|
|
|
|
let notifier_runtime = RuntimeBuilder::new()
|
|
.core_threads(1)
|
|
.name_prefix("solana-rpc-notifier-")
|
|
.build()
|
|
.unwrap();
|
|
|
|
let notifier = RpcNotifier(notifier_runtime.executor());
|
|
let t_cleanup = Builder::new()
|
|
.name("solana-rpc-notifications".to_string())
|
|
.spawn(move || {
|
|
Self::process_notifications(
|
|
exit_clone,
|
|
notifier,
|
|
notification_receiver,
|
|
_subscriptions,
|
|
_bank_forks,
|
|
_block_commitment_cache,
|
|
);
|
|
})
|
|
.unwrap();
|
|
|
|
Self {
|
|
subscriptions,
|
|
notification_sender,
|
|
notifier_runtime: Some(notifier_runtime),
|
|
t_cleanup: Some(t_cleanup),
|
|
bank_forks,
|
|
block_commitment_cache,
|
|
exit: exit.clone(),
|
|
}
|
|
}
|
|
|
|
pub fn default_with_blockstore_bank_forks(
|
|
blockstore: Arc<Blockstore>,
|
|
bank_forks: Arc<RwLock<BankForks>>,
|
|
) -> Self {
|
|
Self::new(
|
|
&Arc::new(AtomicBool::new(false)),
|
|
bank_forks,
|
|
Arc::new(RwLock::new(BlockCommitmentCache::default_with_blockstore(
|
|
blockstore,
|
|
))),
|
|
)
|
|
}
|
|
|
|
fn check_account(
|
|
pubkey: &Pubkey,
|
|
bank_forks: &Arc<RwLock<BankForks>>,
|
|
block_commitment_cache: &Arc<RwLock<BlockCommitmentCache>>,
|
|
account_subscriptions: Arc<RpcAccountSubscriptions>,
|
|
notifier: &RpcNotifier,
|
|
) {
|
|
let subscriptions = account_subscriptions.read().unwrap();
|
|
check_commitment_and_notify(
|
|
&subscriptions,
|
|
pubkey,
|
|
bank_forks,
|
|
block_commitment_cache,
|
|
Bank::get_account_modified_slot,
|
|
filter_account_result,
|
|
notifier,
|
|
);
|
|
}
|
|
|
|
fn check_program(
|
|
program_id: &Pubkey,
|
|
bank_forks: &Arc<RwLock<BankForks>>,
|
|
block_commitment_cache: &Arc<RwLock<BlockCommitmentCache>>,
|
|
program_subscriptions: Arc<RpcProgramSubscriptions>,
|
|
notifier: &RpcNotifier,
|
|
) {
|
|
let subscriptions = program_subscriptions.read().unwrap();
|
|
check_commitment_and_notify(
|
|
&subscriptions,
|
|
program_id,
|
|
bank_forks,
|
|
block_commitment_cache,
|
|
Bank::get_program_accounts_modified_since_parent,
|
|
filter_program_results,
|
|
notifier,
|
|
);
|
|
}
|
|
|
|
fn check_signature(
|
|
signature: &Signature,
|
|
bank_forks: &Arc<RwLock<BankForks>>,
|
|
block_commitment_cache: &Arc<RwLock<BlockCommitmentCache>>,
|
|
signature_subscriptions: Arc<RpcSignatureSubscriptions>,
|
|
notifier: &RpcNotifier,
|
|
) {
|
|
let mut subscriptions = signature_subscriptions.write().unwrap();
|
|
let notified_ids = check_commitment_and_notify(
|
|
&subscriptions,
|
|
signature,
|
|
bank_forks,
|
|
block_commitment_cache,
|
|
Bank::get_signature_status_processed_since_parent,
|
|
filter_signature_result,
|
|
notifier,
|
|
);
|
|
if let Some(subscription_ids) = subscriptions.get_mut(signature) {
|
|
subscription_ids.retain(|k, _| !notified_ids.contains(k));
|
|
if subscription_ids.is_empty() {
|
|
subscriptions.remove(&signature);
|
|
}
|
|
}
|
|
}
|
|
|
|
pub fn add_account_subscription(
|
|
&self,
|
|
pubkey: Pubkey,
|
|
commitment: Option<CommitmentConfig>,
|
|
sub_id: SubscriptionId,
|
|
subscriber: Subscriber<Response<RpcAccount>>,
|
|
) {
|
|
let mut subscriptions = self.subscriptions.account_subscriptions.write().unwrap();
|
|
let slot = match commitment
|
|
.unwrap_or_else(CommitmentConfig::recent)
|
|
.commitment
|
|
{
|
|
CommitmentLevel::Max => self
|
|
.block_commitment_cache
|
|
.read()
|
|
.unwrap()
|
|
.largest_confirmed_root(),
|
|
CommitmentLevel::Recent => self.block_commitment_cache.read().unwrap().slot(),
|
|
CommitmentLevel::Root => self.block_commitment_cache.read().unwrap().root(),
|
|
};
|
|
let last_notified_slot = if let Some((_account, slot)) = self
|
|
.bank_forks
|
|
.read()
|
|
.unwrap()
|
|
.get(slot)
|
|
.and_then(|bank| bank.get_account_modified_slot(&pubkey))
|
|
{
|
|
slot
|
|
} else {
|
|
0
|
|
};
|
|
add_subscription(
|
|
&mut subscriptions,
|
|
pubkey,
|
|
commitment,
|
|
sub_id,
|
|
subscriber,
|
|
last_notified_slot,
|
|
);
|
|
}
|
|
|
|
pub fn remove_account_subscription(&self, id: &SubscriptionId) -> bool {
|
|
let mut subscriptions = self.subscriptions.account_subscriptions.write().unwrap();
|
|
remove_subscription(&mut subscriptions, id)
|
|
}
|
|
|
|
pub fn add_program_subscription(
|
|
&self,
|
|
program_id: Pubkey,
|
|
commitment: Option<CommitmentConfig>,
|
|
sub_id: SubscriptionId,
|
|
subscriber: Subscriber<Response<RpcKeyedAccount>>,
|
|
) {
|
|
let mut subscriptions = self.subscriptions.program_subscriptions.write().unwrap();
|
|
add_subscription(
|
|
&mut subscriptions,
|
|
program_id,
|
|
commitment,
|
|
sub_id,
|
|
subscriber,
|
|
0, // last_notified_slot is not utilized for program subscriptions
|
|
);
|
|
}
|
|
|
|
pub fn remove_program_subscription(&self, id: &SubscriptionId) -> bool {
|
|
let mut subscriptions = self.subscriptions.program_subscriptions.write().unwrap();
|
|
remove_subscription(&mut subscriptions, id)
|
|
}
|
|
|
|
pub fn add_signature_subscription(
|
|
&self,
|
|
signature: Signature,
|
|
commitment: Option<CommitmentConfig>,
|
|
sub_id: SubscriptionId,
|
|
subscriber: Subscriber<Response<RpcSignatureResult>>,
|
|
) {
|
|
let mut subscriptions = self.subscriptions.signature_subscriptions.write().unwrap();
|
|
add_subscription(
|
|
&mut subscriptions,
|
|
signature,
|
|
commitment,
|
|
sub_id,
|
|
subscriber,
|
|
0, // last_notified_slot is not utilized for signature subscriptions
|
|
);
|
|
}
|
|
|
|
pub fn remove_signature_subscription(&self, id: &SubscriptionId) -> bool {
|
|
let mut subscriptions = self.subscriptions.signature_subscriptions.write().unwrap();
|
|
remove_subscription(&mut subscriptions, id)
|
|
}
|
|
|
|
/// Notify subscribers of changes to any accounts or new signatures since
|
|
/// the bank's last checkpoint.
|
|
pub fn notify_subscribers(&self, current_slot: Slot) {
|
|
self.enqueue_notification(NotificationEntry::Bank(current_slot));
|
|
}
|
|
|
|
pub fn add_slot_subscription(&self, sub_id: SubscriptionId, subscriber: Subscriber<SlotInfo>) {
|
|
let sink = subscriber.assign_id(sub_id.clone()).unwrap();
|
|
let mut subscriptions = self.subscriptions.slot_subscriptions.write().unwrap();
|
|
subscriptions.insert(sub_id, sink);
|
|
}
|
|
|
|
pub fn remove_slot_subscription(&self, id: &SubscriptionId) -> bool {
|
|
let mut subscriptions = self.subscriptions.slot_subscriptions.write().unwrap();
|
|
subscriptions.remove(id).is_some()
|
|
}
|
|
|
|
pub fn notify_slot(&self, slot: Slot, parent: Slot, root: Slot) {
|
|
self.enqueue_notification(NotificationEntry::Slot(SlotInfo { slot, parent, root }));
|
|
}
|
|
|
|
pub fn add_root_subscription(&self, sub_id: SubscriptionId, subscriber: Subscriber<Slot>) {
|
|
let sink = subscriber.assign_id(sub_id.clone()).unwrap();
|
|
let mut subscriptions = self.subscriptions.root_subscriptions.write().unwrap();
|
|
subscriptions.insert(sub_id, sink);
|
|
}
|
|
|
|
pub fn remove_root_subscription(&self, id: &SubscriptionId) -> bool {
|
|
let mut subscriptions = self.subscriptions.root_subscriptions.write().unwrap();
|
|
subscriptions.remove(id).is_some()
|
|
}
|
|
|
|
pub fn notify_roots(&self, mut rooted_slots: Vec<Slot>) {
|
|
rooted_slots.sort();
|
|
rooted_slots.into_iter().for_each(|root| {
|
|
self.enqueue_notification(NotificationEntry::Root(root));
|
|
});
|
|
}
|
|
|
|
fn enqueue_notification(&self, notification_entry: NotificationEntry) {
|
|
match self
|
|
.notification_sender
|
|
.lock()
|
|
.unwrap()
|
|
.send(notification_entry)
|
|
{
|
|
Ok(()) => (),
|
|
Err(SendError(notification)) => {
|
|
warn!(
|
|
"Dropped RPC Notification - receiver disconnected : {:?}",
|
|
notification
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
fn process_notifications(
|
|
exit: Arc<AtomicBool>,
|
|
notifier: RpcNotifier,
|
|
notification_receiver: Receiver<NotificationEntry>,
|
|
subscriptions: Subscriptions,
|
|
bank_forks: Arc<RwLock<BankForks>>,
|
|
block_commitment_cache: Arc<RwLock<BlockCommitmentCache>>,
|
|
) {
|
|
loop {
|
|
if exit.load(Ordering::Relaxed) {
|
|
break;
|
|
}
|
|
match notification_receiver.recv_timeout(Duration::from_millis(RECEIVE_DELAY_MILLIS)) {
|
|
Ok(notification_entry) => match notification_entry {
|
|
NotificationEntry::Slot(slot_info) => {
|
|
let subscriptions = subscriptions.slot_subscriptions.read().unwrap();
|
|
for (_, sink) in subscriptions.iter() {
|
|
notifier.notify(slot_info, sink);
|
|
}
|
|
}
|
|
NotificationEntry::Root(root) => {
|
|
let subscriptions = subscriptions.root_subscriptions.read().unwrap();
|
|
for (_, sink) in subscriptions.iter() {
|
|
notifier.notify(root, sink);
|
|
}
|
|
}
|
|
NotificationEntry::Bank(_current_slot) => {
|
|
let pubkeys: Vec<_> = {
|
|
let subs = subscriptions.account_subscriptions.read().unwrap();
|
|
subs.keys().cloned().collect()
|
|
};
|
|
for pubkey in &pubkeys {
|
|
Self::check_account(
|
|
pubkey,
|
|
&bank_forks,
|
|
&block_commitment_cache,
|
|
subscriptions.account_subscriptions.clone(),
|
|
¬ifier,
|
|
);
|
|
}
|
|
|
|
let programs: Vec<_> = {
|
|
let subs = subscriptions.program_subscriptions.read().unwrap();
|
|
subs.keys().cloned().collect()
|
|
};
|
|
for program_id in &programs {
|
|
Self::check_program(
|
|
program_id,
|
|
&bank_forks,
|
|
&block_commitment_cache,
|
|
subscriptions.program_subscriptions.clone(),
|
|
¬ifier,
|
|
);
|
|
}
|
|
|
|
let signatures: Vec<_> = {
|
|
let subs = subscriptions.signature_subscriptions.read().unwrap();
|
|
subs.keys().cloned().collect()
|
|
};
|
|
for signature in &signatures {
|
|
Self::check_signature(
|
|
signature,
|
|
&bank_forks,
|
|
&block_commitment_cache,
|
|
subscriptions.signature_subscriptions.clone(),
|
|
¬ifier,
|
|
);
|
|
}
|
|
}
|
|
},
|
|
Err(RecvTimeoutError::Timeout) => {
|
|
// not a problem - try reading again
|
|
}
|
|
Err(RecvTimeoutError::Disconnected) => {
|
|
warn!("RPC Notification thread - sender disconnected");
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
fn shutdown(&mut self) -> std::thread::Result<()> {
|
|
if let Some(runtime) = self.notifier_runtime.take() {
|
|
info!("RPC Notifier runtime - shutting down");
|
|
let _ = runtime.shutdown_now().wait();
|
|
info!("RPC Notifier runtime - shut down");
|
|
}
|
|
|
|
if self.t_cleanup.is_some() {
|
|
info!("RPC Notification thread - shutting down");
|
|
self.exit.store(true, Ordering::Relaxed);
|
|
let x = self.t_cleanup.take().unwrap().join();
|
|
info!("RPC Notification thread - shut down.");
|
|
x
|
|
} else {
|
|
warn!("RPC Notification thread - already shut down.");
|
|
Ok(())
|
|
}
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
pub(crate) mod tests {
|
|
use super::*;
|
|
use crate::commitment::BlockCommitment;
|
|
use jsonrpc_core::futures::{self, stream::Stream};
|
|
use jsonrpc_pubsub::typed::Subscriber;
|
|
use serial_test_derive::serial;
|
|
use solana_budget_program;
|
|
use solana_ledger::{
|
|
blockstore::Blockstore,
|
|
genesis_utils::{create_genesis_config, GenesisConfigInfo},
|
|
get_tmp_ledger_path,
|
|
};
|
|
use solana_sdk::{
|
|
signature::{Keypair, Signer},
|
|
system_transaction,
|
|
};
|
|
use std::{fmt::Debug, sync::mpsc::channel, time::Instant};
|
|
use tokio::{prelude::FutureExt, runtime::Runtime, timer::Delay};
|
|
|
|
pub(crate) fn robust_poll_or_panic<T: Debug + Send + 'static>(
|
|
receiver: futures::sync::mpsc::Receiver<T>,
|
|
) -> (T, futures::sync::mpsc::Receiver<T>) {
|
|
let (inner_sender, inner_receiver) = channel();
|
|
let mut rt = Runtime::new().unwrap();
|
|
rt.spawn(futures::lazy(|| {
|
|
let recv_timeout = receiver
|
|
.into_future()
|
|
.timeout(Duration::from_millis(RECEIVE_DELAY_MILLIS))
|
|
.map(move |result| match result {
|
|
(Some(value), receiver) => {
|
|
inner_sender.send((value, receiver)).expect("send error")
|
|
}
|
|
(None, _) => panic!("unexpected end of stream"),
|
|
})
|
|
.map_err(|err| panic!("stream error {:?}", err));
|
|
|
|
const INITIAL_DELAY_MS: u64 = RECEIVE_DELAY_MILLIS * 2;
|
|
Delay::new(Instant::now() + Duration::from_millis(INITIAL_DELAY_MS))
|
|
.and_then(|_| recv_timeout)
|
|
.map_err(|err| panic!("timer error {:?}", err))
|
|
}));
|
|
inner_receiver.recv().expect("recv error")
|
|
}
|
|
|
|
#[test]
|
|
#[serial]
|
|
fn test_check_account_subscribe() {
|
|
let GenesisConfigInfo {
|
|
genesis_config,
|
|
mint_keypair,
|
|
..
|
|
} = create_genesis_config(100);
|
|
let ledger_path = get_tmp_ledger_path!();
|
|
let blockstore = Arc::new(Blockstore::open(&ledger_path).unwrap());
|
|
let bank = Bank::new(&genesis_config);
|
|
let blockhash = bank.last_blockhash();
|
|
let bank_forks = Arc::new(RwLock::new(BankForks::new(0, bank)));
|
|
let bank0 = bank_forks.read().unwrap().get(0).unwrap().clone();
|
|
let bank1 = Bank::new_from_parent(&bank0, &Pubkey::default(), 1);
|
|
bank_forks.write().unwrap().insert(bank1);
|
|
let alice = Keypair::new();
|
|
|
|
let (subscriber, _id_receiver, transport_receiver) =
|
|
Subscriber::new_test("accountNotification");
|
|
let sub_id = SubscriptionId::Number(0 as u64);
|
|
let exit = Arc::new(AtomicBool::new(false));
|
|
let subscriptions = RpcSubscriptions::new(
|
|
&exit,
|
|
bank_forks.clone(),
|
|
Arc::new(RwLock::new(
|
|
BlockCommitmentCache::new_for_tests_with_blockstore_bank(
|
|
blockstore,
|
|
bank_forks.read().unwrap().get(1).unwrap().clone(),
|
|
1,
|
|
),
|
|
)),
|
|
);
|
|
subscriptions.add_account_subscription(alice.pubkey(), None, sub_id.clone(), subscriber);
|
|
|
|
assert!(subscriptions
|
|
.subscriptions
|
|
.account_subscriptions
|
|
.read()
|
|
.unwrap()
|
|
.contains_key(&alice.pubkey()));
|
|
|
|
let tx = system_transaction::create_account(
|
|
&mint_keypair,
|
|
&alice,
|
|
blockhash,
|
|
1,
|
|
16,
|
|
&solana_budget_program::id(),
|
|
);
|
|
bank_forks
|
|
.write()
|
|
.unwrap()
|
|
.get(1)
|
|
.unwrap()
|
|
.process_transaction(&tx)
|
|
.unwrap();
|
|
subscriptions.notify_subscribers(1);
|
|
let (response, _) = robust_poll_or_panic(transport_receiver);
|
|
let expected = json!({
|
|
"jsonrpc": "2.0",
|
|
"method": "accountNotification",
|
|
"params": {
|
|
"result": {
|
|
"context": { "slot": 1 },
|
|
"value": {
|
|
"data": "1111111111111111",
|
|
"executable": false,
|
|
"lamports": 1,
|
|
"owner": "Budget1111111111111111111111111111111111111",
|
|
"rentEpoch": 1,
|
|
},
|
|
},
|
|
"subscription": 0,
|
|
}
|
|
});
|
|
assert_eq!(serde_json::to_string(&expected).unwrap(), response);
|
|
|
|
subscriptions.remove_account_subscription(&sub_id);
|
|
assert!(!subscriptions
|
|
.subscriptions
|
|
.account_subscriptions
|
|
.read()
|
|
.unwrap()
|
|
.contains_key(&alice.pubkey()));
|
|
}
|
|
|
|
#[test]
|
|
#[serial]
|
|
fn test_check_program_subscribe() {
|
|
let GenesisConfigInfo {
|
|
genesis_config,
|
|
mint_keypair,
|
|
..
|
|
} = create_genesis_config(100);
|
|
let ledger_path = get_tmp_ledger_path!();
|
|
let blockstore = Arc::new(Blockstore::open(&ledger_path).unwrap());
|
|
let bank = Bank::new(&genesis_config);
|
|
let blockhash = bank.last_blockhash();
|
|
let bank_forks = Arc::new(RwLock::new(BankForks::new(0, bank)));
|
|
let alice = Keypair::new();
|
|
let tx = system_transaction::create_account(
|
|
&mint_keypair,
|
|
&alice,
|
|
blockhash,
|
|
1,
|
|
16,
|
|
&solana_budget_program::id(),
|
|
);
|
|
bank_forks
|
|
.write()
|
|
.unwrap()
|
|
.get(0)
|
|
.unwrap()
|
|
.process_transaction(&tx)
|
|
.unwrap();
|
|
|
|
let (subscriber, _id_receiver, transport_receiver) =
|
|
Subscriber::new_test("programNotification");
|
|
let sub_id = SubscriptionId::Number(0 as u64);
|
|
let exit = Arc::new(AtomicBool::new(false));
|
|
let subscriptions = RpcSubscriptions::new(
|
|
&exit,
|
|
bank_forks,
|
|
Arc::new(RwLock::new(
|
|
BlockCommitmentCache::new_for_tests_with_blockstore(blockstore),
|
|
)),
|
|
);
|
|
subscriptions.add_program_subscription(
|
|
solana_budget_program::id(),
|
|
None,
|
|
sub_id.clone(),
|
|
subscriber,
|
|
);
|
|
|
|
assert!(subscriptions
|
|
.subscriptions
|
|
.program_subscriptions
|
|
.read()
|
|
.unwrap()
|
|
.contains_key(&solana_budget_program::id()));
|
|
|
|
subscriptions.notify_subscribers(0);
|
|
let (response, _) = robust_poll_or_panic(transport_receiver);
|
|
let expected = json!({
|
|
"jsonrpc": "2.0",
|
|
"method": "programNotification",
|
|
"params": {
|
|
"result": {
|
|
"context": { "slot": 0 },
|
|
"value": {
|
|
"account": {
|
|
"data": "1111111111111111",
|
|
"executable": false,
|
|
"lamports": 1,
|
|
"owner": "Budget1111111111111111111111111111111111111",
|
|
"rentEpoch": 1,
|
|
},
|
|
"pubkey": alice.pubkey().to_string(),
|
|
},
|
|
},
|
|
"subscription": 0,
|
|
}
|
|
});
|
|
assert_eq!(serde_json::to_string(&expected).unwrap(), response);
|
|
|
|
subscriptions.remove_program_subscription(&sub_id);
|
|
assert!(!subscriptions
|
|
.subscriptions
|
|
.program_subscriptions
|
|
.read()
|
|
.unwrap()
|
|
.contains_key(&solana_budget_program::id()));
|
|
}
|
|
|
|
#[test]
|
|
#[serial]
|
|
fn test_check_signature_subscribe() {
|
|
let GenesisConfigInfo {
|
|
genesis_config,
|
|
mint_keypair,
|
|
..
|
|
} = create_genesis_config(100);
|
|
let ledger_path = get_tmp_ledger_path!();
|
|
let blockstore = Arc::new(Blockstore::open(&ledger_path).unwrap());
|
|
let bank = Bank::new(&genesis_config);
|
|
let blockhash = bank.last_blockhash();
|
|
let mut bank_forks = BankForks::new(0, bank);
|
|
let alice = Keypair::new();
|
|
|
|
let past_bank_tx =
|
|
system_transaction::transfer(&mint_keypair, &alice.pubkey(), 1, blockhash);
|
|
let unprocessed_tx =
|
|
system_transaction::transfer(&mint_keypair, &alice.pubkey(), 2, blockhash);
|
|
let processed_tx =
|
|
system_transaction::transfer(&mint_keypair, &alice.pubkey(), 3, blockhash);
|
|
|
|
bank_forks
|
|
.get(0)
|
|
.unwrap()
|
|
.process_transaction(&past_bank_tx)
|
|
.unwrap();
|
|
|
|
let next_bank =
|
|
Bank::new_from_parent(&bank_forks.banks[&0].clone(), &Pubkey::new_rand(), 1);
|
|
bank_forks.insert(next_bank);
|
|
|
|
bank_forks
|
|
.get(1)
|
|
.unwrap()
|
|
.process_transaction(&processed_tx)
|
|
.unwrap();
|
|
let bank1 = bank_forks[1].clone();
|
|
|
|
let bank_forks = Arc::new(RwLock::new(bank_forks));
|
|
|
|
let mut cache0 = BlockCommitment::default();
|
|
cache0.increase_confirmation_stake(1, 10);
|
|
let cache1 = BlockCommitment::default();
|
|
|
|
let mut block_commitment = HashMap::new();
|
|
block_commitment.entry(0).or_insert(cache0.clone());
|
|
block_commitment.entry(1).or_insert(cache1.clone());
|
|
let block_commitment_cache =
|
|
BlockCommitmentCache::new(block_commitment, 0, 10, bank1, blockstore, 0);
|
|
|
|
let exit = Arc::new(AtomicBool::new(false));
|
|
let subscriptions = RpcSubscriptions::new(
|
|
&exit,
|
|
bank_forks,
|
|
Arc::new(RwLock::new(block_commitment_cache)),
|
|
);
|
|
|
|
let (past_bank_sub1, _id_receiver, past_bank_recv1) =
|
|
Subscriber::new_test("signatureNotification");
|
|
let (past_bank_sub2, _id_receiver, past_bank_recv2) =
|
|
Subscriber::new_test("signatureNotification");
|
|
let (processed_sub, _id_receiver, processed_recv) =
|
|
Subscriber::new_test("signatureNotification");
|
|
|
|
subscriptions.add_signature_subscription(
|
|
past_bank_tx.signatures[0],
|
|
Some(CommitmentConfig::recent()),
|
|
SubscriptionId::Number(1 as u64),
|
|
past_bank_sub1,
|
|
);
|
|
subscriptions.add_signature_subscription(
|
|
past_bank_tx.signatures[0],
|
|
Some(CommitmentConfig::root()),
|
|
SubscriptionId::Number(2 as u64),
|
|
past_bank_sub2,
|
|
);
|
|
subscriptions.add_signature_subscription(
|
|
processed_tx.signatures[0],
|
|
Some(CommitmentConfig::recent()),
|
|
SubscriptionId::Number(3 as u64),
|
|
processed_sub,
|
|
);
|
|
subscriptions.add_signature_subscription(
|
|
unprocessed_tx.signatures[0],
|
|
Some(CommitmentConfig::recent()),
|
|
SubscriptionId::Number(4 as u64),
|
|
Subscriber::new_test("signatureNotification").0,
|
|
);
|
|
|
|
{
|
|
let sig_subs = subscriptions
|
|
.subscriptions
|
|
.signature_subscriptions
|
|
.read()
|
|
.unwrap();
|
|
assert_eq!(sig_subs.get(&past_bank_tx.signatures[0]).unwrap().len(), 2);
|
|
assert!(sig_subs.contains_key(&unprocessed_tx.signatures[0]));
|
|
assert!(sig_subs.contains_key(&processed_tx.signatures[0]));
|
|
}
|
|
|
|
subscriptions.notify_subscribers(1);
|
|
let expected_res = RpcSignatureResult { err: None };
|
|
|
|
struct Notification {
|
|
slot: Slot,
|
|
id: u64,
|
|
}
|
|
|
|
let expected_notification = |exp: Notification| -> String {
|
|
let json = json!({
|
|
"jsonrpc": "2.0",
|
|
"method": "signatureNotification",
|
|
"params": {
|
|
"result": {
|
|
"context": { "slot": exp.slot },
|
|
"value": &expected_res,
|
|
},
|
|
"subscription": exp.id,
|
|
}
|
|
});
|
|
serde_json::to_string(&json).unwrap()
|
|
};
|
|
|
|
// Expect to receive a notification from bank 1 because this subscription is
|
|
// looking for 0 confirmations and so checks the current bank
|
|
let expected = expected_notification(Notification { slot: 1, id: 1 });
|
|
let (response, _) = robust_poll_or_panic(past_bank_recv1);
|
|
assert_eq!(expected, response);
|
|
|
|
// Expect to receive a notification from bank 0 because this subscription is
|
|
// looking for 1 confirmation and so checks the past bank
|
|
let expected = expected_notification(Notification { slot: 0, id: 2 });
|
|
let (response, _) = robust_poll_or_panic(past_bank_recv2);
|
|
assert_eq!(expected, response);
|
|
|
|
let expected = expected_notification(Notification { slot: 1, id: 3 });
|
|
let (response, _) = robust_poll_or_panic(processed_recv);
|
|
assert_eq!(expected, response);
|
|
|
|
// Subscription should be automatically removed after notification
|
|
let sig_subs = subscriptions
|
|
.subscriptions
|
|
.signature_subscriptions
|
|
.read()
|
|
.unwrap();
|
|
assert!(!sig_subs.contains_key(&processed_tx.signatures[0]));
|
|
assert!(!sig_subs.contains_key(&past_bank_tx.signatures[0]));
|
|
|
|
// Unprocessed signature subscription should not be removed
|
|
assert_eq!(
|
|
sig_subs.get(&unprocessed_tx.signatures[0]).unwrap().len(),
|
|
1
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
#[serial]
|
|
fn test_check_slot_subscribe() {
|
|
let (subscriber, _id_receiver, transport_receiver) =
|
|
Subscriber::new_test("slotNotification");
|
|
let sub_id = SubscriptionId::Number(0 as u64);
|
|
let exit = Arc::new(AtomicBool::new(false));
|
|
let ledger_path = get_tmp_ledger_path!();
|
|
let blockstore = Arc::new(Blockstore::open(&ledger_path).unwrap());
|
|
let GenesisConfigInfo { genesis_config, .. } = create_genesis_config(10_000);
|
|
let bank = Bank::new(&genesis_config);
|
|
let bank_forks = Arc::new(RwLock::new(BankForks::new(0, bank)));
|
|
let subscriptions = RpcSubscriptions::new(
|
|
&exit,
|
|
bank_forks,
|
|
Arc::new(RwLock::new(
|
|
BlockCommitmentCache::new_for_tests_with_blockstore(blockstore),
|
|
)),
|
|
);
|
|
subscriptions.add_slot_subscription(sub_id.clone(), subscriber);
|
|
|
|
assert!(subscriptions
|
|
.subscriptions
|
|
.slot_subscriptions
|
|
.read()
|
|
.unwrap()
|
|
.contains_key(&sub_id));
|
|
|
|
subscriptions.notify_slot(0, 0, 0);
|
|
let (response, _) = robust_poll_or_panic(transport_receiver);
|
|
let expected_res = SlotInfo {
|
|
parent: 0,
|
|
slot: 0,
|
|
root: 0,
|
|
};
|
|
let expected_res_str =
|
|
serde_json::to_string(&serde_json::to_value(expected_res).unwrap()).unwrap();
|
|
let expected = format!(
|
|
r#"{{"jsonrpc":"2.0","method":"slotNotification","params":{{"result":{},"subscription":0}}}}"#,
|
|
expected_res_str
|
|
);
|
|
assert_eq!(expected, response);
|
|
|
|
subscriptions.remove_slot_subscription(&sub_id);
|
|
assert!(!subscriptions
|
|
.subscriptions
|
|
.slot_subscriptions
|
|
.read()
|
|
.unwrap()
|
|
.contains_key(&sub_id));
|
|
}
|
|
|
|
#[test]
|
|
#[serial]
|
|
fn test_check_root_subscribe() {
|
|
let (subscriber, _id_receiver, mut transport_receiver) =
|
|
Subscriber::new_test("rootNotification");
|
|
let sub_id = SubscriptionId::Number(0 as u64);
|
|
let exit = Arc::new(AtomicBool::new(false));
|
|
let ledger_path = get_tmp_ledger_path!();
|
|
let blockstore = Arc::new(Blockstore::open(&ledger_path).unwrap());
|
|
let GenesisConfigInfo { genesis_config, .. } = create_genesis_config(10_000);
|
|
let bank = Bank::new(&genesis_config);
|
|
let bank_forks = Arc::new(RwLock::new(BankForks::new(0, bank)));
|
|
let subscriptions = RpcSubscriptions::new(
|
|
&exit,
|
|
bank_forks,
|
|
Arc::new(RwLock::new(
|
|
BlockCommitmentCache::new_for_tests_with_blockstore(blockstore),
|
|
)),
|
|
);
|
|
subscriptions.add_root_subscription(sub_id.clone(), subscriber);
|
|
|
|
assert!(subscriptions
|
|
.subscriptions
|
|
.root_subscriptions
|
|
.read()
|
|
.unwrap()
|
|
.contains_key(&sub_id));
|
|
|
|
subscriptions.notify_roots(vec![2, 1, 3]);
|
|
|
|
for expected_root in 1..=3 {
|
|
let (response, receiver) = robust_poll_or_panic(transport_receiver);
|
|
transport_receiver = receiver;
|
|
let expected_res_str =
|
|
serde_json::to_string(&serde_json::to_value(expected_root).unwrap()).unwrap();
|
|
let expected = format!(
|
|
r#"{{"jsonrpc":"2.0","method":"rootNotification","params":{{"result":{},"subscription":0}}}}"#,
|
|
expected_res_str
|
|
);
|
|
assert_eq!(expected, response);
|
|
}
|
|
|
|
subscriptions.remove_root_subscription(&sub_id);
|
|
assert!(!subscriptions
|
|
.subscriptions
|
|
.root_subscriptions
|
|
.read()
|
|
.unwrap()
|
|
.contains_key(&sub_id));
|
|
}
|
|
|
|
#[test]
|
|
#[serial]
|
|
fn test_add_and_remove_subscription() {
|
|
let mut subscriptions: HashMap<u64, HashMap<SubscriptionId, SubscriptionData<()>>> =
|
|
HashMap::new();
|
|
|
|
let num_keys = 5;
|
|
for key in 0..num_keys {
|
|
let (subscriber, _id_receiver, _transport_receiver) =
|
|
Subscriber::new_test("notification");
|
|
let sub_id = SubscriptionId::Number(key);
|
|
add_subscription(&mut subscriptions, key, None, sub_id, subscriber, 0);
|
|
}
|
|
|
|
// Add another subscription to the "0" key
|
|
let (subscriber, _id_receiver, _transport_receiver) = Subscriber::new_test("notification");
|
|
let extra_sub_id = SubscriptionId::Number(num_keys);
|
|
add_subscription(
|
|
&mut subscriptions,
|
|
0,
|
|
None,
|
|
extra_sub_id.clone(),
|
|
subscriber,
|
|
0,
|
|
);
|
|
|
|
assert_eq!(subscriptions.len(), num_keys as usize);
|
|
assert_eq!(subscriptions.get(&0).unwrap().len(), 2);
|
|
assert_eq!(subscriptions.get(&1).unwrap().len(), 1);
|
|
|
|
assert_eq!(
|
|
remove_subscription(&mut subscriptions, &SubscriptionId::Number(0)),
|
|
true
|
|
);
|
|
assert_eq!(subscriptions.len(), num_keys as usize);
|
|
assert_eq!(subscriptions.get(&0).unwrap().len(), 1);
|
|
assert_eq!(
|
|
remove_subscription(&mut subscriptions, &SubscriptionId::Number(0)),
|
|
false
|
|
);
|
|
|
|
assert_eq!(remove_subscription(&mut subscriptions, &extra_sub_id), true);
|
|
assert_eq!(subscriptions.len(), (num_keys - 1) as usize);
|
|
assert!(subscriptions.get(&0).is_none());
|
|
}
|
|
}
|