Updates etherFi logic to include queued to withdrawal shares (#4445)

* Updates etherFi logic to include queued to withdrawal shares

Author: mohamed-mehany

.changeset/calm-plants-heal.md

@@ -0,0 +1,5 @@
+---
+'@chainlink/token-balance-adapter': minor
+---
+
+Updates etherFi logic to include queued to withdrawal shares

packages/sources/token-balance/src/config/EigenPodManager.json

@@ -0,0 +1,25 @@
+[
+  {
+    "inputs": [{ "internalType": "address", "name": "staker", "type": "address" }],
+    "name": "getQueuedWithdrawals",
+    "outputs": [
+      {
+        "components": [
+          { "internalType": "address", "name": "staker", "type": "address" },
+          { "internalType": "address", "name": "delegatedTo", "type": "address" },
+          { "internalType": "address", "name": "withdrawer", "type": "address" },
+          { "internalType": "uint256", "name": "nonce", "type": "uint256" },
+          { "internalType": "uint32", "name": "startBlock", "type": "uint32" },
+          { "internalType": "address[]", "name": "strategies", "type": "address[]" },
+          { "internalType": "uint256[]", "name": "scaledShares", "type": "uint256[]" }
+        ],
+        "internalType": "struct IDelegationManager.Withdrawal[]",
+        "name": "withdrawals",
+        "type": "tuple[]"
+      },
+      { "internalType": "uint256[][]", "name": "shares", "type": "uint256[][]" }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  }
+]

packages/sources/token-balance/src/endpoint/etherFi.ts

@@ -25,13 +25,19 @@ export const inputParameters = new InputParameters(
       type: 'string',
       description: 'Input to eigenStrategy contract',
     },
+    eigenPodManager: {
+      type: 'string',
+      description: 'EigenPodManager contract address used to query queued withdrawals',
+      default: '0x39053D51B77DC0d36036Fc1fCc8Cb819df8Ef37A',
+    },
   },
   [
     {
       splitMain: '0x2ed6c4B5dA6378c7897AC67Ba9e43102Feb694EE',
       splitMainAccount: '',
       eigenStrategy: '0x93c4b944D05dfe6df7645A86cd2206016c51564D',
       eigenStrategyUser: '',
+      eigenPodManager: '0x39053D51B77DC0d36036Fc1fCc8Cb819df8Ef37A',
     },
   ],
 )

packages/sources/token-balance/src/transport/etherFi.ts

@@ -1,12 +1,13 @@
+import { EndpointContext } from '@chainlink/external-adapter-framework/adapter'
 import { TransportDependencies } from '@chainlink/external-adapter-framework/transports'
-import { AdapterResponse, makeLogger, sleep } from '@chainlink/external-adapter-framework/util'
 import { SubscriptionTransport } from '@chainlink/external-adapter-framework/transports/abstract/subscription'
-import { EndpointContext } from '@chainlink/external-adapter-framework/adapter'
+import { AdapterResponse, makeLogger, sleep } from '@chainlink/external-adapter-framework/util'
 import { AdapterInputError } from '@chainlink/external-adapter-framework/validation/error'
-import { BaseEndpointTypes, inputParameters } from '../endpoint/etherFi'
 import { ethers } from 'ethers'
+import EigenPodManager from '../config/EigenPodManager.json'
 import SplitMain from '../config/SplitMain.json'
 import StrategyBaseTVLLimits from '../config/StrategyBaseTVLLimits.json'
+import { BaseEndpointTypes, inputParameters } from '../endpoint/etherFi'
 
 const logger = makeLogger('Token Balances - EtherFi')
 
@@ -74,7 +75,23 @@ export class EtherFiBalanceTransport extends SubscriptionTransport<BaseEndpointT
       this.provider,
     )
     const shares = await eigenContract.shares(param.eigenStrategyUser)
