Hooks Wizard v0.0.1

.changeset/happy-queens-retire.md

@@ -0,0 +1,8 @@
+---
+'@openzeppelin/wizard-uniswap-hooks': patch
+'@openzeppelin/wizard': patch
+'@openzeppelin/wizard-common': patch
+'@openzeppelin/contracts-mcp': patch
+---
+
+Add support for Uniswap Hooks Wizard

.github/CODEOWNERS

@@ -10,3 +10,5 @@
 /packages/ui/src/stylus @OpenZeppelin/stylus @OpenZeppelin/wizard
 /packages/core/stellar @OpenZeppelin/stellar @OpenZeppelin/wizard
 /packages/ui/src/stellar @OpenZeppelin/stellar @OpenZeppelin/wizard
+/packages/core/uniswap-hooks @OpenZeppelin/contracts @OpenZeppelin/wizard
+/packages/ui/src/uniswap-hooks @OpenZeppelin/contracts @OpenZeppelin/wizard

.github/workflows/test.yml

@@ -60,6 +60,7 @@ jobs:
           - cairo
           - stellar
           - stylus
+          - uniswap-hooks
         # This variant config creates 2 branches of the matrix a default and a compile one to run the compile tests in their own job
         variant:
           - default
@@ -71,6 +72,8 @@ jobs:
             variant: compile
           - package: stylus
             variant: compile
+          - package: uniswap-hooks
+            variant: compile
 
 
     runs-on: ubuntu-latest
@@ -82,9 +85,9 @@ jobs:
         uses: ./.github/actions/setup
 
       # ----------------------------
-      # Solidity setup
+      # Solidity and Uniswap Hooks setup
       - name: Install Foundry
-        if: matrix.package == 'solidity'
+        if: matrix.package == 'solidity' || matrix.package == 'uniswap-hooks'
         uses: foundry-rs/foundry-toolchain@82dee4ba654bd2146511f85f0d013af94670c4de #v1.4.0
 
       # ----------------------------

README.md

