Initial commit

.env.example

@@ -0,0 +1,3 @@
+GOERLI_RPC_URL=asdfasdf 
+PRIVATE_KEY=asdfasdf 
+ETHERSCAN_API_KEY=asdfasfs

.gitignore

@@ -0,0 +1,13 @@
+cache/
+out/
+.gas-snapshot
+.vscode/
+.env
+.encryptedKey
+broadcast/
+
+node_modules
+package-lock.json
+
+.DS_Store
+src/.DS_Store

.gitmodules

@@ -0,0 +1,10 @@
+[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
+	branch = v7
+[submodule "lib/forge-std"]
+	path = lib/forge-std
+	url = https://github.com/foundry-rs/forge-std

.prettierignore

@@ -0,0 +1,7 @@
+build
+coverage
+out
+lib
+assets
+node_modules
+.next

.prettierrc

@@ -0,0 +1,6 @@
+{
+    "trailingComma": "es5",
+    "tabWidth": 4,
+    "semi": false,
+    "singleQuote": false
+}

.solhint.json

@@ -0,0 +1,19 @@
+{
+    "extends": "solhint:recommended",
+    "rules": {
+        "code-complexity": ["error", 8],
+        "compiler-version": ["error", ">=0.5.8"],
+        "const-name-snakecase": "off",
+        "constructor-syntax": "error",
+        "func-visibility": ["error", { "ignoreConstructors": true }],
+        "max-line-length": ["error", 120],
+        "not-rely-on-time": "off",
+        "prettier/prettier": [
+            "error",
+            {
+                "endOfLine": "auto"
+            }
+        ],
+        "reason-string": ["warn", { "maxLength": 64 }]
+    }
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 2018 SmartContract ChainLink, Ltd.
+
+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,40 @@
+-include .env
+
+.PHONY: all test clean deploy-anvil
+
+all: clean remove install update build
+
+# Clean the repo
+clean  :; forge clean
+
+# Remove modules
+remove :; rm -rf .gitmodules && rm -rf .git/modules/* && rm -rf lib && touch .gitmodules && git add . && git commit -m "modules"
+
+install :; forge install smartcontractkit/chainlink-brownie-contracts && forge install rari-capital/solmate && forge install foundry-rs/forge-std
+
+# Update Dependencies
+update:; forge update
+
+build:; forge build
+
+test :; forge test 
+
+snapshot :; forge snapshot
+
+slither :; slither ./src 
+
+format :; prettier --write src/**/*.sol && prettier --write src/*.sol
+
+# solhint should be installed globally
+lint :; solhint src/**/*.sol && solhint src/*.sol
+
+anvil :; anvil -m 'test test test test test test test test test test test junk'
+
+# use the "@" to hide the command from your shell 
+deploy-goerli :; @forge script script/${contract}.s.sol:Deploy${contract} --rpc-url ${GOERLI_RPC_URL}  --private-key ${PRIVATE_KEY} --broadcast --verify --etherscan-api-key ${ETHERSCAN_API_KEY}  -vvvv
+
+# This is the private key of account from the mnemonic from the "make anvil" command
+deploy-anvil :; @forge script script/${contract}.s.sol:Deploy${contract} --rpc-url http://localhost:8545  --private-key 0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80 --broadcast 
+
+deploy-all :; make deploy-${network} contract=APIConsumer && make deploy-${network} contract=KeepersCounter && make deploy-${network} contract=PriceFeedConsumer && make deploy-${network} contract=VRFConsumerV2
+

README.md

@@ -0,0 +1,169 @@
+*Note: This repo has been recently updated for Goerli*
+
+# Foundry Starter Kit
+
+<br/>
+<p align="center">
+<a href="https://chain.link" target="_blank">
+<img src="./img/chainlink-foundry.png" width="225" alt="Chainlink Foundry logo">
+</a>
+</p>
+<br/>
+
+[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/smartcontractkit/foundry-starter-kit)
+
+Foundry Starter Kit is a repo that shows developers how to quickly build, test, and deploy smart contracts with one of the fastest frameworks out there, [foundry](https://github.com/gakonst/foundry)!
+
+
+- [Foundry Starter Kit](#foundry-starter-kit)
+- [Getting Started](#getting-started)
+  - [Requirements](#requirements)
+  - [Quickstart](#quickstart)
+  - [Testing](#testing)
+- [Deploying to a network](#deploying-to-a-network)
+  - [Setup](#setup)
+  - [Deploying](#deploying)
+    - [Working with a local network](#working-with-a-local-network)
+    - [Working with other chains](#working-with-other-chains)
+- [Security](#security)
+- [Contributing](#contributing)
+- [Thank You!](#thank-you)
+  - [Resources](#resources)
+    - [TODO](#todo)
+
+# Getting Started
+
+## Requirements
+
+Please install the following:
+
+-   [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)  
+    -   You'll know you've done it right if you can run `git --version`
+-   [Foundry / Foundryup](https://github.com/gakonst/foundry)
+    -   This will install `forge`, `cast`, and `anvil`
+    -   You can test you've installed them right by running `forge --version` and get an output like: `forge 0.2.0 (f016135 2022-07-04T00:15:02.930499Z)`
+    -   To get the latest of each, just run `foundryup`
+
+And you probably already have `make` installed... but if not [try looking here.](https://askubuntu.com/questions/161104/how-do-i-install-make)
+
+## Quickstart
+
+```sh
+git clone https://github.com/smartcontractkit/foundry-starter-kit
+cd foundry-starter-kit
+make # This installs the project's dependencies.
+make test
+```
+
+## Testing
+
+```
+make test
+```
+
+or
+
+```
+forge test
+```
+
+# Deploying to a network
+
+Deploying to a network uses the [foundry scripting system](https://book.getfoundry.sh/tutorials/solidity-scripting.html), where you write your deploy scripts in solidity!
+
+## Setup
+
+We'll demo using the Goerli testnet. (Go here for [testnet goerli ETH](https://faucets.chain.link/).)
+
+You'll need to add the following variables to a `.env` file:
+
+-   `GOERLI_RPC_URL`: A URL to connect to the blockchain. You can get one for free from [Alchemy](https://www.alchemy.com/). 
+-   `PRIVATE_KEY`: A private key from your wallet. You can get a private key from a new [Metamask](https://metamask.io/) account
+    -   Additionally, if you want to deploy to a testnet, you'll need test ETH and/or LINK. You can get them from [faucets.chain.link](https://faucets.chain.link/).
+-   Optional `ETHERSCAN_API_KEY`: If you want to verify on etherscan
+
+## Deploying
+
+```
+make deploy-goerli contract=<CONTRACT_NAME>
+```
+
+For example:
+
+```
+make deploy-goerli contract=PriceFeedConsumer
+```
+
+This will run the forge script, the script it's running is:
+
+```
+@forge script script/${contract}.s.sol:Deploy${contract} --rpc-url ${GOERLI_RPC_URL}  --private-key ${PRIVATE_KEY} --broadcast --verify --etherscan-api-key ${ETHERSCAN_API_KEY}  -vvvv
+```
+
+If you don't have an `ETHERSCAN_API_KEY`, you can also just run:
+
+```
+@forge script script/${contract}.s.sol:Deploy${contract} --rpc-url ${GOERLI_RPC_URL}  --private-key ${PRIVATE_KEY} --broadcast 
+```
+
+These pull from the files in the `script` folder. 
+
+### Working with a local network
+
+Foundry comes with local network [anvil](https://book.getfoundry.sh/anvil/index.html) baked in, and allows us to deploy to our local network for quick testing locally. 
+
+To start a local network run:
+
+```
+make anvil
+```
+
+This will spin up a local blockchain with a determined private key, so you can use the same private key each time. 
+
+Then, you can deploy to it with:
+
+```
+make deploy-anvil contract=<CONTRACT_NAME>
+```
+
+Similar to `deploy-goerli`
+
+### Working with other chains
+
+To add a chain, you'd just need to make a new entry in the `Makefile`, and replace `<YOUR_CHAIN>` with whatever your chain's information is. 
+
+```
+deploy-<YOUR_CHAIN> :; @forge script script/${contract}.s.sol:Deploy${contract} --rpc-url ${<YOUR_CHAIN>_RPC_URL}  --private-key ${PRIVATE_KEY} --broadcast -vvvv
+
+```
+
+# Security
+
+This framework comes with slither parameters, a popular security framework from [Trail of Bits](https://www.trailofbits.com/). To use slither, you'll first need to [install python](https://www.python.org/downloads/) and [install slither](https://github.com/crytic/slither#how-to-install).
+
+Then, you can run:
+
+```
+make slither
+```
+
+And get your slither output. 
+
+
+
+# Contributing
+
+Contributions are always welcome! Open a PR or an issue!
+
+# Thank You!
+
+## Resources
+
+-   [Chainlink Documentation](https://docs.chain.link/)
+-   [Foundry Documentation](https://book.getfoundry.sh/)
+
+### TODO
+
+[ ] Add bash scripts to interact with contracts using `cast`
+
+[ ] Make deploying contracts to `anvil` simpler

foundry.toml

@@ -0,0 +1,11 @@
+[profile.default]
+src = 'src'
+out = 'out'
+libs = ['lib']
+gas_reports = ["*"]
+optimizer = true
+optimizer_runs = 20000
+
+# Remappings in remappings.txt
+
+# See more config options https://github.com/gakonst/foundry/tree/master/config

lib/chainlink-brownie-contracts/.github/workflows/add-and-commit.yml

@@ -0,0 +1,51 @@
+name: Update repo to match @chainlink/contracts
+
+on:
+  push:
+  schedule:
+    # Everyday at 3AM
+    - cron: '0 3 * * *'
+jobs:
+  check-update-version-and-release:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [14.x]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      # - name: Get Current Version
+      #   run: current_version_var=$(cat version.txt) && echo "::set-output name=current_verision::${current_version_var}"
+      #   id: get_current_version
+      # - name: print current version
+      #   run: echo "Current @chainlink/contracts version is ${{steps.get_current_version.outputs.current_verision}}"
+      - name: Check npm version
+        run: yarn outdated
+        continue-on-error: true
+        id: check_outdated
+      - name: Get Updated Version
+        if: steps.check_outdated.outcome != 'success'
+        id: get_updated
+        run: |
+          yarn upgrade --latest
+          cp -r node_modules/@chainlink/contracts/* contracts/
+          jq '.dependencies."@chainlink/contracts"' package.json | sed 's/"//g' | sed 's/\^//g' > version.txt
+          version=$(cat version.txt)
+          echo "::set-output name=version::${version}"
+      - name: add and commit
+        if: steps.check_outdated.outcome != 'success'
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          tagging_message: ${{steps.get_updated.outputs.version}}
+          commit_message: ${{steps.get_updated.outputs.version}}
+      - name: Create Release
+        if: steps.check_outdated.outcome != 'success'
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token
+        with:
+          tag_name: ${{steps.get_updated.outputs.version}}
+          release_name: ${{steps.get_updated.outputs.version}}
+          draft: false
+          prerelease: false