Merge pull request #97 from liquity/format

Format Solidity + JS + TS files, pnpm workspace

.github/workflows/contracts-tests.yml

@@ -86,7 +86,7 @@ jobs:
         with:
           node-version-file: '.node-version'
           cache: 'pnpm'
-          cache-dependency-path: 'contracts/pnpm-lock.yaml'
+          cache-dependency-path: 'pnpm-lock.yaml'
 
       - name: Install dependencies
         run: pnpm install
@@ -142,11 +142,12 @@ jobs:
         with:
           version: 8
 
-      - uses: actions/setup-node@v4
+      - name: Install Node.js
+        uses: actions/setup-node@v4
         with:
           node-version-file: '.node-version'
           cache: 'pnpm'
-          cache-dependency-path: 'contracts/pnpm-lock.yaml'
+          cache-dependency-path: 'pnpm-lock.yaml'
 
       - name: Install dependencies
         run: pnpm install

.github/workflows/testnet-deployment.yml

@@ -44,7 +44,7 @@ jobs:
         with:
           node-version-file: '.node-version'
           cache: 'pnpm'
-          cache-dependency-path: 'contracts/pnpm-lock.yaml'
+          cache-dependency-path: 'pnpm-lock.yaml'
 
       - name: Install dependencies
         run: pnpm install

.gitignore

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

.vscode/extensions.json

@@ -0,0 +1,5 @@
+{
+    "recommendations": [
+        "dprint.dprint"
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+  "editor.defaultFormatter": "dprint.dprint",
+  "dprint.path": "node_modules/.bin/dprint"
+}

contracts/.gitignore

@@ -16,7 +16,6 @@ docs/
 
 artifacts
 cache_hardhat
-node_modules
 
 coverage/
 coverage.json

contracts/.solcover.js

@@ -1,8 +1,8 @@
 module.exports = {
   // Improve performance by skipping statements and functions. Tool still checks lines of code and branches:
   // https://github.com/sc-forks/solidity-coverage/blob/master/docs/advanced.md
-  //measureStatementCoverage: false,
-  //measureFunctionCoverage: false,
+  // measureStatementCoverage: false,
+  // measureFunctionCoverage: false,
 
   skipFiles: [
     "GasPool",
@@ -14,12 +14,12 @@ module.exports = {
     "Dependencies/Math.sol",
     "Dependencies/Ownable.sol",
     "Dependencies/",
-    "Integrations/"
+    "Integrations/",
   ],
   // https://github.com/sc-forks/solidity-coverage/blob/master/docs/advanced.md#skipping-tests
   mocha: {
     grep: "@skip-on-coverage", // Find everything with this tag
-    invert: true               // Run the grep's inverse set.
+    invert: true, // Run the grep's inverse set.
   },
   contractsDir: "src/",
 };

contracts/README.md

@@ -4,10 +4,10 @@
 
 Foundry consists of:
 
--   **Forge**: Ethereum testing framework (like Truffle, Hardhat and DappTools).
--   **Cast**: Swiss army knife for interacting with EVM smart contracts, sending transactions and getting chain data.
--   **Anvil**: Local Ethereum node, akin to Ganache, Hardhat Network.
--   **Chisel**: Fast, utilitarian, and verbose solidity REPL.
+- **Forge**: Ethereum testing framework (like Truffle, Hardhat and DappTools).
+- **Cast**: Swiss army knife for interacting with EVM smart contracts, sending transactions and getting chain data.
+- **Anvil**: Local Ethereum node, akin to Ganache, Hardhat Network.
+- **Chisel**: Fast, utilitarian, and verbose solidity REPL.
 
 ## Documentation
 

contracts/package.json

@@ -1,24 +1,20 @@
 {
-  "name": "bold",
+  "name": "bold-contracts",
   "version": "1.0.0",
   "description": "Bold decentralized stablecoin",
   "main": "index.js",
   "directories": {
     "lib": "lib"
   },
   "scripts": {
+    "format": "forge fmt && dprint fmt",
     "test": "hardhat test --parallel",
     "coverage": "hardhat coverage"
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/liquity/bold.git"
-  },
+  "repository": "github:liquity/bold",
   "author": "Liquity AG",
   "license": "GPL-3.0",
-  "bugs": {
-    "url": "https://github.com/liquity/bold/issues"
-  },
+  "bugs": "https://github.com/liquity/bold/issues",
   "homepage": "https://github.com/liquity/bold#readme",
   "devDependencies": {
     "@nomicfoundation/hardhat-chai-matchers": "^1.0.0",