init

CodeWarriorr · CodeWarriorr · commit 4a41b1580fa7 · 2022-12-28T13:56:08.000+01:00
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1 @@
+node_modules
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -0,0 +1,24 @@
+module.exports = {
+  env: {
+    browser: false,
+    es2021: true,
+    mocha: true,
+    node: true,
+  },
+  plugins: ['@typescript-eslint'],
+  extends: [
+    'standard',
+    'plugin:prettier/recommended',
+    'plugin:@typescript-eslint/recommended',
+  ],
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaVersion: 12,
+  },
+  rules: {
+    'node/no-unsupported-features/es-syntax': [
+      'error',
+      { ignores: ['modules'] },
+    ],
+  },
+};
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+node_modules
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1 @@
+node_modules
diff --git a/.prettierrc.js b/.prettierrc.js
@@ -0,0 +1,15 @@
+module.exports = {
+  singleQuote: true,
+  bracketSpacing: true,
+  overrides: [
+    {
+      files: '*.sol',
+      options: {
+        printWidth: 120,
+        tabWidth: 4,
+        singleQuote: false,
+        explicitTypes: 'always',
+      },
+    },
+  ],
+};
diff --git a/README.md b/README.md
@@ -0,0 +1,3 @@
+# Hardhat Create App Template
+
+```npx hardhat-create-app myApp```
diff --git a/bin/hardhat-create-app.js b/bin/hardhat-create-app.js
@@ -0,0 +1,173 @@
+#!/usr/bin/env node
+
+const fs = require('fs-extra');
+const path = require('path');
+const { spawnSync, execSync } = require('child_process');
+
+const projectName = process.argv[2];
+
+if (!projectName) {
+  console.error('No project name specified');
+  process.exit(1);
+}
+
+const root = path.resolve(projectName);
+
+fs.ensureDirSync(root);
+process.chdir(root);
+
+console.log(`Creating a new Hardhat project in ${root}.`);
+
+// Initialize a new npm project
+console.log('Initializing a new npm project...');
+spawnSync('npm', ['init', '-y'], { stdio: 'inherit' });
+
+// Install Hardhat and initialize a new TypeScript project
+console.log('Installing Hardhat...');
+spawnSync('npm', ['install', 'hardhat'], { stdio: 'inherit' });
+
+console.log('Initializing a new Hardhat TypeScript project...');
+const result = execSync(
+  'HARDHAT_CREATE_TYPESCRIPT_PROJECT_WITH_DEFAULTS=true npx hardhat',
+  {
+    stdio: 'inherit',
+  }
+);
+
+console.log('Installing Hardhat Plugins...');
+spawnSync(
+  'npm',
+  [
+    'install',
+    '--save-dev',
+    '-f',
+    'solhint',
+    'prettier',
+    'prettier-plugin-solidity',
+    'hardhat-deploy',
+    '@types/chai',
+    '@types/mocha',
+    '@types/node',
+    'dotenv',
+    '@nomiclabs/hardhat-ethers@npm:hardhat-deploy-ethers',
+    '@openzeppelin/contracts',
+    'hardhat-contract-sizer',
+    'hardhat-gas-reporter',
+  ],
+  { stdio: 'inherit' }
+);
+
+// Add the "compile" script to package.json
+console.log("Adding the 'compile' script to package.json...");
+const packageJsonPath = path.join(root, 'package.json');
+const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf-8'));
+packageJson.scripts.compile = 'hardhat compile';
+fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2));
+
+// Edit the hardhat.config.ts
+console.log('Editing the hardhat.config.ts...');
+const configPath = path.join(root, 'hardhat.config.ts');
+const configContent = fs.readFileSync(configPath, 'utf-8');
+let modifiedContent = configContent.replace(
+  '};',
+  `
+  networks: {
+    hardhat: {
+      forking: {
+        url: nodeUrl('matic') ?? '',
+        blockNumber: 37377259, // Latest as of 28.12.2022
+      },
+    },
+    matic: {
+      url: nodeUrl('matic'),
+      accounts: accounts('matic'),
+    },
+    mumbai: {
+      url: nodeUrl('mumbai'),
+      accounts: accounts('mumbai'),
+    },
+    rinkeby: {
+      url: nodeUrl('rinkeby'),
+      accounts: accounts('rinkeby'),
+    },
+  },
+  gasReporter: {
+    enabled: process.env.REPORT_GAS !== undefined,
+    currency: 'USD',
+    token: 'MATIC',
+    gasPriceApi:
+      'https://api.polygonscan.com/api?module=proxy&action=eth_gasPrice',
+    coinmarketcap: process.env.COINMARKETCAP_API_KEY,
+  },
+  etherscan: {
+    apiKey: {
+      mainnet: process.env.ETHERSCAN_API_KEY || '',
+      rinkeby: process.env.ETHERSCAN_API_KEY || '',
+      polygon: process.env.POLYGONSCAN_API_KEY || '',
+      polygonMumbai: process.env.POLYGONSCAN_API_KEY || '',
+    },
+  },
+  mocha: {
+    timeout: 0,
+  },
+  namedAccounts: {
+    deployer: {
+      default: 0,
+    },
+    proxyAdminOwner: {
+      default: 1,
+    },
+    bob: {
+      default: 5,
+    },
+    alice: {
+      default: 6,
+    },
+    mat: {
+      default: 7,
+    },
+  },
+};
+  `
+);
+
+modifiedContent = modifiedContent.replace(
+  `import "@nomicfoundation/hardhat-toolbox";`,
+  `import '@nomicfoundation/hardhat-toolbox';
+import 'hardhat-deploy';
+import 'hardhat-gas-reporter';
+import 'hardhat-contract-sizer';
+import { nodeUrl, accounts } from './utils/network';
+import * as dotenv from 'dotenv';
+import './tasks/acl';
+
+dotenv.config();
+  `
+);
+fs.writeFileSync(configPath, modifiedContent);
+
+// Copy files to the project directory
+console.log('Copying files to the project directory...');
+fs.copySync(path.resolve(__dirname, '../files'), `${root}/`);
+
+console.log(`
+Success! Created ${projectName} at ${root}.
+
+Inside that directory, you can run several commands:
+
+  npm run compile
+    Compiles the contracts.
+
+  npm run test
+    Runs the tests.
+
+  npm run test:watch
+    Runs the tests in watch mode.
+
+We suggest that you begin by typing:
+
+  cd ${projectName}
+  npm run test
+
+Happy hacking!
+`);
diff --git a/files/.env.example b/files/.env.example
@@ -0,0 +1,14 @@
+MNEMONIC_MUMBAI=
+MNEMONIC_MATIC=
+MNEMONIC_RINKEBY=
+
+ETH_NODE_URI_MUMBAI=
+ETH_NODE_URI_MATIC=
+ETH_NODE_URI_RINKEBY=
+
+ETHERSCAN_API_KEY=""
+POLYGONSCAN_API_KEY=""
+
+COINMARKETCAP_API_KEY=""
+
+REPORT_GAS=true
diff --git a/files/.eslintignore b/files/.eslintignore
@@ -0,0 +1,4 @@
+node_modules
+artifacts
+cache
+coverage
diff --git a/files/.eslintrc.js b/files/.eslintrc.js
@@ -0,0 +1,24 @@
+module.exports = {
+  env: {
+    browser: false,
+    es2021: true,
+    mocha: true,
+    node: true,
+  },
+  plugins: ['@typescript-eslint'],
+  extends: [
+    'standard',
+    'plugin:prettier/recommended',
+    'plugin:@typescript-eslint/recommended',
+  ],
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaVersion: 12,
+  },
+  rules: {
+    'node/no-unsupported-features/es-syntax': [
+      'error',
+      { ignores: ['modules'] },
+    ],
+  },
+};
diff --git a/files/.mocharc.js b/files/.mocharc.js
@@ -0,0 +1,16 @@
+'use strict';
+process.env.TS_NODE_FILES = true;
+module.exports = {
+  'allow-uncaught': true,
+  diff: true,
+  extension: ['ts', 'js'],
+  recursive: true,
+  reporter: 'spec',
+  require: ['ts-node/register', 'hardhat/register'],
+  slow: 300,
+  spec: ['test/**/*.test.ts', 'test/**/*.test.js'],
+  timeout: 0,
+  ui: 'bdd',
+  watch: false,
+  'watch-files': ['contracts/**/*.sol', 'test/**/*.ts', 'test/**/*.js'],
+};
diff --git a/files/.prettierignore b/files/.prettierignore
@@ -0,0 +1,5 @@
+node_modules
+artifacts
+cache
+coverage*
+gasReporterOutput.json
diff --git a/files/.prettierrc.js b/files/.prettierrc.js
@@ -0,0 +1,15 @@
+module.exports = {
+  singleQuote: true,
+  bracketSpacing: true,
+  overrides: [
+    {
+      files: '*.sol',
+      options: {
+        printWidth: 120,
+        tabWidth: 4,
+        singleQuote: false,
+        explicitTypes: 'always',
+      },
+    },
+  ],
+};
diff --git a/files/.solhint.json b/files/.solhint.json
@@ -0,0 +1,7 @@
+{
+  "extends": "solhint:recommended",
+  "rules": {
+    "compiler-version": ["error", "^0.8.0"],
+    "func-visibility": ["warn", { "ignoreConstructors": true }]
+  }
+}
diff --git a/files/.solhintignore b/files/.solhintignore
@@ -0,0 +1 @@
+node_modules
diff --git a/files/utils/hardhat.ts b/files/utils/hardhat.ts
@@ -0,0 +1,29 @@
+import { ethers } from 'hardhat';
+
+export const SECONDS_PER_YEAR = 31536000;
+export const SECONDS_PER_MONTH = SECONDS_PER_YEAR / 12;
+export const SECONDS_PER_3_MONTHS = SECONDS_PER_MONTH * 3;
+export const SECONDS_PER_DAY = SECONDS_PER_MONTH / 30;
+
+export async function increaseTime(x: string | number): Promise<void> {
+  await ethers.provider.send('evm_increaseTime', [x]);
+  await ethers.provider.send('evm_mine', []);
+}
+
+export async function advanceBlock(x: number): Promise<void> {
+  for (let i = 0; i < x; i++) {
+    await ethers.provider.send('evm_mine', []);
+  }
+}
+
+export async function getTime(): Promise<number> {
+  const latestBlock = await ethers.provider.getBlock('latest');
+  return latestBlock.timestamp;
+}
+
+export async function getBlockTime(
+  blockNumber: string | number
+): Promise<number> {
+  const latestBlock = await ethers.provider.getBlock(blockNumber);
+  return latestBlock.timestamp;
+}
diff --git a/files/utils/network.ts b/files/utils/network.ts
@@ -0,0 +1,44 @@
+export function nodeUrl(networkName: string): string {
+  if (networkName) {
+    const uri = process.env["ETH_NODE_URI_" + networkName.toUpperCase()];
+    if (uri && uri !== "") {
+      return uri;
+    }
+  }
+
+  let uri = process.env.ETH_NODE_URI;
+  if (uri) {
+    uri = uri.replace("{{networkName}}", networkName);
+  }
+  if (!uri || uri === "") {
+    if (networkName === "localhost") {
+      return "http://localhost:8545";
+    }
+    return "";
+  }
+  if (uri.indexOf("{{") >= 0) {
+    throw new Error(
+      `invalid uri or network not supported by node provider : ${uri}`
+    );
+  }
+  return uri;
+}
+
+export function getMnemonic(networkName?: string): string {
+  if (networkName) {
+    const mnemonic = process.env["MNEMONIC_" + networkName.toUpperCase()];
+    if (mnemonic && mnemonic !== "") {
+      return mnemonic;
+    }
+  }
+
+  const mnemonic = process.env.MNEMONIC;
+  if (!mnemonic || mnemonic === "") {
+    return "test test test test test test test test test test test junk";
+  }
+  return mnemonic;
+}
+
+export function accounts(networkName?: string): { mnemonic: string } {
+  return { mnemonic: getMnemonic(networkName) };
+}
diff --git a/files/utils/signers.ts b/files/utils/signers.ts
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Hardhat Create App Template`
	`2`	`+`
	`3`	+```npx hardhat-create-app myApp```