Implement handleRequest of XrplTransport (#3866)

Author: dskloetc

.changeset/strong-kings-double.md

@@ -0,0 +1,5 @@
+---
+'@chainlink/token-balance-adapter': patch
+---
+
+Adding not-yet used code for future new endpoint

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

@@ -5,6 +5,21 @@ import { xrplTransport } from '../transport/xrpl'
 
 export const inputParameters = new InputParameters(
   {
+    tokenIssuerAddress: {
+      required: true,
+      type: 'string',
+      description: 'Identifies the token, e.g., TBILL, to fetch the balance of',
+    },
+    priceOracleAddress: {
+      required: true,
+      type: 'string',
+      description: 'Address of the price oracle contract to use to convert the above token to USD',
+    },
+    priceOracleNetwork: {
+      required: true,
+      type: 'string',
+      description: 'EVM network on which to query the price oracle (ethereum, arbitrum, etc.)',
+    },
     addresses: {
       required: true,
       type: {
@@ -20,6 +35,9 @@ export const inputParameters = new InputParameters(
   },
   [
     {
+      tokenIssuerAddress: 'rJNE2NNz83GJYtWVLwMvchDWEon3huWnFn',
+      priceOracleAddress: '0xCe9a6626Eb99eaeA829D7fA613d5D0A2eaE45F40',
+      priceOracleNetwork: 'ethereum',
       addresses: [
         {
           address: 'rGSA6YCGzywj2hsPA8DArSsLr1DMTBi2LH',

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

@@ -8,6 +8,8 @@ import { Requester } from '@chainlink/external-adapter-framework/util/requester'
 import { AdapterInputError } from '@chainlink/external-adapter-framework/validation/error'
 import Decimal from 'decimal.js'
 import { BaseEndpointTypes, inputParameters } from '../endpoint/xrpl'
+import { getTokenPrice } from './priceFeed'
+import { SharePriceType } from './utils'
 
 const logger = makeLogger('Token Balance - XRPL')
 
@@ -84,12 +86,19 @@ export class XrplTransport extends SubscriptionTransport<BaseEndpointTypes> {
   }
 
   async _handleRequest(
-    _param: RequestParams,
+    param: RequestParams,
   ): Promise<AdapterResponse<BaseEndpointTypes['Response']>> {
     const providerDataRequestedUnixMs = Date.now()
+    const [tokenPriceInUsd, tokenBalance]: [SharePriceType, Decimal] = await Promise.all([
+      getTokenPrice(param),
+      this.getTotalTokenBalance(param),
+    ])
 
-    // TODO: Implement the logic
-    const result = '0'
+    const tokenBalanceInUsd = tokenBalance
+      .times(new Decimal(tokenPriceInUsd.value.toString()))
+      .times(10 ** (RESULT_DECIMALS - tokenPriceInUsd.decimal))
+
+    const result = tokenBalanceInUsd.toFixed(0)
 
     return {
       data: {

packages/sources/token-balance/test/unit/xrpl.test.ts

@@ -4,9 +4,40 @@ import { TransportDependencies } from '@chainlink/external-adapter-framework/tra
 import { deferredPromise, LoggerFactoryProvider } from '@chainlink/external-adapter-framework/util'
 import { makeStub } from '@chainlink/external-adapter-framework/util/testing-utils'
 import Decimal from 'decimal.js'
+import { ethers } from 'ethers'
 import { BaseEndpointTypes, inputParameters } from '../../src/endpoint/xrpl'
 import { XrplTransport } from '../../src/transport/xrpl'
 
+const originalEnv = { ...process.env }
+
+const restoreEnv = () => {
+  for (const key of Object.keys(process.env)) {
+    if (key in originalEnv) {
+      process.env[key] = originalEnv[key]
+    } else {
+      delete process.env[key]
+    }
+  }
+}
+
+const ethersNewContract = jest.fn()
+const ethersNewJsonRpcProvider = jest.fn()
+
+const makeEthers = () => {
+  return {
+    JsonRpcProvider: function (...args: [string, number]) {
+      return ethersNewJsonRpcProvider(...args)
+    },
+    Contract: function (...args: [string, unknown, ethers.JsonRpcProvider]) {
+      return ethersNewContract(...args)
+    },
+  }
+}
+
+jest.mock('ethers', () => ({
+  ethers: makeEthers(),
+}))
+
 const log = jest.fn()
 const logger = {
   fatal: log,
@@ -127,6 +158,7 @@ describe('XrplTransport', () => {
   }
 
   beforeEach(async () => {
+    restoreEnv()
     jest.resetAllMocks()
     jest.useFakeTimers()
 
@@ -172,14 +204,36 @@ describe('XrplTransport', () => {
 
   describe('handleRequest', () => {
     it('should cache response', async () => {
+      const priceOracleAddress = '0x123'
+      const priceOracleNetwork = 'arbitrum'
+      const arbitrumRpcUrl = 'https://arb.rpc.url'
+      const arbitrumChainId = 42161
+      const tokenPrice = 200_000_000n
+      const tokenDecimals = 8
       const address = 'r101'
+      const tokenIssuerAddress = 'r456'
+      const balance = 123
+
+      process.env.ARBITRUM_RPC_URL = arbitrumRpcUrl
+      process.env.ARBITRUM_RPC_CHAIN_ID = arbitrumChainId.toString()
+
+      const contract = makeStub('contract', {
+        decimals: jest.fn().mockResolvedValue(tokenDecimals),
+        latestAnswer: jest.fn().mockResolvedValue(tokenPrice),
+      })
+      ethersNewContract.mockReturnValue(contract)
+
+      mockLineBalances([balance.toString()])
 
       const param = makeStub('param', {
+        priceOracleAddress,
+        priceOracleNetwork,
+        tokenIssuerAddress,
         addresses: [{ address }],
       })
       await transport.handleRequest(context, param)
 
-      const expectedResult = '0'
+      const expectedResult = (246 * 10 ** 18).toString()
       const expectedResponse = {
         statusCode: 200,
         result: expectedResult,
@@ -201,19 +255,48 @@ describe('XrplTransport', () => {
         },
       ])
       expect(responseCache.write).toBeCalledTimes(1)
+
+      expect(log).toBeCalledWith(expect.stringContaining('Generated HTTP request queue key:'))
+      expect(log).toBeCalledTimes(1)
+      log.mockClear()
     })
   })
 
   describe('_handleRequest', () => {
-    it('should return a response', async () => {
-      const address = 'r101'
+    it('should add balances and multiply by token price', async () => {
+      const priceOracleAddress = '0x123'
+      const priceOracleNetwork = 'arbitrum'
+      const arbitrumRpcUrl = 'https://arb.rpc.url'
+      const arbitrumChainId = 42161
+      const tokenPrice = 200_000_000n
+      const tokenDecimals = 8
+      const address1 = 'r101'
+      const address2 = 'r102'
+      const tokenIssuerAddress = 'r456'
+      const balance1 = 100
+      const balance2 = 200
+
+      process.env.ARBITRUM_RPC_URL = arbitrumRpcUrl
+      process.env.ARBITRUM_RPC_CHAIN_ID = arbitrumChainId.toString()
+
+      const contract = makeStub('contract', {
+        decimals: jest.fn().mockResolvedValue(tokenDecimals),
+        latestAnswer: jest.fn().mockResolvedValue(tokenPrice),
+      })
+      ethersNewContract.mockReturnValue(contract)
+
+      mockLineBalances([balance1.toString()])
+      mockLineBalances([balance2.toString()])
 
       const param = makeStub('param', {
-        addresses: [{ address }],
+        priceOracleAddress,
+        priceOracleNetwork,
+        tokenIssuerAddress,
+        addresses: [{ address: address1 }, { address: address2 }],
       })
       const response = await transport._handleRequest(param)
 
-      const expectedResult = '0'
+      const expectedResult = (600 * 10 ** 18).toString()
       expect(response).toEqual({
         statusCode: 200,
         result: expectedResult,
@@ -227,6 +310,73 @@ describe('XrplTransport', () => {
           providerIndicatedTimeUnixMs: undefined,
         },
       })
+
+      expect(log).toHaveBeenNthCalledWith(
+        1,
+        expect.stringContaining('Generated HTTP request queue key:'),
+      )
+      expect(log).toHaveBeenNthCalledWith(
+        2,
+        expect.stringContaining('Generated HTTP request queue key:'),
+      )
+      expect(log).toBeCalledTimes(2)
+      log.mockClear()
+    })
+
+    it('should record received timestamp separate from requested timestamp', async () => {
+      const priceOracleAddress = '0x123'
+      const priceOracleNetwork = 'arbitrum'
+      const arbitrumRpcUrl = 'https://arb.rpc.url'
+      const arbitrumChainId = 42161
+      const tokenPrice = 200_000_000n
+      const tokenDecimals = 8
+      const address = 'r101'
+      const tokenIssuerAddress = 'r456'
+      const balance = 100
+
+      process.env.ARBITRUM_RPC_URL = arbitrumRpcUrl
+      process.env.ARBITRUM_RPC_CHAIN_ID = arbitrumChainId.toString()
+
+      const contract = makeStub('contract', {
+        decimals: jest.fn().mockResolvedValue(tokenDecimals),
+        latestAnswer: jest.fn().mockResolvedValue(tokenPrice),
+      })
+      ethersNewContract.mockReturnValue(contract)
+
+      const [balancePromise, resolveBalance] = deferredPromise<string[]>()
+      mockLineBalances(balancePromise)
+
+      const param = makeStub('param', {
+        priceOracleAddress,
+        priceOracleNetwork,
+        tokenIssuerAddress,
+        addresses: [{ address }],
+      })
+
+      const requestTimestamp = Date.now()
+      const responsePromise = transport._handleRequest(param)
+      jest.advanceTimersByTime(1234)
+      const responseTimestamp = Date.now()
+      expect(responseTimestamp).toBeGreaterThan(requestTimestamp)
+
+      resolveBalance([balance.toString()])
+
+      const expectedResult = (200 * 10 ** 18).toString()
+      expect(await responsePromise).toEqual({
+        statusCode: 200,
+        result: expectedResult,
+        data: {
+          decimals: 18,
+          result: expectedResult,
+        },
+        timestamps: {
+          providerDataRequestedUnixMs: requestTimestamp,
+          providerDataReceivedUnixMs: responseTimestamp,
+          providerIndicatedTimeUnixMs: undefined,
+        },
+      })
+
+      log.mockClear()
     })
   })