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
use crate::{
chain::{Chain, ChainId},
event_submission::RateLimit,
util::ApiUrl,
Address, BigNum, ChainOf, ValidatorId,
};
use once_cell::sync::Lazy;
use serde::{Deserialize, Serialize};
use std::{collections::HashMap, num::NonZeroU8, time::Duration};
use thiserror::Error;
pub use toml::de::Error as TomlError;
/// Production configuration found in `docs/config/prod.toml`
///
/// ```toml
#[doc = include_str!("../../docs/config/prod.toml")]
/// ```
pub static PRODUCTION_CONFIG: Lazy<Config> = Lazy::new(|| {
toml::from_str(include_str!("../../docs/config/prod.toml"))
.expect("Failed to parse prod.toml config file")
});
/// Ganache (dev) configuration found in `docs/config/ganache.toml`
///
/// ```toml
#[doc = include_str!("../../docs/config/ganache.toml")]
/// ```
pub static GANACHE_CONFIG: Lazy<Config> = Lazy::new(|| {
Config::try_toml(include_str!("../../docs/config/ganache.toml"))
.expect("Failed to parse ganache.toml config file")
});
/// The environment in which the application is running
/// Defaults to [`Environment::Development`]
#[derive(Debug, Deserialize, PartialEq, Eq, Clone, Copy)]
#[serde(rename_all = "camelCase")]
pub enum Environment {
/// The default development setup is running `ganache-cli` locally.
Development,
Production,
}
impl Default for Environment {
fn default() -> Self {
Self::Development
}
}
/// Examples:
/// ```
#[doc = include_str!("../../primitives/examples/get_cfg_response.rs")]
/// ```
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq)]
pub struct Config {
/// Values used for the validator worker
pub worker: ValidatorWorkerConfig,
/// Values used for the sentry
pub sentry: SentryConfig,
/// An optional whitelisted addresses for [`Campaign.creator`](crate::Campaign::creator)s.
///
/// If empty, any address will be allowed to create a [`Campaign`](crate::Campaign).
pub creators_whitelist: Vec<Address>,
/// An optional whitelisted Validator addresses for [`Campaign.validators`](crate::Campaign::validators).
///
/// If empty, any address will be allowed to be a validator in a [`Campaign`](crate::Campaign).
pub validators_whitelist: Vec<ValidatorId>,
/// The key of this map is a human-readable text of the Chain name
/// for readability in the configuration file.
///
/// - To get the chain of a token address use [`Config::find_chain_of()`].
///
/// - To get a [`ChainInfo`] only by a [`ChainId`] use [`Config::find_chain()`].
///
/// **NOTE:** Make sure that a Token [`Address`] is unique across all Chains,
/// otherwise [`Config::find_chain_of()`] will fetch only one of them and cause unexpected problems.
#[serde(rename = "chain")]
pub chains: HashMap<String, ChainInfo>,
/// Any limits applied to Sentry or Validator.
pub limits: Limits,
}
impl Config {
/// Utility method that will deserialize a Toml file content into a [`Config`].
///
/// Rather than relying on the `toml` crate directly, use this method instead.
pub fn try_toml(toml: &str) -> Result<Self, TomlError> {
toml::from_str(toml)
}
/// Finds a [`Chain`] based on the [`ChainId`].
pub fn find_chain(&self, chain_id: ChainId) -> Option<&ChainInfo> {
self.chains
.values()
.find(|chain_info| chain_info.chain.chain_id == chain_id)
}
/// Finds the pair of Chain & Token, given only a token [`Address`].
pub fn find_chain_of(&self, token: Address) -> Option<ChainOf<()>> {
self.chains.values().find_map(|chain_info| {
chain_info
.tokens
.values()
.find(|token_info| token_info.address == token)
.map(|token_info| ChainOf::new(chain_info.chain.clone(), token_info.clone()))
})
}
}
/// Config values that are used in the sentry only
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq)]
pub struct SentryConfig {
/// A timeout to be used when collecting the Analytics for a request:
/// - GET `/v5/analytics`
/// - GET `/v5/analytics/for-publisher`
/// - GET `/v5/analytics/for-advertiser`
/// - GET `/v5/analytics/for-admin`
///
/// In milliseconds
#[serde(with = "std_duration_millis")]
pub analytics_maxtime: Duration,
pub admins: Vec<Address>,
pub platform: PlatformConfig,
}
/// Config values that are used in the validator worker only
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq)]
pub struct ValidatorWorkerConfig {
/// The maximum number of [`Channel`](crate::Channel)s that the worker
/// can process for one tick.
pub max_channels: u32,
/// The Validator Worker tick time.
///
/// The [`Channel`](crate::Channel)s' tick and the wait time should both
/// finish before running a new tick in the Validator Worker.
///
/// In milliseconds
#[serde(with = "std_duration_millis")]
pub wait_time: Duration,
/// The amount of time that should have passed before sending a new heartbeat.
///
/// In milliseconds
#[serde(with = "std_duration_millis")]
pub heartbeat_time: Duration,
/// The pro miles below which the [`ApproveState`](crate::validator::ApproveState)
/// becomes **unhealthy** in the [`Channel`](crate::Channel)'s Follower.
///
/// Also see: [`ApproveState.is_healthy`](crate::validator::ApproveState::is_healthy)
///
/// In pro milles (<= 1000)
pub health_threshold_promilles: u32,
/// The pro milles below which the [`ApproveState`](crate::validator::ApproveState)
/// will not be triggered and instead a [`RejectState`](crate::validator::RejectState)
/// will be propagated by the [`Channel`](crate::Channel)'s Follower.
///
/// In pro milles (<= 1000)
pub health_unsignable_promilles: u32,
pub timeouts: Timeouts,
}
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq)]
pub struct PlatformConfig {
pub url: ApiUrl,
#[serde(with = "std_duration_millis")]
pub keep_alive_interval: Duration,
}
/// Configured chain with tokens.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct ChainInfo {
#[serde(flatten)]
pub chain: Chain,
/// A Chain should always have whitelisted tokens configured,
/// otherwise there is no reason to have the chain set up.
#[serde(rename = "token")]
pub tokens: HashMap<String, TokenInfo>,
}
impl ChainInfo {
pub fn find_token(&self, token: Address) -> Option<&TokenInfo> {
self.tokens
.values()
.find(|token_info| token_info.address == token)
}
}
/// Configured Token in a specific [`Chain`].
/// Precision can differ for the same token from one [`Chain`] to another.
#[derive(Serialize, Deserialize, Debug, Clone, Eq, PartialEq, Hash)]
pub struct TokenInfo {
pub min_campaign_budget: BigNum,
pub min_validator_fee: BigNum,
pub precision: NonZeroU8,
pub address: Address,
}
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq)]
pub struct Limits {
pub units_for_slot: limits::UnitsForSlot,
/// The maximum number of [`Campaign`](crate::Campaign)s per page
/// returned by Sentry's GET `/v5/campaign/list` route.
///
/// Also see: [`CampaignListResponse`](crate::sentry::campaign_list::CampaignListResponse)
pub campaigns_find: u32,
/// The maximum number of [`Spender`](crate::spender::Spender)s per page
/// returned by Sentry's GET `/v5/channel/0xXXX.../spender/all` route.
///
/// Also see: [`AllSpendersResponse`](crate::sentry::AllSpendersResponse)
pub spendable_find: u32,
/// The maximum number of [`Channel`](crate::Channel)s per page
/// returned by Sentry's GET `/v5/channel/list` route.
///
/// Also see: [`ChannelListResponse`](crate::sentry::channel_list::ChannelListResponse)
pub channels_find: u32,
/// The maximum allowed limit of [`FetchedAnalytics`](crate::sentry::FetchedAnalytics)s per page
/// returned by Sentry's GET `/v5/analytics` routes:
///
/// - GET `/v5/analytics`
/// - GET `/v5/analytics/for-publisher`
/// - GET `/v5/analytics/for-advertiser`
/// - GET `/v5/analytics/for-admin`
///
/// Request query also has a `limit` parameter, which can be used to return
/// <= `limits.analytics_find` messages in the request.
///
/// Also see: [`AnalyticsQuery`](crate::analytics::AnalyticsQuery)
pub analytics_find: u32,
/// The maximum allowed limit of [`ValidatorMessage`](crate::sentry::validator_messages::ValidatorMessage)s per page
/// returned by Sentry's GET `/v5/channel/0xXXX.../validator-messages` route.
///
/// Request query also has a `limit` parameter, which can be used to return
/// <= `limits.msgs_find` messages in the request.
///
/// Also see: [`ValidatorMessagesListResponse`](crate::sentry::validator_messages::ValidatorMessagesListResponse),
/// [`ValidatorMessagesListQuery`](crate::sentry::validator_messages::ValidatorMessagesListQuery)
pub msgs_find: u32,
/// The default IP rate limit that will be imposed if
/// [`Campaign.event_submission`](crate::Campaign::event_submission) is [`None`].
pub ip_rate_limit: RateLimit,
}
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq)]
pub struct Timeouts {
/// Sets the timeout for propagating a Validator message ([`MessageTypes`](crate::validator::MessageTypes))
/// to a validator.
///
/// In milliseconds
#[serde(with = "std_duration_millis")]
pub propagation: Duration,
/// The Client timeout for `SentryApi`.
///
/// This includes all requests made to sentry except propagating messages.
/// When propagating messages we make requests to foreign Sentry
/// instances and we use a separate timeout -
/// [`Config.timeouts.propagation`](crate::config::Timeouts::propagation).
///
/// In milliseconds
#[serde(with = "std_duration_millis")]
pub fetch: Duration,
/// The Client timeout for `SentryApi` when collecting all channels
/// and Validators using the `/campaign/list` route.
///
/// In milliseconds
#[serde(with = "std_duration_millis")]
pub all_campaigns: Duration,
/// The timeout for a single tick of a [`Channel`](crate::Channel) in
/// the Validator Worker.
/// This timeout is applied to both the leader and follower ticks.
///
/// In milliseconds
#[serde(with = "std_duration_millis")]
pub channel_tick: Duration,
}
/// Module for [`Config`] (de)serialization of [`std::time::Duration`] from
/// and to milliseconds.
pub mod std_duration_millis {
use serde::{Deserialize, Deserializer, Serializer};
use std::time::Duration;
pub fn deserialize<'de, D>(deserializer: D) -> Result<Duration, D::Error>
where
D: Deserializer<'de>,
{
use serde::de::Error;
use toml::Value;
let toml_value: Value = Value::deserialize(deserializer)?;
let milliseconds = match toml_value {
Value::Integer(mills) => u64::try_from(mills).map_err(Error::custom),
_ => Err(Error::custom("Only integers allowed for this value")),
}?;
Ok(Duration::from_millis(milliseconds))
}
pub fn serialize<S>(duration: &Duration, serializer: S) -> Result<S::Ok, S::Error>
where
S: Serializer,
{
serializer.serialize_str(&duration.as_millis().to_string())
}
}
pub mod limits {
use serde::{Deserialize, Serialize};
use crate::UnifiedNum;
/// Limits applied to the `POST /units-for-slot` route
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq)]
pub struct UnitsForSlot {
/// The maximum number of campaigns a publisher can earn from.
/// This will limit the returned Campaigns to the set number.
#[serde(default)]
pub max_campaigns_earning_from: u16,
/// If the resulting targeting price is lower than this value,
/// it will filter out the given AdUnit.
pub global_min_impression_price: UnifiedNum,
}
}
#[derive(Debug, Error)]
pub enum ConfigError {
#[error("Toml parsing: {0}")]
Toml(#[from] toml::de::Error),
#[error("File reading: {0}")]
InvalidFile(#[from] std::io::Error),
}
/// If no `config_file` path is provided it will load the [`Environment`] configuration.
/// If `config_file` path is provided it will try to read and parse the file in Toml format.
pub fn configuration(
environment: Environment,
config_file: Option<&str>,
) -> Result<Config, ConfigError> {
match config_file {
Some(config_file) => {
let content = std::fs::read(config_file)?;
Ok(toml::from_slice(&content)?)
}
None => match environment {
Environment::Production => Ok(PRODUCTION_CONFIG.clone()),
Environment::Development => Ok(GANACHE_CONFIG.clone()),
},
}
}
#[cfg(test)]
mod test {
use super::{GANACHE_CONFIG, PRODUCTION_CONFIG};
/// Makes sure that both config files are correct and won't be left in a
/// broken state.
#[test]
fn correct_config_files() {
let _ganache = GANACHE_CONFIG.clone();
let _production = PRODUCTION_CONFIG.clone();
}
}