@cowprotocol/hook-dapp-lib 1.7.1 → 2.0.2

package/README.md

@@ -27,10 +27,6 @@ And it expects calling two callbacks:
 npm install @cowprotocol/hook-dapp-lib --save
 ```
 
-```
-yarn add @cowprotocol/hook-dapp-lib
-```
-
 Let's create a simple hook-dapp that will check the COW token balance of the order creator.
 
 ```html

package/jest.config.ts

@@ -0,0 +1,10 @@
+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/package.json

@@ -1,26 +1,15 @@
 {
   "name": "@cowprotocol/hook-dapp-lib",
-  "version": "1.7.1",
-  "type": "commonjs",
+  "version": "2.0.2",
   "description": "CoW Swap Hook Dapp Library. Allows you to develop pre/post hooks dapps for CoW Protocol.",
-  "main": "index.js",
-  "exports": {
-    "import": "./index.js",
-    "require": "./index.mjs"
-  },
+  "type": "commonjs",
+  "main": "./src/index.ts",
+  "types": "./src/index.d.ts",
   "license": "ISC",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/cowprotocol/cowswap"
+  "publishConfig": {
+    "access": "public"
   },
-  "keywords": [
-    "cowprotocol",
-    "hooks",
-    "cowswap",
-    "dex",
-    "hook-dapp-lib"
-  ],
   "dependencies": {
-    "@cowprotocol/iframe-transport": "^1.0.0"
+    "@cowprotocol/iframe-transport": "2.0.2"
   }
-}
+}

package/project.json

