CTF init

.github/workflows/lint.yaml

@@ -0,0 +1,43 @@
+name: Lint
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  ci:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        node: [lts/*]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@master
+
+      - name: Setup node env
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node }}
+          cache: yarn
+
+      - name: Install dependencies
+        run: yarn install --immutable
+
+      - name: Run hardhat node, deploy contracts (& generate contracts typescript output)
+        run: yarn chain & yarn deploy
+
+      - name: Run hardhat lint
+        run: yarn hardhat:lint --max-warnings=0
+
+      - name: Run nextjs lint
+        run: yarn next:lint --max-warnings=0
+
+      - name: Check typings on nextjs
+        run: yarn next:check-types

.gitignore

@@ -0,0 +1,23 @@
+# dependencies
+node_modules
+
+# yarn
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
+
+# eslint
+.eslintcache
+
+# misc
+.DS_Store
+
+# IDE
+.vscode
+.idea
+
+# cli
+dist

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+yarn lint-staged --verbose

.lintstagedrc.js

@@ -0,0 +1,21 @@
+const path = require("path");
+
+const buildNextEslintCommand = (filenames) =>
+  `yarn next:lint --fix --file ${filenames
+    .map((f) => path.relative(path.join("packages", "nextjs"), f))
+    .join(" --file ")}`;
+
+const checkTypesNextCommand = () => "yarn next:check-types";
+
+const buildHardhatEslintCommand = (filenames) =>
+  `yarn hardhat:lint-staged --fix ${filenames
+    .map((f) => path.relative(path.join("packages", "hardhat"), f))
+    .join(" ")}`;
+
+module.exports = {
+  "packages/nextjs/**/*.{ts,tsx}": [
+    buildNextEslintCommand,
+    checkTypesNextCommand,
+  ],
+  "packages/hardhat/**/*.{ts,tsx}": [buildHardhatEslintCommand],
+};

.yarnrc.yml

@@ -0,0 +1,11 @@
+enableColors: true
+
+nmHoistingLimits: workspaces
+
+nodeLinker: node-modules
+
+plugins:
+  - path: .yarn/plugins/@yarnpkg/plugin-typescript.cjs
+    spec: "@yarnpkg/plugin-typescript"
+
+yarnPath: .yarn/releases/yarn-3.2.3.cjs

CONTRIBUTING.md

