fix(APP-517): Resolve cryptex voting escrow addresses dynamically (#1066)

thekidnamedkd · web-flow · commit bb2198b1746d · 2026-04-02T10:04:08.000+02:00
* fix: resolve cryptex voting escrow addresses dynamically

* fix: rename cryptex token voting rewards test dao

* chore: include changeset

* chore: generalize VE token lookup

* chore: docs, revert minor return change
diff --git a/.changeset/some-bats-lose.md b/.changeset/some-bats-lose.md
@@ -0,0 +1,5 @@
+---
+"@aragon/app": patch
+---
+
+Resolve cryptex voting escrow addresses dynamically
diff --git a/src/actions/capitalDistributor/components/capitalDistributorCreateCampaignActionCreate/capitalDistributorCampaignPayoutField.tsx b/src/actions/capitalDistributor/components/capitalDistributorCreateCampaignActionCreate/capitalDistributorCampaignPayoutField.tsx
@@ -3,7 +3,10 @@
 import { InputContainer, RadioCard, RadioGroup } from '@aragon/gov-ui-kit';
 import { useWatch } from 'react-hook-form';
 import type { Hex } from 'viem';
-import { CapitalFlowDaoSlotId } from '@/modules/capitalFlow/constants/moduleDaoSlots';
+import {
+    CapitalFlowDaoSlotId,
+    type ICapitalDistributorVotingEscrowAddressParams,
+} from '@/modules/capitalFlow/constants/moduleDaoSlots';
 import { useTranslations } from '@/shared/components/translationsProvider';
 import { useFormField } from '@/shared/hooks/useFormField';
 import { useSlotSingleFunction } from '@/shared/hooks/useSlotSingleFunction';
@@ -29,10 +32,13 @@ export const CapitalDistributorCampaignPayoutField: React.FC<
     const { fieldPrefix, daoId } = props;
     const { t } = useTranslations();
 
-    const escrowAddress = useSlotSingleFunction<void, Hex | undefined>({
+    const escrowAddress = useSlotSingleFunction<
+        ICapitalDistributorVotingEscrowAddressParams,
+        Hex | undefined
+    >({
         slotId: CapitalFlowDaoSlotId.CAPITAL_DISTRIBUTOR_VOTING_ESCROW_ADDRESS,
         pluginId: daoId,
-        params: undefined,
+        params: { daoId },
     });
 
     const { onChange, ...payoutTypeField } = useFormField<
diff --git a/src/actions/capitalDistributor/components/capitalDistributorCreateCampaignActionCreate/capitalDistributorCreateCampaignActionCreate.tsx b/src/actions/capitalDistributor/components/capitalDistributorCreateCampaignActionCreate/capitalDistributorCreateCampaignActionCreate.tsx
@@ -12,7 +12,10 @@ import {
     type Hex,
     zeroHash,
 } from 'viem';
-import { CapitalFlowDaoSlotId } from '@/modules/capitalFlow/constants/moduleDaoSlots';
+import {
+    CapitalFlowDaoSlotId,
+    type ICapitalDistributorVotingEscrowAddressParams,
+} from '@/modules/capitalFlow/constants/moduleDaoSlots';
 import {
     type IProposalActionData,
     useCreateProposalFormContext,
@@ -50,10 +53,13 @@ export const CapitalDistributorCreateCampaignActionCreate: React.FC<
     const { addPrepareAction } =
         useCreateProposalFormContext<ICapitalDistributorActionCreateCampaign>();
 
-    const escrowAddress = useSlotSingleFunction<void, Hex | undefined>({
+    const escrowAddress = useSlotSingleFunction<
+        ICapitalDistributorVotingEscrowAddressParams,
+        Hex | undefined
+    >({
         slotId: CapitalFlowDaoSlotId.CAPITAL_DISTRIBUTOR_VOTING_ESCROW_ADDRESS,
         pluginId: daoId,
-        params: undefined,
+        params: { daoId },
     });
 
     const fieldName = `actions.[${index.toString()}]`;
diff --git a/src/daos/cryptex/components/cryptexMembersFileDownload/cryptexMembersFileDownload.tsx b/src/daos/cryptex/components/cryptexMembersFileDownload/cryptexMembersFileDownload.tsx
@@ -7,17 +7,16 @@ import { useTranslations } from '@/shared/components/translationsProvider';
 import {
     cryptex,
     cryptexTokenVotingPluginAddress,
-    tokenCDTest,
-    tokenCDTestTokenVotingPluginAddress,
+    tokenVotingRewardsTest,
+    tokenVotingRewardsTestTokenVotingPluginAddress,
 } from '../../constants';
 import { CryptexDialogId } from '../../constants/cryptexDialogId';
 import type { ICryptexMembersFileDownloadDialogParams } from '../../dialogs/cryptexMembersFileDownloadDialog';
 import type { ICryptexMembersFileDownloadProps } from './cryptexMembersFileDownload.api';
 
-// TODO: Remove tokenCDTest entry when mainnet capital distributor is live (APP-558)
 const tokenVotingPluginAddresses: Record<string, `0x${string}`> = {
     [cryptex.id]: cryptexTokenVotingPluginAddress,
-    [tokenCDTest.id]: tokenCDTestTokenVotingPluginAddress,
+    [tokenVotingRewardsTest.id]: tokenVotingRewardsTestTokenVotingPluginAddress,
 };
 
 export const CryptexMembersFileDownload: React.FC<
diff --git a/src/daos/cryptex/constants/domains/tokenCDTest.ts b/src/daos/cryptex/constants/domains/tokenCDTest.ts
diff --git a/src/daos/cryptex/constants/domains/tokenVotingRewardsTest.ts b/src/daos/cryptex/constants/domains/tokenVotingRewardsTest.ts
@@ -0,0 +1 @@
+export * from '../../tokenVotingRewardsTest/tokenVotingRewardsTest';
diff --git a/src/daos/cryptex/constants/index.ts b/src/daos/cryptex/constants/index.ts
@@ -2,5 +2,6 @@ export * from './actions';
 export * from './cryptexDialogId';
 export * from './cryptexDialogsDefinitions';
 export * from './domains/cryptexMainnet';
-export * from './domains/tokenCDTest';
+export * from './domains/tokenVotingRewardsTest';
 export * from './tokens';
+export * from './tokenVotingPluginAddresses';
diff --git a/src/daos/cryptex/constants/tokenVotingPluginAddresses.ts b/src/daos/cryptex/constants/tokenVotingPluginAddresses.ts
@@ -0,0 +1,13 @@
+import {
+    cryptex,
+    cryptexTokenVotingPluginAddress,
+} from '../cryptexMainnet/constants/cryptexMainnet';
+import {
+    tokenVotingRewardsTest,
+    tokenVotingRewardsTestTokenVotingPluginAddress,
+} from '../tokenVotingRewardsTest/tokenVotingRewardsTest';
+
+export const cryptexTokenVotingPluginAddressByDaoId = {
+    [cryptex.id]: cryptexTokenVotingPluginAddress,
+    [tokenVotingRewardsTest.id]: tokenVotingRewardsTestTokenVotingPluginAddress,
+} satisfies Record<string, `0x${string}`>;
diff --git a/src/daos/cryptex/cryptexMainnet/constants/cryptexMainnet.ts b/src/daos/cryptex/cryptexMainnet/constants/cryptexMainnet.ts
@@ -9,12 +9,3 @@ export const cryptex = {
  */
 export const cryptexTokenVotingPluginAddress: `0x${string}` =
     '0x17a1688C56087aDe762721180e1cC1E831C73719';
-
-/**
- * Hardcoded voting escrow (veLocker) address shared by Cryptex DAOs.
- */
-export const cryptexVotingEscrowAddress: `0x${string}` =
-    '0x2DE5aE18750FBf82821212194D59aCc989469CDd';
-
-export const getCryptexVotingEscrowAddress = (): `0x${string}` =>
-    cryptexVotingEscrowAddress;
diff --git a/src/daos/cryptex/hooks/useCryptexVotingEscrowAddress.ts b/src/daos/cryptex/hooks/useCryptexVotingEscrowAddress.ts
@@ -0,0 +1,9 @@
+'use client';
+
+import { createCapitalDistributorVotingEscrowAddressResolver } from '@/modules/capitalFlow/hooks';
+import { cryptexTokenVotingPluginAddressByDaoId } from '../constants';
+
+export const useCryptexVotingEscrowAddress =
+    createCapitalDistributorVotingEscrowAddressResolver({
+        pluginAddressByDaoId: cryptexTokenVotingPluginAddressByDaoId,
+    });
diff --git a/src/daos/cryptex/index.ts b/src/daos/cryptex/index.ts
@@ -3,11 +3,8 @@ import { DashboardDaoSlotId } from '@/modules/dashboard/constants/moduleDaoSlots
 import { pluginRegistryUtils } from '@/shared/utils/pluginRegistryUtils';
 import { CryptexMembersFileDownload } from './components/cryptexMembersFileDownload';
 import { CryptexPageHeader } from './components/cryptexPageHeader';
-import {
-    cryptex,
-    getCryptexVotingEscrowAddress,
-    tokenCDTest,
-} from './constants';
+import { cryptex, tokenVotingRewardsTest } from './constants';
+import { useCryptexVotingEscrowAddress } from './hooks/useCryptexVotingEscrowAddress';
 
 export const initialiseCryptex = () => {
     pluginRegistryUtils
@@ -28,21 +25,19 @@ export const initialiseCryptex = () => {
         .registerSlotFunction({
             slotId: CapitalFlowDaoSlotId.CAPITAL_DISTRIBUTOR_VOTING_ESCROW_ADDRESS,
             pluginId: cryptex.id,
-            function: getCryptexVotingEscrowAddress,
+            function: useCryptexVotingEscrowAddress,
         })
-
-        // TODO: Remove tokenCDTest when mainnet capital distributor is live (APP-558)
-        .registerPlugin(tokenCDTest)
+        .registerPlugin(tokenVotingRewardsTest)
 
         .registerSlotComponent({
             slotId: CapitalFlowDaoSlotId.CAPITAL_DISTRIBUTOR_MEMBERS_FILE_DOWNLOAD,
-            pluginId: tokenCDTest.id,
+            pluginId: tokenVotingRewardsTest.id,
             component: CryptexMembersFileDownload,
         })
 
         .registerSlotFunction({
             slotId: CapitalFlowDaoSlotId.CAPITAL_DISTRIBUTOR_VOTING_ESCROW_ADDRESS,
-            pluginId: tokenCDTest.id,
-            function: getCryptexVotingEscrowAddress,
+            pluginId: tokenVotingRewardsTest.id,
+            function: useCryptexVotingEscrowAddress,
         });
 };
diff --git a/src/daos/cryptex/tokenCDTest/constants/tokenCDTest.ts b/src/daos/cryptex/tokenCDTest/constants/tokenCDTest.ts
diff --git a/src/daos/cryptex/tokenVotingRewardsTest/tokenVotingRewardsTest.ts b/src/daos/cryptex/tokenVotingRewardsTest/tokenVotingRewardsTest.ts
@@ -0,0 +1,8 @@
+// Temporary Cryptex Sepolia DAO entry for dev.app custom DAO wiring.
+export const tokenVotingRewardsTest = {
+    id: 'ethereum-sepolia-0xF445edE111dD57Effc7aC9bcf8fC3dF1f60797Fa',
+    name: 'tokenVotingRewardsTest',
+};
+
+export const tokenVotingRewardsTestTokenVotingPluginAddress: `0x${string}` =
+    '0xCCBe12eC0B50E14e62870BE41e6D9258b5D609c9';
diff --git a/src/daos/katana/capitalDistributorTest/constants/capitalDistributorTest.ts b/src/daos/katana/capitalDistributorTest/constants/capitalDistributorTest.ts
@@ -3,6 +3,3 @@ export const capitalDistributorTestDao = {
     id: 'ethereum-sepolia-0x4ec795c6F2a67634C2E8e7Fd9887dc83283D059b',
     name: 'capitalDistributorTest',
 };
-
-export const capitalDistributorTestVotingEscrowAddress: `0x${string}` =
-    '0xAB2b63dbf65eFd507F4Cb63cFc55116E75737d60';
diff --git a/src/daos/katana/hooks/useKatanaVotingEscrowAddress.ts b/src/daos/katana/hooks/useKatanaVotingEscrowAddress.ts
@@ -0,0 +1,6 @@
+'use client';
+
+import { createCapitalDistributorVotingEscrowAddressResolver } from '@/modules/capitalFlow/hooks';
+
+export const useKatanaVotingEscrowAddress =
+    createCapitalDistributorVotingEscrowAddressResolver();
diff --git a/src/daos/katana/index.ts b/src/daos/katana/index.ts
@@ -3,14 +3,11 @@ import { pluginRegistryUtils } from '@/shared/utils/pluginRegistryUtils';
 import { CapitalDistributorTestMembersFileDownload } from './components/capitalDistributorTestMembersFileDownload';
 import {
     capitalDistributorTestDao,
-    capitalDistributorTestVotingEscrowAddress,
     katanaCDDemo,
-    katanaCDDemoVotingEscrowAddress,
     katanaEmissionsTest,
-    katanaEmissionsTestVotingEscrowAddress,
     katanaVKatManagement,
-    katanaVKatManagementVotingEscrowAddress,
 } from './constants';
+import { useKatanaVotingEscrowAddress } from './hooks/useKatanaVotingEscrowAddress';
 
 export const initialiseKatana = () => {
     pluginRegistryUtils
@@ -25,7 +22,7 @@ export const initialiseKatana = () => {
         .registerSlotFunction({
             slotId: CapitalFlowDaoSlotId.CAPITAL_DISTRIBUTOR_VOTING_ESCROW_ADDRESS,
             pluginId: katanaCDDemo.id,
-            function: () => katanaCDDemoVotingEscrowAddress,
+            function: useKatanaVotingEscrowAddress,
         })
 
         .registerPlugin(katanaEmissionsTest)
@@ -39,7 +36,7 @@ export const initialiseKatana = () => {
         .registerSlotFunction({
             slotId: CapitalFlowDaoSlotId.CAPITAL_DISTRIBUTOR_VOTING_ESCROW_ADDRESS,
             pluginId: katanaEmissionsTest.id,
-            function: () => katanaEmissionsTestVotingEscrowAddress,
+            function: useKatanaVotingEscrowAddress,
         })
 
         // TODO: Remove capitalDistributorTest when mainnet capital distributor is live (APP-558)
@@ -54,7 +51,7 @@ export const initialiseKatana = () => {
         .registerSlotFunction({
             slotId: CapitalFlowDaoSlotId.CAPITAL_DISTRIBUTOR_VOTING_ESCROW_ADDRESS,
             pluginId: capitalDistributorTestDao.id,
-            function: () => capitalDistributorTestVotingEscrowAddress,
+            function: useKatanaVotingEscrowAddress,
         })
 
         .registerPlugin(katanaVKatManagement)
@@ -68,6 +65,6 @@ export const initialiseKatana = () => {
         .registerSlotFunction({
             slotId: CapitalFlowDaoSlotId.CAPITAL_DISTRIBUTOR_VOTING_ESCROW_ADDRESS,
             pluginId: katanaVKatManagement.id,
-            function: () => katanaVKatManagementVotingEscrowAddress,
+            function: useKatanaVotingEscrowAddress,
         });
 };
diff --git a/src/daos/katana/katanaCDDemo/constants/katanaCDDemo.ts b/src/daos/katana/katanaCDDemo/constants/katanaCDDemo.ts
@@ -2,6 +2,3 @@ export const katanaCDDemo = {
     id: 'katana-mainnet-0x0cD4B1347D06e386970b89A010f54e3a9Cc31834',
     name: 'katanaCDDemo',
 };
-
-export const katanaCDDemoVotingEscrowAddress: `0x${string}` =
-    '0x5Ef1cE4fC5207A784E1E848EF6AA954beE710af1';
diff --git a/src/daos/katana/katanaEmissionsTest/constants/katanaEmissionsTest.ts b/src/daos/katana/katanaEmissionsTest/constants/katanaEmissionsTest.ts
@@ -2,6 +2,3 @@ export const katanaEmissionsTest = {
     id: 'katana-mainnet-0x888Db6ef6503a0CcDbdcf754f5e753362BD97B45',
     name: 'katanaEmissionsTest',
 };
-
-export const katanaEmissionsTestVotingEscrowAddress: `0x${string}` =
-    '0x5Ef1cE4fC5207A784E1E848EF6AA954beE710af1';
diff --git a/src/daos/katana/katanaVKatManagement/constants/katanaVKatManagement.ts b/src/daos/katana/katanaVKatManagement/constants/katanaVKatManagement.ts
@@ -2,6 +2,3 @@ export const katanaVKatManagement = {
     id: 'katana-mainnet-0xb72291652f15cF73651357383c0A86FBba29B675',
     name: 'katanaVKatManagement',
 };
-
-export const katanaVKatManagementVotingEscrowAddress: `0x${string}` =
-    '0x4d6fC15Ca6258b168225D283262743C623c13Ead';
diff --git a/src/modules/capitalFlow/constants/moduleDaoSlots.ts b/src/modules/capitalFlow/constants/moduleDaoSlots.ts
@@ -2,3 +2,7 @@ export enum CapitalFlowDaoSlotId {
     CAPITAL_DISTRIBUTOR_MEMBERS_FILE_DOWNLOAD = 'CAPITAL_DISTRIBUTOR_MEMBERS_FILE_DOWNLOAD',
     CAPITAL_DISTRIBUTOR_VOTING_ESCROW_ADDRESS = 'CAPITAL_DISTRIBUTOR_VOTING_ESCROW_ADDRESS',
 }
+
+export interface ICapitalDistributorVotingEscrowAddressParams {
+    daoId: string;
+}
diff --git a/src/modules/capitalFlow/hooks/index.ts b/src/modules/capitalFlow/hooks/index.ts
@@ -0,0 +1,4 @@
+export {
+    createCapitalDistributorVotingEscrowAddressResolver,
+    type ICreateCapitalDistributorVotingEscrowAddressResolverParams,
+} from './useCapitalDistributorVotingEscrowAddress';
diff --git a/src/modules/capitalFlow/hooks/useCapitalDistributorVotingEscrowAddress.ts b/src/modules/capitalFlow/hooks/useCapitalDistributorVotingEscrowAddress.ts
@@ -0,0 +1,103 @@
+'use client';
+
+import type { Hex } from 'viem';
+import { PluginInterfaceType } from '@/shared/api/daoService';
+import { useDaoPlugins } from '@/shared/hooks/useDaoPlugins';
+import type { ICapitalDistributorVotingEscrowAddressParams } from '../constants/moduleDaoSlots';
+
+/**
+ * Internal plugin meta shape used by the voting-escrow resolver.
+ */
+interface IPluginWithVotingEscrow {
+    /**
+     * Plugin instance address returned by the DAO plugins query.
+     */
+    address: string;
+    /**
+     * Interface discriminator used to prioritize matching plugins.
+     */
+    interfaceType: PluginInterfaceType;
+    /**
+     * Optional voting-escrow configuration exposed on plugin metadata.
+     */
+    votingEscrow?: {
+        /**
+         * Voting escrow contract address associated with the plugin.
+         */
+        escrowAddress: string;
+    };
+}
+
+/**
+ * Internal configuration for building the capital distributor voting-escrow
+ * address resolver.
+ */
+export interface ICreateCapitalDistributorVotingEscrowAddressResolverParams {
+    /**
+     * Optional DAO-to-plugin address overrides used to resolve a specific
+     * plugin before falling back to interface-type matching.
+     */
+    pluginAddressByDaoId?: Record<string, `0x${string}`>;
+    /**
+     * Preferred plugin interface order used when multiple plugins expose a
+     * voting escrow address.
+     */
+    preferredInterfaceTypes?: PluginInterfaceType[];
+}
+
+const defaultPreferredInterfaceTypes = [
+    PluginInterfaceType.GAUGE_VOTER,
+    PluginInterfaceType.TOKEN_VOTING,
+];
+
+export const createCapitalDistributorVotingEscrowAddressResolver = (
+    config: ICreateCapitalDistributorVotingEscrowAddressResolverParams = {},
+) => {
+    const {
+        pluginAddressByDaoId,
+        preferredInterfaceTypes = defaultPreferredInterfaceTypes,
+    } = config;
+
+    return (params: ICapitalDistributorVotingEscrowAddressParams) => {
+        const { daoId } = params;
+        const preferredPluginAddress = pluginAddressByDaoId?.[daoId];
+
+        const plugins = useDaoPlugins({
+            daoId,
+            pluginAddress: preferredPluginAddress,
+            includeSubPlugins: true,
+        });
+
+        const pluginMetas =
+            plugins?.map((plugin) => plugin.meta as IPluginWithVotingEscrow) ??
+            [];
+
+        const pluginWithEscrowAddress = pluginMetas.find(
+            (plugin) => plugin.votingEscrow?.escrowAddress != null,
+        );
+
+        if (preferredPluginAddress != null) {
+            return pluginWithEscrowAddress?.votingEscrow?.escrowAddress as
+                | Hex
+                | undefined;
+        }
+
+        for (const interfaceType of preferredInterfaceTypes) {
+            const matchingPlugin = pluginMetas.find(
+                (plugin) =>
+                    plugin.interfaceType === interfaceType &&
+                    plugin.votingEscrow?.escrowAddress != null,
+            );
+
+            if (matchingPlugin?.votingEscrow?.escrowAddress != null) {
+                return matchingPlugin.votingEscrow.escrowAddress as
+                    | Hex
+                    | undefined;
+            }
+        }
+
+        return pluginWithEscrowAddress?.votingEscrow?.escrowAddress as
+            | Hex
+            | undefined;
+    };
+};

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"@aragon/app": patch
 +---
++
 +Resolve cryptex voting escrow addresses dynamically
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+export * from '../../tokenVotingRewardsTest/tokenVotingRewardsTest';`