Modernize Setup

.github/workflows/ci.yaml

@@ -9,10 +9,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v4
+        with:
+          version: 9
       - uses: actions/setup-node@v4
         with:
           node-version: 20.x
-          cache: yarn
-          cache-dependency-path: yarn.lock
-      - run: yarn
-      - run: yarn build
+          cache: pnpm
+      - run: pnpm install --frozen-lockfile

.gitignore

@@ -1,14 +1,3 @@
-build/
-node_modules/
 .DS_Store
-.zos.session
-.openzeppelin/.session
-deployments/
-env/
-.env
 dist/
-bin/
-solc
-coverage/
-coverage.json
-yarn-error.log
+node_modules/

README.md

@@ -12,6 +12,7 @@ To add additional deployments please follow the [deployment steps in the module
 
 - npm - `npm i @safe-global/safe-modules-deployments`
 - yarn - `yarn add @safe-global/safe-modules-deployments`
+- pnpm - `pnpm install @safe-global/safe-modules-deployments`
 
 ## Usage
 
@@ -41,20 +42,26 @@ interface Deployment {
 }
 ```
 
-- Allowance Module
-  ```ts
-  const allowanceModule = getAllowanceModuleDeployment();
+For example, in order to get various deployments for the Safe Allowance module:
+
+```ts
+const allowanceModule = getAllowanceModuleDeployment();
 
-  // Returns latest contract version, even if not finally released yet
-  const allowanceModuleNightly = getAllowanceModuleDeployment({ released: undefined });
+// Returns latest contract version, even if not finally released yet
+const allowanceModuleNightly = getAllowanceModuleDeployment({ released: undefined });
 
-  // Returns released contract version for specific network
-  const allowanceModuleGörli = getAllowanceModuleDeployment({ network: '5' });
+// Returns released contract version for specific network
+const allowanceModuleGörli = getAllowanceModuleDeployment({ network: '5' });
 
-  // Returns released contract version for specific version
-  const allowanceModule010 = getAllowanceModuleDeployment({ version: '0.1.0' });
-  ```
+// Returns released contract version for specific version
+const allowanceModule010 = getAllowanceModuleDeployment({ version: '0.1.0' });
+```
+
+This repository contains deployments for the following modules:
+
+- Allowance Module
 - ERC-4337 Module
+- Passkeys
 
 ## Notes
 

eslint.config.mjs

@@ -0,0 +1,16 @@
+import eslint from '@eslint/js';
+import tseslint from 'typescript-eslint';
+import prettier from 'eslint-plugin-prettier/recommended';
+
+export default [
+  eslint.configs.recommended,
+  ...tseslint.configs.recommended,
+  {
+    rules: {
+      '@typescript-eslint/camelcase': 'off',
+      '@typescript-eslint/no-var-requires': 'off',
+      '@typescript-eslint/no-unused-vars': ['error', { ignoreRestSiblings: true }],
+    },
+  },
+  prettier,
+];

package.json

@@ -1,21 +1,20 @@
 {
   "name": "@safe-global/safe-modules-deployments",
   "version": "2.2.0",
-  "description": "Collection of Safe Modules singleton deployments",
+  "description": "Collection of Safe modules contract deployments",
   "homepage": "https://github.com/safe-global/safe-modules-deployments/",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "files": [
     "dist",
-    "src",
-    "test",
-    "build"
+    "src"
   ],
   "scripts": {
-    "build": "yarn rimraf dist && tsc",
+    "build": "rimraf dist && tsc",
     "lint": "eslint --max-warnings 0 src/",
-    "prepack": "yarn build"
+    "lint:fix": "pnpm run lint --fix",
+    "prepare": "pnpm run build"
   },
   "repository": {
     "type": "git",
@@ -31,14 +30,13 @@
     "url": "https://github.com/safe-global/safe-modules-deployments/issues"
   },
   "devDependencies": {
-    "@types/node": "^14.14.21",
-    "@typescript-eslint/eslint-plugin": "^5.10.1",
-    "@typescript-eslint/parser": "^5.10.1",
-    "eslint": "8.7.0",
-    "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-prettier": "^4.0.0",
-    "prettier": "^2.1.2",
-    "rimraf": "^3.0.2",
-    "typescript": "^4.2.4"
+    "@eslint/js": "^8.56.0",
+    "@types/node": "^20.14.2",
+    "eslint": "^8.56.0",
+    "eslint-plugin-prettier": "^5.1.3",
+    "prettier": "^3.3.2",
+    "rimraf": "^5.0.7",
+    "typescript": "^5.4.5",
+    "typescript-eslint": "^7.13.0"
   }
 }