Merge pull request #68 from ssvlabs/chore/update-docs

chore: update docs + add release notes

Author: riccardo-ssvlabs

RELEASE_NOTES.md

@@ -0,0 +1,27 @@
+# Release Notes
+
+## [v0.1.1] 2024-06-xx
+
+### Functions
+
+#### Modified
+- `function registerBApp(ICore.TokenConfig[] calldata tokenConfigs, string calldata metadataURI) external`
+- `function updateDisabledFeatures(uint32 value) external onlyOwner`
+
+### Errors
+
+#### New
+- `error InvalidDisabledFeatures();`
+- `error InvalidFeeExpireTime();`
+- `error InvalidFeeTimelockPeriod();`
+- `error InvalidMaxShares();`
+- `error InvalidObligationExpireTime();`
+- `error InvalidObligationTimelockPeriod();`
+- `error InvalidTokenUpdateTimelockPeriod();`
+- `error InvalidWithdrawalExpireTime();`
+- `error InvalidWithdrawalTimelockPeriod();`
+
+### Events
+
+#### Modified
+- `event BAppRegistered(address indexed bApp, ICore.TokenConfig[] tokenConfigs, string metadataURI);`

docs/src/README.md

@@ -65,6 +65,8 @@ __`❍ forge test`__
 
 [Slashing & Withdrawals](./guides/slashing-and-withdrawals.md)
 
+[Generation pattern](./guides/generations.md)
+
 ## :gear: _Feature Activation_
 
 [Feature Activation](./guides/feature-activation.md)
@@ -78,7 +80,6 @@ __`❍ forge test`__
 
 [Based Apps Onboarding Guide](./guides/bApp-onboarding.md) 
 
- 
 
 ## :rocket: _Deployments_
 

docs/src/SUMMARY.md

@@ -8,6 +8,7 @@
       - [IProtocolManager](src/core/interfaces/IProtocolManager.sol/interface.IProtocolManager.md)
       - [ISSVBasedApps](src/core/interfaces/ISSVBasedApps.sol/interface.ISSVBasedApps.md)
       - [IStrategyManager](src/core/interfaces/IStrategyManager.sol/interface.IStrategyManager.md)
+      - [IViews](src/core/interfaces/IViews.sol/interface.IViews.md)
     - [❱ libraries](src/core/libraries/README.md)
       - [SSVCoreModules](src/core/libraries/CoreStorageLib.sol/enum.SSVCoreModules.md)
       - [CoreStorageLib](src/core/libraries/CoreStorageLib.sol/library.CoreStorageLib.md)

docs/src/src/core/SSVBasedApps.sol/contract.SSVBasedApps.md

@@ -1,8 +1,8 @@
 # SSVBasedApps
