From 371aa776bd1cdfbd04dda811a098d308d06eb5a8 Mon Sep 17 00:00:00 2001
From: markuspluna <59978114+markuspluna@users.noreply.github.com>
Date: Mon, 29 Jul 2024 16:18:11 +0300
Subject: [PATCH] added comments regarding reserve emission metadata

---
 pool/src/emissions/manager.rs | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/pool/src/emissions/manager.rs b/pool/src/emissions/manager.rs
index 933a84ff..32fbfe0b 100644
--- a/pool/src/emissions/manager.rs
+++ b/pool/src/emissions/manager.rs
@@ -17,9 +17,9 @@ use super::distributor;
 /// Metadata for a pool's reserve emission configuration
 #[contracttype]
 pub struct ReserveEmissionMetadata {
-    pub res_index: u32,
-    pub res_type: u32,
-    pub share: u64,
+    pub res_index: u32, // index of the reserve as defined by the ReserveConfig
+    pub res_type: u32,  // 0 for liabilities, 1 for supply
+    pub share: u64, // percent of the total pool emissions this reserve should receive. Scaled to 7 decimals
 }
 
 /// Set the pool emissions