@@ -4,6 +4,7 @@
 [![Cairo NPM Package](https://img.shields.io/npm/v/@openzeppelin/wizard-cairo?color=%23e55233&label=%40openzeppelin%2Fwizard-cairo)](https://www.npmjs.com/package/@openzeppelin/wizard-cairo)
 [![Stellar NPM Package](https://img.shields.io/npm/v/@openzeppelin/wizard-stellar?color=%23e55233&label=%40openzeppelin%2Fwizard-stellar)](https://www.npmjs.com/package/@openzeppelin/wizard-stellar)
 [![Stylus NPM Package](https://img.shields.io/npm/v/@openzeppelin/wizard-stylus?color=%23e55233&label=%40openzeppelin%2Fwizard-stylus)](https://www.npmjs.com/package/@openzeppelin/wizard-stylus)
+[![Uniswap Hooks NPM Package](https://img.shields.io/npm/v/@openzeppelin/wizard-uniswap-hooks?color=%23e55233&label=%40openzeppelin%2Fwizard-uniswap-hooks)](https://www.npmjs.com/package/@openzeppelin/wizard-uniswap-hooks)
 [![Contracts MCP NPM Package](https://img.shields.io/npm/v/@openzeppelin/contracts-mcp?label=%40openzeppelin%2Fcontracts-mcp)](https://www.npmjs.com/package/@openzeppelin/contracts-mcp)
 [![Netlify Status](https://api.netlify.com/api/v1/badges/ca9b53e1-44eb-410d-aac7-31b2f5399b68/deploy-status)](https://app.netlify.com/sites/openzeppelin-contracts-wizard/deploys)
 

packages/common/src/ai/descriptions/uniswap-hooks.ts

@@ -0,0 +1,94 @@
+// IMPORTANT: This file must not have any imports since it is used in both Node and Deno environments,
+// which have different requirements for file extensions in import statements.
+
+export const byHooksDescriptions = {
+  BaseHook:
+    'Base hook implementation that defines all hook entry points, security and permission helpers. Based on the Uniswap v4 periphery implementation. Hook entry points must be overridden and implemented by the inheriting hook to be used, with respective flags set in getHookPermissions.',
+  BaseAsyncSwap:
+    'Base implementation for async swaps that skip the v3-like swap implementation by taking the full swap input amount and returning a delta that nets out the specified amount to 0. Allows developers to implement arbitrary logic for executing swaps, including asynchronous swaps and custom swap-ordering. Mints ERC-6909 claim tokens for the specified currency and amount.',
+  BaseCustomAccounting:
+    'Base implementation for custom accounting and hook-owned liquidity. Enables tokens to be deposited via the hook to allow control and flexibility over how liquidity is computed. The hook is the sole owner of the liquidity and manages fees over liquidity shares accordingly. Designed to work with a single pool key.',
+  BaseCustomCurve:
+    'Base implementation for custom curves that overrides the default v3-like concentrated liquidity implementation. During a swap, calls a function to get the amount of tokens to be sent to the receiver. The return delta is then consumed and applied by the PoolManager. Does not include fee or salt mechanisms by default.',
+  BaseDynamicFee:
+    "Base implementation to apply a dynamic fee via the PoolManager's updateDynamicLPFee function. Allows hooks to update LP fees dynamically based on external conditions. Includes a poke function that can be called by anyone to update the fee. Alternative names to refer to the hook: 'Dynamic pool fee'.",
+  BaseOverrideFee:
+    "Base implementation for automatic dynamic fees applied before swaps. Allows hooks to override the pool's fee before a swap is processed using the override fee flag. The fee is calculated dynamically and applied to the swap. Alternative names to refer to the hook: 'Dynamic swap fee'.",
+  BaseDynamicAfterFee:
+    "Base implementation for dynamic target hook fees applied after swaps. Enforces a dynamic target for the unspecified currency during beforeSwap, where if the swap outcome is better than the target, any positive difference is taken as a hook fee. Fees are handled or distributed by the hook via afterSwapHandler. Alternative names to refer to the hook: 'Swap target enforcer'.",
+  BaseHookFee:
+    "Base implementation for applying hook fees to the unspecified currency of the swap. These fees are independent of the pool's LP fee and are charged as a percentage of the output amount after the swap completes. Fees are taken as ERC-6909 claims.",
+  AntiSandwichHook:
+    "Implements sandwich-resistant AMM design that guarantees no swaps get filled at a price better than the price at the beginning of the slot window. Within a slot window, swaps impact the pool asymmetrically for buys and sells. Only protects swaps in the zeroForOne direction. Alternative names to refer to the hook: 'Sandwich resistance'.",
+  LiquidityPenaltyHook:
+    "Just-in-Time (JIT) liquidity provisioning resistant hook that disincentivizes JIT attacks by penalizing LP fee collection during liquidity removal and disabling it during liquidity addition if liquidity was recently added. The penalty is donated to the pool's liquidity providers in range at the time of removal. Alternative names to refer to the hook: 'JIT liquidity resistance'.",
+  LimitOrderHook:
+    "Limit Order Mechanism hook that allows users to place limit orders at specific ticks outside of the current price range. Orders will be filled if the pool's price crosses the order's tick. Orders can be cancelled at any time until filled. Once completely filled, the resulting liquidity can be withdrawn from the pool.",
+  ReHypothecationHook:
+    "A Uniswap V4 hook that enables rehypothecation of liquidity positions. Allows users to deposit assets into yield-generating sources while providing liquidity to Uniswap pools Just-in-Time during swaps. Assets earn yield when idle and are temporarily injected as pool liquidity only when needed for swap execution, then immediately withdrawn back to yield sources. Users receive ERC20 shares representing their rehypothecated position. Alternative names to refer to the hook: 'Liquidity rehypothecation'.",
+  BaseOracleHook:
+    'A hook that enables a Uniswap V4 pool to record price observations and expose an oracle interface. Records cumulative tick values and provides time-weighted average price data. Allows increasing observation cardinality to store more historical price data. Provides observe function to get cumulative tick values for specified time periods.',
+  OracleHookWithV3Adapters:
+    'A hook that enables a Uniswap V4 pool to record price observations and expose an oracle interface with Uniswap V3-compatible adapters. Extends BaseOracleHook by automatically deploying standard and truncated V3 oracle adapters for each pool, making the oracle data compatible with existing V3 oracle interfaces and tools.',
+} as const;
+
+export const uniswapHooksPrompts = {
+  Hooks: `Make a Uniswap v4 hook contract using the OpenZeppelin Uniswap Hooks library. ${Object.entries(
+    byHooksDescriptions,
+  )
+    .map(([hookName, hookDescription]) => `${hookName}: ${hookDescription}`)
+    .join(', ')}`,
+};
+
+export const uniswapHooksSharesDescriptions = {
+  options:
+    'The implementation used to represent position shares. Options include disabling shares or issuing ERC20, ERC6909, or ERC1155 tokens.',
+  name: 'The name of the share token when ERC20 shares are enabled.',
+  symbol: 'The symbol of the share token when ERC20 shares are enabled.',
+  uri: 'The metadata URI used when ERC1155 shares are enabled.',
+};
+
+export const uniswapHooksDescriptions = {
+  hook: 'The name of the Uniswap hook',
+  currencySettler:
+    'Whether to include the CurrencySettler utility to settle pending deltas with the PoolManager during flash accounting.',
+  safeCast: 'Whether to include the SafeCast library for safe integer conversions when handling balances or fees.',
+  transientStorage:
+    'Whether to include the TransientSlot and SlotDerivation helpers for temporary state that clears at the end of the transaction.',
+  shares: 'Configuration for optional share tokens exposed by the hook.',
+  permissions:
+    'Toggle lifecycle permissions to enable specific core hook callbacks. Required permissions are enforced automatically.',
+  inputs: 'Hook-specific configuration inputs used by certain templates.',
+};
+
+export const uniswapHooksPermissionDescriptions = {
+  beforeInitialize: 'Whether to enable the `_beforeInitialize` callback to run before pools are initialized.',
+  afterInitialize: 'Whether to enable the `_afterInitialize` callback to react after pool initialization.',
+  beforeAddLiquidity:
+    'Whether to enable the `_beforeAddLiquidity` callback to validate or modify adds before liquidity is deposited.',
+  afterAddLiquidity:
+    'Whether to enable the `_afterAddLiquidity` callback to update accounting after liquidity is added.',
+  beforeRemoveLiquidity:
+    'Whether to enable the `_beforeRemoveLiquidity` callback to validate removals before liquidity is withdrawn.',
+  afterRemoveLiquidity:
+    'Whether to enable the `_afterRemoveLiquidity` callback to update accounting after liquidity is withdrawn.',
+  beforeSwap: 'Whether to enable the `_beforeSwap` callback to inspect and optionally modify swap parameters.',
+  afterSwap: 'Whether to enable the `_afterSwap` callback to perform post-swap accounting or logic.',
+  beforeDonate: 'Whether to enable the `_beforeDonate` callback to run before donations are processed.',
+  afterDonate: 'Whether to enable the `_afterDonate` callback to run after donations are processed.',
+  beforeSwapReturnDelta:
+    'Whether to allow `_beforeSwap` to return a `BeforeSwapDelta`, adjusting the assets that must be provided for the swap.',
+  afterSwapReturnDelta:
+    'Whether to allow `_afterSwap` to return an additional delta that adjusts the final swap settlement.',
+  afterAddLiquidityReturnDelta:
+    'Whether to allow `_afterAddLiquidity` to return a `BalanceDelta` that adjusts how liquidity addition balances are settled.',
+  afterRemoveLiquidityReturnDelta:
+    'Whether to allow `_afterRemoveLiquidity` to return a `BalanceDelta` that adjusts how liquidity removal balances are settled.',
+};
+
+export const uniswapHooksInputsDescriptions = {
+  blockNumberOffset:
+    'The number of blocks that must elapse after liquidity is added before it can be removed without penalties. Used by liquidity protection hooks.',
+  maxAbsTickDelta:
+    'The maximum absolute tick change that can be recorded per oracle observation. Lower values resist manipulation but lag during volatility.',
+};

packages/common/src/index.ts

@@ -3,3 +3,4 @@ export * from './ai/descriptions/cairo';
 export * from './ai/descriptions/solidity';
 export * from './ai/descriptions/stellar';
 export * from './ai/descriptions/stylus';
+export * from './ai/descriptions/uniswap-hooks';

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␊