Skip to content

Commit

Permalink
add readme to gda example
Browse files Browse the repository at this point in the history
  • Loading branch information
youssefea committed Jan 21, 2024
1 parent 1384869 commit 1afc186
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions projects/gda-advertisement-auction/README.md
Original file line number Diff line number Diff line change
@@ -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/[email protected] --no-commit`
4. Compile the contracts with `forge build`.
5. Run the test suite with `forge test`.

0 comments on commit 1afc186

Please sign in to comment.