-    const eigenBalance = await eigenContract.sharesToUnderlyingView(shares)
+
+    const eigenPodManagerContract = new ethers.Contract(
+      param.eigenPodManager,
+      EigenPodManager,
+      this.provider,
+    )
+    const { shares: queuedWithdrawalShares } = (await eigenPodManagerContract.getQueuedWithdrawals(
+      param.eigenStrategyUser,
+    )) as { shares?: ethers.BigNumberish[][] }
+
+    const queuedSharesTotal = (queuedWithdrawalShares?.flat() ?? []).reduce(
+      (acc: bigint, val: ethers.BigNumberish) => acc + BigInt(val),
+      0n,
+    )
+
+    const totalShares = shares + queuedSharesTotal
+    const eigenBalance = await eigenContract.sharesToUnderlyingView(totalShares)
 
     return {
       data: {

packages/sources/token-balance/test/integration/__snapshots__/etherFi.test.ts.snap

@@ -0,0 +1,42 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`execute etherFi endpoint happy path returns success including queued withdrawal shares 1`] = `
+{
+  "data": {
+    "decimals": 18,
+    "result": "12345",
+  },
+  "result": "12345",
+  "statusCode": 200,
+  "timestamps": {
+    "providerDataReceivedUnixMs": 978347471111,
+    "providerDataRequestedUnixMs": 978347471111,
+  },
+}
+`;
+
+exports[`execute etherFi endpoint happy path returns success without queued withdrawals 1`] = `
+{
+  "data": {
+    "decimals": 18,
+    "result": "4500000000000000000",
+  },
+  "result": "4500000000000000000",
+  "statusCode": 200,
+  "timestamps": {
+    "providerDataReceivedUnixMs": 978347471111,
+    "providerDataRequestedUnixMs": 978347471111,
+  },
+}
+`;
+
+exports[`execute etherFi endpoint validation errors fails when required fields are missing 1`] = `
+{
+  "error": {
+    "message": "[Param: splitMain] param is required but no value was provided",
+    "name": "AdapterError",
+  },
+  "status": "errored",
+  "statusCode": 400,
+}
+`;

packages/sources/token-balance/test/integration/etherFi.test.ts

@@ -0,0 +1,120 @@
+import {
+  setEnvVariables,
+  TestAdapter,
+} from '@chainlink/external-adapter-framework/util/testing-utils'
+import * as nock from 'nock'
+
+import { ethers } from 'ethers'
+
+import {
+  ETHERFI_SUCCESS_NO_QUEUED_CONFIG,
+  ETHERFI_SUCCESS_WITH_QUEUED_CONFIG,
+  ETHERFI_TEST_PARAMS,
+  mockEtherFiSuccessNoQueued,
+  mockEtherFiSuccessWithQueued,
+} from './fixtures'
+
+describe('execute', () => {
+  let testAdapter: TestAdapter
+  let oldEnv: NodeJS.ProcessEnv
+  let spy: jest.SpyInstance
+
+  const baseParams = {
+    endpoint: 'etherFi',
+    splitMain: ETHERFI_TEST_PARAMS.splitMain,
+    splitMainAccount: ETHERFI_TEST_PARAMS.splitMainAccount,
+    eigenStrategy: ETHERFI_TEST_PARAMS.eigenStrategy,
+    eigenStrategyUser: ETHERFI_TEST_PARAMS.eigenStrategyUser,
+    eigenPodManager: ETHERFI_TEST_PARAMS.eigenPodManager,
+  }
+
+  beforeAll(async () => {
+    oldEnv = JSON.parse(JSON.stringify(process.env))
+
+    process.env.ETHEREUM_RPC_URL =
+      process.env.ETHEREUM_RPC_URL ?? 'http://localhost-eth-mainnet:8080'
+    process.env.ETHEREUM_RPC_CHAIN_ID = process.env.ETHEREUM_RPC_CHAIN_ID ?? '1'
+    process.env.BACKGROUND_EXECUTE_MS = '0'
+
+    const mockDate = new Date('2001-01-01T11:11:11.111Z')
+    spy = jest.spyOn(Date, 'now').mockReturnValue(mockDate.getTime())
+
+    const adapter = (await import('./../../src')).adapter
+    adapter.rateLimiting = undefined
+
+    testAdapter = await TestAdapter.startWithMockedCache(adapter, {
+      testAdapter: {} as TestAdapter<never>,
+    })
+  })
+
+  afterEach(async () => {
+    testAdapter.mockCache?.cache.clear()
+    nock.cleanAll()
+  })
+
+  afterAll(async () => {
+    nock.restore()
+    spy.mockRestore()
+    setEnvVariables(oldEnv)
+    await testAdapter.api.close()
+  })
+
+  describe('etherFi endpoint', () => {
+    describe('happy path', () => {
+      it('returns success without queued withdrawals', async () => {
+        let sharesToUnderlyingCallData: string | undefined
+        mockEtherFiSuccessNoQueued({
+          onSharesToUnderlyingCall: (data) => {
+            sharesToUnderlyingCallData = data
+          },
+        })
+
+        const response = await testAdapter.request(baseParams)
+
+        expect(sharesToUnderlyingCallData).toBeDefined()
+        expect(response.statusCode).toBe(200)
+        const expectedTotalShares = ETHERFI_SUCCESS_NO_QUEUED_CONFIG.strategyShares
+        const expectedCallData = new ethers.Interface([
+          'function sharesToUnderlyingView(uint256 amountShares) view returns (uint256)',
+        ]).encodeFunctionData('sharesToUnderlyingView', [expectedTotalShares])
+        expect(sharesToUnderlyingCallData).toBe(expectedCallData)
+        expect(response.json()).toMatchSnapshot()
+      })
+
+      it('returns success including queued withdrawal shares', async () => {
+        let sharesToUnderlyingCallData: string | undefined
+        mockEtherFiSuccessWithQueued({
+          onSharesToUnderlyingCall: (data) => {
+            sharesToUnderlyingCallData = data
+          },
+        })
+
+        const response = await testAdapter.request(baseParams)
+
+        expect(response.statusCode).toBe(200)
+        expect(response.json()).toMatchSnapshot()
+
+        expect(sharesToUnderlyingCallData).toBeDefined()
+        const expectedTotalShares =
+          ETHERFI_SUCCESS_WITH_QUEUED_CONFIG.strategyShares +
+          ETHERFI_SUCCESS_WITH_QUEUED_CONFIG.queuedShares!.flat().reduce(
+            (acc, val) => acc + val,
+            0n,
+          )
+        const expectedCallData = new ethers.Interface([
+          'function sharesToUnderlyingView(uint256 amountShares) view returns (uint256)',
+        ]).encodeFunctionData('sharesToUnderlyingView', [expectedTotalShares])
+        expect(sharesToUnderlyingCallData).toBe(expectedCallData)
+      })
+    })
+
+    describe('validation errors', () => {
+      it('fails when required fields are missing', async () => {
+        const response = await testAdapter.request({ endpoint: 'etherfi' })
+
+        expect(response.statusCode).toBe(400)
+        expect(response.json()).toMatchSnapshot()
+      })
+    })
+  })
+})