Initial commit

.github/workflows/test.yml

@@ -0,0 +1,45 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+env:
+  FOUNDRY_PROFILE: ci
+
+jobs:
+  check:
+    strategy:
+      fail-fast: true
+
+    name: Foundry project
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+        with:
+          version: nightly
+
+      - name: Show Forge version
+        run: |
+          forge --version
+
+      - name: Run Forge fmt
+        run: |
+          forge fmt --check
+        id: fmt
+
+      - name: Run Forge build
+        run: |
+          forge build --sizes
+        id: build
+
+      - name: Run Forge tests
+        run: |
+          forge test -vvv
+        id: test

.gitignore

@@ -0,0 +1,14 @@
+# Compiler files
+cache/
+out/
+
+# Ignores development broadcast logs
+!/broadcast
+/broadcast/*/31337/
+/broadcast/**/dry-run/
+
+# Docs
+docs/
+
+# Dotenv file
+.env

.gitmodules

@@ -0,0 +1,12 @@
+[submodule "lib/forge-std"]
+	path = lib/forge-std
+	url = https://github.com/foundry-rs/forge-std
+[submodule "lib/chainlink-brownie-contracts"]
+	path = lib/chainlink-brownie-contracts
+	url = https://github.com/smartcontractkit/chainlink-brownie-contracts
+[submodule "lib/solmate"]
+	path = lib/solmate
+	url = https://github.com/transmissions11/solmate
+[submodule "lib/foundry-devops"]
+	path = lib/foundry-devops
+	url = https://github.com/Cyfrin/foundry-devops

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 blockketten
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -0,0 +1,14 @@
+-include .env
+
+DEFAULT_ANVIL_KEY := 0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80
+
+install :; forge install cyfrin/[email protected] --no-commit && forge install smartcontractkit/[email protected] --no-commit && forge install foundry-rs/[email protected] --no-commit && forge install transmissions11/solmate@v6 --no-commit
+
+build:; forge build
+
+test :; forge test 
+
+deploy-sepolia: ## Deploy the contract on Sepolia network
+	@forge script script/DeployRaffle.s.sol:DeployRaffle --rpc-url $(SEPOLIA_RPC_URL) --account $(ACCOUNT) --broadcast --verify --etherscan-api-key $(ETHERSCAN_API_KEY) -vvvv
+
+

README.md

