feat: add foundry (#55)

* feat: add foundry
* ci: update actions
* feat: update readme

Author: vittominacori

.github/actions/setup/action.yml

@@ -4,7 +4,7 @@ runs:
   using: composite
   steps:      
     - name: Setup Node
-      uses: actions/setup-node@v4
+      uses: actions/setup-node@v6
       with:
         node-version: 22
 
@@ -19,3 +19,8 @@ runs:
       run: npm ci
       shell: bash
       if: steps.cache.outputs.cache-hit != 'true'
+      
+    - name: Install Foundry
+      uses: foundry-rs/foundry-toolchain@v1
+      with:
+        version: stable  

.github/workflows/ci.yml

@@ -17,7 +17,7 @@ jobs:
       FORCE_COLOR: 1
     steps:
       - name: Setup Code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       - name: Setup Environment
         uses: ./.github/actions/setup
@@ -32,7 +32,7 @@ jobs:
       FORCE_COLOR: 1
     steps:
       - name: Setup Code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       - name: Setup Environment
         uses: ./.github/actions/setup
@@ -50,7 +50,7 @@ jobs:
       FORCE_COLOR: 1
     steps:
       - name: Setup Code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       - name: Setup Environment
         uses: ./.github/actions/setup
@@ -70,13 +70,13 @@ jobs:
       FORCE_COLOR: 1
     steps:
       - name: Setup Code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       - name: Setup Environment
         uses: ./.github/actions/setup
 
       - name: Run Slither
-        uses: crytic/slither-action@v0.4.0
+        uses: crytic/slither-action@v0.4.1
         with:
           node-version: 22
           solc-version: 0.8.30
@@ -88,7 +88,7 @@ jobs:
       FORCE_COLOR: 1
     steps:
       - name: Setup Code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       - name: Run CodeSpell
         uses: codespell-project/actions-codespell@v2

.gitignore

@@ -44,6 +44,11 @@ contracts-exposed
 /artifacts
 /cache
 
+# Foundry
+foundry.lock
+/out
+/cache_forge
+
 # macOS
 .DS_Store
 
@@ -53,10 +58,6 @@ contracts-exposed
 # IntelliJ IDE
 .idea
 
-# vuepress
-pages/.vuepress/dist
-pages/.vuepress/.env.json
-
 # vitepress
 pages/.vitepress/cache
 pages/.vitepress/dist

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "lib/forge-std"]
+	path = lib/forge-std
+	url = https://github.com/foundry-rs/forge-std

README.md

@@ -26,12 +26,22 @@ ERC-1363 is also useful for avoiding token loss or token locking in contracts by
 > [!IMPORTANT]
 > **This repo contains the reference implementation of the official [ERC-1363](https://eips.ethereum.org/EIPS/eip-1363).**
 
-## Install
+## Installation
+
+### Hardhat
 
 ```bash
 npm install erc-payable-token
 ```
 
+### Foundry
+
+```bash
+forge install vittominacori/erc1363-payable-token
+```
+
+Add `erc-payable-token/contracts/=lib/erc1363-payable-token/contracts/` in `remappings.txt`.
+
 ## Usage
 
 ```solidity

contracts/examples/ERC1363Payable.sol

@@ -29,9 +29,7 @@ contract ERC1363Payable is ERC1363Guardian {
      * @dev Payment can be done only using the accepted token.
      */
     modifier onlyAcceptedToken() {
-        if (msg.sender != _acceptedToken) {
-            revert NotAcceptedToken(msg.sender, _acceptedToken);
-        }
+        _onlyAcceptedToken();
         _;
     }
 
@@ -58,6 +56,15 @@ contract ERC1363Payable is ERC1363Guardian {
         return _credits[account];
     }
 
+    /**
+     * @dev Checks that the caller is the accepted token.
+     */
+    function _onlyAcceptedToken() internal view {
+        if (msg.sender != _acceptedToken) {
+            revert NotAcceptedToken(msg.sender, _acceptedToken);
+        }
+    }
+
     /**
      * @inheritdoc ERC1363Guardian
      */

contracts/mocks/ERC1363ReturnFalseOnERC20Mock.sol

@@ -2,7 +2,9 @@
 
 pragma solidity ^0.8.20;
 
-import {IERC20, ERC20, ERC1363} from "../token/ERC1363/ERC1363.sol";
+import {IERC20} from "@openzeppelin/contracts/token/ERC20/ERC20.sol";
+
+import {ERC20, ERC1363} from "../token/ERC1363/ERC1363.sol";
 
 // mock class testing an ERC-20 token that returns false
 abstract contract ERC1363ReturnFalseOnERC20Mock is ERC1363 {

contracts/token/ERC1363/ERC1363.sol

@@ -2,7 +2,7 @@
 
 pragma solidity ^0.8.20;
 
-import {IERC20, ERC20} from "@openzeppelin/contracts/token/ERC20/ERC20.sol";
+import {ERC20} from "@openzeppelin/contracts/token/ERC20/ERC20.sol";
 import {IERC165, ERC165} from "@openzeppelin/contracts/utils/introspection/ERC165.sol";
 
 import {IERC1363} from "./IERC1363.sol";

foundry.toml

@@ -0,0 +1,13 @@
+[profile.default]
+src = 'contracts'
+out = 'out'
+libs = ['node_modules', 'lib']
+test = 'test'
+cache_path  = 'cache_forge'
+solc_version = '0.8.30'
+evm_version = 'prague'
+optimizer = true
+optimizer-runs = 200
+
+[lint]
+exclude_lints = ["screaming-snake-case-immutable"]

hardhat.config.js

@@ -1,5 +1,6 @@
 require('@nomicfoundation/hardhat-chai-matchers');
 require('@nomiclabs/hardhat-truffle5');
+require('@nomicfoundation/hardhat-foundry');
 require('hardhat-exposed');
 require('hardhat-gas-reporter');
 require('solidity-coverage');