Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
0xkoiner authored Nov 5, 2024
1 parent e71e7b3 commit df6a395
Showing 1 changed file with 9 additions and 62 deletions.
71 changes: 9 additions & 62 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,66 +1,13 @@
## Foundry
## Decentralized Lottery with Chainlink VRF 🎲

**Foundry is a blazing fast, portable and modular toolkit for Ethereum application development written in Rust.**
A fully decentralized lottery application built in Solidity, utilizing Chainlink VRF for provably fair randomization. This project includes comprehensive test coverage with Foundry, ensuring security and reliability.

Foundry consists of:
Features

- **Forge**: Ethereum testing framework (like Truffle, Hardhat and DappTools).
- **Cast**: Swiss army knife for interacting with EVM smart contracts, sending transactions and getting chain data.
- **Anvil**: Local Ethereum node, akin to Ganache, Hardhat Network.
- **Chisel**: Fast, utilitarian, and verbose solidity REPL.
Smart Contracts: Core logic written in Solidity
Chainlink VRF: Secures random number generation for lottery fairness
Automations: Scheduled lottery draws and automated prize distribution
Testing: Full coverage of contract tests in Foundry for robust verification
Perfect for learning decentralized apps, smart contract testing, and the Chainlink VRF.

## Documentation

https://book.getfoundry.sh/

## Usage

### Build

```shell
$ forge build
```

### Test

```shell
$ forge test
```

### Format

```shell
$ forge fmt
```

### Gas Snapshots

```shell
$ forge snapshot
```

### Anvil

```shell
$ anvil
```

### Deploy

```shell
$ forge script script/Counter.s.sol:CounterScript --rpc-url <your_rpc_url> --private-key <your_private_key>
```

### Cast

```shell
$ cast <subcommand>
```

### Help

```shell
$ forge --help
$ anvil --help
$ cast --help
```
This version highlights each major component with a clear focus on functionality and testing!

0 comments on commit df6a395

Please sign in to comment.