Hooks Wizard v0.0.1

packages/core/solidity/src/contract.test.ts.md

@@ -9,7 +9,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts ^5.4.0␊
+    ␊
     pragma solidity ^0.8.27;␊
     ␊
     contract Foo {␊
@@ -21,7 +21,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts ^5.4.0␊
+    ␊
     pragma solidity ^0.8.27;␊
     ␊
     contract Footec {␊
@@ -33,7 +33,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts ^5.4.0␊
+    ␊
     pragma solidity ^0.8.27;␊
     ␊
     import {Bar} from "./Bar.sol";␊
@@ -47,7 +47,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts ^5.4.0␊
+    ␊
     pragma solidity ^0.8.27;␊
     ␊
     import {Bar} from "./Bar.sol";␊
@@ -62,7 +62,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts ^5.4.0␊
+    ␊
     pragma solidity ^0.8.27;␊
     ␊
     import {Bar} from "./Bar.sol";␊
@@ -77,7 +77,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts ^5.4.0␊
+    ␊
     pragma solidity ^0.8.27;␊
     ␊
     import {Bar} from "./Bar.sol";␊
@@ -93,7 +93,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts ^5.4.0␊
+    ␊
     pragma solidity ^0.8.27;␊
     ␊
     contract Foo {␊
@@ -105,7 +105,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts ^5.4.0␊
+    ␊
     pragma solidity ^0.8.27;␊
     ␊
     contract Foo {␊
@@ -125,7 +125,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts ^5.4.0␊
+    ␊
     pragma solidity ^0.8.27;␊
     ␊
     contract Foo {␊
@@ -149,7 +149,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts ^5.4.0␊
+    ␊
     pragma solidity ^0.8.27;␊
     ␊
     contract Foo {␊
@@ -162,7 +162,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts ^5.4.0␊
+    ␊
     pragma solidity ^0.8.27;␊
     ␊
     contract Foo {␊
@@ -177,7 +177,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts ^5.4.0␊
+    ␊
     pragma solidity ^0.8.27;␊
     ␊
     contract Foo {␊
@@ -192,7 +192,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts ^5.4.0␊
+    ␊
     pragma solidity ^0.8.27;␊
     ␊
     import {Bar} from "./Bar.sol";␊
@@ -209,7 +209,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts ^5.4.0␊
+    ␊
     pragma solidity ^0.8.27;␊
     ␊
     contract Foo {␊
@@ -224,7 +224,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts ^5.4.0␊
+    ␊
     pragma solidity ^0.8.27;␊
     ␊
     contract Foo {␊
@@ -240,7 +240,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts ^5.4.0␊
+    ␊
     pragma solidity ^0.8.27;␊
     ␊
     contract Foo {␊
@@ -253,7 +253,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts ^5.4.0␊
+    ␊
     pragma solidity ^0.8.27;␊
     ␊
     contract Foo {␊
@@ -267,7 +267,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts ^5.4.0␊
+    ␊
     pragma solidity ^0.8.27;␊
     ␊
     contract FooBarBaz {␊
@@ -279,7 +279,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts ^5.4.0␊
+    ␊
     pragma solidity ^0.8.27;␊
     ␊
     /// @custom:security-contact security@example.com␊

packages/core/solidity/src/contract.ts

@@ -5,6 +5,7 @@ export interface Contract {
   license: string;
   parents: Parent[];
   natspecTags: NatspecTag[];
+  using: Using[];
   imports: ImportContract[];
   functions: ContractFunction[];
   constructorCode: string[];
@@ -52,7 +53,7 @@ export interface ContractFunction extends BaseFunction {
   comments: string[];
 }
 
-export type FunctionKind = 'internal' | 'public';
+export type FunctionKind = 'private' | 'internal' | 'public' | 'external';
 export type FunctionMutability = (typeof mutabilityRank)[number];
 
 // Order is important
@@ -133,6 +134,15 @@ export class ContractBuilder implements Contract {
     return !present;
   }
 
+  addUsing(library: ImportContract, usingFor: string): boolean {
+    const exists = this.using.some(u => u.library.name === library.name && u.usingFor === usingFor);
+    if (!exists) {
+      this.using.push({ library, usingFor });
+      return true;
+    }
+    return false;
+  }
+
   addOverride(parent: ReferencedContract, baseFn: BaseFunction, mutability?: FunctionMutability) {
     const fn = this.addFunction(baseFn);
     fn.override.add(parent);

packages/core/solidity/src/custom.test.ts.md

@@ -9,7 +9,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts ^5.4.0␊
+    ␊
     pragma solidity ^0.8.27;␊
     ␊
     contract MyContract {␊
@@ -21,7 +21,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts ^5.4.0␊
+    ␊
     pragma solidity ^0.8.27;␊
     ␊
     contract Contract {␊
@@ -106,7 +106,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts ^5.4.0␊
+    ␊
     pragma solidity ^0.8.27;␊
     ␊
     contract MyContract {␊

packages/core/solidity/src/options.ts

@@ -27,6 +27,10 @@ const upgradeableImport = (p: ImportContract): ImportContract => {
 
 export interface Options {
   transformImport?: (parent: ImportContract) => ImportContract;
+  /**
+   * Add additional libraries to the compatibility banner printed at the top of the contract.
+   */
+  additionalCompatibleLibraries?: { name: string; path: string; version: string }[];
 }
 
 export interface Helpers extends Required<Options> {
@@ -45,5 +49,6 @@ export function withHelpers(contract: Contract, opts: Options = {}): Helpers {
       const p2 = contractUpgradeable && inferTranspiled(p1) ? upgradeableImport(p1) : p1;
       return opts.transformImport?.(p2) ?? p2;
     },
+    additionalCompatibleLibraries: opts.additionalCompatibleLibraries ?? [],
   };
 }

packages/core/solidity/src/print.ts

@@ -17,7 +17,7 @@ import SOLIDITY_VERSION from './solidity-version.json';
 import { inferTranspiled } from './infer-transpiled';
 import { compatibleContractsSemver } from './utils/version';
 import { stringifyUnicodeSafe } from './utils/sanitize';
-import { importsCommunityContracts } from './utils/imports-libraries';
+import { importsLibrary } from './utils/imports-libraries';
 import { getCommunityContractsGitCommit } from './utils/community-contracts-git-commit';
 
 export function printContract(contract: Contract, opts?: Options): string {
@@ -31,7 +31,7 @@ export function printContract(contract: Contract, opts?: Options): string {
     ...spaceBetween(
       [
         `// SPDX-License-Identifier: ${contract.license}`,
-        printCompatibleLibraryVersions(contract),
+        printCompatibleLibraryVersions(contract, opts),
         `pragma solidity ^${SOLIDITY_VERSION};`,
       ],
 
@@ -42,6 +42,7 @@ export function printContract(contract: Contract, opts?: Options): string {
         [`contract ${contract.name}`, ...printInheritance(contract, helpers), '{'].join(' '),
 
         spaceBetween(
+          printUsing(contract, helpers),
           contract.variables,
           printConstructor(contract, helpers),
           ...fns.code,
@@ -56,17 +57,30 @@ export function printContract(contract: Contract, opts?: Options): string {
   );
 }
 
-function printCompatibleLibraryVersions(contract: Contract): string {
-  let result = `// Compatible with OpenZeppelin Contracts ${compatibleContractsSemver}`;
-  if (importsCommunityContracts(contract)) {
+function printCompatibleLibraryVersions(contract: Contract, opts?: Options): string {
+  const libraries: string[] = [];
+  if (importsLibrary(contract, '@openzeppelin/contracts')) {
+    libraries.push(`OpenZeppelin Contracts ${compatibleContractsSemver}`);
+  }
+  if (importsLibrary(contract, '@openzeppelin/community-contracts')) {
     try {
       const commit = getCommunityContractsGitCommit();
-      result += ` and Community Contracts commit ${commit}`;
+      libraries.push(`Community Contracts commit ${commit}`);
     } catch (e) {
       console.error(e);
     }
   }
-  return result;
+  if (opts?.additionalCompatibleLibraries) {
+    for (const library of opts.additionalCompatibleLibraries) {
+      if (importsLibrary(contract, library.path)) {
+        libraries.push(`${library.name} ${library.version}`);
+      }
+    }
+  }
+
+  if (libraries.length === 0) return '';
+  if (libraries.length === 1) return `// Compatible with ${libraries[0]}`;
+  return `// Compatible with ${libraries.slice(0, -1).join(', ')} and ${libraries.slice(-1)}`;
 }
 
 function printInheritance(contract: Contract, { transformName }: Helpers): [] | [string] {
@@ -275,3 +289,20 @@ function printImports(imports: ImportContract[], helpers: Helpers): string[] {
 
   return lines;
 }
+
+function printUsing(contract: Contract, { transformName }: Helpers): string[] {
+  if (!contract.using || contract.using.length === 0) {
+    return [];
+  }
+
+  // Emit in stable order by library then type to keep output deterministic
+  const entries = [...contract.using].sort((a, b) => {
+    if (a.library.name < b.library.name) return -1;
+    if (a.library.name > b.library.name) return 1;
+    if (a.usingFor < b.usingFor) return -1;
+    if (a.usingFor > b.usingFor) return 1;
+    return 0;
+  });
+
+  return entries.map(u => `using ${transformName(u.library)} for ${u.usingFor};`);
+}

packages/core/solidity/src/utils/imports-libraries.ts

@@ -1,5 +1,5 @@
 import type { Contract } from '../contract';
 
-export function importsCommunityContracts(contract: Contract) {
-  return contract.imports.some(i => i.path.startsWith('@openzeppelin/community-contracts/'));
+export function importsLibrary(contract: Contract, library: string) {
+  return contract.imports.some(i => i.path.startsWith(library));
 }

packages/core/solidity/src/zip-foundry.test.ts.md

@@ -1252,7 +1252,7 @@ Generated by [AVA](https://avajs.dev).
       }␊
       `,
       `// SPDX-License-Identifier: MIT␊
-      // Compatible with OpenZeppelin Contracts ^5.4.0␊
+      ␊
       pragma solidity ^0.8.27;␊
       ␊
       contract MyContract {␊

packages/core/solidity/src/zip-hardhat.test.ts.md

@@ -491,7 +491,7 @@ Generated by [AVA](https://avajs.dev).
 
     [
       `// SPDX-License-Identifier: MIT␊
-      // Compatible with OpenZeppelin Contracts ^5.4.0␊
+      ␊
       pragma solidity ^0.8.27;␊
       ␊
       contract MyContract {␊

packages/core/uniswap-hooks/.gitignore

@@ -0,0 +1,4 @@
+/cache
+/artifacts
+/contracts/generated
+/openzeppelin-contracts.json

packages/core/uniswap-hooks/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+
+## 0.0.1 (2025-08-11)
+
+- Initial version. (PR link)