Cyfrin F23 / foundry-smart-contract-lottery-f23
Docs
Source
ChefGPT

Cyfrin Foundry-23 implementation of a loterry project using Chainlink VRF for randomization. Also equipped with unit and forked testing.

VRFConsumerBaseV2.sol
AutomationCompatibleInterface.sol
VRFCoordinatorV2Interface.sol
VRFCoordinatorV2Mock.sol
ConfirmedOwner.sol
ConfirmedOwnerWithProposal.sol
IOwnable.sol
LinkTokenInterface.sol
VRFConsumerBase.sol
VRFConsumerBaseV2.sol
VRFRequestIDBase.sol
test.sol
Base.sol
Script.sol
StdAssertions.sol
StdChains.sol
StdCheats.sol
StdError.sol
StdInvariant.sol
StdJson.sol
StdMath.sol
StdStorage.sol
StdStyle.sol
StdUtils.sol
Test.sol
Vm.sol
console.sol
console2.sol
IMulticall3.sol
safeconsole.sol
DevOpsTools.sol
StringUtils.sol
ERC20.sol
DeployRaffle.s.sol
HelperConfig.s.sol
Interactions.s.sol
Raffle.sol
ExampleEvents.sol
ExampleModulo.sol
ExampleRevert.sol
LinkToken.sol
VRFCoordinatorV2Mock.sol
VRFCoordinatorV2_5Mock.sol
RaffleStagingTest.t.sol
RaffleTest.t.sol
Downloads5

Chains

Authors

Cyfrin F23 / foundry-smart-contract-lottery-f23
Info
Source
ChefGPT
Expand
Share

Get Cookin'

Downloads5

Authors

! Updates from Video

  1. V2.5 of Chainlink VRF uses a uint256 as a subId instead of a uint64 this repo has a comment to reflect that. We added a mock in case you'd like to work with version 2.5.
  2. We use 0.1.0 of the foundry-devops package which doesn't need to have ffi=true

Foundry Smart Contract Lottery

This is a section of the Cyfrin Foundry Solidity Course.

⭐️ (3:04:09) | Lesson 9: Foundry Smart Contract Lottery

Getting Started

Requirements

  • git
    • You'll know you did it right if you can run git --version and you see a response like git version x.x.x
  • foundry
    • You'll know you did it right if you can run forge --version and you see a response like forge 0.2.0 (816e00b 2023-03-16T00:05:26.396218Z)

Quickstart

git clone https://github.com/Cyfrin/foundry-smart-contract-lottery-f23
cd foundry-smart-contract-lottery-f23
forge build

Optional Gitpod

If you can't or don't want to run and install locally, you can work with this repo in Gitpod. If you do this, you can skip the clone this repo part.

Open in Gitpod

Usage

Start a local node

make anvil

Library

If you're having a hard time installing the chainlink library, you can optionally run this command.

forge install smartcontractkit/chainlink-brownie-contracts@0.6.1 --no-commit

Deploy

This will default to your local node. You need to have it running in another terminal in order for it to deploy.

make deploy

Deploy - Other Network

See below

Testing

We talk about 4 test tiers in the video.

  1. Unit
  2. Integration
  3. Forked
  4. Staging

This repo we cover #1 and #3.

forge test

or

forge test --fork-url $SEPOLIA_RPC_URL

Test Coverage

forge coverage

Deployment to a testnet or mainnet

  1. Setup environment variables

You'll want to set your SEPOLIA_RPC_URL and PRIVATE_KEY as environment variables. You can add them to a .env file, similar to what you see in .env.example.

  • PRIVATE_KEY: The private key of your account (like from metamask). NOTE: FOR DEVELOPMENT, PLEASE USE A KEY THAT DOESN'T HAVE ANY REAL FUNDS ASSOCIATED WITH IT.
  • SEPOLIA_RPC_URL: This is url of the sepolia testnet node you're working with. You can get setup with one for free from Alchemy

Optionally, add your ETHERSCAN_API_KEY if you want to verify your contract on Etherscan.

  1. Get testnet ETH

Head over to faucets.chain.link and get some testnet ETH. You should see the ETH show up in your metamask.

  1. Deploy
make deploy ARGS="--network sepolia"

This will setup a ChainlinkVRF Subscription for you. If you already have one, update it in the scripts/HelperConfig.s.sol file. It will also automatically add your contract as a consumer.

  1. Register a Chainlink Automation Upkeep

You can follow the documentation if you get lost.

Go to automation.chain.link and register a new upkeep. Choose Custom logic as your trigger mechanism for automation. Your UI will look something like this once completed:

Automation

Scripts

After deploying to a testnet or local net, you can run the scripts.

Using cast deployed locally example:

cast send <RAFFLE_CONTRACT_ADDRESS> "enterRaffle()" --value 0.1ether --private-key <PRIVATE_KEY> --rpc-url $SEPOLIA_RPC_URL

or, to create a ChainlinkVRF Subscription:

make createSubscription ARGS="--network sepolia"

Estimate gas

You can estimate how much gas things cost by running:

forge snapshot

And you'll see an output file called .gas-snapshot

Formatting

To run code formatting:

forge fmt

Thank you!

If you appreciated this, feel free to follow me or donate!

ETH/Arbitrum/Optimism/Polygon/etc Address: 0x9680201d9c93d65a3603d2088d125e955c73BD65

Patrick Collins Twitter Patrick Collins YouTube Patrick Collins Linkedin Patrick Collins Medium

Cyfrin Foundry-23 implementation of a loterry project using Chainlink VRF for randomization. Also equipped with unit and forked testing.
VRFConsumerBaseV2.sol
AutomationCompatibleInterface.sol
VRFCoordinatorV2Interface.sol
VRFCoordinatorV2Mock.sol
ConfirmedOwner.sol
ConfirmedOwnerWithProposal.sol
IOwnable.sol
LinkTokenInterface.sol
VRFConsumerBase.sol
VRFConsumerBaseV2.sol
VRFRequestIDBase.sol
test.sol
Base.sol
Script.sol
StdAssertions.sol
StdChains.sol
StdCheats.sol
StdError.sol
StdInvariant.sol
StdJson.sol
StdMath.sol
StdStorage.sol
StdStyle.sol
StdUtils.sol
Test.sol
Vm.sol
console.sol
console2.sol
IMulticall3.sol
safeconsole.sol
DevOpsTools.sol
StringUtils.sol
ERC20.sol
DeployRaffle.s.sol
HelperConfig.s.sol
Interactions.s.sol
Raffle.sol
ExampleEvents.sol
ExampleModulo.sol
ExampleRevert.sol
LinkToken.sol
VRFCoordinatorV2Mock.sol
VRFCoordinatorV2_5Mock.sol
RaffleStagingTest.t.sol
RaffleTest.t.sol