Skip to content

Latest commit

 

History

History
86 lines (61 loc) · 5.09 KB

README.md

File metadata and controls

86 lines (61 loc) · 5.09 KB
Raw

AMM 101

Introduction

Welcome! This is an automated workshop that will guide you into using Uniswap and doing a simple integration in a smart contract. It is aimed at developpers that are familiar with Solidity and ERC20

How to work on this TD

Introduction

The TD has three components:

  • An ERC20 token, ticker TD-AMM-101, that is used to keep track of points
  • An evaluator contract, that is able to mint and distribute TD-AMM-101 points
  • A dummy ERC20 token that you'll trade in the beginning of the workshop

Your objective is to gather as many TD-AMM-101 points as possible. Please note :

  • The 'transfer' function of TD-AMM-101 has been disabled to encourage you to finish the TD with only one address
  • You can answer the various questions of this workshop with different contracts. However, an evaluated address has only one evaluated contract at a time. To change the evaluated contract associated with your address, call submitExercice() with that specific address.
  • You will also have to deploy an ERC20 and register it with submitErc20()
  • In order to receive points, you will have to do execute code in Evaluator.sol such that the function TDERC20.distributeTokens(msg.sender, n); is triggered, and distributes n points.
  • This repo contains an interface IExerciceSolution.sol. Your ERC20 contract will have to conform to this interface in order to validate the exercice; that is, your contract needs to implement all the functions described in IExerciceSolution.sol.
  • A high level description of what is expected for each exercice is in this readme. A low level description of what is expected can be inferred by reading the code in Evaluator.sol.
  • The Evaluator contract sometimes needs to make payments to buy your tokens. Make sure he has enough ETH to do so! If not, you can send ETH directly to the contract.

Getting to work

  • Clone the repo on your machine
  • Install the required packages npm i
  • Register for an infura API key
  • Create a .env file that contains private key for deployment, an infura API key.
  • To deploy a contract, configure a script in the scripts folder. Look at the way the TD is deployed and try to iterate
  • Test your deployment locallly with anvil and forge script script/your-script.s.sol --fork-url http://localhost:8545 --broadcast -vvvv
  • Deploy on Sepolia forge script script/Counter.s.sol --fork-url $GOERLI --broadcast -vvvv

Points list

Uniswap basics

  • Find the dummyToken address by calling dummyToken() on the Evaluator
  • Buy some units of dummyToken on Uniswap. You can do this using their website. Please let some tokens to the others.
  • Prove that you own these tokens by calling ex1_showIHaveTokens() (2 pts)
  • Provide liquidity to the Weth - dummyToken pool on Uniswap
  • Prove that you own these tokens by calling ex2_showIProvidedLiquidity() (2 pts)

ERC20 basics

  • Call ex3a_getTickerAndSupply() in the evaluator contract to receive a random ticker for your ERC20 token, as well as an initial token supply. You can read your assigned ticker and supply in Evaluator.sol by calling getters readTicker() and readSupply() (2 pt)
  • Create an ERC20 token contract with the proper ticker and supply
  • Deploy it to the goerli testnet
  • Call submitErc20() in the Evaluator to configure the contract you want evaluated (Previous 3 points are attributed at that step)
  • Call ex3b_testErc20TickerAndSupply() in the evaluator to receive your points (2 pts)

Uniswap basics - again

  • Create a uniswap pool for you token and add liquidity to it
  • Call ex4_tokenIsTradableOnUniswap to show your token is tradable on uniswap (5 pts)

Uniswap integration

You will need to interact with UniswapV2Router02 in order to complete this part. It can be found here

  • Create a contract that can swap tokens in Uniswap in the WETH/Your token pool
  • Submit your contract address using submitExercice() (repeat as needed)
  • Prove your contract work by calling ex5_contractCanSwapVsEth() in the evaluator (1pts)
  • Create a contract that can swap tokens in Uniswap in the dummyToken/Your token pool
  • Prove your contract work by calling ex6_contractCanSwapVsDummyToken() in the evaluator (2pts)
  • Create a contract that can deposit tokens in Uniswap in the WETH/Your token pool
  • Prove your contract work by calling ex7_contractCanProvideLiquidity() in the evaluator (2pts)
  • Create a contract that can withdraw tokens in Uniswap from the WETH/Your token pool
  • Prove your contract work by calling ex8_contractCanWithdrawLiquidity() in the evaluator (2pts)

Extra points

Extra points if you find bugs / corrections this TD can benefit from, and submit a PR to make it better. Ideas:

  • Adding a way to check the code of a specific contract was only used once (no copying)
  • Publish the code of the Evaluator on Etherscan using the "Verify and publish" functionnality

TD addresses

  • Points contracts 0xcD41e953423c795BF1b4a68c13ee4A2e6B99C7f3
  • DummyToken 0x99a4859adeD0b841ebFAA9E686D681091A92A263
  • Evaluator 0x88B8B21531BB27Dd6b622aE07487D6f65DAD3848