From 3b0002ab746e145b7d59635b0fbeb3fac423d41a Mon Sep 17 00:00:00 2001
From: Matthias Zimmermann <zimmermann@xbrain.ch>
Date: Mon, 19 Sep 2022 09:11:14 +0000
Subject: [PATCH] amend descriptions for captial, lockedCapital and blance to
 IBundle and IPool

---
 contracts/modules/IBundle.sol | 8 ++++----
 contracts/modules/IPool.sol   | 8 ++++----
 2 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/contracts/modules/IBundle.sol b/contracts/modules/IBundle.sol
index cd80663..65ecaa6 100644
--- a/contracts/modules/IBundle.sol
+++ b/contracts/modules/IBundle.sol
@@ -32,10 +32,10 @@ interface IBundle {
         uint256 riskpoolId;
         uint256 tokenId;
         BundleState state;
-        bytes filter;
-        uint256 capital;
-        uint256 lockedCapital;
-        uint256 balance;
+        bytes filter; // required conditions for applications to be considered for collateralization by this bundle
+        uint256 capital; // net investment capital amount (<= balance)
+        uint256 lockedCapital; // capital amount linked to collateralizaion of non-closed policies (<= capital)
+        uint256 balance; // total amount of funds: net investment capital + net premiums - payouts
         uint256 createdAt;
         uint256 updatedAt;
     }
diff --git a/contracts/modules/IPool.sol b/contracts/modules/IPool.sol
index 451ddb9..29cb41f 100644
--- a/contracts/modules/IPool.sol
+++ b/contracts/modules/IPool.sol
@@ -20,12 +20,12 @@ interface IPool {
         uint256 id; // matches component id of riskpool
         address wallet; // riskpool wallet
         address erc20Token; // the value token of the riskpool
-        uint256 collateralizationLevel;
+        uint256 collateralizationLevel; // required collateralization level to cover new policies 
         uint256 sumOfSumInsuredCap; // max sum of sum insured the pool is allowed to secure
         uint256 sumOfSumInsuredAtRisk; // current sum of sum insured at risk in this pool
-        uint256 capital;
-        uint256 lockedCapital;
-        uint256 balance;
+        uint256 capital; // net investment capital amount (<= balance)
+        uint256 lockedCapital; // capital amount linked to collateralizaion of non-closed policies (<= capital)
+        uint256 balance; // total amount of funds: net investment capital + net premiums - payouts
         uint256 createdAt;
         uint256 updatedAt;
     }