Hooks Wizard v0.0.0 [WIP]

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[];
@@ -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/print.ts

@@ -40,6 +40,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,
@@ -260,3 +261,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/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)

packages/core/uniswap-hooks/NOTICE

@@ -0,0 +1,8 @@
+OpenZeppelin Contracts Wizard
+Copyright (C) 2021-2025  Zeppelin Group Ltd
+
+This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, version 3.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.

packages/core/uniswap-hooks/README.md

@@ -0,0 +1 @@
+# OpenZeppelin Contracts Wizard for Uniswap Hooks

packages/core/uniswap-hooks/ava.config.js

@@ -0,0 +1,9 @@
+module.exports = {
+  extensions: ['ts'],
+  require: ['ts-node/register'],
+  watchmode: {
+    ignoreChanges: ['contracts', 'artifacts', 'cache'],
+  },
+  timeout: '10m',
+  workerThreads: false,
+};

packages/core/uniswap-hooks/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@openzeppelin/wizard-uniswap-hooks",
+  "version": "0.0.1",
+  "description": "A boilerplate generator to get started with OpenZeppelin Contracts for Uniswap Hooks",
+  "license": "AGPL-3.0-only",
+  "repository": "https://github.com/OpenZeppelin/contracts-wizard",
+  "main": "dist/index.js",
+  "ts:main": "src/index.ts",
+  "files": [
+    "LICENSE",
+    "NOTICE",
+    "/dist",
+    "/src",
+    "!**/*.test.*"
+  ],
+  "scripts": {
+    "prepare": "tsc",
+    "prepublish": "rimraf dist *.tsbuildinfo && hardhat clean",
+    "test": "ava",
+    "test:update-snapshots": "ava --update-snapshots",
+    "test:watch": "ava --watch"
+  },
+  "devDependencies": {
+    "@openzeppelin/contracts": "^5.3.0",
+    "@openzeppelin/uniswap-hooks": "https://github.com/OpenZeppelin/uniswap-hooks",
+    "@uniswap/v4-core": "^1.0.2",
+    "@uniswap/v4-periphery": "^1.0.3",
+    "@types/node": "^20.0.0",
+    "@types/semver": "^7.5.7",
+    "ava": "^6.0.0",
+    "hardhat": "^2.22.11",
+    "rimraf": "^5.0.0",
+    "semver": "^7.6.0",
+    "solidity-ast": "^0.4.18",
+    "ts-node": "^10.4.0",
+    "typescript": "^5.0.0"
+  }
+}

packages/core/uniswap-hooks/src/api.ts

@@ -0,0 +1,16 @@
+import type { WizardContractAPI, AccessControlAPI } from '@openzeppelin/wizard/src/api';
+
+import {
+  printHooks,
+  defaults as hooksDefaults,
+  isAccessControlRequired as hooksIsAccessControlRequired,
+} from './hooks';
+import type { HooksOptions } from './hooks';
+
+export type Hooks = WizardContractAPI<HooksOptions> & AccessControlAPI<HooksOptions>;
+
+export const hooks: Hooks = {
+  print: printHooks,
+  defaults: hooksDefaults,
+  isAccessControlRequired: hooksIsAccessControlRequired,
+};

packages/core/uniswap-hooks/src/build-generic.ts

@@ -0,0 +1,16 @@
+import type { Contract } from '@openzeppelin/wizard/src/contract';
+import type { HooksOptions } from './hooks';
+import { buildHooks } from './hooks';
+
+export interface KindedOptions {
+  Hooks: { kind: 'Hooks' } & HooksOptions;
+}
+
+export type GenericOptions = KindedOptions[keyof KindedOptions];
+
+export function buildGeneric(opts: GenericOptions): Contract {
+  switch (opts.kind) {
+    case 'Hooks':
+      return buildHooks(opts);
+  }
+}

packages/core/uniswap-hooks/src/generate/hooks.ts

@@ -0,0 +1,33 @@
+import type { HookName, HooksOptions } from '../hooks';
+import { Hooks } from '../hooks';
+import { accessOptions } from '@openzeppelin/wizard/src/set-access-control';
+import { infoOptions } from '@openzeppelin/wizard/src/set-info';
+import { generateAlternatives } from '@openzeppelin/wizard/src/generate/alternatives';
+
+const booleanOptions = [true, false];
+
+const sharesOptions = [
+  { options: false, name: 'MyShares', symbol: 'MSH' },
+  { options: 'ERC20', name: 'MyShares', symbol: 'MSH' },
+  { options: 'ERC6909', name: 'MyShares', symbol: 'MSH' },
+] as const;
+
+const hooksOptions: HookName[] = Hooks.map(hook => hook.name);
+
+const blueprint = {
+  hook: hooksOptions as readonly HookName[],
+  name: ['MyHook'] as const,
+  pausable: booleanOptions,
+  currencySettler: booleanOptions,
+  safeCast: booleanOptions,
+  transientStorage: booleanOptions,
+  access: accessOptions,
+  // Hooks are not upgradeable yet; fix to false
+  upgradeable: [false] as const,
+  info: infoOptions,
+  shares: sharesOptions,
+};
+
+export function* generateHooksOptions(): Generator<Required<HooksOptions>> {
+  yield* generateAlternatives(blueprint);
+}