Skip to content

Commit

Permalink
docs: add README
Browse files Browse the repository at this point in the history
  • Loading branch information
0xAustrian committed Sep 9, 2024
1 parent db04f7f commit 4b207be
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions script/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Deployment scripts

This folder contains the scripts neccessary to deploy strategies and Allo contracts to the blockchain.

# Usage

1. Install dependencies by running `bun install`.
2. Compile contracts by running `bun smock && bun compile`.
3. Fill the necessary environment variables in `.env` file. You can use `.env.example` as a template.
4. Run the deployment script with:
```
forge script script/${SCRIPT_FILENAME}.sol:${SCRIPT_CONTRACT_NAME} --fork-url ${RPC_URL} --private-key ${PRIVATE_KEY} --broadcast
```
For example:
```
forge script script/DeployDirectAllocation.sol:DeployDirectAllocation --fork-url https://eth-sepolia.public.blastapi.io --private-key 0x0000 --broadcast
```

0 comments on commit 4b207be

Please sign in to comment.