add PoolMetadata

Author: cocoyoon

pallets/hybrid-orderbook/src/lib.rs

@@ -921,6 +921,15 @@ pub mod pallet {
             return Ok(pool.to_pool_query(b_r, q_r, pool_price));
         }
 
+        pub fn get_pool_metadata(
+            base_asset: &T::AssetKind,
+            quote_asset: &T::AssetKind,
+        ) -> Result<PoolMetadata<T::Unit>, DispatchError> {
+            let pool_id = T::PoolLocator::pool_id(base_asset, quote_asset).map_err(|_| Error::<T>::PoolNotFound)?;
+            let pool = Pools::<T>::get(&pool_id).ok_or(Error::<T>::PoolNotFound)?;
+            Ok(pool.to_pool_metadata())
+        }
+
         fn freeze_asset(
             who: &T::AccountId,
             asset: &T::AssetKind,
@@ -2043,33 +2052,11 @@ sp_api::decl_runtime_apis! {
         AssetId: Codec,
         Orderbook: Codec,
     {
-        /// Provides a quote for [`Pallet::swap_tokens_for_exact_tokens`].
-        ///
-        /// Note that the price may have changed by the time the transaction is executed.
-        /// (Use `amount_in_max` to control slippage.)
-        fn quote_price_tokens_for_exact_tokens(
-            asset1: AssetId,
-            asset2: AssetId,
-            amount: Balance,
-            include_fee: bool,
-        ) -> Option<Balance>;
-
-        /// Provides a quote for [`Pallet::swap_exact_tokens_for_tokens`].
-        ///
-        /// Note that the price may have changed by the time the transaction is executed.
-        /// (Use `amount_out_min` to control slippage.)
-        fn quote_price_exact_tokens_for_tokens(
-            asset1: AssetId,
-            asset2: AssetId,
-            amount: Balance,
-            include_fee: bool,
-        ) -> Option<Balance>;
-
-        /// Returns the size of the liquidity pool for the given asset pair.
-        fn get_reserves(asset1: AssetId, asset2: AssetId) -> Option<(Balance, Balance)>;
-
         /// Returns query of the `pool`
         fn get_pool_query(base: AssetId, quote: AssetId) -> Option<PoolQuery<Orderbook, Balance>>;
+
+        /// Returns the metadata of the pool
+        fn get_pool_metadata(base: AssetId, quote: AssetId) -> Option<PoolMetadata<Balance>>;
     }
 }
 

pallets/hybrid-orderbook/src/types.rs

@@ -279,14 +279,20 @@ impl<Quantity, Account: Clone, BlockNumber> Order<Quantity, Account, BlockNumber
     }
 }
 
-#[derive(Encode, Decode, Default, Debug, Clone, PartialEq, TypeInfo)]
+#[derive(Encode, Decode, TypeInfo)]
 pub struct PoolQuery<Orderbook, Unit> {
     bids: Orderbook,
     asks: Orderbook,
-    taker_fee_rate: Permill,
     base_reserve: Unit,
     quote_reserve: Unit,
     pool_price: Unit,
+}
+
+#[derive(Encode, Decode, TypeInfo)]
+pub struct PoolMetadata<Unit> {
+    taker_fee_rate: Permill,
+    lot_size: Unit,
+    tick_size: Unit,
     pool_decimals: u8,
     base_decimals: u8,
     quote_decimals: u8,
@@ -350,10 +356,17 @@ impl<T: Config> Pool<T> {
         PoolQuery {
             bids: self.bids,
             asks: self.asks,
-            taker_fee_rate: self.taker_fee_rate,
             base_reserve,
             quote_reserve,
             pool_price,
+        }
+    }
+
+    pub fn to_pool_metadata(self) -> PoolMetadata<T::Unit> {
+        PoolMetadata {
+            taker_fee_rate: self.taker_fee_rate,
+            lot_size: self.lot_size,
+            tick_size: self.tick_size,
             pool_decimals: self.pool_decimals,
             base_decimals: self.base_decimals,
             quote_decimals: self.quote_decimals,

runtime/src/apis.rs

@@ -40,7 +40,7 @@ use sp_runtime::{
     ApplyExtrinsicResult,
 };
 use sp_version::RuntimeVersion;
-use pallet_hybrid_orderbook::{CritbitTree, PoolQuery, Tick};
+use pallet_hybrid_orderbook::{CritbitTree, PoolQuery, PoolMetadata, Tick};
 
 // Local module imports
 use super::{
@@ -213,21 +213,13 @@ impl_runtime_apis! {
     }
 
     impl pallet_hybrid_orderbook::HybridOrderbookApi<Block, Balance, NativeOrWithId<u32>, CritbitTree<Balance, Tick<Balance, AccountId, BlockNumber>>> for Runtime {
-        fn quote_price_exact_tokens_for_tokens(asset1: NativeOrWithId<u32>, asset2: NativeOrWithId<u32>, amount: Balance, include_fee: bool) -> Option<Balance> {
-            HybridOrderbook::quote_price_exact_tokens_for_tokens(asset1, asset2, amount, include_fee)
-        }
-
-        fn quote_price_tokens_for_exact_tokens(asset1: NativeOrWithId<u32>, asset2: NativeOrWithId<u32>, amount: Balance, include_fee: bool) -> Option<Balance> {
-            HybridOrderbook::quote_price_tokens_for_exact_tokens(asset1, asset2, amount, include_fee)
-        }
-
-        fn get_reserves(_asset1: NativeOrWithId<u32>, _asset2: NativeOrWithId<u32>) -> Option<(Balance, Balance)> {
-            None
-        }
-
         fn get_pool_query(base: NativeOrWithId<u32>, quote: NativeOrWithId<u32>) -> Option<PoolQuery<CritbitTree<Balance, Tick<Balance, AccountId, BlockNumber>>, Balance>> {
             HybridOrderbook::get_pool_query(&base, &quote).ok()
         }
+
+        fn get_pool_metadata(base: NativeOrWithId<u32>, quote: NativeOrWithId<u32>) -> Option<PoolMetadata<Balance>> {
+            HybridOrderbook::get_pool_metadata(&base, &quote).ok()
+        }
     }
 
     impl cumulus_primitives_core::CollectCollationInfo<Block> for Runtime {