filled in the blanks

Signed-off-by: Alexander Diemand <[email protected]>

Author: CodiePP

doc/Contracts.md

@@ -1,11 +1,12 @@
 # Smart contracts
 
-## BCA_ERC20_nf.sol
+## Contract: BCAServiceToken
 
 This contract implements an ERC20 token following the definitions from OpenZeppelin:
 
 Source file: [BCA_ERC20_nf.sol](../bca-token-solidity/contracts/BCA_ERC20_nf.sol)
 
+Implements interfaces:
 - `import {ERC20} from "@openzeppelin/contracts/token/ERC20/ERC20.sol"`
     - the `constructor(string memory setName, string memory setSymbol, address setMinter, address setBurner)`
 
@@ -19,12 +20,16 @@ The contract has public fields:
 - `address public minterAddress`
 - `address public burnerAddress`
 
-## BCA_ServiceManager.sol
+## Contract: BCAServiceManager
 
 The service manager contract is at the top of the hierarchy of contracts and serves as an entry point. It is parameterized by the ERC20 or stable-coin address that is used throughout the dependent contracts. It stores the addresses of provider controller contracts.
 
 Source file: [BCA_ServiceManager.sol](../bca-token-solidity/contracts/BCA_ServiceManager.sol)
 
+Implements interfaces:
+- [IServiceManager](../bca-token-solidity/contracts/Iface_ServiceManager.sol)
+- [ReentrancyGuard](https://docs.openzeppelin.com/contracts/4.x/api/security#ReentrancyGuard)
+
 The contract has public fields:
 - `IERC20 public immutable tokToken`
     * address of the ERC20 token as stable-coin
@@ -52,13 +57,17 @@ The contract has public methods:
 - `function countServiceControllers() public view returns (uint)`
     * returns the number of known controllers by this service manager
 
-## BCA_ServiceController.sol
+## Contract: BCAServiceController
 
 The service controller contract is deployed for every provider.
 It keeps a list of addresses for the services that the provider offers.
 
 Source file: [BCA_ServiceController.sol](../bca-token-solidity/contracts/BCA_ServiceController.sol)
 
+Implements interfaces:
+- [IServiceController](../bca-token-solidity/contracts/Iface_ServiceController.sol)
+- [ReentrancyGuard](https://docs.openzeppelin.com/contracts/4.x/api/security#ReentrancyGuard)
+
 The contract has public fields:
 - `IERC20 public immutable tokToken`
     * the common ERC20 or stable-coin
@@ -74,12 +83,16 @@ The contract has public methods:
 - `function countServiceContracts() public view returns (uint)`
     * returns the number of services in the array, necessary to enumerate the array entries
 
-## BCA_Service.sol
+## Contract: BCAService
 
 A service references a provider and the common ERC20/stable-coin and is parameterized with the maximal number of instances and the price of the service per day.
 
 Source file: [BCA_Service.sol](../bca-token-solidity/contracts/BCA_Service.sol)
 
+Implements interfaces:
+- [IService](../bca-token-solidity/contracts/Iface_Service.sol)
+- [ReentrancyGuard](https://docs.openzeppelin.com/contracts/4.x/api/security#ReentrancyGuard)
+
 The contract has public fields:
 - `IERC20 public immutable tokToken`
 - `uint256 public immutable dayPrice`
@@ -93,47 +106,80 @@ The contract has public methods:
 - `function newInstance(address userAddress) external nonReentrant returns (address)`
 - `function countServiceInstances() public view returns (uint)`
 
-## BCA_ServiceInstance.sol
+## Contract: BCAServiceInstance
+
+This contract is at the heart of the market and represents a service instance. A user subscribes to a service with a first deposit of funds. This sets the start time of the contract from which the balances are calculated.
 
 Source file: [BCA_ServiceInstance.sol](../bca-token-solidity/contracts/BCA_ServiceInstance.sol)
 
+Implements interfaces:
+- [IServiceInstance](../bca-token-solidity/contracts/Iface_ServiceInstance.sol)
+- [ReentrancyGuard](https://docs.openzeppelin.com/contracts/4.x/api/security#ReentrancyGuard)
+
 The contract has public fields:
 - `IERC20 public immutable tokToken`
+    * the common ERC20/stable-coin
 - `uint256 public immutable dayPrice`
+    * the price of the service for 24 hours; minimizes rounding errors
 - `address public immutable providerAddress`
+    * the address of the provider
 - `address public immutable userAddress`
+    * the address of the user
 - `uint256 public deposit`
+    * the amount of deposits made by the user
 - `uint256 public retracted`
+    * the amount of withdrawals made by the provider
 - `uint256 public startTime`
+    * when the contract has been started
 - `uint256 public endTime`
+    * when it has been stopped
 
 The contract has public methods:
 - `constructor(address setProviderAddress, address tokAddress,
                 address setUserAddress,
                 uint256 setDayPrice)`
 - `function makeDeposit(uint256 amount) external nonReentrant`
+    * deposits can only be made from the user's address
 - `function stop() external nonReentrant`
+    * both parties may call stop() at any time
 - `function balanceUser() public view returns (uint256)`
+    * calculates the user's balance
 - `function balanceProvider() public view returns (uint256)`
+    * calculates the provider's balance
 - `function withdrawUser(uint256 amount) external nonReentrant`
+    * the user may withdraw from his balance; this will affect the deposit
 - `function withdrawProvider(uint256 amount) external nonReentrant`
+    * the provider may withdraw up to his calculated balance
+
 
+## Contract: BCAServiceFunding24
 
-## BCA_Funding24.sol
+This contract automates the funding of a service contract by transferring the required funds to run the service every 24 hours. The contract is guaranteed to only transfer the said amount at most every 24 hours. It requires an external transaction to `deposit()` which is sent from a bot.
 
 Source file: [BCA_Funding24.sol](../bca-token-solidity/contracts/BCA_Funding24.sol)
 
+Implements interfaces:
+- [IFunding24](../bca-token-solidity/contracts/Iface_Funding24.sol)
+- [Ownable](https://docs.openzeppelin.com/contracts/4.x/api/access#Ownable)
+
 The contract has public fields:
 - `address public immutable targetContract`
+    * the target contract
 - `uint256 public immutable dailyAmount`
+    * the amount to deposit every 24 hours
 - `IERC20 public immutable token`
+    * the common ERC20/stable-coin
 - `uint256 public lastDepositTime`
+    * remembers the last time a deposit was made
 
 The contract has public methods:
 - `constructor(
         address initialOwner,
         address setTargetContract,
         address setToken,
         uint256 setDailyAmount`
+    * the parameterization of the contract is done in the constructor. The owner is set to the service user.
 - `function deposit() external`
-- `function canDeposit() external view returns (bool)`
+    * this method triggers the transfer of funds and makes the deposit to the service contract
+- `function canDeposit() external view returns (bool)`
+    * returns true if a deposit can be make