v1.0 review

.solhint.json

@@ -6,7 +6,6 @@
     "compiler-version": ["error", ">=0.8.0"],
     "contract-name-camelcase": "off",
     "const-name-snakecase": "off",
-    "custom-errors": "error",
     "no-inline-assembly": "off",
     "func-name-mixedcase": "error",
     "func-visibility": ["error", { "ignoreConstructors": true }],

CHANGELOG.md

@@ -13,19 +13,18 @@ The format is based on [Common Changelog](https://common-changelog.org/).
 ### Changed
 
 - Refactored multiAttest code
-- Standardised naming
+- Standardized naming
 - Import remappings
 
 ### Added
 
-- Gas optimisations of query functions
+- Gas optimizations of query functions
 - Expanded test coverage
 
 ### Removed
 
 - Unchecked increments in loops
 
-
 ## [0.2.0] - 25-10-2023
 
 ### Changed

README.md

@@ -20,7 +20,7 @@ could drastically undermine the objective by opening up a plethora of new attack
 
 The Registry aims to solve this concern by providing a means of verifying the legitimacy and
 security of independently built smart account modules for installation and use across any integrated
-smart account. It allows entities to attest to statements about modules and smart accounts to query these at module nstallation and/or execution time. The Registry is a Singleton that is free, open and permissionless. It also serves as the reference implementation for [ERC-7484](https://eips.ethereum.org/EIPS/eip-7484).
+smart account. It allows entities to attest to statements about modules and smart accounts to query these at module installation and/or execution time. The Registry is a Singleton that is free, open and permissionless. It also serves as the reference implementation for [ERC-7484](https://eips.ethereum.org/EIPS/eip-7484).
 
 ## Usage
 
@@ -106,7 +106,7 @@ For feature or change requests, feel free to open a PR or get in touch with us.
 
 ## Credits & Special Thanks
 
-For the continious support and constructive feedback, we would like to thank:
+For the continuous support and constructive feedback, we would like to thank:
 
 - [Ethereum Foundation](https://erc4337.mirror.xyz/hRn_41cef8oKn44ZncN9pXvY3VID6LZOtpLlktXYtmA)
 - ERC-4337 Team

cspell.json

@@ -0,0 +1,55 @@
+{
+  "ignorePaths": [
+    "node_modules/**",
+    "out/**",
+    "lib/**",
+    "broadcast/**",
+    "cache/**",
+    "cache/**",
+    "lcov.info",
+    "pnpm-lock.yaml",
+    "natspec-smells.config.js",
+    "package.json",
+    "remappings.txt"
+  ],
+  "useGitignore": true,
+  "words": [
+    "SSTORE",
+    "SLOAD",
+    "solhint",
+    "zeroknots",
+    "Kopp",
+    "kopy",
+    "rimeissner",
+    "Meissner",
+    "taek",
+    "Biconomy",
+    "IERC",
+    "ERC",
+    "inheritdoc",
+    "solady",
+    "struct",
+    "keccak",
+    "mload",
+    "iszero",
+    "TYPEHASH",
+    "chainid",
+    "natspec",
+    "remappings",
+    "UIDs",
+    "usecase",
+    "callvalue",
+    "initcode",
+    "solmate",
+    "extcodecopy",
+    "permissionless",
+    "structs",
+    "frontrunners",
+    "tokenomics",
+    "uniquify",
+    "uniquifying",
+    "ercs",
+    "SECP",
+    "doesnt"
+  ]
+}

natspec-smells.config.js

@@ -0,0 +1,9 @@
+/**
+ * List of supported options: https://github.com/defi-wonderland/natspec-smells?tab=readme-ov-file#options
+ */
+
+/** @type {import('@defi-wonderland/natspec-smells').Config} */
+module.exports = {
+  include: "src/**/*.sol",
+  exclude: "(test|scripts)/**/*.sol",
+};

package.json

@@ -2,7 +2,7 @@
   "name": "@rhinestone/registry",
   "description": "Rhinestone Registry",
   "license": "GPL-3.0",
-  "version": "0.3.1",
+  "version": "1.0.0",
   "author": {
     "name": "zeroknots.eth",
     "url": "https://rhinestone.wtf"
@@ -14,11 +14,13 @@
     "@openzeppelin/contracts": "5.0.1"
   },
   "devDependencies": {
+    "@defi-wonderland/natspec-smells": "^1.1.1",
+    "cspell": "^8.6.0",
     "ds-test": "github:dapphub/ds-test#e282159d5170298eb2455a6c05280ab5a73a4ef0",
     "forge-std": "github:foundry-rs/forge-std#v1.7.6",
-    "solmate": "github:transmissions11/solmate#c892309933b25c03d32b1b0d674df7ae292ba925",
     "solady": "github:vectorized/solady#9deb9ed36a27261a8745db5b7cd7f4cdc3b1cd4e",
-    "solhint": "^4.1.1"
+    "solhint": "^4.5.2",
+    "solmate": "github:transmissions11/solmate#c892309933b25c03d32b1b0d674df7ae292ba925"
   },
   "files": [
     "artifacts",
@@ -53,6 +55,8 @@
     "test": "forge test",
     "test:lite": "FOUNDRY_PROFILE=lite forge test",
     "test:optimized": "pnpm run build:optimized && FOUNDRY_PROFILE=test-optimized forge test",
-    "build:docs": "forge doc && cd ./docs && rm -rf ./src/src/DataTypes.sol; mdbook build && cd .."
+    "build:docs": "forge doc && cd ./docs && rm -rf ./src/src/DataTypes.sol; mdbook build && cd ..",
+    "natspec": "natspec-smells",
+    "spellcheck": "cspell '**'"
   }
 }