-[Git Source](https://github.com/ssvlabs/based-applications/blob/f462573124548b82b6a002d4ef069bdfacf5c637/src/core/SSVBasedApps.sol)
+[Git Source](https://github.com/ssvlabs/based-applications/blob/3ee95af731e4fce61ac2b03f418aa4e9fb5f64bd/src/core/SSVBasedApps.sol)
 
 **Inherits:**
-[ISSVBasedApps](/src/core/interfaces/ISSVBasedApps.sol/interface.ISSVBasedApps.md), UUPSUpgradeable, Ownable2StepUpgradeable, [IBasedAppManager](/src/core/interfaces/IBasedAppManager.sol/interface.IBasedAppManager.md), [IStrategyManager](/src/core/interfaces/IStrategyManager.sol/interface.IStrategyManager.md), [IProtocolManager](/src/core/interfaces/IProtocolManager.sol/interface.IProtocolManager.md)
+[ISSVBasedApps](/src/core/interfaces/ISSVBasedApps.sol/interface.ISSVBasedApps.md), UUPSUpgradeable, Ownable2StepUpgradeable
 
 **Author:**
 
@@ -91,7 +91,7 @@ function updateBAppMetadataURI(string calldata metadataURI) external;
 
 
 ```solidity
-function registerBApp(address[] calldata tokens, uint32[] calldata sharedRiskLevels, string calldata metadataURI) external;
+function registerBApp(ICore.TokenConfig[] calldata tokenConfigs, string calldata metadataURI) external;
 ```
 
 ### updateBAppsTokens
@@ -329,7 +329,7 @@ function updateMaxFeeIncrement(uint32 value) external onlyOwner;
 
 
 ```solidity
-function updateDisabledFeatures(uint32 disabledFeatures) external onlyOwner;
+function updateDisabledFeatures(uint32 value) external onlyOwner;
 ```
 
 ### delegations

docs/src/src/core/interfaces/IBasedAppManager.sol/interface.IBasedAppManager.md

@@ -1,13 +1,13 @@
 # IBasedAppManager
-[Git Source](https://github.com/ssvlabs/based-applications/blob/f462573124548b82b6a002d4ef069bdfacf5c637/src/core/interfaces/IBasedAppManager.sol)
+[Git Source](https://github.com/ssvlabs/based-applications/blob/3ee95af731e4fce61ac2b03f418aa4e9fb5f64bd/src/core/interfaces/IBasedAppManager.sol)
 
 
 ## Functions
 ### registerBApp
 
 
 ```solidity
-function registerBApp(address[] calldata tokens, uint32[] calldata sharedRiskLevels, string calldata metadataURI) external;
+function registerBApp(ICore.TokenConfig[] calldata tokenConfigs, string calldata metadataURI) external;
 ```
 
 ### updateBAppMetadataURI
@@ -34,7 +34,7 @@ event BAppMetadataURIUpdated(address indexed bApp, string metadataURI);
 ### BAppRegistered
 
 ```solidity
-event BAppRegistered(address indexed bApp, address[] tokens, uint32[] sharedRiskLevel, string metadataURI);
+event BAppRegistered(address indexed bApp, ICore.TokenConfig[] tokenConfigs, string metadataURI);
 ```
 
 ### BAppTokensUpdated

docs/src/src/core/interfaces/ICore.sol/interface.ICore.md

@@ -1,5 +1,5 @@
 # ICore
-[Git Source](https://github.com/ssvlabs/based-applications/blob/f462573124548b82b6a002d4ef069bdfacf5c637/src/core/interfaces/ICore.sol)
+[Git Source](https://github.com/ssvlabs/based-applications/blob/3ee95af731e4fce61ac2b03f418aa4e9fb5f64bd/src/core/interfaces/ICore.sol)
 
 
 ## Structs

docs/src/src/core/interfaces/IProtocolManager.sol/interface.IProtocolManager.md

@@ -1,5 +1,5 @@
 # IProtocolManager
-[Git Source](https://github.com/ssvlabs/based-applications/blob/f462573124548b82b6a002d4ef069bdfacf5c637/src/core/interfaces/IProtocolManager.sol)
+[Git Source](https://github.com/ssvlabs/based-applications/blob/3ee95af731e4fce61ac2b03f418aa4e9fb5f64bd/src/core/interfaces/IProtocolManager.sol)
 
 
 ## Functions

docs/src/src/core/interfaces/ISSVBasedApps.sol/interface.ISSVBasedApps.md

@@ -1,5 +1,8 @@
 # ISSVBasedApps
-[Git Source](https://github.com/ssvlabs/based-applications/blob/f462573124548b82b6a002d4ef069bdfacf5c637/src/core/interfaces/ISSVBasedApps.sol)
+[Git Source](https://github.com/ssvlabs/based-applications/blob/3ee95af731e4fce61ac2b03f418aa4e9fb5f64bd/src/core/interfaces/ISSVBasedApps.sol)
+
+**Inherits:**
+[IStrategyManager](/src/core/interfaces/IStrategyManager.sol/interface.IStrategyManager.md), [IBasedAppManager](/src/core/interfaces/IBasedAppManager.sol/interface.IBasedAppManager.md), [IProtocolManager](/src/core/interfaces/IProtocolManager.sol/interface.IProtocolManager.md), [IViews](/src/core/interfaces/IViews.sol/interface.IViews.md)
 
 
 ## Functions
@@ -10,13 +13,6 @@
 function getModuleAddress(SSVCoreModules moduleId) external view returns (address);
 ```
 
-### getVersion
-
-
-```solidity
-function getVersion() external pure returns (string memory version);
-```
-
 ### initialize
 
 
@@ -51,6 +47,60 @@ event ModuleUpdated(SSVCoreModules indexed moduleId, address moduleAddress);
 error InvalidMaxFeeIncrement();
 ```
 
+### InvalidMaxShares
+
+```solidity
+error InvalidMaxShares();
+```
+
+### InvalidFeeTimelockPeriod
+
+```solidity
+error InvalidFeeTimelockPeriod();
+```
+
+### InvalidFeeExpireTime
+
+```solidity
+error InvalidFeeExpireTime();
+```
+
+### InvalidWithdrawalTimelockPeriod
+
+```solidity
+error InvalidWithdrawalTimelockPeriod();
+```
+
+### InvalidWithdrawalExpireTime
+
+```solidity
+error InvalidWithdrawalExpireTime();
+```
+
+### InvalidObligationTimelockPeriod
+
+```solidity
+error InvalidObligationTimelockPeriod();
+```
+
+### InvalidObligationExpireTime
+
+```solidity
+error InvalidObligationExpireTime();
+```
+
+### InvalidTokenUpdateTimelockPeriod
+
+```solidity
+error InvalidTokenUpdateTimelockPeriod();
+```
+
+### InvalidDisabledFeatures
+
+```solidity
+error InvalidDisabledFeatures();
+```
+
 ### TargetModuleDoesNotExist
 
 ```solidity

docs/src/src/core/interfaces/IStrategyManager.sol/interface.IStrategyManager.md

@@ -1,5 +1,5 @@
 # IStrategyManager
-[Git Source](https://github.com/ssvlabs/based-applications/blob/f462573124548b82b6a002d4ef069bdfacf5c637/src/core/interfaces/IStrategyManager.sol)
+[Git Source](https://github.com/ssvlabs/based-applications/blob/3ee95af731e4fce61ac2b03f418aa4e9fb5f64bd/src/core/interfaces/IStrategyManager.sol)
 
 
 ## Functions