chore: add custom errors to abis

Author: bayological

src/core/abis/fpmm.ts

@@ -15,4 +15,33 @@ export const FPMM_ABI = parseAbi([
   'function rebalanceThresholdBelow() view returns (uint256)',
   'function liquidityStrategy(address) view returns (bool)',
   'function getRebalancingState() view returns (uint256, uint256, uint256, uint256, bool, uint16, uint256)',
+
+  // Custom errors
+  'error ReferenceRateNotSet()',
+  'error ReservesEmpty()',
+  'error InvalidToken()',
+  'error ZeroAddress()',
+  'error ProtocolFeeRecipientRequired()',
+  'error NotFeeSetter()',
+  'error FeeTooHigh()',
+  'error InsufficientLiquidityMinted()',
+  'error InsufficientLiquidityBurned()',
+  'error InsufficientOutputAmount()',
+  'error InsufficientLiquidity()',
+  'error InvalidToAddress()',
+  'error InsufficientInputAmount()',
+  'error NotLiquidityStrategy()',
+  'error OneOutputAmountRequired()',
+  'error PriceDifferenceTooSmall()',
+  'error PriceDifferenceNotImproved()',
+  'error PriceDifferenceMovedInWrongDirection()',
+  'error PriceDifferenceMovedTooFarFromThresholds()',
+  'error InsufficientAmount0In()',
+  'error InsufficientAmount1In()',
+  'error ReserveValueDecreased()',
+  'error RebalanceIncentiveTooHigh()',
+  'error RebalanceThresholdTooHigh()',
+  'error RebalanceDirectionInvalid()',
+  'error LimitDoesNotFitInInt120()',
+  'error InvalidTokenDecimals()',
 ])

src/core/abis/fpmmFactory.ts

@@ -3,4 +3,22 @@ import { parseAbi } from 'viem'
 export const FPMM_FACTORY_ABI = parseAbi([
   'function deployedFPMMAddresses() view returns (address[])',
   'function isPool(address pool) view returns (bool)',
+
+  // Custom errors
+  'error CreateXBytecodeHashMismatch()',
+  'error ZeroAddress()',
+  'error IdenticalTokenAddresses()',
+  'error SortTokensZeroAddress()',
+  'error InvalidOracleAdapter()',
+  'error InvalidProxyAdmin()',
+  'error InvalidOwner()',
+  'error InvalidReferenceRateFeedID()',
+  'error PairAlreadyExists()',
+  'error ImplementationNotRegistered()',
+  'error ImplementationAlreadyRegistered()',
+  'error IndexOutOfBounds()',
+  'error ImplementationIndexMismatch()',
+  'error FeeTooHigh()',
+  'error RebalanceIncentiveTooHigh()',
+  'error RebalanceThresholdTooHigh()',
 ])

src/core/abis/router.ts

@@ -21,7 +21,7 @@ export const ROUTER_ABI = parseAbi([
   'struct Route { address from; address to; address factory; }',
   'struct Zap { address tokenA; address tokenB; address factory; uint256 amountOutMinA; uint256 amountOutMinB; uint256 amountAMin; uint256 amountBMin; }',
 
-  // Custom errors
+  // Custom errors (Router)
   'error ETHTransferFailed()',
   'error Expired()',
   'error InsufficientAmount()',
@@ -42,4 +42,5 @@ export const ROUTER_ABI = parseAbi([
   'error PoolFactoryDoesNotExist()',
   'error SameAddresses()',
   'error ZeroAddress()',
+  'error FXMarketClosed()',
 ])

src/core/abis/virtualPoolFactory.ts

@@ -4,4 +4,12 @@ export const VIRTUAL_POOL_FACTORY_ABI = parseAbi([
   'function getOrPrecomputeProxyAddress(address token0, address token1) view returns (address)',
   'function isPool(address pool) view returns (bool)',
   'function getAllPools() view returns (address[])',
+
+  // Custom errors
+  'error InvalidExchangeProvider()',
+  'error InvalidExchangeId()',
+  'error VirtualPoolAlreadyExistsForThisPair()',
+  'error InvalidCreateXBytecode()',
+  'error PoolNotFound()',
+  'error PoolAlreadyDeprecated()',
 ])

src/services/quotes/QuoteService.ts

@@ -1,4 +1,4 @@
-import { Address, PublicClient } from 'viem'
+import { Address, PublicClient, BaseError, ContractFunctionRevertedError } from 'viem'
 import { RouteService } from '../routes'
 import { Route } from '../../core/types'
 import { ROUTER_ABI } from '../../core/abis'
@@ -7,8 +7,6 @@ import { FXMarketClosedError } from '../../core/errors'
 import { encodeRoutePath, ReadonlyRouterRoutes } from '../../utils/pathEncoder'
 import { validateAddress } from '../../utils/validation'
 
-const FX_MARKET_CLOSED_SIG = '0xa407143a'
-
 /**
  * Service for getting swap quotes from the Mento protocol.
  * Calculates expected output amounts for trades without executing them.
@@ -79,9 +77,14 @@ export class QuoteService {
 
       return amounts[amounts.length - 1]
     } catch (error: unknown) {
-      const errorString = String(error)
-      if (errorString.includes(FX_MARKET_CLOSED_SIG)) {
-        throw new FXMarketClosedError()
+      if (error instanceof BaseError) {
+        const revertError = error.walk((e) => e instanceof ContractFunctionRevertedError)
+        if (
+          revertError instanceof ContractFunctionRevertedError &&
+          revertError.data?.errorName === 'FXMarketClosed'
+        ) {
+          throw new FXMarketClosedError()
+        }
       }
       throw error
     }

tests/unit/services/QuoteService.test.ts

@@ -3,7 +3,9 @@ import { RouteService } from '../../../src/services/routes'
 import { FXMarketClosedError } from '../../../src/core/errors'
 import { PoolType } from '../../../src/core/types'
 import type { PublicClient } from 'viem'
+import { ContractFunctionRevertedError } from 'viem'
 import { ChainId } from '../../../src/core/constants'
+import { ROUTER_ABI } from '../../../src/core/abis'
 
 describe('QuoteService', () => {
   let mockPublicClient: jest.Mocked<PublicClient>
@@ -45,20 +47,24 @@ describe('QuoteService', () => {
   })
 
   describe('FXMarketClosed handling', () => {
-    it('should throw FXMarketClosedError when router reverts with 0xa407143a', async () => {
-      mockPublicClient.readContract.mockRejectedValue(
-        new Error('execution reverted: error 0xa407143a')
-      )
+    function createFXMarketClosedError() {
+      return new ContractFunctionRevertedError({
+        abi: ROUTER_ABI as any,
+        data: '0xa407143a',
+        functionName: 'getAmountsOut',
+      })
+    }
+
+    it('should throw FXMarketClosedError when router reverts with FXMarketClosed', async () => {
+      mockPublicClient.readContract.mockRejectedValue(createFXMarketClosedError())
 
       await expect(
         service.getAmountOut(tokenIn, tokenOut, 1000000000000000000n, mockRoute)
       ).rejects.toThrow(FXMarketClosedError)
     })
 
     it('should throw FXMarketClosedError with descriptive message', async () => {
-      mockPublicClient.readContract.mockRejectedValue(
-        new Error('ContractFunctionExecutionError: 0xa407143a')
-      )
+      mockPublicClient.readContract.mockRejectedValue(createFXMarketClosedError())
 
       await expect(
         service.getAmountOut(tokenIn, tokenOut, 1000000000000000000n, mockRoute)