refactor: turn PRBMath into free functions

build: add forge-std and prb-test dev depdendencies build: upgrade dev deps build: upgrade to Solidity v0.8.17 build: upgrade to Yarn v3.2.4 chore: delete ".czrc" file chore: delete superfluous ".npmignore" file chore: delete stale "out" directory chore: update package.json for Foundry environment chore: update config and ignore files for Foundry environment chore: use "yml" extension for lint-staged confi docs: define version hyperlinks at the top refactor: delete Hardhat and its Node.js paraphernalia refactor: switch to Foundry style: enable "proseWrap" rule in Prettier config test: add Solidity tests (WIP) test: delete stale test contracts test: delete Node.js tests
PaulRBerg · Nov 5, 2022 · 1b82ea7 · 1b82ea7
1 parent e3213d7
commit 1b82ea7
Show file tree

Hide file tree

Showing 144 changed files with 4,571 additions and 513,139 deletions.
diff --git a/.czrc b/.czrc
diff --git a/.editorconfig b/.editorconfig
@@ -14,3 +14,6 @@ trim_trailing_whitespace = true
 
 [*.sol]
 indent_size = 4
+
+[*.tree]
+indent_size = 1
diff --git a/.env.example b/.env.example
@@ -1,2 +1,3 @@
-INFURA_API_KEY="zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz"
-MNEMONIC="here is where your twelve words mnemonic should be put my friend"
+export ETH_FROM="YOUR_DEFAULT_SENDER_ACCOUNT"
+export ETH_RPC_URL="https://sepolia.infura.io/v3/INFURA_API_KEY"
+export PRIVATE_KEY="YOUR_PRIVATE_KEY"
diff --git a/.eslintignore b/.eslintignore
diff --git a/.eslintrc.yml b/.eslintrc.yml
diff --git a/.gitignore b/.gitignore
@@ -5,22 +5,19 @@
 !.yarn/plugins
 !.yarn/sdks
 !.yarn/versions
-**/.nyc_output
-**/artifacts
-**/build
 **/cache
-**/coverage
-**/coverage-contracts
-**/coverage-ts
-**/dist
 **/node_modules
-**/src/types
+**/out
 
 # files
 *.env
 *.log
-*.tsbuildinfo
-coverage.json
-npm-debug.log*
+.DS_Store
+.pnp.*
 yarn-debug.log*
 yarn-error.log*
+
+# broadcasts
+!/broadcast
+/broadcast/*
+/broadcast/*/31337/
diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,8 @@
+[submodule "lib/forge-std"]
+  branch = "v0.3"
+  path = "lib/forge-std"
+  url = "https://github.com/foundry-rs/forge-std"
+[submodule "lib/prb-test"]
+  branch = "0.1.3"
+  path = "lib/prb-test"
+  url = "https://github.com/paulrberg/prb-test"
diff --git a/.lintstagedrc b/.lintstagedrc
diff --git a/.lintstagedrc.yml b/.lintstagedrc.yml
@@ -0,0 +1,2 @@
+"*.{json,md,sol,yml}":
+  - prettier --config ./.prettierrc.yml --write
diff --git a/.mocharc.yml b/.mocharc.yml
diff --git a/.nycrc.yml b/.nycrc.yml
diff --git a/.prettierignore b/.prettierignore
@@ -1,16 +1,15 @@
 # directories
 .yarn/
-**/.nyc_output
-**/artifacts
-**/build
+**/broadcast
 **/cache
-**/coverage
-**/coverage-contracts
-**/coverage-ts
-**/dist
+**/lib
+**/out
 **/node_modules
-**/src/types
 
 # files
+*.env
+*.log
+.pnp.*
 coverage.json
-LICENSE.md
+yarn-debug.log*
+yarn-error.log*
diff --git a/.prettierrc.yml b/.prettierrc.yml
@@ -1,20 +1,13 @@
-arrowParens: avoid
 bracketSpacing: true
-endOfLine: auto
-
+endOfLine: "auto"
 printWidth: 120
+proseWrap: "always"
 singleQuote: false
 tabWidth: 2
-trailingComma: all
+trailingComma: "all"
 
 overrides:
-  - files: "*.sol"
+  - files: ["*.sol"]
     options:
-      compiler: "0.8.15"
+      compiler: "0.8.17"
       tabWidth: 4
-  - files: "*.ts"
-    options:
-      importOrder: ["<THIRD_PARTY_MODULES>", "^[./]"]
-      importOrderParserPlugins: ["typescript"]
-      importOrderSeparation: true
-      importOrderSortSpecifiers: true
diff --git a/.solcover.js b/.solcover.js
diff --git a/.solhint.json b/.solhint.json
@@ -5,7 +5,9 @@
     "code-complexity": "off",
     "compiler-version": ["error", ">=0.8.13"],
     "const-name-snakecase": "off",
-    "func-visibility": ["error", { "ignoreConstructors": true }],
+    "contract-name-camelcase": "off",
+    "func-name-mixedcase": "off",
+    "func-visibility": "off",
     "max-line-length": ["error", 132],
     "no-inline-assembly": "off",
     "not-rely-on-time": "off",

