Support Delayed Token Update

.github/workflows/tests.yml

@@ -20,19 +20,27 @@ jobs:
         with:
           submodules: recursive
 
+      - name: Install Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+          cache: 'npm'
+          cache-dependency-path: package-lock.json
+
+      - name: Install dependencies
+        run: |
+          npm install
+
       - name: Install Foundry
         uses: foundry-rs/foundry-toolchain@v1
-        with:
-          version: nightly
 
       - name: Show Forge version
         run: |
           forge --version
 
-      - name: Run Forge fmt
+      - name: Run Prettier Format Check
         run: |
-          forge fmt --check
-        id: fmt
+          npm run lint:check
 
       - name: Run Forge build
         run: |
@@ -42,16 +50,4 @@ jobs:
       - name: Run Forge tests
         run: |
           forge test -vvv
-        id: test
-
-      - name: Run Slither
-        uses: crytic/[email protected]
-        id: slither
-        with:
-          sarif: results.sarif
-          fail-on: none
-
-      - name: Upload SARIF file
-        uses: github/codeql-action/upload-sarif@v3
-        with:
-          sarif_file: ${{ steps.slither.outputs.sarif }}
+        id: test

.husky/pre-commit

@@ -1,5 +1,5 @@
-npm run format
+npm run lint:fix
 
-npm run lint:solhint
+npx lint-staged
 
 npm run test-coverage

.prettierignore

@@ -0,0 +1,6 @@
+node_modules
+out/
+cache/
+lib/
+!src/lib
+coverage

.prettierrc

@@ -0,0 +1,20 @@
+{
+  "plugins": ["prettier-plugin-solidity"],
+  "singleQuote": false,
+  "trailingComma": "none",
+  "printWidth": 100,
+  "bracketSpacing": true,
+  "overrides": [
+    {
+      "files": "*.sol",
+      "options": {
+        "parser": "solidity-parse",
+        "printWidth": 80,
+        "tabWidth": 4,
+        "useTabs": false,
+        "singleQuote": false,
+        "bracketSpacing": true
+      }
+    }
+  ]
+}

.solhint.json

@@ -1,14 +1,20 @@
 {
   "extends": "solhint:recommended",
   "rules": {
-    "compiler-version": ["error", "0.8.28"],
+    "compiler-version": ["error", "0.8.29"],
     "no-inline-assembly": "off",
     "no-unused-import": "error",
     "func-named-parameters": "off",
     "func-visibility": ["error", { "ignoreConstructors": true }],
     "reason-string": ["warn", { "maxLength": 64 }],
     "immutable-vars-naming": ["error", { "immutablesAsConstants": true }],
-    "var-name-mixedcase": "error",
-    "func-name-mixedcase": "error"
+    "var-name-mixedcase": "warn",
+    "custom-errors": "error",
+    "func-name-mixedcase": "error",
+    "max-line-length": [
+      "error",
+      160
+    ],
+    "no-unused-vars": "off"
   }
 }

.solhintignore

@@ -0,0 +1 @@
+interfaces/

.tool-versions

@@ -1 +1 @@
-solidity 0.8.28
+solidity 0.8.29

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "solidity.compileUsingRemoteVersion": "v0.8.29+commit.ab55807c"
+}

README.md

@@ -9,16 +9,36 @@
 
 ## :book: _Description_
 
-This repository contains the core Based Applications Contracts, including UUPS upgradeable contracts for managing delegations, creating strategies, and registering bApps on the SSV Based-Applications Platform. 
+This repository contains the SSV Based Applications Platform Contracts.
 
-### **Main Contracts**
+The contracts are organized under the `src/` directory into two main folders:
 
-- **`SSVBasedApps.sol`** – Core contract managing bApps, delegations, and strategies.
+- **`core/`**: contains the main platform contract: `SSVBasedApps.sol`;
 
-- **`IBasedAppManager.sol`** – Interface for the Based Application Manager.
+- **`middleware/`** contains the module contracts to build a based application. 
+
+### **The Core Platform**
+
+The core contract is build in a diamond-like pattern: 
+
+- **`SSVBasedApps.sol`** – Core contract where all the functions are declared and via an internal proxy it redirects to the right implementation. 
+
+The functions are implemented in 3 different modules:
 
-- **`IStorage.sol`** – Core interface defining key structs for staking and obligation mechanisms.
+- **`StrategyManager.sol`** – Implements functions related to strategies, validator balance delegation, opting-in to bApp, and slashing;
 
+- **`BasedAppsManager.sol`** – Implements functions related to bApps like the registration and update the metadata;
+
+- **`PlatformManager.sol`** – Implements functions for updating the global variables like timelocks length, max number of shares, etc. The variable update process will be handled by the SSV DAO.
+
+### **The Middleware**
+
+This `middleware` folder contains the modules for building a bapp: 
+
+- **`modules/core`**: the base layer for a bApp to be compliant and be recognized by the system;
+
+- **`examples`**: contains example of working compliant bApps.
+
  
 
 ## :page_with_curl: _Instructions_