@@ -0,0 +1,51 @@
+{
+  "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

@@ -0,0 +1,13 @@
+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

@@ -0,0 +1,23 @@
+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')

package/src/hookDappsRegistry.ts

@@ -0,0 +1,209 @@
+import { PERMIT_HOOK_DAPP_ID } from './consts'
+
+export const hookDappsRegistry = {
+  BUILD_CUSTOM_HOOK: {
+    type: 'INTERNAL',
+    name: `Build your own hook`,
+    descriptionShort: `Call any smart contract with your own parameters`,
+    description: `Didn't find a suitable hook? You can always create your own! To do this, you need to specify which smart contract you want to call, the parameters for the call and the gas limit.`,
+    image:
+      'https://raw.githubusercontent.com/cowprotocol/cowswap/refs/heads/develop/apps/cowswap-frontend/src/modules/hooksStore/dapps/BuildHookApp/build.png',
+    version: 'v0.1.0',
+    website: 'https://docs.cow.fi/cow-protocol/tutorials/hook-dapp',
+  },
+  CLAIM_GNO_FROM_VALIDATORS: {
+    type: 'INTERNAL',
+    name: `Claim GNO from validators`,
+    descriptionShort: `Withdraw rewards from your Gnosis validators.`,
+    description: `This hook allows you to withdraw rewards from your Gnosis Chain validators through CoW Swap. It automates the process of interacting with the Gnosis Deposit Contract, enabling you to claim any available rewards directly to your specified withdrawal address. The hook monitors your validator's accrued rewards and triggers the claimWithdrawals function when rewards are ready for withdrawal. This simplifies the management of Gnosis validator earnings without requiring ready for withdrawal. This simplifies the management of Gnosis validator earnings without requiring manual contract interaction, providing a smoother and more efficient experience for users.`,
+    image:
+      'https://raw.githubusercontent.com/cowprotocol/cowswap/897ce91ca60a6b2d3823e6a002c3bf64c5384afe/libs/assets/src/cow-swap/network-gnosis-chain-logo.svg',
+    version: 'v0.1.1',
+    website: 'https://www.gnosis.io',
+    conditions: {
+      supportedNetworks: [100],
+      position: 'pre',
+    },
+  },
+  [PERMIT_HOOK_DAPP_ID]: {
+    type: 'INTERNAL',
+    name: `Permit a token`,
+    descriptionShort: `Permit an address to spend one token on your behalf.`,
+    description: `This hook allows you to permit an address to spend your tokens on your behalf. This is useful for allowing a smart contract to spend your tokens without needing to approve each transaction.`,
+    image:
+      'https://raw.githubusercontent.com/cowprotocol/cowswap/refs/heads/develop/apps/cowswap-frontend/src/modules/hooksStore/dapps/PermitHookApp/icon.png',
+    version: 'v0.1.0',
+    website: 'https://docs.cow.fi/cow-protocol/tutorials/hook-dapp',
+    conditions: {
+      walletCompatibility: ['EOA'],
+      supportedNetworks: [11155111],
+    },
+  },
+  CLAIM_COW_AIRDROP: {
+    type: 'INTERNAL',
+    name: `Claim COW Airdrop`,
+    descriptionShort: `Retrieve COW tokens before or after a swap.`,
+    description: `Effortless Airdrop Claims! The Claim COW Airdrop feature simplifies the process of collecting free COW tokens before or after your swap, seamlessly integrating into the CoW Swap platform. Whether you're claiming new airdrops or exploring CoW on a new network, this tool ensures you get your rewards quickly and easily.`,
+    image:
+      'https://raw.githubusercontent.com/cowprotocol/cowswap/897ce91ca60a6b2d3823e6a002c3bf64c5384afe/apps/cowswap-frontend/src/modules/hooksStore/dapps/AirdropHookApp/airdrop.svg',
+    version: 'v0.1.0',
+    website: 'https://github.com/bleu/cow-airdrop-contract-deployer',
+    conditions: {
+      supportedNetworks: [11155111],
+    },
+  },
+  COW_AMM_WITHDRAW: {
+    name: `CoW AMM Withdraw Liquidity`,
+    type: 'IFRAME',
+    descriptionShort: `Remove liquidity from a CoW AMM pool before the swap`,
+    description: `Reduce or withdraw liquidity from a pool before a token swap integrating the process directly into the transaction flow. By adjusting your liquidity ahead of time, you gain more control over your assets without any extra steps. Optimize your position in a pool, all in one seamless action — no need for multiple transactions or added complexity.`,
+    version: '0.0.1',
+    website: 'https://balancer.fi/pools/cow',
+    image: 'https://cow-hooks-dapps-withdraw-pool.vercel.app/icon.png',
+    url: 'https://cow-hooks-dapps-withdraw-pool.vercel.app/',
+    conditions: {
+      position: 'pre',
+      walletCompatibility: ['EOA'],
+      supportedNetworks: [1, 100, 8453, 42161, 11155111],
+    },
+  },
+  CLAIM_LLAMAPAY_VESTING: {
+    type: 'IFRAME',
+    name: `Claim LlamaPay Vesting Hook`,
+    description: `The Claim LlamaPay Vesting Hook is a powerful and user-friendly feature designed to streamline the process of claiming funds from LlamaPay vesting contracts. This tool empowers users to easily access and manage their vested tokens, ensuring a smooth and efficient experience in handling time-locked assets.`,
+    descriptionShort: `Claim your LlamaPay vesting contract funds`,
+    image: 'https://cow-hooks-dapps-claim-vesting.vercel.app/llama-pay-icon.png',
+    version: '0.1.0',
+    website: 'https://github.com/bleu/cow-hooks-dapps',
+    url: 'https://cow-hooks-dapps-claim-vesting.vercel.app',
+    conditions: {
+      supportedNetworks: [1, 100, 42161],
+      walletCompatibility: ['EOA'],
+    },
+  },
+  CREATE_LLAMAPAY_VESTING: {
+    type: 'IFRAME',
+    name: `Create LlamaPay Vesting`,
+    descriptionShort: `Create a LlamaPay vesting contract`,
+    description: `This hook allows you to easily set up vesting contracts with LlamaPay. Enter the recipient’s address or ENS name, then choose how much to transfer: the token buy will be automatically detected by the hook and the contracts will be linked to your LlamaPay dashboard for seamless tracking.`,
+    version: '0.1.0',
+    website: 'https://llamapay.io/vesting',
+    image: 'https://cow-hooks-dapps-create-vesting.vercel.app/llama-pay-icon.png',
+    url: 'https://cow-hooks-dapps-create-vesting.vercel.app',
+    conditions: {
+      position: 'post',
+      walletCompatibility: ['EOA'],
+      supportedNetworks: [1, 100, 42161],
+    },
+  },
+  UNI_V2_WITHDRAW: {
+    type: 'IFRAME',
+    name: `Withdraw Uniswap v2 Liquidity`,
+    descriptionShort: `Remove liquidity from a Uniswap v2 Weighted pool before the swap`,
+    description: `Reduce or withdraw Uniswap v2 from a pool before a token swap integrating the process directly into the transaction flow. By adjusting your liquidity ahead of time, you gain more control over your assets without any extra steps. Optimize your position in a pool, all in one seamless action — no need for multiple transactions or added complexity.`,
+    version: '0.0.1',
+    website: 'https://app.uniswap.org/pools/v2',
+    image: 'https://cow-hooks-dapps-withdraw-uniswap-v2.vercel.app/icon.png',
+    url: 'https://cow-hooks-dapps-withdraw-uniswap-v2.vercel.app/',
+    conditions: {
+      position: 'pre',
+      walletCompatibility: ['EOA'],
+      supportedNetworks: [1, 42161, 11155111, 8453],
+    },
+  },
+  COW_AMM_DEPOSIT: {
+    name: `CoW AMM Deposit`,
+    type: 'IFRAME',
+    descriptionShort: `Add liquidity to any of the CoW AMM pools`,
+    description: `Easily increase your position in a liquidity pool, adding both tokens in the right ratio.\n\n Whether you're seeking to increase your exposure to specific tokens or maximize the returns from your assets, this tool offers a quick and efficient way to enhance your liquidity position after a token swap, all in a smooth, efficient process.`,
+    version: '0.0.1',
+    website: 'https://balancer.fi/pools/cow',
+    image: 'https://cow-hooks-dapps-cow-amm-deposit.vercel.app/icon.png',
+    url: 'https://cow-hooks-dapps-cow-amm-deposit.vercel.app/',
+    conditions: {
+      position: 'post',
+      walletCompatibility: ['EOA'],
+      supportedNetworks: [1, 100, 8453, 42161, 11155111],
+    },
+  },
+  UNI_V2_DEPOSIT: {
+    name: `Uniswap v2 Deposit`,
+    type: 'IFRAME',
+    descriptionShort: `Add liquidity to a Uniswap v2 pool after the swap`,
+    description: `Easily increase your position in a liquidity pool, adding both tokens in the right ratio.\n\n Whether you're seeking to increase your exposure to specific tokens or maximize the returns from your assets, this tool offers a quick and efficient way to enhance your liquidity position after a token swap, all in a smooth, efficient process.`,
+    version: '0.0.1',
+    website: 'https://app.uniswap.org/pools/v2',
+    image: 'https://cow-hooks-dapps-9zio.vercel.app/icon.png',
+    url: 'https://cow-hooks-dapps-9zio.vercel.app/',
+    conditions: {
+      position: 'post',
+      walletCompatibility: ['EOA'],
+      supportedNetworks: [1, 42161, 11155111, 8453],
+    },
+  },
+  MORPHO_BORROW: {
+    name: `Morpho Borrow`,
+    type: 'IFRAME',
+    descriptionShort: `Supply collateral, borrow, repay and withdraw collateral on Morpho Protocol.`,
+    description: `The Morpho Borrow hook enables users to seamlessly combine swaps with borrow-related actions. Users can enter new positions, leave existing ones, or move between different markets through a unified, streamlined process.`,
+    version: '0.0.1',
+    website: 'https://app.morpho.org/',
+    image: 'https://cow-hooks-dapps-morpho-lending.vercel.app/icon.png',
+    url: 'https://cow-hooks-dapps-morpho-lending.vercel.app/',
+    conditions: {
+      walletCompatibility: ['EOA'],
+      supportedNetworks: [1, 137, 8453],
+    },
+  },
+  'cow-sdk://bridging/providers/bungee': {
+    name: `Bungee`,
+    type: 'INTERNAL',
+    descriptionShort: `Bungee Protocol - Swap tokens across chains`,
+    description: `Bungee is a liquidity marketplace that lets you swap into any token on any chain in a fully abstracted manner. Trade any token with the best quotes and a gasless UX!`,
+    version: '0.0.1',
+    website: 'https://www.bungee.exchange',
+    image: 'https://files.cow.fi/cow-sdk/bridging/providers/bungee/bungee-logo.png',
+    conditions: {
+      walletCompatibility: ['EOA'],
+    },
+  },
+  'cow-sdk://bridging/providers/across': {
+    name: `Across`,
+    type: 'INTERNAL',
+    descriptionShort: `Across Protocol - Transfer Assets Between Layer 2s and Mainnet`,
+    description: `Across is the fastest, cheapest and most secure cross-chain bridge for Ethereum, Arbitrum, Optimism, Polygon and other Layer 1 and Layer 2 networks. Transfer tokens with Across.`,
+    version: '0.0.1',
+    website: 'https://across.to',
+    image: 'https://files.cow.fi/cow-sdk/bridging/providers/across/across-logo.png',
+    conditions: {
+      walletCompatibility: ['EOA'],
+    },
+  },
+  'cow-sdk://flashloans/aave/v3/collateral-swap': {
+    name: `Aave Collateral Swap`,
+    type: 'INTERNAL',
+    descriptionShort: `Aave Collateral Swap Flashloan`,
+    description: `The swap adapter contracts integrate Aave Flash Loans and CoW Swap to facilitate advanced actions like swapping collateral assets when there are borrow positions. Learn more at https://aave.com/docs/developers/smart-contracts/swap-features.`,
+    version: '0.0.1',
+    website: 'https://aave.com',
+    image: 'https://files.cow.fi/token-lists/images/1/0x7fc66500c84a76ad7e9c93437bfc5ac33e2ddae9/logo.png',
+  },
+  'cow-sdk://flashloans/aave/v3/debt-swap': {
+    name: `Aave Debt Swap`,
+    type: 'INTERNAL',
+    descriptionShort: `Aave Debt Swap Flashloan`,
+    description: `The swap adapter contracts integrate Aave Flash Loans and CoW Swap to facilitate advanced actions like swapping debt assets. Learn more at https://aave.com/docs/developers/smart-contracts/swap-features.`,
+    version: '0.0.1',
+    website: 'https://aave.com',
+    image: 'https://files.cow.fi/token-lists/images/1/0x7fc66500c84a76ad7e9c93437bfc5ac33e2ddae9/logo.png',
+  },
+  'cow-sdk://flashloans/aave/v3/repay-with-collateral': {
+    name: `Aave Repay`,
+    type: 'INTERNAL',
+    descriptionShort: `Aave Repay with Collateral Flashloan`,
+    description: `The swap adapter contracts integrate Aave Flash Loans and CoW Swap to facilitate advanced actions like repaying borrow positions using collateral. Learn more at https://aave.com/docs/developers/smart-contracts/swap-features.`,
+    version: '0.0.1',
+    website: 'https://aave.com',
+    image: 'https://files.cow.fi/token-lists/images/1/0x7fc66500c84a76ad7e9c93437bfc5ac33e2ddae9/logo.png',
+  },
+}

package/src/index.ts

@@ -0,0 +1,6 @@
+export { initCoWHookDapp } from './initCoWHookDapp'
+export * from './hookDappIframeTransport'
+export * from './types'
+export * from './consts'
+export * from './utils'
+export { hookDappsRegistry } from './hookDappsRegistry'

package/src/initCoWHookDapp.ts

@@ -0,0 +1,42 @@
+import { WidgetEthereumProvider } from '@cowprotocol/iframe-transport'
+
+import { CoWHookDappEvents, hookDappIframeTransport } from './hookDappIframeTransport'
+import { CowHookCreation, CoWHookDappActions, CowHookDetails, HookDappContext, TokenData } from './types'
+
+interface CoWHookDappInit {
+  onContext(context: HookDappContext): void
+}
+
+export interface CoWHookDappHandler {
+  actions: CoWHookDappActions
+  provider: WidgetEthereumProvider
+}
+
+export function initCoWHookDapp({ onContext }: CoWHookDappInit): CoWHookDappHandler {
+  const parent = window.parent
+  const provider = new WidgetEthereumProvider()
+  const actions = getCoWHookDappActions()
+
+  hookDappIframeTransport.listenToMessageFromWindow(window, CoWHookDappEvents.CONTEXT_UPDATE, onContext)
+
+  hookDappIframeTransport.postMessageToWindow(parent, CoWHookDappEvents.ACTIVATE, void 0)
+
+  return { actions, provider }
+}
+
+function getCoWHookDappActions(): CoWHookDappActions {
+  return {
+    addHook(payload: CowHookCreation) {
+      hookDappIframeTransport.postMessageToWindow(parent, CoWHookDappEvents.ADD_HOOK, payload)
+    },
+    editHook(payload: CowHookDetails) {
+      hookDappIframeTransport.postMessageToWindow(parent, CoWHookDappEvents.EDIT_HOOK, payload)
+    },
+    setSellToken(token: TokenData) {
+      hookDappIframeTransport.postMessageToWindow(parent, CoWHookDappEvents.SET_SELL_TOKEN, token)
+    },
+    setBuyToken(token: TokenData) {
+      hookDappIframeTransport.postMessageToWindow(parent, CoWHookDappEvents.SET_BUY_TOKEN, token)
+    },
+  }
+}

package/src/types.ts

@@ -0,0 +1,141 @@
+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
+}
+
+enum SimpleTypeType {
+  Address = 'address',
+  Bool = 'bool',
+  Bytes = 'bytes',
+  Slice = 'slice',
+  String = 'string',
+  Uint = 'uint',
+}
+
+interface Type {
+  type: SimpleTypeType
+}
+
+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',
+}
+
+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
+  // { [address: string]: { [token: string]: balanceDiff: string } }
+  // example: { '0x123': { '0x456': '100', '0xabc': '-100' } }
+  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
+}