@@ -0,0 +1,151 @@
+
+# Raffle Contract
+
+## Overview
+
+This repository contains a smart contract for a decentralized raffle system built on the Ethereum blockchain using Solidity. The contract leverages Chainlink VRF (Verifiable Random Function) v2.5 for random number generation to ensure fairness in selecting the raffle winner.
+
+## Table of Contents
+
+- [Raffle Contract](#raffle-contract)
+  - [Overview](#overview)
+  - [Table of Contents](#table-of-contents)
+  - [Getting Started](#getting-started)
+    - [Prerequisites](#prerequisites)
+    - [Installation](#installation)
+    - [Deployment on Ethereum Sepolia](#deployment-on-ethereum-sepolia)
+    - [Interactions](#interactions)
+    - [Testing](#testing)
+  - [Contract Details](#contract-details)
+    - [Raffle Contract](#raffle-contract-1)
+      - [State Variables](#state-variables)
+      - [Functions](#functions)
+      - [Events](#events)
+  - [License](#license)
+
+## Getting Started
+
+These instructions will help you set up the project on your local machine for development and testing purposes.
+
+### Prerequisites
+
+- [Node.js](https://nodejs.org/)
+- [npm](https://www.npmjs.com/)
+- [Foundry](https://book.getfoundry.sh/)
+- A web3 wallet, such as Metamask
+- A small balance of Sepolia $ETH and $LINK: These can be acquired from faucets.
+
+### Installation
+
+Clone the repository and install the necessary dependencies:
+
+```bash
+git clone https://github.com/yourusername/raffle-contract.git
+cd raffle-contract
+make install
+```
+
+### Deployment on Ethereum Sepolia
+
+To deploy the smart contract on Ethereum Sepolia, you need to configure environment variables and deploy the contract using Foundry.
+
+Ideally, you would create your own Chainlink VRF subscription on Ethereum Sepolia network and add your own admin public key address and VRF subscription ID into the config file.
+
+However, you are free to use my Chainlink subscription. If the LINK balance drops to low, shoot me a message and I will top it up.
+
+1. Create a keystore that encrypts and stores your private key securely:
+
+```bash
+cast wallet import <keystore account name> –interactive
+```
+
+You will need to type in your private key and then a password that you must remember to decrypt the private key later.
+
+2. Create a `.env` file in the project root and add your environment variables:
+
+```env
+SEPOLIA_RPC_URL=<Your Sepolia RPC URL>
+ACCOUNT=<Your keystore account name>
+ETHERSCAN_API_KEY=<Your Etherscan API Key>
+```
+
+3.  Deploy the contract the contract on Sepolia:
+
+```bash
+make deploy-sepolia
+```
+
+You will need to enter the aforementioned keystore password to complete the deployment
+
+4. Automate upkeep of the contract (resetting the contract state for a new raffle after a previous one has completed):
+
+Go to https://automation.chain.link/, connect your wallet, and select "Register new Upkeep".
+
+Select "Custom Logic", click "Next", provide a name for your contract, enter an initial amount of LINK to fund the Upkeep with (there is a link to a faucet, in case you don't have any testnet LINK), and then click "Register Upkeep". Your web3 wallet will prompt you to send a transaction and sign a message. Your Upkeep is now setup and maintenance of the contract is automated. Congrats!
+
+
+
+### Interactions
+
+The repository contains scripts to interact with the deployed contract.
+
+1. Create a subscription:
+
+```bash
+forge script script/CreateSubscription.s.sol:CreateSubscription --broadcast
+```
+
+2. Fund the subscription:
+
+```bash
+forge script script/FundSubscription.s.sol:FundSubscription --broadcast
+```
+
+3. Add a consumer:
+
+```bash
+forge script script/AddConsumer.s.sol:AddConsumer --broadcast
+```
+
+### Testing
+
+To run the tests, use the following command:
+
+```bash
+forge test
+```
+
+## Contract Details
+
+### Raffle Contract
+
+The `Raffle` contract allows users to buy tickets and enter a raffle. The contract uses Chainlink VRF v2.5 for random number generation to ensure fairness.
+
+#### State Variables
+
+- `i_entranceFee`: The cost to enter the raffle.
+- `i_interval`: The duration of the raffle in seconds.
+- `i_keyHash`: The gas lane key hash.
+- `i_subscriptionId`: The subscription ID for the VRF coordinator.
+- `i_callbackGasLimit`: The gas limit for the callback.
+- `s_lastTimeStamp`: The last time the raffle was run.
+- `s_players`: The array of addresses of players in the raffle.
+- `s_recentWinner`: The address of the most recent winner.
+- `s_raffleState`: The state of the raffle (OPEN or CALCULATING).
+
+#### Functions
+
+- `enterRaffle`: Allows users to enter the raffle by paying the entrance fee.
+- `checkUpkeep`: Checks if the raffle is ready to pick a winner.
+- `performUpkeep`: Requests random words from the VRF coordinator.
+- `fulfillRandomWords`: Picks a winner and transfers the prize.
+
+#### Events
+
+- `RaffleEntered`: Emitted when a player enters the raffle.
+- `WinnerPicked`: Emitted when a winner is picked.
+- `RequestedRaffleWinner`: Emitted when a random word request is made.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

SolidityStyleGuide.md

@@ -0,0 +1,27 @@
+// Contract elements should be laid out in the following order:
+//     Pragma statements
+//     Import statements
+//     Events
+//     Errors
+//     Interfaces
+//     Libraries
+//     Contracts
+
+// Inside each contract, library or interface, use the following order:
+//     Type declarations
+//     State variables
+//     Events
+//     Errors
+//     Modifiers
+//     Functions
+
+// Functions should be grouped according to their visibility and ordered:
+//     constructor
+//     receive function (if exists)
+//     fallback function (if exists)
+//     external
+//     public
+//     internal
+//     private
+
+// Within a grouping, place the view and pure functions last.