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
//! Example ContextProvider that uses the Core gRPC API to fetch data from Platform.
use crate::core_client::CoreClient;
use crate::platform::Fetch;
use crate::{Error, Sdk};
use arc_swap::ArcSwapAny;
use dpp::prelude::{CoreBlockHeight, DataContract, Identifier};
use drive_proof_verifier::error::ContextProviderError;
use drive_proof_verifier::ContextProvider;
use pollster::FutureExt;
use std::hash::Hash;
use std::num::NonZeroUsize;
use std::sync::Arc;
/// Context provider that uses the Core gRPC API to fetch data from Platform.
///
/// Example [ContextProvider] used by the Sdk for testing purposes.
pub struct GrpcContextProvider {
/// Core client
core: CoreClient,
/// [Sdk] to use when fetching data from Platform
///
/// Note that if the `sdk` is `None`, the context provider will not be able to fetch data itself and will rely on
/// values set by the user in the caches: `data_contracts_cache`, `quorum_public_keys_cache`.
///
/// We use [Arc] as we have circular dependencies between Sdk and ContextProvider.
sdk: ArcSwapAny<Arc<Option<Sdk>>>,
/// Data contracts cache.
///
/// Users can insert new data contracts into the cache using [`Cache::put`].
pub data_contracts_cache: Cache<Identifier, dpp::data_contract::DataContract>,
/// Quorum public keys cache.
///
/// Key is a tuple of quorum hash and quorum type. Value is a quorum public key.
///
/// Users can insert new quorum public keys into the cache using [`Cache::put`].
pub quorum_public_keys_cache: Cache<([u8; 32], u32), [u8; 48]>,
/// Directory where to store dumped data.
///
/// This is used to store data that is fetched from Platform and can be used for testing purposes.
#[cfg(feature = "mocks")]
pub dump_dir: Option<std::path::PathBuf>,
}
impl GrpcContextProvider {
/// Create new context provider.
///
/// Note that if the `sdk` is `None`, the context provider will not be able to fetch data itself and will rely on
/// values set by the user in the caches: `data_contracts_cache`, `quorum_public_keys_cache`.
///
/// Sdk can be set later with [`GrpcContextProvider::set_sdk`].
pub fn new(
sdk: Option<Sdk>,
core_ip: &str,
core_port: u16,
core_user: &str,
core_password: &str,
data_contracts_cache_size: NonZeroUsize,
quorum_public_keys_cache_size: NonZeroUsize,
) -> Result<Self, Error> {
let core_client = CoreClient::new(core_ip, core_port, core_user, core_password)?;
Ok(Self {
core: core_client,
sdk: ArcSwapAny::new(Arc::new(sdk)),
data_contracts_cache: Cache::new(data_contracts_cache_size),
quorum_public_keys_cache: Cache::new(quorum_public_keys_cache_size),
#[cfg(feature = "mocks")]
dump_dir: None,
})
}
/// Set the Sdk to use when fetching data from Platform.
/// This is useful when the Sdk is created after the ContextProvider.
///
/// Note that if the `sdk` is `None`, the context provider will not be able to fetch data itself and will rely on
/// values set by the user in the caches: `data_contracts_cache`, `quorum_public_keys_cache`.
pub fn set_sdk(&self, sdk: Option<Sdk>) {
self.sdk.store(Arc::new(sdk));
}
/// Set the directory where to store dumped data.
///
/// When set, the context provider will store data fetched from Platform into this directory.
#[cfg(feature = "mocks")]
pub fn set_dump_dir(&mut self, dump_dir: Option<std::path::PathBuf>) {
self.dump_dir = dump_dir;
}
/// Save quorum public key to disk.
///
/// Files are named: `quorum_pubkey-<int_quorum_type>-<hex_quorum_hash>.json`
///
/// Note that this will overwrite files with the same quorum type and quorum hash.
///
/// Any errors are logged on `warn` level and ignored.
#[cfg(feature = "mocks")]
fn dump_quorum_public_key(
&self,
quorum_type: u32,
quorum_hash: [u8; 32],
_core_chain_locked_height: u32,
public_key: &[u8],
) {
use hex::ToHex;
let path = match &self.dump_dir {
Some(p) => p,
None => return,
};
let encoded = hex::encode(public_key);
let file = path.join(format!(
"quorum_pubkey-{}-{}.json",
quorum_type,
quorum_hash.encode_hex::<String>()
));
if let Err(e) = std::fs::write(file, encoded) {
tracing::warn!("Unable to write dump file {:?}: {}", path, e);
}
}
/// Save data contract to disk.
///
/// Files are named: `quorum_pubkey-<int_quorum_type>-<hex_quorum_hash>.json`
///
/// Note that this will overwrite files with the same quorum type and quorum hash.
///
/// Any errors are logged on `warn` level and ignored.
#[cfg(feature = "mocks")]
fn dump_data_contract(&self, data_contract: &DataContract) {
use dpp::data_contract::accessors::v0::DataContractV0Getters;
use hex::ToHex;
let path = match &self.dump_dir {
Some(p) => p,
None => return,
};
let id = data_contract.id();
let file = path.join(format!("data_contract-{}.json", id.encode_hex::<String>()));
let encoded = serde_json::to_vec(data_contract).expect("serialize data contract");
if let Err(e) = std::fs::write(file, encoded) {
tracing::warn!("Unable to write dump file {:?}: {}", path, e);
}
}
}
impl ContextProvider for GrpcContextProvider {
fn get_quorum_public_key(
&self,
quorum_type: u32,
quorum_hash: [u8; 32], // quorum hash is 32 bytes
core_chain_locked_height: u32,
) -> Result<[u8; 48], ContextProviderError> {
if let Some(key) = self
.quorum_public_keys_cache
.get(&(quorum_hash, quorum_type))
{
return Ok(*key);
};
let key = self.core.get_quorum_public_key(quorum_type, quorum_hash)?;
self.quorum_public_keys_cache
.put((quorum_hash, quorum_type), key);
#[cfg(feature = "mocks")]
self.dump_quorum_public_key(quorum_type, quorum_hash, core_chain_locked_height, &key);
Ok(key)
}
fn get_data_contract(
&self,
data_contract_id: &Identifier,
) -> Result<Option<Arc<DataContract>>, ContextProviderError> {
if let Some(contract) = self.data_contracts_cache.get(data_contract_id) {
return Ok(Some(contract));
};
let sdk_guard = self.sdk.load();
let sdk = match sdk_guard.as_ref() {
Some(sdk) => sdk,
None => {
tracing::warn!("data contract cache miss and no sdk provided, skipping fetch");
return Ok(None);
}
};
let contract_id = *data_contract_id;
let sdk_cloned = sdk.clone();
let data_contract: Option<DataContract> = DataContract::fetch(&sdk_cloned, contract_id)
.block_on()
.map_err(|e| ContextProviderError::DataContractFailure(e.to_string()))?;
if let Some(ref dc) = data_contract {
self.data_contracts_cache.put(*data_contract_id, dc.clone());
};
#[cfg(feature = "mocks")]
if let Some(ref dc) = data_contract {
self.dump_data_contract(dc);
}
Ok(data_contract.map(Arc::new))
}
fn get_platform_activation_height(&self) -> Result<CoreBlockHeight, ContextProviderError> {
self.core.get_platform_activation_height()
}
}
/// Thread-safe cache of various objects inside the SDK.
///
/// This is used to cache objects that are expensive to fetch from Platform, like data contracts.
pub struct Cache<K: Hash + Eq, V> {
// We use a Mutex to allow access to the cache when we don't have mutable &self
// And we use Arc to allow multiple threads to access the cache without having to clone it
inner: std::sync::RwLock<lru::LruCache<K, Arc<V>>>,
}
impl<K: Hash + Eq, V> Cache<K, V> {
/// Create new cache
pub fn new(capacity: NonZeroUsize) -> Self {
Self {
// inner: std::sync::Mutex::new(lru::LruCache::new(capacity)),
inner: std::sync::RwLock::new(lru::LruCache::new(capacity)),
}
}
/// Get a reference to the value stored under `k`.
pub fn get(&self, k: &K) -> Option<Arc<V>> {
let mut guard = self.inner.write().expect("cache lock poisoned");
guard.get(k).map(Arc::clone)
}
/// Insert a new value into the cache.
pub fn put(&self, k: K, v: V) {
let mut guard = self.inner.write().expect("cache lock poisoned");
guard.put(k, Arc::new(v));
}
}