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
// Copyright (C) 2019-2023 Aleo Systems Inc.
// This file is part of the Aleo SDK library.
// The Aleo SDK library 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.
// The Aleo SDK library 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 the Aleo SDK library. If not, see <https://www.gnu.org/licenses/>.
//! API clients for interacting with Aleo Network endpoints
use super::*;
pub mod blocking;
pub use blocking::*;
/// Aleo API client for interacting with the Aleo Beacon API
#[derive(Clone, Debug)]
pub struct AleoAPIClient<N: Network> {
client: ureq::Agent,
base_url: String,
network_id: String,
_network: PhantomData<N>,
}
impl<N: Network> AleoAPIClient<N> {
pub fn new(base_url: &str, chain: &str) -> Result<Self> {
let client = ureq::Agent::new();
ensure!(
base_url.starts_with("http://") || base_url.starts_with("https://"),
"specified url {base_url} invalid, the base url must start with or https:// (or http:// if doing local development)"
);
Ok(AleoAPIClient {
client,
base_url: base_url.to_string(),
network_id: chain.to_string(),
_network: PhantomData,
})
}
pub fn testnet3() -> Self {
Self::new("https://vm.aleo.org/api", "testnet3").unwrap()
}
pub fn local_testnet3(port: &str) -> Self {
Self::new(&format!("http://localhost:{}", port), "testnet3").unwrap()
}
/// Get base URL
pub fn base_url(&self) -> &str {
&self.base_url
}
/// Get network ID being interacted with
pub fn network_id(&self) -> &str {
&self.network_id
}
}