feat: add NAV runtime API (#1703)

* feat: add NAV runtime API * refactor: explicit nav type
centrifuge · Jan 30, 2024 · 23daeeb · 23daeeb
1 parent f7e1232
commit 23daeeb
Show file tree

Hide file tree

Showing 7 changed files with 47 additions and 6 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/libs/types/src/pools.rs b/libs/types/src/pools.rs
@@ -42,6 +42,14 @@ pub enum PoolRegistrationStatus {
 	Unregistered,
 }
 
+#[derive(Encode, Decode, Clone, Eq, PartialEq, RuntimeDebug, TypeInfo, MaxEncodedLen)]
+pub struct PoolNav<Balance> {
+	pub nav_aum: Balance,
+	pub nav_fees: Balance,
+	pub reserve: Balance,
+	pub total: Balance,
+}
+
 /// The dynamic representation of a pool fee, its editor and destination
 /// address.
 ///

diff --git a/runtime/altair/src/lib.rs b/runtime/altair/src/lib.rs
@@ -2000,7 +2000,7 @@ mod __runtime_api_use {
 
 #[cfg(not(feature = "disable-runtime-api"))]
 use __runtime_api_use::*;
-use cfg_types::{locations::Location, tokens::FilterCurrency};
+use cfg_types::{locations::Location, pools::PoolNav, tokens::FilterCurrency};
 use runtime_common::transfer_filter::PreNativeTransfer;
 
 #[cfg(not(feature = "disable-runtime-api"))]
@@ -2174,6 +2174,16 @@ impl_runtime_apis! {
 			let pool = pallet_pool_system::Pool::<Runtime>::get(pool_id)?;
 			pool.tranches.tranche_currency(tranche_loc).map(Into::into)
 		}
+
+		fn nav(pool_id: PoolId) -> Option<PoolNav<Balance>> {
+			let pool = pallet_pool_system::Pool::<Runtime>::get(pool_id)?;
+			let nav_loans = Loans::update_nav(pool_id).ok()?;
+			let nav_fees = PoolFees::update_nav(pool_id).ok()?;
+			let nav = pallet_pool_system::Nav::new(nav_loans, nav_fees);
+			let total = nav.total(pool.reserve.total).ok()?;
+
+			Some(PoolNav { nav_aum: nav.nav_aum, nav_fees: nav.nav_fees, reserve: pool.reserve.total, total })
+		}
 	}
 
 	// RewardsApi

diff --git a/runtime/centrifuge/src/lib.rs b/runtime/centrifuge/src/lib.rs
@@ -2043,7 +2043,7 @@ mod __runtime_api_use {
 
 #[cfg(not(feature = "disable-runtime-api"))]
 use __runtime_api_use::*;
-use cfg_types::{locations::Location, tokens::FilterCurrency};
+use cfg_types::{locations::Location, pools::PoolNav, tokens::FilterCurrency};
 use runtime_common::transfer_filter::PreNativeTransfer;
 
 #[cfg(not(feature = "disable-runtime-api"))]
@@ -2218,6 +2218,16 @@ impl_runtime_apis! {
 			let pool = pallet_pool_system::Pool::<Runtime>::get(pool_id)?;
 			pool.tranches.tranche_currency(tranche_loc).map(Into::into)
 		}
+
+		fn nav(pool_id: PoolId) -> Option<PoolNav<Balance>> {
+			let pool = pallet_pool_system::Pool::<Runtime>::get(pool_id)?;
+			let nav_loans = Loans::update_nav(pool_id).ok()?;
+			let nav_fees = PoolFees::update_nav(pool_id).ok()?;
+			let nav = pallet_pool_system::Nav::new(nav_loans, nav_fees);
+			let total = nav.total(pool.reserve.total).ok()?;
+
+			Some(PoolNav { nav_aum: nav.nav_aum, nav_fees: nav.nav_fees, reserve: pool.reserve.total, total })
+		}
 	}
 
 	// RewardsApi

diff --git a/runtime/common/src/apis/pools.rs b/runtime/common/src/apis/pools.rs
@@ -10,6 +10,7 @@
 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 // GNU General Public License for more details.
 
+use cfg_types::pools::PoolNav;
 use pallet_pool_system::{
 	tranches::{TrancheIndex, TrancheLoc, TrancheSolution},
 	EpochSolution,
@@ -46,5 +47,7 @@ decl_runtime_apis! {
 		fn tranche_id(pool_id: PoolId, tranche_index: TrancheIndex) -> Option<TrancheId>;
 
 		fn tranche_currency(pool_id: PoolId, tranche_loc: TrancheLoc<TrancheId>) -> Option<Currency>;
+
+		fn nav(pool_id: PoolId) -> Option<PoolNav<Balance>>;
 	}
 }
diff --git a/runtime/development/Cargo.toml b/runtime/development/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "development-runtime"
-version = "0.10.38"
+version = "0.10.39"
 build = "build.rs"
 authors.workspace = true
 edition.workspace = true

diff --git a/runtime/development/src/lib.rs b/runtime/development/src/lib.rs
@@ -142,7 +142,7 @@ pub const VERSION: RuntimeVersion = RuntimeVersion {
 	spec_name: create_runtime_str!("centrifuge-devel"),
 	impl_name: create_runtime_str!("centrifuge-devel"),
 	authoring_version: 1,
-	spec_version: 1038,
+	spec_version: 1039,
 	impl_version: 1,
 	#[cfg(not(feature = "disable-runtime-api"))]
 	apis: RUNTIME_API_VERSIONS,
@@ -2118,7 +2118,7 @@ mod __runtime_api_use {
 
 #[cfg(not(feature = "disable-runtime-api"))]
 use __runtime_api_use::*;
-use cfg_types::tokens::FilterCurrency;
+use cfg_types::{pools::PoolNav, tokens::FilterCurrency};
 use runtime_common::{remarks::Remark, transfer_filter::PreNativeTransfer};
 
 #[cfg(not(feature = "disable-runtime-api"))]
@@ -2296,6 +2296,16 @@ impl_runtime_apis! {
 			let pool = pallet_pool_system::Pool::<Runtime>::get(pool_id)?;
 			pool.tranches.tranche_currency(tranche_loc).map(Into::into)
 		}
+
+		fn nav(pool_id: PoolId) -> Option<PoolNav<Balance>> {
+			let pool = pallet_pool_system::Pool::<Runtime>::get(pool_id)?;
+			let nav_loans = Loans::update_nav(pool_id).ok()?;
+			let nav_fees = PoolFees::update_nav(pool_id).ok()?;
+			let nav = pallet_pool_system::Nav::new(nav_loans, nav_fees);
+			let total = nav.total(pool.reserve.total).ok()?;
+
+			Some(PoolNav { nav_aum: nav.nav_aum, nav_fees: nav.nav_fees, reserve: pool.reserve.total, total })
+		}
 	}
 
 	// RewardsApi