init via carbyne

Author: noyyyy

.env.example

@@ -0,0 +1,2 @@
+RINKEBY_URL="https://rinkeby.infura.io/v3/<YOUR INFURA KEY>"
+ACCOUNTS=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb

.eslintignore

@@ -0,0 +1,4 @@
+node_modules
+artifacts
+cache
+coverage

.eslintrc.js

@@ -0,0 +1,25 @@
+module.exports = {
+  env: {
+    browser: false,
+    es2021: true,
+    mocha: true,
+    node: true,
+  },
+  plugins: ['@typescript-eslint'],
+  extends: ['standard', 'plugin:prettier/recommended', 'plugin:node/recommended'],
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaVersion: 12,
+  },
+  rules: {
+    'node/no-unsupported-features/es-syntax': ['error', { ignores: ['modules'] }],
+    'node/no-missing-import': [
+      'error',
+      {
+        allowModules: [],
+        resolvePaths: ['./typechain'],
+        tryExtensions: ['.js', '.json', '.node', '.ts'],
+      },
+    ],
+  },
+};

.gitignore

@@ -0,0 +1,11 @@
+node_modules
+.env
+coverage
+coverage.json
+typechain
+
+#Hardhat files
+cache
+artifacts
+.openzeppelin
+flatten

.husky/pre-commit

@@ -0,0 +1,5 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npm run lint
+npm run test

.prettierignore

@@ -0,0 +1,6 @@
+node_modules
+artifacts
+cache
+coverage*
+gasReporterOutput.json
+typechain

.prettierrc.js

@@ -0,0 +1,35 @@
+module.exports = {
+  // 128 character each line
+  printWidth: 128,
+  // use 2 Spaces for indentation
+  tabWidth: 2,
+  // don't use tab
+  useTabs: false,
+  // semicolon required at end of line
+  semi: true,
+  // use single quote
+  singleQuote: true,
+  // The object's key is quoted only when necessary
+  quoteProps: 'as-needed',
+  // comma is required at the end
+  trailingComma: 'all',
+  // spaces are required at the beginning and end of the curly brackets
+  bracketSpacing: true,
+  // Arrow functions, when there is only one parameter, also need parentheses
+  arrowParens: 'always',
+  // The scope of each file format is the entire contents of the file
+  rangeStart: 0,
+  rangeEnd: Infinity,
+  // No need to write @prettier at the beginning of the file
+  requirePragma: false,
+  // No need to automatically insert @prettier at the beginning of the file
+  insertPragma: false,
+  // Use default wrapping standard
+  proseWrap: 'preserve',
+  // Decide whether to wrap html according to the display style
+  htmlWhitespaceSensitivity: 'css',
+  // Line breaks use lf
+  endOfLine: 'lf',
+  // Format embedded content
+  embeddedLanguageFormatting: 'auto',
+};

.solhint.json

@@ -0,0 +1,13 @@
+{
+  "extends": "solhint:recommended",
+  "rules": {
+    "compiler-version": ["error", "^0.8.0"],
+    "func-visibility": [
+      "warn",
+      {
+        "ignoreConstructors": true
+      }
+    ],
+    "quotes": ["error", "single"]
+  }
+}

.solhintignore

@@ -0,0 +1 @@
+node_modules

README.md

