From 1afc186c0c8126e7fb3f666999afb4b8f274e883 Mon Sep 17 00:00:00 2001 From: youssefea Date: Sun, 21 Jan 2024 21:41:21 +0000 Subject: [PATCH] add readme to gda example --- projects/gda-advertisement-auction/README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 projects/gda-advertisement-auction/README.md diff --git a/projects/gda-advertisement-auction/README.md b/projects/gda-advertisement-auction/README.md new file mode 100644 index 0000000..9bde8d1 --- /dev/null +++ b/projects/gda-advertisement-auction/README.md @@ -0,0 +1,16 @@ +# Welcome to the Advertisement Auction + +### A basic example to get you started with the Superfluid's Distributions (General Distribution Agreement) + +To get started with the updated version: + +1. Navigate to the `foundry-tests`folder + * `cd projects/gda-advertisement-auction/foundry-tests` +2. Create a .env file or simple export the environment variable RPC URL necessary for the Polygon Mumbai fork: + * `export MUMBAI_RPC_URL=https://rpc-mumbai.maticvigil.com` + Make sure to use a un RPC URL that is functional. Check [Chainlist](https://chainlist.org/chain/80001) for more URLs. +3. Install dependencies with specific commands: + * `forge install superfluid-protocol-monorepo=https://github.com/superfluid-finance/protocol-monorepo@dev --no-commit` + * `forge install https://github.com/OpenZeppelin/openzeppelin-contracts@v4.9.3 --no-commit` +4. Compile the contracts with `forge build`. +5. Run the test suite with `forge test`.