• 1. Overview
• 2. Usage
• 3. Functions
  • 3.1. Swap Functions
  • 3.2. Withdraw Functions
  • 3.3. Contract Upgrade Functions
  • 3.4. Contract Update Functions
  • 3.5. Role Management Functions
  • 3.6. Getter Functions
• 4. Installation
  • 4.1. Clone repository
  • 4.2. Install Dependencies
  • 4.3. Create the .env file
• 5. Testing
  • 5.1. Tests (Fork)
  • 5.2. Coverage (Fork)
• 6. Deployment
• 7. Interactions
  • 7.1. Force Send ETH
  • 7.2. Swap Functions
    • 7.2.1. Send ETH
    • 7.2.2. Swap USDC
  • 7.3. Withdraw Functions
    • 7.3.1. Withdraw ETH
    • 7.3.2. Withdraw Tokens
  • 7.4. Upgrades
  • 7.5. Updates
    • 7.5.1. Update Contract Address
    • 7.5.2. Update Token Address
    • 7.5.3. Update UniswapV3Pool Address
    • 7.5.4. Update Slippage Tolerance
  • 7.6. Role Management
    • 7.6.1. Grant Role
    • 7.6.2. Revoke Role
    • 7.6.3. Get Role Admin
    • 7.6.4. Get Role Member
    • 7.6.5. Get Role Members
    • 7.6.6. Get Role Member Count
    • 7.6.7. Check Has Role
    • 7.6.8. Renounce Role
  • 7.7. Getters
    • 7.7.1. Get Creator
    • 7.7.2. Get Version
    • 7.7.3. Get Balance
    • 7.7.4. Get Event Block Numbers
    • 7.7.5. Get Contract Address
    • 7.7.6. Get Token Address
    • 7.7.7. Get Uniswap V3 Pool
    • 7.7.8. Get Module Version
• 8. Build and Deploy Documentation
• 9. License

SimpleSwap is an example project for swapping tokens using Uniswap V3.

The contract structure is broken down into individual contracts, each inherited from the previous contract. This was done as an exercise to better understand smart contract inheritance and to highlight reusable code sections.

Imports ➜ Variables ➜ Getters ➜ ModifiersAndChecks ➜ Updates ➜ Core ➜ SimpleSwap

This project builds on knowledge from the AavePM project.

The TokenSwap contract is a pure logic contract that can be used to swap ETH <-> USDC. It has no owner and is immutable. To upgrade the TokenSwap contract, a new contract must be deployed and the SimpleSwap contract must be updated to point to the new contract.

1. Send ETH directly to the contract address to receive USDC on the sender address.
2. Send USDC to the swapUsdc function to receive ETH on the sender address.

git clone https://github.com/EridianAlpha/simple-swap.git

This should happen automatically when first running a command, but the installation can be manually triggered with the following commands:

git submodule init
git submodule update
make install

Use the .env.example file as a template to create a .env file.

make test
make test-v
make test-summary

make coverage
make coverage-report

Deploys the SimpleSwap contract and all module contracts.

Interactions are defined in ./script/Interactions.s.sol

If DEPLOYED_CONTRACT_ADDRESS is set in the .env file, that contract address will be used for interactions. If that variable is not set, the latest deployment on the specified chain will be used.

Deployed Contracts:

• SimpleSwap: 0xB48feaDA85be6e061ba1D2FF36633C99fe50C0DA
• ERC1967Proxy: 0xea5f4F00f29d97cd3F340e66b80EdbD737ae29ae
• TokenSwapCalcsModule: 0x4B68D4b25d7B484b4a10D88d2c83308831c980B1

Send ETH to the contract using a intermediate selfdestruct contract. This does not call the receive function on the contract. Input value in ETH e.g. 0.15.

Send ETH to the contract to receive USDC. Input value in ETH e.g. 0.15.

Swap USDC for ETH. Input value in USD e.g. 200.

Withdraw all ETH in the contract to an owner address. Requires the specified withdrawal address to have the OWNER_ROLE. Input value as an address e.g. 0x123....

Withdraw all of the specified token in the contract to an owner address. Requires the specified withdrawal address to have the OWNER_ROLE. Input value 1 as a token identifier e.g. USDC. Input value 2 as an address e.g. 0x123.... Combined input value e.g. USDC,0x123....

Upgrade the contract to the latest logic implementation while maintaining the same proxy address. This also redeploys all modules and updates their contract addresses on SimpleSwap.

Update the specified contract identifier to a new address. Input value 1 as a contract identifier e.g. uniswapV3Router. Input value 2 as an address e.g. 0x123.... Combined input value e.g. uniswapV3Router,0x123....

Update the specified token identifier to a new address. Input value 1 as a token identifier e.g. USDC. Input value 2 as an address e.g. 0x123.... Combined input value e.g. USDC,0x123....

Update the specified token identifier to a new address and fee. Input value 1 as a UniswapV3Pool identifier e.g. USDC/ETH. Input value 2 as an address e.g. 0x123.... Input value 3 as a fee e.g. 500 for a fee of 0.05%. Combined input value e.g. USDC/ETH,0x123...,500.

Input value to 2 decimal places e.g. 200 for a Slippage Tolerance of 0.5%.

Grant a role to an address. Requires the caller to be an admin of the role being granted. Input value 1 as a role e.g. OWNER_ROLE. Input value 2 as an address e.g. 0x123.... Combined input value e.g. OWNER_ROLE,0x123....

Revoke a role from an address. Requires the caller to be an admin of the role being revoked. Input value 1 as a role e.g. OWNER_ROLE. Input value 2 as an address e.g. 0x123.... Combined input value e.g. OWNER_ROLE,0x123....

Get the admin for the specified role. Input value as a role e.g. OWNER_ROLE. Returns keccak256 hash of the admin role.

Get the member for the specified role and index. Input value 1 as a role e.g. OWNER_ROLE. Input value 2 as index e.g. 0. Combined input value e.g. OWNER_ROLE,0. Returns address of the member.

Get all members for the specified role. Input value as a role e.g. OWNER_ROLE. Returns array of addresses of the members.

Get the member count for the specified role. Input value as a role e.g. OWNER_ROLE. Returns the number of members in the role.

Check if an address has the specified role. Input value 1 as a role e.g. OWNER_ROLE. Input value 2 as an address e.g. 0x123.... Combined input value e.g. OWNER_ROLE,0x123....

Renounce the specified role from an address. Any address can renounce a role from themselves. Input value as a role e.g. OWNER_ROLE.

Returns the contract creator address.

Returns the current version of the contract.

Input value as token identifier e.g. USDC. Returns the balance of the contract for the specified token.

Returns the block numbers of all previous contract events.

Input value as a contract identifier e.g. uniswapV3Router. Returns the contract address of the specified identifier.

Input value as a token identifier e.g. USDC. Returns the token address of the specified identifier.

Input value as a Uniswap V3 Pool identifier e.g. USDC/ETH. Returns the address and fee of the specified identifier.

Input value as a module identifier e.g. tokenSwapCalcsModule. Returns the version of the specified module.

Instructions on how to build and deploy the documentation book are detailed here: https://docs.eridianalpha.com/ethereum-dev/foundry-notes/docs-and-github-pages

MIT