diff --git a/.gitmodules b/.gitmodules
index bfd357b9..dff455ab 100644
--- a/.gitmodules
+++ b/.gitmodules
@@ -16,3 +16,6 @@
[submodule "packages/foundry/lib/balancer-v3-monorepo"]
path = packages/foundry/lib/balancer-v3-monorepo
url = https://github.com/balancer/balancer-v3-monorepo
+[submodule "packages/foundry/lib/openzeppelin-contracts-upgradeable"]
+ path = packages/foundry/lib/openzeppelin-contracts-upgradeable
+ url = https://github.com/OpenZeppelin/openzeppelin-contracts-upgradeable
diff --git a/README.md b/README.md
index 1397b2da..57ac0d6c 100644
--- a/README.md
+++ b/README.md
@@ -1,301 +1,158 @@
-# ๐๏ธ Scaffold Balancer v3
-A starter kit for building on top of Balancer v3. Accelerate the process of creating custom pools and hooks contracts. Concentrate on mastering the core concepts within a swift and responsive environment augmented by a local fork and a frontend pool operations playground.
+# SafeSwap
-[](https://www.youtube.com/watch?v=m6q5M34ZdXw)
+SafeSwap is a decentralized automated market maker (AMM) built on the Balancer V3 protocol. It enables liquidity providers to add and remove liquidity in a pool while allowing users to swap between tokens. Additionally, SafeSwap introduces a unique discount mechanism for users holding a specific token, providing them with a 10% discount on swap fees.
-### ๐ Development Life Cycle
+## Key Features
-1. Learn the core concepts for building on top of Balancer v3
-2. Configure and deploy factories, pools, and hooks contracts to a local anvil fork of Sepolia
-3. Interact with pools via a frontend that runs at [localhost:3000](http://localhost:3000/)
+- **Balancer V3 Integration**: Built on top of the Balancer V3 protocol with BalancerPoolToken, allowing flexible pool operations.
+- **Custom Liquidity Operations**: Custom hooks for adding and removing liquidity.
+- **Discount on Swap Fees**: Users holding a specific ERC-20 token are eligible for a 10% discount on the swap fee.
+- **Optimized Fee Structure**: The contract enforces a swap fee between 0% and 10%, with a default fee of 10%, reduced if the user qualifies for a discount.
-### ๐ชง Table Of Contents
+## Contract Structure
-- [๐งโ๐ป Environment Setup](#-environment-setup)
-- [๐ฉโ๐ซ Learn Core Concepts](#-learn-core-concepts)
-- [๐ต๏ธ Explore the Examples](#-explore-the-examples)
-- [๐ Create a Custom Pool](#-create-a-custom-pool)
-- [๐ญ Create a Pool Factory](#-create-a-pool-factory)
-- [๐ช Create a Pool Hook](#-create-a-pool-hook)
-- [๐ข Deploy the Contracts](#-deploy-the-contracts)
-- [๐งช Test the Contracts](#-test-the-contracts)
+### SafeSwap
-## ๐งโ๐ป Environment Setup
+The `SafeSwap` contract extends the Balancer V3 pool functionality with added customization for liquidity and swaps:
-### 1. Requirements ๐
+- **Discount Token**: The contract allows setting a discount token, an ERC-20 token. Users holding this token in their wallets receive a reduced swap fee.
+- **Swap Fee Logic**: The default swap fee is 10%, which can be reduced by 10% (i.e., down to 9%) if the user holds the discount token.
+- **Custom Liquidity Hooks**: Implementations for custom liquidity operations (`onAddLiquidityCustom` and `onRemoveLiquidityCustom`).
-- [Node (>= v18.17)](https://nodejs.org/en/download/)
-- Yarn ([v1](https://classic.yarnpkg.com/en/docs/install/) or [v2+](https://yarnpkg.com/getting-started/install))
-- [Git](https://git-scm.com/downloads)
-- [Foundry](https://book.getfoundry.sh/getting-started/installation) (>= v0.2.0)
+### Key Functions
-### 2. Quickstart ๐
+1. **`onSwap`**: Executes a token swap within the pool. If the user holds the discount token, they receive a 10% discount on the swap fee.
+ - Parameters:
+ - `params`: Pool swap parameters, including token balances and amounts.
+ - Returns:
+ - `amountCalculatedScaled18`: The calculated amount for the swap, adjusted for the discounted swap fee.
-1. Ensure you have the latest version of foundry installed
+2. **`computeInvariant`**: Calculates the pool's invariant based on the current token balances.
-```
-foundryup
-```
+3. **`onAddLiquidityCustom`**: Custom implementation for adding liquidity to the pool.
+ - Returns:
+ - `amountsInScaled18`: Amount of tokens being added to the pool.
+ - `bptAmountOut`: Calculated pool token (BPT) amount the user receives.
+ - `swapFeeAmountsScaled18`: The swap fee charged for each token.
-2. Clone this repo & install dependencies
+4. **`onRemoveLiquidityCustom`**: Custom implementation for removing liquidity from the pool.
+ - Returns:
+ - `bptAmountIn`: Amount of pool tokens (BPT) burned.
+ - `amountsOutScaled18`: Amount of tokens the user receives.
+ - `swapFeeAmountsScaled18`: The swap fee charged for each token.
-```bash
-git clone https://github.com/balancer/scaffold-balancer-v3.git
-cd scaffold-balancer-v3
-yarn install
-```
+### Discount Logic
-3. Set a `SEPOLIA_RPC_URL` in the `packages/foundry/.env` file
+The discount logic checks whether the user holds a specific ERC-20 token (the "discount token"). If the user holds this token, they are eligible for a 10% discount on the swap fee.
-```
-SEPOLIA_RPC_URL=...
-```
+### Constructor Parameters
-4. Start a local anvil fork of the Sepolia testnet
+The `SafeSwap` contract constructor takes the following parameters:
-```bash
-yarn fork
-```
-
-5. Deploy the mock tokens, pool factories, pool hooks, and custom pools contracts
- > By default, the anvil account #0 will be the deployer and recieve the mock tokens and BPT from pool initialization
+1. **`IVault vault`**: The Balancer Vault that manages the pool.
+2. **`string name`**: Name of the pool token (BPT).
+3. **`string symbol`**: Symbol of the pool token (BPT).
+4. **`address discountToken`**: The address of the ERC-20 token that provides users with the discount on swap fees.
-```bash
-yarn deploy
-```
+### Deployment
-6. Start the nextjs frontend
+To deploy the contract, provide the following arguments to the constructor:
-```bash
-yarn start
+```solidity
+constructor(
+ IVault vault,
+ string memory name,
+ string memory symbol,
+ address _discountToken
+)
```
-7. Explore the frontend
+- **`vault`**: Address of the Balancer Vault.
+- **`name`**: The name of the Balancer Pool Token (BPT).
+- **`symbol`**: The symbol of the Balancer Pool Token (BPT).
+- **`_discountToken`**: Address of the ERC-20 token that gives users a swap fee discount.
-- Navigate to http://localhost:3000 to see the home page
-- Visit the [Pools Page](http://localhost:3000/pools) to search by address or select using the pool buttons
-- Vist the [Debug Page](http://localhost:3000/debug) to see the mock tokens, factory, and hooks contracts
+### Example
-8. Run the Foundry tests
+Deploying the `SafeSwap` contract:
+```solidity
+SafeSwap safeSwap = new SafeSwap(
+ vaultAddress,
+ "SafeSwap Pool Token",
+ "SSPT",
+ discountTokenAddress
+);
```
-yarn test
-```
-
-### 3. Scaffold ETH 2 Tips ๐๏ธ
-
-SE-2 offers a variety of configuration options for connecting an account, choosing networks, and deploying contracts
-
-๐ฅ Burner Wallet
-
-If you do not have an active wallet extension connected to your web browser, then scaffold eth will automatically connect to a "burner wallet" that is randomly generated on the frontend and saved to the browser's local storage. When using the burner wallet, transactions will be instantly signed, which is convenient for quick iterative development.
-
-To force the use of burner wallet, disable your browsers wallet extensions and refresh the page. Note that the burner wallet comes with 0 ETH to pay for gas so you will need to click the faucet button in top right corner. Also the mock tokens for the pool are minted to your deployer account set in `.env` so you will want to navigate to the "Debug Contracts" page to mint your burner wallet some mock tokens to use with the pool.
-
-
-
-
-
-๐ Browser Extension Wallet
-
-- To use your preferred browser extension wallet, ensure that the account you are using matches the PK you previously provided in the `foundry/.env` file
-- You may need to add a local development network with rpc url `http://127.0.0.1:8545/` and chain id `31337`. Also, you may need to reset the nonce data for your wallet exension if it gets out of sync.
-๐ Debug Contracts Page
+If a user holds the specified `discountToken`, they will receive a 10% discount on the swap fee:
-The [Debug Contracts Page](http://localhost:3000/debug) can be useful for viewing and interacting with all of the externally avaiable read and write functions of a contract. The page will automatically hot reload with contracts that are deployed via the `01_DeployConstantSumFactory.s.sol` script. We use this handy setup to mint `mockERC20` tokens to any connected wallet
+- Default swap fee: 10%
+- Discounted swap fee: 9% (if the user holds the discount token)
-๐ Changing The Frontend Network Connection
+To install and run the SafeSwap contract, follow these steps:
-- The network the frontend points at is set via `targetNetworks` in the `scaffold.config.ts` file using `chains` from viem.
-- By default, the frontend runs on a local node at `http://127.0.0.1:8545`
+1. Clone the repository:
-```typescript
-const scaffoldConfig = {
- targetNetworks: [chains.foundry],
-```
-
-๐ด Changing The Forked Network
-
-- By default, the `yarn fork` command points at sepolia, but any of the network aliases from the `[rpc_endpoints]` of `foundry.toml` can be used to modify the `"fork"` alias in the `packages/foundry/package.json` file
-
-```json
- "fork": "anvil --fork-url ${0:-sepolia} --chain-id 31337 --config-out localhost.json",
+```bash
+git clone https://github.com/your-repo/safeswap.git
```
-- To point the frontend at a different forked network, change the `targetFork` in `scaffold.config.ts`
+2. Install dependencies:
-```typescript
-const scaffoldConfig = {
- // The networks the frontend can connect to
- targetNetworks: [chains.foundry],
-
- // If using chains.foundry as your targetNetwork, you must specify a network to fork
- targetFork: chains.sepolia,
+```bash
+npm install
```
-