Skip to content

Commit

Permalink
updated instructions and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Andrew Redden committed Oct 19, 2022
1 parent a97c2ab commit 658ce26
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 5 deletions.
44 changes: 44 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,43 @@
# Astaria contest details

- 50,000 USDC main award pot
- Join [Sherlock Discord](https://discord.gg/MABEWyASkp)
- Submit findings using the issue page in your private contest repo (label issues as med or high)
- [Read for more details](https://docs.sherlock.xyz/audits/watsons)
- Starts October 20, 2022 15:00 UTC
- Ends November 03, 2022 15:00 UTC

# Resources

TBD

# Audit scope


[astaria-gpl](https://github.com/AstariaXYZ/astaria-gpl)

[astaria-core](https://github.com/sherlock-audit/2022-10-astaria)

All contracts in these repos are in scope unless specified below

Not in scope

```
libraries/Base64.sol
libraries/CollateralLookup.sol
scripts/deployments/strategies/*
utils
test
```

# Astaria Docs
For more details on the Astaria protocol and its contracts, see the [docs](https://docs.astaria.xyz/docs/intro)

# Astaria Contracts Setup

Astaria runs on [Foundry](https://github.com/foundry-rs/foundry).
So make sure you get setup with Foundry first

To install contract dependencies, run:

Expand All @@ -13,6 +47,16 @@ forge install
git submodule install
```


To Deploy on a forked network, update your RPC in docker-compose.yml first and then run:

```
sh scripts/boot-system.sh
```




Tests are located in src/test. To run tests, run:

```sh
Expand Down
2 changes: 1 addition & 1 deletion docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ services:
image: ghcr.io/foundry-rs/foundry:nightly-4fcd7e0ecc16c77c381884d0298301fe8b77028d
ports:
- "8545:8545"
entrypoint: ["anvil", "--host", "0.0.0.0"]
entrypoint: ["anvil", "--host", "0.0.0.0", "--fork-url", "<RPC_TO_FORK_HERE>"]
7 changes: 3 additions & 4 deletions scripts/boot-system.sh
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
docker-compose up -d
# consider the hardhat template for the deployment
forge create src/AstariaDeploy.sol:AstariaDeploy --private-key 0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80 --rpc-url http://localhost:8545 --revert-strings debug

# we're on a fork so get some weth
forge script Deploy --broadcast --private-key 0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80 --rpc-url http://localhost:8545
forge script UniqueStrategy --broadcast --private-key 0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80 --rpc-url http://localhost:8545

cast 0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2 --method "deposit" --params "[]" --private-key 0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80 --rpc-url http://localhost:8545 --revert-strings debug
# we're on a fork so get some weth

# create some vaults

Expand Down

0 comments on commit 658ce26

Please sign in to comment.