@@ -0,0 +1,86 @@
+# Welcome to Scaffold-ETH 2 Contributing Guide
+
+Thank you for investing your time in contributing to Scaffold-ETH 2!
+
+This guide aims to provide an overview of the contribution workflow to help us make the contribution process effective for everyone involved.
+
+## About the Project
+
+Scaffold-ETH 2 is a minimal and forkable repo providing builders with a starter kit to build decentralized applications on Ethereum.
+
+Read the [README](README.md) to get an overview of the project.
+
+### Vision
+
+The goal of Scaffold-ETH 2 is to provide the primary building blocks for a decentralized application.
+
+The repo can be forked to include integrations and more features, but we want to keep the master branch simple and minimal.
+
+### Project Status
+
+The project is under active development.
+
+You can view the open Issues, follow the development process and contribute to the project.
+
+## Getting started
+
+You can contribute to this repo in many ways:
+
+- Solve open issues
+- Report bugs or feature requests
+- Improve the documentation
+
+Contributions are made via Issues and Pull Requests (PRs). A few general guidelines for contributions:
+
+- Search for existing Issues and PRs before creating your own.
+- Contributions should only fix/add the functionality in the issue OR address style issues, not both.
+- If you're running into an error, please give context. Explain what you're trying to do and how to reproduce the error.
+- Please use the same formatting in the code repository. You can configure your IDE to do it by using the prettier / linting config files included in each package.
+- If applicable, please edit the README.md file to reflect the changes.
+
+### Issues
+
+Issues should be used to report problems, request a new feature, or discuss potential changes before a PR is created.
+
+#### Solve an issue
+
+Scan through our [existing issues](https://github.com/scaffold-eth/scaffold-eth-2/issues) to find one that interests you.
+
+If a contributor is working on the issue, they will be assigned to the individual. If you find an issue to work on, you are welcome to assign it to yourself and open a PR with a fix for it.
+
+#### Create a new issue
+
+If a related issue doesn't exist, you can open a new issue.
+
+Some tips to follow when you are creating an issue:
+
+- Provide as much context as possible. Over-communicate to give the most details to the reader.
+- Include the steps to reproduce the issue or the reason for adding the feature.
+- Screenshots, videos etc., are highly appreciated.
+
+### Pull Requests
+
+#### Pull Request Process
+
+We follow the ["fork-and-pull" Git workflow](https://github.com/susam/gitpr)
+
+1. Fork the repo
+2. Clone the project
+3. Create a new branch with a descriptive name
+4. Commit your changes to the new branch
+5. Push changes to your fork
+6. Open a PR in our repository and tag one of the maintainers to review your PR
+
+Here are some tips for a high-quality pull request:
+
+- Create a title for the PR that accurately defines the work done.
+- Structure the description neatly to make it easy to consume by the readers. For example, you can include bullet points and screenshots instead of having one large paragraph.
+- Add the link to the issue if applicable.
+- Have a good commit message that summarises the work done.
+
+Once you submit your PR:
+
+- We may ask questions, request additional information or ask for changes to be made before a PR can be merged. Please note that these are to make the PR clear for everyone involved and aims to create a frictionless interaction process.
+- As you update your PR and apply changes, mark each conversation resolved.
+
+Once the PR is approved, we'll "squash-and-merge" to keep the git commit history clean.

LICENCE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 BuidlGuidl
+
+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.

README.md

@@ -0,0 +1,162 @@
+![BuidlGuidl CTF - Devcon](./packages/nextjs/public/readme-image.jpg?raw=true)
+
+**Welcome to the BuidlGuidl CTF - Devcon SEA 2024!**
+
+⚡️ Live at https://ctf.buidlguidl.com/
+
+**The goal of this CTF game is to mint as many NFT flags as possible from the `NFTFlags.sol` contract**. The allowed minters are each of the challenge contracts. Each flag gives you 100 points. We only track NFT minters, not NFT holders (i.e. transfers are not computed into the score).
+
+This repository was built with [Scaffold-ETH 2](https://github.com/scaffold-eth/scaffold-eth-2) and it contains **all the tools that you need to play (& win!) the CTF**. But you can also hack with your own stack.
+
+---
+
+In this repo we provide a full set of tools to help you with the challenges, including:
+
+- A user-friendly frontend to interact with the contracts (`/debug` page)
+- Simplified workflow for [deploying new contracts](https://docs.scaffoldeth.io/deploying/deploy-smart-contracts)
+- A local blockchain and a block explorer for testing.
+- [Example scripts](./packages/scripts/src/example.ts) to interact with smart contracts via scripts.
+
+> [!NOTE]
+> If you prefer using Foundry for development, check out the [foundry branch](https://github.com/buidlguidl/ctf-devcon/tree/foundry).
+
+## Setting up the environment
+
+### Requirements
+
+You'll need to have the following tools installed in your machine:
+
+- [Node (>= v18.18)](https://nodejs.org/en/download/)
+- Yarn ([v1](https://classic.yarnpkg.com/en/docs/install/) or [v2+](https://yarnpkg.com/getting-started/install))
+- [Git](https://git-scm.com/downloads)
+
+### Setting up your local testing environment
+
+First, you'll need to clone this repository and install dependencies:
+
+```
+git clone https://github.com/buidlguidl/ctf-devcon.git
+cd ctf-devcon
+yarn install
+```
+
+Now you will run the following commands in separate terminals:
+
+1. Run a local blockchain:
+
+```
+yarn chain
+```
+
+2. Deploy the challenges contracts locally:
+
+```
+yarn deploy
+```
+
+> Note: This command will update the `deployedContracts.ts` file (in the `scripts` and `nextjs` packages), which contains the deployed contracts addresses and ABIs.
+
+3. Start Ponder (event indexer):
+
+```
+yarn ponder:dev
+```
+
+> Note: This just runs the ponder indexer locally, which is used to keep track of all the events happening in the blockchain.
+
+4. Start the frontend (NextJS app):
+
+```
+yarn start
+```
+
+Now your app on `http://localhost:3000` is running entirely locally. You can break things without any consequences :)
+
+## Repo structure / Key files
+
+This is a [yarn](https://yarnpkg.com/features/workspaces) monorepo with different packages:
+
+```
+ctf-devcon/
+└── packages/
+    ├── hardhat/
+    ├── nextjs/
+    ├── scripts/
+    └── ponder/
+```
+
+### hardhat
+
+Comes preconfigured with [hardhat](https://hardhat.org/) and contains the smart contracts and deployment scripts for the CTF challenges.
+
+It uses hardhat-deploy to deploy the contracts.
+
+#### Key files in hardhat
+
+- `contracts/`: The source directory where all your smart contracts should be. It already contains all the challenge contracts and the NFT Flag minter contract.
+- `deploy/`: This directory contains all your deployments scripts. When you run `yarn deploy` all the scripts present in this directory will be executed in numbered order.
+
+<details>
+<summary>Example (How to deploy a contract)</summary>
+
+1. Create the smart contract:
+
+   - Add your new contract file (e.g., `Challenge2Solution.sol`) in the `packages/hardhat/contracts/` directory.
+
+2. Create a deployment script:
+
+   - Add a new file (or use the already created `02_deploy_challenge_2_solution.ts` file as a starting point) in the `deploy/` directory.
+   - Write your deployment script as needed (you can use `00_deploy_your_contract.ts` to guide you)
+
+3. Deploy your contract locally:
+
+   - Run `yarn deploy --tags solution2` to deploy your solution contract locally. The `tags` make sure that your are only deploying the solution contract and not all the other challenges (that were deployed with `yarn deploy` or `yarn deploy --tags CTF`).
+
+4. When tested and ready, deploy your contract to Optimism (ask us for some funds if you need!):
+   - > Note: You need a private key to deploy the contracts. You can generate one with `yarn generate` or add your own private key in the `.env` files in `/packages/hardhat` and `packages/scripts` folders.
+   - Run `yarn deploy --tags solution2 --network optimism` to deploy your solution contract to Optimism.
+
+For more details on deployment, including configuring deployer accounts or the network you want to deploy to, see the [Scaffold-ETH 2 deployment docs](https://docs.scaffoldeth.io/deploying/deploy-smart-contracts).
+
+</details>
+
+### NextJS
+
+This is the frontend of the game. Main pages:
+
+- _"Profile"_ shows the team profile and the flags they have minted.
+- _"Challenges"_ shows the Challenges descriptions, Goals and Hints.
+- _"Leaderboard"_ shows the current top teams in the game.
+- _"Debug Contracts"_ lists all the deployed contracts and allows you to interact with them.
+
+Key folders and files:
+
+- `app/`: Contains the Next.js pages and components (uses [app router](https://nextjs.org/docs/app)).
+- `contracts/`: Contains deployed contracts ABIs and addresses.
+- `package.json`: Dependencies and scripts for the Next.js app.
+- `scaffold.config.ts`: Configuration file, you can check the different settings in our [docs](https://docs.scaffoldeth.io/deploying/deploy-nextjs-app#scaffold-app-configuration)
+
+### scripts
+
+Contains scripts to interact with the deployed contracts. This package comes pre-installed with [viem](https://viem.sh/)
+which helps you interface with the Blockchain using Typescript scripts.
+
+#### Key files and directories:
+
+- `src/`: Contains the script files.
+  - `example.ts`: A basic example script demonstrating how to interact with contracts.
+- `contracts/`: Contains deployed contracts ABIs and addresses. (generated by `yarn deploy`)
+
+To run scripts, navigate to the scripts package and run the script using `yarn tsx`:
+
+```shell
+cd packages/scripts
+yarn tsx src/example.ts
+```
+
+- You can generate a PK for the deployer account with `yarn generate` or fill the `.env` file with your own PK to run the transactions.
+- Check the `TARGET_CHAIN` variable in the example script to see how to deploy to the live network. (default is localhost)
+
+### Ponder
+
+No need to take a look here, since it's not part of the game. Just the indexer we use to keep track of all the contract events happening.