@cowprotocol/hook-dapp-lib 2.0.8 → 2.0.10

package/types.d.ts

@@ -0,0 +1,120 @@
+import { HookDappType, HookDappWalletCompatibility } from './consts';
+export interface CowHook {
+    target: string;
+    callData: string;
+    gasLimit: string;
+    dappId: string;
+}
+export interface HookDappConditions {
+    position?: 'post' | 'pre';
+    walletCompatibility?: HookDappWalletCompatibility[];
+    supportedNetworks?: number[];
+}
+export interface CowHookCreation {
+    hook: Omit<CowHook, 'dappId'>;
+    recipientOverride?: string;
+}
+export interface TokenData {
+    address: string;
+}
+export interface CowHookDetails extends CowHookCreation {
+    hook: CowHook;
+    uuid: string;
+}
+export interface CowHookToEdit extends CowHookCreation {
+    uuid: string;
+}
+export interface CoWHookDappActions {
+    addHook(payload: CowHookCreation): void;
+    editHook(payload: CowHookToEdit): void;
+    setSellToken(token: TokenData): void;
+    setBuyToken(token: TokenData): void;
+}
+export interface HookDappOrderParams {
+    kind: 'buy' | 'sell';
+    validTo: number;
+    sellTokenAddress: string;
+    buyTokenAddress: string;
+    receiver: string;
+    sellAmount: string;
+    buyAmount: string;
+}
+declare enum SimpleTypeType {
+    Address = "address",
+    Bool = "bool",
+    Bytes = "bytes",
+    Slice = "slice",
+    String = "string",
+    Uint = "uint"
+}
+interface Type {
+    type: SimpleTypeType;
+}
+declare enum SoltypeType {
+    Address = "address",
+    Bool = "bool",
+    Bytes32 = "bytes32",
+    MappingAddressUint256 = "mapping (address => uint256)",
+    MappingUint256Uint256 = "mapping (uint256 => uint256)",
+    String = "string",
+    Tuple = "tuple",
+    TypeAddress = "address[]",
+    TypeTuple = "tuple[]",
+    Uint16 = "uint16",
+    Uint256 = "uint256",
+    Uint48 = "uint48",
+    Uint56 = "uint56",
+    Uint8 = "uint8"
+}
+declare enum StorageLocation {
+    Calldata = "calldata",
+    Default = "default",
+    Memory = "memory",
+    Storage = "storage"
+}
+interface SoltypeElement {
+    name: string;
+    type: SoltypeType;
+    storage_location: StorageLocation;
+    components: SoltypeElement[] | null;
+    offset: number;
+    index: string;
+    indexed: boolean;
+    simple_type?: Type;
+}
+interface RawElement {
+    address: string;
+    key: string;
+    original: string;
+    dirty: string;
+}
+export interface StateDiff {
+    address: string;
+    soltype: SoltypeElement | null;
+    original: string | Record<string, unknown>;
+    dirty: string | Record<string, unknown>;
+    raw: RawElement[];
+}
+export interface HookDappContext {
+    chainId: number;
+    account?: string;
+    orderParams: HookDappOrderParams | null;
+    hookToEdit?: CowHookDetails;
+    isSmartContract: boolean | undefined;
+    isPreHook: boolean;
+    isDarkMode: boolean;
+    balancesDiff: Record<string, Record<string, string>>;
+    stateDiff: StateDiff[];
+}
+export interface HookDappBase {
+    id: string;
+    name: string;
+    descriptionShort?: string;
+    description?: string;
+    type: HookDappType;
+    version: string;
+    website: string;
+    image: string;
+    conditions?: HookDappConditions;
+}
+export {};

package/utils.d.ts

@@ -0,0 +1,14 @@
+import { CowHook, HookDappBase } from './types';
+type StrictCowHook = Omit<CowHook, 'dappId'> & {
+    dappId?: string;
+};
+export interface HookToDappMatch {
+    dapp: HookDappBase | null;
+    hook: CowHook;
+}
+export declare function matchHooksToDapps(hooks: StrictCowHook[], dapps: HookDappBase[]): HookToDappMatch[];
+export declare function doesHookHavePermit(hook: {
+    callData: string;
+}): boolean;
+export declare function matchHooksToDappsRegistry(hooks: StrictCowHook[], additionalHookDapps?: HookDappBase[]): HookToDappMatch[];
+export {};