@@ -0,0 +1,120 @@
+# Carbyne General Template
+
+## Set up
+
+```
+$ npm install prepare
+```
+
+Copy `.env.example` to `.env`
+
+```shell
+$ cp .env.example .env
+```
+
+Config environment variables. By default, there is a configuration for rinkeby networks RPC url and private key config. You can fill in multiple private keys and separate them with commas.
+
+```
+RINKEBY_URL="https://rinkeby.infura.io/v3/<YOUR INFURA KEY>"
+ACCOUNTS=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
+```
+
+## Compile contract
+
+Compile contracts
+
+```shell
+$ npm run compile
+```
+
+## Lint
+
+Use `cspell`, `prettier`, `eslint` to format and check code format.
+
+```shell
+$ npm run lint
+```
+
+## Test
+
+Run all tests
+
+```shell
+$ npm run test
+```
+
+Run all tests and get estimating gas used in each contract
+
+```shell
+$ npm run test:analysis
+```
+
+Get Test coverage
+
+```shell
+$ npm run coverage
+```
+
+Test coverage will show in the terminal(stdout) and HTML files are generated in the `coverage` folder so that you can also open them in the browser to view.
+
+## Smart flatten
+
+Flatten all smart contracts in the `contracts` folder and generate files to the `flatten` folder according to their relative path, and all flattened contracts are ready for being verified. It helps a lot usually.
+
+```shell
+$ npm run flat
+```
+
+## Run some script
+
+Check before you run it!
+
+```
+$ npm hardhat run scripts/xxxx.ts
+```
+
+# Directory Structure
+
+```
+.
+├── contracts/
+├── cspell.json
+├── .eslintignore
+├── .eslintrc.js
+├── flat.ts
+├── .git
+├── .gitignore
+├── hardhat.config.ts
+├── .husky/
+├── node_modules
+├── package.json
+├── package-lock.json
+├── .prettierignore
+├── .prettierrc.js
+├── scripts/
+├── .solhintignore
+├── .solhint.json
+├── test/
+└── tsconfig.json
+
+```
+
+`contracts` is where you write your own smart contracts, there are some common subfolders you can refer to, such as `libraries` for shared libraries, and `tests` for contracts not written by you but used in test scripts. You can also make some subfolders for different features.
+
+`scripts` is where you write some one-time scripts, such as deploying contracts to a specific chain or calling a contract to change some data. As it may write to the real blockchain, be careful before running it！
+
+`tests` is where you write test scripts to test your contracts thoroughly. It uses hardhat framework to run tests and there is a temporary chain for you to read and write arbitrarily. For more, you can refer to hardhat [docs](https://hardhat.org/getting-started/)
+
+`.husky` is a folder for git hook. By default, there is a pre-commit hook that runs `npm run lint` and `npm run test` before you make a git commit.
+
+`flat.ts` is a custom file to run smart flatten as hardhat's origin command `flatten` doesn't work well.
+
+`hardhat.config.ts` is the hardhat config file, you can use more environment variables after configuring them in `.env`.
+
+`tsconfig.json` is the file for configuring typescript compiling options.
+
+`.eslintrc.js` and `.eslintignore` for eslint config.
+
+`.prettierignore` and `.prettierrc.js` for prettier config.
+
+`.solhint.json` and `.solhintignore` for solhint config.

contracts/Campaign.sol

@@ -0,0 +1,39 @@
+//SPDX-License-Identifier: GPL-3.0-or-later
+
+pragma solidity 0.8.15;
+
+import '@openzeppelin/contracts/token/ERC721/IERC721.sol';
+import '@openzeppelin/contracts/token/ERC721/ERC721.sol';
+import '@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol';
+import '@openzeppelin/contracts/access/Ownable.sol';
+import '@openzeppelin/contracts/token/ERC20/IERC20.sol';
+import './interface/ICampaign.sol';
+
+contract Campaign is ICampaign, Ownable, ERC721 {
+  using SafeERC20 for IERC20;
+
+  IERC20 public immutable targetToken;
+  uint256 public immutable requiredAmount;
+
+  mapping(address => bool) public registry;
+
+  constructor(
+    IERC20 token_,
+    uint256 amount_,
+    string memory name_,
+    string memory symbol_
+  ) ERC721(name_, symbol_) {
+    require(address(token_) != address(0), 'Campaign: invalid token');
+    require(amount_ != 0, 'Campaign: invalid amount');
+    targetToken = token_;
+    requiredAmount = amount_;
+  }
+
+  function register() public override returns (bool) {
+    IERC20(targetToken).safeTransferFrom(msg.sender, address(this), requiredAmount);
+
+    registry[msg.sender] = true;
+
+    return true;
+  }
+}

contracts/CampaignFactoryUpgradable.sol

@@ -0,0 +1,56 @@
+//SPDX-License-Identifier: GPL-3.0-or-later
+pragma solidity 0.8.15;
+
+import '@openzeppelin/contracts/proxy/utils/UUPSUpgradeable.sol';
+import '@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol';
+import '@openzeppelin/contracts/token/ERC20/IERC20.sol';
+
+import './Campaign.sol';
+
+import 'hardhat/console.sol';
+import './interface/ICampaignFactory.sol';
+
+contract CampaignFactoryUpgradable is ICampaignFactory, UUPSUpgradeable, OwnableUpgradeable {
+  // White list mapping
+  mapping(address => bool) public whiteUsers;
+
+  // White list token mapping
+  mapping(IERC20 => bool) public whiteTokens;
+
+  function _authorizeUpgrade(address newImplementation) internal override onlyOwner {}
+
+  function initialize() public initializer {
+    __Ownable_init_unchained();
+  }
+
+  function modifyWhiteUser(address user, bool status) public onlyOwner {
+    whiteUsers[user] = status;
+    emit EvWhiteUserSet(user, status);
+  }
+
+  function modifyWhiteToken(IERC20 token, bool status) public onlyOwner {
+    whiteTokens[token] = status;
+    emit EvWhiteTokenSet(token, status);
+  }
+
+  function createCampaign(
+    IERC20 token,
+    uint256 amount,
+    string memory name,
+    string memory symbol
+  ) public override onlyWhiteUser onlyWhiteToken(token) returns (bool) {
+    Campaign cam = new Campaign(token, amount, name, symbol);
+    emit EvCampaignCreated(msg.sender, address(cam));
+    return true;
+  }
+
+  modifier onlyWhiteUser() {
+    require(whiteUsers[msg.sender], 'CampaignFactory: not whitelist');
+    _;
+  }
+
+  modifier onlyWhiteToken(IERC20 token) {
+    require(whiteTokens[token], 'CampaignFactory: not whitelist');
+    _;
+  }
+}

contracts/interface/ICampaign.sol

@@ -0,0 +1,6 @@
+//SPDX-License-Identifier: GPL-3.0-or-later
+pragma solidity 0.8.15;
+
+interface ICampaign {
+  function register() external returns (bool);
+}

contracts/interface/ICampaignFactory.sol

@@ -0,0 +1,17 @@
+//SPDX-License-Identifier: GPL-3.0-or-later
+pragma solidity 0.8.15;
+
+import '@openzeppelin/contracts/token/ERC20/IERC20.sol';
+
+interface ICampaignFactory {
+  function createCampaign(
+    IERC20 token,
+    uint256 amount,
+    string memory name,
+    string memory symbol
+  ) external returns (bool success);
+
+  event EvCampaignCreated(address indexed promoter, address indexed campaignAddress);
+  event EvWhiteUserSet(address indexed user, bool status);
+  event EvWhiteTokenSet(IERC20 indexed token, bool status);
+}