diff --git a/.yarn/plugins/@yarnpkg/plugin-interactive-tools.cjs b/.yarn/plugins/@yarnpkg/plugin-interactive-tools.cjs
diff --git a/.yarn/releases/yarn-3.2.0.cjs b/.yarn/releases/yarn-3.2.0.cjs
diff --git a/.yarn/releases/yarn-3.2.4.cjs b/.yarn/releases/yarn-3.2.4.cjs
diff --git a/.yarnrc.yml b/.yarnrc.yml
@@ -1,9 +1,9 @@
 enableTelemetry: false
 
-nodeLinker: node-modules
+nodeLinker: "node-modules"
 
 plugins:
-  - path: .yarn/plugins/@yarnpkg/plugin-interactive-tools.cjs
+  - path: ".yarn/plugins/@yarnpkg/plugin-interactive-tools.cjs"
     spec: "@yarnpkg/plugin-interactive-tools"
 
-yarnPath: .yarn/releases/yarn-3.2.0.cjs
+yarnPath: .yarn/releases/yarn-3.2.4.cjs
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,24 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+[2.5.0]: https://github.com/paulrberg/prb-math/compare/v2.4.3...v2.5.0
+[2.4.3]: https://github.com/paulrberg/prb-math/compare/v2.4.2...v2.4.3
+[2.4.2]: https://github.com/paulrberg/prb-math/compare/v2.4.1...v2.4.2
+[2.4.1]: https://github.com/paulrberg/prb-math/compare/v2.4.0...v2.4.1
+[2.4.0]: https://github.com/paulrberg/prb-math/compare/v2.3.0...v2.4.0
+[2.3.0]: https://github.com/paulrberg/prb-math/compare/v2.2.0...v2.3.0
+[2.2.0]: https://github.com/paulrberg/prb-math/compare/v2.1.0...v2.2.0
+[2.1.0]: https://github.com/paulrberg/prb-math/compare/v2.0.1...v2.1.0
+[2.0.1]: https://github.com/paulrberg/prb-math/compare/v2.0.0...v2.0.1
+[2.0.0]: https://github.com/paulrberg/prb-math/compare/v1.1.0...v2.0.0
+[1.1.0]: https://github.com/paulrberg/prb-math/compare/v1.0.5...v1.1.0
+[1.0.5]: https://github.com/paulrberg/prb-math/compare/v1.0.4...v1.0.5
+[1.0.4]: https://github.com/paulrberg/prb-math/compare/v1.0.3...v1.0.4
+[1.0.3]: https://github.com/paulrberg/prb-math/compare/v1.0.2...v1.0.3
+[1.0.2]: https://github.com/paulrberg/prb-math/compare/v1.0.1...v1.0.2
+[1.0.1]: https://github.com/paulrberg/prb-math/compare/v1.0.0...v1.0.1
+[1.0.0]: https://github.com/paulrberg/prb-math/releases/tag/v1.0.0
+
 ## [2.5.0] - 2022-03-08
 
 ### Changed
@@ -201,21 +219,3 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 ### Added
 
 - First release of the library.
-
-[2.5.0]: https://github.com/paulrberg/prb-math/compare/v2.4.3...v2.5.0
-[2.4.3]: https://github.com/paulrberg/prb-math/compare/v2.4.2...v2.4.3
-[2.4.2]: https://github.com/paulrberg/prb-math/compare/v2.4.1...v2.4.2
-[2.4.1]: https://github.com/paulrberg/prb-math/compare/v2.4.0...v2.4.1
-[2.4.0]: https://github.com/paulrberg/prb-math/compare/v2.3.0...v2.4.0
-[2.3.0]: https://github.com/paulrberg/prb-math/compare/v2.2.0...v2.3.0
-[2.2.0]: https://github.com/paulrberg/prb-math/compare/v2.1.0...v2.2.0
-[2.1.0]: https://github.com/paulrberg/prb-math/compare/v2.0.1...v2.1.0
-[2.0.1]: https://github.com/paulrberg/prb-math/compare/v2.0.0...v2.0.1
-[2.0.0]: https://github.com/paulrberg/prb-math/compare/v1.1.0...v2.0.0
-[1.1.0]: https://github.com/paulrberg/prb-math/compare/v1.0.5...v1.1.0
-[1.0.5]: https://github.com/paulrberg/prb-math/compare/v1.0.4...v1.0.5
-[1.0.4]: https://github.com/paulrberg/prb-math/compare/v1.0.3...v1.0.4
-[1.0.3]: https://github.com/paulrberg/prb-math/compare/v1.0.2...v1.0.3
-[1.0.2]: https://github.com/paulrberg/prb-math/compare/v1.0.1...v1.0.2
-[1.0.1]: https://github.com/paulrberg/prb-math/compare/v1.0.0...v1.0.1
-[1.0.0]: https://github.com/paulrberg/prb-math/releases/tag/v1.0.0
diff --git a/contracts/.npmignore b/contracts/.npmignore