@@ -41,29 +61,116 @@ __`❍ forge test`__
 
  
 
+## 🔨 _Slashing Mechanism_
+
+The `slash` function allows for the reduction of a strategy’s token balance under specific conditions, either as a penalty or to enforce protocol-defined behavior. Slashing can happen in two distinct modes, depending on whether:
+
+**1)** The bApp is a compliant smart contract;
+
+**2)** The bApp is a non-compliant smart contract or an EOA.
+
+### 🧠 Compliant BApp
+
+If the bApp is a compliant contract implementing the required interface `IBasedApp`,
+
+The slash function of the bApp is called: `(success, receiver, exit) = IBasedApp(bApp).slash(...)`
+
+*	`data` parameter is forwarded and may act as a proof or auxiliary input.
+
+*	The bApp decides:
+
+    *	Who receives the slashed funds by setting the `receiver` fund;
+
+    *	Whether to exit the strategy or adjust obligations;
+
+    *	If `exit == true`, the strategy is exited and the obligation value is set to 0;
+
+    *	Otherwise, obligations are updated proportionally based on remaining balances;
+
+    *	Funds are credited to the receiver in the slashing fund.
+
+### 🔐 Non-compliant bApp (EOA or Non-compliant Contract)
+
+If the bApp is an EOA or does not comply with the required interface:
+
+*	Only the bApp itself can invoke slashing;
+
+*	The receiver of slashed funds is forcibly set to the bApp itself;
+
+*	The strategy is always exited (no obligation adjustment);
+
+*	Funds are added to the bApp’s slashing fund.
+
+### ⏳ Post Slashing
+
+⚠️ Important: After an obligation has been exited, it can be updated again to a value greater than 0, but only after a 14-day obligation timelock.
+
+This acts as a safeguard to prevent immediate re-entry and encourages more deliberate strategy participation.
+
+### 💸 Slashing Fund
+
+Slashed tokens are not immediately transferred. They are deposited into an internal slashing fund.
+
+The `receiver` (set during slashing) can later withdraw them using:
+
+```
+function withdrawSlashingFund(address token, uint256 amount) external
+function withdrawETHSlashingFund(uint256 amount) external
+```
+
+These functions verify balances and authorize the caller to retrieve their accumulated slashed tokens.
+
+ 
+
 ## :page_facing_up: _Whitepaper_
 
 [Whitepaper](https://ssv.network/wp-content/uploads/2025/01/SSV2.0-Based-Applications-Protocol-1.pdf)
 
  
 
-## :page_facing_up: _More Resources_
+## :books: _More Resources_
 
-[Based Apps Onboarding Guide](./doc/bapp_onboarding.md) 
+[Based Apps Onboarding Guide](./doc/bAppOnBoarding.md) 
 
  
 
 ## :rocket: _Deployments_
 
-### Public Testnet
+### How to Deploy
+
+**1)** Run the deployment script defined in `scripts/`:
+
+__`❍ npm run deploy:holesky`__: verification is done automatically.
+
+__`❍ npm run deploy:hoodi`__: verification needs to be done manually for now.
+
+### How to Update Module Contracts
+
+It is possible to update each one of the three modules: `StrategyManager`, `BasedAppsManager` and `ProtocolManager`.
+
+It is possible to update multiple modules at the same time. 
+
+**1)** Go on the Proxy Contract on Etherscan, under "Write as Proxy" call the function:
+
+__`❍ updateModules`__: specifying the correct module id and the new module address.
+
+### How to Upgrade the Implementation Contract 
+
+**1)** Go on the Proxy Contract on Etherscan, under "Write as Proxy" call the function:
+
+__`❍ upgradeToAndCall`__: specifying the new implementation address. The data field can be left empty in this case.
+
+There is also the `UpgradeProxy.s.sol` script file that can be run easily from the CLI.
+
+### Public Testnet Holesky
 
 | Name | Proxy | Implementation | Notes |
 | -------- | -------- | -------- | -------- | 
 | [`BasedApplications`](https://github.com/ssvlabs/based-applications/blob/main/src/BasedAppManager.sol) | [`0x1Bd6ceB98Daf7FfEB590236b720F81b65213836A`](https://holesky.etherscan.io/address/0x1Bd6ceB98Daf7FfEB590236b720F81b65213836A) | [`0x9a09A49870353867b0ce9901B44E84C32B2A47AC`](https://holesky.etherscan.io/address/0x9a09A49870353867b0ce9901B44E84C32B2A47AC) | Proxy: [`[email protected]`](https://github.com/OpenZeppelin/openzeppelin-contracts-upgradeable/blob/v5.1.0/contracts/proxy/utils/UUPSUpgradeable.sol) |
 
  
 
-## License
+## :scroll: _License_
 
 2025 SSV Network <https://ssv.network/>