api cleanup

Author: kpinter-iohk

Cargo.lock

@@ -42,6 +42,7 @@ figment = { workspace = true }
 tokio = { workspace = true }
 derive-new = { workspace = true }
 chrono = { workspace = true }
+bech32 = { workspace = true }
 
 [features]
 default = []

toolkit/data-sources/dolos/Cargo.toml

@@ -107,12 +107,10 @@ impl AuthoritySelectionDataSource for AuthoritySelectionDataSourceImpl {
 		let candidates = self.get_registered_candidates(epoch, committee_candidate_address).await?;
 		let pools = self.client.pools_extended().await?;
 		let pred = |pool: PoolListExtendedInner| async move {
-			let history = self.client.pools_history(&pool.pool_id).await?;
+			let pool_id = mckeyhash_from_bech32(&pool.pool_id)?;
+			let history = self.client.pools_history(pool_id).await?;
 			Result::Ok(match history.into_iter().find(|h| h.epoch == epoch.0 as i32) {
-				Some(e) => Some((
-					MainchainKeyHash::decode_hex(&pool.pool_id)?,
-					StakeDelegation(e.active_stake.parse::<u64>()?),
-				)),
+				Some(e) => Some((pool_id, StakeDelegation(e.active_stake.parse::<u64>()?))),
 				None => None,
 			})
 		};
@@ -147,6 +145,11 @@ impl AuthoritySelectionDataSource for AuthoritySelectionDataSourceImpl {
 	}
 }
 
+fn mckeyhash_from_bech32(bech32_str: &str) -> Result<MainchainKeyHash> {
+	let (_hrp, val) = bech32::decode(bech32_str).map_err(|e| e.to_string())?;
+	Ok(MainchainKeyHash(val.try_into().map_err(|_| "failed to convert vec to array")?))
+}
+
 #[derive(Debug)]
 struct RegisteredCandidate {
 	stake_pool_pub_key: StakePoolPublicKey,

toolkit/data-sources/dolos/src/candidate.rs

@@ -13,40 +13,53 @@ use sidechain_domain::*;
 use crate::DataSourceError;
 
 /// Mainchain block id, either a block hash or a block number
-pub enum McBlockId {
-	/// Domain type Mainchain block hash
-	McBlockHash(McBlockHash),
-	/// Domain type Mainchain block number
-	McBlockNumber(McBlockNumber),
-	/// Mainchain block hash returned as string by Blockfrost API
-	Raw(String),
-}
+pub struct McBlockId(String);
 
 impl From<McBlockHash> for McBlockId {
 	fn from(value: McBlockHash) -> Self {
-		McBlockId::McBlockHash(value)
+		McBlockId(value.to_string())
 	}
 }
 
 impl From<McBlockNumber> for McBlockId {
 	fn from(value: McBlockNumber) -> Self {
-		McBlockId::McBlockNumber(value)
+		McBlockId(value.to_string())
 	}
 }
 
 impl From<String> for McBlockId {
 	fn from(value: String) -> Self {
-		McBlockId::Raw(value)
+		McBlockId(value)
 	}
 }
 
 impl std::fmt::Display for McBlockId {
 	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
-		match self {
-			McBlockId::McBlockHash(mc_block_hash) => mc_block_hash.fmt(f),
-			McBlockId::McBlockNumber(mc_block_number) => mc_block_number.fmt(f),
-			McBlockId::Raw(str) => str.fmt(f),
-		}
+		self.0.fmt(f)
+	}
+}
+
+/// Mainchain pool id as a bech32 string
+pub struct McPoolId(String);
+
+impl From<MainchainKeyHash> for McPoolId {
+	fn from(value: MainchainKeyHash) -> Self {
+		let pool_id =
+			bech32::encode::<bech32::Bech32>(bech32::Hrp::parse_unchecked("pool"), &value.0)
+				.expect("MainchainKeyHash is valid");
+		McPoolId(pool_id)
+	}
+}
+
+impl From<String> for McPoolId {
+	fn from(value: String) -> Self {
+		McPoolId(value)
+	}
+}
+
+impl std::fmt::Display for McPoolId {
+	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+		self.0.fmt(f)
 	}
 }
 
@@ -64,12 +77,12 @@ pub trait MiniBFApi {
 		address: MainchainAddress,
 	) -> Result<Vec<AddressTransactionsContentInner>, DataSourceError>;
 
-	/// List of a specific asset transactions.
+	/// List of specific asset transactions.
 	async fn assets_transactions(
 		&self,
 		asset_id: AssetId,
 	) -> Result<Vec<AssetTransactionsInner>, DataSourceError>;
-	/// List of a addresses containing a specific asset.
+	/// List of addresses containing a specific asset.
 	async fn assets_addresses(
 		&self,
 		asset_id: AssetId,
@@ -110,11 +123,14 @@ pub trait MiniBFApi {
 	async fn epochs_stakes_by_pool(
 		&self,
 		epoch_number: McEpochNumber,
-		pool_id: &str,
+		pool_id: impl Into<McPoolId> + Send,
 	) -> Result<Vec<EpochStakePoolContentInner>, DataSourceError>;
 
 	/// History of stake pool parameters over epochs.
-	async fn pools_history(&self, pool_id: &str) -> Result<Vec<PoolHistoryInner>, DataSourceError>;
+	async fn pools_history(
+		&self,
+		pool_id: impl Into<McPoolId> + Send,
+	) -> Result<Vec<PoolHistoryInner>, DataSourceError>;
 	/// List of registered stake pools with additional information.
 	async fn pools_extended(&self) -> Result<Vec<PoolListExtendedInner>, DataSourceError>;
 

toolkit/data-sources/dolos/src/client/api.rs

@@ -15,7 +15,7 @@ use ureq::Agent;
 
 use crate::{
 	DataSourceError,
-	client::api::{McBlockId, MiniBFApi},
+	client::api::{McBlockId, McPoolId, MiniBFApi},
 };
 
 /// Client implementing Dolos MiniBF
@@ -187,13 +187,18 @@ impl MiniBFApi for MiniBFClient {
 	async fn epochs_stakes_by_pool(
 		&self,
 		epoch_number: McEpochNumber,
-		pool_id: &str,
+		pool_id: impl Into<McPoolId> + Send,
 	) -> Result<Vec<EpochStakePoolContentInner>, DataSourceError> {
+		let pool_id: McPoolId = pool_id.into();
 		self.paginated_request_all(&format!("epochs/{epoch_number}/stakes/{pool_id}"))
 			.await
 	}
 
-	async fn pools_history(&self, pool_id: &str) -> Result<Vec<PoolHistoryInner>, DataSourceError> {
+	async fn pools_history(
+		&self,
+		pool_id: impl Into<McPoolId> + Send,
+	) -> Result<Vec<PoolHistoryInner>, DataSourceError> {
+		let pool_id: McPoolId = pool_id.into();
 		self.paginated_request_all(&format!("pools/{pool_id}/history")).await
 	}
 	async fn pools_extended(&self) -> Result<Vec<PoolListExtendedInner>, DataSourceError> {
@@ -223,7 +228,7 @@ impl MiniBFApi for MiniBFClient {
 	}
 }
 
-fn format_asset_id(asset_id: &AssetId) -> String {
+pub fn format_asset_id(asset_id: &AssetId) -> String {
 	let AssetId { policy_id, asset_name } = asset_id;
 	format!("{}{}", &policy_id.to_hex_string()[2..], &asset_name.to_hex_string()[2..])
 }