nautilus_finfeed/common/credential.rs
1// -------------------------------------------------------------------------------------------------
2// Copyright (C) 2015-2026 Nautech Systems Pty Ltd. All rights reserved.
3// https://nautechsystems.io
4//
5// Licensed under the GNU Lesser General Public License Version 3.0 (the "License");
6// You may not use this file except in compliance with the License.
7// You may obtain a copy of the License at https://www.gnu.org/licenses/lgpl-3.0.en.html
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14// -------------------------------------------------------------------------------------------------
15
16//! FinFeed credential resolution at construction.
17
18use nautilus_core::string::secret::SecretString;
19
20use crate::http::error::Error;
21
22/// Default environment source for prediction-market access.
23pub const FINFEED_API_KEY: &str = "FINFEED_API_KEY";
24
25/// Resolves an explicit key or reads `FINFEED_API_KEY` once.
26///
27/// # Errors
28///
29/// Returns an error if the key is missing, empty, or contains anything other than visible ASCII characters.
30pub fn resolve_api_key(api_key: Option<SecretString>) -> Result<SecretString, Error> {
31 let api_key = match api_key {
32 Some(api_key) => api_key,
33 None => std::env::var(FINFEED_API_KEY)
34 .map(SecretString::from)
35 .map_err(|_| Error::Validation("set api_key or FINFEED_API_KEY".into()))?,
36 };
37
38 if api_key.expose_secret().is_empty()
39 || !api_key
40 .expose_secret()
41 .bytes()
42 .all(|b| (33..=126).contains(&b))
43 {
44 return Err(Error::Validation(
45 "API key must contain visible ASCII".into(),
46 ));
47 }
48
49 Ok(api_key)
50}