package/CHANGELOG.md

@@ -1,262 +0,0 @@
-# Changelog
-
-## [2.0.8](https://github.com/cowprotocol/cowswap/compare/hook-dapp-lib-v2.0.7...hook-dapp-lib-v2.0.8) (2026-03-11)
-
-
-### Dependencies
-
-* The following workspace dependencies were updated
-  * dependencies
-    * @cowprotocol/iframe-transport bumped to 2.0.8
-
-## [2.0.7](https://github.com/cowprotocol/cowswap/compare/hook-dapp-lib-v2.0.6...hook-dapp-lib-v2.0.7) (2026-03-10)
-
-
-### Dependencies
-
-* The following workspace dependencies were updated
-  * dependencies
-    * @cowprotocol/iframe-transport bumped to 2.0.7
-
-## [2.0.6](https://github.com/cowprotocol/cowswap/compare/hook-dapp-lib-v2.0.5...hook-dapp-lib-v2.0.6) (2026-02-25)
-
-
-### 🔧 Miscellaneous
-
-* main -> dev ([9c6611e](https://github.com/cowprotocol/cowswap/commit/9c6611e90a4b23e23f6aaadc513de3c6d7f3b562))
-
-
-### Dependencies
-
-* The following workspace dependencies were updated
-  * dependencies
-    * @cowprotocol/iframe-transport bumped to 2.0.6
-
-## [2.0.5](https://github.com/cowprotocol/cowswap/compare/hook-dapp-lib-v2.0.4...hook-dapp-lib-v2.0.5) (2026-02-24)
-
-
-### 🔧 Miscellaneous
-
-* merge main into dev 23 02 ([#7062](https://github.com/cowprotocol/cowswap/issues/7062)) ([ac48c9c](https://github.com/cowprotocol/cowswap/commit/ac48c9c83284c6228ba71392edc1c1e0483b53ff))
-
-
-### Dependencies
-
-* The following workspace dependencies were updated
-  * dependencies
-    * @cowprotocol/iframe-transport bumped to 2.0.5
-
-## [2.0.4](https://github.com/cowprotocol/cowswap/compare/hook-dapp-lib-v2.0.3...hook-dapp-lib-v2.0.4) (2026-02-20)
-
-
-### Dependencies
-
-* The following workspace dependencies were updated
-  * dependencies
-    * @cowprotocol/iframe-transport bumped to 2.0.4
-
-## [2.0.3](https://github.com/cowprotocol/cowswap/compare/hook-dapp-lib-v2.0.2...hook-dapp-lib-v2.0.3) (2026-02-13)
-
-
-### Dependencies
-
-* The following workspace dependencies were updated
-  * dependencies
-    * @cowprotocol/iframe-transport bumped to 2.0.3
-
-## [2.0.2](https://github.com/cowprotocol/cowswap/compare/hook-dapp-lib-v2.0.1...hook-dapp-lib-v2.0.2) (2026-02-05)
-
-
-### Dependencies
-
-* The following workspace dependencies were updated
-  * dependencies
-    * @cowprotocol/iframe-transport bumped to 2.0.2
-
-## [2.0.1](https://github.com/cowprotocol/cowswap/compare/hook-dapp-lib-v2.0.0...hook-dapp-lib-v2.0.1) (2026-02-02)
-
-
-### Dependencies
-
-* The following workspace dependencies were updated
-  * dependencies
-    * @cowprotocol/iframe-transport bumped to 2.0.1
-
-## [2.0.0](https://github.com/cowprotocol/cowswap/compare/hook-dapp-lib-v1.14.4...hook-dapp-lib-v2.0.0) (2026-01-28)
-
-
-### ⚠ BREAKING CHANGES
-
-* migrate from yarn to pnpm ([#6847](https://github.com/cowprotocol/cowswap/issues/6847))
-
-### Features
-
-* migrate from yarn to pnpm ([#6847](https://github.com/cowprotocol/cowswap/issues/6847)) ([1c5d115](https://github.com/cowprotocol/cowswap/commit/1c5d11516d0ddb997b0ebbb4eee4adcb491204a4))
-
-
-### Dependencies
-
-* The following workspace dependencies were updated
-  * dependencies
-    * @cowprotocol/iframe-transport bumped to 2.0.0
-
-## [1.14.4](https://github.com/cowprotocol/cowswap/compare/hook-dapp-lib-v1.14.3...hook-dapp-lib-v1.14.4) (2026-01-26)
-
-
-### Dependencies
-
-* The following workspace dependencies were updated
-  * dependencies
-    * @cowprotocol/iframe-transport bumped from ^1.1.1 to ^1.2.0
-
-## [1.14.3](https://github.com/cowprotocol/cowswap/compare/hook-dapp-lib-v1.14.2...hook-dapp-lib-v1.14.3) (2026-01-26)
-
-
-### Dependencies
-
-* The following workspace dependencies were updated
-  * dependencies
-    * @cowprotocol/iframe-transport bumped from ^1.0.0 to ^1.1.1
-
-## [1.14.2](https://github.com/cowprotocol/cowswap/compare/hook-dapp-lib-v1.14.1...hook-dapp-lib-v1.14.2) (2025-12-24)
-
-
-### Bug Fixes
-
-* use aave token logo from cow cdn for aave img ([#6655](https://github.com/cowprotocol/cowswap/issues/6655)) ([b1acbfd](https://github.com/cowprotocol/cowswap/commit/b1acbfdf021fe53265b44c985baa5bf806571e7c))
-
-## [1.14.1](https://github.com/cowprotocol/cowswap/compare/hook-dapp-lib-v1.14.0...hook-dapp-lib-v1.14.1) (2025-12-09)
-
-
-### Bug Fixes
-
-* avoid using i18n in hookDappsRegistry ([#6633](https://github.com/cowprotocol/cowswap/issues/6633)) ([9cfeae0](https://github.com/cowprotocol/cowswap/commit/9cfeae0c107a632e78176c004aa3614fad12f68b))
-
-## [1.14.0](https://github.com/cowprotocol/cowswap/compare/hook-dapp-lib-v1.13.0...hook-dapp-lib-v1.14.0) (2025-11-24)
-
-
-### Features
-
-* **internationalization:** add internationalization to CoW Swap ([#6198](https://github.com/cowprotocol/cowswap/issues/6198)) ([bec1e54](https://github.com/cowprotocol/cowswap/commit/bec1e54643d9b20a8b6517eae188993e364fed90))
-
-## [1.13.0](https://github.com/cowprotocol/cowswap/compare/hook-dapp-lib-v1.12.0...hook-dapp-lib-v1.13.0) (2025-11-05)
-
-
-### Features
-
-* **hook-dapps:** register aave flash-loans hooks ([#6470](https://github.com/cowprotocol/cowswap/issues/6470)) ([a033304](https://github.com/cowprotocol/cowswap/commit/a033304a8a6376ccb28319e998c13a7916eebcd5))
-
-
-### Bug Fixes
-
-* update permit hook description ([#6412](https://github.com/cowprotocol/cowswap/issues/6412)) ([0342200](https://github.com/cowprotocol/cowswap/commit/03422007648aede61f75ac8b66b450e2a01bbe8a))
-
-## [1.12.0](https://github.com/cowprotocol/cowswap/compare/hook-dapp-lib-v1.11.0...hook-dapp-lib-v1.12.0) (2025-10-02)
-
-
-### Features
-
-* **bridge:** use best quote among all providers ([#6299](https://github.com/cowprotocol/cowswap/issues/6299)) ([ba90184](https://github.com/cowprotocol/cowswap/commit/ba901842f4f940e30dedda66b0b39273f53713ae))
-
-## [1.11.0](https://github.com/cowprotocol/cowswap/compare/hook-dapp-lib-v1.10.0...hook-dapp-lib-v1.11.0) (2025-08-28)
-
-
-### Features
-
-* **trade:** implement partial approve ([#6139](https://github.com/cowprotocol/cowswap/issues/6139)) ([6f9d6b0](https://github.com/cowprotocol/cowswap/commit/6f9d6b055323d25705ee88a533f71190944be6e2))
-
-
-### Bug Fixes
-
-* **lens:** follow up fixes ([#6176](https://github.com/cowprotocol/cowswap/issues/6176)) ([cd8f3c0](https://github.com/cowprotocol/cowswap/commit/cd8f3c0201b8f04fc31a59588b6d2d05d215e112))
-
-## [1.10.0](https://github.com/cowprotocol/cowswap/compare/hook-dapp-lib-v1.9.0...hook-dapp-lib-v1.10.0) (2025-08-12)
-
-
-### Features
-
-* rename Permit hook dapp id ([#6138](https://github.com/cowprotocol/cowswap/issues/6138)) ([41b0b18](https://github.com/cowprotocol/cowswap/commit/41b0b182d4a673bb1799a699ea83029ee8c6d73b))
-
-## [1.9.0](https://github.com/cowprotocol/cowswap/compare/hook-dapp-lib-v1.8.0...hook-dapp-lib-v1.9.0) (2025-07-30)
-
-
-### Features
-
-* **bridge:** add bungee to hook dapps registry ([#5974](https://github.com/cowprotocol/cowswap/issues/5974)) ([5cc9ee4](https://github.com/cowprotocol/cowswap/commit/5cc9ee4b293c7e662a6723ad37729cbc08296d23))
-* **hooks:** add polygon to morpho and update info ([#5945](https://github.com/cowprotocol/cowswap/issues/5945)) ([6c47e0e](https://github.com/cowprotocol/cowswap/commit/6c47e0eb481ed4ce5af2b2e3c7cf4c61f4ba79e1))
-
-## [1.8.0](https://github.com/cowprotocol/cowswap/compare/hook-dapp-lib-v1.7.1...hook-dapp-lib-v1.8.0) (2025-07-03)
-
-
-### Features
-
-* **hooks:** add Morpho Lending hook to registry ([#5646](https://github.com/cowprotocol/cowswap/issues/5646)) ([198db52](https://github.com/cowprotocol/cowswap/commit/198db528011ebaf4c2787be1d3413e2e105d2125))
-
-## [1.7.1](https://github.com/cowprotocol/cowswap/compare/hook-dapp-lib-v1.7.0...hook-dapp-lib-v1.7.1) (2025-05-16)
-
-
-### Bug Fixes
-
-* **permit:** dai permit issues ([#5680](https://github.com/cowprotocol/cowswap/issues/5680)) ([a9e2da0](https://github.com/cowprotocol/cowswap/commit/a9e2da026cab2b0e001adc7fb0ebf11d1b028089))
-
-## [1.7.0](https://github.com/cowprotocol/cowswap/compare/hook-dapp-lib-v1.6.0...hook-dapp-lib-v1.7.0) (2025-03-20)
-
-
-### Features
-
-* **hook-store:** add uni-v2 deposit hook dapp ([#5245](https://github.com/cowprotocol/cowswap/issues/5245)) ([f335a05](https://github.com/cowprotocol/cowswap/commit/f335a0575e624747714662e7237b8bd7b97bd49d))
-
-## [1.6.0](https://github.com/cowprotocol/cowswap/compare/hook-dapp-lib-v1.5.0...hook-dapp-lib-v1.6.0) (2025-02-05)
-
-
-### Features
-
-* **hook-store:** add Uniswap v2 withdraw hook dapp ([#5155](https://github.com/cowprotocol/cowswap/issues/5155)) ([2abaf53](https://github.com/cowprotocol/cowswap/commit/2abaf53a5f87c91521ed8dd94e2cd8aa5ecb8aec))
-
-## [1.5.0](https://github.com/cowprotocol/cowswap/compare/hook-dapp-lib-v1.4.0...hook-dapp-lib-v1.5.0) (2025-01-09)
-
-
-### Features
-
-* **swap:** partial approve ([#5256](https://github.com/cowprotocol/cowswap/issues/5256)) ([f080ffd](https://github.com/cowprotocol/cowswap/commit/f080ffdb098612e729f3a3f829410ce78697979f))
-
-## [1.4.0](https://github.com/cowprotocol/cowswap/compare/hook-dapp-lib-v1.3.0...hook-dapp-lib-v1.4.0) (2024-12-11)
-
-
-### Features
-
-* **hook-store:** add cow amm deposit hook dapp ([#5069](https://github.com/cowprotocol/cowswap/issues/5069)) ([4b9331c](https://github.com/cowprotocol/cowswap/commit/4b9331cbfab92fc113043c4e204e280b55d09f62))
-
-## [1.3.0](https://github.com/cowprotocol/cowswap/compare/hook-dapp-lib-v1.2.0...hook-dapp-lib-v1.3.0) (2024-10-29)
-
-
-### Features
-
-* **hook-store:** create bundle hooks tenderly simulation ([#4943](https://github.com/cowprotocol/cowswap/issues/4943)) ([435bfdf](https://github.com/cowprotocol/cowswap/commit/435bfdfa3e68cea1652bc00dcf5908bbc991d7b1))
-
-## [1.2.0](https://github.com/cowprotocol/cowswap/compare/hook-dapp-lib-v1.1.0...hook-dapp-lib-v1.2.0) (2024-10-18)
-
-
-### Features
-
-* **hooks-store:** add claim vesting iframe hook ([#4924](https://github.com/cowprotocol/cowswap/issues/4924)) ([395f48f](https://github.com/cowprotocol/cowswap/commit/395f48f57d93de67305791fdb9a668bdd693074e))
-* **hooks-store:** add sell/buy amounts to hook-dapp context ([#4990](https://github.com/cowprotocol/cowswap/issues/4990)) ([26cbffb](https://github.com/cowprotocol/cowswap/commit/26cbffbbfe8edbc0a4a9ba31fe9c0d42852118d9))
-
-## [1.1.0](https://github.com/cowprotocol/cowswap/compare/hook-dapp-lib-v1.0.0...hook-dapp-lib-v1.1.0) (2024-10-10)
-
-
-### Features
-
-* **explorer:** display order hooks details ([#4921](https://github.com/cowprotocol/cowswap/issues/4921)) ([9c364bd](https://github.com/cowprotocol/cowswap/commit/9c364bd81f2e392a8cece06f6470734ee3d7623c))
-* **hooks-store:** add dapp id to hook callData ([#4920](https://github.com/cowprotocol/cowswap/issues/4920)) ([7111756](https://github.com/cowprotocol/cowswap/commit/7111756e359a8e52daa674068f99217efe27ee5b))
-* **hooks-store:** style hook details ([#4932](https://github.com/cowprotocol/cowswap/issues/4932)) ([83184d2](https://github.com/cowprotocol/cowswap/commit/83184d23da3c812eff87bfc0ec5a2832af0ff235))
-* **hooks-store:** use dappId from hook model to match with dapp ([#4938](https://github.com/cowprotocol/cowswap/issues/4938)) ([46699cb](https://github.com/cowprotocol/cowswap/commit/46699cbe6df02b0f7a3c6c380a04842e9f403a88))
-* **swap:** display order hooks details ([#4925](https://github.com/cowprotocol/cowswap/issues/4925)) ([1e776fc](https://github.com/cowprotocol/cowswap/commit/1e776fc4f6dfb28eebf881e79bb45dbfd693e472))
-
-## 1.0.0 (2024-09-30)
-
-
-### Features
-
-* **hooks-store:** import custom hook-dapps ([#4910](https://github.com/cowprotocol/cowswap/issues/4910)) ([5847017](https://github.com/cowprotocol/cowswap/commit/584701715500525365475660732edb6bbf7ba396))
-* **hooks-store:** support iframe hook-dapps ([#4885](https://github.com/cowprotocol/cowswap/issues/4885)) ([5116f29](https://github.com/cowprotocol/cowswap/commit/5116f296a0e4866d0a51a806b7abe55e809d26e9))

package/jest.config.ts

@@ -1,10 +0,0 @@
-export default {
-  displayName: 'hook-dapp-lib',
-  preset: '../../jest.preset.js',
-  transform: {
-    '^.+\\.[tj]s$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.spec.json' }],
-  },
-  setupFilesAfterEnv: ['../../jest.setup.ts'],
-  moduleFileExtensions: ['ts', 'js', 'html'],
-  coverageDirectory: '../../../coverage/libs/hook-dapp-lib',
-}

package/project.json

@@ -1,51 +0,0 @@
-{
-  "name": "hook-dapp-lib",
-  "$schema": "../../node_modules/nx/schemas/project-schema.json",
-  "sourceRoot": "libs/hook-dapp-lib/src",
-  "projectType": "library",
-  "targets": {
-    "build": {
-      "executor": "@nx/js:tsc",
-      "outputs": ["{options.outputPath}"],
-      "options": {
-        "outputPath": "dist/libs/hook-dapp-lib",
-        "main": "libs/hook-dapp-lib/src/index.ts",
-        "tsConfig": "libs/hook-dapp-lib/tsconfig.lib.json",
-        "assets": ["libs/hook-dapp-lib/*.md"],
-        "updateBuildableProjectDepsInPackageJson": true,
-        "buildableProjectDepsInPackageJsonType": "dependencies"
-      }
-    },
-    "serve": {
-      "executor": "@nx/vite:dev-server",
-      "defaultConfiguration": "development",
-      "options": {
-        "buildTarget": "hook-dapp-lib:build",
-        "port": 3012
-      },
-      "configurations": {}
-    },
-    "lint": {
-      "executor": "@nx/eslint:lint",
-      "outputs": ["{options.outputFile}"],
-      "options": {
-        "lintFilePatterns": ["libs/hook-dapp-lib/**/*.ts"]
-      }
-    },
-    "test": {
-      "executor": "@nx/jest:jest",
-      "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
-      "options": {
-        "jestConfig": "libs/hook-dapp-lib/jest.config.ts",
-        "passWithNoTests": true
-      },
-      "configurations": {
-        "ci": {
-          "ci": true,
-          "codeCoverage": true
-        }
-      }
-    }
-  },
-  "tags": []
-}

package/src/consts.ts

@@ -1,13 +0,0 @@
-export enum HookDappType {
-  INTERNAL = 'INTERNAL',
-  IFRAME = 'IFRAME',
-}
-
-export enum HookDappWalletCompatibility {
-  EOA = 'EOA',
-  SMART_CONTRACT = 'SMART_CONTRACT',
-}
-
-export const HOOK_DAPP_ID_LENGTH = 64
-
-export const PERMIT_HOOK_DAPP_ID = 'cow-swap://libs/hook-dapp-lib/permit'

package/src/hookDappIframeTransport.ts

@@ -1,23 +0,0 @@
-import { IframeTransport } from '@cowprotocol/iframe-transport'
-
-import { CowHookCreation, CowHookDetails, HookDappContext, TokenData } from './types'
-
-export enum CoWHookDappEvents {
-  ACTIVATE = 'ACTIVATE',
-  CONTEXT_UPDATE = 'CONTEXT_UPDATE',
-  ADD_HOOK = 'ADD_HOOK',
-  EDIT_HOOK = 'EDIT_HOOK',
-  SET_SELL_TOKEN = 'SET_SELL_TOKEN',
-  SET_BUY_TOKEN = 'SET_BUY_TOKEN',
-}
-
-export interface HookDappEventsPayloadMap {
-  [CoWHookDappEvents.ACTIVATE]: void
-  [CoWHookDappEvents.CONTEXT_UPDATE]: HookDappContext
-  [CoWHookDappEvents.ADD_HOOK]: CowHookCreation
-  [CoWHookDappEvents.EDIT_HOOK]: CowHookDetails
-  [CoWHookDappEvents.SET_SELL_TOKEN]: TokenData
-  [CoWHookDappEvents.SET_BUY_TOKEN]: TokenData
-}
-
-export const hookDappIframeTransport = new IframeTransport<HookDappEventsPayloadMap>('cowSwapHookDapp')