praneshasp/foundry-faucet

This is a simple project that demonstrates testing and deployment using `forge`

Foundry Faucet

A simple project built using Foundry. This repo contains the implementation of a Faucet contract. You can find the article associated with this repo here.

This repo is created from the forge template.

Getting Started

• Clone this repo:

git clone https://github.com/PraneshASP/foundry-faucet

• Install the dependencies/libraries:

git submodule update --init --recursive
forge install

Directory structure

lib
├─ forge-std — https://github.com/brockelmore/forge-std
├─ openzeppelin-contracts — https://github.com/OpenZeppelin/openzeppelin-contracts
src
├─ tests
│  └─ Faucet.t.sol — "Test suite for the faucet"
├─ Facuet.sol — "A Simple Faucet contract implementation"
└─ MockERC20.sol — "A Mock ERC20 token for the faucet"

Development

Compilation

forge build

Testing

forge test

To run tests with console outputs (console.logs()):

forge test -vv

Deployment

Copy the .env.example file to .env and update the values.

Using forge create:

First, deploy the MockERC20 to Kovan:

./scripts/deploy_token_kovan.sh

Then, deploy the Faucet to Kovan:

./scripts/deploy_faucet_kovan.sh

Using scripts:

npm run deploy:forge

Verification

Add your ETHERSCAN_API_KEY to the .env file.

Then execute the scripts/verify_faucet_kovan.sh script.

./scripts/verify_faucet_kovan.sh

License

MIT

Disclaimer

These smart contracts are being provided as is. No guarantee, representation or warranty is being made, express or implied, as to the safety or correctness of the user interface or the smart contracts. They have not been audited and as such there can be no assurance they will work as intended, and users may experience delays, failures, errors, omissions, loss of transmitted information or loss of funds. The creators are not liable for any of the foregoing. Users should proceed with caution and use at their own risk.