initial commit

bartomolina · bartomolina · commit f99465c26493 · 2025-10-22T10:23:50.000+02:00
diff --git a/.DS_Store b/.DS_Store
diff --git a/.env.example b/.env.example
@@ -0,0 +1 @@
+PRIVATE_KEY=
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,14 @@
+# Compiler files
+cache/
+out/
+
+# Ignores development broadcast logs
+!/broadcast
+/broadcast/*/31337/
+/broadcast/**/dry-run/
+
+# Docs
+docs/
+
+# Dotenv file
+.env
diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,7 @@
+
+[submodule "lib/aave-v4"]
+	path = lib/aave-v4
+	url = https://github.com/aave/aave-v4
+[submodule "lib/forge-std"]
+	path = lib/forge-std
+	url = https://github.com/foundry-rs/forge-std
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,4 @@
+out
+lib
+cache
+node_modules
diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1,15 @@
+{
+    "overrides": [
+      {
+        "files": "*.sol",
+        "options": {
+          "printWidth": 80,
+          "tabWidth": 2,
+          "useTabs": false,
+          "singleQuote": true,
+          "bracketSpacing": false,
+          "explicitTypes": "always"
+        }
+      }
+    ]
+  }
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Aave Labs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,66 @@
+## Aave v4 Foundry Boilerplate
+
+This repository contains a minimal boilerplate for developing smart contracts that integrate with Aave v4 using [Foundry](https://book.getfoundry.sh/).
+
+## Table of Contents <!-- omit in toc -->
+
+- [Requirements](#requirements)
+- [Initial Setup](#initial-setup)
+- [Usage](#usage)
+- [License](#license)
+
+## Requirements
+
+- Foundry
+
+Install or update Foundry:
+
+```bash
+curl -L https://foundry.paradigm.xyz | bash
+foundryup
+```
+
+## Initial Setup
+
+# Install dependencies
+
+```bash
+forge install
+```
+
+Create a `.env` file copying the `.env.example` file:
+
+```bash
+cp .env.example .env
+```
+
+Update the `.env` file with the correct values.
+
+## Usage
+
+### Build
+
+```shell
+$ forge build
+```
+
+### Test
+
+```shell
+forge test
+```
+
+### Deploy
+
+```shell
+forge script script/Deploy_UserPositions.s.sol:DeployUserPositions \
+  --sig "run(address)" <SPOKE_ADDRESS> \
+  --rpc-url <RPC_URL> \
+  --private-key <PRIVATE_KEY> \
+```
+
+Need to add or update dependencies later? Run `forge install owner/repo` to pull them in and keep `foundry.lock` synchronized.
+
+## License
+
+Aave v4 Foundry Boilerplate [MIT licensed](./LICENSE)
diff --git a/foundry.lock b/foundry.lock
@@ -0,0 +1,14 @@
+{
+  "lib/aave-v4": {
+    "tag": {
+      "name": "v0.5.2",
+      "rev": "14a824b258eb76b7a1ec86bd6cbe79da2539aed8"
+    }
+  },
+  "lib/forge-std": {
+    "tag": {
+      "name": "v1.11.0",
+      "rev": "8e40513d678f392f398620b3ef2b418648b33e89"
+    }
+  }
+}
diff --git a/foundry.toml b/foundry.toml
@@ -0,0 +1,7 @@
+[profile.default]
+src = "src"
+out = "out"
+libs = ["lib"]
+solc_version = "0.8.28"
+
+# See more config options https://github.com/foundry-rs/foundry/blob/master/crates/config/README.md#all-options
diff --git a/lib/aave-v4 b/lib/aave-v4
@@ -0,0 +1 @@
+Subproject commit 14a824b258eb76b7a1ec86bd6cbe79da2539aed8
diff --git a/lib/forge-std b/lib/forge-std
@@ -0,0 +1 @@
+Subproject commit 8e40513d678f392f398620b3ef2b418648b33e89
diff --git a/script/Deploy_UserPositions.s.sol b/script/Deploy_UserPositions.s.sol
@@ -0,0 +1,19 @@
+// SPDX-License-Identifier: AGPL-3.0
+pragma solidity ^0.8.10;
+
+import {Script} from 'forge-std/Script.sol';
+import {console} from 'forge-std/Test.sol';
+import {UserPositions} from '../src/UserPositions.sol';
+
+contract DeployUserPositions is Script {
+  function run(address spoke) external {
+    console.log('Deploying UserPositions', spoke);
+    uint256 deployerPrivateKey = vm.envUint('PRIVATE_KEY');
+    vm.startBroadcast(deployerPrivateKey);
+    UserPositions userPositions = new UserPositions(spoke);
+    vm.stopBroadcast();
+    console.log('UserPositions deployed at', address(userPositions));
+  }
+}
+
+
diff --git a/src/UserPositions.sol b/src/UserPositions.sol
@@ -0,0 +1,27 @@
+// SPDX-License-Identifier: AGPL-3.0
+pragma solidity ^0.8.10;
+
+import {ISpoke} from 'aave-v4/src/spoke/interfaces/ISpoke.sol';
+
+/// @title UserPositions
+/// @notice Query Aave v4 Spoke for a user's reserve position.
+contract UserPositions {
+  ISpoke public immutable SPOKE;
+
+  /// @param spoke Address of the Aave v4 Spoke contract
+  constructor(address spoke) {
+    require(spoke != address(0), 'INVALID_SPOKE');
+    SPOKE = ISpoke(spoke);
+  }
+
+  /// @notice Returns the position for a user in a specific reserve.
+  function getUserPosition(uint256 reserveId, address user)
+    external
+    view
+    returns (ISpoke.UserPosition memory)
+  {
+    return SPOKE.getUserPosition(reserveId, user);
+  }
+}
+
+
diff --git a/test/UserPositions.sol b/test/UserPositions.sol
@@ -0,0 +1,40 @@
+// SPDX-License-Identifier: AGPL-3.0
+pragma solidity ^0.8.10;
+
+import {Test} from 'forge-std/Test.sol';
+import {UserPositions} from '../src/UserPositions.sol';
+import {ISpoke} from 'aave-v4/src/spoke/interfaces/ISpoke.sol';
+
+contract UserPositionsTest is Test {
+  UserPositions internal userPositions;
+  address internal spoke;
+  address internal user;
+
+  function setUp() public {
+    spoke = makeAddr("SPOKE");
+    userPositions = new UserPositions(spoke);
+    user = makeAddr("USER");
+  }
+
+  function test_getUserPosition() public {
+    uint256 reserveId = 7;
+    ISpoke.UserPosition memory p = ISpoke.UserPosition({
+      drawnShares: 10,
+      realizedPremium: 0,
+      premiumShares: 0,
+      premiumOffset: 0,
+      suppliedShares: 50,
+      configKey: 1
+    });
+
+    vm.mockCall(
+      spoke,
+      abi.encodeWithSelector(ISpoke.getUserPosition.selector, reserveId, user),
+      abi.encode(p)
+    );
+    ISpoke.UserPosition memory got = userPositions.getUserPosition(reserveId, user);
+    assertEq(got.suppliedShares, 50);
+  }
+}
+
+

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +out
 +lib
 +cache
 +node_modules