package/src/utils.ts

@@ -0,0 +1,68 @@
+import { PERMIT_HOOK_DAPP_ID } from './consts'
+import { hookDappsRegistry } from './hookDappsRegistry'
+import { CowHook, HookDappBase } from './types'
+
+const hookDapps = Object.keys(hookDappsRegistry).reduce((acc, id) => {
+  const dapp = (hookDappsRegistry as Record<string, Omit<HookDappBase, 'id'>>)[id]
+
+  acc.push({ id, ...dapp })
+  return acc
+}, [] as HookDappBase[])
+
+// permit() function selector
+const EIP_2612_PERMIT_SELECTOR = '0xd505accf'
+const DAI_PERMIT_SELECTOR = '0x8fcbaf0c'
+
+// Before the hooks store the dappId wasn't included in the hook object
+type StrictCowHook = Omit<CowHook, 'dappId'> & { dappId?: string }
+
+export interface HookToDappMatch {
+  dapp: HookDappBase | null
+  hook: CowHook
+}
+
+export function matchHooksToDapps(hooks: StrictCowHook[], dapps: HookDappBase[]): HookToDappMatch[] {
+  const dappsMap = dapps.reduce(
+    (acc, dapp) => {
+      acc[dapp.id] = dapp
+      return acc
+    },
+    {} as Record<string, HookDappBase | undefined>,
+  )
+
+  return (
+    hooks
+      // Skip hooks before the hooks store was introduced
+      .filter((hook) => !!hook.dappId)
+      .map((_hook) => {
+        const hook = _hook as CowHook
+        const dapp = dappsMap[hook.dappId]
+
+        /**
+         * Permit token is a special case, as it's not a dapp, but a hook
+         */
+        if (doesHookHavePermit(hook)) {
+          return {
+            hook,
+            dapp: hookDappsRegistry[PERMIT_HOOK_DAPP_ID] as HookDappBase,
+          }
+        }
+
+        return {
+          hook,
+          dapp: dapp || null,
+        }
+      })
+  )
+}
+
+export function doesHookHavePermit(hook: { callData: string }): boolean {
+  return hook.callData.startsWith(EIP_2612_PERMIT_SELECTOR) || hook.callData.startsWith(DAI_PERMIT_SELECTOR)
+}
+
+export function matchHooksToDappsRegistry(
+  hooks: StrictCowHook[],
+  additionalHookDapps: HookDappBase[] = [],
+): HookToDappMatch[] {
+  return matchHooksToDapps(hooks, hookDapps.concat(additionalHookDapps))
+}

package/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "module": "commonjs",
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "noImplicitOverride": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true
+  },
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.lib.json"
+    },
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ]
+}

package/tsconfig.lib.json

@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "declaration": true,
+    "types": ["node"]
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["src/**/*.spec.ts", "src/**/*.test.ts"]
+}

package/tsconfig.spec.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../../dist/out-tsc",
+    "module": "commonjs",
+    "types": ["jest", "node"]
+  },
+  "include": ["jest.config.ts", "src/**/*.test.ts", "src/**/*.spec.ts", "src/**/*.d.ts", "src/lib/widget.ts"]
+}