use canic_core::{bootstrap::parse_config_model, ids::CanisterRole};
use std::{
collections::{BTreeMap, BTreeSet},
fs,
path::Path,
};
#[derive(Clone, Copy)]
enum RootSubnetRoleScope {
Release,
Fleet,
}
const DEFAULT_INITIAL_CYCLES: u128 = 5_000_000_000_000;
const DEFAULT_RANDOMNESS_RESEED_INTERVAL_SECS: u64 = 3600;
const TENTH_TC: u128 = 100_000_000_000;
impl RootSubnetRoleScope {
const fn includes_root(self) -> bool {
matches!(self, Self::Fleet)
}
}
pub fn configured_release_roles(
config_path: &Path,
) -> Result<Vec<String>, Box<dyn std::error::Error>> {
let config_source = fs::read_to_string(config_path)?;
configured_release_roles_from_source(&config_source)
.map_err(|err| format!("invalid {}: {err}", config_path.display()).into())
}
pub fn configured_fleet_roles(
config_path: &Path,
) -> Result<Vec<String>, Box<dyn std::error::Error>> {
let config_source = fs::read_to_string(config_path)?;
configured_fleet_roles_from_source(&config_source)
.map_err(|err| format!("invalid {}: {err}", config_path.display()).into())
}
pub fn configured_install_targets(
config_path: &Path,
root_canister: &str,
) -> Result<Vec<String>, Box<dyn std::error::Error>> {
let mut targets = vec![root_canister.to_string()];
targets.extend(configured_release_roles(config_path)?);
Ok(targets)
}
pub fn configured_fleet_name(config_path: &Path) -> Result<String, Box<dyn std::error::Error>> {
let config_source = fs::read_to_string(config_path)?;
configured_fleet_name_from_source(&config_source)
.map_err(|err| format!("invalid {}: {err}", config_path.display()).into())
}
pub fn configured_role_kinds(
config_path: &Path,
) -> Result<BTreeMap<String, String>, Box<dyn std::error::Error>> {
let config_source = fs::read_to_string(config_path)?;
configured_role_kinds_from_source(&config_source)
.map_err(|err| format!("invalid {}: {err}", config_path.display()).into())
}
pub fn configured_role_capabilities(
config_path: &Path,
) -> Result<BTreeMap<String, Vec<String>>, Box<dyn std::error::Error>> {
let config_source = fs::read_to_string(config_path)?;
configured_role_capabilities_from_source(&config_source)
.map_err(|err| format!("invalid {}: {err}", config_path.display()).into())
}
pub fn configured_role_auto_create(
config_path: &Path,
) -> Result<BTreeSet<String>, Box<dyn std::error::Error>> {
let config_source = fs::read_to_string(config_path)?;
configured_role_auto_create_from_source(&config_source)
.map_err(|err| format!("invalid {}: {err}", config_path.display()).into())
}
pub fn configured_role_topups(
config_path: &Path,
) -> Result<BTreeMap<String, String>, Box<dyn std::error::Error>> {
let config_source = fs::read_to_string(config_path)?;
configured_role_topups_from_source(&config_source)
.map_err(|err| format!("invalid {}: {err}", config_path.display()).into())
}
pub fn configured_role_details(
config_path: &Path,
) -> Result<BTreeMap<String, Vec<String>>, Box<dyn std::error::Error>> {
let config_source = fs::read_to_string(config_path)?;
configured_role_details_from_source(&config_source)
.map_err(|err| format!("invalid {}: {err}", config_path.display()).into())
}
pub(super) fn configured_role_kinds_from_source(
config_source: &str,
) -> Result<BTreeMap<String, String>, Box<dyn std::error::Error>> {
let config = parse_config_model(config_source).map_err(|err| err.to_string())?;
let mut kinds = BTreeMap::<String, String>::new();
for subnet in config.subnets.values() {
for (role, canister) in &subnet.canisters {
let role = role.as_str().to_string();
let kind = canister.kind.to_string();
match kinds.get(&role) {
Some(existing) if existing != &kind => {
kinds.insert(role, "mixed".to_string());
}
Some(_) => {}
None => {
kinds.insert(role, kind);
}
}
}
}
Ok(kinds)
}
pub(super) fn configured_role_capabilities_from_source(
config_source: &str,
) -> Result<BTreeMap<String, Vec<String>>, Box<dyn std::error::Error>> {
let config = parse_config_model(config_source).map_err(|err| err.to_string())?;
let mut capabilities = BTreeMap::<String, BTreeSet<String>>::new();
for subnet in config.subnets.values() {
for (role, canister) in &subnet.canisters {
let mut role_capabilities = BTreeSet::new();
if canister.auth.delegated_token_signer || canister.auth.role_attestation_cache {
role_capabilities.insert("auth".to_string());
}
if canister.sharding.is_some() {
role_capabilities.insert("sharding".to_string());
}
if canister.scaling.is_some() {
role_capabilities.insert("scaling".to_string());
}
if canister.directory.is_some() {
role_capabilities.insert("directory".to_string());
}
if canister.standards.icrc21 {
role_capabilities.insert("icrc21".to_string());
}
if !role_capabilities.is_empty() {
capabilities
.entry(role.as_str().to_string())
.or_default()
.extend(role_capabilities);
}
}
}
Ok(capabilities
.into_iter()
.map(|(role, capabilities)| (role, capabilities.into_iter().collect()))
.collect())
}
pub(super) fn configured_role_auto_create_from_source(
config_source: &str,
) -> Result<BTreeSet<String>, Box<dyn std::error::Error>> {
let config = parse_config_model(config_source).map_err(|err| err.to_string())?;
let mut auto_create = BTreeSet::<String>::new();
for subnet in config.subnets.values() {
auto_create.extend(
subnet
.auto_create
.iter()
.map(|role| role.as_str().to_string()),
);
}
Ok(auto_create)
}
pub(super) fn configured_role_topups_from_source(
config_source: &str,
) -> Result<BTreeMap<String, String>, Box<dyn std::error::Error>> {
let config = parse_config_model(config_source).map_err(|err| err.to_string())?;
let mut topups = BTreeMap::<String, String>::new();
for subnet in config.subnets.values() {
for (role, canister) in &subnet.canisters {
if let Some(policy) = &canister.topup_policy {
topups.insert(
role.as_str().to_string(),
format!(
"{} @ {}",
format_cycles_tenths(policy.amount.to_u128()),
format_cycles_tenths(policy.threshold.to_u128())
),
);
}
}
}
Ok(topups)
}
pub(super) fn configured_role_details_from_source(
config_source: &str,
) -> Result<BTreeMap<String, Vec<String>>, Box<dyn std::error::Error>> {
let config = parse_config_model(config_source).map_err(|err| err.to_string())?;
let mut details = BTreeMap::<String, BTreeSet<String>>::new();
for role in &config.app_index {
details
.entry(role.as_str().to_string())
.or_default()
.insert("app_index".to_string());
}
for subnet in config.subnets.values() {
for role in &subnet.auto_create {
details
.entry(role.as_str().to_string())
.or_default()
.insert("auto_create".to_string());
}
for role in &subnet.subnet_index {
details
.entry(role.as_str().to_string())
.or_default()
.insert("subnet_index".to_string());
}
for (role, canister) in &subnet.canisters {
let role_details = details.entry(role.as_str().to_string()).or_default();
if canister.initial_cycles.to_u128() != DEFAULT_INITIAL_CYCLES {
role_details.insert(format!("initial_cycles={}", canister.initial_cycles));
}
if !canister.randomness.enabled {
role_details.insert("randomness=off".to_string());
} else if randomness_source_label(canister.randomness.source) != "ic"
|| canister.randomness.reseed_interval_secs
!= DEFAULT_RANDOMNESS_RESEED_INTERVAL_SECS
{
role_details.insert(format!(
"randomness={} reseed={}s",
randomness_source_label(canister.randomness.source),
canister.randomness.reseed_interval_secs
));
}
if canister.auth.delegated_token_signer {
role_details.insert("auth delegated-token-signer".to_string());
}
if canister.auth.role_attestation_cache {
role_details.insert("auth role-attestation-cache".to_string());
}
if canister.standards.icrc21 {
role_details.insert("standard icrc21".to_string());
}
if let Some(scaling) = &canister.scaling {
for (pool_name, pool) in &scaling.pools {
role_details.insert(format!(
"scaling {pool_name}->{} initial={} min={} max={}",
pool.canister_role.as_str(),
pool.policy.initial_workers,
pool.policy.min_workers,
pool.policy.max_workers
));
}
}
if let Some(sharding) = &canister.sharding {
for (pool_name, pool) in &sharding.pools {
role_details.insert(format!(
"sharding {pool_name}->{} cap={} initial={} max={}",
pool.canister_role.as_str(),
pool.policy.capacity,
pool.policy.initial_shards,
pool.policy.max_shards
));
}
}
if let Some(directory) = &canister.directory {
for (pool_name, pool) in &directory.pools {
role_details.insert(format!(
"directory {pool_name}->{} key={}",
pool.canister_role.as_str(),
pool.key_name
));
}
}
}
}
Ok(details
.into_iter()
.filter(|(_, details)| !details.is_empty())
.map(|(role, details)| (role, details.into_iter().collect()))
.collect())
}
fn randomness_source_label(source: impl std::fmt::Debug) -> String {
format!("{source:?}").to_ascii_lowercase()
}
fn format_cycles_tenths(cycles: u128) -> String {
let tenths = cycles.saturating_add(TENTH_TC / 2) / TENTH_TC;
format!("{}.{}TC", tenths / 10, tenths % 10)
}
pub(super) fn configured_fleet_name_from_source(
config_source: &str,
) -> Result<String, Box<dyn std::error::Error>> {
let config = parse_config_model(config_source).map_err(|err| err.to_string())?;
let name = config
.fleet
.and_then(|fleet| fleet.name)
.ok_or_else(|| "missing required [fleet].name in canic.toml".to_string())?;
Ok(name)
}
pub(super) fn configured_release_roles_from_source(
config_source: &str,
) -> Result<Vec<String>, Box<dyn std::error::Error>> {
configured_root_subnet_roles_from_source(config_source, RootSubnetRoleScope::Release)
}
pub(super) fn configured_fleet_roles_from_source(
config_source: &str,
) -> Result<Vec<String>, Box<dyn std::error::Error>> {
configured_root_subnet_roles_from_source(config_source, RootSubnetRoleScope::Fleet)
}
fn configured_root_subnet_roles_from_source(
config_source: &str,
scope: RootSubnetRoleScope,
) -> Result<Vec<String>, Box<dyn std::error::Error>> {
let config = parse_config_model(config_source).map_err(|err| err.to_string())?;
let mut root_subnet_roles = None;
for (subnet_role, subnet) in &config.subnets {
if !subnet.canisters.keys().any(CanisterRole::is_root) {
continue;
}
if root_subnet_roles.is_some() {
return Err(format!(
"multiple subnets define a root canister; expected exactly one root subnet (found at least '{subnet_role}')"
)
.into());
}
root_subnet_roles = Some(
subnet
.canisters
.keys()
.filter(|role| !role.is_wasm_store())
.filter(|role| scope.includes_root() || !role.is_root())
.map(|role| role.as_str().to_string())
.collect::<Vec<_>>(),
);
}
let root_subnet_roles = root_subnet_roles.ok_or_else(|| {
"no subnet defines a root canister; expected exactly one root subnet".to_string()
})?;
Ok(sort_root_subnet_roles(root_subnet_roles))
}
fn sort_root_subnet_roles(mut roles: Vec<String>) -> Vec<String> {
roles.sort_by(|left, right| {
match (
left == CanisterRole::ROOT.as_str(),
right == CanisterRole::ROOT.as_str(),
) {
(true, false) => std::cmp::Ordering::Less,
(false, true) => std::cmp::Ordering::Greater,
_ => left.cmp(right),
}
});
roles
}